autodoc.git / onepage / manual.html

version» Context lines:

autodoc.git/onepage/manual.html:27781:    and the elements from the second stack at the    top of the new stack.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>create</b></span>   </dt> - <dd><p><code><span class='object'>ADT.Stack</span> <span class='class'>ADT.Stack</span><b>(</b><code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code><b>)</b></code></p></dd> + <dd><p><code><span class='object'>ADT.Stack</span> <span class='class'>ADT.Stack</span><b>(</b><code class='datatype'>int(1..)</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>An initial stack size can be given when    a stack is cloned. The default value is    32.</p>   </dd></dl>         <hr />   <dl class='group--doc'>
autodoc.git/onepage/manual.html:27871:    if no value is given. The popped entries are not    actually freed, only the stack pointer is moved.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>reset</b></span>   </dt> - <dd><p><code><code class='datatype'>void</code> <b><span class='method'>reset</span>(</b><code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>reset</span>(</b><code class='datatype'>int(1..)</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Empties the stack, resets the stack pointer    and shrinks the stack size to the given value    or 32 if none is given.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>create</code></p>   </dd></dl>   
autodoc.git/onepage/manual.html:28641:   <dd class='body--doc'><p>Create a new buffer, optionally initialized with the    value <code>s</code>.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>get_bignum</b></span>   </dt> - <dd><p><code><code class='object unresolved'>Gmp.mpz</code> <b><span class='method'>get_bignum</span>(</b><code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>len</code><b>)</b></code></p></dd> + <dd><p><code><code class='object unresolved'>Gmp.mpz</code> <b><span class='method'>get_bignum</span>(</b><code class='datatype'>int(1..)</code>|<code class='datatype'>void</code> <code class='argument'>len</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Reads a bignum written by <code>put_bignum</code> from the buffer.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>get_fix_string</b></span>
autodoc.git/onepage/manual.html:28760:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Return all the data in the buffer and empties it.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>put_bignum</b></span>   </dt> - <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>put_bignum</span>(</b><code class='object unresolved'>Gmp.mpz</code> <code class='argument'>i</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>void</code> <code class='argument'>len_width</code><b>)</b></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>put_bignum</span>(</b><code class='object unresolved'>Gmp.mpz</code> <code class='argument'>i</code>, <code class='datatype'>int(1..)</code>|<code class='datatype'>void</code> <code class='argument'>len_width</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Appends a bignum <code>i</code> as a variable string preceded with an    unsigned integer of the size <code>len_width</code> declaring the length    of the string. <code>len_width</code> defaults to 2.</p>   </dd></dl>         <hr />   <dl class='group--doc'>
autodoc.git/onepage/manual.html:163588:   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>create_process</code>, <code>Tools.Standalone.forkd</code></p>   </dd></dl>      <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>create</b></span>   </dt> - <dd><p><code><span class='object'>Process.Process</span> <span class='class'>Process.Process</span><b>(</b><code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>command_args</code>, <code class='datatype'>void</code>|<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) <code class='argument'>modifiers</code><b>)</b></code></p></dd> + <dd><p><code><span class='object'>Process.Process</span> <span class='class'>Process.Process</span><b>(</b><code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>command_args</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>)|<code class='datatype'>void</code> <code class='argument'>modifiers</code><b>)</b></code></p></dd>      <dt class='head--doc'><span id='p-command_args'></span>Parameter <code class='parameter'>command_args</code></dt>   <dd></dd><dd class='body--doc'><p>Either a command line array, as the command_args    argument to <code>create_process()</code>, or a string that    will be splitted into a command line array by    calling <code>split_quoted_string()</code> in an operating    system dependant mode.</p>   </dd>   <dt class='head--doc'><span id='p-modifiers'></span>Parameter <code class='parameter'>modifiers</code></dt>   <dd></dd><dd class='body--doc'><p>In addition to the modifiers that <code>create_process</code> accepts,
autodoc.git/onepage/manual.html:185055:   Result<span class='delim'>:</span> <span class='ns'>Regexp</span><span class='delim'>.</span>PCRE<span class='delim'>.</span>StudiedWidestring<span class='delim'>(</span><span class='string'>"b(a*)([^-Ê\234]*)(Ê\234*)m"</span><span class='delim'>)</span>   </code></pre>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>replace</b></span>   </dt> - <dd><p><code><code class='datatype'>string</code> <b><span class='method'>replace</span>(</b><code class='datatype'>string</code> <code class='argument'>subject</code>, <code class='datatype'>string</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>with</code>, <code class='datatype'>mixed</code>|<code class='datatype'>void</code> ... <code class='argument'>args</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>replace</span>(</b><code class='datatype'>string</code> <code class='argument'>subject</code>, <code class='datatype'>string</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>with</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>replace all occurances of a pattern in a subject;    callbacks and replacements will be from the first occurance,    not from the last as in Regexp.Builtin.replace.</p>   <p> if with is a function, the first argument will be the total match    string, and the subsequent arguments will contain any submatches</p>   <p> example:</p>   <pre><code><span class='delim'>&gt;</span> <span class='ns'>Regexp</span><span class='delim'>.</span>PCRE<span class='delim'>(</span><span class='string'>"b[^-]*m"</span><span class='delim'>)</span>-&gt;replace<span class='delim'>(</span><span class='string'>"abam-boom-fooabadoom"</span><span class='delim'>,</span><span class='string'>"gurka"</span><span class='delim'>)</span><span class='delim'>;</span>   Result<span class='delim'>:</span> <span class='string'>"agurka-gurka-fooagurka"</span>
autodoc.git/onepage/manual.html:199960:   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>big_typed_query()</code>, <code>streaming_typed_query()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>utf8_encode_query</b></span>   </dt> - <dd><p><code><code class='datatype'>string</code> <b><span class='method'>utf8_encode_query</span>(</b><code class='datatype'>string</code> <code class='argument'>q</code>, <code class='datatype'>function</code>(<code class='datatype'>string</code>, <code class='datatype'>mixed</code>|<code class='datatype'>void</code> ... :<code class='datatype'>string</code>) <code class='argument'>encode_fn</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extras</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>utf8_encode_query</span>(</b><code class='datatype'>string</code> <code class='argument'>q</code>, <code class='datatype'>function</code>(<code class='datatype'>string</code>, <code class='object unresolved'>__unknown__</code> ... :<code class='datatype'>string</code>) <code class='argument'>encode_fn</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extras</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Encodes the appropriate sections of the query with <code>encode_fn</code>.    Everything except strings prefixed by an introducer (i.e.    <code class='expr'>_something</code> or <code class='expr'>N</code>) is encoded.</p>   </dd></dl>   </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Sql.mysql_result</b></h2>   </dt><dd><dl class='group--doc'>   <dt class='head--doc'>Deprecated</dt>   <dd class='body--doc'><p>Replaced by <code>Result</code>.</p>
autodoc.git/onepage/manual.html:202493:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Throw an error in case an unimplemented function is called.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>handle_extraargs</b></span>   </dt> - <dd><p><code><code class='datatype'>array</code>(<code class='datatype'>string</code>|<code class='datatype'>mapping</code>(<code class='datatype'>string</code>|<code class='datatype'>int</code>:<code class='datatype'>mixed</code>)) <b><span class='method'>handle_extraargs</span>(</b><code class='datatype'>string</code> <code class='argument'>query</code>, <code class='datatype'>array</code>(<code class='datatype'>mixed</code>) <code class='argument'>extraargs</code>, <code class='datatype'>void</code>|<code class='datatype'>mapping</code>(<code class='datatype'>string</code>|<code class='datatype'>int</code>:<code class='datatype'>mixed</code>) <code class='argument'>bindings</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>array</code>(<code class='datatype'>string</code>|<code class='datatype'>mapping</code>(<code class='datatype'>string</code>|<code class='datatype'>int</code>:<code class='datatype'>mixed</code>)) <b><span class='method'>handle_extraargs</span>(</b><code class='datatype'>string</code> <code class='argument'>query</code>, <code class='datatype'>array</code>(<code class='datatype'>mixed</code>) <code class='argument'>extraargs</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>|<code class='datatype'>int</code>:<code class='datatype'>mixed</code>)|<code class='datatype'>void</code> <code class='argument'>bindings</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Handle <code>sprintf</code>-based quoted arguments</p>   </dd>   <dt class='head--doc'><span id='p-query'></span>Parameter <code class='parameter'>query</code></dt>   <dd></dd><dd class='body--doc'><p>The query as sent to one of the query functions.</p>   </dd>   <dt class='head--doc'><span id='p-extraargs'></span>Parameter <code class='parameter'>extraargs</code></dt>   <dd></dd><dd class='body--doc'><p>The arguments following the query.</p>   </dd>
autodoc.git/onepage/manual.html:222726:   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Constant</span>   <span class='homogen--name'><b>objtype</b></span>   </dt>   <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>string</code> Tools.AutoDoc.PikeObjects.Enum.<code class='constant'>objtype</code></code></p></dd>   </dl>   </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Tools.AutoDoc.PikeObjects.EnumConstant</b></h2>   </dt><dd><dl class='group--doc'>   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>The values inside <code class='expr'>enum&nbsp;Foo&nbsp;{&nbsp;...&nbsp;}</code></p> + <p> These are currently handled identically to normal constants.</p>   </dd></dl>      <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Inherit</span> - <span class='homogen--name'><b>PikeObject</b></span> + <span class='homogen--name'><b>Constant</b></span>   </dt> - <dd><p><code><span class='datatype'>inherit PikeObject</span> : <span class='inherit'>PikeObject</span></code></p></dd> + <dd><p><code><span class='datatype'>inherit Constant</span> : <span class='inherit'>Constant</span></code></p></dd>   </dl> -  -  - <hr /> - <dl class='group--doc'> - <dt class='head--type'><span class='homogen--type'>Constant</span> - <span class='homogen--name'><b>objtype</b></span> - </dt> - <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>string</code> Tools.AutoDoc.PikeObjects.EnumConstant.<code class='constant'>objtype</code></code></p></dd> - </dl> +    </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Tools.AutoDoc.PikeObjects.FloatType</b></h2>   </dt><dd><dl class='group--doc'>   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>The class for representing the float type.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>Type</code></p>   </dd></dl>      <hr />