develooper Front page | perl.cvs.parrot | Postings from December 2008

[svn:parrot] r34102 - trunk/compilers/pirc/new

From:
kjs
Date:
December 19, 2008 04:59
Subject:
[svn:parrot] r34102 - trunk/compilers/pirc/new
Message ID:
20081219125946.D73C6CBA12@x12.develooper.com
Author: kjs
Date: Fri Dec 19 04:59:46 2008
New Revision: 34102

Modified:
   trunk/compilers/pirc/new/bcgen.c

Log:
[pirc] add a synopsis section to bcgen.c. This presents overview of how to use the ByteCodeGENerator file.

Modified: trunk/compilers/pirc/new/bcgen.c
==============================================================================
--- trunk/compilers/pirc/new/bcgen.c	(original)
+++ trunk/compilers/pirc/new/bcgen.c	Fri Dec 19 04:59:46 2008
@@ -25,6 +25,30 @@
 private bits. Everything you need to know should be accessible through
 accessor functions.
 
+=head1 SYNOPSIS
+
+  // create a bytecode object
+  bytecode *bc = new_bytecode(interp, "foo.pir", codesize, bytes);
+
+  while ( ... ) {
+
+      // write opcodes
+      int opcode = ...
+
+      emit_opcode(bc, opcode);
+      // emit constants
+      int mystring = add_string_const(bc, "hello");
+
+      // emit the constant index into bytecode stream
+      emit_int_arg(bc, mystring);
+  }
+
+  // write the pbc file
+  write_pbc_file(bc, "foo.pbc");
+
+  // clean up
+  destroy_bytecode(bc);
+
 =cut
 
 */
@@ -307,6 +331,7 @@
         emit_opcode(bc, op);
 }
 
+/* XXX remove or update prototype once the XXX below has been resolved. */
 static STRING *add_string_const_from_cstring(bytecode * const bc, char const * const str);
 
 /*



nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About