Log of autodoc.git/autodoc.xml

1995-11-05

1995-11-05 23:39:29 by Fredrik Hübinette (Hubbe) <hubbe@hubbe.net>

76296496c5cdc3cd37660b2fbce2f7b0e9fa449e (324 lines) (+255/-69) ^{[

Show
| Annotate

]}
Branch: 8.0
Tags: v1.5E-12, v1.6E-12 and v1.0E-12

tests ulpc and doc dir, moved from bin/

Rev: src/test/.cvsignore:1.1
Rev: src/test/create_testsuite:1.1
Rev: src/test/test_lpc.lpc:1.1
Rev: src/test/verifymanual.lpc:1.1

134: </doc> </docgroup> - <docgroup homogen-name='aggregate' homogen-type='method'> - <method name='aggregate'/><doc placeholder='true'> + <docgroup homogen-name='aggregate_list' homogen-type='method'> + <method name='aggregate_list'/><doc placeholder='true'> <text> - <tt>aggregate</tt> - construct a list + <tt>aggregate_list</tt> - construct a list <tt>list aggregate_list(mixed ... elems); or 
151: </text> <group><seealso/><text> - <ref resolved='predef::sizeof' to='sizeof'>sizeof</ref>, <ref resolved='predef::listp' to='listp'>listp</ref> and <ref to='mklist'>mklist</ref> + <ref resolved='predef::sizeof' to='sizeof'>sizeof</ref>, <ref resolved='predef::listp' to='listp'>listp</ref> and <ref resolved='predef::mklist' to='mklist'>mklist</ref> </text></group> </doc>
186: </tt> Return a mapping containing all efuns, indexed on the names of the - efuns, and with the value of the efun as argument. - - SEE ALSO - add_efun - + efuns, and with the value of the efun as argument. </text> - + <group><seealso/><text> + <ref resolved='predef::add_efun' to='add_efun'>add_efun</ref> + </text></group> + </doc> </docgroup> <docgroup homogen-name='allocate' homogen-type='method'> <method name='allocate'/><doc placeholder='true'> <text> - <tt>allocate</tt> - allocate an array - SYNTAX - mixed *allocate(int size, [ string type ]); + <tt>allocate</tt> - allocate an array - + <tt>mixed *allocate(int size, [ string type ]); + + </tt> Allocate an array of size elements. Optionally, write what type you want to store in the array in the second argument as a string. Note that the type given in this string should be simple, instead
239: allocate(10); </tt> - Arrays are basically a place to store a number of other values. - - Arrays in lpc are allocated blocks of values. They are dynamically - allocated and does not need to be declared as in C. The values in - the array can be set when creating the array as in the first - construction or anytime afterwards like this: arr[index]=data where - index is an integer greater or equal to 0 and smaller than the array - size. Note that arrays are shared and use reference counts to keep - track of their references. This will have the effect that you can - <dl><group><text>have two variables pointing to the same array, and when you change - </text></group></dl>an index in in it, both variables will show the change. - + Arrays are basically a place to store a number of other values. + Arrays in lpc are allocated blocks of values. They are dynamically + allocated and does not need to be declared as in C. The values in + the array can be set when creating the array as in the first + construction or anytime afterwards like this: arr[index]=data where + index is an integer greater or equal to 0 and smaller than the array + size. Note that arrays are shared and use reference counts to keep + track of their references. This will have the effect that you can + have two variables pointing to the same array, and when you change + an index in in it, both variables will show the change. Here follows a list of operators that applies to arrays: In this list a and b is used to represent an array expression:
258: a + b : summation ( ({1}) + ({2}) returns ({1,2}) ) a - b : subtraction, returns a copy of a with all values that are <dl><group><text>present in b removed, ( ({1, 2, 3}) - ({2}) returns ({1,3}) ) - a & b : intersection, return an array with all values that are + </text></group></dl><matrix> - + <r><c> a & b : intersection, return an array with all values that are </c></r> <r><c> </c><c> present in both a and b </c></r> - <r><c> </c></r> + <r><c> a | b : union, return an array with all values that are present in </c></r> </matrix> - <dl><group><text>a | b : union, return an array with all values that are present in + <dl><group><text>a or b, differs from summation in that values that are present in both a and b are only returned once. </text></group></dl>a ^ b : xor, return an array with all values that are present in 
274: </text></group></dl>a != b : returns 0 if a is the same array as b, same size and values <dl><group><text>is not enough. </text></group></dl>! a : boolean not, returns 0 - </text></group></dl>a[c] : indexing, returns element c in the array (c is an int) + a[c] : indexing, returns element c in the array (c is an int) a[c]=d : setting, sets element c in the array to d (c is an int) a[c..d]: range (c & d are ints) returns an array containing a pice of <dl><group><text>the array a. The piece starts at element c and ends (and 
440: <docgroup homogen-name='capitalize' homogen-type='method'> <method name='capitalize'/><doc placeholder='true'> <text> - <tt>capitalize</tt> - capitalize a string - SYNTAX - string capitalize(string str) + <tt>capitalize</tt> - capitalize a string - + <tt>string capitalize(string str) + + </tt> Convert the first character in str to upper case, and return the new string. </text>
473: </doc> </docgroup> + <docgroup homogen-name='catch' homogen-type='method'> + <method name='catch'/><doc placeholder='true'> + <text> + <tt>catch</tt> - catch errorrs + + <tt>catch { commands } + or + catch ( expression ) + + </tt> + catch traps exceptions such as run time errors or calls to throw() and + returns the argument given to throw. For a run time error, this value + is ({ "error message", backtrace }) + </text> + + <group><seealso/><text> + <ref resolved='predef::throw' to='predef::throw'>builtin/throw</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='cd' homogen-type='method'> <method name='cd'/><doc placeholder='true'> <text>
709: </doc> </docgroup> - <docgroup homogen-name='describe_bactrace' homogen-type='method'> - <method name='describe_bactrace'/><doc placeholder='true'> + <docgroup homogen-name='describe_backtrace' homogen-type='method'> + <method name='describe_backtrace'/><doc placeholder='true'> <text> - <tt>describe_bactrace</tt> - make a backtrace readable + <tt>describe_backtrace</tt> - make a backtrace readable <tt>string describe_backtrace(mixed **backtrace); 
780: <docgroup homogen-name='exec' homogen-type='method'> <method name='exec'/><doc placeholder='true'> <text> - <tt>exec</tt> - execute a program + <tt>exec</tt> - simple way to use exece() - <tt>int exec(string ... args); + <tt>int exec(string file, string ... args); </tt> - This function transforms the uLPC process into a process running - the program specified in args. The args will be sent as argv[] to - the new program. This function only returns if something went wrong - during exec(), and in that case it returns zero. + This function destroys the uLPC parser and runs the program + 'file' instead with the arguments. If no there are no '/' in + the filename, the variable PATH will be consulted when looking + for the program. This function does not return except when + the exec fails for some reason. </text> - <group><note/><text> - The uLPC driver _dies_ when this function is called. You must use - fork() if you wish to execute a program and still run the uLPC - driver. - </text></group> - + <group><example/><text> - <tt>exec("ls","-l"); + <tt>exec("/bin/echo","hello","world"); + </tt></text></group> - <group><seealso/><text> - <ref resolved='predef::fork' to='predef::fork'>files/fork</ref> and <ref resolved='predef::/precompiled/file.pipe' to='file->pipe'>file->pipe</ref> - </text></group> - + </doc> </docgroup> - <docgroup homogen-name='exec' homogen-type='method'> - <method name='exec'/><doc placeholder='true'> + <docgroup homogen-name='exece' homogen-type='method'> + <method name='exece'/><doc placeholder='true'> <text> - <tt>exec</tt> - simple way to use exece() + <tt>exece</tt> - execute a program - <tt>int exec(string file, string ... args); + <tt>int exece(string file, string *args); + or + int exece(string file, string *args, mapping(string:string) env); </tt> - This function destroys the uLPC parser and runs the program - 'file' instead with the arguments. If no there are no '/' in - the filename, the variable PATH will be consulted when looking - for the program. This function does not return except when - the exec fails for some reason. + This function transforms the uLPC process into a process running + the program specified in the argument 'file' with the argument 'args'. + If the mapping 'env' is present, it will completely replace all + environment variables before the new program is executed. + This function only returns if something went wrong during exece(), + and in that case it returns zero. </text> - + <group><note/><text> + The uLPC driver _dies_ when this function is called. You must use + fork() if you wish to execute a program and still run the uLPC + driver. + </text></group> + <group><example/><text> - <tt>exec("/bin/echo","hello","world"); - + <tt>exece("/bin/ls", ({"-l"})); + exece("/bin/sh", ({"-c", "echo $HOME"}), (["HOME":"/not/home"])); </tt></text></group> - + <group><seealso/><text> + <ref resolved='predef::fork' to='predef::fork'>files/fork</ref> and <ref resolved='predef::/precompiled/file.pipe' to='file->pipe'>file->pipe</ref> + </text></group> + </doc> </docgroup> <docgroup homogen-name='exit' homogen-type='method'>
939: <dl><group><text>mode, /* file mode, protection bits etc. etc. */ size, /* file size for regular files, <dl><group><text>* -2 for dirs, - <dl><group><text>* -3 for links, + * -3 for links, * -4 for otherwise */ - </text></group></dl></text></group></dl>atime, /* last access time */ + </text></group></dl>atime, /* last access time */ mtime, /* last modify time */ ctime, /* last status time change */ uid, /* The user who owns this file */ 
1290: </doc> </docgroup> + <docgroup homogen-name='hilfe' homogen-type='method'> + <method name='hilfe'/><doc placeholder='true'> + <text> + <tt>hilfe</tt> - Hubbe's Incremental LPC FrontEnd + + <tt>$ hilfe + or + $ ulpc -Cstay hilfe + + </tt> + Hilfe is a LPC-script that supplies an incremental environment for + LPC. It allowes you to evaluate LPC 'on the fly'. If you're running + UNIX, you only have to write 'hilfe' to start it, otherwise you will + have to write 'driver -Cstay hilfe' to run it. If you don't know what + 'incremeantal' means in this context, ask you local LISP junkie. + + Hilfe has the following commands: + + quit - exit hilfe + new - clear all variables and function definition + dump - dump all current variables + . - clear input buffer + + Hilfe parses a subset of LPC, there many things it doesn't handle. Here + is a list of what you can do: + + Define a function: + <type> <name>( <arguments> ) { <statements > } + Note that hilfe simulates a function defenition by defining a variable + and setting it to the function pointer. Therefor actual typechecking is + almost nil. Also note that hilfe doesn't recognize type modifiers such + as static, private, varargs etc. + + Declare one or many global variables: + <type> <name> [=<value>], <name> [=value>] ..... ; + Hilfe simulates variable handling, and typechecking is almost nil, + therefor all global variables are declared as mixed, whatever the + <type> may be. + + <matrix> + <r><c> Evaluate a statement: </c></r> + <r><c> <statement> ; </c></r> + <r><c> Statements include the following examples: </c></r> + <r><c> </c><c> for(e=0;e<10;e++) ; e=10; </c></r> + </matrix> + + + <matrix> + <r><c> </c><c> write(e); </c></r> + <r><c> </c></r> + </matrix> + + + <matrix> + <r><c> </c><c> if(foo) return bar; else return gazonk; </c></r> + <r><c> </c></r> + </matrix> + + + Statements beginning with for, while, switch, if, do or return will + not automatically return anything, and no result will be printed. + </text> + + <group><seealso/><text> + <ref to='script_mode'>script_mode</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='implode' homogen-type='method'> <method name='implode'/><doc placeholder='true'> <text>
1785: </doc> </docgroup> + <docgroup homogen-name='mklist' homogen-type='method'> + <method name='mklist'/><doc placeholder='true'> + <text> + <tt>mklist</tt> - make a list + + <tt>list mklist(mixed *a) + + </tt> + This function creates a list from an array. + </text> + + <group><example/><text> + <tt>> mklist( ({1,2,3}) ); + Result: (< /* 3 elements */ + <dl><group><text>1, + 2, + 3 + </text></group></dl>>) + + </tt></text></group> + + <group><seealso/><text> + <ref resolved='predef::aggregate_list' to='predef::aggregate_list'>builtin/aggregate_list</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='mkmapping' homogen-type='method'> <method name='mkmapping'/><doc placeholder='true'> <text>
2062: <tt>int random(int max); </tt> - This function returns a random number in the range 0 - max-1. + This function returns a random number in the range 0 - max-1. + </text> + + <group><seealso/><text> + <ref resolved='predef::random_seed' to='random_seed'>random_seed</ref> + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='random_seed' homogen-type='method'> + <method name='random_seed'/><doc placeholder='true'> + <text> + <tt>random_seed</tt> - seed random generator + + <tt>void random_seed(int seed); - + </tt> + This function sets the initial value for the random generator. </text> - + <group><example/><text> + <tt>uLPC v1.0E-13 Running Hilfe v1.2 (Hubbe's Incremental LPC FrontEnd) + > random_seed(17); + Result: 0 + > random(1000); + Result: 732 + > random(1000); + Result: 178 + > random(1000); + Result: 94 + > random_seed(17); + Result: 0 + > random(1000); + Result: 732 + > random(1000); + Result: 178 + > random(1000); + Result: 94 + > + + </tt></text></group> + + <group><seealso/><text> + <ref resolved='predef::random' to='random'>random</ref> + </text></group> + </doc> </docgroup> <docgroup homogen-name='read_bytes' homogen-type='method'>
3052: </doc> </docgroup> + <docgroup homogen-name='version' homogen-type='method'> + <method name='version'/><doc placeholder='true'> + <text> + <tt>version</tt> - return version info + + <tt>string version(); + + </tt> + This function returns a brief information about the uLPC version. + </text> + + <group><example/><text> + <tt>> version(); + Result: uLPC v1.0E-13 + + + </tt></text></group> + + </doc> + </docgroup> <docgroup homogen-name='write' homogen-type='method'> <method name='write'/><doc placeholder='true'> <text>
3307: </matrix> - How should _always_ contain at least one of 'r' or 'w'. + How should _always_ contain at least one of 'r' or 'w'. + + Returns 1 on success, 0 otherwise. </text> <group><seealso/><text>
3565: </text> <group><seealso/><text> - <ref to='predef::exece'>builtin/exece</ref> + <ref resolved='predef::exece' to='predef::exece'>builtin/exece</ref> </text></group> </doc>
3582: </tt> This function sets the id of this file. The id is mainly used as an identifier that is sent as the first arguments to all callbacks. The - default id is this_object(). Another possible use of the id is to hold - all data related to this file in a mapping or array. + default id is 0. Another possible use of the id is to hold all data + related to this file in a mapping or array. </text> <group><seealso/><text>

autodoc.git/ autodoc.xml

1995-11-05

1995-11-05 23:39:29 by Fredrik Hübinette (Hubbe) <hubbe@hubbe.net>