Log of autodoc.git/autodoc.xml

1996-06-21

1996-06-21 18:34:42 by Fredrik Hübinette (Hubbe) <hubbe@hubbe.net>

ab5bd4c94ce8fb9a75a72c290e05ac84729dc944 (212 lines) (+212/-0) ^{[

Show
| Annotate

]}
Branch: ulpc

document for call_out module

Rev: src/modules/call_out/doc/call_out:1.1
Rev: src/modules/call_out/doc/call_out_info:1.1
Rev: src/modules/call_out/doc/find_call_out:1.1
Rev: src/modules/call_out/doc/remove_call_out:1.1

268: </doc> </docgroup> + <docgroup homogen-name='_verify_internals' homogen-type='method'> + <method name='_verify_internals'/><doc placeholder='true'> + <text> + <tt>_verify_internals</tt> - check uLPC internals + + <tt>void _verify_internals(); + + </tt> + This function goes through most of the internal uLPC structures and + generates a fatal error if one of them is found to be out of order. + It is only used for debugging. + + debugging</text> + + </doc> + </docgroup> <docgroup homogen-name='`!' homogen-type='method'> <method name='`!'/><doc placeholder='true'> <text>
2388: </doc> </docgroup> + <docgroup homogen-name='glob' homogen-type='method'> + <method name='glob'/><doc placeholder='true'> + <text> + <tt>glob</tt> - match strings against globs + + <tt>int glob(string glob, string str); + or + string *glob(string glob, string *arr); + + </tt> + This function matches "globs". A in the glob string a question sign + matches any character and an asterisk matches any string. When + given two strings as argument a true/false value is returned + which reflects if the 'str' matches 'glob'. When given an array as + second argument, an array containing all matching strings is returned. + </text> + + <group><seealso/><text> + <ref resolved='predef::sscanf' to='sscanf'>sscanf</ref> and <ref resolved='predef::regexp' to='regexp'>regexp</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='hash' homogen-type='method'> <method name='hash'/><doc placeholder='true'> <text>
2846: </doc> </docgroup> + <docgroup homogen-name='localtime' homogen-type='method'> + <method name='localtime'/><doc placeholder='true'> + <text> + <tt>localtime</tt> - break down time() into intelligible components + + <tt>mapping(string:int) localtime(int time); + + </tt> + Given a time represented as second since 1970, as returned by the + function time(), this function returns a mapping with the following + components: + + <matrix> + <r><c> sec </c><c> seconds over the minute </c><c> 0 - 59 </c></r> + <r><c> min </c><c> minutes over the hour </c><c> 0 - 59 </c></r> + <r><c> hour </c><c> what hour in the day </c><c> 0 - 23 </c></r> + <r><c> mday </c><c> day of the month </c><c> 1 - 31 </c></r> + <r><c> mon </c><c> what month </c><c> 0 - 11 </c></r> + <r><c> year </c><c> years since 1900 </c><c> 0 - </c></r> + <r><c> wday </c><c> day of week (0=sunday) </c><c> 0 - 6 </c></r> + <r><c> yday </c><c> day of year </c><c> 0 - 365 </c></r> + <r><c> isdst </c><c> is daylight saving time </c><c> 0/1 </c></r> + <r><c> timezone </c><c> differance between </c></r> + <r><c> </c><c> </c><c> local time and UTC </c></r> + </matrix> + + </text> + + <group><note/><text> + The 'timezone' might not be available on all platforms. + </text></group> + + <group><seealso/><text> + <ref resolved='predef::time' to='time'>time</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='log' homogen-type='method'> <method name='log'/><doc placeholder='true'> <text>
3306: </doc> </docgroup> + <docgroup homogen-name='operators' homogen-type='method'> + <method name='operators'/><doc placeholder='true'> + <text> + <tt>operators</tt> - arethmics and other stuff + + uLPC has the following operators: + + <matrix> + <r><c> a(args) </c><c> function call </c></r> + <r><c> a[b..c] </c><c> range </c></r> + <r><c> a[b] </c><c> index </c></r> + <r><c> --a </c><c> pre decrement </c></r> + <r><c> a-- </c><c> post decrement </c></r> + <r><c> ++a </c><c> pre increment </c></r> + <r><c> a++ </c><c> post increment </c></r> + <r><c> (type)a </c><c> cast </c></r> + <r><c> ~a </c><c> complement </c></r> + <r><c> !a </c><c> not </c></r> + <r><c> -a </c><c> negate </c></r> + <r><c> a/b </c><c> divide </c></r> + <r><c> a%b </c><c> modulo </c></r> + <r><c> a*b </c><c> multiply </c></r> + <r><c> a-b </c><c> subtract </c></r> + <r><c> a+b </c><c> add </c></r> + <r><c> >> </c><c> shift right </c></r> + <r><c> << </c><c> shift left </c></r> + <r><c> a>b </c><c> greater than? </c></r> + <r><c> a<c> lesser than? </c></r> + <r><c> a>=b </c><c> greater or equal than? </c></r> + <r><c> a<=b </c><c> lesser or equal than? </c></r> + <r><c> a!=b </c><c> not equal to? </c></r> + <r><c> a==b </c><c> equal to? </c></r> + <r><c> a&b </c><c> intersection </c></r> + <r><c> a^b </c><c> xor (symmetric differance) </c></r> + <r><c> a|b </c><c> union </c></r> + <r><c> a&&b </c><c> logical and </c></r> + <r><c> a||b </c><c> logical or </c></r> + <r><c> a?b:c </c><c> condition </c></r> + <r><c> a=b </c><c> assignment </c></r> + </matrix> + + + The ones at the top of the list are parsed before operators lower + down on the list. This means that a|b&c means a|(b&c) not (a|b)&c. + Look at the individual pages for fuller explanations of what they do. + + Then there is also the @ "splice" operator which can only be used in + argument lists. + + Arguments to operators are always computed from left to right. + + Many (but not all) of these operators can also be used as by prepending + with a ` sign. For instance `+(a,b) is the same as a+b. These functions + are called "operator functions" and the following are currently + available: + + `== `!= `! `< `<= `> `>= `+ `- `& `| `^ `<< `>> `* `/ `% `~ + + These operator functions are basically efuns, but beware, if you + re-define the `+ function a+b will also be redefined. + + On top of all this, many operators can also be overloaded. Overloading + an operator lets you specify how operators works on your objects. + To overload an operator you simply put the corresponding operator + function as a method in your object. An example: + + > program nine=class { + <dl><group><text>int `+(int arg) { return arg+9; } + </text></group></dl>}; + Result: program + > clone(nine)+1; + Result: 10 + > + + + This little example defines a program that works almost like the number + nine. As you can see, clone(nine)+1 is the same as clone(nine)->`+(1) + in this case, and that is the whole point of operator overloading. + Note however that it would not have worked to write 1+clone(nine) + because operator overloading only works if the first argument is the + object with the overloaded function. Well, almost anyway, the operators + <, >, <=, >= can check both sides. In fact, the methods `<= and `>= + will never be called since uLPC will translate a<=b to !(a>b). + + These are the operators you can overload: + + <matrix> + <r><c> `== </c><c> also overloads `!= </c></r> + <r><c> `! </c><c> This is also used by if-statements to find out if the object in question is 'true' or not. </c></r> + <r><c> `< </c><c> also overloads `>= </c></r> + <r><c> `> </c><c> also overloads `<= </c></r> + <r><c> `+ </c><c> </c></r> + <r><c> `- </c><c> </c></r> + <r><c> `& </c><c> </c></r> + <r><c> `| </c><c> </c></r> + <r><c> `^ </c><c> </c></r> + <r><c> `<< </c><c> </c></r> + <r><c> `>> </c><c> </c></r> + <r><c> `* </c><c> </c></r> + <r><c> `/ </c><c> </c></r> + <r><c> `% </c><c> </c></r> + <r><c> `~ </c><c> </c></r> + </matrix> + + + If you also define a function __hash to return an integer, which + must be equal for all objects where `== is true you can index mappings + on the contents of your objects rather than on the object itself. + More details about this will come later. + </text> + + <group><seealso/><text> + <ref resolved='predef::operators' to='/precompiled/mpz'>/precompiled/mpz</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='perror' homogen-type='method'> <method name='perror'/><doc placeholder='true'> <text>
3418: </doc> </docgroup> + <docgroup homogen-name='putenv' homogen-type='method'> + <method name='putenv'/><doc placeholder='true'> + <text> + <tt>putenv</tt> - put environment variable + + <tt>void putenv(string varname, string value); + + </tt> + This function sets the environment variable 'varname' to 'value'. + </text> + + <group><seealso/><text> + <ref resolved='predef::getenv' to='getenv'>getenv</ref> and <ref resolved='predef::exece' to='exece'>exece</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='query_host_name' homogen-type='method'> <method name='query_host_name'/><doc placeholder='true'> <text>

autodoc.git/ autodoc.xml

1996-06-21

1996-06-21 18:34:42 by Fredrik Hübinette (Hubbe) <hubbe@hubbe.net>