Log of autodoc.git/traditional_manual/chapter

2021-10-20

2021-10-20 16:03:58 by Henrik Grubbström (Grubba) <grubba@grubba.org>

43893ce0bd49c1992b223b587ecc8a35bb1dd9ec (78442 lines) (+6793/-71649) ^{[

Show
| Annotate

]}
Branch: master

Doc [Traditional]: More sections and move around stuff.

1: <!doctype html><html><head><title>Pike Reference Manual</title> <meta charset='utf-8'></head> - <body><dl><dt><h1 class='header'>21. The rest</h1></dt><dd><dl><dt><h2 class='header'>Namespace cpp::</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pike has a builtin C-style preprocessor. It works similar to the - ANSI-C preprocessor but has a few extra features. These and the - default set of preprocessor macros are described here. - The preprocessor is usually accessed via - <code>MasterObject->compile_file()</code> or <code>MasterObject->compile_string()</code>, - but may be accessed directly by calling <code>cpp()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile()</code>, <code>cpp()</code>, <code>CompilerEnvironment.CPP</code> - </dd></dl> + <body><dl><dt><h1 class='header'>21. Cryptography</h1></dt><dd></dd> + <dt><a name='21.1'></a> + <h2 class='header'>21.1. Password hashing</h2></dt> + <dd> <hr /> <dl class='group--doc'> - <dt class='head--type'>Directive - #elifdef - Directive - #elseifdef - </dt> - <dd><code class='directive'>#elifdef</code> - <code class='directive'>#elseifdef</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>These work as a combined <code>#else</code> and <code>#ifdef</code> without - adding an extra level of nesting. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>The following two are equivalent: - <pre><code>#ifdef A - // Code for A. - #else - #ifdef B - // Code for B. - #else - #ifdef C - // Code for C. - #else - // Code for D. - #endif - #endif - #endif</code></pre>And - <pre><code>#ifdef A - // Code for A. - #elifdef B - // Code for B. - #elseifdef C - // Code for C. - #else - // Code for D. - #endif</code></pre> - </pre></dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>#if</code>, <code>#ifdef</code>, <code>#else</code>, <code>defined()</code>, <code>constant()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Directive - #elifndef - Directive - #elseifndef - </dt> - <dd><code class='directive'>#elifndef</code> - <code class='directive'>#elseifndef</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>These work as a combined <code>#else</code> and <code>#ifndef</code> without - adding an extra level of nesting. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>The following two are equivalent: - <pre><code>#ifndef A - // Code for not A. - #else - #ifndef B - // Code for not B. - #else - #ifdef C - // Code for not C. - #else - // Code for ABC. - #endif - #endif - #endif</code></pre>And - <pre><code>#ifndef A - // Code for not A. - #elifndef B - // Code for not B. - #elseifndef C - // Code for not C. - #else - // Code for ABC. - #endif</code></pre> - </pre></dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>#if</code>, <code>#ifdef</code>, <code>#else</code>, <code>defined()</code>, <code>constant()</code> - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Namespace predef::</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This is the default namespace and contains lots of global symbols. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - FUSE_MAJOR_VERSION - Constant - FUSE_MINOR_VERSION - </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>FUSE_MAJOR_VERSION</code></code> - <code><code class='datatype'>constant</code> <code class='constant'>FUSE_MINOR_VERSION</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The version of FUSE - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - HKEY_CLASSES_ROOT - Constant - HKEY_LOCAL_MACHINE - Constant - HKEY_CURRENT_USER - Constant - HKEY_USERS - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>HKEY_CLASSES_ROOT</code></code> - <code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>HKEY_LOCAL_MACHINE</code></code> - <code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>HKEY_CURRENT_USER</code></code> - <code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>HKEY_USERS</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Root handles in the Windows registry. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>These constants are only available on Win32 systems. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>RegGetValue()</code>, <code>RegGetValues()</code>, <code>RegGetKeyNames()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - ProxyFactory + crypt </dt> - <dd><code><code class='datatype'>program</code> ProxyFactory(<code class='datatype'>program</code> <code class='argument'>p</code>)</code></dd> + <dd><code><code class='datatype'>string(46..122)</code> crypt(<code class='datatype'>string(1..255)</code> <code class='argument'>password</code>)</code> + <code><code class='datatype'>bool</code> crypt(<code class='datatype'>string(1..255)</code> <code class='argument'>input_password</code>, <code class='datatype'>string(46..122)</code> <code class='argument'>crypted_password</code>)</code> + <code><code class='datatype'>string(46..122)</code> crypt()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Create a class that acts as a proxy for the specified program. + <dd class='body--doc'>This function crypts and verifies a short string (only the first + 8 characters are significant). + The first syntax crypts the string <code>password</code> into something that + is hopefully hard to decrypt. + The second syntax is used to verify <code>typed_password</code> against + <code>crypted_password</code>, and returns <code class='expr'>1</code> if they match, and + <code class='expr'>0</code> (zero) otherwise. + The third syntax generates a random string and then crypts it, + creating a string useful as a password. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>p</code></dt> - <dd></dd><dd class='body--doc'>Program to generate a proxy for. - The generated class will have the same symbols (public and - private) with the same types as in <code>p</code>, where accesses to - these will proxy the access to the same symbol in the proxied - (aka wrapped) object. With the following exceptions: - <dl class='group--doc'><dt><code class='expr'>protected void create(object(p) obj)</code> - </dt><dd>Initialize the object to act as a proxy for <code class='expr'>obj</code>. - </dd> - <dt><code class='expr'>_sprintf(int c, mapping|void params)</code> - </dt><dd>Special case for <code class='expr'>c</code> == <code class='expr'>'O'</code>, where - it will return <code class='expr'>sprintf("%O(%O)", this_program, obj)</code>, - and otherwise proxy the call. - </dd> - <dt><code class='expr'>void _destruct()</code>/<code class='expr'>void destroy()</code> - </dt><dd>These lfuns will not be present as the act of them - being proxied would likely confuse the proxied object. - </dd> - </dl> - </dd> + <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The same proxy class will be returned if this function - is called with the same program multiple times. + <dd class='body--doc'>Note that strings containing null characters will only be + processed up until the null character. </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - RegGetKeyNames - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) RegGetKeyNames(<code class='datatype'>int</code> <code class='argument'>hkey</code>, <code class='datatype'>string</code> <code class='argument'>key</code>)</code></dd> - + <dl><dt><h2 class='header'>Module Crypto.Password</h2> + </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get a list of value key names from the register. + <dd class='body--doc'>Password handling. + This module handles generation and verification of + password hashes. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>hkey</code></dt> - <dd></dd><dd class='body--doc'>One of the following: - <table class='box'><tr><td><code><code class='key'>HKEY_CLASSES_ROOT</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_LOCAL_MACHINE</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_CURRENT_USER</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_USERS</code></code></td></tr> - </table> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>key</code></dt> - <dd></dd><dd class='body--doc'>A registry key. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns an array of value keys stored at the specified location if any. - Returns <code class='expr'>UNDEFINED</code> on missing <code>key</code>. - Throws errors on other failures. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>> RegGetKeyNames(HKEY_CURRENT_USER, "Keyboard Layout"); - (1) Result: ({ - "IMEtoggle", - "Preload", - "Substitutes", - "Toggle" - }) - </pre></dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is only available on Win32 systems. - </dd> + <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>RegGetValue()</code>, <code>RegGetValues()</code> + <dd class='body--doc'><code>verify()</code>, <code>hash()</code>, <code>crypt()</code> </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - RegGetValue + hash </dt> - <dd><code><code class='datatype'>string</code>|<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) RegGetValue(<code class='datatype'>int</code> <code class='argument'>hkey</code>, <code class='datatype'>string</code> <code class='argument'>key</code>, <code class='datatype'>string</code> <code class='argument'>index</code>)</code></dd> + <dd><code><code class='datatype'>string(7bit)</code> hash(<code class='datatype'>string(8bit)</code> <code class='argument'>password</code>, <code class='datatype'>string(7bit)</code>|<code class='datatype'>void</code> <code class='argument'>scheme</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>void</code> <code class='argument'>rounds</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get a single value from the register. + <dd class='body--doc'>Generate a hash of <code>password</code> suitable for <code>verify()</code>. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>hkey</code></dt> - <dd></dd><dd class='body--doc'>One of the following: - <table class='box'><tr><td><code><code class='key'>HKEY_CLASSES_ROOT</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_LOCAL_MACHINE</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_CURRENT_USER</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_USERS</code></code></td></tr> - </table> + <dt class='head--doc'>Parameter <code class='parameter'>password</code></dt> + <dd></dd><dd class='body--doc'>Password to hash. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>key</code></dt> - <dd></dd><dd class='body--doc'>Registry key. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>index</code></dt> - <dd></dd><dd class='body--doc'>Value name. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the value stored at the specified location in the register - if any. Returns <code class='expr'>UNDEFINED</code> on missing keys, throws errors - on other failures. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is only available on Win32 systems. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>RegGetValues()</code>, <code>RegGetKeyNames()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - RegGetValues - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>|<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>)) RegGetValues(<code class='datatype'>int</code> <code class='argument'>hkey</code>, <code class='datatype'>string</code> <code class='argument'>key</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get multiple values from the register. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>hkey</code></dt> - <dd></dd><dd class='body--doc'>One of the following: - <table class='box'><tr><td><code><code class='key'>HKEY_CLASSES_ROOT</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_LOCAL_MACHINE</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_CURRENT_USER</code></code></td></tr> - <tr><td><code><code class='key'>HKEY_USERS</code></code></td></tr> - </table> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>key</code></dt> - <dd></dd><dd class='body--doc'>Registry key. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns a mapping with all the values stored at the specified location - in the register if any. - Returns <code class='expr'>UNDEFINED</code> on missing <code>key</code>. - Throws errors on other failures. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>> RegGetValues(HKEY_CURRENT_USER, "Keyboard Layout\\Preload"); - (5) Result: ([ - "1":"0000041d" - ]) - </pre></dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is only available on Win32 systems. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>RegGetValue()</code>, <code>RegGetKeyNames()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - TOKENIZE_KEEP_ESCAPES - </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>TOKENIZE_KEEP_ESCAPES</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Don't unquote backslash-sequences in quoted strings during tokenizing. - This is used for bug-compatibility with Microsoft... - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>tokenize()</code>, <code>tokenize_labled()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - UNDEFINED - </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>UNDEFINED</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The undefined value; ie a zero for which <code>zero_type()</code> returns 1. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - _Static_assert - </dt> - <dd><code><code class='datatype'>void</code> _Static_assert(<code class='datatype'>int</code> <code class='argument'>constant_expression</code>, <code class='datatype'>string</code> <code class='argument'>constant_message</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Perform a compile-time assertion check. - If <code>constant_expression</code> is false, a compiler error message - containing <code>constant_message</code> will be generated. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Note that the function call compiles to the null statement, - and thus does not affect the run-time. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>cpp::static_assert</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - __automap__ - </dt> - <dd><code><code class='datatype'>array</code> __automap__(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>fun</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Automap execution function. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>fun</code></dt> - <dd></dd><dd class='body--doc'>Function to call for each of the mapped arguments. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> - <dd></dd><dd class='body--doc'>Arguments for <code>fun</code>. Either - <table class='box'><tr><td><code><code class='object unresolved'>Builtin.automap_marker</code></code></td><td>Wrapper for an array to loop over. All of the - arrays will be looped over in parallel. + <dt class='head--doc'>Parameter <code class='parameter'>scheme</code></dt> + <dd></dd><dd class='body--doc'>Password hashing scheme. If not specified the strongest available + will be used. + If an unsupported scheme is specified an error will be thrown. + Supported schemes are: + Crypt(3C)-style: + <table class='box'><tr><td><code><code class='key'>UNDEFINED</code></code></td><td rowspan='3'>Use the strongest crypt(3C)-style hash that is supported. </td></tr> - <tr><td><code><code class='datatype'>mixed</code></code></td><td>All other arguments will be held constant during - the automap, and sent as is to <code>fun</code>. + <tr><td><code><code class='key'>"crypt"</code></code></td></tr> + <tr><td><code><code class='key'>"{crypt}"</code></code></td></tr> + <tr><td><code><code class='key'>"6"</code></code></td><td rowspan='2'><code>SHA512.crypt_hash()</code> with 96 bits of salt and a default + of <code class='expr'>5000</code> rounds. </td></tr> - </table> - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is used by the compiler to implement the - automap syntax, and should in normal circumstances never - be used directly. - It may however show up during module dumping and in - backtraces. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>It is an error not to have any <code>Builtin.automap_marker</code>s - in <code>args</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Builtin.automap_marker</code>, <code>map()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - __cast - </dt> - <dd><code><code class='datatype'>mixed</code> __cast(<code class='datatype'>mixed</code> <code class='argument'>val</code>, <code class='datatype'>string</code>|<code class='type'>type</code> <code class='argument'>type_name</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Cast <code>val</code> to the type indicated by <code>type_name</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>lfun::cast()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - __empty_program - </dt> - <dd><code><code class='datatype'>program</code> __empty_program(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>line</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>file</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - __handle_sprintf_format - </dt> - <dd><code><code class='type'>type</code> __handle_sprintf_format(<code class='datatype'>string</code> <code class='argument'>attr</code>, <code class='datatype'>string</code> <code class='argument'>fmt</code>, <code class='type'>type</code> <code class='argument'>arg_type</code>, <code class='type'>type</code> <code class='argument'>cont_type</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Type attribute handler for <code class='expr'>"sprintf_format"</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>attr</code></dt> - <dd></dd><dd class='body--doc'>Attribute to handle, either <code class='expr'>"sprintf_format"</code> - or <code class='expr'>"strict_sprintf_format"</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>fmt</code></dt> - <dd></dd><dd class='body--doc'>Sprintf-style formatting string to generate type information from. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>arg_type</code></dt> - <dd></dd><dd class='body--doc'>Declared type of the <code>fmt</code> argument (typically <code class='expr'>string</code>). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>cont_type</code></dt> - <dd></dd><dd class='body--doc'>Continuation function type after the <code>fmt</code> argument. This is - scanned for the type attribute <code class='expr'>"sprintf_args"</code> to - determine where the remaining arguments to <code>sprintf()</code> will - come from. - This function is typically called from - <code>PikeCompiler()->apply_attribute_constant()</code> and is used to perform - stricter compile-time argument checking of <code>sprintf()</code>-style functions. - It currently implements two operating modes depending on the value of - <code>attr</code>: - <table class='box'><tr><td><code><code class='key'>"strict_sprintf_format"</code></code></td><td>The formatting string <code>fmt</code> is known to always be passed to - <code>sprintf()</code>. + <tr><td><code><code class='key'>"$6$"</code></code></td></tr> + <tr><td><code><code class='key'>"5"</code></code></td><td rowspan='2'><code>SHA256.crypt_hash()</code> with 96 bits of salt and a default + of <code class='expr'>5000</code> rounds. </td></tr> - <tr><td><code><code class='key'>"sprintf_format"</code></code></td><td>The formatting string <code>fmt</code> is passed to <code>sprintf()</code> only - if there are <code class='expr'>"sprintf_args"</code>. + <tr><td><code><code class='key'>"$5$"</code></code></td></tr> + <tr><td><code><code class='key'>"3"</code></code></td><td rowspan='2'>The NTLM MD4 hash. </td></tr> - </table> - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns <code>cont_type</code> with <code class='expr'>"sprintf_args"</code> replaced by the - arguments required by the <code>fmt</code> formatting string, and - <code class='expr'>"sprintf_result"</code> replaced by the resulting string type. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>PikeCompiler()->apply_attribute_constant()</code>, <code>sprintf()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - __null_program - </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>__null_program</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Program used internally by the compiler to create objects - 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> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - call_out - Method - _do_call_outs - Method - find_call_out - Method - remove_call_out - Method - call_out_info - </dt> - <dd><code><code class='datatype'>mixed</code> call_out(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>float</code>|<code class='datatype'>int</code> <code class='argument'>delay</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code> - <code><code class='datatype'>void</code> _do_call_outs()</code> - <code><code class='datatype'>int</code> find_call_out(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>)</code> - <code><code class='datatype'>int</code> find_call_out(<code class='datatype'>mixed</code> <code class='argument'>id</code>)</code> - <code><code class='datatype'>int</code> remove_call_out(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>)</code> - <code><code class='datatype'>int</code> remove_call_out(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>id</code>)</code> - <code><code class='datatype'>array</code>(<code class='datatype'>array</code>) call_out_info()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>These are aliases for the corresponding functions in - <code>Pike.DefaultBackend</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Pike.Backend()->call_out()</code>, <code>Pike.Backend()->_do_call_outs()</code>, - <code>Pike.Backend()->find_call_out()</code>, <code>Pike.Backend()->remove_call_out()</code>, - <code>Pike.Backend()->call_out_info()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <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> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - _m_delete - </dt> - <dd><code><code class='datatype'>mixed</code> _m_delete(<code class='datatype'>mixed</code> <code class='argument'>key</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>m_delete callback. - </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'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>random_string</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>random</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get a random entry. - </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'>Variable - _static_modules - </dt> - <dd><code><code class='datatype'>object</code> _static_modules</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This is an object containing the classes for all static - (ie non-dynamic) C-modules. - In a typic Pike with support for dynamic modules the contained - module classes are: - <dl class='group--doc'><dt><code>Builtin</code> - </dt><dt><code>Gmp</code> - </dt><dt><code>_Stdio</code> - </dt><dt><code>_math</code> - </dt><dt><code>_system</code> - </dt></dl>If the Pike binary lacks support for dynamic modules, all C-modules - will show up here. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - abs - </dt> - <dd><code><code class='datatype'>float</code> abs(<code class='datatype'>float</code> <code class='argument'>f</code>)</code> - <code><code class='datatype'>int</code> abs(<code class='datatype'>int</code> <code class='argument'>f</code>)</code> - <code><code class='datatype'>object</code> abs(<code class='datatype'>object</code> <code class='argument'>f</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the absolute value for <code>f</code>. If <code>f</code> is - an object it must implement <code>lfun::`<</code> and - unary <code>lfun::`-</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - acos - </dt> - <dd><code><code class='datatype'>float</code> acos(<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 arcus cosine value for <code>f</code>. - The result will be in radians. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>cos()</code>, <code>asin()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - acosh - </dt> - <dd><code><code class='datatype'>float</code> acosh(<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 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 - < > to quote the included file. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>remove_include_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_module_path - </dt> - <dd><code><code class='datatype'>void</code> add_module_path(<code class='datatype'>string</code> <code class='argument'>path</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>subpath</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a directory to search for modules. - This is the same as the command line option <tt>-M</tt>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>remove_module_path()</code> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>path</code></dt> - <dd></dd><dd class='body--doc'>a string containing a path to search for Pike modules. May be a - directory, or a path to a ZIP archive. If a ZIP archive path is - provided, modules will be loaded from a directory, "modules" within - the ZIP archive (see the subpath argument). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>subpath</code></dt> - <dd></dd><dd class='body--doc'>if path is a ZIP archive, this argument will determine the path within - the archive to be searched. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_program_path - </dt> - <dd><code><code class='datatype'>void</code> add_program_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 programs. - 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> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>sizeof()</code>, <code>mappingp()</code>, <code>mkmapping()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - aggregate_multiset - </dt> - <dd><code><code class='datatype'>multiset</code> aggregate_multiset(<code class='datatype'>mixed</code> ... <code class='argument'>elems</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Construct a multiset with the arguments as indices. The multiset - will not contain any values. This method is most useful when - constructing multisets with <code>map</code> or similar; generally, the - multiset literal syntax is handier: <code class='expr'>(<elem1, elem2, ...>)</code> - With it, it's also possible to construct a multiset with values: - <code class='expr'>(<index1: value1, index2: value2, ...>)</code> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>sizeof()</code>, <code>multisetp()</code>, <code>mkmultiset()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - alarm - </dt> - <dd><code><code class='datatype'>int</code> alarm(<code class='datatype'>int</code> <code class='argument'>seconds</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set an alarm clock for delivery of a signal. - <code>alarm()</code> arranges for a SIGALRM signal to be delivered to the - process in <code>seconds</code> seconds. - If <code>seconds</code> is <code class='expr'>0</code> (zero), no new alarm will be scheduled. - Any previous alarms will in any case be canceled. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the number of seconds remaining until any previously - scheduled alarm was due to be delivered, or zero if there was - no previously scheduled alarm. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is only available on platforms that support - 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> - <dd class='body--doc'><code>sscanf()</code>, <code>`/()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - asin - </dt> - <dd><code><code class='datatype'>float</code> asin(<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 arcus sine value for <code>f</code>. - The result will be in radians. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>sin()</code>, <code>acos()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - asinh - </dt> - <dd><code><code class='datatype'>float</code> asinh(<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 hyperbolic arcus sine value for <code>f</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>sinh()</code>, <code>acosh()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - atan - </dt> - <dd><code><code class='datatype'>float</code> atan(<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 arcus tangent value for <code>f</code>. - The result will be in radians. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>tan()</code>, <code>asin()</code>, <code>acos()</code>, <code>atan2()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - atan2 - </dt> - <dd><code><code class='datatype'>float</code> atan2(<code class='datatype'>float</code> <code class='argument'>f1</code>, <code class='datatype'>float</code> <code class='argument'>f2</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the arcus tangent value for <code>f1</code>/<code>f2</code>, and uses - the signs of <code>f1</code> and <code>f2</code> to determine the quadrant. - The result will be in radians. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>tan()</code>, <code>asin()</code>, <code>acos()</code>, <code>atan()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - atanh - </dt> - <dd><code><code class='datatype'>float</code> atanh(<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 hyperbolic arcus tangent value for <code>f</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>tanh()</code>, <code>asinh()</code>, <code>acosh()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - atexit - </dt> - <dd><code><code class='datatype'>void</code> atexit(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>callback</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function puts the <code>callback</code> in a queue of callbacks to - call when pike exits. The call order is reversed, i.e. callbacks - that have been added earlier are called after <code>callback</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Please note that <code>atexit</code> callbacks are not called if Pike - exits abnormally. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>exit()</code>, <code>_exit()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - atomic_get_set - </dt> - <dd><code><code class='datatype'>mixed</code> atomic_get_set(<code class='datatype'>mapping</code>|<code class='datatype'>object</code> <code class='argument'>map</code>, <code class='datatype'>mixed</code> <code class='argument'>key</code>, <code class='datatype'>mixed</code> <code class='argument'>val</code>)</code> - <code><code class='datatype'>mixed</code> atomic_get_set(<code class='datatype'>array</code> <code class='argument'>arr</code>, <code class='datatype'>int</code> <code class='argument'>index</code>, <code class='datatype'>mixed</code> <code class='argument'>val</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Replace atomically the value for a key in a mapping or array. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>map</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>arr</code></dt> - <dd></dd><dd class='body--doc'>Mapping or array to alter. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>key</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>index</code></dt> - <dd></dd><dd class='body--doc'>Key or index to change the value for. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>val</code></dt> - <dd></dd><dd class='body--doc'>Value to change to. If value is <code>UNDEFINED</code> and <code>map</code> is a mapping - this function function behaves exactly as <code class='expr'>m_delete(map, key)</code>. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the previous value for <code>key</code>. If <code>map</code> is a mapping and - there was no previous value <code>UNDEFINED</code> is returned. - If <code>map</code> is an object <code>lfun::_m_replace()</code> will be called - in it. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>m_delete()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - backtrace - </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>Pike.BacktraceFrame</code>) backtrace(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>flags</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get a description of the current call stack. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>flags</code></dt> - <dd></dd><dd class='body--doc'>A bit mask of flags affecting generation of the backtrace. - Currently a single flag is defined: - <table class='box'><tr><td><code><code class='key'>1</code></code></td><td>Return <code>LiveBacktraceFrame</code>s. This flag causes the frame - objects to track changes (as long as they are in use), and - makes eg local variables for functions available for - inspection or change. - Note that since these values are "live", they may change or - dissapear at any time unless the corresponding thread has - been halted or similar. + <tr><td><code><code class='key'>"NT"</code></code></td></tr> + <tr><td><code><code class='key'>"2"</code></code></td><td rowspan='10'><code>Nettle.bcrypt()</code> with 128 bits of salt and a default + of <code class='expr'>1024</code> rounds. </td></tr> - </table> - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The description is returned as an array with one entry for each call - frame on the stack. - The entries are represented by <code>Pike.BacktraceFrame</code> objects. - The current call frame will be last in the array. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Please note that the frame order may be reversed in a later version - of Pike to accommodate for deferred backtraces. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Note that the arguments reported in the backtrace are the current - values of the variables, and not the ones that were at call-time. - This can be used to hide sensitive information from backtraces - (eg passwords). - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>In old versions of Pike the entries used to be represented - by arrays of the following format: - <table class='box'><tr><td colspan='2'>Array</td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>file</code></code></td><td>A string with the filename if known, else zero. + <tr><td><code><code class='key'>"2a"</code></code></td></tr> + <tr><td><code><code class='key'>"2b"</code></code></td></tr> + <tr><td><code><code class='key'>"2x"</code></code></td></tr> + <tr><td><code><code class='key'>"2y"</code></code></td></tr> + <tr><td><code><code class='key'>"$2$"</code></code></td></tr> + <tr><td><code><code class='key'>"$2a$"</code></code></td></tr> + <tr><td><code><code class='key'>"$2b$"</code></code></td></tr> + <tr><td><code><code class='key'>"$2x$"</code></code></td></tr> + <tr><td><code><code class='key'>"$2y$"</code></code></td></tr> + <tr><td><code><code class='key'>"1"</code></code></td><td rowspan='2'><code>MD5.crypt_hash()</code> with 48 bits of salt and <code class='expr'>1000</code> rounds. </td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>line</code></code></td><td>An integer containing the linenumber if known, else zero. + <tr><td><code><code class='key'>"$1$"</code></code></td></tr> + <tr><td><code><code class='key'>"sha1"</code></code></td><td><code>SHA1.HMAC.crypt_hash()</code> with 48 bits of salt and a default + of <code class='expr'>480000</code> rounds. </td></tr> - <tr><td><code><code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='key'>fun</code></code></td><td>The function that was called at this level. + <tr><td><code><code class='key'>"P"</code></code></td><td rowspan='4'><code>MD5.crypt_php()</code> with 48 bits of salt and a default of + <code class='expr'>1<<19</code> rounds. The specified number of rounds will + be rounded up to the closest power of <code class='expr'>2</code>. </td></tr> - <tr><td><code><code class='datatype'>mixed</code>|<code class='datatype'>void</code> ... <code class='key'>args</code></code></td><td>The arguments that the function was called with. + <tr><td><code><code class='key'>"$P$"</code></code></td></tr> + <tr><td><code><code class='key'>"H"</code></code></td></tr> + <tr><td><code><code class='key'>"$H$"</code></code></td></tr> + <tr><td><code><code class='key'>"U$P$"</code></code></td><td>Same as <code class='expr'>"$P$"</code>, the supplied <code>password</code> is assumed to + have already been passed through <code>MD5.hash()</code> once. Typically + used to upgrade unsalted <code>MD5</code>-password databases. </td></tr> - </table>The above format is still supported by eg <code>describe_backtrace()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>catch()</code>, <code>throw()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - basetype - </dt> - <dd><code><code class='datatype'>string</code> basetype(<code class='datatype'>mixed</code> <code class='argument'>x</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Same as sprintf("%t",x); - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>sprintf()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - bkey - </dt> - <dd><code><code class='datatype'>string</code> bkey(<code class='datatype'>mixed</code> <code class='argument'>key</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Render the internally used binary representation of - the key into a string as a strings of '0's and '1's. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - cast - </dt> - <dd><code><code class='datatype'>mapping</code> cast(<code class='datatype'>string</code> <code class='argument'>type</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Cast callback. Supports only cast to mapping and - behaves as the inverse of create(). - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - ceil - </dt> - <dd><code><code class='datatype'>float</code> ceil(<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 greater or equal to <code>f</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'><code>ceil()</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>round()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - column - </dt> - <dd><code><code class='datatype'>array</code> column(<code class='datatype'>array</code> <code class='argument'>data</code>, <code class='datatype'>mixed</code> <code class='argument'>index</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Extract a column from a two-dimensional array. - This function is exactly equivalent to: - <pre><code>map(data, lambda(mixed x,mixed y) { return x[y]; }, index) - </code></pre>Except of course it is a lot shorter and faster. - That is, it indices every index in the array data on the value of - the argument index and returns an array with the results. - </dd> - <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> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Compile the Pike code contained in the file <code>filename</code> into a program. - This function will compile the file <code>filename</code> to a Pike program that can - later be instantiated. It is the same as doing - <code class='expr'><code>compile_string</code>(<code>Stdio.read_file</code>(<code>filename</code>), <code>filename</code>)</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile()</code>, <code>compile_string()</code>, <code>cpp()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - compile_string - </dt> - <dd><code><code class='datatype'>program</code> compile_string(<code class='datatype'>string</code> <code class='argument'>source</code>, <code class='datatype'>void</code>|<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 class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>_show_if_constant_errors</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Compile the Pike code in the string <code>source</code> into a program. - If <code>filename</code> is not specified, it will default to <code class='expr'>"-"</code>. - 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> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - cosh - </dt> - <dd><code><code class='datatype'>float</code> cosh(<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 hyperbolic cosine value for <code>f</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>acosh()</code>, <code>sinh()</code>, <code>tanh()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - cpp - </dt> - <dd><code><code class='datatype'>string</code> cpp(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>mapping</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>charset</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>compat_major</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>compat_minor</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>picky_cpp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Run a string through the preprocessor. - Preprocesses the string <code>data</code> with Pike's builtin ANSI-C look-alike - preprocessor. If the <code>current_file</code> argument has not been specified, - it will default to <code class='expr'>"-"</code>. <code>charset</code> defaults to <code class='expr'>"ISO-10646"</code>. - If the second argument is a mapping, no other arguments may follow. - Instead, they have to be given as members of the mapping (if wanted). - The following members are recognized: - <table class='box'><tr><td><code><code class='key'>"current_file"</code> : <code class='datatype'>string</code></code></td><td>Name of the current file. It is used for generating - #line directives and for locating include files. + <tr><td><code><code class='key'>"Q"</code></code></td><td rowspan='2'>Same as <code class='expr'>"$P$"</code>, but with <code>SHA1.crypt_php()</code>. </td></tr> - <tr><td><code><code class='key'>"charset"</code> : <code class='datatype'>int</code>|<code class='datatype'>string</code></code></td><td>Charset to use when processing <code class='expr'>data</code>. + <tr><td><code><code class='key'>"$Q$"</code></code></td></tr> + <tr><td><code><code class='key'>"S"</code></code></td><td rowspan='2'>Same as <code class='expr'>"$S$"</code>, but with <code>SHA512.crypt_php()</code>. </td></tr> - <tr><td><code><code class='key'>"handler"</code> : <code class='datatype'>object</code></code></td><td>Compilation handler. + <tr><td><code><code class='key'>"$S$"</code></code></td></tr> + <tr><td><code><code class='key'>"pbkdf2"</code></code></td><td rowspan='2'><code>SHA1.pbkdf2()</code>. </td></tr> - <tr><td><code><code class='key'>"compat_major"</code> : <code class='datatype'>int</code></code></td><td>Sets the major pike version used for compat handling. + <tr><td><code><code class='key'>"$pbkdf2$"</code></code></td></tr> + <tr><td><code><code class='key'>"pbkdf2-sha256"</code></code></td><td rowspan='2'><code>SHA256.pbkdf2()</code>. </td></tr> - <tr><td><code><code class='key'>"compat_minor"</code> : <code class='datatype'>int</code></code></td><td>Sets the minor pike version used for compat handling. + <tr><td><code><code class='key'>"$pbkdf2-sha256$"</code></code></td></tr> + <tr><td><code><code class='key'>"pbkdf2-sha512"</code></code></td><td rowspan='2'><code>SHA512.pbkdf2()</code>. </td></tr> - <tr><td><code><code class='key'>"picky_cpp"</code> : <code class='datatype'>int</code></code></td><td>Generate more warnings. + <tr><td><code><code class='key'>"$pbkdf2-sha512$"</code></code></td></tr> + <tr><td><code><code class='key'>""</code></code></td><td><code>predef::crypt()</code> with 12 bits of salt. </td></tr> - <tr><td><code><code class='key'>"keep_comments"</code> : <code class='datatype'>int</code></code></td><td>This option keeps <code>cpp()</code> from removing comments. - Useful in combination with the prefix feature below. + </table>LDAP (<a href='http://pike.lysator.liu.se/rfc2307.xml'>RFC 2307</a>)-style. Don't use these if you can avoid it, + since they are suspectible to attacks. In particular avoid + the unsalted variants at all costs: + <table class='box'><tr><td><code><code class='key'>"ssha"</code></code></td><td rowspan='2'><code>SHA1.hash()</code> with 96 bits of salt appended to the password. </td></tr> - <tr><td><code><code class='key'>"prefix"</code> : <code class='datatype'>string</code></code></td><td>If a prefix is given, only prefixed directives will be - processed. For example, if the prefix is <code class='expr'>"foo"</code>, then - <code class='expr'>#foo_ifdef COND</code> and <code class='expr'>foo___LINE__</code> would be - processed, <code class='expr'>#ifdef COND</code> and <code class='expr'>__LINE__</code> would not. + <tr><td><code><code class='key'>"{ssha}"</code></code></td></tr> + <tr><td><code><code class='key'>"smd5"</code></code></td><td rowspan='2'><code>MD5.hash()</code> with 96 bits of salt appended to the password. </td></tr> - <tr><td><code><code class='key'>"predefines"</code> : <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>)</code></td><td>Mapping of predefined macros in addition to those - returned by <code>CPP()->get_predefines()</code>. + <tr><td><code><code class='key'>"{smd5}"</code></code></td></tr> + <tr><td><code><code class='key'>"sha"</code></code></td><td rowspan='2'><code>SHA1.hash()</code> without any salt. </td></tr> - </table> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - cpp - </dt> - <dd><code><code class='modifier'>protected</code> <code class='datatype'>string</code> cpp(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>mapping</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>charset</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>compat_major</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>compat_minor</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>picky_cpp</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - ctime - </dt> - <dd><code><code class='datatype'>string</code> ctime(<code class='datatype'>int</code> <code class='argument'>timestamp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Convert the output from a previous call to <code>time()</code> into a readable - string containing the current year, month, day and time. - Like <code>localtime</code>, this function might throw an error if the - ctime(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'>See also</dt> - <dd class='body--doc'><code>strftime()</code>, <code>time()</code>, <code>localtime()</code>, <code>gmtime()</code>, <code>mktime()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - decode_value - </dt> - <dd><code><code class='datatype'>mixed</code> decode_value(<code class='datatype'>string</code> <code class='argument'>coded_value</code>, <code class='datatype'>void</code>|<code class='object unresolved'>Codec</code>|<code class='datatype'>int(-1..-1)</code> <code class='argument'>codec</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Decode a value from the string <code>coded_value</code>. - This function takes a string created with <code>encode_value()</code> or - <code>encode_value_canonic()</code> and converts it back to the value that was - coded. - If <code>codec</code> is specified, it's used as the codec for the decode. - If none is specified, then one is instantiated through - <code class='expr'>master()->Decoder()</code>. As a compatibility fallback, the - master itself is used if it has no <code class='expr'>Decoder</code> class. - If <code>codec</code> is the special value <code class='expr'>-1</code>, then decoding of - types, functions, programs and objects is disabled. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Decoding a <code>coded_value</code> that you have not generated yourself - is a security risk that can lead to execution of arbitrary - 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 /> - <dl class='group--doc'> - <dt class='head--type'>Method - describe_backtrace - </dt> - <dd><code><code class='datatype'>string</code> describe_backtrace(<code class='datatype'>mixed</code> <code class='argument'>trace</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>linewidth</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return a readable message that describes where the backtrace - <code>trace</code> was made (by <code>backtrace</code>). - It may also be an error object or array (typically caught by a - <code>catch</code>), in which case the error message also is included in the - description. - Pass <code>linewidth</code> -1 to disable wrapping of the output. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>backtrace()</code>, <code>describe_error()</code>, <code>catch()</code>, <code>throw()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - describe_error - </dt> - <dd><code><code class='datatype'>string</code> describe_error(<code class='datatype'>mixed</code> <code class='argument'>err</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the error message from an error object or array (typically - caught by a <code>catch</code>). The type of the error is checked, hence - <code>err</code> is declared as <code class='expr'>mixed</code> and not <code class='expr'>object|array</code>. - If an error message couldn't be obtained, a fallback message - describing the failure is returned. No errors due to incorrectness - 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. - Almost any value can be coded, mappings, floats, arrays, circular - structures etc. - If <code>codec</code> is specified, it's used as the codec for the encode. - If none is specified, then one is instantiated through - <code class='expr'>master()->Encoder()</code>. As a compatibility fallback, the - master itself is used if it has no <code class='expr'>Encoder</code> class. - If <code class='expr'><code>codec</code>->nameof(o)</code> returns <tt>UNDEFINED</tt> for an - object, <code class='expr'>val = o->encode_object(o)</code> will be called. The - returned value will be passed to <code class='expr'>o->decode_object(o, val)</code> - when the object is decoded. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>When only simple types like int, floats, strings, mappings, - multisets and arrays are encoded, the produced string is very - portable between pike versions. It can at least be read by any - later version. - The portability when objects, programs and functions are involved - depends mostly on the codec. If the byte code is encoded, i.e. - when Pike programs are actually dumped in full, then the string - can probably only be read by the same pike version. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>decode_value()</code>, <code>sprintf()</code>, <code>encode_value_canonic()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - encode_value_canonic - </dt> - <dd><code><code class='datatype'>string</code> encode_value_canonic(<code class='datatype'>mixed</code> <code class='argument'>value</code>, <code class='datatype'>object</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 on canonical form. - Takes a value and converts it to a string on canonical form, much like - <code>encode_value()</code>. The canonical form means that if an identical value is - encoded, it will produce exactly the same string again, even if it's - done at a later time and/or in another Pike process. The produced - string is compatible with <code>decode_value()</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Note that this function is more restrictive than <code>encode_value()</code> with - respect to the types of values it can encode. It will throw an error - 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>. + <tr><td><code><code class='key'>"{sha}"</code></code></td></tr> + <tr><td><code><code class='key'>"md5"</code></code></td><td rowspan='2'><code>MD5.hash()</code> without any salt. </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> + <tr><td><code><code class='key'>"{md5}"</code></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> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - is_gssapi_error - Constant - error_type - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>is_gssapi_error</code></code> - <code><code class='datatype'>constant</code> <code class='datatype'>string</code> <code class='constant'>error_type</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Object recognition constants. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - is_gssapi_missing_services_error - Constant - error_type - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>is_gssapi_missing_services_error</code></code> - <code><code class='datatype'>constant</code> <code class='datatype'>string</code> <code class='constant'>error_type</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Object recognition constants. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - exece - </dt> - <dd><code><code class='datatype'>int</code> exece(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>args</code>)</code> - <code><code class='datatype'>int</code> exece(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>args</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>env</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function transforms the Pike process into a process running - the program specified in the argument <code>file</code> with the arguments <code>args</code>. - If the mapping <code>env</code> is present, it will completely replace all - environment variables before the new program is executed. + <dt class='head--doc'>Parameter <code class='parameter'>rounds</code></dt> + <dd></dd><dd class='body--doc'>The number of rounds to use in parameterized schemes. If not + specified the scheme specific default will be used. </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>This function only returns if something went wrong during <tt>exece(2)</tt>, - and in that case it returns <code class='expr'>0</code> (zero). + <dd class='body--doc'>Returns a string suitable for <code>verify()</code>. This means that + the hashes will be prepended with the suitable markers. </dd> <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The Pike driver _dies_ when this function is called. You must either - use <code>fork()</code> or <code>Process.create_process()</code> if you wish to execute a - program and still run the Pike runtime. - This function is not available on all platforms. + <dd class='body--doc'>Note that the availability of <code>SHA512</code> depends on the version + of <code>Nettle</code> that Pike has been compiled with. </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 class='body--doc'>This function was added in Pike 7.8.755. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>map()</code>, <code>foreach()</code> + <dd class='body--doc'><code>verify()</code>, <code>predef::crypt()</code>, <code>Nettle.crypt_md5()</code>, + <code>Nettle.Hash()->crypt_hash()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - floor + verify </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> + <dd><code><code class='datatype'>int</code> verify(<code class='datatype'>string(8bit)</code> <code class='argument'>password</code>, <code class='datatype'>string(7bit)</code> <code class='argument'>hash</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>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>ceil()</code>, <code>round()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - fork - </dt> - <dd><code><code class='datatype'>object</code> fork()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Fork the process in two. - Fork splits the process in two, and for the parent it returns a - pid object for the child. Refer to your Unix manual for further - details. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function can cause endless bugs if used without proper care. - This function is disabled when using threads. - This function is not available on all platforms. - The most common use for fork is to start sub programs, which is - 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> - <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_compilation_handler()</code>, <code>compile()</code>, <code>CompilationHandler</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_all_groups - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>))) get_all_groups()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns an array of arrays with all groups in the system groups source. - Each element in the returned array has the same structure as in - <code>getgrent</code> function. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The groups source is system dependant. Refer to your system manuals for information - about how to set the source. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><table class='box'><tr><td colspan='2'>Array</td></tr> - <tr><td><code><code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>)) <code class='key'>0..</code></code></td><td>Array with info about the group + <dd class='body--doc'>Verify a password against a hash. + This function attempts to support most common + password hashing schemes. The <code>hash</code> can be on any + of the following formats. + LDAP-style (<a href='http://pike.lysator.liu.se/rfc2307.xml'>RFC 2307</a>) hashes: + <table class='box'><tr><td><code><code class='key'>"{SHA}XXXXXXXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The <code class='expr'>XXX</code> string is taken to be a <code>MIME.encode_base64</code> + <code>SHA1</code> hash of the password. Source: OpenLDAP FAQ + <a href='http://www.openldap.org/faq/data/cache/347.html'>http://www.openldap.org/faq/data/cache/347.html</a>. </td></tr> - </table> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>getgrent()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_all_users - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>)) get_all_users()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns an array with all users in the system. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>An array with arrays of userinfo as in <code>getpwent</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>getpwent()</code> - <code>getpwnam()</code> - <code>getpwuid()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_backtrace - </dt> - <dd><code><code class='datatype'>array</code> get_backtrace(<code class='datatype'>object</code>|<code class='datatype'>array</code> <code class='argument'>err</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the backtrace array from an error object or array - (typically caught by a <code>catch</code>), or zero if there is none. Errors - are thrown on if there are problems retrieving the backtrace. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>describe_backtrace()</code>, <code>describe_error()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_groups_for_user - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) get_groups_for_user(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>user</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Gets all groups which a given user is a member of. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>user</code></dt> - <dd></dd><dd class='body--doc'>UID or loginname of the user - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><table class='box'><tr><td colspan='2'>Array</td></tr> - <tr><td><code><code class='datatype'>array</code> <code class='key'>0..</code></code></td><td>Information about all the users groups + <tr><td><code><code class='key'>"{SSHA}XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The <code class='expr'>XXX</code> string is taken to be a <code>MIME.encode_base64</code> + string in which the first 20 chars are an <code>SHA1</code> hash and the + remaining chars the salt. The input for the hash is the password + concatenated with the salt. Source: OpenLDAP FAQ + <a href='http://www.openldap.org/faq/data/cache/347.html'>http://www.openldap.org/faq/data/cache/347.html</a>. </td></tr> - </table> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_all_groups()</code> - <code>getgrgid()</code> - <code>getgrnam()</code> - <code>getpwuid()</code> - <code>getpwnam()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_iterator - </dt> - <dd><code><code class='object unresolved'>Iterator</code> get_iterator(<code class='datatype'>object</code>|<code class='datatype'>array</code>|<code class='datatype'>mapping</code>|<code class='datatype'>multiset</code>|<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates and returns a canonical iterator for <code>data</code>. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><code>data</code> can have any of the following types: <table class='box'><tr><td><code><code class='datatype'>object</code></code></td><td>If <code>data</code> is an object with <code>lfun::_get_iterator</code> defined then - it's called in it with the arguments <code>args</code> to create the iterator. - If <code>data</code> is an object that lacks <code>lfun::_get_iterator</code> then - it's assumed to already be an iterator object, and is simply - returned. + <tr><td><code><code class='key'>"{MD5}XXXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The <code class='expr'>XXX</code> string is taken to be a <code>MIME.encode_base64</code> <code>MD5</code> + hash of the password. Source: OpenLDAP FAQ + <a href='http://www.openldap.org/faq/data/cache/418.html'>http://www.openldap.org/faq/data/cache/418.html</a>. </td></tr> - <tr><td><code><code class='datatype'>array</code></code></td><td>If <code>data</code> is an array, an <code>Array.Iterator</code> object will be - returned. + <tr><td><code><code class='key'>"{SMD5}XXXXXXXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The <code class='expr'>XXX</code> string is taken to be a <code>MIME.encode_base64</code> + string in which the first 16 chars are an <code>MD5</code> hash and the + remaining chars the salt. The input for the hash is the password + concatenated with the salt. Source: OpenLDAP FAQ + <a href='http://www.openldap.org/faq/data/cache/418.html'>http://www.openldap.org/faq/data/cache/418.html</a>. </td></tr> - <tr><td><code><code class='datatype'>mapping</code></code></td><td>If <code>data</code> is a mapping, a <code>Mapping.Iterator</code> object will be - returned + <tr><td><code><code class='key'>"{CRYPT}XXXXXXXXXXXXX"</code></code></td><td>The <code class='expr'>XX</code> string is taken to be a crypt(3C)-style hash. + This is the same thing as passing the <code class='expr'>XXX</code> string without + any preceding method name within <code class='expr'>{...}</code>. I.e. it's + interpreted according to the crypt-style hashes below. </td></tr> - <tr><td><code><code class='datatype'>multiset</code></code></td><td>If <code>data</code> is a multiset, a <code>Multiset.Iterator</code> object will be - returned + </table>Crypt-style hashes: + <table class='box'><tr><td><code><code class='key'>"$6$SSSSSSSSSSSSSSSS$XXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The string is interpreted according to the + "Unix crypt using SHA-256 and SHA-512" standard + Version 0.4 2008-4-3, where <code class='expr'>SSSSSSSSSSSSSSSS</code> + is up to 16 characters of salt, and the string <code class='expr'>XXX</code> + the result of <code>SHA512.crypt_hash()</code> with <code class='expr'>5000</code> + rounds. Source: Unix crypt using SHA-256 and SHA-512 + <a href='http://www.akkadia.org/drepper/SHA-crypt.txt'>http://www.akkadia.org/drepper/SHA-crypt.txt</a> </td></tr> - <tr><td><code><code class='datatype'>string</code></code></td><td>If <code>data</code> is a string, a <code>String.Iterator</code> object will be - returned + <tr><td><code><code class='key'>"$6$rounds=RR$SSSSSSSSSSSSSSSS$XXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>This is the same algorithm as the one above, but with the + number of rounds specified by <code class='expr'>RR</code> in decimal. Note + that the number of rounds is clamped to be within + <code class='expr'>1000</code> and <code class='expr'>999999999</code> (inclusive). + Source: Unix crypt using SHA-256 and SHA-512 + <a href='http://www.akkadia.org/drepper/SHA-crypt.txt'>http://www.akkadia.org/drepper/SHA-crypt.txt</a> </td></tr> - </table> - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is used by <code>foreach</code> to get an iterator for an - object. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Iterator</code>, <code>lfun::_get_iterator</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getenv - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) getenv(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>force_update</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Queries the environment variables. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>force_update</code></dt> - <dd></dd><dd class='body--doc'>A cached copy of the real environment is kept to make this - function quicker. If the optional flag <code>force_update</code> is nonzero - then the real environment is queried and the cache is updated from - it. That can be necessary if the environment changes through other - means than <code>putenv</code>, typically from a C-level library. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the whole environment as a mapping. Destructive - operations on the mapping will not affect the internal - environment representation. - Variable names and values cannot be wide strings nor contain - <code class='expr'>'\0'</code> characters. Variable names also cannot contain - <code class='expr'>'='</code> characters. - </dd> - <dt class='head--doc'>Note</dt> - <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>putenv()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getenv - </dt> - <dd><code><code class='datatype'>string</code> getenv(<code class='datatype'>string</code> <code class='argument'>varname</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>force_update</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Query the value of a specific environment variable. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>varname</code></dt> - <dd></dd><dd class='body--doc'>Environment variable to query. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>force_update</code></dt> - <dd></dd><dd class='body--doc'>A cached copy of the real environment is kept to make this - function quicker. If the optional flag <code>force_update</code> is nonzero - then the real environment is queried and the cache is updated from - it. That can be necessary if the environment changes through other - means than <code>putenv</code>, typically from a C-level library. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the value of the environment variable <code>varname</code> - if it exists, and <code class='expr'>0</code> (zero) otherwise. - Variable names and values cannot be wide strings nor contain - <code class='expr'>'\0'</code> characters. Variable names also cannot contain - <code class='expr'>'='</code> characters. - </dd> - <dt class='head--doc'>Note</dt> - <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>putenv()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getgrgid - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>)) getgrgid(<code class='datatype'>int</code> <code class='argument'>gid</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get the group entry for the group with the id <code>gid</code> using the systemfunction - <tt>getgrid(3)</tt>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>gid</code></dt> - <dd></dd><dd class='body--doc'>The id of the group - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>An array with the information about the group - <table class='box'><tr><td colspan='2'>Array</td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>0</code></code></td><td>Group name + <tr><td><code><code class='key'>"$5$SSSSSSSSSSSSSSSS$XXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The string is interpreted according to the + "Unix crypt using SHA-256 and SHA-512" standard + Version 0.4 2008-4-3, where <code class='expr'>SSSSSSSSSSSSSSSS</code> + is up to 16 characters of salt, and the string <code class='expr'>XXX</code> + the result of <code>SHA256.crypt_hash()</code> with <code class='expr'>5000</code> + rounds. Source: Unix crypt using SHA-256 and SHA-512 + <a href='http://www.akkadia.org/drepper/SHA-crypt.txt'>http://www.akkadia.org/drepper/SHA-crypt.txt</a> </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>1</code></code></td><td>Group password (encrypted) + <tr><td><code><code class='key'>"$5$rounds=RR$SSSSSSSSSSSSSSSS$XXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>This is the same algorithm as the one above, but with the + number of rounds specified by <code class='expr'>RR</code> in decimal. Note + that the number of rounds is clamped to be within + <code class='expr'>1000</code> and <code class='expr'>999999999</code> (inclusive). + Source: Unix crypt using SHA-256 and SHA-512 + <a href='http://www.akkadia.org/drepper/SHA-crypt.txt'>http://www.akkadia.org/drepper/SHA-crypt.txt</a> </td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>2</code></code></td><td>ID of the group + <tr><td><code><code class='key'>"$3$$XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>This is interpreted as the NT LANMANAGER (NTLM) password + hash. It is a hex representation of MD4 of the password. </td></tr> - <tr><td><code><code class='datatype'>array</code> <code class='key'>3..</code></code></td><td>Array with UIDs of group members + <tr><td><code><code class='key'>"$1$SSSSSSSS$XXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The string is interpreted according to the GNU libc2 extension + of <code class='expr'>crypt(3C)</code> where <code class='expr'>SSSSSSSS</code> is up to 8 chars of + salt and the <code class='expr'>XXX</code> string is an <code>MD5</code>-based hash created + from the password and the salt. Source: GNU libc + <a href='http://www.gnu.org/software/libtool/manual/libc/crypt.html'>http://www.gnu.org/software/libtool/manual/libc/crypt.html</a>. </td></tr> - </table> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>getgrent()</code> - <code>getgrnam()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getgrnam - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>)) getgrnam(<code class='datatype'>string</code> <code class='argument'>str</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get the group entry for the group with the name <code>str</code> using the - systemfunction <tt>getgrnam(3)</tt>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>str</code></dt> - <dd></dd><dd class='body--doc'>The name of the group - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>An array with the information about the group - <table class='box'><tr><td colspan='2'>Array</td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>0</code></code></td><td>Group name + <tr><td><code><code class='key'>"$sha1$RRRRR$SSSSSSSS$XXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The string is interpreted as a NetBSD-style <code>SHA1.HMAC.crypt_hash()</code> + (aka <tt>crypt_sha1(3C)</tt>), + where <code class='expr'>RRRRR</code> is the number of rounds (default 480000), + <code class='expr'>SSSSSSSS</code> is a <code>MIME.crypt64()</code> encoded salt. and the + <code class='expr'>XXX</code> string is an <code>SHA1.HMAC</code>-based hash created from + the password and the salt. </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>1</code></code></td><td>Group password (encrypted) + <tr><td><code><code class='key'>"$P$RSSSSSSSSXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The string is interpreted as a PHPass' Portable Hash password hash, + where <code class='expr'>R</code> is an encoding of the 2-logarithm of the number of + rounds, <code class='expr'>SSSSSSSS</code> is a salt of 8 characters, and + <code class='expr'>XXX</code> is similarily the <code>MIME.encode_crypt64</code> of running + <code>MD5.hash()</code> repeatedly on the password and the salt. </td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>2</code></code></td><td>ID of the group + <tr><td><code><code class='key'>"$H$RSSSSSSSS.XXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>Same as <code class='expr'>"$P$"</code> above. Used by phpBB3. </td></tr> - <tr><td><code><code class='datatype'>array</code> <code class='key'>3..</code></code></td><td>Array with UIDs of group members + <tr><td><code><code class='key'>"U$P$RSSSSSSSSXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>This is handled as a Drupal upgraded PHPass Portable Hash password. + The password is run once through <code>MD5.hash()</code>, and then passed + along to the <code class='expr'>"$P$"</code>-handler above. </td></tr> - </table> - </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> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getpwnam - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>) getpwnam(<code class='datatype'>string</code> <code class='argument'>str</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get the user entry for login <code>str</code> using the systemfunction <tt>getpwnam(3)</tt>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>str</code></dt> - <dd></dd><dd class='body--doc'>The login name of the user whos userrecord is requested. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>An array with the information about the user - <table class='box'><tr><td colspan='2'>Array</td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>0</code></code></td><td>Users username (loginname) + <tr><td><code><code class='key'>"$Q$RSSSSSSSSXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The string is interpreted as a PHPass' Portable Hash password hash, + where the base hashing alorithm has been switched to <code>SHA1</code>. + This method is apparently used by some versions of Escher CMS. </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>1</code></code></td><td>User password (encrypted) + <tr><td><code><code class='key'>"$S$RSSSSSSSSXXXXXXXXXXXXXXXXXXXXXX"</code></code></td><td>The string is interpreted as a PHPass' Portable Hash password hash, + where the base hashing alorithm has been switched to <code>SHA256</code>. + This method is apparently used by some versions of Drupal. </td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>2</code></code></td><td>Users ID + <tr><td><code><code class='key'>"XXXXXXXXXXXXX"</code></code></td><td>The <code class='expr'>XXX</code> string (which doesn't begin with <code class='expr'>"{"</code>) is + taken to be a password hashed using the classic unix + <code class='expr'>crypt(3C)</code> function. If the string contains only chars + from the set <code class='expr'>[a-zA-Z0-9./]</code> it uses DES and the first two + characters as salt, but other alternatives may be possible + depending on the <code class='expr'>crypt(3C)</code> implementation in the + operating system. </td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>3</code></code></td><td>Users primary group ID + <tr><td><code><code class='key'>""</code></code></td><td>The empty password hash matches all passwords. </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>4</code></code></td><td>Users real name an possibly some other info - </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>5</code></code></td><td>Users home directory - </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>6</code></code></td><td>Users shell - </td></tr> + </table> </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>getpwuid()</code> - <code>getpwent()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getpwuid - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>) getpwuid(<code class='datatype'>int</code> <code class='argument'>uid</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get the user entry for UID <code>uid</code> using the systemfunction <tt>getpwuid(3)</tt>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>uid</code></dt> - <dd></dd><dd class='body--doc'>The uid of the user whos userrecord is requested. - </dd> + <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>An array with the information about the user - <table class='box'><tr><td colspan='2'>Array</td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>0</code></code></td><td>Users username (loginname) - </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>1</code></code></td><td>User password (encrypted) - </td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>2</code></code></td><td>Users ID - </td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>3</code></code></td><td>Users primary group ID - </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>4</code></code></td><td>Users real name an possibly some other info - </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>5</code></code></td><td>Users home directory - </td></tr> - <tr><td><code><code class='datatype'>string</code> <code class='key'>6</code></code></td><td>Users shell - </td></tr> - </table> + <dd class='body--doc'>Returns <code class='expr'>1</code> on success, and <code class='expr'>0</code> (zero) otherwise. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>getpwnam()</code> - <code>getpwent()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getxattr - </dt> - <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 class='body--doc'>This function was added in Pike 7.8.755. </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 class='body--doc'><code>hash()</code>, <code>predef::crypt()</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> - + </dd></dl></dd> + <dt><a name='21.2'></a> + <h2 class='header'>21.2. Kerberos and GSSAPI</h2></dt> + <dd><dl><dt><h2 class='header'>Module GSSAPI</h2> + </dt><dd><dl class='group--doc'> <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 class='body--doc'>This is pike glue for GSS-API ver 2 as specified in <a href='http://pike.lysator.liu.se/rfc2743.xml'>RFC 2743</a>. + GSS-API is used to authenticate users and servers, and optionally + also to encrypt communication between them. The API is generic and + can be used without any knowledge of the actual implementation of + these security services, which is typically provided by the + operating system. + The most common implementation at the time of writing is Kerberos, + which means that the main benefit of this API is to allow clients + and servers to authenticate each other using Kerberos, thereby + making single sign-on possible in a Kerberized environment. + All functions in this module that wrap GSS-API routines may throw + <code>GSSAPI.Error</code>, and by default they do so for all such errors. Only in + some special cases do they return when a GSS-API error has happened, + and this is then noted in the documentation. </dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - has_suffix + <dt class='head--type'>Constant + INITIATE + Constant + ACCEPT + Constant + BOTH </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> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>INITIATE</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>ACCEPT</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>BOTH</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 class='body--doc'>Flags for indicating how a <code>GSSAPI.Cred</code> object may be used: + <dl class='group--doc'><dt>INITIATE</dt> + <dd>The credential can only be used to initiate security contexts + (i.e. using <code>GSSAPI.InitContext</code>). </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>. + <dt>ACCEPT</dt> + <dd>The credential can only be used to accept security contexts + (i.e. using <code>GSSAPI.AcceptContext</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> + <dt>BOTH</dt> + <dd>The credential may be used both to initiate or accept security + contexts. </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> + </dl></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> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Constant - is_sql_null + DELEG_FLAG + Constant + MUTUAL_FLAG + Constant + REPLAY_FLAG + Constant + SEQUENCE_FLAG + Constant + CONF_FLAG + Constant + INTEG_FLAG + Constant + ANON_FLAG + Constant + PROT_READY_FLAG + Constant + TRANS_FLAG </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>is_sql_null</code></code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>DELEG_FLAG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>MUTUAL_FLAG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>REPLAY_FLAG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>SEQUENCE_FLAG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>CONF_FLAG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>INTEG_FLAG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>ANON_FLAG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>PROT_READY_FLAG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>TRANS_FLAG</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>SQL Null marker. + <dd class='body--doc'>Bitfield flags returned by e.g. <code>GSSAPI.Context.services</code> to + denote various services that are available in the context. + Brief descriptions of the flags: + <dl class='group--doc'><dt>GSSAPI.DELEG_FLAG</dt> + <dd>Delegation. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.9'>RFC 2743 section 1.2.9</a>. </dd> - <dt class='head--doc'>Deprecated</dt> - <dd class='body--doc'>Replaced by <code>is_val_null</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - is_val_null - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>is_val_null</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Nonzero recognition constant. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - iterator_index - </dt> - <dd><code><code class='datatype'>mixed</code> iterator_index(<code class='datatype'>object</code> <code class='argument'>iter</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get the current index for <code>iter</code>. + <dt>GSSAPI.MUTUAL_FLAG</dt> + <dd>Mutual authentication (actually, acceptor authentication). See + <a href='http://pike.lysator.liu.se/rfc2743.xml#1.1.1.3'>RFC 2743 section 1.1.1.3</a> and <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.5'>RFC 2743 section 1.2.5</a>. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_iterator()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - iterator_next - </dt> - <dd><code><code class='datatype'>bool</code> iterator_next(<code class='datatype'>object</code> <code class='argument'>iter</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Advance <code>iter</code> one step. + <dt>GSSAPI.REPLAY_FLAG</dt> + <dd>Per-message replay detection. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.3'>RFC 2743 section 1.2.3</a>. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_iterator()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - iterator_value - </dt> - <dd><code><code class='datatype'>mixed</code> iterator_value(<code class='datatype'>object</code> <code class='argument'>iter</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get the current value for <code>iter</code>. + <dt>GSSAPI.SEQUENCE_FLAG</dt> + <dd>Per-message sequencing. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.3'>RFC 2743 section 1.2.3</a>. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_iterator()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - kill - </dt> - <dd><code><code class='datatype'>bool</code> kill(<code class='datatype'>int</code> <code class='argument'>pid</code>, <code class='datatype'>int</code> <code class='argument'>signal</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Send a signal to another process. - Some signals and their supposed purpose: - <table class='box'><tr><td><code><code class='key'>SIGHUP</code></code></td><td>Hang-up, sent to process when user logs out. - </td></tr> - <tr><td><code><code class='key'>SIGINT</code></code></td><td>Interrupt, normally sent by ctrl-c. - </td></tr> - <tr><td><code><code class='key'>SIGQUIT</code></code></td><td>Quit, sent by ctrl-\. - </td></tr> - <tr><td><code><code class='key'>SIGILL</code></code></td><td>Illegal instruction. - </td></tr> - <tr><td><code><code class='key'>SIGTRAP</code></code></td><td>Trap, mostly used by debuggers. - </td></tr> - <tr><td><code><code class='key'>SIGABRT</code></code></td><td>Aborts process, can be caught, used by Pike whenever something - goes seriously wrong. - </td></tr> - <tr><td><code><code class='key'>SIGEMT</code></code></td><td>Emulation trap. - </td></tr> - <tr><td><code><code class='key'>SIGFPE</code></code></td><td>Floating point error (such as division by zero). - </td></tr> - <tr><td><code><code class='key'>SIGKILL</code></code></td><td>Really kill a process, cannot be caught. - </td></tr> - <tr><td><code><code class='key'>SIGBUS</code></code></td><td>Bus error. - </td></tr> - <tr><td><code><code class='key'>SIGSEGV</code></code></td><td>Segmentation fault, caused by accessing memory where you - shouldn't. Should never happen to Pike. - </td></tr> - <tr><td><code><code class='key'>SIGSYS</code></code></td><td>Bad system call. Should never happen to Pike. - </td></tr> - <tr><td><code><code class='key'>SIGPIPE</code></code></td><td>Broken pipe. - </td></tr> - <tr><td><code><code class='key'>SIGALRM</code></code></td><td>Signal used for timer interrupts. - </td></tr> - <tr><td><code><code class='key'>SIGTERM</code></code></td><td>Termination signal. - </td></tr> - <tr><td><code><code class='key'>SIGUSR1</code></code></td><td>Signal reserved for whatever you want to use it for. - Note that some OSs reserve this signal for the thread library. - </td></tr> - <tr><td><code><code class='key'>SIGUSR2</code></code></td><td>Signal reserved for whatever you want to use it for. - Note that some OSs reserve this signal for the thread library. - </td></tr> - <tr><td><code><code class='key'>SIGCHLD</code></code></td><td>Child process died. This signal is reserved for internal use - by the Pike run-time. - </td></tr> - <tr><td><code><code class='key'>SIGPWR</code></code></td><td>Power failure or restart. - </td></tr> - <tr><td><code><code class='key'>SIGWINCH</code></code></td><td>Window change signal. - </td></tr> - <tr><td><code><code class='key'>SIGURG</code></code></td><td>Urgent socket data. - </td></tr> - <tr><td><code><code class='key'>SIGIO</code></code></td><td>Pollable event. - </td></tr> - <tr><td><code><code class='key'>SIGSTOP</code></code></td><td>Stop (suspend) process. - </td></tr> - <tr><td><code><code class='key'>SIGTSTP</code></code></td><td>Stop (suspend) process. Sent by ctrl-z. - </td></tr> - <tr><td><code><code class='key'>SIGCONT</code></code></td><td>Continue suspended. - </td></tr> - <tr><td><code><code class='key'>SIGTTIN</code></code></td><td>TTY input for background process. - </td></tr> - <tr><td><code><code class='key'>SIGTTOU</code></code></td><td>TTY output for background process. - </td></tr> - <tr><td><code><code class='key'>SIGVTALRM</code></code></td><td>Virtual timer expired. - </td></tr> - <tr><td><code><code class='key'>SIGPROF</code></code></td><td>Profiling trap. - </td></tr> - <tr><td><code><code class='key'>SIGXCPU</code></code></td><td>Out of CPU. - </td></tr> - <tr><td><code><code class='key'>SIGXFSZ</code></code></td><td>File size limit exceeded. - </td></tr> - <tr><td><code><code class='key'>SIGSTKFLT</code></code></td><td>Stack fault - </td></tr> - </table> + <dt>GSSAPI.CONF_FLAG</dt> + <dd>Per-message confidentiality. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.2'>RFC 2743 section 1.2.2</a>. </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><table class='box'><tr><td><code><code class='key'>1</code></code></td><td>Success. - </td></tr> - <tr><td><code><code class='key'>0</code></code></td><td>Failure. <code>errno()</code> is set to EINVAL, EPERM or ESRCH. - </td></tr> - </table> + <dt>GSSAPI.INTEG_FLAG</dt> + <dd>Per-message integrity. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.2'>RFC 2743 section 1.2.2</a>. </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Note that you have to use signame to translate the name of a signal - to its number. - Note that the kill function is not available on platforms that do not - support signals. Some platforms may also have signals not listed here. + <dt>GSSAPI.ANON_FLAG</dt> + <dd>Anonymous authentication. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.5'>RFC 2743 section 1.2.5</a>. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>signal()</code>, <code>signum()</code>, <code>signame()</code>, <code>fork()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - limit - </dt> - <dd><code><code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>object</code> limit(<code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>object</code> <code class='argument'>minval</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>object</code> <code class='argument'>x</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>object</code> <code class='argument'>maxval</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Limits the value <code>x</code> so that it's between <code>minval</code> and <code>maxval</code>. - If <code>x</code> is an object, it must implement the <code>lfun::`<</code> method. + <dt>GSSAPI.PROT_READY_FLAG</dt> + <dd>Might be set before the context establishment has finished, to + denote that per-message protection already is available. See + <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.7'>RFC 2743 section 1.2.7</a>. Is always set in <code>GSSAPI.Context</code> and + derived classes when the context is established. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>max()</code> and <code>min()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - listxattr - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) listxattr(<code class='datatype'>string</code> <code class='argument'>file</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 an array of all extended attributes set on the file - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - load_module - </dt> - <dd><code><code class='datatype'>program</code> load_module(<code class='datatype'>string</code> <code class='argument'>module_name</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Load a binary module. - This function loads a module written in C or some other language - into Pike. The module is initialized and any programs or constants - defined will immediately be available. - When a module is loaded the C function <tt>pike_module_init()</tt> will - be called to initialize it. When Pike exits <tt>pike_module_exit()</tt> - will be called. These two functions must be available in the module. + <dt>GSSAPI.TRANS_FLAG</dt> + <dd>The context can be transferred between processes using + <code>GSSAPI.Context.export</code>. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.10'>RFC 2743 section 1.2.10</a>. </dd> - <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> + </dl></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> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - m_clear - </dt> - <dd><code><code class='datatype'>void</code> m_clear(<code class='datatype'>mapping</code>|<code class='datatype'>multiset</code>|<code class='datatype'>object</code> <code class='argument'>map</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Clear the contents of a mapping or multiset. - This function clears the content of the mapping - or multiset <code>map</code> so that it becomes empty. - This is an atomic operation. - If <code>map</code> is an object <code>lfun::_m_clear()</code> will be called - in it. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>m_delete()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - m_delete - </dt> - <dd><code><code class='datatype'>mixed</code> m_delete(<code class='datatype'>object</code>|<code class='datatype'>mapping</code>|<code class='datatype'>multiset</code> <code class='argument'>map</code>, <code class='datatype'>mixed</code> <code class='argument'>index</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>If <code>map</code> is an object that implements <code>lfun::_m_delete()</code>, - that function will be called with <code>index</code> as its single argument. - Otherwise if <code>map</code> is a mapping or multiset the entry with - index <code>index</code> will be removed from <code>map</code> destructively. - If the mapping or multiset does not have an entry with - index <code>index</code>, nothing is done. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The value that was removed will be returned, - and <code class='expr'>UNDEFINED</code> otherwise. - </dd> - <dt class='head--doc'>Note</dt> - <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> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>min()</code> and <code>limit()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - min - </dt> - <dd><code><code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>object</code> min(<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> min(<code class='datatype'>string</code>, <code class='datatype'>string</code> ... <code class='argument'>args</code>)</code> - <code><code class='datatype'>int(0..0)</code> min()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the smallest value among <code>args</code>. Compared objects - must implement the <code>lfun::`<</code> method. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>max()</code> and <code>limit()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - mkmapping - </dt> - <dd><code><code class='datatype'>mapping</code> mkmapping(<code class='datatype'>array</code> <code class='argument'>ind</code>, <code class='datatype'>array</code> <code class='argument'>val</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Make a mapping from two arrays. - Makes a mapping <code>ind[x]</code>:<code>val[x]</code>, <tt>0 <= x < sizeof(ind)</tt>. - <code>ind</code> and <code>val</code> must have the same size. - This is the inverse operation of <code>indices()</code> and <code>values()</code>. - </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 - mkmultiset - </dt> - <dd><code><code class='datatype'>multiset</code> mkmultiset(<code class='datatype'>array</code> <code class='argument'>a</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <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> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - nth - </dt> - <dd><code><code class='datatype'>mixed</code> nth(<code class='datatype'>int(0..)</code> <code class='argument'>n</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <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. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>exp()</code>, <code>log()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - putenv - </dt> - <dd><code><code class='datatype'>void</code> putenv(<code class='datatype'>string</code> <code class='argument'>varname</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>value</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the environment variable <code>varname</code> to <code>value</code>. - If <code>value</code> is omitted or zero, the environment variable - <code>varname</code> is removed. - <code>varname</code> and <code>value</code> cannot be wide strings nor contain - <code class='expr'>'\0'</code> characters. <code>varname</code> also cannot contain - <code class='expr'>'='</code> characters. - </dd> - <dt class='head--doc'>Note</dt> - <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> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_include_path - </dt> - <dd><code><code class='datatype'>void</code> remove_include_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for include files. - This function performs the reverse operation of <code>add_include_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_include_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_module_path - </dt> - <dd><code><code class='datatype'>void</code> remove_module_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for modules. - This function performs the reverse operation of <code>add_module_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_module_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_program_path - </dt> - <dd><code><code class='datatype'>void</code> remove_program_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for programs. - This function performs the reverse operation of <code>add_program_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_program_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - removexattr - </dt> - <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 - fails if the named attribute does not already exist. - By default (no flags), the extended attribute will be created if need be, - or will simply replace the value if the attribute exists. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>1 if successful, 0 otherwise, setting errno. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - sgn - </dt> - <dd><code><code class='datatype'>int</code> sgn(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code> - <code><code class='datatype'>int</code> sgn(<code class='datatype'>mixed</code> <code class='argument'>value</code>, <code class='datatype'>mixed</code> <code class='argument'>zero</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Check the sign of a value. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns <code class='expr'>-1</code> if <code>value</code> is less than <code>zero</code>, - <code class='expr'>1</code> if <code>value</code> is greater than <code>zero</code> and <code class='expr'>0</code> - (zero) otherwise. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>abs()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - signal - </dt> - <dd><code><code class='datatype'>function</code>(<code class='datatype'>int</code>|<code class='datatype'>void</code>:<code class='datatype'>void</code>) signal(<code class='datatype'>int</code> <code class='argument'>sig</code>, <code class='datatype'>function</code>(<code class='datatype'>int</code>|<code class='datatype'>void</code>:<code class='datatype'>void</code>) <code class='argument'>callback</code>)</code> - <code><code class='datatype'>function</code>(<code class='datatype'>int</code>|<code class='datatype'>void</code>:<code class='datatype'>void</code>) signal(<code class='datatype'>int</code> <code class='argument'>sig</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Trap signals. - This function allows you to trap a signal and have a function called - when the process receives a signal. Although it IS possible to trap - SIGBUS, SIGSEGV etc, I advise you not to; Pike should not receive any - such signals, and if it does, it is because of bugs in the Pike - interpreter. And all bugs should be reported, no matter how trifle. - The callback will receive the signal number as its only argument. - See the documentation for <code>kill()</code> for a list of signals. - If no second argument is given, the signal handler for that signal - is restored to the default handler. - If the second argument is zero, the signal will be completely ignored. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the previous signal function, or 0 if none had been registered. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>kill()</code>, <code>signame()</code>, <code>signum()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - signame - </dt> - <dd><code><code class='datatype'>string</code> signame(<code class='datatype'>int</code> <code class='argument'>sig</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns a string describing the signal <code>sig</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>kill()</code>, <code>signum()</code>, <code>signal()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - signum - </dt> - <dd><code><code class='datatype'>int</code> signum(<code class='datatype'>string</code> <code class='argument'>sig</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get a signal number given a descriptive string. - This function is the inverse of <code>signame()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>signame()</code>, <code>kill()</code>, <code>signal()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - sin - </dt> - <dd><code><code class='datatype'>float</code> sin(<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 sine 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>asin()</code>, <code>cos()</code>, <code>tan()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - sinh - </dt> - <dd><code><code class='datatype'>float</code> sinh(<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 hyperbolic sine value for <code>f</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>asinh()</code>, <code>cosh()</code>, <code>tanh()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - sizeof - </dt> - <dd><code><code class='datatype'>int</code> sizeof(<code class='datatype'>string</code> <code class='argument'>arg</code>)</code> - <code><code class='datatype'>int</code> sizeof(<code class='datatype'>array</code> <code class='argument'>arg</code>)</code> - <code><code class='datatype'>int</code> sizeof(<code class='datatype'>mapping</code> <code class='argument'>arg</code>)</code> - <code><code class='datatype'>int</code> sizeof(<code class='datatype'>multiset</code> <code class='argument'>arg</code>)</code> - <code><code class='datatype'>int</code> sizeof(<code class='datatype'>object</code> <code class='argument'>arg</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Size query. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The result will be as follows: - <code>arg</code> can have any of the following types: <table class='box'><tr><td><code><code class='datatype'>string</code></code></td><td>The number of characters in <code>arg</code> will be returned. - </td></tr> - <tr><td><code><code class='datatype'>array</code>|<code class='datatype'>multiset</code></code></td><td>The number of elements in <code>arg</code> will be returned. - </td></tr> - <tr><td><code><code class='datatype'>mapping</code></code></td><td>The number of key-value pairs in <code>arg</code> will be returned. - </td></tr> - <tr><td><code><code class='datatype'>object</code></code></td><td>If <code>arg</code> implements <code>lfun::_sizeof()</code>, that function will - be called. Otherwise the number of non-protected (ie public) - symbols in <code>arg</code> will be returned. - </td></tr> - </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. - The following modifiers are supported: - <table class='box'><tr><td><code><code class='key'>'0'</code></code></td><td>Zero pad numbers (implies right justification). - </td></tr> - <tr><td><code><code class='key'>'!'</code></code></td><td>Toggle truncation. - </td></tr> - <tr><td><code><code class='key'>' '</code></code></td><td>Pad positive integers with a space. - </td></tr> - <tr><td><code><code class='key'>'+'</code></code></td><td>Pad positive integers with a plus sign. - </td></tr> - <tr><td><code><code class='key'>'-'</code></code></td><td>Left adjust within field size (default is right). - </td></tr> - <tr><td><code><code class='key'>'|'</code></code></td><td>Centered within field size. - </td></tr> - <tr><td><code><code class='key'>'='</code></code></td><td>Column mode if strings are greater than field width. Breaks - between words (possibly skipping or adding spaces). Can not be - used together with <code class='expr'>'/'</code>. - </td></tr> - <tr><td><code><code class='key'>'/'</code></code></td><td>Column mode with rough line break (break at exactly field width - instead of between words). Can not be used together with <code class='expr'>'='</code>. - </td></tr> - <tr><td><code><code class='key'>'#'</code></code></td><td>Table mode, print a list of <code class='expr'>'\n'</code> separated words - (top-to-bottom order). - </td></tr> - <tr><td><code><code class='key'>'$'</code></code></td><td>Inverse table mode (left-to-right order). - </td></tr> - <tr><td><code><code class='key'>'n'</code></code></td><td rowspan='2'>(Where n is a number or *) field width specifier. - </td></tr> - <tr><td><code><code class='key'>':n'</code></code></td></tr> - <tr><td><code><code class='key'>'.n'</code></code></td><td>Precision specifier. - </td></tr> - <tr><td><code><code class='key'>';n'</code></code></td><td>Column width specifier. - </td></tr> - <tr><td><code><code class='key'>'*'</code></code></td><td>If n is a <tt>*</tt> then next argument is used for precision/field - size. The argument may either be an integer, or a modifier mapping - as received by <code>lfun::_sprintf()</code>: - <table class='box'><tr><td><code><code class='key'>"precision"</code> : <code class='datatype'>int</code>|<code class='datatype'>void</code></code></td><td>Precision. - </td></tr> - <tr><td><code><code class='key'>"width"</code> : <code class='datatype'>int(0..)</code>|<code class='datatype'>void</code></code></td><td>Field width. - </td></tr> - <tr><td><code><code class='key'>"flag_left"</code> : <code class='datatype'>bool</code>|<code class='datatype'>void</code></code></td><td>Indicates that the output should be left-aligned. - </td></tr> - <tr><td><code><code class='key'>"indent"</code> : <code class='datatype'>int(0..)</code>|<code class='datatype'>void</code></code></td><td>Indentation level in <tt>%O</tt>-mode. - </td></tr> - </table></td></tr> - <tr><td><code><code class='key'>"'"</code></code></td><td>Set a pad string. <tt>'</tt> cannot be a part of the pad string (yet). - </td></tr> - <tr><td><code><code class='key'>'~'</code></code></td><td>Get pad string from argument list. - </td></tr> - <tr><td><code><code class='key'>'<'</code></code></td><td>Use same argument again. - </td></tr> - <tr><td><code><code class='key'>'^'</code></code></td><td>Repeat this on every line produced. - </td></tr> - <tr><td><code><code class='key'>'@'</code></code></td><td>Repeat this format for each element in the argument array. - </td></tr> - <tr><td><code><code class='key'>'>'</code></code></td><td>Put the string at the bottom end of column instead of top. - </td></tr> - <tr><td><code><code class='key'>'_'</code></code></td><td>Set width to the length of data. - </td></tr> - <tr><td><code><code class='key'>'[n]'</code></code></td><td>Select argument number <tt>n</tt>. Use <tt>*</tt> to use the next - argument as selector. The arguments are numbered starting from - <code class='expr'>0</code> (zero) for the first argument after the <code>format</code>. - Note that this only affects where the current operand is fetched. - </td></tr> - </table>The following operators are supported: - <table class='box'><tr><td><code><code class='key'>'%'</code></code></td><td>Percent. - </td></tr> - <tr><td><code><code class='key'>'b'</code></code></td><td>Signed binary integer. - </td></tr> - <tr><td><code><code class='key'>'d'</code></code></td><td>Signed decimal integer. - </td></tr> - <tr><td><code><code class='key'>'u'</code></code></td><td>Unsigned decimal integer. - </td></tr> - <tr><td><code><code class='key'>'o'</code></code></td><td>Signed octal integer. - </td></tr> - <tr><td><code><code class='key'>'x'</code></code></td><td>Lowercase signed hexadecimal integer. - </td></tr> - <tr><td><code><code class='key'>'X'</code></code></td><td>Uppercase signed hexadecimal integer. - </td></tr> - <tr><td><code><code class='key'>'c'</code></code></td><td>Character. If a fieldsize has been specified this will output - the low-order bytes of the integer in network (big endian) byte - order. To get little endian byte order, negate the field size. - </td></tr> - <tr><td><code><code class='key'>'f'</code></code></td><td>Float. (Locale dependent formatting.) - </td></tr> - <tr><td><code><code class='key'>'g'</code></code></td><td>Heuristically chosen representation of float. - (Locale dependent formatting.) - </td></tr> - <tr><td><code><code class='key'>'G'</code></code></td><td>Like <tt>%g</tt>, but uses uppercase <tt>E</tt> for exponent. - </td></tr> - <tr><td><code><code class='key'>'e'</code></code></td><td>Exponential notation float. (Locale dependent output.) - </td></tr> - <tr><td><code><code class='key'>'E'</code></code></td><td>Like <tt>%e</tt>, but uses uppercase <tt>E</tt> for exponent. - </td></tr> - <tr><td><code><code class='key'>'F'</code></code></td><td>Binary IEEE representation of float (<tt>%4F</tt> gives - single precision, <tt>%8F</tt> gives double precision) - in network (big endian) byte order. To get little endian - byte order, negate the field size. - </td></tr> - <tr><td><code><code class='key'>'s'</code></code></td><td>String. - </td></tr> - <tr><td><code><code class='key'>'q'</code></code></td><td>Quoted string. Escapes all control and non-8-bit characters, - as well as the quote characters <tt>'\\'</tt> and <tt>'\"'</tt>. - </td></tr> - <tr><td><code><code class='key'>'O'</code></code></td><td>Any value, debug style. Do not rely on the exact formatting; - how the result looks can vary depending on locale, phase of - the moon or anything else the <code>lfun::_sprintf()</code> method - implementor wanted for debugging. - </td></tr> - <tr><td><code><code class='key'>'p'</code></code></td><td>Hexadecimal representation of the memory address of the object. - Integers and floats have no address, and are printed as themselves. - </td></tr> - <tr><td><code><code class='key'>'H'</code></code></td><td>Binary Hollerith string. Equivalent to <code class='expr'>sprintf("%c%s", -        strlen(str), str)</code>. Arguments (such as width etc) adjust the - length-part of the format. Requires 8-bit strings. - </td></tr> - <tr><td><code><code class='key'>'n'</code></code></td><td>No argument. Same as <code class='expr'>"%s"</code> with an empty string as argument. - Note: Does take an argument array (but ignores its content) - if the modifier <code class='expr'>'@'</code> is active. - </td></tr> - <tr><td><code><code class='key'>'t'</code></code></td><td>Type of the argument. - </td></tr> - <tr><td><code><code class='key'>'{'</code></code></td><td rowspan='2'>Perform the enclosed format for every element of the argument array. - </td></tr> - <tr><td><code><code class='key'>'}'</code></code></td></tr> - </table>Most modifiers and operators are combinable in any fashion, but some - combinations may render strange results. - If an argument is an object that implements <code>lfun::_sprintf()</code>, that - callback will be called with the operator as the first argument, and - the current modifiers as the second. The callback is expected to return - a string. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>sprintf-style formatting is applied by many formatting functions, such - <code>write()</code> and <code>werror()</code>. It is also possible to get sprintf-style - compile-time argument checking by using the type-attributes - <code>sprintf_format</code> or <code>strict_sprintf_format</code> in combination - with <code>sprintf_args</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The <code class='expr'>'q'</code> operator was added in Pike 7.7. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Support for specifying modifiers via a mapping was added in Pike 7.8. - This support can be tested for with the constant - <code>String.__HAVE_SPRINTF_STAR_MAPPING__</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Support for specifying little endian byte order to <code class='expr'>'F'</code> - was added in Pike 7.8. This support can be tested for with the - constant <code>String.__HAVE_SPRINTF_NEGATIVE_F__</code>. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre><pre><code>Pike v7.8 release 263 running Hilfe v3.5 (Incremental Pike Frontend) - > sprintf("The unicode character %c has character code %04X.", 'A', 'A'); - (1) Result: "The unicode character A has character code 0041." - > sprintf("#%@02X is the HTML code for purple.", Image.Color.purple->rgb()); - (2) Result: "#A020F0 is the HTML code for purple." - > int n=4711; - > sprintf("%d = hexadecimal %x = octal %o = %b binary", n, n, n, n); - (3) Result: "4711 = hexadecimal 1267 = octal 11147 = 1001001100111 binary" - > write(#"Formatting examples: - Left adjusted [%-10d] - Centered [%|10d] - Right adjusted [%10d] - Zero padded [%010d] - ", n, n, n, n); - Formatting examples: - Left adjusted [4711 ] - Centered [ 4711 ] - Right adjusted [ 4711] - Zero padded [0000004711] - (5) Result: 142 - int screen_width=70; - > write("%-=*s\n", screen_width, - >> "This will wordwrap the specified string within the "+ - >> "specified field size, this is useful say, if you let "+ - >> "users specify their screen size, then the room "+ - >> "descriptions will automagically word-wrap as appropriate.\n"+ - >> "slosh-n's will of course force a new-line when needed.\n"); - This will wordwrap the specified string within the specified field - size, this is useful say, if you let users specify their screen size, - then the room descriptions will automagically word-wrap as - appropriate. - slosh-n's will of course force a new-line when needed. - (6) Result: 355 - > write("%-=*s %-=*s\n", screen_width/2, - >> "Two columns next to each other (any number of columns will "+ - >> "of course work) independantly word-wrapped, can be useful.", - >> screen_width/2-1, - >> "The - is to specify justification, this is in addherence "+ - >> "to std sprintf which defaults to right-justification, "+ - >> "this version also supports centre and right justification."); - Two columns next to each other (any The - is to specify justification, - number of columns will of course this is in addherence to std - work) independantly word-wrapped, sprintf which defaults to - can be useful. right-justification, this version - also supports centre and right - justification. - (7) Result: 426 - > write("%-$*s\n", screen_width, - >> "Given a\nlist of\nslosh-n\nseparated\n'words',\nthis option\n"+ - >> "creates a\ntable out\nof them\nthe number of\ncolumns\n"+ - >> "be forced\nby specifying a\npresision.\nThe most obvious\n"+ - >> "use is for\nformatted\nls output."); - Given a list of slosh-n - separated 'words', this option - creates a table out of them - the number of columns be forced - by specifying a presision. The most obvious - use is for formatted ls output. - (8) Result: 312 - > write("%-#*s\n", screen_width, - >> "Given a\nlist of\nslosh-n\nseparated\n'words',\nthis option\n"+ - >> "creates a\ntable out\nof them\nthe number of\ncolumns\n"+ - >> "be forced\nby specifying a\npresision.\nThe most obvious\n"+ - >> "use is for\nformatted\nls output."); - Given a creates a by specifying a - list of table out presision. - slosh-n of them The most obvious - separated the number of use is for - 'words', columns formatted - this option be forced ls output. - (9) Result: 312 - > sample = ([ "align":"left", "valign":"middle" ]); - (10) Result: ([ /* 2 elements */ - "align":"left", - "valign":"middle" - ]) - > write("<td%{ %s='%s'%}>\n", (array)sample); - <td valign='middle' align='left - </code></pre> - </pre></dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>lfun::_sprintf()</code>, <code>strict_sprintf_format</code>, <code>sprintf_format</code>, - <code>sprintf_args</code>, <code>String.__HAVE_SPRINTF_STAR_MAPPING__</code>, - <code>String.__HAVE_SPRINTF_NEGATIVE_F__</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Constant - sprintf_args + BAD_MECH + Constant + BAD_NAME + Constant + BAD_NAMETYPE + Constant + BAD_BINDINGS + Constant + BAD_STATUS + Constant + BAD_SIG + Constant + NO_CRED + Constant + NO_CONTEXT + Constant + DEFECTIVE_TOKEN + Constant + DEFECTIVE_CREDENTIAL + Constant + CREDENTIALS_EXPIRED + Constant + CONTEXT_EXPIRED + Constant + FAILURE + Constant + BAD_QOP + Constant + UNAUTHORIZED + Constant + UNAVAILABLE + Constant + DUPLICATE_ELEMENT + Constant + NAME_NOT_MN </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>sprintf_args</code></code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>BAD_MECH</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>BAD_NAME</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>BAD_NAMETYPE</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>BAD_BINDINGS</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>BAD_STATUS</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>BAD_SIG</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>NO_CRED</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>NO_CONTEXT</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>DEFECTIVE_TOKEN</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>DEFECTIVE_CREDENTIAL</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>CREDENTIALS_EXPIRED</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>CONTEXT_EXPIRED</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>FAILURE</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>BAD_QOP</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>UNAUTHORIZED</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>UNAVAILABLE</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>DUPLICATE_ELEMENT</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>NAME_NOT_MN</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Type constant used for typing extra arguments that are - sent to <code>sprintf()</code>. + <dd class='body--doc'>Constants for routine errors in major status codes like + <code>GSSAPI.Error.major_status</code>. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.1.1'>RFC 2743 section 1.2.1.1</a>. Note that + major status codes have to be masked with <code>GSSAPI.ERROR_MASK</code> + before comparison with these. + Brief descriptions of the flags: + <dl class='group--doc'><dt>GSSAPI.BAD_BINDINGS</dt> + <dd>Channel binding mismatch. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>strict_sprintf_format</code>, <code>sprintf_format</code>, <code>sprintf()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - sprintf_format - </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>sprintf_format</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Type constant used for typing arguments that are optionally - sent to <code>sprintf()</code> depending on the presence of extra arguments. + <dt>GSSAPI.BAD_MECH</dt> + <dd>Unsupported mechanism requested. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>strict_sprintf_format</code>, <code>sprintf_args</code>, <code>sprintf()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - sprintf_result - </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>sprintf_result</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Type constant used for typing the return value from <code>sprintf()</code>. + <dt>GSSAPI.BAD_NAME</dt> + <dd>Invalid name provided. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>strict_sprintf_format</code>, <code>sprintf_format</code>, <code>sprintf()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - sqrt - </dt> - <dd><code><code class='datatype'>float</code> sqrt(<code class='datatype'>float</code> <code class='argument'>f</code>)</code> - <code><code class='datatype'>int</code> sqrt(<code class='datatype'>int</code> <code class='argument'>i</code>)</code> - <code><code class='datatype'>mixed</code> sqrt(<code class='datatype'>object</code> <code class='argument'>o</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the square root of <code>f</code>, or in the integer case, the square root - truncated to the closest lower integer. If the argument is an object, - the lfun _sqrt in the object will be called. + <dt>GSSAPI.BAD_NAMETYPE</dt> + <dd>Name of unsupported type provided. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>pow()</code>, <code>log()</code>, <code>exp()</code>, <code>floor()</code>, <code>lfun::_sqrt</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - sscanf - </dt> - <dd><code><code class='datatype'>int</code> sscanf(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>string</code> <code class='argument'>format</code>, <code class='datatype'>mixed</code> ... <code class='argument'>lvalues</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The purpose of sscanf is to match a string <code>data</code> against a <code>format</code> - string and place the matching results into a list of variables. The list - of <code>lvalues</code> are destructively modified (which is only possible because - sscanf really is a special form, rather than a pike function) with the values - extracted from the <code>data</code> according to the <code>format</code> specification. Only - the variables up to the last matching directive of the format string are - touched. - The <code>format</code> string may contain strings separated by special matching - directives like <tt>%d</tt>, <tt>%s</tt> <tt>%c</tt> and <tt>%f</tt>. Every such - directive corresponds to one of the <code>lvalues</code>, in the order they are listed. - An lvalue is the name of a variable, a name of a local variable, an index - into an array, mapping or object. It is because of these lvalues that sscanf - can not be implemented as a normal function. - Whenever a percent character is found in the format string, a match is - performed, according to which operator and modifiers follow it: - <table class='box'><tr><td><code><code class='key'>"%b"</code></code></td><td>Reads a binary integer (<code class='expr'>"0101"</code> makes <code class='expr'>5</code>) - </td></tr> - <tr><td><code><code class='key'>"%d"</code></code></td><td>Reads a decimal integer (<code class='expr'>"0101"</code> makes <code class='expr'>101</code>). - </td></tr> - <tr><td><code><code class='key'>"%o"</code></code></td><td>Reads an octal integer (<code class='expr'>"0101"</code> makes <code class='expr'>65</code>). - </td></tr> - <tr><td><code><code class='key'>"%x"</code></code></td><td>Reads a hexadecimal integer (<code class='expr'>"0101"</code> makes <code class='expr'>257</code>). - </td></tr> - <tr><td><code><code class='key'>"%D"</code></code></td><td>Reads an integer that is either octal (leading zero), - hexadecimal (leading <code class='expr'>0x</code>) or decimal. (<code class='expr'>"0101"</code> makes - <code class='expr'>65</code>). - </td></tr> - <tr><td><code><code class='key'>"%c"</code></code></td><td>Reads one character and returns it as an integer - (<code class='expr'>"0101"</code> makes <code class='expr'>48</code>, or <code class='expr'>'0'</code>, leaving - <code class='expr'>"101"</code> for later directives). Using the field width and - endianness modifiers, you can decode integers of any size and - endianness. For example <code class='expr'>"%-2c"</code> decodes <code class='expr'>"0101"</code> - into <code class='expr'>12592</code>, leaving <code class='expr'>"01"</code> for later directives. - The sign modifiers can be used to modify the signature of the - data, making <code class='expr'>"%+1c"</code> decode <code class='expr'>"ä"</code> into - <code class='expr'>-28</code>. - </td></tr> - <tr><td><code><code class='key'>"%n"</code></code></td><td>Returns the current character offset in <code>data</code>. - Note that any characters matching fields scanned with the - <code class='expr'>"!"</code>-modifier are removed from the count (see below). - </td></tr> - <tr><td><code><code class='key'>"%f"</code></code></td><td>Reads a float ("0101" makes 101.0). - </td></tr> - <tr><td><code><code class='key'>"%F"</code></code></td><td>Reads a float encoded according to the IEEE single precision - binary format (<code class='expr'>"0101"</code> makes <code class='expr'>6.45e-10</code>, - approximately). Given a field width modifier of 8 (4 is the - default), the data will be decoded according to the IEEE - double precision binary format instead. (You will however - still get a float, unless your pike was compiled with the - configure argument <tt>--with-double-precision</tt>.) - </td></tr> - <tr><td><code><code class='key'>"%s"</code></code></td><td>Reads a string. If followed by %d, %s will only read non-numerical - characters. If followed by a %[], %s will only read characters not - present in the set. If followed by normal text, %s will match all - characters up to but not including the first occurrence of that text. - </td></tr> - <tr><td><code><code class='key'>"%H"</code></code></td><td>Reads a Hollerith-encoded string, i.e. first reads the length - of the string and then that number of characters. The size and - byte order of the length descriptor can be modified in the - same way as <tt>%c</tt>. As an example <code class='expr'>"%2H"</code> first reads - <code class='expr'>"%2c"</code> and then the resulting number of characters. - </td></tr> - <tr><td><code><code class='key'>"%[set]"</code></code></td><td>Matches a string containing a given set of characters (those given - inside the brackets). Ranges of characters can be defined by using - a minus character between the first and the last character to be - included in the range. Example: <code class='expr'>%[0-9H]</code> means any number or 'H'. - Note that sets that includes the character '-' must have it first - (not possible in complemented sets, see below) or last in the brackets - to avoid having a range defined. Sets including the character ']' must - list this first too. If both '-' and ']' should be included - then put ']' first and '-' last. It is not possible to make a range - that ends with ']'; make the range end with '\' instead and put ']' - at the beginning of the set. Likewise it is generally not possible - to have a range start with '-'; make the range start with '.' instead - and put '-' at the end of the set. If the first character after the - [ bracket is '^' (%[^set]), and this character does not begin a - range, it means that the set is complemented, which is to say that - any character except those inside brackets is matched. To include '-' - in a complemented set, it must be put last, not first. To include '^' - in a non-complemented set, it can be put anywhere but first, or be - specified as a range ("^-^"). - </td></tr> - <tr><td><code><code class='key'>"%{format%}"</code></code></td><td>Repeatedly matches 'format' as many times as possible and assigns an - array of arrays with the results to the lvalue. - </td></tr> - <tr><td><code><code class='key'>"%O"</code></code></td><td>Match a Pike constant, such as string or integer (currently only - integer, string and character constants are functional). - </td></tr> - <tr><td><code><code class='key'>"%%"</code></code></td><td>Match a single percent character (hence this is how you quote the % - character to just match, and not start an lvalue matcher directive). - </td></tr> - </table>Similar to <code>sprintf</code>, you may supply modifiers between the % character - and the operator, to slightly change its behaviour from the default: - <table class='box'><tr><td><code><code class='key'>"*"</code></code></td><td>The operator will only match its argument, without assigning any - variable. - </td></tr> - <tr><td><code><code class='key'>number</code></code></td><td>You may define a field width by supplying a numeric modifier. - This means that the format should match that number of - characters in the input data; be it a number characters - long string, integer or otherwise (<code class='expr'>"0101"</code> using the - format %2c would read an unsigned short <code class='expr'>12337</code>, leaving - the final <code class='expr'>"01"</code> for later operators, for instance). - </td></tr> - <tr><td><code><code class='key'>"-"</code></code></td><td>Supplying a minus sign toggles the decoding to read the data encoded - in little-endian byte order, rather than the default network - (big-endian) byte order. - </td></tr> - <tr><td><code><code class='key'>"+"</code></code></td><td>Interpret the data as a signed entity. In other words, - <code class='expr'>"%+1c"</code> will read <code class='expr'>"\xFF"</code> as <code class='expr'>-1</code> instead - of <code class='expr'>255</code>, as <code class='expr'>"%1c"</code> would have. - </td></tr> - <tr><td><code><code class='key'>"!"</code></code></td><td>Ignore the matched characters with respect to any following - <code class='expr'>"%n"</code>. - </td></tr> - </table> + <dt>GSSAPI.BAD_STATUS</dt> + <dd>Invalid input status selector. </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Sscanf does not use backtracking. Sscanf simply looks at the format string - up to the next % and tries to match that with the string. It then proceeds - to look at the next part. If a part does not match, sscanf immediately - returns how many % were matched. If this happens, the lvalues for % that - were not matched will not be changed. + <dt>GSSAPI.BAD_MIC</dt> + <dd>Token had invalid integrity check. </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre><pre><code>// a will be assigned "oo" and 1 will be returned - sscanf("foo", "f%s", a); - - // a will be 4711 and b will be "bar", 2 will be returned - sscanf("4711bar", "%d%s", a, b); - - // a will be 4711, 2 will be returned - sscanf("bar4711foo", "%*s%d", a); - - // a will become "test", 2 will be returned - sscanf(" \t test", "%*[ \t]%s", a); - - // Remove "the " from the beginning of a string - // If 'str' does not begin with "the " it will not be changed - sscanf(str, "the %s", str); - - // It is also possible to declare a variable directly in the sscanf call; - // another reason for sscanf not to be an ordinary function: - - sscanf("abc def", "%s %s", string a, string b); - </code></pre> - </pre></dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The number of directives matched in the format string. Note that a string - directive (%s or %[]) counts as a match even when matching just the empty - string (which either may do). + <dt>GSSAPI.CONTEXT_EXPIRED</dt> + <dd>Specified security context expired. </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 + <dt>GSSAPI.CREDENTIALS_EXPIRED</dt> + <dd>Expired credentials detected. </dd> - <dt>%A</dt> - <dd>The full weekday name according to the current locale. + <dt>GSSAPI.DEFECTIVE_CREDENTIAL</dt> + <dd>Defective credential detected. </dd> - <dt>%b</dt> - <dd>The abbreviated month name according to the current locale. + <dt>GSSAPI.DEFECTIVE_TOKEN</dt> + <dd>Defective token detected. </dd> - <dt>%B</dt> - <dd>The full month name according to the current locale. + <dt>GSSAPI.FAILURE</dt> + <dd>Failure, unspecified at GSS-API level. + <code>GSSAPI.Error.minor_status</code> should provide further details. </dd> - <dt>%c</dt> - <dd>The preferred date and time representation for the current locale. + <dt>GSSAPI.NO_CONTEXT</dt> + <dd>No valid security context specified. </dd> - <dt>%C</dt> - <dd>The century number (year/100) as a 2-digit integer. + <dt>GSSAPI.NO_CRED</dt> + <dd>No valid credentials provided. </dd> - <dt>%d</dt> - <dd>The day of the month as a decimal number (range 01 to 31). + <dt>GSSAPI.BAD_QOP</dt> + <dd>Unsupported QOP value. </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.) + <dt>GSSAPI.UNAUTHORIZED</dt> + <dd>Operation unauthorized. </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. + <dt>GSSAPI.UNAVAILABLE</dt> + <dd>Operation unavailable. </dd> - <dt>%E</dt> - <dd>Modifier: use alternative format, see below. + <dt>GSSAPI.DUPLICATE_ELEMENT</dt> + <dd>Duplicate credential element requested. </dd> - <dt>%F</dt> - <dd>Equivalent to %Y-%m-%d (the ISO 8601 date format). (C99) + <dt>GSSAPI.NAME_NOT_MN</dt> + <dd>Name contains multi-mechanism elements. </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> + </dl></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Constant - strict_sprintf_format + CONTINUE_NEEDED + Constant + DUPLICATE_TOKEN + Constant + OLD_TOKEN + Constant + UNSEQ_TOKEN + Constant + GAP_TOKEN </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>strict_sprintf_format</code></code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>CONTINUE_NEEDED</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>DUPLICATE_TOKEN</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>OLD_TOKEN</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>UNSEQ_TOKEN</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>GAP_TOKEN</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 class='body--doc'>Bitfield flags for informatory codes in major status codes like + <code>GSSAPI.Error.major_status</code>. See <a href='http://pike.lysator.liu.se/rfc2743.xml#1.2.1.1'>RFC 2743 section 1.2.1.1</a>. Any + combination of these might optionally be combined with one routine + error constant to form a major status code. + Brief descriptions of the flags: + <dl class='group--doc'><dt>GSSAPI.CONTINUE_NEEDED</dt> + <dd>Continuation call to routine required. </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. + <dt>GSSAPI.DUPLICATE_TOKEN</dt> + <dd>Duplicate per-message token detected. </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). + <dt>GSSAPI.OLD_TOKEN</dt> + <dd>Timed-out per-message token detected. </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. + <dt>GSSAPI.UNSEQ_TOKEN</dt> + <dd>Reordered (early) per-message token detected. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> - <dd></dd><dd class='body--doc'>String to convert to UTF16. + <dt>GSSAPI.GAP_TOKEN</dt> + <dd>Skipped predecessor token(s) detected. </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> + </dl></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> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - tanh - </dt> - <dd><code><code class='datatype'>float</code> tanh(<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 hyperbolic tangent value for <code>f</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>atanh()</code>, <code>sinh()</code>, <code>cosh()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Constant - this + ERROR_MASK </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>this</code></code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>ERROR_MASK</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Builtin read only variable that evaluates to the current object. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>this_program</code>, <code>this_object()</code> + <dd class='body--doc'>Bitfield mask for the routine error part of major status codes + like <code>GSSAPI.Error.major_status</code>. After applying this mask, the + status values may be compared to any of the routine error + constants. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Constant - this_function + INFO_MASK </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>this_function</code></code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> GSSAPI.<code class='constant'>INFO_MASK</code></code></dd> <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 class='body--doc'>Bitfield mask for the informatory part of major status codes like + <code>GSSAPI.Error.major_status</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 + NT_HOSTBASED_SERVICE + Constant + NT_USER_NAME + Constant + NT_MACHINE_UID_NAME + Constant + NT_STRING_UID_NAME + Constant + NT_ANONYMOUS + Constant + NT_EXPORT_NAME + Constant + KRB5_NT_PRINCIPAL_NAME </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>this_program</code></code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>string</code> GSSAPI.<code class='constant'>NT_HOSTBASED_SERVICE</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>string</code> GSSAPI.<code class='constant'>NT_USER_NAME</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>string</code> GSSAPI.<code class='constant'>NT_MACHINE_UID_NAME</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>string</code> GSSAPI.<code class='constant'>NT_STRING_UID_NAME</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>string</code> GSSAPI.<code class='constant'>NT_ANONYMOUS</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>string</code> GSSAPI.<code class='constant'>NT_EXPORT_NAME</code></code> + <code><code class='datatype'>constant</code> <code class='datatype'>string</code> GSSAPI.<code class='constant'>KRB5_NT_PRINCIPAL_NAME</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Builtin constant that evaluates to the current program. + <dd class='body--doc'>OIDs on dotted-decimal form for the GSS-API mechanism-independent + name types, and some selected mechanism-specific ones: + <dl class='group--doc'><dt>NT_HOSTBASED_SERVICE</dt> + <dd>Name type for a service associated with a host computer. The + syntax is <tt>service@hostname</tt> where the <tt>@hostname</tt> + part may be omitted for the local host. See <a href='http://pike.lysator.liu.se/rfc2743.xml#4.1'>RFC 2743 section 4.1</a>. </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. + <dt>NT_USER_NAME</dt> + <dd>Name type for a named user on a local system. The syntax is + <tt>username</tt>. See <a href='http://pike.lysator.liu.se/rfc2743.xml#4.2'>RFC 2743 section 4.2</a>. </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. + <dt>NT_MACHINE_UID_NAME</dt> + <dd>Name type for a numeric user identifier corresponding to a user + on a local system. The string representing a name of this type + should contain a locally-significant user ID, represented in + host byte order. See <a href='http://pike.lysator.liu.se/rfc2743.xml#4.3'>RFC 2743 section 4.3</a>. </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 - level is zero which disables all trace messages. - See the <tt>-t</tt> command-line option for more information. + <dt>NT_STRING_UID_NAME</dt> + <dd>Name type for a string of digits representing the numeric user + identifier of a user on a local system. This name type is + similar to the Machine UID Form, except that the buffer contains + a string representing the user ID. See <a href='http://pike.lysator.liu.se/rfc2743.xml#4.4'>RFC 2743 section 4.4</a>. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>level</code></dt> - <dd></dd><dd class='body--doc'>If <code>facility</code> is specified then there is typically only one - trace level for it, i.e. it's an on-or-off toggle. The global - trace levels, when <code>facility</code> isn't specified, are: - <table class='box'><tr><td><code><code class='key'>1</code></code></td><td>Trace calls to Pike functions and garbage collector runs. - </td></tr> - <tr><td><code><code class='key'>2</code></code></td><td>Trace calls to builtin functions. - </td></tr> - <tr><td><code><code class='key'>3</code></code></td><td>Trace every interpreted opcode. - </td></tr> - <tr><td><code><code class='key'>4</code></code></td><td>Also trace the opcode arguments. - </td></tr> - </table> + <dt>NT_ANONYMOUS</dt> + <dd>Name type to identify anonymous names. See <a href='http://pike.lysator.liu.se/rfc2743.xml#4.5'>RFC 2743 section 4.5</a>. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>facility</code></dt> - <dd></dd><dd class='body--doc'>Valid facilities are: - <table class='box'><tr><td><code><code class='key'>"gc"</code></code></td><td>Trace the doings of the garbage collector. The setting is - never thread local. <code>level</code> has two different meanings: - <dl class='group--doc'><dt>1..2</dt> - <dd>Trace the start and end of each gc run. + <dt>NT_EXPORT_NAME</dt> + <dd>Name type for the Mechanism-Independent Exported Name Object + type, which is the type of the names returned by + <code>GSSAPI.Name.export</code>. See <a href='http://pike.lysator.liu.se/rfc2743.xml#4.7'>RFC 2743 section 4.7</a>. </dd> - <dt>3..</dt> - <dd>Additionally show info about the collected garbage, to aid - hunting down garbage problems. This currently shows gc'd - trampolines. Note that the output can be very bulky and is - somewhat low-level technical. Also note that pike currently - has to be configured with <code class='expr'>--with-rtldebug</code> to enable - this. + <dt>KRB5_NT_PRINCIPAL_NAME</dt> + <dd>Name type for a Kerberos principal. See <a href='http://pike.lysator.liu.se/rfc1964.xml#2.1.1'>RFC 1964 section 2.1.1</a>. </dd> - </dl></td></tr> - </table> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>all_threads</code></dt> - <dd></dd><dd class='body--doc'>Trace levels are normally thread local, so changes affect only - the current thread. To change the level in all threads, pass a - nonzero value in this argument. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The old trace level in the current thread is returned. - </dd></dl> + </dl></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - ualarm + describe_services </dt> - <dd><code><code class='datatype'>int</code> ualarm(<code class='datatype'>int</code> <code class='argument'>useconds</code>)</code></dd> + <dd><code><code class='datatype'>string</code> describe_services(<code class='datatype'>int</code> <code class='argument'>services</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set an alarm clock for delivery of a signal. - <code>alarm()</code> arranges for a SIGALRM signal to be delivered to the - process in <code>useconds</code> microseconds. - If <code>useconds</code> is <code class='expr'>0</code> (zero), no new alarm will be scheduled. - Any previous alarms will in any case be canceled. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the number of microseconds remaining until any previously - scheduled alarm was due to be delivered, or zero if there was - no previously scheduled alarm. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is only available on platforms that support - signals. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>alarm()</code>, <code>signal()</code>, <code>call_out()</code> + <dd class='body--doc'>Returns a string that compactly describes the given <code>services</code>, + which is taken as a bitfield of <tt>GSSAPI.*_FLAG</tt> flags. + The returned string contains capitalized names for the flags + reminiscent of the <code>GSSAPI.*_FLAG</code> constants, separated by + <code class='expr'>"|"</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - unicode_to_string + indicate_mechs </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> + <dd><code><code class='datatype'>multiset</code>(<code class='datatype'>string</code>) indicate_mechs()</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 class='body--doc'>Returns the OIDs for the available mechanism in the GSS-API + implementation. The OIDs are returned on dotted-decimal form. + This wraps <tt>GSS_Indicate_mechs</tt> according to + <a href='http://pike.lysator.liu.se/rfc2743.xml#2.4.2'>RFC 2743 section 2.4.2</a>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - upper_case + major_status_messages </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> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) major_status_messages(<code class='datatype'>int</code> <code class='argument'>major_status</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 class='body--doc'>Given a major status code like <code>GSSAPI.Error.major_status</code> (or + more commonly <code>GSSAPI.Context.last_major_status</code> in this case), + returns an array containing messages for all the status values in + it. The returned string(s) presumably don't end with linefeeds. + This wraps <tt>GSS_Display_status</tt> according to + <a href='http://pike.lysator.liu.se/rfc2743.xml#2.4.1'>RFC 2743 section 2.4.1</a>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - utf8_to_string + minor_status_messages </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> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) minor_status_messages(<code class='datatype'>int</code> <code class='argument'>minor_status</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>mech</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Converts an UTF-8 byte-stream into a string. + <dd class='body--doc'>Given a mechanism-specific minor status code like + <code>GSSAPI.Error.minor_status</code>, returns an array containing messages + for all the status values in it. The returned string(s) presumably + don't end with linefeeds. + This wraps <tt>GSS_Display_status</tt> according to + <a href='http://pike.lysator.liu.se/rfc2743.xml#2.4.1'>RFC 2743 section 2.4.1</a>. </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. + <dt class='head--doc'>Parameter <code class='parameter'>minor_status</code></dt> + <dd></dd><dd class='body--doc'>The mechanism-specific minor status. </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> + <dt class='head--doc'>Parameter <code class='parameter'>mech</code></dt> + <dd></dd><dd class='body--doc'>The mechanism that produced the status code. If this is zero or + left out, a system default mechanism is used. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - validate_utf8 + names_for_mech </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> + <dd><code><code class='datatype'>multiset</code>(<code class='datatype'>string</code>) names_for_mech(<code class='datatype'>string</code> <code class='argument'>mech</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 class='body--doc'>Returns the OIDs for the name types that the given <code>mech</code> + supports. Both <code>mech</code> and the returned OID strings are on + dotted-decimal form. + This wraps <tt>GSS_Inquire_names_for_mech</tt> according to + <a href='http://pike.lysator.liu.se/rfc2743.xml#2.4.12'>RFC 2743 section 2.4.12</a>. </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> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>__VERSION__</code>, <code>__MINOR__</code>, <code>__BUILD__</code>, - <code>__REAL_VERSION__</code>, <code>__REAL_MINOR__</code>, <code>__REAL_BUILD__</code>, - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - werror - </dt> - <dd><code><code class='datatype'>int</code> werror(<code class='datatype'>string</code> <code class='argument'>fmt</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Writes a string on stderr. Works just like <code>Stdio.File.write</code> - on <code>Stdio.stderr</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - write - </dt> - <dd><code><code class='datatype'>int</code> write(<code class='datatype'>string</code> <code class='argument'>fmt</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Writes a string on stdout. Works just like <code>Stdio.File.write</code> - on <code>Stdio.stdout</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Typedef - zero - </dt> - <dd><code><code class='datatype'>typedef</code> <code class='datatype'>int(0..0)</code> <code class='typedef'>zero</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Zero datatype. - </dd></dl> - <dl><dt><h2 class='header'>Enum bool</h2> + <dl><dt><h2 class='header'>Class GSSAPI.AcceptContext</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Boolean datatype. + <dd class='body--doc'>Variant of <code>Context</code> which is used on the acceptor side. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Constant - false - Constant - true - </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>false</code></code> - <code><code class='datatype'>constant</code> <code class='constant'>true</code></code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class Codec</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An <code>Encoder</code> and a <code>Decoder</code> lumped into a single instance which - can be used for both encoding and decoding. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Decoder - </dt> - <dd><code>inherit Decoder : Decoder</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Encoder - </dt> - <dd><code>inherit Encoder : Encoder</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class CompilationHandler</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Objects used by the compiler to handle references to global symbols, - modules, external files, etc. - There can be up to three compilation handlers active at the same - time during a compilation. They are in order of precedence: - <ol> - <li>The error handler - This is the object passed to <code>compile()</code> as - the second argument (if any). This object is returned by - <code>get_active_error_handler()</code> during a compilation. - </li><li>The compatibility handler - This is the object returned by - <code>master()->get_compilation_handler()</code> (if any), which - the compiler calls when it sees <tt>#pike</tt>-directives, - or expressions using the version scope - (eg <code class='expr'>7.4::rusage</code>). This object is returned by - <code>get_active_compilation_handler()</code> during a compilation. - </li><li>The master object. - This is returned by <code>master()</code> at any time. - </li></ol>Any of the objects may implement a subset of the <code>CompilationHandler</code> - functions, and the first object that implements a function will be - used. The error handler object can thus be used to block certain - functionality (eg to restrict the number of available functions). - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>master()->get_compilation_handler()</code>, <code>get_active_error_handler()</code>, - <code>get_active_compilation_handler()</code>, <code>compile()</code> - </dd></dl> - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - compile_error + accept </dt> - <dd><code><code class='datatype'>void</code> compile_error(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>line</code>, <code class='datatype'>string</code> <code class='argument'>msg</code>)</code></dd> + <dd><code><code class='datatype'>string</code> accept(<code class='datatype'>string</code> <code class='argument'>remote_token</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Called by <code>compile()</code> and <code>cpp()</code> when they encounter - errors in the code they compile. + <dd class='body--doc'>Accepts a remotely initiated security context. + This wraps <tt>GSS_Accept_sec_context</tt> according to + <a href='http://pike.lysator.liu.se/rfc2743.xml#2.2.2'>RFC 2743 section 2.2.2</a>. + The underlying mechanism might require several tokens to be + passed back and forth to establish the context. If + <code>is_established</code> returns zero after a call to this function + then the caller must wait for a token from the remote peer to + feed as <code>remote_token</code> in another call to this function. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>filename</code></dt> - <dd></dd><dd class='body--doc'>File where the error was detected. + <dt class='head--doc'>Parameter <code class='parameter'>remote_token</code></dt> + <dd></dd><dd class='body--doc'>A token from the remote peer, as returned by a call to + <code>GSSAPI.InitContext.init</code> or some other + <tt>GSS_Init_sec_context</tt> wrapper. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>line</code></dt> - <dd></dd><dd class='body--doc'>Line where the error was detected. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>msg</code></dt> - <dd></dd><dd class='body--doc'>Description of error. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile_warning()</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - compile_exception - </dt> - <dd><code><code class='datatype'>void</code> compile_exception(<code class='datatype'>mixed</code> <code class='argument'>exception</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Called by <code>compile()</code> and <code>cpp()</code> if they trigger - exceptions. - </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'>filename</code>, <code class='datatype'>int</code> <code class='argument'>line</code>, <code class='datatype'>string</code> <code class='argument'>msg</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Called by <code>compile()</code> to report warnings. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>filename</code></dt> - <dd></dd><dd class='body--doc'>File which triggered the warning. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>line</code></dt> - <dd></dd><dd class='body--doc'>Line which triggered the warning. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>msg</code></dt> - <dd></dd><dd class='body--doc'>Warning message. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile_error()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_default_module - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>)|<code class='datatype'>object</code> get_default_module()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the default module from which global symbols will - be fetched. - </dd> + <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the default module, or <code class='expr'>0</code> (zero). - If <code class='expr'>0</code> (zero) is returned the compiler use the mapping - returned by <code>all_constants()</code> as fallback. + <dd class='body--doc'>If a string is returned then it must be passed to the remote + peer which will feed it to <code>GSSAPI.InitContext.init</code> or some + other <tt>GSS_Init_sec_context</tt> wrapper. An empty string is + never returned. + Zero is returned if there is no token to send to the remote + peer. Note that <code>is_established</code> might still return zero in + that case, meaning more remote tokens are necessary. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_predefines()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_predefines - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) get_predefines()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Called by <code>cpp()</code> to get the set of global symbols. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns a mapping from symbol name to symbol value. - Returns zero on failure. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>resolv()</code>, <code>get_default_module()</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'>path</code>, <code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='object unresolved'>CompilationHandler</code> <code class='argument'>handler</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Called by <code>compile()</code> and <code>cpp()</code> to handle import - directives specifying specific paths. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the resolved value, or <code>UNDEFINED</code> on failure. - </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'>header_file</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>bool</code> <code class='argument'>is_local_ref</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Called by <code>cpp()</code> to resolv <code class='expr'>#include</code> and <code class='expr'>#string</code> - directives. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>header_file</code></dt> - <dd></dd><dd class='body--doc'>File that was requested for inclusion. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>current_file</code></dt> - <dd></dd><dd class='body--doc'>File where the directive was found. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>is_local_ref</code></dt> - <dd></dd><dd class='body--doc'>Specifies reference method. - <table class='box'><tr><td><code><code class='key'>0</code></code></td><td>Directive was <code class='expr'>#include <header_file></code>. - </td></tr> - <tr><td><code><code class='key'>1</code></code></td><td>Directive was <code class='expr'>#include "header_file"</code>. - </td></tr> - </table> - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the filename to pass to <code>read_include()</code> if found, - and <code class='expr'>0</code> (zero) on failure. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read_include()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read_include - </dt>

autodoc.git/ traditional_manual/ chapter_21.html

2021-10-20

2021-10-20 16:03:58 by Henrik Grubbström (Grubba) <grubba@grubba.org>