[svn:parrot] r37821 - in trunk: compilers/imcc compilers/pirc/src src src/call t/codingstd
coke at svn.parrot.org
coke at svn.parrot.org
Mon Mar 30 22:58:48 UTC 2009
Author: coke
Date: Mon Mar 30 22:58:47 2009
New Revision: 37821
URL: https://trac.parrot.org/parrot/changeset/37821
Log:
[t/docs] fixup more function signatures in docs
This gets more tests passing, notes on others that only the signatures are
present (no docs) and catches a few cases where the actual signature changed,
but the docs weren't kept up.
Modified:
trunk/compilers/imcc/imc.c
trunk/compilers/pirc/src/pirsymbol.c
trunk/src/byteorder.c
trunk/src/call/ops.c
trunk/src/embed.c
trunk/src/exec.c
trunk/src/exit.c
trunk/src/library.c
trunk/src/multidispatch.c
trunk/src/runops_cores.c
trunk/src/stacks.c
trunk/src/trace.c
trunk/t/codingstd/c_function_docs.t
Modified: trunk/compilers/imcc/imc.c
==============================================================================
--- trunk/compilers/imcc/imc.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/compilers/imcc/imc.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -52,7 +52,7 @@
/*
-=item C<void imc_compile_all_units>
+=item C<void imc_compile_all_units(PARROT_INTERP)>
Compiles all imc_units, and free all memory of instructions and structures
afterwards.
@@ -102,7 +102,7 @@
/*
-=item C<void imc_compile_unit>
+=item C<void imc_compile_unit(PARROT_INTERP, IMC_Unit *unit)>
Compiles each unit in IMCC. This is the main loop of the compiler; it operates
on a single compilation unit at a time.
@@ -126,7 +126,7 @@
/*
-=item C<void imc_cleanup>
+=item C<void imc_cleanup(PARROT_INTERP, void *yyscanner)>
Cleans up the compiler state in preparation for another compiler invocation.
@@ -148,7 +148,7 @@
/*
-=item C<static IMC_Unit * imc_new_unit>
+=item C<static IMC_Unit * imc_new_unit(IMC_Unit_Type t)>
Creates a new IMC_Unit of the given IMC_Unit_Type C<t>.
@@ -171,7 +171,7 @@
/*
-=item C<IMC_Unit * imc_open_unit>
+=item C<IMC_Unit * imc_open_unit(PARROT_INTERP, IMC_Unit_Type t)>
Creates a new IMC_Unit and "open" it for construction. This sets the current
state of the parser. You can close the unit later while retaining all the
@@ -212,7 +212,7 @@
/*
-=item C<void imc_close_unit>
+=item C<void imc_close_unit(PARROT_INTERP, IMC_Unit *unit)>
Closes a unit from compilation. This does not destroy the unit, but leaves it
on the list of units.
@@ -236,7 +236,7 @@
/*
-=item C<static void imc_free_unit>
+=item C<static void imc_free_unit(PARROT_INTERP, IMC_Unit *unit)>
Frees an IMC_Unit and all of its associated memory.
Modified: trunk/compilers/pirc/src/pirsymbol.c
==============================================================================
--- trunk/compilers/pirc/src/pirsymbol.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/compilers/pirc/src/pirsymbol.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -84,7 +84,7 @@
/*
=item C<static int
-next_register(struct lexer_state * const lexer, pir_type type)>
+next_register(lexer_state * const lexer, pir_type type)>
Returns a new register of the specified type.
This is the vanilla register allocator.
@@ -675,8 +675,9 @@
/*
-=item C<static label *
-new_label(char * const name, unsigned offset)>
+=item C<static local_label *
+new_local_label(lexer_state * const lexer, char const * const name,
+unsigned offset)>
Constructor for a label. Create a new label structure, fill out the details
and return it. C<name> is the name of the label; C<offset> is its current
Modified: trunk/src/byteorder.c
==============================================================================
--- trunk/src/byteorder.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/byteorder.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -32,7 +32,7 @@
/*
-=item C<INTVAL fetch_iv_le>
+=item C<INTVAL fetch_iv_le(INTVAL w)>
This function converts a 4 or 8 byte C<INTVAL> into little endian
format. If the native format is already little endian, then no
@@ -76,7 +76,7 @@
/*
-=item C<INTVAL fetch_iv_be>
+=item C<INTVAL fetch_iv_be(INTVAL w)>
This function converts a 4 or 8 byte C<INTVAL> into big endian format.
If the native format is already big endian, then no conversion is done.
@@ -118,7 +118,7 @@
/*
-=item C<opcode_t fetch_op_be>
+=item C<opcode_t fetch_op_be(opcode_t w)>
Same as C<fetch_iv_be> for opcode_t
@@ -156,7 +156,7 @@
/*
-=item C<opcode_t fetch_op_le>
+=item C<opcode_t fetch_op_le(opcode_t w)>
Same as C<fetch_iv_le> for opcode_t
@@ -206,7 +206,7 @@
/*
-=item C<void fetch_buf_be_4>
+=item C<void fetch_buf_be_4(unsigned char *rb, const unsigned char *b)>
Converts a 4-byte big-endian buffer C<b> into a little-endian C<rb>.
@@ -230,7 +230,7 @@
/*
-=item C<void fetch_buf_le_4>
+=item C<void fetch_buf_le_4(unsigned char *rb, const unsigned char *b)>
Converts a 4-byte little-endian buffer C<b> into a big-endian buffer C<rb>.
@@ -254,7 +254,7 @@
/*
-=item C<void fetch_buf_be_8>
+=item C<void fetch_buf_be_8(unsigned char *rb, const unsigned char *b)>
Converts an 8-byte big-endian buffer C<b> into a little-endian buffer C<rb>
@@ -282,7 +282,7 @@
/*
-=item C<void fetch_buf_le_8>
+=item C<void fetch_buf_le_8(unsigned char *rb, const unsigned char *b)>
Converts an 8-byte little-endian buffer C<b> into a big-endian buffer C<rb>.
@@ -310,7 +310,7 @@
/*
-=item C<void fetch_buf_le_12>
+=item C<void fetch_buf_le_12(unsigned char *rb, const unsigned char *b)>
Converts a 12-byte little-endian buffer C<b> into a big-endian buffer C<b>.
@@ -342,7 +342,7 @@
/*
-=item C<void fetch_buf_be_12>
+=item C<void fetch_buf_be_12(unsigned char *rb, const unsigned char *b)>
Converts a 12-byte big-endian buffer C<b> into a little-endian buffer C<b>.
@@ -374,7 +374,7 @@
/*
-=item C<void fetch_buf_le_16>
+=item C<void fetch_buf_le_16(unsigned char *rb, const unsigned char *b)>
Converts a 16-byte little-endian buffer C<b> into a big-endian buffer C<b>.
@@ -410,7 +410,7 @@
/*
-=item C<void fetch_buf_be_16>
+=item C<void fetch_buf_be_16(unsigned char *rb, const unsigned char *b)>
Converts a 16-byte big-endian buffer C<b> into a little-endian buffer C<b>.
@@ -446,7 +446,7 @@
/*
-=item C<void fetch_buf_le_32>
+=item C<void fetch_buf_le_32(unsigned char *rb, const unsigned char *b)>
Converts a 32-byte little-endian buffer C<b> into a big-endian buffer C<b>.
@@ -498,7 +498,7 @@
/*
-=item C<void fetch_buf_be_32>
+=item C<void fetch_buf_be_32(unsigned char *rb, const unsigned char *b)>
Converts a 32-byte big-endian buffer C<b> into a little-endian buffer C<b>.
Modified: trunk/src/call/ops.c
==============================================================================
--- trunk/src/call/ops.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/call/ops.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -53,7 +53,7 @@
/*
-=item C<void runops>
+=item C<void runops(PARROT_INTERP, size_t offs)>
Run parrot ops. Set exception handler and/or resume after exception.
@@ -121,7 +121,7 @@
/*
-=item C<Parrot_Context * Parrot_runops_fromc>
+=item C<Parrot_Context * Parrot_runops_fromc(PARROT_INTERP, PMC *sub)>
Runs the Parrot ops, called from C code. The function arguments are
already setup according to Parrot calling conventions, the C<sub> argument
@@ -165,7 +165,8 @@
/*
-=item C<static Parrot_Context * runops_args>
+=item C<static Parrot_Context * runops_args(PARROT_INTERP, PMC *sub,
+PMC *obj, STRING *meth, const char *sig, va_list ap)>
Calls the PMC subroutine C<sub> with optional name C<meth>. If PMC object
C<obj> is provided, the call is treated as a method call on that object.
@@ -258,7 +259,8 @@
/*
-=item C<void * Parrot_run_meth_fromc>
+=item C<void * Parrot_run_meth_fromc(PARROT_INTERP, PMC *sub, PMC *obj,
+STRING *meth)>
Run a method sub from C. The function arguments are
already setup according to Parrot calling conventions, the C<sub> argument
@@ -296,7 +298,8 @@
/*
-=item C<PMC * Parrot_runops_fromc_args>
+=item C<PMC * Parrot_runops_fromc_args(PARROT_INTERP, PMC *sub,
+const char *sig, ...)>
Run parrot ops, called from C code, function arguments are passed as
C<va_args> according to the signature. The C<sub> argument is an
@@ -327,7 +330,8 @@
/*
-=item C<void * Parrot_runops_fromc_args_event>
+=item C<void * Parrot_runops_fromc_args_event(PARROT_INTERP, PMC *sub,
+const char *sig, ...)>
Run code from within event handlers. This variant deals with some reentrency
issues. It also should do sanity checks, if e.g. the handler subroutine
@@ -373,7 +377,8 @@
/*
-=item C<INTVAL Parrot_runops_fromc_args_reti>
+=item C<INTVAL Parrot_runops_fromc_args_reti(PARROT_INTERP, PMC *sub,
+const char *sig, ...)>
Called from C code, runs a Parrot subroutine C<sub>. The subroutine has
function signature C<sig> and a C variadic argument list. Returns an
@@ -404,7 +409,8 @@
/*
-=item C<FLOATVAL Parrot_runops_fromc_args_retf>
+=item C<FLOATVAL Parrot_runops_fromc_args_retf(PARROT_INTERP, PMC *sub,
+const char *sig, ...)>
Called from C code, runs a Parrot subroutine C<sub>. The subroutine has
function signature C<sig> and a C variadic argument list. Returns a
@@ -435,7 +441,8 @@
/*
-=item C<void* Parrot_run_meth_fromc_args>
+=item C<void* Parrot_run_meth_fromc_args(PARROT_INTERP, PMC *sub, PMC *obj,
+STRING *meth, const char *sig, ...)>
Called from C code, runs a Parrot subroutine C<sub> as a method on object
C<obj>. The subroutine has function signature C<sig> and a C variadic argument
@@ -467,7 +474,8 @@
/*
-=item C<INTVAL Parrot_run_meth_fromc_args_reti>
+=item C<INTVAL Parrot_run_meth_fromc_args_reti(PARROT_INTERP, PMC *sub,
+PMC *obj, STRING *meth, const char *sig, ...)>
Called from C code, runs a Parrot subroutine C<sub> as a method on object
C<obj>. The subroutine has function signature C<sig> and a C variadic argument
@@ -498,7 +506,8 @@
/*
-=item C<FLOATVAL Parrot_run_meth_fromc_args_retf>
+=item C<FLOATVAL Parrot_run_meth_fromc_args_retf(PARROT_INTERP, PMC *sub,
+PMC *obj, STRING *meth, const char *sig, ...)>
Called from C code, runs a Parrot subroutine C<sub> as a method on object
C<obj>. The subroutine has function signature C<sig> and a C variadic argument
@@ -529,7 +538,8 @@
/*
-=item C<void * Parrot_runops_fromc_arglist>
+=item C<void * Parrot_runops_fromc_arglist(PARROT_INTERP, PMC *sub,
+const char *sig, va_list args)>
Called from C code, runs a Parrot subroutine C<sub>.
The subroutine has function signature C<sig> and a C C<va_list>
@@ -557,7 +567,8 @@
/*
-=item C<INTVAL Parrot_runops_fromc_arglist_reti>
+=item C<INTVAL Parrot_runops_fromc_arglist_reti(PARROT_INTERP, PMC *sub,
+const char *sig, va_list args)>
Called from C code, runs a Parrot subroutine C<sub>.
The subroutine has function signature C<sig> and a C C<va_list>
@@ -584,7 +595,8 @@
/*
-=item C<FLOATVAL Parrot_runops_fromc_arglist_retf>
+=item C<FLOATVAL Parrot_runops_fromc_arglist_retf(PARROT_INTERP, PMC *sub,
+const char *sig, va_list args)>
Called from C code, runs a Parrot subroutine C<sub>.
The subroutine has function signature C<sig> and a C C<va_list>
@@ -611,7 +623,8 @@
/*
-=item C<void* Parrot_run_meth_fromc_arglist>
+=item C<void* Parrot_run_meth_fromc_arglist(PARROT_INTERP, PMC *sub,
+PMC *obj, STRING *meth, const char *sig, va_list args)>
Calls the subroutine C<sub> as a method on object C<obj>. The method to be
called is named C<meth>, has the function signature C<sig> and arguments
@@ -640,7 +653,8 @@
/*
-=item C<INTVAL Parrot_run_meth_fromc_arglist_reti>
+=item C<INTVAL Parrot_run_meth_fromc_arglist_reti(PARROT_INTERP, PMC *sub,
+PMC *obj, STRING *meth, const char *sig, va_list args)>
Calls the subroutine C<sub> as a method on object C<obj>. The method to be
called is named C<meth>, has the function signature C<sig> and arguments
@@ -669,7 +683,8 @@
/*
-=item C<FLOATVAL Parrot_run_meth_fromc_arglist_retf>
+=item C<FLOATVAL Parrot_run_meth_fromc_arglist_retf(PARROT_INTERP, PMC *sub,
+PMC *obj, STRING *meth, const char *sig, va_list args)>
Calls the subroutine C<sub> as a method on object C<obj>. The method to be
called is named C<meth>, has the function signature C<sig> and arguments
@@ -703,7 +718,7 @@
=over 4
-=item C<void new_runloop_jump_point>
+=item C<void new_runloop_jump_point(PARROT_INTERP)>
Create a new runloop jump point, either by allocating it or by
getting one from the free list.
@@ -732,7 +747,7 @@
/*
-=item C<void free_runloop_jump_point>
+=item C<void free_runloop_jump_point(PARROT_INTERP)>
Place runloop jump point back on the free list.
@@ -753,7 +768,7 @@
/*
-=item C<void destroy_runloop_jump_points>
+=item C<void destroy_runloop_jump_points(PARROT_INTERP)>
Destroys (and frees the memory of) the runloop jump point list and the
associated free list for the specified interpreter.
@@ -772,7 +787,7 @@
/*
-=item C<void really_destroy_runloop_jump_points>
+=item C<void really_destroy_runloop_jump_points(Parrot_runloop *jump_point)>
Takes a pointer to a runloop jump point (which had better be the last one in
the list). Walks back through the list, freeing the memory of each one, until
Modified: trunk/src/embed.c
==============================================================================
--- trunk/src/embed.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/embed.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -79,7 +79,7 @@
/*
-=item C<Parrot_Interp Parrot_new>
+=item C<Parrot_Interp Parrot_new(Parrot_Interp parent)>
Returns a new Parrot interpreter.
@@ -111,7 +111,7 @@
/*
-=item C<void Parrot_init_stacktop>
+=item C<void Parrot_init_stacktop(PARROT_INTERP, void *stack_top)>
Initializes the new interpreter when it hasn't been initialized before.
@@ -138,7 +138,7 @@
/*
-=item C<void Parrot_set_flag>
+=item C<void Parrot_set_flag(PARROT_INTERP, INTVAL flag)>
Sets on any of the following flags, specified by C<flag>, in the interpreter:
@@ -173,7 +173,7 @@
/*
-=item C<void Parrot_set_debug>
+=item C<void Parrot_set_debug(PARROT_INTERP, UINTVAL flag)>
Set a debug flag: C<PARROT_DEBUG_FLAG>.
@@ -191,7 +191,7 @@
/*
-=item C<void Parrot_set_executable_name>
+=item C<void Parrot_set_executable_name(PARROT_INTERP, Parrot_String name)>
Sets the name of the executable launching Parrot (see C<pbc_to_exe> and the
C<parrot> binary).
@@ -213,7 +213,7 @@
/*
-=item C<void Parrot_set_trace>
+=item C<void Parrot_set_trace(PARROT_INTERP, UINTVAL flag)>
Set a trace flag: C<PARROT_TRACE_FLAG>
@@ -232,7 +232,7 @@
/*
-=item C<void Parrot_clear_flag>
+=item C<void Parrot_clear_flag(PARROT_INTERP, INTVAL flag)>
Clears a flag in the interpreter.
@@ -250,7 +250,7 @@
/*
-=item C<void Parrot_clear_debug>
+=item C<void Parrot_clear_debug(PARROT_INTERP, UINTVAL flag)>
Clears a flag in the interpreter.
@@ -268,7 +268,7 @@
/*
-=item C<void Parrot_clear_trace>
+=item C<void Parrot_clear_trace(PARROT_INTERP, UINTVAL flag)>
Clears a flag in the interpreter.
@@ -286,7 +286,7 @@
/*
-=item C<Parrot_Int Parrot_test_flag>
+=item C<Parrot_Int Parrot_test_flag(PARROT_INTERP, INTVAL flag)>
Test the interpreter flags specified in C<flag>.
@@ -304,7 +304,7 @@
/*
-=item C<UINTVAL Parrot_test_debug>
+=item C<UINTVAL Parrot_test_debug(PARROT_INTERP, UINTVAL flag)>
Test the interpreter flags specified in C<flag>.
@@ -322,7 +322,7 @@
/*
-=item C<UINTVAL Parrot_test_trace>
+=item C<UINTVAL Parrot_test_trace(PARROT_INTERP, UINTVAL flag)>
Test the interpreter flags specified in C<flag>.
@@ -340,7 +340,7 @@
/*
-=item C<void Parrot_set_run_core>
+=item C<void Parrot_set_run_core(PARROT_INTERP, Parrot_Run_core_t core)>
Sets the specified run core.
@@ -358,7 +358,7 @@
/*
-=item C<void Parrot_setwarnings>
+=item C<void Parrot_setwarnings(PARROT_INTERP, Parrot_warnclass wc)>
Activates the given warnings.
@@ -377,7 +377,8 @@
/*
-=item C<PackFile * Parrot_pbc_read>
+=item C<PackFile * Parrot_pbc_read(PARROT_INTERP, const char *fullname,
+const int debug)>
Read in a bytecode, unpack it into a C<PackFile> structure, and do fixups.
@@ -563,7 +564,7 @@
/*
-=item C<void Parrot_pbc_load>
+=item C<void Parrot_pbc_load(PARROT_INTERP, PackFile *pf)>
Loads the C<PackFile> returned by C<Parrot_pbc_read()>.
@@ -586,7 +587,7 @@
/*
-=item C<void Parrot_pbc_fixup_loaded>
+=item C<void Parrot_pbc_fixup_loaded(PARROT_INTERP)>
Fixups after pbc loading
@@ -603,7 +604,7 @@
/*
-=item C<static PMC* setup_argv>
+=item C<static PMC* setup_argv(PARROT_INTERP, int argc, char **argv)>
Creates and returns C<ARGS> array PMC.
@@ -652,9 +653,9 @@
/*
-=item C<static int prof_sort_f>
+=item C<static int prof_sort_f(const void *a, const void *b)>
-Sort function for profile data. Sorts by time.
+Sort function for profile data, by time.
=cut
@@ -679,7 +680,7 @@
/*
-=item C<static const char * op_name>
+=item C<static const char * op_name(PARROT_INTERP, int k)>
Returns the name of the opcode.
@@ -715,7 +716,7 @@
/*
-=item C<static FLOATVAL calibrate>
+=item C<static FLOATVAL calibrate(PARROT_INTERP)>
With this calibration, reported times of C<parrot -p> almost match those
measured with time C<parrot -R bounds>.
@@ -747,7 +748,7 @@
/*
-=item C<static void print_profile>
+=item C<static void print_profile(PARROT_INTERP, int status, void *p)>
Prints out a profile listing.
@@ -831,7 +832,7 @@
/*
-=item C<static void print_debug>
+=item C<static void print_debug(PARROT_INTERP, int status, void *p)>
Prints GC info.
@@ -854,7 +855,7 @@
/*
-=item C<static PMC* set_current_sub>
+=item C<static PMC* set_current_sub(PARROT_INTERP)>
Search the fixup table for a PMC matching the argument. On a match,
set up the appropriate context.
@@ -918,7 +919,7 @@
/*
-=item C<void Parrot_runcode>
+=item C<void Parrot_runcode(PARROT_INTERP, int argc, char **argv)>
Sets up C<ARGV> and runs the ops.
@@ -1014,7 +1015,7 @@
/*
-=item C<opcode_t * Parrot_debug>
+=item C<opcode_t * Parrot_debug(PARROT_INTERP, Parrot_Interp debugger, opcode_t * pc)>
Runs the interpreter's bytecode in debugging mode.
@@ -1054,7 +1055,7 @@
/*
-=item C<static void print_constant_table>
+=item C<static void print_constant_table(PARROT_INTERP)>
Print the contents of the constants table.
@@ -1143,7 +1144,8 @@
/*
-=item C<void Parrot_disassemble>
+=item C<void Parrot_disassemble(PARROT_INTERP, const char *outfile,
+Parrot_disassemble_options options)>
Disassembles and prints out the interpreter's bytecode.
@@ -1235,7 +1237,7 @@
/*
-=item C<void Parrot_run_native>
+=item C<void Parrot_run_native(PARROT_INTERP, native_func_t func)>
Run the C function C<func> through the program C<[enternative, end]>.
This ensures that the function is run with the same setup as in other
@@ -1275,7 +1277,8 @@
/*
-=item C<Parrot_PMC Parrot_compile_string>
+=item C<Parrot_PMC Parrot_compile_string(PARROT_INTERP, Parrot_String type,
+const char *code, Parrot_String *error)>
Compile code string.
Modified: trunk/src/exec.c
==============================================================================
--- trunk/src/exec.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/exec.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -73,7 +73,8 @@
/*
-=item C<void Parrot_exec>
+=item C<void Parrot_exec(PARROT_INTERP, opcode_t *pc, opcode_t *code_start,
+opcode_t *code_end)>
Call the jit to get the program code. Adds the members of the data
section. And emits the executable.
@@ -143,7 +144,8 @@
/*
-=item C<static void add_data_member>
+=item C<static void add_data_member(Parrot_exec_objfile_t *obj,
+const void *src, size_t len)>
Adds a member to the data section, storing the size of it at
C<< obj->data_size[N] >>.
@@ -183,7 +185,7 @@
/*
-=item C<static void exec_init>
+=item C<static void exec_init(Parrot_exec_objfile_t *obj)>
Initialize the obj structure.
@@ -222,7 +224,8 @@
/*
-=item C<int Parrot_exec_add_symbol>
+=item C<int Parrot_exec_add_symbol(Parrot_exec_objfile_t *obj,
+const char *symbol, int stype)>
Adds a symbol to the object file.
@@ -269,7 +272,8 @@
/*
-=item C<int * Parrot_exec_add_text_rellocation_reg>
+=item C<int * Parrot_exec_add_text_rellocation_reg(Parrot_exec_objfile_t *obj,
+char *nptr, const char *var, int offset, int disp)>
Adds a register's text rellocation to the object file. Wrapper
around C<Parrot_exec_add_text_rellocation>.
@@ -293,7 +297,8 @@
/*
-=item C<void Parrot_exec_add_text_rellocation_func>
+=item C<void Parrot_exec_add_text_rellocation_func(Parrot_exec_objfile_t *obj,
+char *nptr, const char *func_name)>
Adds a function's text rellocation to the object file. Wrapper
around C<Parrot_exec_add_text_rellocation>.
@@ -313,7 +318,8 @@
/*
-=item C<void Parrot_exec_add_text_rellocation>
+=item C<void Parrot_exec_add_text_rellocation(Parrot_exec_objfile_t *obj,
+char *nptr, int type, const char *symbol, int disp)>
Adds a text rellocation to the object file.
@@ -361,7 +367,8 @@
/*
-=item C<static int symbol_list_find>
+=item C<static int symbol_list_find(const Parrot_exec_objfile_t *obj,
+const char *symbol)>
Returns the index of C<symbol> in the symbol list. Returns -1 if it is
not in the list.
Modified: trunk/src/exit.c
==============================================================================
--- trunk/src/exit.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/exit.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -28,7 +28,8 @@
/*
-=item C<void Parrot_on_exit>
+=item C<void Parrot_on_exit(PARROT_INTERP, exit_handler_f function,
+void *arg)>
Register the specified function to be called on exit.
@@ -54,7 +55,7 @@
/*
-=item C<void Parrot_exit>
+=item C<void Parrot_exit(PARROT_INTERP, int status)>
Exit, calling any registered exit handlers.
Modified: trunk/src/library.c
==============================================================================
--- trunk/src/library.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/library.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -126,7 +126,7 @@
/*
-=item C<void parrot_init_library_paths>
+=item C<void parrot_init_library_paths(PARROT_INTERP)>
Create an array of StringArrays with library searchpaths and shared
extension used for loading various files at runtime. The created
@@ -256,7 +256,7 @@
/*
-=item C<static PMC* get_search_paths>
+=item C<static PMC* get_search_paths(PARROT_INTERP, enum_lib_paths which)>
Return lib_paths as array of StringArrays with library searchpaths and shared
extension used for loading various files at runtime.
@@ -296,7 +296,7 @@
/*
-=item C<static int is_abs_path>
+=item C<static int is_abs_path(const STRING *file)>
Determines whether a file name given by a fixed-8 or utf8 C<STRING> is an
absolute file name. Returns C<1> if the filename is absolute, returns C<0>
@@ -337,7 +337,7 @@
/*
-=item C<static void cnv_to_win32_filesep>
+=item C<static void cnv_to_win32_filesep(STRING *path)>
Converts a path with forward slashes to one with backward slashes.
@@ -363,7 +363,7 @@
/*
-=item C<static STRING* path_finalize>
+=item C<static STRING* path_finalize(PARROT_INTERP, STRING *path)>
Ensures the given STRING C<path> has a C-style NULL character at the end. The
length of the string is not increased to account for this NULL, however. In
@@ -401,7 +401,7 @@
/*
-=item C<static STRING* path_guarantee_trailing_separator>
+=item C<static STRING* path_guarantee_trailing_separator(PARROT_INTERP, STRING *path)>
unary path argument. the path string will have a
trailing path-separator appended if it is not
@@ -429,7 +429,7 @@
/*
-=item C<static STRING* path_append>
+=item C<static STRING* path_append(PARROT_INTERP, STRING *l_path, STRING *r_path)>
binary path arguments, the left arg is modified.
a trailing separator is guaranteed for the left
@@ -453,7 +453,7 @@
/*
-=item C<static STRING* path_concat>
+=item C<static STRING* path_concat(PARROT_INTERP, STRING *l_path, STRING *r_path)>
binary path arguments. A new string is created
that is the concatenation of the two path components
@@ -480,7 +480,7 @@
/*
-=item C<static STRING* try_load_path>
+=item C<static STRING* try_load_path(PARROT_INTERP, STRING* path)>
Attempts to load a file with name C<path>. If the file is successfully located,
the finalized name of the file is returned as a STRING. Otherwise, returns
@@ -511,7 +511,7 @@
/*
-=item C<static STRING* try_bytecode_extensions>
+=item C<static STRING* try_bytecode_extensions(PARROT_INTERP, STRING* path)>
Guess extensions, so that the user can drop the extensions
leaving it up to the build process/install whether or not
@@ -591,7 +591,8 @@
/*
-=item C<void Parrot_add_library_path>
+=item C<void Parrot_add_library_path(PARROT_INTERP, STRING *path,
+enum_lib_paths which)>
Add a path to the library searchpath of the given type.
@@ -615,7 +616,8 @@
/*
-=item C<void Parrot_add_library_path_from_cstring>
+=item C<void Parrot_add_library_path_from_cstring(PARROT_INTERP,
+const char *path, enum_lib_paths which)>
Add a path to the library searchpath of the given type (passing in a C string).
@@ -639,24 +641,13 @@
/*
-=item C<char* Parrot_locate_runtime_file>
+=item C<STRING* Parrot_locate_runtime_file_str(PARROT_INTERP, STRING *file,
+enum_runtime_ft type)>
Locate the full path for C<file_name> and the given file type(s). If
successful, returns a C-string allocated with C<Parrot_str_to_cstring> or
NULL otherwise. Remember to free the string with C<Parrot_str_free_cstring()>.
-=item C<STRING* Parrot_locate_runtime_file_str>
-
-Like above but use and return STRINGs.
-
-Locate the full path for C<file_name> and the given file type(s). If
-successful, returns a C-string allocated with C<Parrot_str_to_cstring> or
-NULL otherwise.
-
-If successful, the returned STRING is 0-terminated so that
-C<result-E<gt>strstart> is usable as B<const char*> c-string for C library
-functions like fopen(3). This is the preferred API function.
-
The C<enum_runtime_ft type> is one or more of the types defined in
F<include/parrot/library.h>.
@@ -729,6 +720,27 @@
return full_name;
}
+/*
+
+=item C<char* Parrot_locate_runtime_file(PARROT_INTERP, const char *file_name,
+enum_runtime_ft type)>
+
+Locate the full path for C<file_name> and the given file type(s). If
+successful, returns a C-string allocated with C<Parrot_str_to_cstring> or
+NULL otherwise. Remember to free the string with C<Parrot_str_free_cstring()>.
+
+If successful, the returned STRING is 0-terminated so that
+C<result-E<gt>strstart> is usable as B<const char*> c-string for C library
+functions like fopen(3). This is the preferred API function.
+
+The C<enum_runtime_ft type> is one or more of the types defined in
+F<include/parrot/library.h>.
+
+=cut
+
+*/
+
+
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
@@ -753,7 +765,7 @@
/*
-=item C<char* Parrot_get_runtime_prefix>
+=item C<char* Parrot_get_runtime_prefix(PARROT_INTERP)>
Return a malloced C-string for the runtime prefix. The calling function
must free it.
@@ -793,7 +805,7 @@
/*
-=item C<STRING * Parrot_get_runtime_path>
+=item C<STRING * Parrot_get_runtime_path(PARROT_INTERP)>
Return a string for the runtime prefix.
@@ -833,7 +845,8 @@
/*
-=item C<STRING * parrot_split_path_ext>
+=item C<STRING * parrot_split_path_ext(PARROT_INTERP, STRING *in,
+STRING **wo_ext, STRING **ext)>
Split the pathstring C<in> into <path><filestem><ext>. Return the
C<filestem> of the pathstring. Set C<wo_ext> to the part without
Modified: trunk/src/multidispatch.c
==============================================================================
--- trunk/src/multidispatch.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/multidispatch.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -255,7 +255,8 @@
/*
-=item C<PMC* Parrot_mmd_find_multi_from_sig_obj>
+=item C<PMC* Parrot_mmd_find_multi_from_sig_obj(PARROT_INTERP, STRING *name,
+PMC *invoke_sig)>
Collect a list of possible candidates for a given sub name and call signature.
Rank the possible candidates by Manhattan Distance, and return the best
@@ -285,7 +286,8 @@
/*
-=item C<void Parrot_mmd_multi_dispatch_from_c_args>
+=item C<void Parrot_mmd_multi_dispatch_from_c_args(PARROT_INTERP,
+const char *name, const char *sig, ...)>
Dispatches to a MultiSub from a variable-sized list of C arguments. The
multiple dispatch system will figure out which sub should be called based on
@@ -343,7 +345,8 @@
/*
-=item C<PMC * Parrot_mmd_find_multi_from_long_sig>
+=item C<PMC * Parrot_mmd_find_multi_from_long_sig(PARROT_INTERP, STRING *name,
+STRING *long_sig)>
Find the best candidate multi for a given sub name and signature. The signature
is a string containing a comma-delimited list of type names.
@@ -378,7 +381,8 @@
/*
-=item C<PMC * Parrot_mmd_sort_manhattan_by_sig_pmc>
+=item C<PMC * Parrot_mmd_sort_manhattan_by_sig_pmc(PARROT_INTERP,
+PMC *candidates, PMC *invoke_sig)>
Given an array PMC (usually a MultiSub) and a CallSignature PMC, sorts the mmd
candidates by their manhattan distance to the signature args and returns the
@@ -408,7 +412,7 @@
/*
-=item C<PMC * Parrot_mmd_sort_manhattan>
+=item C<PMC * Parrot_mmd_sort_manhattan(PARROT_INTERP, PMC *candidates)>
Given an array PMC (usually a MultiSub) sorts the mmd candidates by their
manhattan distance to the current args and returns the best one.
@@ -436,7 +440,7 @@
/*
-=item C<static PMC* Parrot_mmd_arg_tuple_func>
+=item C<static PMC* Parrot_mmd_arg_tuple_func(PARROT_INTERP)>
Return a list of argument types. PMC arguments are taken from registers
according to calling conventions.
@@ -544,7 +548,8 @@
/*
-=item C<static void Parrot_mmd_search_classes>
+=item C<static void Parrot_mmd_search_classes(PARROT_INTERP, STRING *meth,
+PMC *arg_tuple, PMC *cl, INTVAL start_at_parent)>
Search all the classes in all MultiSubs of the candidates C<cl> and return
a list of all candidates. C<start_at_parent> is 0 to start at the class itself
@@ -602,7 +607,7 @@
/*
-=item C<static INTVAL distance_cmp>
+=item C<static INTVAL distance_cmp(PARROT_INTERP, INTVAL a, INTVAL b)>
=cut
@@ -632,7 +637,7 @@
/*
-=item C<static PMC* mmd_build_type_tuple_from_type_list>
+=item C<static PMC* mmd_build_type_tuple_from_type_list(PARROT_INTERP, PMC *type_list)>
Construct a FixedIntegerArray of type numbers from an array of
type names. Used for multiple dispatch.
@@ -677,7 +682,7 @@
/*
-=item C<static PMC* mmd_build_type_tuple_from_long_sig>
+=item C<static PMC* mmd_build_type_tuple_from_long_sig(PARROT_INTERP, STRING *long_sig)>
Construct a FixedIntegerArray of type numbers from a comma-delimited string of
type names. Used for multiple dispatch.
@@ -700,7 +705,7 @@
/*
-=item C<PMC* Parrot_mmd_build_type_tuple_from_sig_obj>
+=item C<PMC* Parrot_mmd_build_type_tuple_from_sig_obj(PARROT_INTERP, PMC *sig_obj)>
Construct a FixedIntegerArray of type numbers from the arguments of a Call
Signature object. Used for multiple dispatch.
@@ -793,7 +798,7 @@
/*
-=item C<static PMC* mmd_cvt_to_types>
+=item C<static PMC* mmd_cvt_to_types(PARROT_INTERP, PMC *multi_sig)>
Given a ResizablePMCArray PMC containing some form of type identifier (either
the string name of a class or a PMC representing the type), resolves all type
@@ -855,6 +860,14 @@
}
+/*
+
+=item C<static PMC * Parrot_mmd_get_cached_multi_sig(PARROT_INTERP, PMC *sub_pmc)>
+
+=cut
+
+*/
+
PARROT_CANNOT_RETURN_NULL
static PMC *
Parrot_mmd_get_cached_multi_sig(PARROT_INTERP, ARGIN(PMC *sub_pmc))
@@ -887,7 +900,7 @@
/*
-=item C<static UINTVAL mmd_distance>
+=item C<static UINTVAL mmd_distance(PARROT_INTERP, PMC *pmc, PMC *arg_tuple)>
Create Manhattan Distance of sub C<pmc> against given argument types.
0xffff is the maximum distance
@@ -1026,7 +1039,7 @@
/*
-=item C<static PMC * Parrot_mmd_sort_candidates>
+=item C<static PMC * Parrot_mmd_sort_candidates(PARROT_INTERP, PMC *arg_tuple, PMC *cl)>
Sort the candidate list C<cl> by Manhattan Distance, returning the best
candidate.
@@ -1060,7 +1073,7 @@
/*
-=item C<static PMC* Parrot_mmd_search_scopes>
+=item C<static PMC* Parrot_mmd_search_scopes(PARROT_INTERP, STRING *meth)>
Search all scopes for MMD candidates matching the arguments given in
C<arg_tuple>.
@@ -1087,7 +1100,7 @@
/*
-=item C<static int mmd_maybe_candidate>
+=item C<static int Parrot_mmd_maybe_candidate(PARROT_INTERP, PMC *pmc, PMC *cl)>
If the candidate C<pmc> is a Sub PMC, push it on the candidate list and
return TRUE to stop further search.
@@ -1134,7 +1147,7 @@
/*
-=item C<static int mmd_search_local>
+=item C<static int mmd_search_local(PARROT_INTERP, STRING *name, PMC *candidates)>
Search the current package namespace for matching candidates. Return
TRUE if the MMD search should stop.
@@ -1155,7 +1168,8 @@
/*
-=item C<static void mmd_search_by_sig_obj>
+=item C<static void mmd_search_by_sig_obj(PARROT_INTERP, STRING *name,
+PMC *sig_obj, PMC *candidates)>
Search the namespace of the first argument to the sub call for matching
candidates.
@@ -1191,7 +1205,7 @@
/*
-=item C<static void mmd_search_global>
+=item C<static void mmd_search_global(PARROT_INTERP, STRING *name, PMC *cl)>
Search the builtin namespace for matching candidates.
@@ -1217,7 +1231,7 @@
/*
-=item C<static void mmd_add_multi_global>
+=item C<static void mmd_add_multi_global(PARROT_INTERP, STRING *sub_name, PMC *sub_obj)>
Create a MultiSub, or add a variant to an existing MultiSub. The MultiSub is
stored in the global MULTI namespace.
@@ -1247,7 +1261,8 @@
/*
-=item C<static void mmd_add_multi_to_namespace>
+=item C<static void mmd_add_multi_to_namespace(PARROT_INTERP, STRING *ns_name,
+STRING *sub_name, PMC *sub_obj)>
Create a MultiSub, or add a variant to an existing MultiSub. The MultiSub is
added as a method to a class.
@@ -1278,7 +1293,8 @@
/*
-=item C<void Parrot_mmd_add_multi_from_long_sig>
+=item C<void Parrot_mmd_add_multi_from_long_sig(PARROT_INTERP,
+STRING *sub_name, STRING *long_sig, PMC *sub_obj)>
Create a MultiSub, or add a variant to an existing MultiSub. The MultiSub is
stored in the global MULTI namespace.
@@ -1318,7 +1334,9 @@
/*
-=item C<void Parrot_mmd_add_multi_from_c_args>
+=item C<void Parrot_mmd_add_multi_from_c_args(PARROT_INTERP,
+const char *sub_name, const char *short_sig,
+const char *long_sig, funcptr_t multi_func_ptr)>
Create a MultiSub, or add a variant to an existing MultiSub. The MultiSub is
stored in the specified namespace.
@@ -1358,7 +1376,8 @@
/*
-=item C<void Parrot_mmd_add_multi_list_from_c_args>
+=item C<void Parrot_mmd_add_multi_list_from_c_args(PARROT_INTERP,
+const multi_func_list *mmd_info, INTVAL elements)>
Create a collection of multiple dispatch subs from a C structure of
information. Iterate through the list of details passed in. For each entry
@@ -1394,7 +1413,7 @@
/*
-=item C<MMD_Cache * Parrot_mmd_cache_create>
+=item C<MMD_Cache * Parrot_mmd_cache_create(PARROT_INTERP)>
Creates and returns a new MMD cache.
@@ -1416,7 +1435,8 @@
/*
-=item C<static STRING * mmd_cache_key_from_values>
+=item C<static STRING * mmd_cache_key_from_values(PARROT_INTERP,
+const char *name, PMC *values)>
Generates an MMD cache key from an array of values.
@@ -1461,7 +1481,8 @@
/*
-=item C<PMC * Parrot_mmd_cache_lookup_by_values>
+=item C<PMC * Parrot_mmd_cache_lookup_by_values(PARROT_INTERP, MMD_Cache *cache,
+const char *name, PMC *values)>
Takes an array of values for the call and does a lookup in the MMD cache.
@@ -1487,7 +1508,8 @@
/*
-=item C<void Parrot_mmd_cache_store_by_values>
+=item C<void Parrot_mmd_cache_store_by_values(PARROT_INTERP, MMD_Cache *cache,
+const char *name, PMC *values, PMC *chosen)>
Takes an array of values for the call along with a chosen candidate and puts
it into the cache.
@@ -1511,7 +1533,8 @@
/*
-=item C<static STRING * mmd_cache_key_from_types>
+=item C<static STRING * mmd_cache_key_from_types(PARROT_INTERP,
+const char *name, PMC *types)>
Generates an MMD cache key from an array of types.
@@ -1558,7 +1581,8 @@
/*
-=item C<PMC * Parrot_mmd_cache_lookup_by_types>
+=item C<PMC * Parrot_mmd_cache_lookup_by_types(PARROT_INTERP, MMD_Cache *cache,
+const char *name, PMC *types)>
Takes an array of types for the call and does a lookup in the MMD cache.
@@ -1584,7 +1608,8 @@
/*
-=item C<void Parrot_mmd_cache_store_by_types>
+=item C<void Parrot_mmd_cache_store_by_types(PARROT_INTERP, MMD_Cache *cache,
+const char *name, PMC *types, PMC *chosen)>
Takes an array of types for the call along with a chosen candidate and puts
it into the cache. The name parameter is optional, and if the cache is already
@@ -1609,7 +1634,7 @@
/*
-=item C<void Parrot_mmd_cache_mark>
+=item C<void Parrot_mmd_cache_mark(PARROT_INTERP, MMD_Cache *cache)>
GC-marks an MMD cache.
@@ -1631,7 +1656,7 @@
/*
-=item C<void Parrot_mmd_cache_destroy>
+=item C<void Parrot_mmd_cache_destroy(PARROT_INTERP, MMD_Cache *cache)>
Destroys an MMD cache.
Modified: trunk/src/runops_cores.c
==============================================================================
--- trunk/src/runops_cores.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/runops_cores.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -266,7 +266,7 @@
/*
-=item C<opcode_t * runops_fast_core>
+=item C<opcode_t * runops_fast_core(PARROT_INTERP, opcode_t *pc)>
Runs the Parrot operations starting at C<pc> until there are no more
operations. This performs no bounds checking, profiling, or tracing.
@@ -295,7 +295,7 @@
/*
-=item C<opcode_t * runops_cgoto_core>
+=item C<opcode_t * runops_cgoto_core(PARROT_INTERP, opcode_t *pc)>
Runs the Parrot operations starting at C<pc> until there are no more
operations, using the computed C<goto> core, performing no bounds checking,
@@ -341,7 +341,7 @@
/*
-=item C<static opcode_t * runops_trace_core>
+=item C<static opcode_t * runops_trace_core(PARROT_INTERP, opcode_t *pc)>
Runs the Parrot operations starting at C<pc> until there are no more
operations, using the tracing interpreter.
@@ -428,7 +428,7 @@
/*
-=item C<opcode_t * runops_slow_core>
+=item C<opcode_t * runops_slow_core(PARROT_INTERP, opcode_t *pc)>
Runs the Parrot operations starting at C<pc> until there are no more
operations, with tracing and bounds checking enabled.
@@ -467,7 +467,7 @@
/*
-=item C<opcode_t * runops_gc_debug_core>
+=item C<opcode_t * runops_gc_debug_core(PARROT_INTERP, opcode_t *pc)>
Runs the Parrot operations starting at C<pc> until there are no more
operations, performing a full GC run before each op. This is very slow, but
@@ -503,7 +503,7 @@
/*
-=item C<opcode_t * runops_profile_core>
+=item C<opcode_t * runops_profile_core(PARROT_INTERP, opcode_t *pc)>
Runs the Parrot operations starting at C<pc> until there are no more
operations, with tracing, bounds checking, and profiling enabled.
@@ -552,7 +552,7 @@
/*
-=item C<opcode_t * runops_debugger_core>
+=item C<opcode_t * runops_debugger_core(PARROT_INTERP, opcode_t *pc)>
Used by the debugger, under construction
Modified: trunk/src/stacks.c
==============================================================================
--- trunk/src/stacks.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/stacks.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -40,7 +40,7 @@
/*
-=item C<void stack_system_init>
+=item C<void stack_system_init(PARROT_INTERP)>
Called from C<make_interpreter()> to initialize the interpreter's
register stacks.
@@ -58,7 +58,7 @@
/*
-=item C<Stack_Chunk_t * cst_new_stack_chunk>
+=item C<Stack_Chunk_t * cst_new_stack_chunk(PARROT_INTERP, const Stack_Chunk_t *chunk)>
Get a new chunk either from the freelist or allocate one.
@@ -87,7 +87,7 @@
/*
-=item C<Stack_Chunk_t * new_stack>
+=item C<Stack_Chunk_t * new_stack(PARROT_INTERP, const char *name)>
Create a new stack and name it. C<< stack->name >> is used for
debugging/error reporting.
@@ -116,7 +116,7 @@
/*
-=item C<void mark_stack>
+=item C<void mark_stack(PARROT_INTERP, Stack_Chunk_t *chunk)>
Mark entries in a stack structure during GC.
@@ -146,7 +146,7 @@
/*
-=item C<void stack_destroy>
+=item C<void stack_destroy(Stack_Chunk_t *top)>
stack_destroy() doesn't need to do anything, since GC does it all.
@@ -164,7 +164,7 @@
/*
-=item C<size_t stack_height>
+=item C<size_t stack_height(PARROT_INTERP, const Stack_Chunk_t *chunk)>
Returns the height of the stack. The maximum "depth" is height - 1.
@@ -192,7 +192,7 @@
/*
-=item C<Stack_Entry_t * stack_entry>
+=item C<Stack_Entry_t * stack_entry(PARROT_INTERP, Stack_Chunk_t *stack, INTVAL depth)>
If C<< depth >= 0 >>, return the entry at that depth from the top of the
stack, with 0 being the top entry. If C<depth < 0>, then return the
@@ -234,7 +234,7 @@
/*
-=item C<Stack_Entry_t* stack_prepare_push>
+=item C<Stack_Entry_t* stack_prepare_push(PARROT_INTERP, Stack_Chunk_t **stack_p)>
Return a pointer, where new entries go for push.
@@ -260,7 +260,8 @@
/*
-=item C<void stack_push>
+=item C<void stack_push(PARROT_INTERP, Stack_Chunk_t **stack_p,
+void *thing, Stack_entry_type type, Stack_cleanup_method cleanup)>
Push something on the generic stack.
@@ -307,7 +308,7 @@
/*
-=item C<Stack_Entry_t* stack_prepare_pop>
+=item C<Stack_Entry_t* stack_prepare_pop(PARROT_INTERP, Stack_Chunk_t **stack_p)>
Return a pointer, where new entries are popped off.
@@ -336,7 +337,8 @@
/*
-=item C<void * stack_pop>
+=item C<void * stack_pop(PARROT_INTERP, Stack_Chunk_t **stack_p,
+void *where, Stack_entry_type type)>
Pop off an entry and return a pointer to the contents.
@@ -395,7 +397,7 @@
/*
-=item C<void * pop_dest>
+=item C<void * pop_dest(PARROT_INTERP)>
Pop off a destination entry and return a pointer to the contents.
@@ -420,7 +422,8 @@
/*
-=item C<void * stack_peek>
+=item C<void * stack_peek(PARROT_INTERP, Stack_Chunk_t *stack_base,
+Stack_entry_type *type)>
Peek at stack and return pointer to entry and the type of the entry.
@@ -451,7 +454,7 @@
/*
-=item C<Stack_entry_type get_entry_type>
+=item C<Stack_entry_type get_entry_type(const Stack_Entry_t *entry)>
Returns the stack entry type of C<entry>.
@@ -470,7 +473,7 @@
/*
-=item C<void Parrot_dump_dynamic_environment>
+=item C<void Parrot_dump_dynamic_environment(PARROT_INTERP, Stack_Chunk_t *dynamic_env)>
Print a representation of the dynamic stack to the standard error (using
C<Parrot_io_eprintf>). This is used only temporarily for debugging.
@@ -518,7 +521,7 @@
/*
-=item C<static void run_cleanup_action>
+=item C<static void run_cleanup_action(PARROT_INTERP, Stack_Entry_t *e)>
Runs the sub PMC from the Stack_Entry_t pointer with an INTVAL arg of 0. Used
in C<Parrot_push_action>.
@@ -541,7 +544,7 @@
/*
-=item C<void Parrot_push_action>
+=item C<void Parrot_push_action(PARROT_INTERP, PMC *sub)>
Pushes an action handler onto the dynamic environment.
@@ -564,7 +567,7 @@
/*
-=item C<void Parrot_push_mark>
+=item C<void Parrot_push_mark(PARROT_INTERP, INTVAL mark)>
Push a cleanup mark onto the dynamic environment.
@@ -583,7 +586,7 @@
/*
-=item C<void Parrot_pop_mark>
+=item C<void Parrot_pop_mark(PARROT_INTERP, INTVAL mark)>
Pop items off the dynamic environment up to the mark.
Modified: trunk/src/trace.c
==============================================================================
--- trunk/src/trace.c Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/src/trace.c Mon Mar 30 22:58:47 2009 (r37821)
@@ -46,7 +46,7 @@
/*
-=item C<static STRING* trace_class_name>
+=item C<static STRING* trace_class_name(PARROT_INTERP, const PMC* pmc)>
Obtains the class name of the PMC.
@@ -74,7 +74,7 @@
/*
-=item C<void trace_pmc_dump>
+=item C<void trace_pmc_dump(PARROT_INTERP, PMC *pmc)>
Prints a PMC to C<stderr>.
@@ -162,7 +162,7 @@
/*
-=item C<int trace_key_dump>
+=item C<int trace_key_dump(PARROT_INTERP, PMC *key)>
Prints a key to C<stderr>, returns the length of the output.
@@ -241,12 +241,13 @@
/*
-=item C<void trace_op_dump>
-
-TODO: This isn't really part of the API, but here's its documentation.
+=item C<void trace_op_dump(PARROT_INTERP, const opcode_t *code_start,
+const opcode_t *pc)>
Prints the PC, OP and ARGS. Used by C<trace_op()>.
+I<Not really part of the API.>
+
=cut
*/
@@ -476,13 +477,14 @@
/*
-=item C<void trace_op>
-
-TODO: This isn't really part of the API, but here's its documentation.
+=item C<void trace_op(PARROT_INTERP, const opcode_t *code_start,
+const opcode_t *code_end, const opcode_t *pc)>
Prints the PC, OP and ARGS. Used by C<runops_trace()>. With bounds
checking.
+I<Not really part of the API.>
+
=cut
*/
Modified: trunk/t/codingstd/c_function_docs.t
==============================================================================
--- trunk/t/codingstd/c_function_docs.t Mon Mar 30 16:29:06 2009 (r37820)
+++ trunk/t/codingstd/c_function_docs.t Mon Mar 30 22:58:47 2009 (r37821)
@@ -118,7 +118,6 @@
# unchecked
compilers/imcc/debug.c
-compilers/imcc/imc.c
compilers/imcc/instructions.c
compilers/imcc/main.c
compilers/imcc/optimizer.c
@@ -137,7 +136,6 @@
compilers/pirc/src/pirop.c
compilers/pirc/src/pirpcc.c
compilers/pirc/src/pirregalloc.c
-compilers/pirc/src/pirsymbol.c
config/gen/platform/ansi/dl.c
config/gen/platform/ansi/exec.c
@@ -168,16 +166,8 @@
src/atomic/gcc_x86.c
-src/call/ops.c
src/call/pcc.c
-src/gc/generational_ms.c
-
-src/io/io_string.c
-src/io/socket_api.c
-src/io/socket_unix.c
-src/io/socket_win32.c
-
src/jit/hppa/jit_emit.h
src/jit/amd64/jit_defs.c
src/jit/arm/exec_dep.c
@@ -191,19 +181,10 @@
src/jit/alpha/jit_emit.h
src/jit/arm/jit_emit.h
-src/string/charset/ascii.c
-src/string/charset/binary.c
-src/string/charset/iso-8859-1.c
-src/string/charset/unicode.c
-
-src/byteorder.c
src/debug.c
src/dynext.c
-src/embed.c
src/events.c
src/exceptions.c
-src/exec.c
-src/exit.c
src/extend.c
src/global.c
src/hash.c
@@ -212,11 +193,9 @@
src/inter_misc.c
src/interpreter.c
src/key.c
-src/library.c
src/list.c
src/malloc-trace.c
src/misc.c
-src/multidispatch.c
src/nci_test.c
src/oo.c
src/packdump.c
@@ -231,18 +210,26 @@
src/pic_jit.c
src/pmc.c
src/pmc_freeze.c
-src/runops_cores.c
src/spf_render.c
src/spf_vtable.c
-src/stacks.c
src/sub.c
src/thread.c
-src/trace.c
src/tsq.c
src/utils.c
# Needs docs written. Boilerplate in place.
src/datatypes.c
+src/gc/generational_ms.c
+src/io/io_string.c
+src/io/socket_api.c
+src/io/socket_unix.c
+src/io/socket_win32.c
+src/multidispatch.c
+src/string/charset/ascii.c
+src/string/charset/binary.c
+src/string/charset/iso-8859-1.c
+src/string/charset/unicode.c
+
# Local Variables:
# mode: cperl
More information about the parrot-commits
mailing list