Diff of autodoc.git/traditional_manual/chapter_21.html (59f51babebb922709b3fb7b97c562af4e0b8a658 » 99eac2dc1f4152a2377ccb7295348cec32ea8525)

autodoc.git/traditional_manual/chapter_21.html:477: that are later modified into instances of the compiled program by the compiler. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>__placeholder_object</code> </dd></dl> <hr /> <dl class='group--doc'> + <dt class='head--type'>Method + __parse_pike_type + </dt> + <dd><code><code class='datatype'>string(8bit)</code> __parse_pike_type(<code class='datatype'>string(8bit)</code> <code class='argument'>t</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> <dt class='head--type'>Constant __placeholder_object </dt> <dd><code><code class='datatype'>constant</code> <code class='constant'>__placeholder_object</code></code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Object used internally by the compiler. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>__null_program</code>
autodoc.git/traditional_manual/chapter_21.html:534: <dt class='head--type'>Method _equal </dt> <dd><code><code class='datatype'>bool</code> _equal(<code class='datatype'>mixed</code> <code class='argument'>o</code>)</code></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + _exit + </dt> + <dd><code><code class='datatype'>void</code> _exit(<code class='datatype'>int</code> <code class='argument'>returncode</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function does the same as <code>exit</code>, but doesn't bother to clean + up the Pike interpreter before exiting. This means that no destructors + will be called, caches will not be flushed, file locks might not be + released, and databases might not be closed properly. + Use with extreme caution. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>exit()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method _gdb_breakpoint </dt> <dd><code><code class='datatype'>void</code> _gdb_breakpoint()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function only exists so that it is possible to set a gdb breakpoint on the function pike_gdb_breakpoint. </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:643: <dd class='body--doc'>Return the hyperbolic arcus cosine value for <code>f</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>cosh()</code>, <code>asinh()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + add_constant + </dt> + <dd><code><code class='datatype'>void</code> add_constant(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mixed</code> <code class='argument'>value</code>)</code> + <code><code class='datatype'>void</code> add_constant(<code class='datatype'>string</code> <code class='argument'>name</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Add a new predefined constant. + This function is often used to add builtin functions. + All programs compiled after the <code>add_constant()</code> function has been + called can access <code>value</code> by the name <code>name</code>. + If there is a constant called <code>name</code> already, it will be replaced by + by the new definition. This will not affect already compiled programs. + Calling <code>add_constant()</code> without a value will remove that name from + the list of constants. As with replacing, this will not affect already + compiled programs. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>all_constants()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method add_include_path </dt> <dd><code><code class='datatype'>void</code> add_include_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Add a directory to search for include files. This is the same as the command line option <tt>-I</tt>. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>Note that the added directory will only be searched when using
autodoc.git/traditional_manual/chapter_21.html:705: This is the same as the command line option <tt>-P</tt>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>remove_program_path()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + aggregate + </dt> + <dd><code><code class='datatype'>array</code> aggregate(<code class='datatype'>mixed</code> ... <code class='argument'>elements</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Construct an array with the arguments as indices. + This function could be written in Pike as: + <pre><code>array aggregate(mixed ... elems) { return elems; } + </code></pre> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Arrays are dynamically allocated there is no need to declare them + like <code class='expr'>int a[10]=allocate(10);</code> (and it isn't possible either) like + in C, just <code class='expr'>array(int) a=allocate(10);</code> will do. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>sizeof()</code>, <code>arrayp()</code>, <code>allocate()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method aggregate_mapping </dt> <dd><code><code class='datatype'>mapping</code> aggregate_mapping(<code class='datatype'>mixed</code> ... <code class='argument'>elems</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Construct a mapping. Groups the arguments together two and two in key-index pairs and creates a mapping of those pairs. Generally, the mapping literal syntax is handier: <code class='expr'>([ key1:val1, key2:val2, ... ])</code> </dd>
autodoc.git/traditional_manual/chapter_21.html:771: signals. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>ualarm()</code>, <code>signal()</code>, <code>call_out()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + all_constants + </dt> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) all_constants()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns a mapping containing all global constants, indexed on the name + of the constant, and with the value of the constant as value. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>add_constant()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + allocate + </dt> + <dd><code><code class='datatype'>array</code> allocate(<code class='datatype'>int</code> <code class='argument'>size</code>)</code> + <code><code class='datatype'>array</code> allocate(<code class='datatype'>int</code> <code class='argument'>size</code>, <code class='datatype'>mixed</code> <code class='argument'>init</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Allocate an array of <code>size</code> elements. If <code>init</code> is specified + then each element is initialized by copying that value + recursively. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>sizeof()</code>, <code>aggregate()</code>, <code>arrayp()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method array_sscanf </dt> <dd><code><code class='datatype'>array</code> array_sscanf(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>string</code> <code class='argument'>format</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function works just like <code>sscanf()</code>, but returns the matched results in an array instead of assigning them to lvalues. This is often useful for user-defined sscanf strings. </dd> <dt class='head--doc'>See also</dt>
autodoc.git/traditional_manual/chapter_21.html:1064: <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>rows()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method compile </dt> + <dd><code><code class='datatype'>program</code> compile(<code class='datatype'>string</code> <code class='argument'>source</code>, <code class='object unresolved'>CompilationHandler</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>major</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>minor</code>, <code class='datatype'>program</code>|<code class='datatype'>void</code> <code class='argument'>target</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>placeholder</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Compile a string to a program. + This function takes a piece of Pike code as a string and + compiles it into a clonable program. + The optional argument <code>handler</code> is used to specify an alternative + error handler. If it is not specified the current master object will + be used. + The optional arguments <code>major</code> and <code>minor</code> are used to tell the + compiler to attempt to be compatible with Pike <code>major</code>.<code>minor</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Note that <code>source</code> must contain the complete source for a program. + It is not possible to compile a single expression or statement. + Also note that <code>compile()</code> does not preprocess the program. + To preprocess the program you can use <code>compile_string()</code> or + call the preprocessor manually by calling <code>cpp()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>compile_string()</code>, <code>compile_file()</code>, <code>cpp()</code>, <code>master()</code>, + <code>CompilationHandler</code>, <code>DefaultCompilerEnvironment</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + compile + </dt> <dd><code><code class='modifier'>protected</code> <code class='datatype'>program</code> compile(<code class='datatype'>string</code> <code class='argument'>source</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>major</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>minor</code>, <code class='datatype'>program</code>|<code class='datatype'>void</code> <code class='argument'>target</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>placeholder</code>)</code></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method compile_file </dt> <dd><code><code class='datatype'>program</code> compile_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>void</code>|<code class='datatype'>program</code> <code class='argument'>p</code>, <code class='datatype'>void</code>|<code class='datatype'>object</code> <code class='argument'>o</code>)</code></dd>
autodoc.git/traditional_manual/chapter_21.html:1106: Functionally equal to <code class='expr'><code>compile</code>(<code>cpp</code>(<code>source</code>, <code>filename</code>))</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>compile()</code>, <code>cpp()</code>, <code>compile_file()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + copy_value + </dt> + <dd><code><code class='datatype'>mixed</code> copy_value(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Copy a value recursively. + If the result value is changed destructively (only possible for + multisets, arrays and mappings) the copied value will not be changed. + The resulting value will always be equal to the copied (as tested with + the function <code>equal()</code>), but they may not the the same value (as tested + with <code>`==()</code>). + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>equal()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method cos </dt> <dd><code><code class='datatype'>float</code> cos(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>f</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Return the cosine value for <code>f</code>. <code>f</code> should be specified in radians. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>acos()</code>, <code>sin()</code>, <code>tan()</code>
autodoc.git/traditional_manual/chapter_21.html:1241: code, unless <code>codec</code> is specified as <code class='expr'>-1</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>encode_value()</code>, <code>encode_value_canonic()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + delay + </dt> + <dd><code><code class='datatype'>void</code> delay(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>s</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function makes the thread stop for <code>s</code> seconds. + Only signal handlers can interrupt the sleep. Other callbacks are + not called during delay. Beware that this function uses busy-waiting + to achieve the highest possible accuracy. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>signal()</code>, <code>sleep()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method depth </dt> <dd><code><code class='datatype'>int(0..)</code> depth()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Calculate the depth of the tree. </dd></dl> <hr />
autodoc.git/traditional_manual/chapter_21.html:1293: in <code>err</code> are thrown. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>describe_backtrace()</code>, <code>get_backtrace</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + destruct + </dt> + <dd><code><code class='datatype'>bool</code> destruct(<code class='datatype'>void</code>|<code class='datatype'>object</code> <code class='argument'>o</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Mark an object as destructed. + Calls <code class='expr'>o->_destruct()</code>, and then clears all variables in the + object. If no argument is given, the current object is destructed. + All pointers and function pointers to this object will become zero. + The destructed object will be freed from memory as soon as possible. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <code class='expr'>1</code> if <code>o</code> has an <code>lfun::_destruct()</code> that + returned <code class='expr'>1</code> and inhibited destruction. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method encode_value </dt> <dd><code><code class='datatype'>string</code> encode_value(<code class='datatype'>mixed</code> <code class='argument'>value</code>, <code class='object unresolved'>Codec</code>|<code class='datatype'>void</code> <code class='argument'>codec</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Code a value into a string. This function takes a value, and converts it to a string. This string can then be saved, sent to another Pike process, packed or used in any way you like. When you want your value back you simply send this string to <code>decode_value()</code> and it will return the value you encoded.
autodoc.git/traditional_manual/chapter_21.html:1357: if it can't encode to a canonical form. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>encode_value()</code>, <code>decode_value()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + enumerate + </dt> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) enumerate(<code class='datatype'>int</code> <code class='argument'>n</code>)</code> + <code><code class='datatype'>array</code> enumerate(<code class='datatype'>int</code> <code class='argument'>n</code>, <code class='datatype'>void</code>|<code class='datatype'>mixed</code> <code class='argument'>step</code>, <code class='datatype'>void</code>|<code class='datatype'>mixed</code> <code class='argument'>start</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>operator</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Create an array with an enumeration, useful for initializing arrays + or as first argument to <code>map()</code> or <code>foreach()</code>. + The defaults are: <code>step</code> = 1, <code>start</code> = 0, <code>operator</code> = <code>`+</code> + <h1>Advanced use</h1> + The resulting array is calculated like this: + <pre><code>array enumerate(int n, mixed step, mixed start, function operator) + { + array res = allocate(n); + for (int i=0; i < n; i++) + { + res[i] = start; + start = operator(start, step); + } + return res; + } + </code></pre> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>map()</code>, <code>foreach()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + equal + </dt> + <dd><code><code class='datatype'>int</code> equal(<code class='datatype'>mixed</code> <code class='argument'>a</code>, <code class='datatype'>mixed</code> <code class='argument'>b</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function checks if the values <code>a</code> and <code>b</code> are equivalent. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>If either of the values is an object the (normalized) result + of calling <code>lfun::_equal()</code> will be returned. + Returns <code class='expr'>1</code> if both values are false (zero, destructed objects, + prototype functions, etc). + Returns <code class='expr'>0</code> (zero) if the values have different types. + Otherwise depending on the type of the values: + <table class='box'><tr><td><code><code class='datatype'>int</code></code></td><td>Returns the same as <code class='expr'>a == b</code>. + </td></tr> + <tr><td><code><code class='datatype'>array</code></code></td><td>The contents of <code>a</code> and <code>b</code> are checked recursively, and + if all their contents are <code>equal</code> and in the same place, + they are considered equal. + Note that for objects this case is only reached if neither + <code>a</code> nor <code>b</code> implements <code>lfun::_equal()</code>. + </td></tr> + <tr><td><code><code class='type'>type</code></code></td><td>Returns <code class='expr'>(a <= b) && (b <= a)</code>. + </td></tr> + </table> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>copy_value()</code>, <code>`==()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method error </dt> <dd><code><code class='datatype'>void</code> error(<code class='object unresolved'>sprintf_format</code> <code class='argument'>f</code>, <code class='object unresolved'>sprintf_args</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Throws an error. A more readable version of the code <code class='expr'>throw( ({ sprintf(f, @args), backtrace() }) )</code>. </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:1429: This function is not available on all platforms. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Process.create_process()</code>, <code>fork()</code>, <code>Stdio.File->pipe()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + exit + </dt> + <dd><code><code class='datatype'>void</code> exit(<code class='datatype'>int</code> <code class='argument'>returncode</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>fmt</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Exit the whole Pike program with the given <code>returncode</code>. + Using <code>exit()</code> with any other value than <code class='expr'>0</code> (zero) indicates + that something went wrong during execution. See your system manuals + for more information about return codes. + The arguments after the <code>returncode</code> will be used for a call to + <code>werror</code> to output a message on stderr. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>_exit()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method exp </dt> <dd><code><code class='datatype'>float</code> exp(<code class='datatype'>float</code>|<code class='datatype'>int</code> <code class='argument'>f</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Return the natural exponential of <code>f</code>. <code class='expr'>log( exp( x ) ) == x</code> as long as exp(x) doesn't overflow an int. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>pow()</code>, <code>log()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + filter + </dt> + <dd><code><code class='datatype'>mixed</code> filter(<code class='datatype'>mixed</code> <code class='argument'>arr</code>, <code class='datatype'>void</code>|<code class='datatype'>mixed</code> <code class='argument'>fun</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Filters the elements in <code>arr</code> through <code>fun</code>. + <code>arr</code> is treated as a set of elements to be filtered, as + follows: + <dl class='group--doc'><dt>array</dt> + <dt>multiset</dt> + <dt>string</dt> + <dd>Each element is filtered with <code>fun</code>. The return value is of + the same type as <code>arr</code> and it contains the elements that + <code>fun</code> accepted. <code>fun</code> is applied in order to each element, + and that order is retained between the kept elements. + If <code>fun</code> is an array, it should have the same length as + <code>arr</code>. In this case, the elements in <code>arr</code> are kept where + the corresponding positions in <code>fun</code> are nonzero. Otherwise + <code>fun</code> is used as described below. + </dd> + <dt>mapping</dt> + <dd>The values are filtered with <code>fun</code>, and the index/value + pairs it accepts are kept in the returned mapping. + </dd> + <dt>program</dt> + <dd>The program is treated as a mapping containing the + identifiers that are indexable from it and their values. + </dd> + <dt>object</dt> + <dd>If there is a <code>lfun::cast</code> method in the object, it's called + to try to cast the object to an array, a mapping, or a + multiset, in that order, which is then filtered as described + above. + </dd> + </dl>Unless something else is mentioned above, <code>fun</code> is used as + filter like this: + <dl class='group--doc'><dt>function</dt> + <dd><code>fun</code> is called for each element. It gets the current + element as the first argument and <code>extra</code> as the rest. The + element is kept if it returns true, otherwise it's filtered + out. + </dd> + <dt>object</dt> + <dd>The object is used as a function like above, i.e. the + <code>lfun::`()</code> method in it is called. + </dd> + <dt>multiset</dt> + <dt>mapping</dt> + <dd><code>fun</code> is indexed with each element. The element is kept if + the result is nonzero, otherwise it's filtered out. + </dd> + <dt>"zero or left out"</dt> + <dd>Each element that is callable is called with <code>extra</code> as + arguments. The element is kept if the result of the call is + nonzero, otherwise it's filtered out. Elements that aren't + callable are also filtered out. + </dd> + <dt>string</dt> + <dd>Each element is indexed with the given string. If the result + of that is zero then the element is filtered out, otherwise + the result is called with <code>extra</code> as arguments. The element + is kept if the return value is nonzero, otherwise it's + filtered out. + This is typically used when <code>arr</code> is a collection of + objects, and <code>fun</code> is the name of some predicate function + in them. + </dd> + </dl> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The function is never destructive on <code>arr</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>map()</code>, <code>foreach()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method floor </dt> <dd><code><code class='datatype'>float</code> floor(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>f</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Return the closest integer value less or equal to <code>f</code>. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'><code>floor()</code> does not return an <code class='expr'>int</code>, merely an integer value stored in a <code class='expr'>float</code>.
autodoc.git/traditional_manual/chapter_21.html:1489: better done with <code>Process.create_process()</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Process.create_process()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + gc + </dt> + <dd><code><code class='datatype'>int</code> gc(<code class='datatype'>mapping</code>|<code class='datatype'>array</code>|<code class='datatype'>void</code> <code class='argument'>quick</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Force garbage collection. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>quick</code></dt> + <dd></dd><dd class='body--doc'>Perform a quick garbage collection on just this value, + which must have been made weak by <code>set_weak_flag()</code>. + All values that only have a single reference from + <code>quick</code> will then be freed. + When <code>quick</code> hasn't been specified or is <code>UNDEFINED</code>, + this function checks all the memory for cyclic structures such + as arrays containing themselves and frees them if appropriate. + It also frees up destructed objects and things with only weak + references. + Normally there is no need to call this function since Pike will + call it by itself every now and then. (Pike will try to predict + when 20% of all arrays/object/programs in memory is 'garbage' + and call this routine then.) + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>The amount of garbage is returned. This is the number of arrays, + mappings, multisets, objects and programs that had no nonweak + external references during the garbage collection. It's normally + the same as the number of freed things, but there might be some + difference since _destruct() functions are called during freeing, + which can cause more things to be freed or allocated. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Pike.gc_parameters</code>, <code>Debug.gc_status</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method get_active_compilation_handler </dt> <dd><code><code class='object unresolved'>CompilationHandler</code> get_active_compilation_handler()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns the currently active compilation compatibility handler, or <tt>0</tt> (zero) if none is active. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>This function should only be used during a call of <code>compile()</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>get_active_error_handler()</code>, <code>compile()</code>, <code>master()->get_compilation_handler()</code>, <code>CompilationHandler</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + get_active_compiler + </dt> + <dd><code><code class='object unresolved'>CompilerEnvironment.PikeCompiler</code>|<code class='datatype'>zero</code> get_active_compiler()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns the most recent of the currently active pike compilers, + or <code>UNDEFINED</code> if none is active. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function should only be used during a call of <code>compile()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>get_active_error_handler()</code>, <code>compile()</code>, + <code>master()->get_compilation_handler()</code>, <code>CompilationHandler</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method get_active_error_handler </dt> <dd><code><code class='object unresolved'>CompilationHandler</code> get_active_error_handler()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns the currently active compilation error handler (second argument to <code>compile()</code>), or <tt>0</tt> (zero) if none is active. </dd> <dt class='head--doc'>Note</dt>
autodoc.git/traditional_manual/chapter_21.html:1795: </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>getgrent()</code> <code>getgrgid()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + gethrdtime + </dt> + <dd><code><code class='datatype'>int</code> gethrdtime(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>nsec</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the high resolution real time spent with threads disabled + since the Pike interpreter was started. The time is normally + returned in microseconds, but if the optional argument <code>nsec</code> + is nonzero it's returned in nanoseconds. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The actual accuracy on many systems is significantly less than + microseconds or nanoseconds. See <code>System.REAL_TIME_RESOLUTION</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>_disable_threads()</code>, <code>gethrtime()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + gethrtime + </dt> + <dd><code><code class='datatype'>int</code> gethrtime(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>nsec</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the high resolution real time since some arbitrary event in + the past. The time is normally returned in microseconds, but if + the optional argument <code>nsec</code> is nonzero it's returned in + nanoseconds. + It's system dependent whether or not this time is monotonic, i.e. + if it's unaffected by adjustments of the calendaric clock in the + system. <code>System.REAL_TIME_IS_MONOTONIC</code> tells what it is. Pike + tries to use monotonic time for this function if it's available. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The actual accuracy on many systems is significantly less than + microseconds or nanoseconds. See <code>System.REAL_TIME_RESOLUTION</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>System.REAL_TIME_IS_MONOTONIC</code>, <code>System.REAL_TIME_RESOLUTION</code>, + <code>time()</code>, <code>System.gettimeofday()</code>, <code>gethrvtime()</code>, + <code>Pike.implicit_gc_real_time</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + gethrvtime + </dt> + <dd><code><code class='datatype'>int</code> gethrvtime(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>nsec</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the CPU time that has been consumed by this process or + thread. -1 is returned if the system couldn't determine it. The + time is normally returned in microseconds, but if the optional + argument <code>nsec</code> is nonzero it's returned in nanoseconds. + The CPU time includes both user and system time, i.e. it's + approximately the same thing you would get by adding together the + "utime" and "stime" fields returned by <code>System.getrusage</code> (but + perhaps with better accuracy). + It's however system dependent whether or not it's the time + consumed in all threads or in the current one only; + <code>System.CPU_TIME_IS_THREAD_LOCAL</code> tells which. If both types are + available then thread local time is preferred. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The actual accuracy on many systems is significantly less than + microseconds or nanoseconds. See <code>System.CPU_TIME_RESOLUTION</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The garbage collector might run automatically at any time. The + time it takes is not included in the figure returned by this + function, so that normal measurements aren't randomly clobbered + by it. Explicit calls to <code>gc</code> are still included, though. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The special function <code>gauge</code> is implemented with this function. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>System.CPU_TIME_IS_THREAD_LOCAL</code>, <code>System.CPU_TIME_RESOLUTION</code>, + <code>gauge()</code>, <code>System.getrusage()</code>, <code>gethrtime()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method getpid </dt> <dd><code><code class='datatype'>int</code> getpid()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns the process ID of this process. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>System.getppid()</code>, <code>System.getpgrp()</code> </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:1898: <dd><code><code class='datatype'>string</code> getxattr(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>string</code> <code class='argument'>attr</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>symlink</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Return the value of a specified attribute, or 0 if it does not exist. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + glob + </dt> + <dd><code><code class='datatype'>bool</code> glob(<code class='datatype'>string</code> <code class='argument'>glob</code>, <code class='datatype'>string</code> <code class='argument'>str</code>)</code> + <code><code class='datatype'>string</code> glob(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>glob</code>, <code class='datatype'>string</code> <code class='argument'>str</code>)</code> + <code><code class='datatype'>array</code>(<code class='datatype'>string</code>) glob(<code class='datatype'>string</code> <code class='argument'>glob</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>str</code>)</code> + <code><code class='datatype'>array</code>(<code class='datatype'>string</code>) glob(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>glob</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>str</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Match strings against a glob pattern. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>glob</code></dt> + <dd></dd><dd class='body--doc'><table class='box'><tr><td><code><code class='datatype'>string</code></code></td><td>The glob pattern. A question sign ('?') matches any character + and an asterisk ('*') matches a string of arbitrary length. All + other characters only match themselves. + </td></tr> + <tr><td><code><code class='datatype'>array</code>(<code class='datatype'>string</code>)</code></td><td>the function returns the matching glob if any of the given + patterns match. Otherwise 0. If the second argument is an array + it will behave as if the first argument is a string (see + below) + </td></tr> + </table> + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>str</code></dt> + <dd></dd><dd class='body--doc'><table class='box'><tr><td><code><code class='datatype'>string</code></code></td><td><code class='expr'>1</code> is returned if the string <code>str</code> matches <code>glob</code>, + <code class='expr'>0</code> (zero) otherwise. + </td></tr> + <tr><td><code><code class='datatype'>array</code>(<code class='datatype'>string</code>)</code></td><td>All strings in the array <code>str</code> are matched against <code>glob</code>, + and those that match are returned in an array (in the same + order). + </td></tr> + </table> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>sscanf()</code>, <code>Regexp</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + gmtime + </dt> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) gmtime(<code class='datatype'>int</code> <code class='argument'>timestamp</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Convert seconds since 00:00:00 UTC, Jan 1, 1970 into components. + This function works like <code>localtime()</code> but the result is + not adjusted for the local time zone. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>localtime()</code>, <code>time()</code>, <code>ctime()</code>, <code>mktime()</code>, + <code>strptime()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + has_index + </dt> + <dd><code><code class='datatype'>int</code> has_index(<code class='datatype'>string</code> <code class='argument'>haystack</code>, <code class='datatype'>int</code> <code class='argument'>index</code>)</code> + <code><code class='datatype'>int</code> has_index(<code class='datatype'>array</code> <code class='argument'>haystack</code>, <code class='datatype'>int</code> <code class='argument'>index</code>)</code> + <code><code class='datatype'>int</code> has_index(<code class='datatype'>mapping</code>|<code class='datatype'>multiset</code>|<code class='datatype'>object</code>|<code class='datatype'>program</code> <code class='argument'>haystack</code>, <code class='datatype'>mixed</code> <code class='argument'>index</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Search for <code>index</code> in <code>haystack</code>. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <code class='expr'>1</code> if <code>index</code> is in the index domain of <code>haystack</code>, + or <code class='expr'>0</code> (zero) if not found. + This function is equivalent to (but sometimes faster than): + <pre><code>search(indices(haystack), index) != -1</code></pre> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>A negative index in strings and arrays as recognized by the + index operators <code class='expr'>`[]()</code> and <code class='expr'>`[]=()</code> is not considered + a proper index by <code>has_index()</code> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>has_value()</code>, <code>has_prefix()</code>, <code>has_suffix()</code>, <code>indices()</code>, + <code>search()</code>, <code>values()</code>, <code>zero_type()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + has_prefix + </dt> + <dd><code><code class='datatype'>int</code> has_prefix(<code class='datatype'>string</code>|<code class='datatype'>object</code> <code class='argument'>s</code>, <code class='datatype'>string</code> <code class='argument'>prefix</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns <code class='expr'>1</code> if the string <code>s</code> starts with <code>prefix</code>, + returns <code class='expr'>0</code> (zero) otherwise. + When <code>s</code> is an object, it needs to implement + <code>lfun::_sizeof()</code> and <code>lfun::`[]</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>has_suffix()</code>, <code>has_value()</code>, <code>search()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + has_suffix + </dt> + <dd><code><code class='datatype'>int</code> has_suffix(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>string</code> <code class='argument'>suffix</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns <code class='expr'>1</code> if the string <code>s</code> ends with <code>suffix</code>, + returns <code class='expr'>0</code> (zero) otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>has_prefix()</code>, <code>has_value()</code>, <code>search()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + has_value + </dt> + <dd><code><code class='datatype'>int</code> has_value(<code class='datatype'>string</code> <code class='argument'>haystack</code>, <code class='datatype'>string</code> <code class='argument'>value</code>)</code> + <code><code class='datatype'>int</code> has_value(<code class='datatype'>string</code> <code class='argument'>haystack</code>, <code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='datatype'>int</code> has_value(<code class='datatype'>array</code>|<code class='datatype'>mapping</code>|<code class='datatype'>object</code>|<code class='datatype'>program</code> <code class='argument'>haystack</code>, <code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Search for <code>value</code> in <code>haystack</code>. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <code class='expr'>1</code> if <code>value</code> is in the value domain of <code>haystack</code>, + or <code class='expr'>0</code> (zero) if not found. + This function is in all cases except when both arguments are strings + equivalent to (but sometimes faster than): + <pre><code>search(values(haystack), value) != -1</code></pre>If both arguments are strings, <code>has_value()</code> is equivalent to: + <pre><code>search(haystack, value) != -1</code></pre> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>has_index()</code>, <code>indices()</code>, <code>search()</code>, <code>has_prefix()</code>, + <code>has_suffix()</code>, <code>values()</code>, <code>zero_type()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + hash + </dt> + <dd><code><code class='datatype'>int</code> hash(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> + <code><code class='datatype'>int</code> hash(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>max</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return an integer derived from the string <code>s</code>. The same string + always hashes to the same value, also between processes, + architectures, and Pike versions (see compatibility notes below, + though). + If <code>max</code> is given, the result will be >= 0 and < <code>max</code>, + otherwise the result will be >= 0 and <= 0x7fffffff. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The hash algorithm was changed in Pike 8.1. If you want a hash + that is compatible with Pike 8.0 and earlier, use <code>hash_8_0()</code>. + The hash algorithm was also changed in Pike 7.5. If you want a hash + that is compatible with Pike 7.4 and earlier, use <code>hash_7_4()</code>. + The difference with regards to <code>hash_8_0()</code> only affects wide strings. + The hash algorithm was also changed in Pike 7.1. If you want a hash + that is compatible with Pike 7.0 and earlier, use <code>hash_7_0()</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This hash function differs from the one provided by <code>hash_value()</code>, + in that <code>hash_value()</code> returns a process specific value. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>hash_7_0()</code>, <code>hash_7_4()</code>, <code>hash_8_0()</code>, <code>hash_value</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + hash_7_0 + </dt> + <dd><code><code class='datatype'>int</code> hash_7_0(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> + <code><code class='datatype'>int</code> hash_7_0(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>max</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return an integer derived from the string <code>s</code>. The same string + always hashes to the same value, also between processes. + If <code>max</code> is given, the result will be >= 0 and < <code>max</code>, + otherwise the result will be >= 0 and <= 0x7fffffff. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function is provided for backward compatibility with + code written for Pike up and including version 7.0. + This function is not NUL-safe, and is byte-order dependant. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>hash()</code>, <code>hash_7_4</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + hash_7_4 + </dt> + <dd><code><code class='datatype'>int</code> hash_7_4(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> + <code><code class='datatype'>int</code> hash_7_4(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>max</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return an integer derived from the string <code>s</code>. The same string + always hashes to the same value, also between processes. + If <code>max</code> is given, the result will be >= 0 and < <code>max</code>, + otherwise the result will be >= 0 and <= 0x7fffffff. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function is provided for backward compatibility with + code written for Pike up and including version 7.4. + This function is byte-order dependant for wide strings. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>hash_7_6()</code>, <code>hash_7_0</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + hash_8_0 + </dt> + <dd><code><code class='datatype'>int</code> hash_8_0(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> + <code><code class='datatype'>int</code> hash_8_0(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>max</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return an integer derived from the string <code>s</code>. The same string + always hashes to the same value, also between processes, + architectures, and Pike versions (see compatibility notes below, + though). + If <code>max</code> is given, the result will be >= 0 and < <code>max</code>, + otherwise the result will be >= 0 and <= 0x7fffffff. + </dd> + <dt class='head--doc'>Deprecated</dt> + <dd class='body--doc'>Use <code>hash_value()</code> for in-process hashing (eg, for implementing + <code>lfun::_hash()</code>) or one of the cryptographic hash functions. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function is really bad at hashing strings. Similar string + often return similar hash values. + It is especially bad for url:s, paths and similarly formatted + strings. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The hash algorithm was changed in Pike 7.5. If you want a hash + that is compatible with Pike 7.4 and earlier, use <code>hash_7_4()</code>. + The difference only affects wide strings. + The hash algorithm was also changed in Pike 7.1. If you want a hash + that is compatible with Pike 7.0 and earlier, use <code>hash_7_0()</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This hash function differs from the one provided by <code>hash_value()</code>, + in that <code>hash_value()</code> returns a process specific value. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>hash()</code>, <code>hash_7_0()</code>, <code>hash_7_4()</code>, <code>hash_value</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + hash_value + </dt> + <dd><code><code class='datatype'>int</code> hash_value(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return a hash value for the argument. It's an integer in the + native integer range. + The hash will be the same for the same value in the running + process only (the memory address is typically used as the basis + for the hash value). + If the value is an object with an <code>lfun::__hash</code>, that function + is called and its result returned. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This is the hashing method used by mappings. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>lfun::__hash()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method is_absolute_path </dt> <dd><code><code class='datatype'>int</code> is_absolute_path(<code class='datatype'>string</code> <code class='argument'>p</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Check if a path <code>p</code> is fully qualified (ie not relative). </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns 1 if the path is absolute, 0 otherwise. </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:2135: <dt class='head--doc'>Note</dt> <dd class='body--doc'>The current working directory is normally not searched for dynamic modules. Please use <code class='expr'>"./name.so"</code> instead of just <code class='expr'>"name.so"</code> to load modules from the current directory. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + localtime + </dt> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) localtime(<code class='datatype'>int</code> <code class='argument'>timestamp</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Convert seconds since 00:00:00 UTC, 1 Jan 1970 into components. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>This function returns a mapping with the following components: + <table class='box'><tr><td><code><code class='key'>"sec"</code> : <code class='datatype'>int(0..60)</code></code></td><td>Seconds over the minute. + </td></tr> + <tr><td><code><code class='key'>"min"</code> : <code class='datatype'>int(0..59)</code></code></td><td>Minutes over the hour. + </td></tr> + <tr><td><code><code class='key'>"hour"</code> : <code class='datatype'>int(0..23)</code></code></td><td>Hour of the day. + </td></tr> + <tr><td><code><code class='key'>"mday"</code> : <code class='datatype'>int(1..31)</code></code></td><td>Day of the month. + </td></tr> + <tr><td><code><code class='key'>"mon"</code> : <code class='datatype'>int(0..11)</code></code></td><td>Month of the year. + </td></tr> + <tr><td><code><code class='key'>"year"</code> : <code class='datatype'>int(0..)</code></code></td><td>Year since 1900. + </td></tr> + <tr><td><code><code class='key'>"wday"</code> : <code class='datatype'>int(0..6)</code></code></td><td>Day of week (0 = Sunday). + </td></tr> + <tr><td><code><code class='key'>"yday"</code> : <code class='datatype'>int(0..365)</code></code></td><td>Day of the year. + </td></tr> + <tr><td><code><code class='key'>"isdst"</code> : <code class='datatype'>bool</code></code></td><td>Is daylight-saving time active. + </td></tr> + <tr><td><code><code class='key'>"timezone"</code> : <code class='datatype'>int</code></code></td><td>Offset from UTC, including daylight-saving time adjustment. + </td></tr> + </table>An error is thrown if the localtime(2) call failed on the system. + It's platform dependent what time ranges that function can handle, + e.g. Windows doesn't handle a negative <code>timestamp</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Prior to Pike 7.5 the field <code class='expr'>"timezone"</code> was sometimes not + present, and was sometimes not adjusted for daylight-saving time. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Calendar</code>, <code>gmtime()</code>, <code>time()</code>, <code>ctime()</code>, <code>mktime()</code>, + <code>strptime()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method log </dt> <dd><code><code class='datatype'>float</code> log(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>f</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Return the natural logarithm of <code>f</code>. <code class='expr'>exp( log(x) ) == x</code> for x > 0. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>pow()</code>, <code>exp()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + lower_case + </dt> + <dd><code><code class='datatype'>string</code> lower_case(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> + <code><code class='datatype'>int</code> lower_case(<code class='datatype'>int</code> <code class='argument'>c</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Convert a string or character to lower case. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns a copy of the string <code>s</code> with all upper case characters + converted to lower case, or the character <code>c</code> converted to lower + case. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Assumes the string or character to be coded according to + ISO-10646 (aka Unicode). If they are not, <code>Charset.decoder</code> can + do the initial conversion for you. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Prior to Pike 7.5 this function only accepted strings. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>upper_case()</code>, <code>Charset.decoder</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method m_add </dt> <dd><code><code class='datatype'>void</code> m_add(<code class='datatype'>multiset</code>|<code class='datatype'>object</code> <code class='argument'>l</code>, <code class='datatype'>mixed</code> <code class='argument'>val</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Add a member to a multiset. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>m_delete()</code> </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:2213: <dd class='body--doc'>Note that <code>m_delete()</code> changes <code>map</code> destructively. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>mappingp()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + map + </dt> + <dd><code><code class='datatype'>mixed</code> map(<code class='datatype'>mixed</code> <code class='argument'>arr</code>, <code class='datatype'>void</code>|<code class='datatype'>mixed</code> <code class='argument'>fun</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Applies <code>fun</code> to the elements in <code>arr</code> and collects the results. + <code>arr</code> is treated as a set of elements, as follows: + <dl class='group--doc'><dt>array</dt> + <dt>multiset</dt> + <dt>string</dt> + <dd><code>fun</code> is applied in order to each element. The results are + collected, also in order, to a value of the same type as + <code>arr</code>, which is returned. + </dd> + <dt>mapping</dt> + <dd><code>fun</code> is applied to the values, and each result is assigned + to the same index in a new mapping, which is returned. + </dd> + <dt>program</dt> + <dd>The program is treated as a mapping containing the + identifiers that are indexable from it and their values. + </dd> + <dt>object</dt> + <dd>If there is a <code>lfun::cast</code> method in the object, it's + called to try to cast the object to an array, a mapping, or + a multiset, in that order, which is then handled as + described above. + </dd> + </dl><code>fun</code> is applied in different ways depending on its type: + <dl class='group--doc'><dt>function</dt> + <dd><code>fun</code> is called for each element. It gets the current + element as the first argument and <code>extra</code> as the rest. The + result of the call is collected. + </dd> + <dt>object</dt> + <dd><code>fun</code> is used as a function like above, i.e. the + <code>lfun::`()</code> method in it is called. + </dd> + <dt>array</dt> + <dd>Each element of the <code>fun</code> array will be called for each + element of <code>arr</code>. + </dd> + <dt>multiset</dt> + <dt>mapping</dt> + <dd><code>fun</code> is indexed with each element. The result of that is + collected. + </dd> + <dt>"zero or left out"</dt> + <dd>Each element that is callable is called with <code>extra</code> as + arguments. The result of the calls are collected. Elements + that aren't callable gets zero as result. + </dd> + <dt>string</dt> + <dd>Each element is indexed with the given string. If the result + of that is zero then a zero is collected, otherwise it's + called with <code>extra</code> as arguments and the result of that + call is collected. + This is typically used when <code>arr</code> is a collection of + objects, and <code>fun</code> is the name of some function in them. + </dd> + </dl> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The function is never destructive on <code>arr</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>filter()</code>, <code>enumerate()</code>, <code>foreach()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + master + </dt> + <dd><code><code class='datatype'>object</code> master()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the current master object. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>May return <code>UNDEFINED</code> if no master has been loaded yet. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>replace_master()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method max </dt> <dd><code><code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>object</code> max(<code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>object</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>object</code> ... <code class='argument'>args</code>)</code> <code><code class='datatype'>string</code> max(<code class='datatype'>string</code>, <code class='datatype'>string</code> ... <code class='argument'>args</code>)</code> <code><code class='datatype'>int(0..0)</code> max()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns the largest value among <code>args</code>. Compared objects must implement the <code>lfun::`<</code> method. </dd>
autodoc.git/traditional_manual/chapter_21.html:2282: <dd class='body--doc'>This function creates a multiset from an array. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>aggregate_multiset()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + mktime + </dt> + <dd><code><code class='datatype'>int</code> mktime(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) <code class='argument'>tm</code>)</code> + <code><code class='datatype'>int</code> mktime(<code class='datatype'>int</code> <code class='argument'>sec</code>, <code class='datatype'>int</code> <code class='argument'>min</code>, <code class='datatype'>int</code> <code class='argument'>hour</code>, <code class='datatype'>int</code> <code class='argument'>mday</code>, <code class='datatype'>int</code> <code class='argument'>mon</code>, <code class='datatype'>int</code> <code class='argument'>year</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>isdst</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>tz</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function converts information about date and time into an integer + which contains the number of seconds since 00:00:00 UTC, Jan 1, 1970. + You can either call this function with a mapping containing the + following elements: + <table class='box'><tr><td><code><code class='key'>"sec"</code> : <code class='datatype'>int(0..60)</code></code></td><td>Seconds over the minute. + </td></tr> + <tr><td><code><code class='key'>"min"</code> : <code class='datatype'>int(0..59)</code></code></td><td>Minutes over the hour. + </td></tr> + <tr><td><code><code class='key'>"hour"</code> : <code class='datatype'>int(0..23)</code></code></td><td>Hour of the day. + </td></tr> + <tr><td><code><code class='key'>"mday"</code> : <code class='datatype'>int(1..31)</code></code></td><td>Day of the month. + </td></tr> + <tr><td><code><code class='key'>"mon"</code> : <code class='datatype'>int(0..11)</code></code></td><td>Month of the year. + </td></tr> + <tr><td><code><code class='key'>"year"</code> : <code class='datatype'>int(0..)</code></code></td><td>Year since 1900. + </td></tr> + <tr><td><code><code class='key'>"isdst"</code> : <code class='datatype'>int(-1..1)</code></code></td><td>Is daylight-saving time active. If omitted or set to <code class='expr'>-1</code>, + it means that the information is not available. + </td></tr> + <tr><td><code><code class='key'>"timezone"</code> : <code class='datatype'>int</code></code></td><td>The timezone offset from UTC in seconds. If omitted, the time + will be calculated in the local timezone. + </td></tr> + </table>Or you can just send them all on one line as the second syntax suggests. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>For proper UTC calculations ensure that <code class='expr'>isdst = 0</code> and + <code class='expr'>timezone = 0</code>; omitting either one of these parameters + will mess up the UTC calculation. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>On some operating systems (notably AIX and Win32), dates before + 00:00:00 UTC, Jan 1, 1970 are not supported. + On most 32-bit systems, the supported range of dates is from Dec 13, 1901 + 20:45:52 UTC through to Jan 19, 2038 03:14:07 UTC (inclusive). + On most 64-bit systems, the supported range of dates is expressed + in 56 bits and is thus practically + unlimited (at least up to 1141 milion years in the past + and into the future). + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>time()</code>, <code>ctime()</code>, <code>localtime()</code>, <code>gmtime()</code>, <code>strftime()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method normalize_path </dt> <dd><code><code class='datatype'>string</code> normalize_path(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Replaces "\" with "/" if runing on MS Windows. It is adviced to use <code>System.normalize_path</code> instead. </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:2310: <dd class='body--doc'>Get the <code class='expr'>n</code>th entry in order. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>An array <code class='expr'>({ key, value })</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + object_variablep + </dt> + <dd><code><code class='datatype'>bool</code> object_variablep(<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>string</code> <code class='argument'>var</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Find out if an object identifier is a variable. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>This function returns <code class='expr'>1</code> if <code>var</code> exists as a + non-protected variable in <code>o</code>, and returns <code class='expr'>0</code> (zero) + otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>indices()</code>, <code>values()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + objectp + </dt> + <dd><code><code class='datatype'>int</code> objectp(<code class='datatype'>mixed</code> <code class='argument'>arg</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns <code class='expr'>1</code> if <code>arg</code> is an object, <code class='expr'>0</code> (zero) otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>mappingp()</code>, <code>programp()</code>, <code>arrayp()</code>, <code>stringp()</code>, <code>functionp()</code>, + <code>multisetp()</code>, <code>floatp()</code>, <code>intp()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method pow </dt> <dd><code><code class='datatype'>int</code>|<code class='datatype'>float</code> pow(<code class='datatype'>float</code>|<code class='datatype'>int</code> <code class='argument'>n</code>, <code class='datatype'>float</code>|<code class='datatype'>int</code> <code class='argument'>x</code>)</code> <code><code class='datatype'>mixed</code> pow(<code class='datatype'>object</code> <code class='argument'>n</code>, <code class='datatype'>float</code>|<code class='datatype'>int</code>|<code class='datatype'>object</code> <code class='argument'>x</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Return <code>n</code> raised to the power of <code>x</code>. If both <code>n</code> and <code>x</code> are integers the result will be an integer. If <code>n</code> is an object its pow method will be called with <code>x</code> as argument.
autodoc.git/traditional_manual/chapter_21.html:2352: <dd class='body--doc'>On NT the environment variable name is case insensitive. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>getenv()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + query_num_arg + </dt> + <dd><code><code class='datatype'>int</code> query_num_arg()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns the number of arguments given when the previous function was + called. + This is useful for functions that take a variable number of arguments. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>call_function()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method random </dt> <dd><code><code class='datatype'>array</code> random(<code class='datatype'>mapping</code> <code class='argument'>m</code>)</code> <code><code class='datatype'>float</code> random(<code class='datatype'>float</code> <code class='argument'>max</code>)</code> <code><code class='datatype'>int</code> random(<code class='datatype'>int</code> <code class='argument'>max</code>)</code> <code><code class='datatype'>mixed</code> random(<code class='datatype'>object</code> <code class='argument'>o</code>)</code> <code><code class='datatype'>mixed</code> random(<code class='datatype'>array</code>|<code class='datatype'>multiset</code> <code class='argument'>x</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get a random value generated by the default <code>RandomSystem</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>RandomSystem()->random()</code>, <code>random_string()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + random_seed + </dt> + <dd><code><code class='datatype'>void</code> random_seed(<code class='datatype'>int</code> <code class='argument'>seed</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function sets the initial value for the random generator. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>random()</code> + </dd> + <dt class='head--doc'>Deprecated</dt> + <dd class='body--doc'><code>Random.Deterministic</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method random_string </dt> <dd><code><code class='datatype'>string</code> random_string(<code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get a string of random characters <code class='expr'>0..255</code> with the length <code>len</code> from the default <code>RandomSystem</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>RandomSystem()->random_string()</code>, <code>random()</code>
autodoc.git/traditional_manual/chapter_21.html:2447: <dd><code><code class='datatype'>void</code> removexattr(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>string</code> <code class='argument'>attr</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>symlink</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Remove the specified extended attribute. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + replace + </dt> + <dd><code><code class='datatype'>string</code> replace(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>string</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>)</code> + <code><code class='datatype'>string</code> replace(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>from</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>to</code>)</code> + <code><code class='datatype'>string</code> replace(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>)</code> + <code><code class='datatype'>string</code> replace(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>replacements</code>)</code> + <code><code class='datatype'>array</code> replace(<code class='datatype'>array</code> <code class='argument'>a</code>, <code class='datatype'>mixed</code> <code class='argument'>from</code>, <code class='datatype'>mixed</code> <code class='argument'>to</code>)</code> + <code><code class='datatype'>mapping</code> replace(<code class='datatype'>mapping</code> <code class='argument'>a</code>, <code class='datatype'>mixed</code> <code class='argument'>from</code>, <code class='datatype'>mixed</code> <code class='argument'>to</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Generic replace function. + This function can do several kinds replacement operations, the + different syntaxes do different things as follows: + If all the arguments are strings, a copy of <code>s</code> with every + occurrence of <code>from</code> replaced with <code>to</code> will be returned. + Special case: <code>to</code> will be inserted between every character in + <code>s</code> if <code>from</code> is the empty string. + If the first argument is a string, and the others array(string), a string + with every occurrance of <code>from</code>[i] in <code>s</code> replaced with + <code>to</code>[i] will be returned. Instead of the arrays <code>from</code> and <code>to</code> + a mapping equivalent to <code class='expr'><code>mkmapping</code>(<code>from</code>, <code>to</code>)</code> can be + used. + If the first argument is an array or mapping, the values of <code>a</code> which + are <code>`==()</code> with <code>from</code> will be replaced with <code>to</code> destructively. + <code>a</code> will then be returned. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Note that <code>replace()</code> on arrays and mappings is a destructive operation. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + replace_master + </dt> + <dd><code><code class='datatype'>void</code> replace_master(<code class='datatype'>object</code> <code class='argument'>o</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Replace the master object with <code>o</code>. + This will let you control many aspects of how Pike works, but beware that + <tt>master.pike</tt> may be required to fill certain functions, so it is + usually a good idea to have your master inherit the original master and + only re-define certain functions. + FIXME: Tell how to inherit the master. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>master()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + reverse + </dt> + <dd><code><code class='datatype'>string</code> reverse(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code>)</code> + <code><code class='datatype'>array</code> reverse(<code class='datatype'>array</code> <code class='argument'>a</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code>)</code> + <code><code class='datatype'>int</code> reverse(<code class='datatype'>int</code> <code class='argument'>i</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code>)</code> + <code><code class='datatype'>mixed</code> reverse(<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>mixed</code> ... <code class='argument'>options</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Reverses a string, array or int. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> + <dd></dd><dd class='body--doc'>String to reverse. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>a</code></dt> + <dd></dd><dd class='body--doc'>Array to reverse. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>i</code></dt> + <dd></dd><dd class='body--doc'>Integer to reverse. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>o</code></dt> + <dd></dd><dd class='body--doc'>Object to reverse. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>start</code></dt> + <dd></dd><dd class='body--doc'>Optional start index of the range to reverse. + Default: <code class='expr'>0</code> (zero). + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>end</code></dt> + <dd></dd><dd class='body--doc'>Optional end index of the range to reverse. + Default for strings: <code class='expr'>sizeof(s)-1</code>. + Default for arrays: <code class='expr'>sizeof(a)-1</code>. + Default for integers: <code class='expr'>Pike.get_runtime_info()->int_size - 1</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>options</code></dt> + <dd></dd><dd class='body--doc'>Optional arguments that are to be passed to <code>lfun::_reverse()</code>. + This function reverses a string, char by char, an array, value + by value or an int, bit by bit and returns the result. It's not + destructive on the input value. For objects it simply calls + <code>lfun::_reverse()</code> in the object, and returns the result. + Reversing strings can be particularly useful for parsing difficult + syntaxes which require scanning backwards. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>sscanf()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method round </dt> <dd><code><code class='datatype'>float</code> round(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>f</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Return the closest integer value to <code>f</code>. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'><code>round()</code> does not return an <code class='expr'>int</code>, merely an integer value stored in a <code class='expr'>float</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>floor()</code>, <code>ceil()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + rows + </dt> + <dd><code><code class='datatype'>array</code> rows(<code class='datatype'>mixed</code> <code class='argument'>data</code>, <code class='datatype'>array</code> <code class='argument'>index</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Select a set of rows from an array. + This function is en optimized equivalent to: + <pre><code>map(index, lambda(mixed x) { return data[x]; }) + </code></pre>That is, it indices data on every index in the array index and + returns an array with the results. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>column()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + search + </dt> + <dd><code><code class='datatype'>int</code> search(<code class='datatype'>string</code> <code class='argument'>haystack</code>, <code class='datatype'>string</code>|<code class='datatype'>int</code> <code class='argument'>needle</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code>)</code> + <code><code class='datatype'>int</code> search(<code class='datatype'>array</code> <code class='argument'>haystack</code>, <code class='datatype'>mixed</code> <code class='argument'>needle</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code>)</code> + <code><code class='datatype'>mixed</code> search(<code class='datatype'>mapping</code> <code class='argument'>haystack</code>, <code class='datatype'>mixed</code> <code class='argument'>needle</code>, <code class='datatype'>mixed</code>|<code class='datatype'>void</code> <code class='argument'>start</code>)</code> + <code><code class='datatype'>mixed</code> search(<code class='datatype'>object</code> <code class='argument'>haystack</code>, <code class='datatype'>mixed</code> <code class='argument'>needle</code>, <code class='datatype'>mixed</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Search for <code>needle</code> in <code>haystack</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>haystack</code></dt> + <dd></dd><dd class='body--doc'>Item to search in. This can be one of: + <table class='box'><tr><td><code><code class='datatype'>string</code></code></td><td>When <code>haystack</code> is a string <code>needle</code> must be a string or an int, + and the first occurrence of the string or int is returned. + </td></tr> + <tr><td><code><code class='datatype'>array</code></code></td><td>When <code>haystack</code> is an array, <code>needle</code> is compared only to + one value at a time in <code>haystack</code>. + </td></tr> + <tr><td><code><code class='datatype'>mapping</code></code></td><td>When <code>haystack</code> is a mapping, <code>search()</code> tries to find the index + connected to the data <code>needle</code>. That is, it tries to lookup the + mapping backwards. + </td></tr> + <tr><td><code><code class='datatype'>object</code></code></td><td>When <code>haystack</code> is an object implementing <code>lfun::_search()</code>, + the result of calling <code>lfun::_search()</code> with <code>needle</code>, <code>start</code> + and any <code>extra_args</code> will be returned. + If <code>haystack</code> is an object that doesn't implement <code>lfun::_search()</code> + it is assumed to be an <code>Iterator</code>, and implement + <code>Iterator()->index()</code>, <code>Iterator()->value()</code>, and + <code>Iterator()->next()</code>. <code>search()</code> will then start comparing + elements with <code>`==()</code> until a match with <code>needle</code> is found. + If <code>needle</code> is found <code>haystack</code> will be advanced to the element, + and the iterator index will be returned. If <code>needle</code> is not + found, <code>haystack</code> will be advanced to the end. + </td></tr> + </table> + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>start</code></dt> + <dd></dd><dd class='body--doc'>If the optional argument <code>start</code> is present search is started at + this position. This has no effect on mappings. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>end</code></dt> + <dd></dd><dd class='body--doc'>If the optional argument <code>end</code> is present, the search will terminate + at this position (exclusive) if not found earlier. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns the position of <code>needle</code> in <code>haystack</code> if found. + If not found the returned value depends on the type of <code>haystack</code>: + <table class='box'><tr><td><code><code class='datatype'>string</code>|<code class='datatype'>array</code></code></td><td><code class='expr'>-1</code>. + </td></tr> + <tr><td><code><code class='datatype'>mapping</code>|<code class='object unresolved'>Iterator</code></code></td><td><code>UNDEFINED</code>. + </td></tr> + <tr><td><code><code class='datatype'>object</code></code></td><td>The value returned by <code>lfun::_search()</code>. + </td></tr> + </table> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>If <code>start</code> is supplied to an iterator object without an + <code>lfun::_search()</code>, <code>haystack</code> will need to implement + <code>Iterator()->set_index()</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>For mappings and object <code>UNDEFINED</code> will be returned when not found. + In all other cases <code class='expr'>-1</code> will be returned when not found. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>indices()</code>, <code>values()</code>, <code>zero_type()</code>, <code>has_value()</code>, + <code>has_prefix()</code>, <code>has_suffix()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method set_priority </dt> <dd><code><code class='datatype'>int</code> set_priority(<code class='datatype'>string</code> <code class='argument'>level</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>void</code> <code class='argument'>pid</code>)</code></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + set_weak_flag + </dt> + <dd><code><code class='datatype'>array</code>|<code class='datatype'>mapping</code>|<code class='datatype'>multiset</code> set_weak_flag(<code class='datatype'>array</code>|<code class='datatype'>mapping</code>|<code class='datatype'>multiset</code> <code class='argument'>m</code>, <code class='datatype'>int</code> <code class='argument'>state</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Set the value <code>m</code> to use weak or normal references in its + indices and/or values (whatever is applicable). <code>state</code> is a + bitfield built by using <code class='expr'>|</code> between the following flags: + <table class='box'><tr><td><code><code class='key'>Pike.WEAK_INDICES</code></code></td><td>Use weak references for indices. Only applicable for + multisets and mappings. + </td></tr> + <tr><td><code><code class='key'>Pike.WEAK_VALUES</code></code></td><td>Use weak references for values. Only applicable for arrays + and mappings. + </td></tr> + <tr><td><code><code class='key'>Pike.WEAK</code></code></td><td>Shorthand for <code class='expr'>Pike.WEAK_INDICES|Pike.WEAK_VALUES</code>. + </td></tr> + </table>If a flag is absent, the corresponding field will use normal + references. <code>state</code> can also be <code class='expr'>1</code> as a compatibility + measure; it's treated like <code>Pike.WEAK</code>. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'><code>m</code> will be returned. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method setxattr </dt> <dd><code><code class='datatype'>void</code> setxattr(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>string</code> <code class='argument'>attr</code>, <code class='datatype'>string</code> <code class='argument'>value</code>, <code class='datatype'>int</code> <code class='argument'>flags</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>symlink</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Set the attribute <code>attr</code> to the value <code>value</code>. The flags parameter can be used to refine the semantics of the operation. <code>Stdio.XATTR_CREATE</code> specifies a pure create, which fails if the named attribute exists already. <code>Stdio.XATTR_REPLACE</code> specifies a pure replace operation, which
autodoc.git/traditional_manual/chapter_21.html:2642: </table> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>lfun::_sizeof()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + sleep + </dt> + <dd><code><code class='datatype'>void</code> sleep(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>s</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>abort_on_signal</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function makes the thread stop for <code>s</code> seconds. + Only signal handlers can interrupt the sleep, and only when + <code>abort_on_signal</code> is set. If more than one thread is running + the signal must be sent to the sleeping thread. Other callbacks + are not called during sleep. + If <code>s</code> is zero then this thread will yield to other threads but + not sleep otherwise. Note that Pike yields internally at regular + intervals so it's normally not necessary to do this. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>signal()</code>, <code>delay()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + sort + </dt> + <dd><code><code class='datatype'>array</code> sort(<code class='datatype'>array</code>(<code class='datatype'>mixed</code>) <code class='argument'>index</code>, <code class='datatype'>array</code>(<code class='datatype'>mixed</code>) ... <code class='argument'>data</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Sort arrays destructively. + This function sorts the array <code>index</code> destructively. That means + that the array itself is changed and returned, no copy is created. + If extra arguments are given, they are supposed to be arrays of the + same size as <code>index</code>. Each of these arrays will be modified in the + same way as <code>index</code>. I.e. if index 3 is moved to position 0 in <code>index</code> + index 3 will be moved to position 0 in all the other arrays as well. + The sort order is as follows: + <ul> + <li>Integers and floats are sorted in ascending order. + </li><li>Strings are sorted primarily on the first characters that are + different, and secondarily with shorter strings before longer. + Different characters are sorted in ascending order on the + character value. Thus the sort order is not locale dependent. + </li><li>Arrays are sorted recursively on the first element. Empty + arrays are sorted before nonempty ones. + </li><li>Multisets are sorted recursively on the first index. Empty + multisets are sorted before nonempty ones. + </li><li>Objects are sorted in ascending order according to <code>`<()</code>, + <code>`>()</code> and <code>`==()</code>. + </li><li>Other types aren't reordered. + </li><li>Different types are sorted in this order: Arrays, mappings, + multisets, objects, functions, programs, strings, types, + integers and floats. Note however that objects can control + their ordering wrt other types with <code>`<</code>, <code>`></code> and <code>`==</code>, + so this ordering of types only applies to objects without + those functions. + </li></ul> + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>The first argument is returned. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The sort is stable, i.e. elements that are compare-wise equal + aren't reordered. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Array.sort_array</code>, <code>reverse()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method sprintf </dt> <dd><code><code class='datatype'>string</code> sprintf(<code class='object unresolved'>strict_sprintf_format</code> <code class='argument'>format</code>, <code class='object unresolved'>sprintf_args</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Print formated output to string. The <code>format</code> string is a string containing a description of how to output the data in <code>args</code>. This string should generally speaking have one <tt>%<modifiers><operator></tt> format specifier (examples: <tt>%s</tt>, <tt>%0d</tt>, <tt>%-=20s</tt>) for each of the arguments.
autodoc.git/traditional_manual/chapter_21.html:3123: directive (%s or %[]) counts as a match even when matching just the empty string (which either may do). </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>sprintf</code>, <code>array_sscanf</code> </dd></dl> <hr /> <dl class='group--doc'> + <dt class='head--type'>Method + strftime + </dt> + <dd><code><code class='datatype'>string(1..255)</code> strftime(<code class='datatype'>string(1..255)</code> <code class='argument'>format</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) <code class='argument'>tm</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Convert the structure to a string. + <dl class='group--doc'><dt>%a</dt> + <dd>The abbreviated weekday name according to the current locale + </dd> + <dt>%A</dt> + <dd>The full weekday name according to the current locale. + </dd> + <dt>%b</dt> + <dd>The abbreviated month name according to the current locale. + </dd> + <dt>%B</dt> + <dd>The full month name according to the current locale. + </dd> + <dt>%c</dt> + <dd>The preferred date and time representation for the current locale. + </dd> + <dt>%C</dt> + <dd>The century number (year/100) as a 2-digit integer. + </dd> + <dt>%d</dt> + <dd>The day of the month as a decimal number (range 01 to 31). + </dd> + <dt>%D</dt> + <dd>Equivalent to <code class='expr'>%m/%d/%y</code>. (for Americans only. + Americans should note that in other countries <code class='expr'>%d/%m/%y</code> + is rather common. This means that in international context + this format is ambiguous and should not be used.) + </dd> + <dt>%e</dt> + <dd>Like <code class='expr'>%d</code>, the day of the month as a decimal number, + but a leading zero is replaced by a space. + </dd> + <dt>%E</dt> + <dd>Modifier: use alternative format, see below. + </dd> + <dt>%F</dt> + <dd>Equivalent to %Y-%m-%d (the ISO 8601 date format). (C99) + </dd> + <dt>%G</dt> + <dd>The ISO 8601 week-based year (see NOTES) with century as a + decimal number. The 4-digit year corresponding to the ISO + week number (see <code class='expr'>%V</code>). This has the same format and + value as <code class='expr'>%Y</code>, except that if the ISO week number + belongs to the previous or next year, that year is used instead. + </dd> + <dt>%g</dt> + <dd>Like <code class='expr'>%G</code>, but without century, that is, + with a 2-digit year (00-99). (TZ) + </dd> + <dt>%h</dt> + <dd>Equivalent to %b. + </dd> + <dt>%H</dt> + <dd>The hour as a decimal number using a 24-hour clock (range 00 to 23). + </dd> + <dt>%I</dt> + <dd>The hour as a decimal number using a 12-hour clock (range 01 to 12). + </dd> + <dt>%j</dt> + <dd>The day of the year as a decimal number (range 001 to 366). + </dd> + <dt>%m</dt> + <dd>The month as a decimal number (range 01 to 12). + </dd> + <dt>%M</dt> + <dd>The minute as a decimal number (range 00 to 59). + </dd> + <dt>%n</dt> + <dd>A newline character. (SU) + </dd> + <dt>%O</dt> + <dd>Modifier: use alternative format, see below. (SU) + </dd> + <dt>%p</dt> + <dd>Either <code class='expr'>"AM"</code> or <code class='expr'>"PM"</code> according to the given time + value, or the corresponding strings for the current locale. + Noon is treated as <code class='expr'>"PM"</code> and midnight as <code class='expr'>"AM"</code>. + </dd> + <dt>%P</dt> + <dd>Like <code class='expr'>%p</code> but in lowercase: <code class='expr'>"am"</code> or <code class='expr'>"pm"</code> + or a corresponding string for the current locale. + </dd> + <dt>%r</dt> + <dd>The time in a.m. or p.m. notation. In the POSIX locale this is + equivalent to <code class='expr'>%I:%M:%S %p</code>. + </dd> + <dt>%R</dt> + <dd>The time in 24-hour notation (<code class='expr'>%H:%M</code>). (SU) + For a version including the seconds, see <code class='expr'>%T</code> below. + </dd> + <dt>%s</dt> + <dd>The number of seconds since the Epoch, + 1970-01-01 00:00:00 +0000 (UTC). (TZ) + </dd> + <dt>%S</dt> + <dd>The second as a decimal number (range 00 to 60). + (The range is up to 60 to allow for occasional leap seconds.) + </dd> + <dt>%t</dt> + <dd>A tab character. (SU) + </dd> + <dt>%T</dt> + <dd>The time in 24-hour notation (<code class='expr'>%H:%M:%S</code>). (SU) + </dd> + <dt>%u</dt> + <dd>The day of the week as a decimal, range 1 to 7, Monday being 1. + See also <code class='expr'>%w</code>. (SU) + </dd> + <dt>%U</dt> + <dd>The week number of the current year as a decimal number, + range 00 to 53, starting with the first Sunday as the first + day of week 01. See also <code class='expr'>%V</code> and <code class='expr'>%W</code>. + </dd> + <dt>%V</dt> + <dd>The ISO 8601 week number of the current year as a decimal number, + range 01 to 53, where week 1 is the first week that has at least + 4 days in the new year. See also <code class='expr'>%U</code> and <code class='expr'>%W</code>. + </dd> + <dt>%w</dt> + <dd>The day of the week as a decimal, range 0 to 6, Sunday being 0. + See also <code class='expr'>%u</code>. + </dd> + </dl> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>ctime()</code>, <code>mktime()</code>, <code>strptime()</code>, <code>Gettext.setlocale</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> <dt class='head--type'>Constant strict_sprintf_format </dt> <dd><code><code class='datatype'>constant</code> <code class='constant'>strict_sprintf_format</code></code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Type constant used for typing arguments that are always sent to <code>sprintf()</code> regardless of the presence of extra arguments. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>sprintf_format</code>, <code>sprintf_args</code>, <code>sprintf()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + string_filter_non_unicode + </dt> + <dd><code><code class='datatype'>string(1..)</code> string_filter_non_unicode(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Replace the most obviously non-unicode characters from <code>s</code> with + the unicode replacement character. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This will replace characters outside the ranges + <code class='expr'>0x00000000-0x0000d7ff</code> and <code class='expr'>0x0000e000-0x0010ffff</code> + with 0xffea (the replacement character). + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Charset.encoder()</code>, <code>string_to_unicode()</code>, + <code>unicode_to_string()</code>, <code>utf8_to_string()</code>, <code>string_to_utf8()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + string_to_unicode + </dt> + <dd><code><code class='datatype'>string(8bit)</code> string_to_unicode(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int(0..2)</code>|<code class='datatype'>void</code> <code class='argument'>byteorder</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Converts a string into an UTF16 compliant byte-stream. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> + <dd></dd><dd class='body--doc'>String to convert to UTF16. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>byteorder</code></dt> + <dd></dd><dd class='body--doc'>Byte-order for the output. One of: + <table class='box'><tr><td><code><code class='key'>0</code></code></td><td>Network (aka big-endian) byte-order (default). + </td></tr> + <tr><td><code><code class='key'>1</code></code></td><td>Little-endian byte-order. + </td></tr> + <tr><td><code><code class='key'>2</code></code></td><td>Native byte-order. + </td></tr> + </table> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Throws an error if characters not legal in an UTF16 stream are + encountered. Valid characters are in the range 0x00000 - 0x10ffff, + except for characters 0xfffe and 0xffff. + Characters in range 0x010000 - 0x10ffff are encoded using surrogates. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Charset.decoder()</code>, <code>string_to_utf8()</code>, <code>unicode_to_string()</code>, + <code>utf8_to_string()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + string_to_utf8 + </dt> + <dd><code><code class='object unresolved'>utf8_string</code> string_to_utf8(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> + <code><code class='object unresolved'>utf8_string</code> string_to_utf8(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>extended</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Convert a string into a UTF-8 compliant byte-stream. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> + <dd></dd><dd class='body--doc'>String to encode into UTF-8. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>extended</code></dt> + <dd></dd><dd class='body--doc'>Bitmask with extension options. + <table class='box'><tr><td><code><code class='key'>1</code></code></td><td>Accept and encode the characters outside the valid ranges + using the same algorithm. Such encoded characters are + however not UTF-8 compliant. + </td></tr> + <tr><td><code><code class='key'>2</code></code></td><td>Encode characters outside the BMP with UTF-8 encoded UTF-16 + (ie split them into surrogate pairs and encode). + </td></tr> + </table> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Throws an error if characters not valid in an UTF-8 stream are + encountered. Valid characters are in the ranges + <code class='expr'>0x00000000-0x0000d7ff</code> and <code class='expr'>0x0000e000-0x0010ffff</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Charset.encoder()</code>, <code>string_to_unicode()</code>, + <code>unicode_to_string()</code>, <code>utf8_to_string()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + stringp + </dt> + <dd><code><code class='datatype'>int</code> stringp(<code class='datatype'>mixed</code> <code class='argument'>arg</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns <code class='expr'>1</code> if <code>arg</code> is a string, <code class='expr'>0</code> (zero) otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>intp()</code>, <code>programp()</code>, <code>arrayp()</code>, <code>multisetp()</code>, <code>objectp()</code>, + <code>mappingp()</code>, <code>floatp()</code>, <code>functionp()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + strptime + </dt> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) strptime(<code class='datatype'>string(1..255)</code> <code class='argument'>data</code>, <code class='datatype'>string(1..255)</code> <code class='argument'>format</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Parse the given <code>data</code> using the format in <code>format</code> as a date. + <dl class='group--doc'><dt>%%</dt> + <dd>The % character. + </dd> + <dt>%a or %A</dt> + <dd>The weekday name according to the C locale, in abbreviated + form or the full name. + </dd> + <dt>%b or %B or %h</dt> + <dd>The month name according to the C locale, in abbreviated form + or the full name. + </dd> + <dt>%c</dt> + <dd>The date and time representation for the C locale. + </dd> + <dt>%C</dt> + <dd>The century number (0-99). + </dd> + <dt>%d or %e</dt> + <dd>The day of month (1-31). + </dd> + <dt>%D</dt> + <dd>Equivalent to %m/%d/%y. + </dd> + <dt>%H</dt> + <dd>The hour (0-23). + </dd> + <dt>%I</dt> + <dd>The hour on a 12-hour clock (1-12). + </dd> + <dt>%j</dt> + <dd>The day number in the year (1-366). + </dd> + <dt>%m</dt> + <dd>The month number (1-12). + </dd> + <dt>%M</dt> + <dd>The minute (0-59). + </dd> + <dt>%n</dt> + <dd>Arbitrary whitespace. + </dd> + <dt>%p</dt> + <dd>The C locale's equivalent of AM or PM. + </dd> + <dt>%R</dt> + <dd>Equivalent to %H:%M. + </dd> + <dt>%S</dt> + <dd>The second (0-60; 60 may occur for leap seconds; + earlier also 61 was allowed). + </dd> + <dt>%t</dt> + <dd>Arbitrary whitespace. + </dd> + <dt>%T</dt> + <dd>Equivalent to %H:%M:%S. + </dd> + <dt>%U</dt> + <dd>The week number with Sunday the first day of the week (0-53). + </dd> + <dt>%w</dt> + <dd>The weekday number (0-6) with Sunday = 0. + </dd> + <dt>%W</dt> + <dd>The week number with Monday the first day of the week (0-53). + </dd> + <dt>%x</dt> + <dd>The date, using the C locale's date format. + </dd> + <dt>%X</dt> + <dd>The time, using the C locale's time format. + </dd> + <dt>%y</dt> + <dd>The year within century (0-99). When a century is not + otherwise specified, values in the range 69-99 refer to years + in the twentieth century (1969-1999); values in the range + 00-68 refer to years in the twenty-first century (2000-2068). + </dd> + <dt>%Y</dt> + <dd>The year, including century (for example, 1991). + </dd> + </dl> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>localtime()</code>, <code>gmtime()</code>, <code>strftime()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method tan </dt> <dd><code><code class='datatype'>float</code> tan(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>f</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns the tangent value for <code>f</code>. <code>f</code> should be specified in radians. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>atan()</code>, <code>sin()</code>, <code>cos()</code>
autodoc.git/traditional_manual/chapter_21.html:3200: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Builtin constant that evaluates to the current function. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>this</code>, <code>this_object()</code> </dd></dl> <hr /> <dl class='group--doc'> + <dt class='head--type'>Method + this_object + </dt> + <dd><code><code class='datatype'>object</code> this_object(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>level</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns the object we are currently evaluating in. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>level</code></dt> + <dd></dd><dd class='body--doc'><code>level</code> may be used to access the object of a surrounding + class: The object at level 0 is the current object, the object + at level 1 is the one belonging to the class that surrounds + the class that the object comes from, and so on. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>As opposed to a qualified <code class='expr'>this</code> reference such as + <code class='expr'>global::this</code>, this function doesn't always access the + objects belonging to the lexically surrounding classes. If the + class containing the call has been inherited then the objects + surrounding the inheriting class are accessed. + </dd></dl> + + + <hr /> + <dl class='group--doc'> <dt class='head--type'>Constant this_program </dt> <dd><code><code class='datatype'>constant</code> <code class='constant'>this_program</code></code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Builtin constant that evaluates to the current program. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>this</code>, <code>this_object()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - + throw + </dt> + <dd><code><code class='datatype'>mixed</code>|<code class='datatype'>void</code> throw(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Throw <code>value</code> to a waiting <code>catch</code>. + If no <code>catch</code> is waiting the global error handling will send the + value to <code>master()->handle_error()</code>. + If you throw an array with where the first index contains an error + message and the second index is a backtrace, (the output from + <code>backtrace()</code>) then it will be treated exactly like a real error + by overlying functions. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>catch</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + time + </dt> + <dd><code><code class='datatype'>int</code> time()</code> + <code><code class='datatype'>int</code> time(<code class='datatype'>int(1..1)</code> <code class='argument'>one</code>)</code> + <code><code class='datatype'>float</code> time(<code class='datatype'>int(2..)</code> <code class='argument'>t</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function returns the number of seconds since 00:00:00 UTC, 1 Jan 1970. + The second syntax does not query the system for the current + time, instead the last time value used by the pike process is returned + again. It avoids a system call, and thus is slightly faster, + but can be wildly inaccurate. Pike + queries the time internally when a thread has waited for + something, typically in <code>sleep</code> or in a backend (see + <code>Pike.Backend</code>). + The third syntax can be used to measure time more precisely than one + second. It returns how many seconds have passed since <code>t</code>. The precision + of this function varies from system to system. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>ctime()</code>, <code>localtime()</code>, <code>mktime()</code>, <code>gmtime()</code>, + <code>System.gettimeofday()</code>, <code>gethrtime()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method trace </dt> <dd><code><code class='datatype'>int</code> trace(<code class='datatype'>int</code> <code class='argument'>level</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>facility</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>all_threads</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function changes the trace level for the subsystem identified by <code>facility</code> to <code>level</code>. If <code>facility</code> is zero or left out, it changes the global trace level which affects all subsystems. Enabling tracing causes messages to be printed to stderr. A higher trace level includes the output from all lower levels. The lowest
autodoc.git/traditional_manual/chapter_21.html:3302: signals. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>alarm()</code>, <code>signal()</code>, <code>call_out()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + unicode_to_string + </dt> + <dd><code><code class='datatype'>string</code> unicode_to_string(<code class='datatype'>string(8bit)</code> <code class='argument'>s</code>, <code class='datatype'>int(0..2)</code>|<code class='datatype'>void</code> <code class='argument'>byteorder</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Converts an UTF16 byte-stream into a string. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> + <dd></dd><dd class='body--doc'>String to convert to UTF16. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>byteorder</code></dt> + <dd></dd><dd class='body--doc'>Default input byte-order. One of: + <table class='box'><tr><td><code><code class='key'>0</code></code></td><td>Network (aka big-endian) byte-order (default). + </td></tr> + <tr><td><code><code class='key'>1</code></code></td><td>Little-endian byte-order. + </td></tr> + <tr><td><code><code class='key'>2</code></code></td><td>Native byte-order. + </td></tr> + </table>Note that this argument is disregarded if <code>s</code> starts with a BOM. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Charset.decoder()</code>, <code>string_to_unicode()</code>, <code>string_to_utf8()</code>, + <code>utf8_to_string()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + upper_case + </dt> + <dd><code><code class='datatype'>string</code> upper_case(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> + <code><code class='datatype'>int</code> upper_case(<code class='datatype'>int</code> <code class='argument'>c</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Convert a string or character to upper case. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns a copy of the string <code>s</code> with all lower case characters + converted to upper case, or the character <code>c</code> converted to upper + case. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Assumes the string or character to be coded according to + ISO-10646 (aka Unicode). If they are not, <code>Charset.decoder</code> can + do the initial conversion for you. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Prior to Pike 7.5 this function only accepted strings. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>lower_case()</code>, <code>Charset.decoder</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + utf8_to_string + </dt> + <dd><code><code class='datatype'>string</code> utf8_to_string(<code class='object unresolved'>utf8_string</code> <code class='argument'>s</code>)</code> + <code><code class='datatype'>string</code> utf8_to_string(<code class='object unresolved'>utf8_string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>extended</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Converts an UTF-8 byte-stream into a string. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> + <dd></dd><dd class='body--doc'>String of UTF-8 encoded data to decode. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>extended</code></dt> + <dd></dd><dd class='body--doc'>Bitmask with extension options. + <table class='box'><tr><td><code><code class='key'>1</code></code></td><td>Accept and decode the extension used by <code>string_to_utf8()</code>. + </td></tr> + <tr><td><code><code class='key'>2</code></code></td><td>Accept and decode UTF-8 encoded UTF-16 (ie accept and + decode valid surrogates). + </td></tr> + </table> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Throws an error if the stream is not a legal UTF-8 byte-stream. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>In conformance with <a href='http://pike.lysator.liu.se/rfc3629.xml'>RFC 3629</a> and Unicode 3.1 and later, + non-shortest forms are not decoded. An error is thrown instead. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Charset.encoder()</code>, <code>string_to_unicode()</code>, <code>string_to_utf8()</code>, + <code>unicode_to_string()</code>, <code>validate_utf8()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + validate_utf8 + </dt> + <dd><code><code class='datatype'>bool</code> validate_utf8(<code class='object unresolved'>utf8_string</code> <code class='argument'>s</code>)</code> + <code><code class='datatype'>bool</code> validate_utf8(<code class='object unresolved'>utf8_string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>extended</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Checks whether a string is a valid UTF-8 byte-stream. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> + <dd></dd><dd class='body--doc'>String of UTF-8 encoded data to validate. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>extended</code></dt> + <dd></dd><dd class='body--doc'>Bitmask with extension options. + <table class='box'><tr><td><code><code class='key'>1</code></code></td><td>Accept the extension used by <code>string_to_utf8()</code>, including + lone UTF-16 surrogates. + </td></tr> + <tr><td><code><code class='key'>2</code></code></td><td>Accept UTF-8 encoded UTF-16 (ie accept valid surrogate-pairs). + </td></tr> + </table> + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <code class='expr'>0</code> (zero) if the stream is not a legal + UTF-8 byte-stream, and <code class='expr'>1</code> if it is. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>In conformance with <a href='http://pike.lysator.liu.se/rfc3629.xml'>RFC 3629</a> and Unicode 3.1 and later, + non-shortest forms are considered invalid. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Charset.encoder()</code>, <code>string_to_unicode()</code>, <code>string_to_utf8()</code>, + <code>unicode_to_string()</code>, <code>utf8_to_string()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method version </dt> <dd><code><code class='datatype'>string</code> version()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Report the version of Pike. Does the same as <pre><code>sprintf("Pike v%d.%d release %d", __REAL_VERSION__, __REAL_MINOR__, __REAL_BUILD__); </code></pre> </dd>
autodoc.git/traditional_manual/chapter_21.html:8203: <dl class='group--doc'> <dt class='head--type'>Method `() </dt> <dd><code><code class='datatype'>void</code> res = <code class='class'>Builtin.Setter()</code>()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Set the variable for the setter to <code>val</code>. This is the function returned by <code>_get_setter()</code>. </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class Builtin.__master</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Used to prototype the master object. + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + _main + </dt> + <dd><code><code class='datatype'>void</code> _main(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>argv</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>env</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + cast_to_object + </dt> + <dd><code><code class='datatype'>object</code> cast_to_object(<code class='datatype'>string</code> <code class='argument'>oname</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + cast_to_program + </dt> + <dd><code><code class='datatype'>program</code> cast_to_program(<code class='datatype'>string</code> <code class='argument'>pname</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + compile_error + </dt> + <dd><code><code class='datatype'>void</code> compile_error(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>int</code> <code class='argument'>line</code>, <code class='datatype'>string</code> <code class='argument'>err</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + compile_warning + </dt> + <dd><code><code class='datatype'>void</code> compile_warning(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>int</code> <code class='argument'>line</code>, <code class='datatype'>string</code> <code class='argument'>warn</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + decode_charset + </dt> + <dd><code><code class='datatype'>string</code> decode_charset(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>string</code> <code class='argument'>charset</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + describe_backtrace + </dt> + <dd><code><code class='datatype'>string</code> describe_backtrace(<code class='datatype'>object</code>|<code class='datatype'>array</code> <code class='argument'>trace</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>line_width</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + handle_error + </dt> + <dd><code><code class='datatype'>void</code> handle_error(<code class='datatype'>array</code>|<code class='datatype'>object</code> <code class='argument'>trace</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + handle_import + </dt> + <dd><code><code class='datatype'>mixed</code> handle_import(<code class='datatype'>string</code> <code class='argument'>what</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + handle_include + </dt> + <dd><code><code class='datatype'>string</code> handle_include(<code class='datatype'>string</code> <code class='argument'>f</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>bool</code> <code class='argument'>local_include</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + handle_inherit + </dt> + <dd><code><code class='datatype'>program</code> handle_inherit(<code class='datatype'>string</code> <code class='argument'>pname</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + read_include + </dt> + <dd><code><code class='datatype'>string</code> read_include(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + resolv + </dt> + <dd><code><code class='datatype'>mixed</code> resolv(<code class='datatype'>string</code> <code class='argument'>identifier</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + werror + </dt> + <dd><code><code class='datatype'>void</code> werror(<code class='datatype'>string</code> <code class='argument'>fmt</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + write + </dt> + <dd><code><code class='datatype'>void</code> write(<code class='datatype'>string</code> <code class='argument'>fmt</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> + </dl> </dd></dl><dl><dt><h2 class='header'>Class Builtin.automap_marker</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This is an internal class used by <code>__automap__()</code>. It may show up during module dumping or in backtraces and the like. It should in normal circumstances never be used directly. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>__automap__()</code>, <code>map()</code>
autodoc.git/traditional_manual/chapter_21.html:15847: <dd class='body--doc'>The total number of strings </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>next_object()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + memory_usage + </dt> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) memory_usage()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Check memory usage. + This function is mostly intended for debugging. It delivers a mapping + with information about how many arrays/mappings/strings etc. there + are currently allocated and how much memory they use. + The entries in the mapping are typically paired, with one + named <code class='expr'>"num_" + SYMBOL + "s"</code> containing a count, + and the other named <code class='expr'>SYMBOL + "_bytes"</code> containing + a best effort approximation of the size in bytes. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Exactly what fields this function returns is version dependant. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>_verify_internals()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method next </dt> <dd><code><code class='datatype'>mixed</code> next(<code class='datatype'>mixed</code> <code class='argument'>x</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Find the next object/array/mapping/multiset/program or string. All objects, arrays, mappings, multisets, programs and strings are stored in linked lists inside Pike. This function returns the next item on the corresponding list. It is mainly meant for debugging the Pike runtime, but can also be used to control memory usage.
autodoc.git/traditional_manual/chapter_21.html:15999: <hr /> <dl class='group--doc'> <dt class='head--type'>Method reset_dmalloc </dt> <dd><code><code class='datatype'>void</code> reset_dmalloc()</code></dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>Only available when compiled with dmalloc. </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + size_object + </dt> + <dd><code><code class='datatype'>int</code> size_object(<code class='datatype'>object</code> <code class='argument'>o</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the aproximate size of the object, in bytes. + This might not work very well for native objects + The function tries to estimate the memory usage of variables + belonging to the object. + It will not, however, include the size of objects assigned to + variables in the object. + If the object has a <code>lfun::_size_object()</code> it will be called + without arguments, and the return value will be added to the final + size. It is primarily intended to be used by C-objects that + allocate memory that is not normally visible to pike. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>lfun::_size_object()</code>, <code>sizeof()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + verify_internals + </dt> + <dd><code><code class='datatype'>void</code> verify_internals()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Perform sanity checks. + This function goes through most of the internal Pike structures and + generates a fatal error if one of them is found to be out of order. + It is only used for debugging. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function does a more thorough check if the Pike runtime has + been compiled with RTL debug. + </dd></dl> <dl><dt><h2 class='header'>Class Debug.Decoder</h2> </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Method create </dt> <dd><code>Debug.Decoder Debug.Decoder(<code class='object unresolved'>Stdio.Buffer</code> <code class='argument'>input</code>)</code></dd> </dl>
autodoc.git/traditional_manual/chapter_21.html:30297: </table> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>gc</code>, <code>Debug.gc_status</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + get_first_arg_type + </dt> + <dd><code><code class='type'>type</code>|<code class='datatype'>zero</code> get_first_arg_type(<code class='type'>type</code> <code class='argument'>fun_type</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Check if a function of the type <code>fun_type</code> may be called + with an argument, and return the type of that argument. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns the expected type of the first argument to the function. + Returns <tt>0</tt> (zero) if a function of the type <code>fun_type</code> + may not be called with any argument, or if it is not callable. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + get_return_type + </dt> + <dd><code><code class='type'>type</code>|<code class='datatype'>zero</code> get_return_type(<code class='type'>type</code> <code class='argument'>fun_type</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Check what a function of the type <code>fun_type</code> will + return if called with no arguments. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns the type of the returned value on success + Returns <tt>0</tt> (zero) on failure. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method get_runtime_info </dt> <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>) get_runtime_info()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get information about the Pike runtime. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns a mapping with the following content: <table class='box'><tr><td><code><code class='key'>"bytecode_method"</code> : <code class='datatype'>string</code></code></td><td>A string describing the bytecode method used by
autodoc.git/traditional_manual/chapter_21.html:30333: </td></tr> <tr><td><code><code class='key'>"auto_bignum"</code> : <code class='datatype'>int(1..1)</code></code></td><td>Integers larger than the native size are now always automatically converted into bignums. </td></tr> </table></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + get_type_attributes + </dt> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) get_type_attributes(<code class='type'>type</code> <code class='argument'>t</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Get the attribute markers for a type. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns an array with the attributes for the type <code>t</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>get_return_type()</code>, <code>get_first_arg_type()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method identify_cycle </dt> <dd><code><code class='datatype'>array</code>(<code class='datatype'>mixed</code>) identify_cycle(<code class='datatype'>mixed</code> <code class='argument'>x</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Identify reference cycles in Pike datastructures. This function is typically used to identify why certain datastructures need the <code>gc</code> to run to be freed. </dd> <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt>
autodoc.git/traditional_manual/chapter_21.html:30376: nanoseconds. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Debug.gc_status</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + low_check_call + </dt> + <dd><code><code class='type'>type</code>|<code class='datatype'>zero</code> low_check_call(<code class='type'>type</code> <code class='argument'>fun_type</code>, <code class='type'>type</code> <code class='argument'>arg_type</code>)</code> + <code><code class='type'>type</code>|<code class='datatype'>zero</code> low_check_call(<code class='type'>type</code> <code class='argument'>fun_type</code>, <code class='type'>type</code> <code class='argument'>arg_type</code>, <code class='datatype'>int</code> <code class='argument'>flags</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Check whether a function of type <code>fun_type</code> may be called + with a first argument of type <code>arg_type</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>flags</code></dt> + <dd></dd><dd class='body--doc'>The following flags are currently defined: + <table class='box'><tr><td><code><code class='key'>1</code></code></td><td>Strict types. Fail if not all possible values in <code>arg_type</code> + are valid as the first argument to <code>fun_type</code>. + </td></tr> + <tr><td><code><code class='key'>2</code></code></td><td>Last argument. <code>arg_type</code> is the last argument to <code>fun_type</code>. + </td></tr> + <tr><td><code><code class='key'>3</code></code></td><td>Both strict types and last argument as above. + </td></tr> + </table> + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns a continuation type on success. + Returns <tt>0</tt> (zero) on failure. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + soft_cast + </dt> + <dd><code><code class='type'>type</code>|<code class='datatype'>zero</code> soft_cast(<code class='type'>type</code> <code class='argument'>to</code>, <code class='type'>type</code> <code class='argument'>from</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the resulting type from a soft cast of <code>from</code> to <code>to</code>. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <code class='expr'>UNDEFINED</code> if the cast is invalid. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The return value for the invalid case may in the future + change to <code class='expr'>__unknown__</code>. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method yield </dt> <dd><code><code class='datatype'>mixed</code> yield(<code class='datatype'>mixed</code> <code class='argument'>val</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Stop execution of the current generator function for now, and return the value <code>val</code>. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Evaluates to the first argument passed to the

autodoc.git / traditional_manual / chapter_21.html