autodoc.git / traditional.xml

version» Context lines:

autodoc.git/traditional.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2022-11-06' version='Pike v8.1.19'> + <manual time-stamp='2022-11-20' version='Pike v8.1.19'>    <dir name='./traditional_manual'>    <file name='./traditional_manual/index.html'>    <chapter title='Table of Contents' unnumbered='1'>    <dl><dt><url href='index.html'>Table of Contents</url></dt>   <dt><url href='chapter_1.html'>1. Introduction</url></dt>   <dd><url href='chapter_1.html#1.1'>1.1. Overview</url></dd>   <dd><url href='chapter_1.html#1.2'>1.2. The history of Pike</url></dd>   <dd><url href='chapter_1.html#1.3'>1.3. A comparison with other languages</url></dd>   <dd><url href='chapter_1.html#1.4'>1.4. What is Pike</url></dd>   <dd><url href='chapter_1.html#1.5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:15413:   <method name='`+'><modifiers><protected/></modifiers>   <arguments><argument name='s'><type><object resolved='predef::ADT.Stack'>this_program</object></type></argument></arguments>   <returntype><object resolved='predef::ADT.Stack'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><text><p>An initial stack size can be given when    a stack is cloned. The default value is    32.</p>   </text></doc>   <method name='create'><modifiers><protected/></modifiers> - <arguments><argument name='initial_size'><type><or><int/><void/></or></type></argument></arguments> + <arguments><argument name='initial_size'><type><or><int><min>1</min><max/></int><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='peek' homogen-type='method'><doc><text><p>Returns an element from the stack, without popping it.</p>   </text><group><param name='offset'/><text><p>The number of elements from the top of the stack to skip.</p>   </text></group><group><throws/><text><p>Throws an error if called on an empty stack.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::ADT.Stack.top'>top()</ref></p>
autodoc.git/traditional.xml:15471:   <arguments><argument name='val'><type><or><void/><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='reset' homogen-type='method'><doc><text><p>Empties the stack, resets the stack pointer    and shrinks the stack size to the given value    or 32 if none is given.</p>   </text><group><seealso/><text><p><ref resolved='predef::ADT.Stack.create'>create</ref></p>   </text></group></doc>   <method name='reset'> - <arguments><argument name='initial_size'><type><or><int/><void/></or></type></argument></arguments> + <arguments><argument name='initial_size'><type><or><int><min>1</min><max/></int><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='set_stack' homogen-type='method'><doc><text><p>Sets the stacks content to the provided array.</p>   </text></doc>   <method name='set_stack'>   <arguments><argument name='stack'><type><array/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>
autodoc.git/traditional.xml:16182:    value <ref resolved='predef::ADT.struct.create.s'>s</ref>.</p>   </text></doc>   <method name='create'>   <arguments><argument name='s'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument></arguments>   <returntype><attribute><prefix/><attribute>"deprecated"</attribute><subtype><void/></subtype></attribute></returntype>   </method>   </docgroup>   <docgroup homogen-name='get_bignum' homogen-type='method'><doc><text><p>Reads a bignum written by <ref resolved='predef::ADT.struct.put_bignum'>put_bignum</ref> from the buffer.</p>   </text></doc>   <method name='get_bignum'> - <arguments><argument name='len'><type><or><int/><void/></or></type></argument></arguments> + <arguments><argument name='len'><type><or><int><min>1</min><max/></int><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='get_fix_string' homogen-type='method'><doc><text><p>Reads a fixed sized string of length <ref resolved='predef::ADT.struct.get_fix_string.len'>len</ref> from the buffer.</p>   </text></doc>   <method name='get_fix_string'>   <arguments><argument name='len'><type><int/></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>   </docgroup>
autodoc.git/traditional.xml:16252:   <method name='pop_data'>   <arguments/>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>   </docgroup>   <docgroup homogen-name='put_bignum' homogen-type='method'><doc><text><p>Appends a bignum <ref resolved='predef::ADT.struct.put_bignum.i'>i</ref> as a variable string preceded with an    unsigned integer of the size <ref resolved='predef::ADT.struct.put_bignum.len_width'>len_width</ref> declaring the length    of the string. <ref resolved='predef::ADT.struct.put_bignum.len_width'>len_width</ref> defaults to 2.</p>   </text></doc>   <method name='put_bignum'> - <arguments><argument name='i'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument><argument name='len_width'><type><or><int><min>0</min><max/></int><void/></or></type></argument></arguments> + <arguments><argument name='i'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument><argument name='len_width'><type><or><int><min>1</min><max/></int><void/></or></type></argument></arguments>   <returntype><object resolved='predef::ADT.struct'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='put_fix_string' homogen-type='method'><doc><text><p>Appends the fix sized string <ref resolved='predef::ADT.struct.put_fix_string.s'>s</ref> to the buffer.</p>   </text></doc>   <method name='put_fix_string'>   <arguments><argument name='s'><type><string><min>0</min><max>255</max></string></type></argument></arguments>   <returntype><object resolved='predef::ADT.struct'>this_program</object></returntype>   </method>   </docgroup>
autodoc.git/traditional.xml:46968:   <method name='streaming_typed_query'><modifiers><variant/></modifiers>   <arguments><argument name='query'><type><string/></type></argument><argument name='bindings'><type><or><mapping><indextype><or><string/><int/></or></indextype><valuetype><mixed/></valuetype></mapping><void/></or></type></argument><argument name='charset'><type><or><void/><string/></or></type></argument></arguments>   <returntype><object resolved='predef::Mysql.mysql.Result'>Result</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='utf8_encode_query' homogen-type='method'><doc><text><p>Encodes the appropriate sections of the query with <ref resolved='predef::Sql.mysql.utf8_encode_query.encode_fn'>encode_fn</ref>.    Everything except strings prefixed by an introducer (i.e.    <expr>_something</expr> or <expr>N</expr>) is encoded.</p>   </text></doc>   <method name='utf8_encode_query'> - <arguments><argument name='q'><type><string/></type></argument><argument name='encode_fn'><type><function><argtype><string/></argtype><argtype><varargs><or><mixed/><void/></or></varargs></argtype><returntype><string/></returntype></function></type></argument><argument name='extras'><type><varargs><mixed/></varargs></type></argument></arguments> + <arguments><argument name='q'><type><string/></type></argument><argument name='encode_fn'><type><function><argtype><string/></argtype><argtype><varargs><object>__unknown__</object></varargs></argtype><returntype><string/></returntype></function></type></argument><argument name='extras'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>   </class></module></namespace></autodoc>    <autodoc hidden='1'><namespace hidden='1' name='predef'><module hidden='1' name='Sql'><class name='mysqls'>   <doc><text><p>Implements SQL-urls for    <tt>mysqls://[user[:password]@][hostname][:port][/database]</tt></p>   <p> Sets the connection to SSL-mode, and sets the default configuration    file to <expr>"/etc/my.cnf"</expr>.</p>   </text><group><fixme/><text><p>Ought to load a suitable default configuration file for Win32 too.</p>
autodoc.git/traditional.xml:50306:   </text></group><group><param name='extraargs'/><text><p>The arguments following the query.</p>   </text></group><group><param name='bindings'/><text><p>Optional bindings mapping to which additional bindings will be    added. It's returned as the second element in the return value.    A new mapping is used if this isn't specified.</p>   </text></group><group><returns/><text><p>Returns an array with two elements:</p>   <array><group><elem><type><string/></type><index>0</index></elem><text><p>The query altered to use bindings-syntax.</p>   </text></group><group><elem><type><mapping><indextype><or><string/><int/></or></indextype><valuetype><mixed/></valuetype></mapping></type><index>1</index></elem><text><p>A bindings mapping. Zero if no bindings were added.</p>   </text></group></array>   </text></group></doc>   <method name='handle_extraargs'> - <arguments><argument name='query'><type><string/></type></argument><argument name='extraargs'><type><array><valuetype><mixed/></valuetype></array></type></argument><argument name='bindings'><type><or><void/><mapping><indextype><or><string/><int/></or></indextype><valuetype><mixed/></valuetype></mapping></or></type></argument></arguments> + <arguments><argument name='query'><type><string/></type></argument><argument name='extraargs'><type><array><valuetype><mixed/></valuetype></array></type></argument><argument name='bindings'><type><or><mapping><indextype><or><string/><int/></or></indextype><valuetype><mixed/></valuetype></mapping><void/></or></type></argument></arguments>   <returntype><array><valuetype><or><string/><mapping><indextype><or><string/><int/></or></indextype><valuetype><mixed/></valuetype></mapping></or></valuetype></array></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='quote' homogen-type='method'><doc><text><p>Quote a string so that it can safely be put in a query.</p>   </text><group><param name='s'/><text><p>String to quote.</p>   </text></group></doc>   <method name='quote'>
autodoc.git/traditional.xml:126259:    15 seconds.</p>   </text></group><group><member><type><int><min>0</min><max>1</max></int></type><index>"forkd"</index></member><text><p>Use <ref resolved='predef::Tools.Standalone.forkd'>Tools.Standalone.forkd</ref> to actually spawn the process.</p>   </text></group></mapping>   </text></group><group><note/><text><p>The default value for the <expr>"forkd"</expr> modifier may be    set via <ref resolved='predef::Process.set_forkd_default'>set_forkd_default()</ref>.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Process.create_process'>create_process</ref>, <ref resolved='predef::Process.create_process.create'>create_process()-&gt;create()</ref>,    <ref resolved='predef::Process.split_quoted_string'>split_quoted_string()</ref>, <ref resolved='predef::Tools.Standalone.forkd'>Tools.Standalone.forkd</ref>,    <ref resolved='predef::Process.set_forkd_default'>set_forkd_default()</ref>, <ref resolved='predef::Process.get_forkd_default'>get_forkd_default()</ref></p>   </text></group></doc>   <method name='create'><modifiers><protected/></modifiers> - <arguments><argument name='command_args'><type><or><string/><array><valuetype><string/></valuetype></array></or></type></argument><argument name='modifiers'><type><or><void/><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></or></type></argument></arguments> + <arguments><argument name='command_args'><type><or><string/><array><valuetype><string/></valuetype></array></or></type></argument><argument name='modifiers'><type><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='create_process' homogen-type='inherit'><doc><text><p>Based on <ref resolved='predef::Process.create_process'>create_process</ref>.</p>   </text></doc>   <inherit name='create_process'><classname resolved='predef::Process.create_process'>create_process</classname></inherit>   </docgroup>   </class>   <class name='Spawn'>   <docgroup homogen-name='create' homogen-type='method'>
autodoc.git/traditional.xml:127102:   </text></code><p>example:</p>   <code><text><p>&gt; Regexp.PCRE("([a-z0-9_\\.-]+)@([\\da-z\\.-]+)\\.([a-z\\.]{2,6})")    -&gt;replace("foo@bar.org",    lambda(string whole, string user, string loc, string domain)    { return user + " from " + loc + " dot " + domain; }    );    (4) Result: "foo from bar dot org"</p>   </text></code>   </text></doc>   <method name='replace'> - <arguments><argument name='subject'><type><string/></type></argument><argument name='with'><type><or><string/><function/></or></type></argument><argument name='args'><type><varargs><or><mixed/><void/></or></varargs></type></argument></arguments> + <arguments><argument name='subject'><type><string/></type></argument><argument name='with'><type><or><string/><function/></or></type></argument><argument name='args'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='replace1' homogen-type='method'><doc><text><p>replace one (first) occurance of a pattern in a subject</p>   <p> example:</p>   <code><text><p>&gt; Regexp.PCRE("b[^-]*m")-&gt;replace1("abam-boom-fooabadoom","gurka");    Result: "agurka-boom-fooabadoom"</p>   </text></code>   </text></doc>   <method name='replace1'>
autodoc.git/traditional.xml:137702:   </docgroup>   <docgroup homogen-name='PikeObject' homogen-type='inherit'>   <inherit name='PikeObject'><classname resolved='predef::Tools.AutoDoc.PikeObjects.PikeObject'>PikeObject</classname></inherit>   </docgroup>   <docgroup homogen-name='objtype' homogen-type='constant'>   <constant name='objtype'><type><string/></type></constant>   </docgroup>   </class>   <class name='EnumConstant'>   <doc><text><p>The values inside <expr>enum Foo { ... }</expr></p> + <p> These are currently handled identically to normal constants.</p>   </text></doc> - <docgroup homogen-name='PikeObject' homogen-type='inherit'> - <inherit name='PikeObject'><classname resolved='predef::Tools.AutoDoc.PikeObjects.PikeObject'>PikeObject</classname></inherit> + <docgroup homogen-name='Constant' homogen-type='inherit'> + <inherit name='Constant'><classname resolved='predef::Tools.AutoDoc.PikeObjects.Constant'>Constant</classname></inherit>   </docgroup> - <docgroup homogen-name='objtype' homogen-type='constant'> - <constant name='objtype'><type><string/></type></constant> - </docgroup> +    </class>   <class name='FloatType'>   <doc><text><p>The class for representing the float type.</p>   </text><group><seealso/><text><p><ref resolved='predef::Tools.AutoDoc.PikeObjects.Type'>Type</ref></p>   </text></group></doc>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments/>   <returntype><void/></returntype>   </method>