Author: paultcochrane Date: Tue Nov 6 14:57:39 2007 New Revision: 22745 Modified: trunk/config/gen/platform/ansi/dl.c trunk/config/gen/platform/ansi/exec.c trunk/config/gen/platform/ansi/time.c trunk/config/gen/platform/generic/dl.c trunk/config/gen/platform/generic/env.c trunk/config/gen/platform/generic/exec.c trunk/config/gen/platform/generic/itimer.c trunk/config/gen/platform/generic/math.c trunk/config/gen/platform/generic/memalign.c trunk/config/gen/platform/generic/memexec.c trunk/config/gen/platform/generic/signal.c trunk/config/gen/platform/generic/stat.c trunk/config/gen/platform/generic/time.c
Log: [config] Getting there slowly with the function documentation Modified: trunk/config/gen/platform/ansi/dl.c ============================================================================== --- trunk/config/gen/platform/ansi/dl.c (original) +++ trunk/config/gen/platform/ansi/dl.c Tue Nov 6 14:57:39 2007 @@ -4,7 +4,31 @@ */ /* -** Parrot_dlopen() + +=head1 NAME + +config/gen/platform/ansi/dl.c + +=head1 DESCRIPTION + +TODO + +=head2 Functions + +=over 4 + +=cut + +*/ + +/* + +=item C<void * Parrot_dlopen(const char *filename)> + +TODO: Not yet documented!!! + +=cut + */ void * @@ -16,7 +40,13 @@ /* -** Parrot_dlerror() + +=item C<const char * Parrot_dlerror(void)> + +TODO: Not yet documented!!! + +=cut + */ const char * @@ -27,7 +57,13 @@ /* -** Parrot_dlsym() + +=item C<void * Parrot_dlsym(void *handle, const char *symbol)> + +TODO: Not yet documented!!! + +=cut + */ void * @@ -39,7 +75,13 @@ /* -** Parrot_dlclose() + +=item C<int Parrot_dlclose(void *handle)> + +TODO: Not yet documented!!! + +=cut + */ int @@ -50,6 +92,14 @@ } /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/ansi/exec.c ============================================================================== --- trunk/config/gen/platform/ansi/exec.c (original) +++ trunk/config/gen/platform/ansi/exec.c Tue Nov 6 14:57:39 2007 @@ -4,15 +4,51 @@ */ /* - * Spawn a subprocess - * - */ -INTVAL Parrot_Run_OS_Command(Parrot_Interp interp, STRING *command) { + +=head1 NAME + +config/gen/platform/ansi/exec.c + +=head1 DESCRIPTION + +TODO + +=head2 Functions + +=over 4 + +=cut + +*/ + +/* + +=item C<INTVAL Parrot_Run_OS_Command(Parrot_Interp interp, STRING *command)> + +Spawn a subprocess + +=cut + +*/ + +INTVAL +Parrot_Run_OS_Command(Parrot_Interp interp, STRING *command) +{ Parrot_warn(NULL, PARROT_WARNINGS_PLATFORM_FLAG, "Parrot_Run_OS_Command not implemented"); return 0; } +/* + +=item C<INTVAL Parrot_Run_OS_Command_Argv(Parrot_Interp interp, PMC *cmdargs)> + +TODO: Not yet documented!!! + +=cut + +*/ + INTVAL Parrot_Run_OS_Command_Argv(Parrot_Interp interp, PMC *cmdargs) { @@ -21,11 +57,31 @@ return 0; } -void Parrot_Exec_OS_Comman(Parrot_Interp interp, STRING *command) { +/* + +=item C<void Parrot_Exec_OS_Comman(Parrot_Interp interp, STRING *command)> + +TODO: Not yet documented!!! + +=cut + +*/ + +void +Parrot_Exec_OS_Comman(Parrot_Interp interp, STRING *command) +{ real_exception(interp, NULL, NOSPAWN, "Exec not implemented"); } /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/ansi/time.c ============================================================================== --- trunk/config/gen/platform/ansi/time.c (original) +++ trunk/config/gen/platform/ansi/time.c Tue Nov 6 14:57:39 2007 @@ -3,10 +3,34 @@ * Copyright (C) 2007, The Perl Foundation. */ +/* + +=head1 NAME + +config/gen/platform/ansi/time.c + +=head1 DESCRIPTION + +TODO + +=head2 Functions + +=over 4 + +=cut + +*/ + #include <time.h> /* -** Parrot_intval_time() + +=item C<INTVAL Parrot_intval_time(void)> + +TODO: Not yet documented!!! + +=cut + */ INTVAL @@ -17,7 +41,13 @@ /* -** Parrot_floatval_time() + +=item C<FLOATVAL Parrot_floatval_time(void)> + +TODO: Not yet documented!!! + +=cut + */ FLOATVAL @@ -31,7 +61,13 @@ /* -** Parrot_sleep() + +=item C<void Parrot_sleep(unsigned int seconds)> + +TODO: Not yet documented!!! + +=cut + */ void @@ -42,6 +78,14 @@ } /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/dl.c ============================================================================== --- trunk/config/gen/platform/generic/dl.c (original) +++ trunk/config/gen/platform/generic/dl.c Tue Nov 6 14:57:39 2007 @@ -4,7 +4,21 @@ */ /* -** Dynlib stuff + +=head1 NAME + +config/gen/platform/generic/dl.c + +=head1 DESCRIPTION + +Dynlib stuff + +=head2 Functions + +=over 4 + +=cut + */ #ifdef PARROT_HAS_HEADER_DLFCN @@ -14,7 +28,14 @@ #define PARROT_DLOPEN_FLAGS RTLD_LAZY /* -** Parrot_dlopen() + +=item C<void * +Parrot_dlopen(const char *filename)> + +TODO: Not yet documented!!! + +=cut + */ void * @@ -27,9 +48,15 @@ #endif } - /* -** Parrot_dlerror() + +=item C<const char * +Parrot_dlerror(void)> + +TODO: Not yet documented!!! + +=cut + */ const char * @@ -43,7 +70,14 @@ } /* -** Parrot_dlsym() + +=item C<void * +Parrot_dlsym(void *handle, const char *symbol)> + +TODO: Not yet documented!!! + +=cut + */ void * @@ -56,9 +90,15 @@ #endif } - /* -** Parrot_dlclose() + +=item C<int +Parrot_dlclose(void *handle)> + +TODO: Not yet documented!!! + +=cut + */ int @@ -72,6 +112,14 @@ } /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/env.c ============================================================================== --- trunk/config/gen/platform/generic/env.c (original) +++ trunk/config/gen/platform/generic/env.c Tue Nov 6 14:57:39 2007 @@ -4,16 +4,37 @@ */ /* - * Environment manipulation stuff - */ -/* -** Parrot_setenv() +=head1 NAME + +config/gen/platform/generic/env.c + +=head1 DESCRIPTION + +Environment manipulation stuff + +=head2 Functions + +=over 4 + +=cut + */ #include <stdlib.h> #include <string.h> +/* + +=item C<void +Parrot_setenv(const char *name, const char *value)> + +TODO: Not yet documented!!! + +=cut + +*/ + void Parrot_setenv(const char *name, const char *value) { @@ -39,6 +60,17 @@ #endif } +/* + +=item C<void +Parrot_unsetenv(const char *name)> + +TODO: Not yet documented!!! + +=cut + +*/ + void Parrot_unsetenv(const char *name) { @@ -49,6 +81,17 @@ #endif } +/* + +=item C<char * +Parrot_getenv(const char *name, int *free_it)> + +TODO: Not yet documented!!! + +=cut + +*/ + char * Parrot_getenv(const char *name, int *free_it) { @@ -57,6 +100,14 @@ } /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/exec.c ============================================================================== --- trunk/config/gen/platform/generic/exec.c (original) +++ trunk/config/gen/platform/generic/exec.c Tue Nov 6 14:57:39 2007 @@ -4,17 +4,38 @@ */ /* - * system() stuff - */ -/* - * Spawn off a subprocess and wait for the damn thing to complete, - * returning the return value of the process - * - */ +=head1 NAME + +config/gen/platform/generic/exec.c + +=head1 DESCRIPTION + +system() stuff + +=head2 Functions + +=over 4 + +=cut + +*/ + #include <sys/types.h> #include <sys/wait.h> +/* + +=item C<INTVAL +Parrot_Run_OS_Command(Parrot_Interp interp, STRING *command)> + +Spawn off a subprocess and wait for the damn thing to complete, +returning the return value of the process + +=cut + +*/ + INTVAL Parrot_Run_OS_Command(Parrot_Interp interp, STRING *command) { @@ -47,6 +68,17 @@ return 1; /* make gcc happy */ } +/* + +=item C<INTVAL +Parrot_Run_OS_Command_Argv(Parrot_Interp interp, PMC *cmdargs)> + +TODO: Not yet documented!!! + +=cut + +*/ + INTVAL Parrot_Run_OS_Command_Argv(Parrot_Interp interp, PMC *cmdargs) { @@ -94,8 +126,20 @@ return 1; /* make gcc happy */ } +/* + +=item C<void +Parrot_Exec_OS_Command(Parrot_Interp interp, STRING *command)> + +TODO: Not yet documented!!! + +=cut + +*/ + void -Parrot_Exec_OS_Command(Parrot_Interp interp, STRING *command) { +Parrot_Exec_OS_Command(Parrot_Interp interp, STRING *command) +{ /* Be horribly profligate with memory, since we're about to be something else */ int status; Modified: trunk/config/gen/platform/generic/itimer.c ============================================================================== --- trunk/config/gen/platform/generic/itimer.c (original) +++ trunk/config/gen/platform/generic/itimer.c Tue Nov 6 14:57:39 2007 @@ -4,18 +4,38 @@ */ /* - * itimer stuff - */ + +=head1 NAME + +config/gen/platform/generic/itimer.c + +=head1 DESCRIPTION + +itimer stuff + +=head2 Functions + +=over 4 + +=cut + +*/ #ifdef PARROT_HAS_SETITIMER /* - * Start a system timer with the passed value in milli seconds. - * - * The handle is that, what new_sys_timer_ms() returned. - * We could pass ITIMER_REAL in handle, but for now we ignore it - * as we are just having one timer. - */ + +=item C<void start_sys_timer_ms(void *handle, int ms)> + +Start a system timer with the passed value in milli seconds. + +The handle is that, what new_sys_timer_ms() returned. +We could pass ITIMER_REAL in handle, but for now we ignore it +as we are just having one timer. + +=cut + +*/ void start_sys_timer_ms(void *handle, int ms) @@ -29,7 +49,16 @@ setitimer(ITIMER_REAL, &its, NULL); } -/* Stop the given timer. */ +/* + +=item C<void stop_sys_timer_ms(void *handle)> + +Stop the given timer. + +=cut + +*/ + void stop_sys_timer_ms(void *handle) { @@ -37,9 +66,15 @@ } /* - * Return the programmed timer interval or 0 if none for the - * given timer handle. - */ + +=item C<int get_sys_timer_ms(void *handle)> + +Return the programmed timer interval or 0 if none for the +given timer handle. + +=cut + +*/ int get_sys_timer_ms(void *handle) @@ -50,9 +85,16 @@ } /* - * Create a new system timer with ~ms resolution. - * The returned handle is passed to the other timer functions. - */ + +=item C<void * new_sys_timer_ms(void)> + +Create a new system timer with ~ms resolution. +The returned handle is passed to the other timer functions. + +=cut + +*/ + void * new_sys_timer_ms(void) { @@ -63,6 +105,14 @@ #endif /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/math.c ============================================================================== --- trunk/config/gen/platform/generic/math.c (original) +++ trunk/config/gen/platform/generic/math.c Tue Nov 6 14:57:39 2007 @@ -4,15 +4,38 @@ */ /* - * math stuff - */ + +=head1 NAME + +config/gen/platform/generic/math.c + +=head1 DESCRIPTION + +math stuff + +=head2 Functions + +=over 4 + +=cut + +*/ + +/* + +=item C<PARROT_API extern int Parrot_signbit(double x)> + +return true if the Numval has a negative sign. +This is mostly for handling the -0.0 case. + +Parrot_signbit is exported because PerlNum.set_number_native() uses it. +XXX: This is probably not a good reason. + +=cut + +*/ /* - * return true if the Numval has a negative sign. - * This is mostly for handling the -0.0 case. - * - * Parrot_signbit is exported because PerlNum.set_number_native() uses it. - * XXX: This is probably not a good reason. */ #if DOUBLE_SIZE == 2 * INT_SIZE PARROT_API extern int @@ -31,6 +54,16 @@ } #endif +/* + +=item C<int Parrot_signbit_l(long double x)> + +TODO: Not yet documented!!! + +=cut + +*/ + #if NUMVAL_SIZE == 12 && DOUBLE_SIZE == 3 * INT_SIZE && PARROT_LITTLE_ENDIAN int Parrot_signbit_l(long double x) @@ -45,6 +78,14 @@ #endif /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/memalign.c ============================================================================== --- trunk/config/gen/platform/generic/memalign.c (original) +++ trunk/config/gen/platform/generic/memalign.c Tue Nov 6 14:57:39 2007 @@ -4,12 +4,36 @@ */ /* - * memalign related stuff - */ + +=head1 NAME + +config/gen/platform/generic/memalign.c + +=head1 DESCRIPTION + +memalign related stuff + +=head2 Functions + +=over 4 + +=cut + +*/ #if defined(PARROT_HAS_POSIX_MEMALIGN) # include <stdlib.h> +/* + +=item C<void * Parrot_memalign(size_t align, size_t size)> + +TODO: Not yet documented!!! + +=cut + +*/ + void * Parrot_memalign(size_t align, size_t size) { @@ -26,6 +50,16 @@ # include <stdlib.h> # endif +/* + +=item C<void * Parrot_memalign(size_t align, size_t size)> + +TODO: Not yet documented!!! + +=cut + +*/ + void * Parrot_memalign(size_t align, size_t size) { @@ -34,6 +68,16 @@ #endif +/* + +=item C<void Parrot_free_memalign(void *p)> + +TODO: Not yet documented!!! + +=cut + +*/ + void Parrot_free_memalign(void *p) { @@ -41,6 +85,14 @@ } /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/memexec.c ============================================================================== --- trunk/config/gen/platform/generic/memexec.c (original) +++ trunk/config/gen/platform/generic/memexec.c Tue Nov 6 14:57:39 2007 @@ -4,15 +4,35 @@ */ /* - * Memory protection stuff - */ + +=head1 NAME + +config/gen/platform/generic/memexec.c + +=head1 DESCRIPTION + +Memory protection stuff + +=head2 Functions + +=over 4 + +=cut + +*/ #ifdef PARROT_HAS_EXEC_PROTECT /* - * Allocate executable memory - * Round up to page size because the whole page will be marked as - * executable - */ + +=item C<void * mem_alloc_executable(size_t size)> + +Allocate executable memory +Round up to page size because the whole page will be marked as executable + +=cut + +*/ + void * mem_alloc_executable(size_t size) { @@ -25,6 +45,16 @@ return p; } +/* + +=item C<void mem_free_executable(void *p)> + +TODO: Not yet documented!!! + +=cut + +*/ + void mem_free_executable(void *p) { @@ -32,11 +62,17 @@ } /* - * Reallocate executable memory - * Round up to page size because the whole page will be marked as - * executable - * The intermediate temp is required because we don't know the old size - */ + +=item C<void * mem_realloc_executable(void* oldp, size_t newsize)> + +Reallocate executable memory +Round up to page size because the whole page will be marked as executable +The intermediate temp is required because we don't know the old size + +=cut + +*/ + void * mem_realloc_executable(void* oldp, size_t newsize) { @@ -61,6 +97,14 @@ #endif /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/signal.c ============================================================================== --- trunk/config/gen/platform/generic/signal.c (original) +++ trunk/config/gen/platform/generic/signal.c Tue Nov 6 14:57:39 2007 @@ -4,14 +4,36 @@ */ /* - * Signal handling stuff - */ + +=head1 NAME + +config/gen/platform/generic/signal.c + +=head1 DESCRIPTION + +Signal handling stuff + +=head2 Functions + +=over 4 + +=cut + +*/ #ifdef PARROT_HAS_HEADER_SIGNAL # include <signal.h> + /* - * for now use signal based functions - */ + +=item C<Parrot_sighandler_t +Parrot_set_sighandler(int signum, Parrot_sighandler_t handler)> + +for now use signal based functions + +=cut + +*/ Parrot_sighandler_t Parrot_set_sighandler(int signum, Parrot_sighandler_t handler) @@ -21,6 +43,14 @@ #endif /* PARROT_HAS_HEADER_SIGNAL */ /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/stat.c ============================================================================== --- trunk/config/gen/platform/generic/stat.c (original) +++ trunk/config/gen/platform/generic/stat.c Tue Nov 6 14:57:39 2007 @@ -4,8 +4,34 @@ */ /* - * File stat stuff - */ + +=head1 NAME + +config/gen/platform/generic/stat.c + +=head1 DESCRIPTION + +File stat stuff + +=head2 Functions + +=over 4 + +=cut + +*/ + + +/* + +=item C<PMC * +Parrot_stat_file(PARROT_INTERP, STRING *filename)> + +TODO: Not yet documented!!! + +=cut + +*/ PMC * Parrot_stat_file(PARROT_INTERP, STRING *filename) @@ -13,12 +39,35 @@ return NULL; } +/* + +=item C<PMC * +Parrot_stat_info_pmc(PARROT_INTERP, STRING *filename, INTVAL thing)> + +TODO: Not yet documented!!! + +=cut + +*/ + PMC * Parrot_stat_info_pmc(PARROT_INTERP, STRING *filename, INTVAL thing) { return NULL; } +/* + +=item C<static INTVAL +stat_common(PARROT_INTERP, struct stat *statbuf, + INTVAL thing, int status)> + +TODO: Not yet documented!!! + +=cut + +*/ + static INTVAL stat_common(PARROT_INTERP, struct stat *statbuf, INTVAL thing, int status) @@ -90,6 +139,17 @@ return result; } +/* + +=item C<INTVAL +Parrot_stat_info_intval(PARROT_INTERP, STRING *file, INTVAL thing)> + +TODO: Not yet documented!!! + +=cut + +*/ + INTVAL Parrot_stat_info_intval(PARROT_INTERP, STRING *file, INTVAL thing) { @@ -106,6 +166,17 @@ return stat_common(interp, &statbuf, thing, status); } +/* + +=item C<INTVAL +Parrot_fstat_info_intval(PARROT_INTERP, INTVAL file, INTVAL thing)> + +TODO: Not yet documented!!! + +=cut + +*/ + INTVAL Parrot_fstat_info_intval(PARROT_INTERP, INTVAL file, INTVAL thing) { @@ -117,12 +188,34 @@ return stat_common(interp, &statbuf, thing, status); } +/* + +=item C<FLOATVAL +Parrot_stat_info_floatval(PARROT_INTERP, STRING *filename, INTVAL thing)> + +TODO: Not yet documented!!! + +=cut + +*/ + FLOATVAL Parrot_stat_info_floatval(PARROT_INTERP, STRING *filename, INTVAL thing) { return (FLOATVAL)-1; } +/* + +=item C<STRING * +Parrot_stat_info_string(PARROT_INTERP, STRING *filename, INTVAL thing)> + +TODO: Not yet documented!!! + +=cut + +*/ + STRING * Parrot_stat_info_string(PARROT_INTERP, STRING *filename, INTVAL thing) { @@ -130,6 +223,14 @@ } /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: Modified: trunk/config/gen/platform/generic/time.c ============================================================================== --- trunk/config/gen/platform/generic/time.c (original) +++ trunk/config/gen/platform/generic/time.c Tue Nov 6 14:57:39 2007 @@ -4,14 +4,35 @@ */ /* -** Time stuff + +=head1 NAME + +config/gen/platform/generic/time.c + +=head1 DESCRIPTION + +Time stuff + +=head2 Functions + +=over 4 + +=cut + */ #include <time.h> #include <sys/time.h> /* -** Parrot_intval_time() + +=item C<INTVAL +Parrot_intval_time(void)> + +TODO: Not yet documented!!! + +=cut + */ INTVAL @@ -22,7 +43,14 @@ /* -** Parrot_floatval_time() + +=item C<FLOATVAL +Parrot_floatval_time(void)> + +TODO: Not yet documented!!! + +=cut + */ FLOATVAL @@ -34,7 +62,14 @@ } /* -** Parrot_sleep() + +=item C<void +Parrot_sleep(unsigned int seconds)> + +TODO: Not yet documented!!! + +=cut + */ void @@ -44,8 +79,15 @@ } /* - * Parrot_gmtime_r() - */ + +=item C<struct tm * +Parrot_gmtime_r(const time_t *t, struct tm *tm)> + +TODO: Not yet documented!!! + +=cut + +*/ struct tm * Parrot_gmtime_r(const time_t *t, struct tm *tm) @@ -54,8 +96,15 @@ } /* - * Parrot_localtime_r() - */ + +=item C<struct tm * +Parrot_localtime_r(const time_t *t, struct tm *tm)> + +TODO: Not yet documented!!! + +=cut + +*/ struct tm * Parrot_localtime_r(const time_t *t, struct tm *tm) @@ -64,8 +113,15 @@ } /* - * Parrot_asctime_r() - */ + +=item C<char* +Parrot_asctime_r(const struct tm *tm, char *buffer)> + +TODO: Not yet documented!!! + +=cut + +*/ char* Parrot_asctime_r(const struct tm *tm, char *buffer) @@ -74,6 +130,14 @@ } /* + +=back + +=cut + +*/ + +/* * Local variables: * c-file-style: "parrot" * End: