autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2018-03-07' version='Pike v8.1.12'> + <manual time-stamp='2018-03-08' version='Pike v8.1.12'>    <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:2669:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='8.0::Crypto.CBC'>Crypto.CBC</classname></inherit>   </docgroup>   </class>   <class name='DHKeyExchange'>   <doc><text><p>Implements Diffie-Hellman key-exchange.</p>   <p> The following key exchange methods are implemented here: -  <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p> +  <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='p'><type><object resolved='7.8::SSL.Cipher.DHParameters'>DHParameters</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='DHParameters'>   <doc><text><p>Diffie-Hellman parameters.</p>
autodoc.git/onepage.xml:121662:   </text><group><seealso/><text><p><ref resolved='predef::Sql.tds.big_query'>big_query()</ref></p>   </text></group></doc>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='query'><type><string/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   </class>   </module> + <class name='Stack'> + <doc><text><p>This class implements a simple stack. Instead of adding and removing +  elements to an array, and thus making it vary in size for every push +  and pop operation, this stack tries to keep the stack size constant. +  If however the stack risks to overflow, it will allocate double its +  current size, i.e. pushing an element on an full 32 slot stack will +  result in a 64 slot stack with 33 elements.</p> + </text></doc> + <docgroup homogen-name='_search' homogen-type='method'><doc><text><p>Return the stack-depth to <ref resolved='predef::Stack._search.item'>item</ref>.</p> + <p> This function makes it possible to use +  eg <ref resolved='predef::search'>search()</ref> and <ref resolved='predef::has_value'>has_value()</ref> on the stack.</p> + </text></doc> + <method name='_search'> + <arguments><argument name='item'><type><mixed/></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='_sizeof' homogen-type='method'><doc><text><p><ref resolved='predef::sizeof'>sizeof</ref> on a stack returns the number of entries +  in the stack.</p> + </text></doc> + <method name='_sizeof'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='_values' homogen-type='method'><doc><text><p><ref resolved='predef::values'>values</ref> on a stack returns all the entries in +  the stack, in order.</p> + </text></doc> + <method name='_values'> + <arguments/> + <returntype><array/></returntype> + </method> + </docgroup> + <docgroup homogen-name='`+' homogen-type='method'><doc><text><p>A stack added with another stack yields a new +  stack with all the elements from both stacks, +  and the elements from the second stack at the +  top of the new stack.</p> + </text></doc> + <method name='`+'> + <arguments><argument name='s'><type><object resolved='predef::Stack'>this_program</object></type></argument></arguments> + <returntype><object resolved='predef::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'> + <arguments><argument name='initial_size'><type><or><int/><void/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='pop' homogen-type='method'><doc><text><p>Pops and returns entry <ref resolved='predef::Stack.pop.val'>val</ref> from the stack, counting +  from the top. If no value is given the top element is +  popped and returned. All popped entries are freed from +  the stack.</p> + </text></doc> + <method name='pop'> + <arguments><argument name='val'><type><or><void/><int/></or></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup> + <docgroup homogen-name='push' homogen-type='method'><doc><text><p>Push an element on the top of the stack.</p> + </text></doc> + <method name='push'> + <arguments><argument name='val'><type><mixed/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='quick_pop' homogen-type='method'><doc><text><p>Pops <ref resolved='predef::Stack.quick_pop.val'>val</ref> entries from the stack, or one entry +  if no value is given. The popped entries are not +  returned.</p> + </text></doc> + <method name='quick_pop'> + <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::Stack.create'>create</ref></p> + </text></group></doc> + <method name='reset'> + <arguments><argument name='initial_size'><type><or><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> + <docgroup homogen-name='top' homogen-type='method'><doc><text><p>Returns the top element from the stack, without +  popping it.</p> + </text><group><throws/><text><p>Throws an error if called on an empty stack.</p> + </text></group></doc> + <method name='top'> + <arguments/> + <returntype><mixed/></returntype> + </method> + </docgroup> + </class>   <module name='Standards'>   <module name='ASN1'>   <docgroup homogen-name='decode_der_oid' homogen-type='method'><doc><text><p>Convenience function to convert a DER/BER encoded oid (object    identifier) to the human readable dotted-decimal form.</p>   </text><group><seealso/><text><p><ref resolved='predef::Standards.ASN1.encode_der_oid'>encode_der_oid</ref></p>   </text></group></doc>   <method name='decode_der_oid'>   <arguments><argument name='der_oid'><type><string/></type></argument></arguments>   <returntype><string/></returntype>   </method>