Diff of autodoc.git/modref.xml (58eaba3b6eaf22dc5d10620ddd0bf349517cc634 » b0a5b247ceb62fc9073da6c8578a79e02fc10069)

autodoc.git/modref.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='./ignored'> <file name='./ignored/ignored'> <chapter number='1' title='ignored'> <autodoc> <namespace name=''> <doc><text>Symbols implicitly inherited from the virtual base class. These symbols exist mainly to simplify implementation of the corresponding lfuns. </text><group><seealso/><text><ref resolved='lfun::'>lfun::</ref> </text></group></doc>
autodoc.git/modref.xml:15065: <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>An initial stack size can be given when a stack is cloned. The default value is 32. </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>Returns an element from the stack, without popping it. </text><group><param name='offset'/><text>The number of elements from the top of the stack to skip. </text></group><group><throws/><text>Throws an error if called on an empty stack. </text></group><group><seealso/><text><ref resolved='predef::ADT.Stack.top'>top()</ref>
autodoc.git/modref.xml:15123: <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>Empties the stack, resets the stack pointer and shrinks the stack size to the given value or 32 if none is given. </text><group><seealso/><text><ref resolved='predef::ADT.Stack.create'>create</ref> </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>Sets the stacks content to the provided array. </text></doc> <method name='set_stack'> <arguments><argument name='stack'><type><array/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup>
autodoc.git/modref.xml:15834: value <ref resolved='predef::ADT.struct.create.s'>s</ref>. </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>Reads a bignum written by <ref resolved='predef::ADT.struct.put_bignum'>put_bignum</ref> from the buffer. </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>Reads a fixed sized string of length <ref resolved='predef::ADT.struct.get_fix_string.len'>len</ref> from the buffer. </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/modref.xml:15904: <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>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. </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>Appends the fix sized string <ref resolved='predef::ADT.struct.put_fix_string.s'>s</ref> to the buffer. </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/modref.xml:102570: 15 seconds. </text></group><group><member><type><int><min>0</min><max>1</max></int></type><index>"forkd"</index></member><text>Use <ref resolved='predef::Tools.Standalone.forkd'>Tools.Standalone.forkd</ref> to actually spawn the process. </text></group></mapping> </text></group><group><note/><text>The default value for the <expr>"forkd"</expr> modifier may be set via <ref resolved='predef::Process.set_forkd_default'>set_forkd_default()</ref>. </text></group><group><seealso/><text><ref resolved='predef::Process.create_process'>create_process</ref>, <ref resolved='predef::Process.create_process.create'>create_process()->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> </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>Based on <ref resolved='predef::Process.create_process'>create_process</ref>. </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/modref.xml:114226: </text></code>example: <code><text>> Regexp.PCRE("([a-z0-9_\\.-]+)@([\\da-z\\.-]+)\\.([a-z\\.]{2,6})") ->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" </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>replace one (first) occurance of a pattern in a subject example: <code><text>> Regexp.PCRE("b[^-]*m")->replace1("abam-boom-fooabadoom","gurka"); Result: "agurka-boom-fooabadoom" </text></code> </text></doc> <method name='replace1'>
autodoc.git/modref.xml:122397: <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>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. </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> <class name='mysql_result'> <doc><group><deprecated><name><ref resolved='predef::Sql.Result'>Result</ref></name></deprecated></group></doc> </class> <class name='mysqls'> <doc><text>Implements SQL-urls for <tt>mysqls://[user[:password]@][hostname][:port][/database]</tt>
autodoc.git/modref.xml:123609: </text></group><group><param name='extraargs'/><text>The arguments following the query. </text></group><group><param name='bindings'/><text>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. </text></group><group><returns/><text>Returns an array with two elements: <array><group><elem><type><string/></type><index>0</index></elem><text>The query altered to use bindings-syntax. </text></group><group><elem><type><mapping><indextype><or><string/><int/></or></indextype><valuetype><mixed/></valuetype></mapping></type><index>1</index></elem><text>A bindings mapping. Zero if no bindings were added. </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>Quote a string so that it can safely be put in a query. </text><group><param name='s'/><text>String to quote. </text></group></doc> <method name='quote'>
autodoc.git/modref.xml:135443: </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>The values inside <expr>enum Foo { ... }</expr> + These are currently handled identically to normal constants. </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>The class for representing the float type. </text><group><seealso/><text><ref resolved='predef::Tools.AutoDoc.PikeObjects.Type'>Type</ref> </text></group></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><void/></returntype> </method>

autodoc.git / modref.xml