<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.bcompiler-write-exe-footer" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>bcompiler_write_exe_footer</refname>
  <refpurpose>Writes the start pos, and sig to the end of a exe type file</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>bcompiler_write_exe_footer</methodname>
   <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam>
   <methodparam><type>int</type><parameter>startpos</parameter></methodparam>
  </methodsynopsis>
  <para>
   An EXE (or self executable) file consists of 3 parts:
   <simplelist>
    <member>
     The <literal>stub</literal> (executable code, e.g. a compiled C program) that loads PHP
     interpreter, bcompiler extension, stored Bytecodes and initiates a call
     for the specified function (e.g. main) or class method (e.g. <literal>main::main</literal>)
    </member>
    <member>The Bytecodes (uncompressed only for the moment)</member>
    <member>The bcompiler EXE footer</member>
   </simplelist>
  </para>
  <para>
   To obtain a suitable stub you can compile php_embed-based stub <filename>phpe.c</filename>
   located in the <filename>examples/embed</filename> directory on bcompiler's CVS.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filehandle</parameter></term>
     <listitem>
      <para>
       A file handle as returned by <function>fopen</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>startpos</parameter></term>
     <listitem>
      <para>
       The file position at which the Bytecodes start, and can be obtained
       using <function>ftell</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>bcompiler_write_exe_footer</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

/* creating the output file (example.exe) */
$fh = fopen("example.exe", "w");

/* 1) writing a stub (phpe.exe) */
$size = filesize("phpe.exe");
$fr = fopen("phpe.exe", "r");
fwrite($fh, fread($fr, $size), $size);
$startpos = ftell($fh);

/* 2) writing bytecodes */
bcompiler_write_header($fh);
bcompiler_write_class($fh, "myclass");
bcompiler_write_function($fh, "main");
bcompiler_write_footer($fh);

/* 3) writing EXE footer */
bcompiler_write_exe_footer($fh, $startpos);

/* closing the output file */
fclose($fh);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &warn.experimental.func;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>bcompiler_write_header</function></member>
    <member><function>bcompiler_write_class</function></member>
    <member><function>bcompiler_write_footer</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->