autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2019-11-01' version='Pike v8.1.13'> + <manual time-stamp='2019-11-02' version='Pike v8.1.13'>    <dir name='./onepage'>    <file name='./onepage/manual.html'>    <chapter number='1' title='Control Structures'>      <p>In this chapter all the control structures in Pike will be   explained. Control structures are used to control the flow of the   program execution. Note that functions that make the program pause and   simple function calls are not qualified as control structures.</p>      <section number='1' title='Conditions'>
autodoc.git/onepage.xml:3305:   <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable>   </docgroup>   <docgroup homogen-type='variable'><doc><text><p>Random cookies, sent and received with the hello-messages.</p>   </text></doc>   <variable name='client_random'><type><string/></type></variable>   <variable name='server_random'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='is_server'/><text><p>Whether this is the server end of the connection or not.</p>   </text></group><group><param name='ctx'/><text><p>The context for the connection.</p>   </text></group><group><param name='min_version'/><text><p>Minimum version of SSL to support. -  Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p>   </text></group><group><param name='max_version'/><text><p>Maximum version of SSL to support.    Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>.</p>   </text></group></doc>   <method name='create'>   <arguments><argument name='is_server'><type><int/></type></argument><argument name='ctx'><type><or><void/><object resolved='7.8::SSL.context'>SSL.context</object></or></type></argument><argument name='min_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument><argument name='max_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='handle_handshake' homogen-type='method'><doc><text><p>Do handshake processing. Type is one of HANDSHAKE_*, data is the    contents of the packet, and raw is the raw packet received (needed
autodoc.git/onepage.xml:3472:   <variable name='rsa'><type><object resolved='7.8::Crypto.RSA'>Crypto.RSA</object></type></variable>   </docgroup>   <docgroup homogen-name='set_cipher_suite' homogen-type='method'><doc><text><p>Sets the proper authentication method and cipher specification    for the given cipher <ref resolved='7.8::SSL.session.set_cipher_suite.suite'>suite</ref> and <ref>verison</ref>.</p>   </text></doc>   <method name='set_cipher_suite'>   <arguments><argument name='suite'><type><int/></type></argument><argument name='version'><type><or><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is + <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is    supported.</p>   </text></doc>   <method name='set_compression_method'>   <arguments><argument name='compr'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='sslfile'>   <doc><text><p>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.</p>
autodoc.git/onepage.xml:8503:   </method>   <method name='remove_call_out'>   <arguments><argument name='id'><type><function/></type></argument></arguments>   <returntype><int/></returntype>   </method>   <method name='call_out_info'>   <arguments/>   <returntype><array><valuetype><array/></valuetype></array></returntype>   </method>   </docgroup> + <docgroup homogen-name='_equal' homogen-type='method'> + <method name='_equal'> + <arguments><argument name='o'><type><mixed/></type></argument></arguments> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup>   <docgroup homogen-name='_exit' homogen-type='method'><doc><text><p>This function does the same as <ref resolved='predef::exit'>exit</ref>, 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.</p>   <p> Use with extreme caution.</p>   </text><group><seealso/><text><p><ref resolved='predef::exit'>exit()</ref></p>   </text></group></doc>   <method name='_exit'>   <arguments><argument name='returncode'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='_gdb_breakpoint' homogen-type='method'><doc><text><p>This function only exists so that it is possible to set a gdb    breakpoint on the function pike_gdb_breakpoint.</p>   </text></doc>   <method name='_gdb_breakpoint'>   <arguments/>   <returntype><void/></returntype>   </method>   </docgroup> -  + <docgroup homogen-name='_m_delete' homogen-type='method'><doc><text><p>m_delete callback.</p> + </text></doc> + <method name='_m_delete'> + <arguments><argument name='key'><type><mixed/></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup> + <docgroup homogen-name='_random' homogen-type='method'><doc><text><p>Get a random entry.</p> + </text><group><returns/><text><p>An array <expr>({ key, value })</expr>.</p> + </text></group></doc> + <method name='_random'> + <arguments><argument name='random_string'><type><function/></type></argument><argument name='random'><type><function/></type></argument></arguments> + <returntype><array/></returntype> + </method> + </docgroup>   <docgroup homogen-name='_static_modules' homogen-type='variable'><doc><text><p>This is an object containing the classes for all static    (ie non-dynamic) C-modules.</p>   <p> In a typic Pike with support for dynamic modules the contained    module classes are:</p>   <dl><group><item><p><ref resolved='predef::Builtin'>Builtin</ref></p>   </item><item><p><ref resolved='predef::Gmp'>Gmp</ref></p>   </item><item><p><ref>_Stdio</ref></p>   </item><item><p><ref>_math</ref></p>   </item><item><p><ref>_system</ref></p>   </item></group></dl><p>If the Pike binary lacks support for dynamic modules, all C-modules
autodoc.git/onepage.xml:8906:   </method>   <method name='`+'>   <arguments><argument name='arg'><type><mapping/></type></argument><argument name='more'><type><varargs><mapping/></varargs></type></argument></arguments>   <returntype><mapping/></returntype>   </method>   <method name='`+'>   <arguments><argument name='arg'><type><multiset/></type></argument><argument name='more'><type><varargs><multiset/></varargs></type></argument></arguments>   <returntype><multiset/></returntype>   </method>   </docgroup> + <docgroup homogen-name='`+' homogen-type='method'><doc><text><p>Add callback. Returns the union of two trees.</p> + </text></doc> + <method name='`+'> + <arguments><argument name='o'><type><mixed/></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='`-' homogen-type='method'><doc><text><p>Negation/subtraction/set difference.</p>   <p> Every expression with the <expr>-</expr> operator becomes a call to    this function, i.e. <expr>-a</expr> is the same as    <expr>predef::`-(a)</expr> and <expr>a-b</expr> is the same as    <expr>predef::`-(a,b)</expr>. Longer <expr>-</expr> expressions are    normally optimized to one call, so e.g. <expr>a-b-c</expr> becomes    <expr>predef::`-(a,b,c)</expr>.</p>   </text><group><returns/><text><p>If there's a single argument, that argument is returned negated.    If <ref resolved='predef::`-.arg1'>arg1</ref> is an object with an <ref resolved='lfun::`-'>lfun::`-()</ref>, that function is    called without arguments, and its result is returned.</p>
autodoc.git/onepage.xml:8994:   </method>   <method name='`-'>   <arguments><argument name='arg1'><type><mapping/></type></argument><argument name='arg2'><type><multiset/></type></argument></arguments>   <returntype><mapping/></returntype>   </method>   <method name='`-'>   <arguments><argument name='arg1'><type><multiset/></type></argument><argument name='arg2'><type><multiset/></type></argument></arguments>   <returntype><multiset/></returntype>   </method>   </docgroup> + <docgroup homogen-name='`-' homogen-type='method'><doc><text><p>Sub[s]tract two trees from each other (key-wise).</p> + </text></doc> + <method name='`-'> + <arguments><argument name='o'><type><mixed/></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='`-&gt;' homogen-type='method'><doc><text><p>Arrow indexing.</p>   <p> Every non-lvalue expression with the <expr>-&gt;</expr> operator becomes    a call to this function. <expr>a-&gt;b</expr> is the same as    <expr>predef::`^(a,"b")</expr> where <expr>"b"</expr> is the symbol    <expr>b</expr> in string form.</p>   <p> This function behaves like <ref resolved='predef::`[]'>`[]</ref>, except that the index is    passed literally as a string instead of being evaluated.</p>   </text><group><returns/><text><p>If <ref resolved='predef::`-&gt;.arg'>arg</ref> is an object that implements <ref resolved='lfun::`-&gt;'>lfun::`-&gt;()</ref>, that function    will be called with <ref resolved='predef::`-&gt;.index'>index</ref> as the single argument.</p>   <p> Otherwise the result will be as follows:</p>
autodoc.git/onepage.xml:9325:   </method>   <method name='`&gt;&gt;'>   <arguments><argument name='arg1'><type><int/></type></argument><argument name='arg2'><type><object resolved='predef::`&gt;&gt;'/></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   <method name='`&gt;&gt;'>   <arguments><argument name='arg1'><type><float/></type></argument><argument name='arg2'><type><int><min>0</min><max/></int></type></argument></arguments>   <returntype><float/></returntype>   </method>   </docgroup> + <docgroup homogen-name='`[..]' homogen-type='method'><doc><group><seealso/><text><p><ref resolved='predef::`[..]'>predef::`[..]</ref></p> + </text></group></doc> + <method name='`[..]'> + <arguments><argument name='a'><type><mixed/></type></argument><argument name='atype'><type><int/></type></argument><argument name='b'><type><mixed/></type></argument><argument name='btype'><type><int/></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='`[..]' homogen-type='method'><doc><text><p>Extracts a subrange.</p>   <p> This is the function form of expressions with the <expr>[..]</expr>    operator. <ref resolved='predef::`[..].arg'>arg</ref> is the thing from which the subrange is to be    extracted. <ref resolved='predef::`[..].start'>start</ref> is the lower bound of the subrange and    <ref resolved='predef::`[..].end'>end</ref> the upper bound.</p>   <p> <ref resolved='predef::`[..].start_type'>start_type</ref> and <ref resolved='predef::`[..].end_type'>end_type</ref> specifies how the <ref resolved='predef::`[..].start'>start</ref> and    <ref resolved='predef::`[..].end'>end</ref> indices, respectively, are to be interpreted. The types    are either <ref resolved='predef::Pike.INDEX_FROM_BEG'>Pike.INDEX_FROM_BEG</ref>, <ref resolved='predef::Pike.INDEX_FROM_END'>Pike.INDEX_FROM_END</ref> or    <ref resolved='predef::Pike.OPEN_BOUND'>Pike.OPEN_BOUND</ref>. In the last case, the index value is    insignificant.</p>
autodoc.git/onepage.xml:9496:   </method>   <method name='`[]'>   <arguments><argument name='arg'><type><string/></type></argument><argument name='start'><type><int/></type></argument><argument name='end'><type><int/></type></argument></arguments>   <returntype><string/></returntype>   </method>   <method name='`[]'>   <arguments><argument name='arg'><type><array/></type></argument><argument name='start'><type><int/></type></argument><argument name='end'><type><int/></type></argument></arguments>   <returntype><array/></returntype>   </method>   </docgroup> + <docgroup homogen-name='`[]' homogen-type='method'> + <method name='`[]'> + <arguments><argument name='key'><type><mixed/></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='`[]=' homogen-type='method'><doc><text><p>Index assignment.</p>   <p> Every lvalue expression with the <expr>[]</expr> operator becomes a    call to this function, i.e. <expr>a[b]=c</expr> is the same as    <expr>predef::`[]=(a,b,c)</expr>.</p>   <p> If <ref resolved='predef::`[]=.arg'>arg</ref> is an object that implements <ref resolved='lfun::`[]='>lfun::`[]=()</ref>, that function    will be called with <ref resolved='predef::`[]=.index'>index</ref> and <ref resolved='predef::`[]=.val'>val</ref> as the arguments.</p>   <mixed name='arg'><group><type><object resolved='predef::`[]='/></type><text><p>The non-protected (ie public) variable named <ref resolved='predef::`[]=.index'>index</ref> will    be looked up in <ref resolved='predef::`[]=.arg'>arg</ref>, and assigned <ref resolved='predef::`[]=.val'>val</ref>.</p>   </text></group><group><type><or><array/><mapping/></or></type><text><p>Index <ref resolved='predef::`[]=.index'>index</ref> in <ref resolved='predef::`[]=.arg'>arg</ref> will be assigned <ref resolved='predef::`[]=.val'>val</ref>.</p>   </text></group><group><type><multiset/></type><text><p>If <ref resolved='predef::`[]=.val'>val</ref> is <expr>0</expr> (zero), one occurrance of <ref resolved='predef::`[]=.index'>index</ref> in
autodoc.git/onepage.xml:9536:   </method>   <method name='`[]='>   <arguments><argument name='arg'><type><mapping/></type></argument><argument name='index'><type><mixed/></type></argument><argument name='val'><type><mixed/></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   <method name='`[]='>   <arguments><argument name='arg'><type><multiset/></type></argument><argument name='index'><type><mixed/></type></argument><argument name='val'><type><int><min>0</min><max>1</max></int></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup> + <docgroup homogen-name='`[]=' homogen-type='method'> + <method name='`[]='> + <arguments><argument name='key'><type><mixed/></type></argument><argument name='val'><type><mixed/></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='`^' homogen-type='method'><doc><text><p>Exclusive or.</p>   <p> Every expression with the <expr>^</expr> operator becomes a call to    this function, i.e. <expr>a^b</expr> is the same as    <expr>predef::`^(a,b)</expr>.</p>   </text><group><returns/><text><p>If there's a single argument, that argument is returned.</p>   <p> If there are more than two arguments, the result is:    <expr>`^(`^(<ref resolved='predef::`^.arg1'>arg1</ref>, <ref resolved='predef::`^.arg2'>arg2</ref>), @<ref resolved='predef::`^.extras'>extras</ref>)</expr>.</p>   <p> Otherwise, if <ref resolved='predef::`^.arg1'>arg1</ref> is an object with an <ref resolved='lfun::`^'>lfun::`^()</ref>, that    function is called with <ref resolved='predef::`^.arg2'>arg2</ref> as argument, and its result is    returned.</p>
autodoc.git/onepage.xml:10088:   </method>   </docgroup>   <docgroup homogen-name='basetype' homogen-type='method'><doc><text><p>Same as sprintf("%t",x);</p>   </text><group><seealso/><text><p><ref resolved='predef::sprintf'>sprintf()</ref></p>   </text></group></doc>   <method name='basetype'>   <arguments><argument name='x'><type><mixed/></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup> + <docgroup homogen-name='bkey' homogen-type='method'><doc><text><p>Render the internally used binary representation of +  the key into a string as a strings of '0's and '1's.</p> + </text></doc> + <method name='bkey'> + <arguments><argument name='key'><type><mixed/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup>   <docgroup homogen-name='callablep' homogen-type='method'><doc><text><p>Returns <expr>1</expr> if <ref resolved='predef::callablep.arg'>arg</ref> is a callable, <expr>0</expr> (zero) otherwise.</p>   </text><group><seealso/><text><p><ref resolved='predef::mappingp'>mappingp()</ref>, <ref resolved='predef::programp'>programp()</ref>, <ref resolved='predef::arrayp'>arrayp()</ref>, <ref resolved='predef::stringp'>stringp()</ref>, <ref resolved='predef::objectp'>objectp()</ref>,    <ref resolved='predef::multisetp'>multisetp()</ref>, <ref resolved='predef::floatp'>floatp()</ref>, <ref resolved='predef::intp'>intp()</ref></p>   </text></group></doc>   <method name='callablep'>   <arguments><argument name='arg'><type><mixed/></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup> -  + <docgroup homogen-name='cast' homogen-type='method'><doc><text><p>Cast callback. Supports only cast to mapping and +  behaves as the inverse of create().</p> + </text></doc> + <method name='cast'> + <arguments><argument name='type'><type><string/></type></argument></arguments> + <returntype><mapping/></returntype> + </method> + </docgroup>   <docgroup homogen-name='cd' homogen-type='method'><doc><text><p>Change the current directory for the whole Pike process.</p>   </text><group><returns/><text><p>Returns <expr>1</expr> for success, <expr>0</expr> (zero) otherwise.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::getcwd'>getcwd()</ref></p>   </text></group></doc>   <method name='cd'>   <arguments><argument name='s'><type><string/></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='ceil' homogen-type='method'><doc><text><p>Return the closest integer value greater or equal to <ref resolved='predef::ceil.f'>f</ref>.</p>
autodoc.git/onepage.xml:10368:    generally only be true in static types of identifiers that have been    marked as __deprecated__.</p>   </text><group><returns/><text><p><expr>1</expr> if the type has the "deprecated" attribute,    <expr>0</expr> otherwise.</p>   </text></group></doc>   <method name='deprecated_typep'>   <arguments><argument name='t'><type><type><mixed/></type></type></argument></arguments>   <returntype><int><min/><max>1</max></int></returntype>   </method>   </docgroup> + <docgroup homogen-name='depth' homogen-type='method'><doc><text><p>Calculate the depth of the tree.</p> + </text></doc> + <method name='depth'> + <arguments/> + <returntype><int><min>0</min><max/></int></returntype> + </method> + </docgroup>   <docgroup homogen-name='describe_backtrace' homogen-type='method'><doc><text><p>Return a readable message that describes where the backtrace    <ref resolved='predef::describe_backtrace.trace'>trace</ref> was made (by <ref resolved='predef::backtrace'>backtrace</ref>).</p>   <p> It may also be an error object or array (typically caught by a    <ref>catch</ref>), in which case the error message also is included in the    description.</p>   <p> Pass <ref resolved='predef::describe_backtrace.linewidth'>linewidth</ref> -1 to disable wrapping of the output.</p>   </text><group><seealso/><text><p><ref resolved='predef::backtrace'>backtrace()</ref>, <ref resolved='predef::describe_error'>describe_error()</ref>, <ref>catch()</ref>, <ref resolved='predef::throw'>throw()</ref></p>   </text></group></doc>   <method name='describe_backtrace'>   <arguments><argument name='trace'><type><mixed/></type></argument><argument name='linewidth'><type><or><void/><int/></or></type></argument></arguments>
autodoc.git/onepage.xml:11811:   </docgroup>   <docgroup homogen-name='normalize_path' homogen-type='method'><doc><text><p>Replaces "\" with "/" if runing on MS Windows. It is    adviced to use <ref resolved='predef::System.normalize_path'>System.normalize_path</ref> instead.</p>   </text></doc>   <method name='normalize_path'>   <arguments><argument name='path'><type><string/></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>    + <docgroup homogen-name='nth' homogen-type='method'><doc><text><p>Get the <expr>n</expr>th entry in order.</p> + </text><group><returns/><text><p>An array <expr>({ key, value })</expr>.</p> + </text></group></doc> + <method name='nth'> + <arguments><argument name='n'><type><int><min>0</min><max/></int></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup>   <docgroup homogen-name='object_program' homogen-type='method'><doc><text><p>Return the program from which <ref resolved='predef::object_program.o'>o</ref> was instantiated. If the    object was instantiated from a class using parent references    the generating function will be returned.</p>   <p> If <ref resolved='predef::object_program.o'>o</ref> is not an object or has been destructed <expr>0</expr> (zero)    will be returned.</p>   </text></doc>   <method name='object_program'>   <arguments><argument name='o'><type><mixed/></type></argument></arguments>   <returntype><or><program/><function/></or></returntype>   </method>