[svn:parrot] r37845 - in trunk: compilers/imcc src t/codingstd
coke at svn.parrot.org
coke at svn.parrot.org
Wed Apr 1 18:19:57 UTC 2009
Author: coke
Date: Wed Apr 1 18:19:56 2009
New Revision: 37845
URL: https://trac.parrot.org/parrot/changeset/37845
Log:
[t/docs] fixup more function docs (mostly signature fixups)
some new boilerplate. 1075 functions left
Modified:
trunk/compilers/imcc/debug.c
trunk/compilers/imcc/symreg.c
trunk/src/packdump.c
trunk/src/packout.c
trunk/src/parrot_debugger.c
trunk/src/pbc_disassemble.c
trunk/src/pbc_dump.c
trunk/src/pbc_merge.c
trunk/src/pic.c
trunk/src/pic_jit.c
trunk/src/pmc_freeze.c
trunk/src/spf_render.c
trunk/src/spf_vtable.c
trunk/src/utils.c
trunk/t/codingstd/c_function_docs.t
Modified: trunk/compilers/imcc/debug.c
==============================================================================
--- trunk/compilers/imcc/debug.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/compilers/imcc/debug.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -30,7 +30,7 @@
/*
-=item C<void IMCC_fatal>
+=item C<void IMCC_fatal(PARROT_INTERP, int code, const char *fmt, ...)>
Prints out a fatal error message from IMCC and throws an
IMCC_FATAL_EXCEPTION.
@@ -55,7 +55,7 @@
/*
-=item C<void IMCC_fataly>
+=item C<void IMCC_fataly(PARROT_INTERP, int code, const char *fmt, ...)>
Throws an IMCC_FATALY_EXCEPTION.
@@ -79,7 +79,7 @@
/*
-=item C<void IMCC_fatal_standalone>
+=item C<void IMCC_fatal_standalone(PARROT_INTERP, int code, const char *fmt, ...)>
Prints an error message from IMCC and exits Parrot. This is not a
recoverable exception but a forced exit.
@@ -104,7 +104,7 @@
/*
-=item C<void IMCC_fataly_standalone>
+=item C<void IMCC_fataly_standalone(PARROT_INTERP, int code, const char *fmt, ...)>
Prints an error message and exits Parrot. This is not a recoverable
error.
@@ -132,7 +132,7 @@
/*
-=item C<void IMCC_warning>
+=item C<void IMCC_warning(PARROT_INTERP, const char *fmt, ...)>
Prints a warning message, but does not throw an exception and does not
cause Parrot to exit.
@@ -157,7 +157,7 @@
/*
-=item C<void IMCC_info>
+=item C<void IMCC_info(PARROT_INTERP, int level, const char *fmt, ...)>
Prints some information, if the level of the information is higher
then IMCC's verbose mode.
@@ -183,7 +183,7 @@
/*
-=item C<void IMCC_debug>
+=item C<void IMCC_debug(PARROT_INTERP, int level, const char *fmt, ...)>
Prints a debug message, if IMCC's debug mode is turned on.
@@ -207,7 +207,7 @@
/*
-=item C<void dump_instructions>
+=item C<void dump_instructions(PARROT_INTERP, const IMC_Unit *unit)>
Dumps the current instruction status of IMCC
@@ -252,7 +252,7 @@
/*
-=item C<void dump_cfg>
+=item C<void dump_cfg(const IMC_Unit *unit)>
Dumps the current IMCC config data.
@@ -292,7 +292,7 @@
/*
-=item C<void dump_loops>
+=item C<void dump_loops(const IMC_Unit *unit)>
Dumps the current loops in the IMC_Unit C<unit>.
@@ -339,7 +339,7 @@
/*
-=item C<void dump_labels>
+=item C<void dump_labels(const IMC_Unit *unit)>
Dumps the list of labels in IMC_Unit C<unit>.
@@ -373,7 +373,7 @@
/*
-=item C<void dump_symreg>
+=item C<void dump_symreg(const IMC_Unit *unit)>
Dumps a list of the symbolic registers in IMC_Unit C<unit>
@@ -421,7 +421,7 @@
/*
-=item C<void dump_liveness_status>
+=item C<void dump_liveness_status(const IMC_Unit *unit)>
Dumps the list of registers in the current IMC_Unit that need to be
allocated.
@@ -451,7 +451,7 @@
/*
-=item C<void dump_liveness_status_var>
+=item C<void dump_liveness_status_var(const IMC_Unit *unit, const SymReg* r)>
Dumps the state of SymReg C<r> in IMC_Unit C<unit>.
@@ -500,7 +500,7 @@
/*
-=item C<void dump_interference_graph>
+=item C<void dump_interference_graph(const IMC_Unit *unit)>
Dumps the interference graph for the current IMC_Unit C<unit>
@@ -540,7 +540,7 @@
/*
-=item C<void dump_dominators>
+=item C<void dump_dominators(const IMC_Unit *unit)>
Dumps the current list of dominators for the current IMC_Unit C<unit>.
@@ -574,7 +574,7 @@
/*
-=item C<void dump_dominance_frontiers>
+=item C<void dump_dominance_frontiers(const IMC_Unit *unit)>
Dumps the list of dominance frontiers for the current IMC_Unit C<unit>.
Modified: trunk/compilers/imcc/symreg.c
==============================================================================
--- trunk/compilers/imcc/symreg.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/compilers/imcc/symreg.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -119,7 +119,7 @@
/*
-=item C<void push_namespace>
+=item C<void push_namespace(PARROT_INTERP, const char *name)>
Begins a new namespace in PASM/PIR, named after the given C<name>.
@@ -141,7 +141,7 @@
/*
-=item C<void pop_namespace>
+=item C<void pop_namespace(PARROT_INTERP, const char *name)>
Ends the current namespace, popping back to the previous. If the namespace
stack is empty, throws a syntax error.
@@ -176,7 +176,7 @@
/*
-=item C<static SymReg * _get_sym_typed>
+=item C<static SymReg * _get_sym_typed(const SymHash *hsh, const char *name, int t)>
Gets a symbol from the hash, with the given C<name> of the specific type C<t>.
@@ -206,7 +206,7 @@
/*
-=item C<static SymReg * _mk_symreg>
+=item C<static SymReg * _mk_symreg(SymHash *hsh, const char *name, int t)>
Makes a new SymReg in the given SymHash from a varname and type.
@@ -239,7 +239,7 @@
/*
-=item C<SymReg * mk_symreg>
+=item C<SymReg * mk_symreg(PARROT_INTERP, const char *name, int t)>
Makes a new SymReg in the current unit, given a varname and type.
@@ -264,7 +264,7 @@
/*
-=item C<char * symreg_to_str>
+=item C<char * symreg_to_str(const SymReg *s)>
Dumps a SymReg to a printable format.
@@ -307,7 +307,7 @@
/*
-=item C<SymReg * mk_temp_reg>
+=item C<SymReg * mk_temp_reg(PARROT_INTERP, int t)>
Makes a new unique and temporary SymReg of the specified type C<t>.
@@ -331,7 +331,7 @@
/*
-=item C<SymReg * mk_pcc_sub>
+=item C<SymReg * mk_pcc_sub(PARROT_INTERP, const char *name, int proto)>
Makes a SymReg representing a PCC sub of the given C<name> with the specified
type.
@@ -358,7 +358,7 @@
/*
-=item C<void add_namespace>
+=item C<void add_namespace(PARROT_INTERP, IMC_Unit *unit)>
Add the current namespace to a sub declaration.
@@ -396,7 +396,7 @@
/*
-=item C<void add_pcc_arg>
+=item C<void add_pcc_arg(SymReg *r, SymReg *arg)>
Adds a register or constant to the function arg list.
@@ -425,7 +425,7 @@
/*
-=item C<void add_pcc_result>
+=item C<void add_pcc_result(SymReg *r, SymReg *arg)>
Adds a register or constant to the function's return list.
@@ -456,7 +456,7 @@
/*
-=item C<void add_pcc_multi>
+=item C<void add_pcc_multi(SymReg *r, SymReg *arg)>
Adds a :multi signature to the sub.
@@ -479,7 +479,7 @@
/*
-=item C<void add_pcc_sub>
+=item C<void add_pcc_sub(SymReg *r, SymReg *arg)>
Sets the current sub in the given SymReg to the second SymReg.
@@ -497,7 +497,7 @@
/*
-=item C<void add_pcc_cc>
+=item C<void add_pcc_cc(SymReg *r, SymReg *arg)>
Adds a continuation (?) to the current sub.
@@ -515,7 +515,7 @@
/*
-=item C<SymReg * mk_pasm_reg>
+=item C<SymReg * mk_pasm_reg(PARROT_INTERP, const char *name)>
Makes a SymReg representing a PASM register.
@@ -547,7 +547,7 @@
/*
-=item C<static char * _mk_fullname>
+=item C<static char * _mk_fullname(const Namespace *ns, const char *name)>
Combines the namespace and name together, separated by a C<::>. If there's no
namespace, the name is returned on its own.
@@ -578,7 +578,7 @@
/*
-=item C<SymReg * mk_ident>
+=item C<SymReg * mk_ident(PARROT_INTERP, const char *name, int t)>
Makes a new identifier.
@@ -618,7 +618,7 @@
/*
-=item C<SymReg* mk_ident_ur>
+=item C<SymReg* mk_ident_ur(PARROT_INTERP, const char *name, int t)>
Creates and returns a SymReg representing a unique (non-volatile) register.
@@ -641,7 +641,8 @@
/*
-=item C<static SymReg * mk_pmc_const_2>
+=item C<static SymReg * mk_pmc_const_2(PARROT_INTERP, IMC_Unit *unit,
+SymReg *left, SymReg *rhs)>
Makes a constant PMC and inserts instructions to access it.
@@ -698,7 +699,8 @@
/*
-=item C<SymReg * mk_const_ident>
+=item C<SymReg * mk_const_ident(PARROT_INTERP, const char *name, int t,
+SymReg *val, int global)>
Makes a new identifier constant with value val.
@@ -750,7 +752,7 @@
/*
-=item C<SymReg * _mk_const>
+=item C<SymReg * _mk_const(SymHash *hsh, const char *name, int t)>
Makes a new constant (internal use only).
@@ -784,6 +786,14 @@
return r;
}
+/*
+
+=item C<static int int_overflows(const SymReg *r)>
+
+=cut
+
+*/
+
static int
int_overflows(ARGIN(const SymReg *r))
{
@@ -812,7 +822,7 @@
/*
-=item C<SymReg * mk_const>
+=item C<SymReg * mk_const(PARROT_INTERP, const char *name, int t)>
Makes a new constant (and populates the cache of global symbols).
@@ -837,7 +847,7 @@
/*
-=item C<static char * add_ns>
+=item C<static char * add_ns(PARROT_INTERP, const char *name)>
Adds a namespace to the current sub.
@@ -884,7 +894,8 @@
/*
-=item C<SymReg * _mk_address>
+=item C<SymReg * _mk_address(PARROT_INTERP, SymHash *hsh, const char *name,
+int uniq)>
Makes a new address (internal use only).
@@ -944,7 +955,7 @@
/*
-=item C<SymReg * mk_sub_label>
+=item C<SymReg * mk_sub_label(PARROT_INTERP, const char *name)>
Makes and stores a new address label for a sub. The label gets a fixup entry.
@@ -969,7 +980,7 @@
/*
-=item C<SymReg * mk_sub_address>
+=item C<SymReg * mk_sub_address(PARROT_INTERP, const char *name)>
Makes a symbol for a label. The symbol gets a fixup entry.
@@ -994,7 +1005,7 @@
/*
-=item C<SymReg * mk_local_label>
+=item C<SymReg * mk_local_label(PARROT_INTERP, const char *name)>
Makes a local symbol, giving it I<no> fixup entry.
@@ -1015,7 +1026,7 @@
/*
-=item C<SymReg * mk_label_address>
+=item C<SymReg * mk_label_address(PARROT_INTERP, const char *name)>
Makes a new label address.
@@ -1036,7 +1047,7 @@
/*
-=item C<SymReg * dup_sym>
+=item C<SymReg * dup_sym(const SymReg *r)>
Links keys to a keys structure = SymReg
@@ -1097,7 +1108,7 @@
/*
-=item C<SymReg * link_keys>
+=item C<SymReg * link_keys(PARROT_INTERP, int nargs, SymReg **keys, int force)>
Links keys together in a keychain.
@@ -1193,7 +1204,7 @@
/*
-=item C<void free_sym>
+=item C<void free_sym(SymReg *r)>
Frees all memory of the specified SymReg. If it has a pcc_sub_t entry, frees
all memory of that structure as well.
@@ -1239,7 +1250,7 @@
/*
-=item C<void create_symhash>
+=item C<void create_symhash(SymHash *hash)>
Creates a symbol hash table with space for 16 entries.
@@ -1259,7 +1270,7 @@
/*
-=item C<static void resize_symhash>
+=item C<static void resize_symhash(SymHash *hsh)>
Resizes a symbol hash table.
@@ -1319,7 +1330,7 @@
/*
-=item C<void _store_symreg>
+=item C<void _store_symreg(SymHash *hsh, SymReg *r)>
Stores a symbol in the hash (internal use only).
@@ -1347,7 +1358,7 @@
/*
-=item C<void store_symreg>
+=item C<void store_symreg(PARROT_INTERP, SymReg *r)>
Stores a symbol in the hash.
@@ -1365,7 +1376,7 @@
/*
-=item C<SymReg * _get_sym>
+=item C<SymReg * _get_sym(const SymHash *hsh, const char *name)>
Fetches a symbol from the hash (internal use only).
@@ -1395,7 +1406,7 @@
/*
-=item C<SymReg * get_sym>
+=item C<SymReg * get_sym(PARROT_INTERP, const char *name)>
Gets a symbol from the current unit's symbol table.
@@ -1415,7 +1426,8 @@
/*
-=item C<SymReg * _find_sym>
+=item C<SymReg * _find_sym(PARROT_INTERP, const Namespace *nspace,
+const SymHash *hsh, const char *name)>
Find a symbol hash or ghash (internal use only);
@@ -1459,7 +1471,7 @@
/*
-=item C<SymReg * find_sym>
+=item C<SymReg * find_sym(PARROT_INTERP, const char *name)>
Finds a symbol hash or ghash in the current unit, if it exists. Otherwise
returns NULL.
@@ -1484,7 +1496,7 @@
/*
-=item C<void clear_sym_hash>
+=item C<void clear_sym_hash(SymHash *hsh)>
Frees all memory of the symbols in the specified hash table.
@@ -1522,7 +1534,7 @@
/*
-=item C<void debug_dump_sym_hash>
+=item C<void debug_dump_sym_hash(const SymHash *hsh)>
Prints all identifiers in the specified hash table to stderr.
@@ -1548,7 +1560,7 @@
/*
-=item C<void clear_locals>
+=item C<void clear_locals(IMC_Unit *unit)>
Deletes all local symbols and clears life info from the given IMC_Unit.
@@ -1585,7 +1597,7 @@
/*
-=item C<void clear_globals>
+=item C<void clear_globals(PARROT_INTERP)>
Clears global symbols.
@@ -1608,7 +1620,7 @@
/*
-=item C<unsigned int hash_str>
+=item C<unsigned int hash_str(const char *str)>
Computes the hash value for the string argument.
Modified: trunk/src/packdump.c
==============================================================================
--- trunk/src/packdump.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/packdump.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2008, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
This program is free software. It is subject to the same license as
Parrot itself.
$Id$
@@ -52,7 +52,7 @@
/*
-=item C<void PackFile_ConstTable_dump>
+=item C<void PackFile_ConstTable_dump(PARROT_INTERP, const PackFile_ConstTable *self)>
Dumps the constant table C<self>.
@@ -75,7 +75,8 @@
/*
-=item C<static void PackFile_Constant_dump>
+=item C<static void PackFile_Constant_dump(PARROT_INTERP,
+const PackFile_ConstTable *ct, const PackFile_Constant *self)>
Dumps the constant C<self>.
@@ -121,9 +122,17 @@
"is_object"
};
-/* Given a word of flags, generate a dump line of the whole word in hex,
- * followed by individual bits.
- */
+/*
+
+=item C<static void pobj_flag_dump(PARROT_INTERP, long flags)>
+
+Given a word of flags, generate a dump line of the whole word in hex,
+followed by individual bits.
+
+=cut
+
+*/
+
static void
pobj_flag_dump(PARROT_INTERP, ARGIN_NULLOK(long flags))
{
@@ -365,7 +374,7 @@
/*
-=item C<void PackFile_Fixup_dump>
+=item C<void PackFile_Fixup_dump(PARROT_INTERP, const PackFile_FixupTable *ft)>
Dumps the fix-up table C<ft>.
Modified: trunk/src/packout.c
==============================================================================
--- trunk/src/packout.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/packout.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2007, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
This program is free software. It is subject to the same license as
Parrot itself.
$Id$
@@ -28,7 +28,7 @@
/*
-=item C<opcode_t PackFile_pack_size>
+=item C<opcode_t PackFile_pack_size(PARROT_INTERP, PackFile *self)>
Determine the size of the buffer needed in order to pack the PackFile
into a contiguous region of memory.
@@ -68,7 +68,7 @@
/*
-=item C<void PackFile_pack>
+=item C<void PackFile_pack(PARROT_INTERP, PackFile *self, opcode_t *cursor)>
Pack the PackFile into a contiguous region of memory.
@@ -143,7 +143,7 @@
/*
-=item C<size_t PackFile_ConstTable_pack_size>
+=item C<size_t PackFile_ConstTable_pack_size(PARROT_INTERP, PackFile_Segment *seg)>
Determine the size of the buffer needed in order to pack the PackFile
constant table into a contiguous region of memory.
@@ -168,7 +168,8 @@
/*
-=item C<opcode_t * PackFile_ConstTable_pack>
+=item C<opcode_t * PackFile_ConstTable_pack(PARROT_INTERP,
+PackFile_Segment *seg, opcode_t *cursor)>
Pack the PackFile ConstTable into a contiguous region of memory.
@@ -203,7 +204,8 @@
/*
-=item C<int PackFile_find_in_const>
+=item C<int PackFile_find_in_const(PARROT_INTERP,
+const PackFile_ConstTable *ct, PMC *key, int type)>
This is really ugly, we don't know where our C<PARROT_ARG_SC> key
constant is in constant table, so we have to search for it.
@@ -237,7 +239,9 @@
/*
-=item C<opcode_t * PackFile_Constant_pack>
+=item C<opcode_t * PackFile_Constant_pack(PARROT_INTERP,
+const PackFile_ConstTable *const_table,
+const PackFile_Constant *self, opcode_t *cursor)>
Pack a PackFile Constant into a contiguous region of memory.
Modified: trunk/src/parrot_debugger.c
==============================================================================
--- trunk/src/parrot_debugger.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/parrot_debugger.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2008, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
History:
@@ -240,9 +240,7 @@
/*
-=item C<static void PDB_add_exception_handler(Parrot_Interp)>
-
-Adds a default exception handler to PDB.
+=item C<static void PDB_run_code(PARROT_INTERP, int argc, char *argv[])>
=cut
Modified: trunk/src/pbc_disassemble.c
==============================================================================
--- trunk/src/pbc_disassemble.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/pbc_disassemble.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2003, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -74,7 +74,7 @@
/*
-=item C<int main(int argc, char *argv[])>
+=item C<int main(int argc, const char *argv[])>
The run-loop. Starts up an interpreter, loads the bytecode from the
command-line and disassembles it.
@@ -145,7 +145,7 @@
/*
-=item C<static void do_dis(PARROT_INTERP, outfile, option)>
+=item C<static void do_dis(PARROT_INTERP, const char *outfile, int options)>
Do the disassembling.
Modified: trunk/src/pbc_dump.c
==============================================================================
--- trunk/src/pbc_dump.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/pbc_dump.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2003, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -219,8 +219,7 @@
/*
-=item C<int
-main(int argc, char **argv)>
+=item C<int main(int argc, const char **argv)>
The run loop. Process the command-line arguments and dump accordingly.
Modified: trunk/src/pbc_merge.c
==============================================================================
--- trunk/src/pbc_merge.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/pbc_merge.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2005-2008, Parrot Foundation.
+Copyright (C) 2005-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -206,7 +206,7 @@
/*
-=item C<static void help>
+=item C<static void help(PARROT_INTERP)>
Print out the user help info.
@@ -226,7 +226,7 @@
/*
-=item C<static PackFile* pbc_merge_loadpbc>
+=item C<static PackFile* pbc_merge_loadpbc(PARROT_INTERP, const char *fullname)>
This function loads a PBC file and unpacks it. We can't
use Parrot_pbc_read because that is specified to also
@@ -318,7 +318,8 @@
/*
-=item C<static PackFile_ByteCode* pbc_merge_bytecode>
+=item C<static PackFile_ByteCode* pbc_merge_bytecode(PARROT_INTERP,
+pbc_merge_input **inputs, int num_inputs, PackFile *pf)>
This function merges the bytecode from the input packfiles, storing the
offsets that each bit of bytecode now exists at.
@@ -384,7 +385,8 @@
/*
-=item C<static PackFile_ConstTable* pbc_merge_constants>
+=item C<static PackFile_ConstTable* pbc_merge_constants(PARROT_INTERP,
+pbc_merge_input **inputs, int num_inputs, PackFile *pf, PackFile_ByteCode *bc)>
This function merges the constants tables from the input PBC files.
@@ -483,7 +485,8 @@
/*
-=item C<static void pbc_merge_fixups>
+=item C<static void pbc_merge_fixups(PARROT_INTERP, pbc_merge_input **inputs,
+int num_inputs, PackFile *pf, PackFile_ByteCode *bc)>
This function merges the fixups tables from the input PBC files.
@@ -579,7 +582,8 @@
/*
-=item C<static void pbc_merge_debugs>
+=item C<static void pbc_merge_debugs(PARROT_INTERP, pbc_merge_input **inputs,
+int num_inputs, PackFile *pf, PackFile_ByteCode *bc)>
This function merges the debug segments from the input PBC files.
@@ -649,7 +653,8 @@
/*
-=item C<static void pbc_merge_pic_index>
+=item C<static void pbc_merge_pic_index(PARROT_INTERP, pbc_merge_input **inputs,
+int num_inputs, PackFile *pf, PackFile_ByteCode *bc)>
This function merges the pic_index segments from the input PBC files.
@@ -701,7 +706,8 @@
/*
-=item C<static void pbc_merge_ctpointers>
+=item C<static void pbc_merge_ctpointers(PARROT_INTERP,
+pbc_merge_input **inputs, int num_inputs, PackFile_ByteCode *bc)>
This function corrects the pointers into the constants table found in the
bytecode.
@@ -785,7 +791,8 @@
/*
-=item C<static PackFile* pbc_merge_begin>
+=item C<static PackFile* pbc_merge_begin(PARROT_INTERP,
+pbc_merge_input **inputs, int num_inputs)>
This is the function that drives PBC merging process.
@@ -827,7 +834,8 @@
/*
-=item C<static void pbc_merge_write>
+=item C<static void pbc_merge_write(PARROT_INTERP, PackFile *pf,
+const char *filename)>
This functions writes out the merged packfile.
@@ -868,7 +876,7 @@
/*
-=item C<int main>
+=item C<int main(int argc, const char **argv)>
The main function that grabs console input, reads in the packfiles
provided they exist, hands them to another function that runs the
Modified: trunk/src/pic.c
==============================================================================
--- trunk/src/pic.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/pic.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2004-2008, Parrot Foundation.
+Copyright (C) 2004-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -251,7 +251,7 @@
/*
-=item C<void parrot_PIC_alloc_store>
+=item C<void parrot_PIC_alloc_store(PackFile_ByteCode *cs, size_t n)>
Initialize the PIC storage for the given code segment with the capacitiy of
holding at least C<n> MIC entries. The PIC_store itself, room for C<n> MICs and
@@ -292,7 +292,7 @@
/*
-=item C<void parrot_PIC_destroy>
+=item C<void parrot_PIC_destroy(PackFile_ByteCode *cs)>
Free memory for the PIC storage.
@@ -317,7 +317,7 @@
/*
-=item C<int parrot_PIC_op_is_cached>
+=item C<int parrot_PIC_op_is_cached(int op_code)>
Return true, if the opcode needs a PIC slot.
@@ -342,7 +342,7 @@
/*
-=item C<Parrot_MIC* parrot_PIC_alloc_mic>
+=item C<Parrot_MIC* parrot_PIC_alloc_mic(const PARROT_INTERP, size_t n)>
Allocate a new MIC structure for the C<n>th cached opcode in this
bytecode segement.
@@ -364,7 +364,7 @@
/*
-=item C<Parrot_PIC* parrot_PIC_alloc_pic>
+=item C<Parrot_PIC* parrot_PIC_alloc_pic(PARROT_INTERP)>
Allocate a new PIC structure for the C<n>th cached opcode in this
bytecode segement.
@@ -410,7 +410,7 @@
/*
-=item C<void * parrot_pic_opcode>
+=item C<void * parrot_pic_opcode(PARROT_INTERP, INTVAL op)>
=cut
@@ -439,7 +439,8 @@
/*
-=item C<static int pass_int>
+=item C<static int pass_int(PARROT_INTERP, PMC *sig, const char *src_base,
+const void **src, char *dest_base, void * const *dest)>
=cut
@@ -462,7 +463,8 @@
/*
-=item C<static int pass_num>
+=item C<static int pass_num(PARROT_INTERP, PMC *sig, const char *src_base,
+const void **src, char *dest_base, void * const *dest)>
=cut
@@ -485,7 +487,8 @@
/*
-=item C<static int pass_str>
+=item C<static int pass_str(PARROT_INTERP, PMC *sig, const char *src_base,
+const void **src, char *dest_base, void * const *dest)>
=cut
@@ -509,7 +512,8 @@
/*
-=item C<static int pass_pmc>
+=item C<static int pass_pmc(PARROT_INTERP, PMC *sig, const char *src_base,
+const void **src, char *dest_base, void * const *dest)>
=cut
@@ -532,7 +536,8 @@
/*
-=item C<static int pass_mixed>
+=item C<static int pass_mixed(PARROT_INTERP, PMC *sig, const char *src_base,
+void * const *src, char *dest_base, void * const *dest)>
=cut
@@ -615,7 +620,8 @@
/*
-=item C<int parrot_pic_check_sig>
+=item C<int parrot_pic_check_sig(PARROT_INTERP, PMC *sig1, PMC *sig2,
+int *type)>
return argument count and type of the signature or -1 if not pic-able
the type PARROT_ARG_CONSTANT stands for mixed types or constants
@@ -685,7 +691,8 @@
/*
-=item C<static int is_pic_param>
+=item C<static int is_pic_param(PARROT_INTERP, void **pc, Parrot_MIC *mic,
+opcode_t op)>
=cut
@@ -767,7 +774,8 @@
/*
-=item C<static int is_pic_func>
+=item C<static int is_pic_func(PARROT_INTERP, void **pc, Parrot_MIC *mic,
+int core_type)>
=cut
@@ -841,7 +849,8 @@
/*
-=item C<void parrot_PIC_prederef>
+=item C<void parrot_PIC_prederef(PARROT_INTERP, opcode_t op, void **pc_pred,
+int core)>
Define either the normal prederef function or the PIC stub, if PIC for
this opcode function is available. Called from C<do_prederef>.
@@ -904,7 +913,7 @@
/*
-=item C<static void parrot_pic_move>
+=item C<static void parrot_pic_move(PARROT_INTERP, Parrot_MIC *mic)>
=cut
@@ -938,7 +947,8 @@
/*
-=item C<void parrot_pic_find_infix_v_pp>
+=item C<void parrot_pic_find_infix_v_pp(PARROT_INTERP, PMC *left, PMC *right,
+Parrot_MIC *mic, opcode_t *cur_opcode)>
=cut
Modified: trunk/src/pic_jit.c
==============================================================================
--- trunk/src/pic_jit.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/pic_jit.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2006-2007, Parrot Foundation.
+Copyright (C) 2006-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -165,7 +165,8 @@
/*
-=item C<static opcode_t * pic_test_func>
+=item C<static opcode_t * pic_test_func(PARROT_INTERP, INTVAL *sig_bits,
+void **args)>
Determines whether the given subroutine C<sub> can be JIT'd. Counts the
number of registers used by the sub, and returns C<0> if more registers
@@ -193,7 +194,7 @@
/*
-=item C<static int jit_can_compile_sub>
+=item C<static int jit_can_compile_sub(PARROT_INTERP, PMC *sub_pmc)>
Determines whether the given subroutine C<sub> can be JIT'd. Counts the
number of registers used by the sub, and returns C<0> if more registers
@@ -241,7 +242,8 @@
/*
-=item C<static int args_match_params>
+=item C<static int args_match_params(PARROT_INTERP, PMC *sig_args,
+const PackFile_ByteCode *seg, const opcode_t *start)>
Returns C<1> if the passed arguments match the subroutine's parameter list.
Returns C<0> otherwise.
@@ -291,7 +293,7 @@
/*
-=item C<static int returns_match_results>
+=item C<static int returns_match_results(PARROT_INTERP, PMC *sig_ret, PMC *sig_result)>
Returns 1 if the return values match the returned results. Returns C<0>
otherwise.
@@ -330,7 +332,7 @@
/*
-=item C<static int call_is_safe>
+=item C<static int call_is_safe(PARROT_INTERP, PMC *sub_pmc, opcode_t **set_args)>
Returns C<1> if the passed arguments match the subroutine's parameter list.
Returns C<0> otherwise.
@@ -383,7 +385,8 @@
/*
-=item C<static int ops_jittable>
+=item C<static int ops_jittable(PARROT_INTERP, PMC *sub, PMC *sig_results,
+const PackFile_ByteCode *seg, opcode_t *pc, const opcode_t *end, int *flags)>
Returns 1 if the return values match the returned results. Returns C<0>
otherwise.
@@ -460,7 +463,8 @@
/*
-=item C<int parrot_pic_is_safe_to_jit>
+=item C<int parrot_pic_is_safe_to_jit(PARROT_INTERP, PMC *sub_pmc,
+PMC *sig_args, PMC *sig_results, int *flags)>
=cut
@@ -524,7 +528,7 @@
/*
-=item C<funcptr_t parrot_pic_JIT_sub>
+=item C<funcptr_t parrot_pic_JIT_sub(PARROT_INTERP, PMC *sub_pmc, int flags)>
=cut
Modified: trunk/src/pmc_freeze.c
==============================================================================
--- trunk/src/pmc_freeze.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/pmc_freeze.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -463,7 +463,8 @@
=over 4
-=item C<static void str_append>
+=item C<static void str_append(PARROT_INTERP, STRING *s, const void *b,
+size_t len)>
Appends C<len> bytes from buffer C<*b> to string C<*s>.
@@ -500,7 +501,7 @@
/*
-=item C<static void push_ascii_integer>
+=item C<static void push_ascii_integer(PARROT_INTERP, IMAGE_IO *io, INTVAL v)>
Pushes an ASCII version of the integer C<v> onto the end of the C<*io>
"stream".
@@ -520,7 +521,8 @@
/*
-=item C<static void push_ascii_number>
+=item C<static void push_ascii_number(PARROT_INTERP, const IMAGE_IO *io,
+FLOATVAL v)>
Pushes an ASCII version of the number C<v> onto the end of the C<*io>
"stream".
@@ -540,7 +542,8 @@
/*
-=item C<static void push_ascii_string>
+=item C<static void push_ascii_string(PARROT_INTERP, IMAGE_IO *io,
+const STRING *s)>
Pushes an ASCII version of the string C<*s> onto the end of the C<*io>
"stream".
@@ -575,7 +578,7 @@
/*
-=item C<static void push_ascii_pmc>
+=item C<static void push_ascii_pmc(PARROT_INTERP, IMAGE_IO *io, const PMC* v)>
Pushes an ASCII version of the PMC C<*v> onto the end of the C<*io>
"stream".
@@ -595,7 +598,7 @@
/*
-=item C<static INTVAL shift_ascii_integer>
+=item C<static INTVAL shift_ascii_integer(PARROT_INTERP, IMAGE_IO *io)>
Removes and returns an integer from the start of the C<*io> "stream".
@@ -621,7 +624,7 @@
/*
-=item C<static FLOATVAL shift_ascii_number>
+=item C<static FLOATVAL shift_ascii_number(PARROT_INTERP, IMAGE_IO *io)>
Removes and returns an number from the start of the C<*io> "stream".
@@ -647,7 +650,7 @@
/*
-=item C<static STRING* shift_ascii_string>
+=item C<static STRING* shift_ascii_string(PARROT_INTERP, IMAGE_IO *io)>
Removes and returns an string from the start of the C<*io> "stream".
@@ -680,7 +683,7 @@
/*
-=item C<static PMC* shift_ascii_pmc>
+=item C<static PMC* shift_ascii_pmc(PARROT_INTERP, IMAGE_IO *io)>
Removes and returns a PMC from the start of the C<*io> "stream".
@@ -713,7 +716,7 @@
=over 4
-=item C<static void op_check_size>
+=item C<static void op_check_size(PARROT_INTERP, STRING *s, size_t len)>
Checks the size of the "stream" buffer to see if it can accommodate
C<len> more bytes. If not then the buffer is expanded.
@@ -746,7 +749,7 @@
/*
-=item C<static void op_append>
+=item C<static void op_append(PARROT_INTERP, STRING *s, opcode_t b, size_t len)>
Appends the opcode C<b> to the string C<*s>.
@@ -766,7 +769,7 @@
/*
-=item C<static void push_opcode_integer>
+=item C<static void push_opcode_integer(PARROT_INTERP, IMAGE_IO *io, INTVAL v)>
Pushes the integer C<v> onto the end of the C<*io> "stream".
@@ -786,7 +789,7 @@
/*
-=item C<static void push_opcode_number>
+=item C<static void push_opcode_number(PARROT_INTERP, IMAGE_IO *io, FLOATVAL v)>
Pushes the number C<v> onto the end of the C<*io> "stream".
@@ -813,7 +816,7 @@
/*
-=item C<static void push_opcode_string>
+=item C<static void push_opcode_string(PARROT_INTERP, IMAGE_IO *io, STRING *v)>
Pushes the string C<*v> onto the end of the C<*io> "stream".
@@ -840,7 +843,7 @@
/*
-=item C<static void push_opcode_pmc>
+=item C<static void push_opcode_pmc(PARROT_INTERP, IMAGE_IO *io, PMC* v)>
Pushes the PMC C<*v> onto the end of the C<*io> "stream".
@@ -857,7 +860,7 @@
/*
-=item C<static INTVAL shift_opcode_integer>
+=item C<static INTVAL shift_opcode_integer(PARROT_INTERP, IMAGE_IO *io)>
Removes and returns an integer from the start of the C<*io> "stream".
@@ -882,7 +885,7 @@
/*
-=item C<static PMC* shift_opcode_pmc>
+=item C<static PMC* shift_opcode_pmc(PARROT_INTERP, IMAGE_IO *io)>
Removes and returns an PMC from the start of the C<*io> "stream".
@@ -904,7 +907,7 @@
/*
-=item C<static FLOATVAL shift_opcode_number>
+=item C<static FLOATVAL shift_opcode_number(PARROT_INTERP, IMAGE_IO *io)>
Removes and returns an number from the start of the C<*io> "stream".
@@ -929,7 +932,7 @@
/*
-=item C<static STRING* shift_opcode_string>
+=item C<static STRING* shift_opcode_string(PARROT_INTERP, IMAGE_IO *io)>
Removes and returns a string from the start of the C<*io> "stream".
@@ -962,7 +965,7 @@
=over 4
-=item C<static void pmc_add_ext>
+=item C<static void pmc_add_ext(PARROT_INTERP, PMC *pmc)>
Adds a C<PMC_EXT> to C<*pmc>.
@@ -980,7 +983,7 @@
/*
-=item C<static void cleanup_next_for_GC_pool>
+=item C<static void cleanup_next_for_GC_pool(Small_Object_Pool *pool)>
Sets all the C<next_for_GC> pointers to C<NULL>.
@@ -1010,7 +1013,7 @@
/*
-=item C<static void cleanup_next_for_GC>
+=item C<static void cleanup_next_for_GC(PARROT_INTERP)>
Cleans up the C<next_for_GC> pointers.
@@ -1058,7 +1061,7 @@
/*
-=item C<static void ft_init>
+=item C<static void ft_init(PARROT_INTERP, visit_info *info)>
Initializes the freeze/thaw subsystem.
@@ -1116,7 +1119,7 @@
/*
-=item C<static void todo_list_init>
+=item C<static void todo_list_init(PARROT_INTERP, visit_info *info)>
Initializes the C<*info> lists.
@@ -1141,7 +1144,8 @@
/*
-=item C<static void freeze_pmc>
+=item C<static void freeze_pmc(PARROT_INTERP, PMC *pmc, visit_info *info,
+int seen, UINTVAL id)>
Freeze PMC, setting type, seen, and "same-as-last" indicators as
appropriate.
@@ -1189,7 +1193,8 @@
/*
-=item C<static int thaw_pmc>
+=item C<static int thaw_pmc(PARROT_INTERP, visit_info *info, UINTVAL *id,
+INTVAL *type)>
Freeze and thaw a PMC (id).
@@ -1250,7 +1255,8 @@
/*
-=item C<static void do_action>
+=item C<static void do_action(PARROT_INTERP, PMC *pmc, visit_info *info,
+int seen, UINTVAL id)>
Called from C<visit_next_for_GC()> and C<visit_todo_list()> to perform
the action specified in C<< info->what >>.
@@ -1282,7 +1288,8 @@
/*
-=item C<static PMC* thaw_create_pmc>
+=item C<static PMC* thaw_create_pmc(PARROT_INTERP, const visit_info *info,
+INTVAL type)>
Called from C<do_thaw()> to attach the vtable etc. to C<*pmc>.
@@ -1313,7 +1320,7 @@
/*
-=item C<static void do_thaw>
+=item C<static void do_thaw(PARROT_INTERP, PMC* pmc, visit_info *info)>
Called by C<visit_todo_list_thaw()> to thaw and return a PMC.
@@ -1411,7 +1418,7 @@
/*
-=item C<static UINTVAL id_from_pmc>
+=item C<static UINTVAL id_from_pmc(PARROT_INTERP, PMC* pmc)>
Find a PMC in an arena, and return an id (left-shifted 2 bits),
based on its position.
@@ -1460,7 +1467,7 @@
/*
-=item C<static void add_pmc_next_for_GC>
+=item C<static void add_pmc_next_for_GC(PARROT_INTERP, PMC *pmc, visit_info *info)>
Remembers the PMC for later processing.
@@ -1480,7 +1487,8 @@
/*
-=item C<static int next_for_GC_seen>
+=item C<static int next_for_GC_seen(PARROT_INTERP, PMC *pmc,
+visit_info *info, UINTVAL *id)>
Remembers next child to visit via the C<next_for_GC pointer> generate a
unique ID per PMC and freeze the ID (not the PMC address) so thaw the
@@ -1526,7 +1534,7 @@
/*
-=item C<static void add_pmc_todo_list>
+=item C<static void add_pmc_todo_list(PARROT_INTERP, PMC *pmc, visit_info *info)>
Remembers the PMC to be processed later.
@@ -1543,7 +1551,8 @@
/*
-=item C<static int todo_list_seen>
+=item C<static int todo_list_seen(PARROT_INTERP, PMC *pmc, visit_info *info,
+UINTVAL *id)>
Returns true if the PMC was seen, otherwise it put it on the todo list,
generates an ID (tag) for PMC, offset by 4 as are addresses, low bits
@@ -1580,7 +1589,7 @@
/*
-=item C<static void visit_next_for_GC>
+=item C<static void visit_next_for_GC(PARROT_INTERP, PMC* pmc, visit_info* info)>
C<visit_child> callbacks:
@@ -1615,7 +1624,7 @@
/*
-=item C<static void visit_todo_list>
+=item C<static void visit_todo_list(PARROT_INTERP, PMC* pmc, visit_info* info)>
Checks the seen PMC via the todo list.
@@ -1643,7 +1652,7 @@
/*
-=item C<static void visit_todo_list_thaw>
+=item C<static void visit_todo_list_thaw(PARROT_INTERP, PMC* old, visit_info* info)>
Callback for thaw - action first.
@@ -1662,7 +1671,8 @@
/*
-=item C<static void visit_loop_next_for_GC>
+=item C<static void visit_loop_next_for_GC(PARROT_INTERP, PMC *current,
+visit_info *info)>
Put first item on todo list, then run as long as there are items to be
done.
@@ -1691,7 +1701,8 @@
/*
-=item C<static void visit_loop_todo_list>
+=item C<static void visit_loop_todo_list(PARROT_INTERP, PMC *current,
+visit_info *info)>
The thaw loop.
@@ -1768,7 +1779,7 @@
/*
-=item C<static void create_image>
+=item C<static void create_image(PARROT_INTERP, PMC *pmc, visit_info *info)>
Allocate image to some estimated size.
@@ -1798,7 +1809,7 @@
/*
-=item C<static PMC* run_thaw>
+=item C<static PMC* run_thaw(PARROT_INTERP, STRING* image, visit_enum_type what)>
Performs thawing. C<what> indicates what to be thawed.
@@ -1881,7 +1892,7 @@
=over 4
-=item C<STRING* Parrot_freeze_at_destruct>
+=item C<STRING* Parrot_freeze_at_destruct(PARROT_INTERP, PMC* pmc)>
This function must not consume any resources (except the image itself).
It uses the C<next_for_GC> pointer, so its not reentrant and must not be
@@ -1920,7 +1931,7 @@
/*
-=item C<STRING* Parrot_freeze>
+=item C<STRING* Parrot_freeze(PARROT_INTERP, PMC* pmc)>
Freeze using either method.
@@ -1963,7 +1974,7 @@
/*
-=item C<PMC* Parrot_thaw>
+=item C<PMC* Parrot_thaw(PARROT_INTERP, STRING* image)>
Thaw a PMC, called from the C<thaw> opcode.
@@ -1983,7 +1994,7 @@
/*
-=item C<PMC* Parrot_thaw_constants>
+=item C<PMC* Parrot_thaw_constants(PARROT_INTERP, STRING* image)>
Thaw the constants. This is used by PackFile for unpacking PMC
constants.
@@ -2004,7 +2015,7 @@
/*
-=item C<PMC* Parrot_clone>
+=item C<PMC* Parrot_clone(PARROT_INTERP, PMC* pmc)>
There are for sure shortcuts to clone faster, e.g. always thaw the image
immediately or use a special callback. But for now we just thaw a frozen
Modified: trunk/src/spf_render.c
==============================================================================
--- trunk/src/spf_render.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/spf_render.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2008, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -115,7 +115,8 @@
/*
-=item C<static STRING * handle_flags>
+=item C<static STRING * handle_flags(PARROT_INTERP, const SpfInfo *info,
+STRING *str, INTVAL is_int_type, STRING* prefix)>
Handles C<+>, C<->, C<0>, C<#>, space, width, and prec.
@@ -219,7 +220,8 @@
/*
-=item C<static STRING* str_append_w_flags>
+=item C<static STRING* str_append_w_flags(PARROT_INTERP, STRING *dest,
+const SpfInfo *info, STRING *src, STRING *prefix)>
Used by Parrot_sprintf_format. Prepends supplied prefix for numeric
values. (e.g. 0x for hex.)
@@ -243,7 +245,7 @@
/*
-=item C<static void gen_sprintf_call>
+=item C<static void gen_sprintf_call(char *out, SpfInfo *info, int thingy)>
Turn the info structure back into an sprintf format. Far from being
pointless, this is used to call C<snprintf()> when we're confronted with
@@ -307,7 +309,8 @@
/*
-=item C<STRING * Parrot_sprintf_format>
+=item C<STRING * Parrot_sprintf_format(PARROT_INTERP, STRING *pat,
+SPRINTF_OBJ *obj)>
This is the engine that does all the formatting.
Modified: trunk/src/spf_vtable.c
==============================================================================
--- trunk/src/spf_vtable.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/spf_vtable.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2008, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -161,7 +161,7 @@
/*
-=item C<static STRING * getchr_va>
+=item C<static STRING * getchr_va(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Gets a C<char> out of the C<va_list> in C<obj> and returns it as a
Parrot C<STRING>.
@@ -188,7 +188,7 @@
/*
-=item C<static HUGEINTVAL getint_va>
+=item C<static HUGEINTVAL getint_va(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Gets an integer out of the C<va_list> in C<obj> and returns it as a
Parrot C<STRING>.
@@ -238,7 +238,7 @@
/*
-=item C<static UHUGEINTVAL getuint_va>
+=item C<static UHUGEINTVAL getuint_va(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Gets an unsigned integer out of the C<va_list> in C<obj> and returns it
as a Parrot C<STRING>.
@@ -288,7 +288,7 @@
/*
-=item C<static HUGEFLOATVAL getfloat_va>
+=item C<static HUGEFLOATVAL getfloat_va(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Gets an floating-point number out of the C<va_list> in C<obj> and
returns it as a Parrot C<STRING>.
@@ -334,7 +334,7 @@
/*
-=item C<static STRING * getstring_va>
+=item C<static STRING * getstring_va(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Gets an string out of the C<va_list> in C<obj> and returns it as a
Parrot C<STRING>.
@@ -385,7 +385,7 @@
/*
-=item C<static void * getptr_va>
+=item C<static void * getptr_va(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Gets a C<void *> out of the C<va_list> in C<obj> and returns it.
@@ -419,7 +419,7 @@
=over 4
-=item C<static STRING * getchr_pmc>
+=item C<static STRING * getchr_pmc(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Same as C<getchr_va()> except that a vtable is used to get the value
from C<obj>.
@@ -447,7 +447,7 @@
/*
-=item C<static HUGEINTVAL getint_pmc>
+=item C<static HUGEINTVAL getint_pmc(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Same as C<getint_va()> except that a vtable is used to get the value
from C<obj>.
@@ -486,7 +486,7 @@
/*
-=item C<static UHUGEINTVAL getuint_pmc>
+=item C<static UHUGEINTVAL getuint_pmc(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Same as C<getuint_va()> except that a vtable is used to get the value
from C<obj>.
@@ -525,7 +525,7 @@
/*
-=item C<static HUGEFLOATVAL getfloat_pmc>
+=item C<static HUGEFLOATVAL getfloat_pmc(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Same as C<getfloat_va()> except that a vtable is used to get the value
from C<obj>.
@@ -561,7 +561,7 @@
/*
-=item C<static STRING * getstring_pmc>
+=item C<static STRING * getstring_pmc(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Same as C<getstring_va()> except that a vtable is used to get the value
from C<obj>.
@@ -588,7 +588,7 @@
/*
-=item C<static void * getptr_pmc>
+=item C<static void * getptr_pmc(PARROT_INTERP, INTVAL size, SPRINTF_OBJ *obj)>
Same as C<getptr_va()> except that a vtable is used to get the value
from C<obj>.
Modified: trunk/src/utils.c
==============================================================================
--- trunk/src/utils.c Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/src/utils.c Wed Apr 1 18:19:56 2009 (r37845)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2008, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -94,7 +94,7 @@
/*
-=item C<INTVAL intval_mod>
+=item C<INTVAL intval_mod(INTVAL i2, INTVAL i3)>
NOTE: This "corrected mod" algorithm is based on the C code on page 70
of [1]. Assuming correct behavior of the built-in mod operator (%) with
@@ -155,7 +155,7 @@
/*
-=item C<FLOATVAL floatval_mod>
+=item C<FLOATVAL floatval_mod(FLOATVAL n2, FLOATVAL n3)>
Returns C<n2 mod n3>.
@@ -225,7 +225,7 @@
/*
-=item C<static void next_rand>
+=item C<static void next_rand(_rand_buf X)>
Returns the next random number in C<X>.
@@ -258,7 +258,7 @@
/*
-=item C<static FLOATVAL _erand48>
+=item C<static FLOATVAL _erand48(_rand_buf buf)>
Returns a C<double> in the interval C<[0.0, 1.0)>.
@@ -278,7 +278,7 @@
/*
-=item C<static FLOATVAL _drand48>
+=item C<static FLOATVAL _drand48(void)>
Returns a C<double> in the interval C<[0.0, 1.0)>.
@@ -295,7 +295,7 @@
/*
-=item C<static long _jrand48>
+=item C<static long _jrand48(_rand_buf buf)>
Returns a C<long> in the interval C<[-2^31, 2^31)>.
@@ -315,7 +315,7 @@
/*
-=item C<static long _nrand48>
+=item C<static long _nrand48(_rand_buf buf)>
Returns a C<long> in the interval C<[0, 2^31)>.
@@ -332,7 +332,7 @@
/*
-=item C<static long _lrand48>
+=item C<static long _lrand48(void)>
Returns a C<long> in the interval C<[0, 2^31)>.
@@ -349,7 +349,7 @@
/*
-=item C<static long _mrand48>
+=item C<static long _mrand48(void)>
Returns a C<long> in the interval C<[-2^31, 2^31)>.
@@ -366,7 +366,7 @@
/*
-=item C<static void _srand48>
+=item C<static void _srand48(long seed)>
Sets the high order 32 bits to the argument C<seed>. The low order 16
bits are set to the arbitrary value 0x330e.
@@ -409,7 +409,7 @@
/*
-=item C<FLOATVAL Parrot_float_rand>
+=item C<FLOATVAL Parrot_float_rand(INTVAL how_random)>
Returns a C<FLOATVAL> in the interval C<[0.0, 1.0)>.
@@ -431,7 +431,7 @@
/*
-=item C<INTVAL Parrot_uint_rand>
+=item C<INTVAL Parrot_uint_rand(INTVAL how_random)>
Returns an C<INTVAL> in the interval C<[0, 2^31)>.
@@ -453,7 +453,7 @@
/*
-=item C<INTVAL Parrot_int_rand>
+=item C<INTVAL Parrot_int_rand(INTVAL how_random)>
Returns an C<INTVAL> in the interval C<[-2^31, 2^31)>.
@@ -475,7 +475,7 @@
/*
-=item C<INTVAL Parrot_range_rand>
+=item C<INTVAL Parrot_range_rand(INTVAL from, INTVAL to, INTVAL how_random)>
Returns an C<INTVAL> in the range C<[from, to]>.
@@ -496,7 +496,7 @@
/*
-=item C<void Parrot_srand>
+=item C<void Parrot_srand(INTVAL seed)>
Seeds the random number generator with C<seed>.
@@ -529,7 +529,7 @@
/*
-=item C<PMC* tm_to_array>
+=item C<PMC* tm_to_array(PARROT_INTERP, const struct tm *tm)>
Helper to convert a B<struct tm *> to an Array
@@ -561,7 +561,8 @@
/*
-=item C<INTVAL Parrot_byte_index>
+=item C<INTVAL Parrot_byte_index(PARROT_INTERP, const STRING *base,
+const STRING *search, UINTVAL start_offset)>
Looks for the location of a substring within a longer string. Takes
pointers to the strings and the offset within the string at which
@@ -609,7 +610,8 @@
/*
-=item C<INTVAL Parrot_byte_rindex>
+=item C<INTVAL Parrot_byte_rindex(PARROT_INTERP, const STRING *base,
+const STRING *search, UINTVAL start_offset)>
Substring search (like Parrot_byte_index), but works backwards,
from the rightmost end of the string.
@@ -648,7 +650,7 @@
/*
-=item C<static void rec_climb_back_and_mark>
+=item C<static void rec_climb_back_and_mark(int node_index, parrot_prm_context* c)>
Recursive function, used by Parrot_register_move to
climb back the graph of register moves operations.
@@ -698,7 +700,8 @@
/*
-=item C<static void process_cycle_without_exit>
+=item C<static void process_cycle_without_exit(int node_index,
+parrot_prm_context* c)>
Recursive function, used by Parrot_register_move to handle the case
of cycles without exits, that are cycles of move ops between registers
@@ -737,7 +740,9 @@
/*
-=item C<void Parrot_register_move>
+=item C<void Parrot_register_move(PARROT_INTERP, int n_regs,
+unsigned char *dest_regs, unsigned char *src_regs, unsigned char temp_reg,
+reg_move_func mov, reg_move_func mov_alt, void *info)>
Move C<n_regs> from the given register list C<src_regs> to C<dest_regs>.
@@ -881,6 +886,14 @@
typedef INTVAL (*sort_func_t)(PARROT_INTERP, void *, void *);
+/*
+
+=item C<static INTVAL COMPARE(PARROT_INTERP, void *a, void *b, PMC *cmp)>
+
+=cut
+
+*/
+
/* TODO: Macroize COMPARE */
/* This is an awfully expensive function to call, what with all the */
/* comparisons that never change. We ought to precompute everything. */
@@ -899,6 +912,13 @@
return Parrot_runops_fromc_args_reti(interp, cmp, "IPP", a, b);
}
+/*
+
+=item C<void Parrot_quicksort(PARROT_INTERP, void **data, UINTVAL n, PMC *cmp)>
+
+=cut
+
+*/
void
Parrot_quicksort(PARROT_INTERP, ARGMOD(void **data), UINTVAL n, ARGIN(PMC *cmp))
Modified: trunk/t/codingstd/c_function_docs.t
==============================================================================
--- trunk/t/codingstd/c_function_docs.t Wed Apr 1 18:09:34 2009 (r37844)
+++ trunk/t/codingstd/c_function_docs.t Wed Apr 1 18:19:56 2009 (r37845)
@@ -117,7 +117,6 @@
# unchecked
-compilers/imcc/debug.c
compilers/imcc/instructions.c
compilers/imcc/main.c
compilers/imcc/optimizer.c
@@ -126,8 +125,6 @@
compilers/imcc/pcc.c
compilers/imcc/reg_alloc.c
compilers/imcc/sets.c
-compilers/imcc/symreg.c
-compilers/pirc/src/bcgen.c
compilers/pirc/src/pircapi.c
compilers/pirc/src/pircompiler.c
compilers/pirc/src/piremit.c
@@ -196,24 +193,12 @@
src/malloc-trace.c
src/nci_test.c
src/oo.c
-src/packdump.c
src/packfile.c
src/packfile/pf_items.c
-src/packout.c
-src/parrot_debugger.c
-src/pbc_disassemble.c
-src/pbc_dump.c
-src/pbc_merge.c
-src/pic.c
-src/pic_jit.c
-src/pmc.c
-src/pmc_freeze.c
-src/spf_render.c
-src/spf_vtable.c
src/thread.c
-src/utils.c
# Needs docs written. Boilerplate in place.
+compilers/imcc/symreg.c
src/datatypes.c
src/debug.c
src/gc/generational_ms.c
@@ -222,12 +207,19 @@
src/io/socket_unix.c
src/io/socket_win32.c
src/multidispatch.c
+src/parrot_debugger.c
+src/pic.c
+src/pic_jit.c
+src/pmc.c
src/string/charset/ascii.c
src/string/charset/binary.c
src/string/charset/iso-8859-1.c
src/string/charset/unicode.c
src/tsq.c
+src/utils.c
+# headerizer returns malformed signatures
+compilers/pirc/src/bcgen.c
# Local Variables:
# mode: cperl
More information about the parrot-commits
mailing list