autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2021-05-27' version='Pike v8.1.14'> + <manual time-stamp='2021-05-30' version='Pike v8.1.14'>    <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:15274:   <method name='append'>   <arguments><argument name='values'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='cast' homogen-type='method'><doc><text><p>Cast the lists. <expr>array</expr> is the only    supported type.</p>   </text></doc>   <method name='cast'>   <arguments><argument name='type'><type><string/></type></argument></arguments> - <returntype><array/></returntype> + <returntype><or><array/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Create a new <ref resolved='predef::ADT.List'>List</ref>, and initialize it with <ref resolved='predef::ADT.List.create.values'>values</ref>.</p>   </text></doc>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='values'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='flush' homogen-type='method'><doc><text><p>Empties the List.</p>
autodoc.git/onepage.xml:18322:   </module>   </module>   <module name='Builtin'>   <docgroup homogen-name='_get_setter' homogen-type='method'><doc><text><p>Get a setter for the variable named <ref resolved='predef::Builtin._get_setter.varname'>varname</ref> in object <ref resolved='predef::Builtin._get_setter.o'>o</ref>.</p>   </text><group><returns/><text><p>Returns a <ref resolved='predef::Builtin.Setter.`()'>Setter()-&gt;`()()</ref> for the variable if it exists,    and <expr>UNDEFINED</expr> otherwise.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::object_variablep'>object_variablep()</ref></p>   </text></group></doc>   <method name='_get_setter'>   <arguments><argument name='o'><type><object resolved='predef::Builtin._get_setter'/></type></argument><argument name='varname'><type><string/></type></argument></arguments> - <returntype><function><argtype><object>mixed_void</object></argtype></function></returntype> + <returntype><or><function><argtype><object>mixed_void</object></argtype></function><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='_take_over_initial_predefines' homogen-type='method'><doc><text><p>Returns a mapping containing the set of predefined macros.    These are typically the macros defined via the <tt>-D</tt> option    when starting Pike.</p>   <p> This function is typically called by the <ref resolved='predef::MasterObject'>MasterObject</ref> at    initialization, and may only be called once. After it has been called,    <ref resolved='predef::cpp'>cpp()</ref> will start calling <ref resolved='predef::CompilationHandler.get_predefines'>CompilationHandler-&gt;get_predefines()</ref> to    retrieve the set of predefined macros.</p>   </text><group><seealso/><text><p>[cpp()], <ref resolved='predef::CompilationHandler.get_predefines'>CompilationHandler-&gt;get_predefines()</ref></p>
autodoc.git/onepage.xml:127369:    public keys must be set.</p>   </text></group><group><param name='name'/><text><p>The distinguished name for the certificate.</p>   </text></group><group><param name='attributes'/><text><p>Attributes from PKCS #9 to add to the certificate.</p>   </text></group><group><param name='hash'/><text><p>Hash algoritm to use for the CSR signature.    Defaults to <ref resolved='predef::Crypto.SHA256'>Crypto.SHA256</ref>.</p>   </text></group><group><note/><text><p>Prior to Pike 8.0 this function only supported signing    with <ref resolved='predef::Crypto.RSA'>Crypto.RSA</ref> and the default (and only) hash was    <ref resolved='predef::Crypto.MD5'>Crypto.MD5</ref>.</p>   </text></group></doc>   <method name='build_csr'> - <arguments><argument name='sign'><type><object resolved='predef::Crypto.Sign'>Crypto.Sign</object></type></argument><argument name='name'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='attributes'><type><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></array></valuetype></mapping></type></argument><argument name='hash'><type><or><object resolved='predef::Crypto.Hash'>Crypto.Hash</object><void/></or></type></argument></arguments> + <arguments><argument name='sign'><type><object resolved='predef::Crypto.Sign'>Crypto.Sign</object></type></argument><argument name='name'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='attributes'><type><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Object'>Object</object></valuetype></array></valuetype></mapping></type></argument><argument name='hash'><type><or><object resolved='predef::Crypto.Hash'>Crypto.Hash</object><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='Types' homogen-type='import'>   <import name='Types'><classname resolved='predef::Standards.ASN1.Types'>Standards.ASN1.Types</classname></import>   </docgroup>   <docgroup homogen-name='sign_cri' homogen-type='method'><doc><text><p>Sign a <ref resolved='predef::Standards.PKCS.CSR.CRI'>CRI</ref> to generate a Certificate Signing Request.</p>
autodoc.git/onepage.xml:127819:   <p>Setting</p>   <p> The signature.</p>   </text></doc>   <variable name='signature'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable>   </docgroup>   <docgroup homogen-name='tbs' homogen-type='variable'><doc><text><p>Getting</p>   <p> ASN.1 structure that has been signed.</p>   <p>Setting</p>   <p> ASN.1 structure that has been signed.</p>   </text></doc> - <variable name='tbs'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></variable> + <variable name='tbs'><type><object resolved='predef::Object'>Object</object></type></variable>   </docgroup>   </class>   </module>   </module>   <module name='TLD'>   <docgroup homogen-name='cc' homogen-type='constant'><doc><text><p>A mapping between country TLDs and the name of the country.</p>   </text></doc>   <constant name='cc'/>   </docgroup>   <docgroup homogen-name='generic' homogen-type='variable'><doc><text><p>A multiset containing the generic TLDs, such as "com" and "info".</p>
autodoc.git/onepage.xml:128340:   <method name='load_authorities'>   <arguments><argument name='root_cert_dirs'><type><or><string/><array><valuetype><string/></valuetype></array><void/></or></type></argument><argument name='cache'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments>   <returntype><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Standards.X509.Verifier'>Verifier</object></valuetype></array></valuetype></mapping></returntype>   </method>   </docgroup>   <docgroup homogen-name='make_extension' homogen-type='method'><doc><text><p>Creates a certificate extension with the <ref resolved='predef::Standards.X509.make_extension.id'>id</ref> as identifier and    <ref resolved='predef::Standards.X509.make_extension.ext'>ext</ref> as the extension payload. If the <ref resolved='predef::Standards.X509.make_extension.critical'>critical</ref> flag is set    the extension will be marked as critical.</p>   </text></doc>   <method name='make_extension'> - <arguments><argument name='id'><type><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></type></argument><argument name='ext'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></argument><argument name='critical'><type><or><void/><int/></or></type></argument></arguments> + <arguments><argument name='id'><type><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></type></argument><argument name='ext'><type><object resolved='predef::Object'>Object</object></type></argument><argument name='critical'><type><or><void/><int/></or></type></argument></arguments>   <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='make_selfsigned_certificate' homogen-type='method'><doc><text><p>Creates a selfsigned certificate, i.e. where issuer and subject    are the same entity. This entity is derived from the list of pairs    in <ref resolved='predef::Standards.X509.make_selfsigned_certificate.name'>name</ref>, which is encoded into an distinguished_name by    <ref resolved='predef::Standards.PKCS.Certificate.build_distinguished_name'>Standards.PKCS.Certificate.build_distinguished_name</ref>.</p>   </text><group><param name='c'/><text><p>The public key cipher used for the certificate, <ref resolved='predef::Crypto.RSA'>Crypto.RSA</ref>,    <ref resolved='predef::Crypto.DSA'>Crypto.DSA</ref> or <ref resolved='predef::Crypto.ECC.Curve.ECDSA'>Crypto.ECC.Curve.ECDSA</ref>. The object should be    initialized with both public and private keys.</p>
autodoc.git/onepage.xml:128650:   </docgroup>   <docgroup homogen-name='ext_subjectKeyIdentifier' homogen-type='variable'><doc><text><p>Set to the value of the SubjectKeyIdentifier if the certificate    contains the subjectKeyIdentifier    extension. <rfc>3280:4.2.1.2</rfc>.</p>   </text></doc>   <variable name='ext_subjectKeyIdentifier'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group><group><note/><text><p>Read only</p>   </text></group></doc> - <variable name='extensions'><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></mapping></type></variable> + <variable name='extensions'><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Object'>Object</object></valuetype></mapping></type></variable>   </docgroup>   <docgroup homogen-name='hash' homogen-type='variable'><doc><text><p>Algorithm hash if known and supported.    Otherwise <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref>.</p>   </text><group><note/><text><p>Read only</p>   </text></group></doc>   <variable name='hash'><type><object resolved='predef::Crypto.Hash'>Crypto.Hash</object></type></variable>   </docgroup>   <docgroup homogen-name='Sequence' homogen-type='inherit'>   <inherit name='Sequence'><classname resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</classname></inherit>   </docgroup>   <docgroup homogen-name='init' homogen-type='method'><doc><text><p>Populates the object from a certificate decoded into an ASN.1    Object. Returns the object on success, otherwise <expr>0</expr>. You    probably want to call <ref resolved='predef::Standards.X509.decode_certificate'>decode_certificate</ref> or even    <ref resolved='predef::Standards.X509.verify_certificate'>verify_certificate</ref>.</p>   </text></doc>   <method name='init'> - <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></or></type></argument></arguments> + <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Object'>Object</object></or></type></argument></arguments>   <returntype><object resolved='predef::Standards.X509.TBSCertificate'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='internal_critical' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc>   <variable name='internal_critical'><modifiers><protected/></modifiers><type><multiset/></type></variable>   </docgroup>   <docgroup homogen-name='internal_extensions' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc> - <variable name='internal_extensions'><modifiers><protected/></modifiers><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></mapping></type></variable> + <variable name='internal_extensions'><modifiers><protected/></modifiers><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Object'>Object</object></valuetype></mapping></type></variable>   </docgroup>   <docgroup homogen-name='issuer' homogen-type='variable'><doc><text><p>Certificate issuer.</p>   </text></doc>   <variable name='issuer'><type><void/></type></variable>   </docgroup>   <docgroup homogen-name='issuer_id' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc>   <variable name='issuer_id'><type><void/></type></variable>   </docgroup>   <docgroup homogen-name='issuer_str' homogen-type='method'><doc><text><p>Return the issuer of the certificate as a human readable string.
autodoc.git/onepage.xml:132446:   </text></doc>   <docgroup homogen-name='_decode' homogen-type='method'>   <method name='_decode'>   <arguments><argument name='encoded'><type><or><array><valuetype><string/></valuetype></array><int><min>0</min><max>0</max></int></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='_encode' homogen-type='method'>   <method name='_encode'>   <arguments/> - <returntype><array><valuetype><string/></valuetype></array></returntype> + <returntype><or><array><valuetype><string/></valuetype></array><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='`()' homogen-type='method'>   <method name='`()'>   <arguments><argument name='str'><type><string/></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><group><note/><text><p>May be called with either zero or two arguments.</p>   </text></group></doc>
autodoc.git/onepage.xml:134389:   <class name='TM'>   <doc><text><p>A wrapper for the system struct tm time keeping structure.    This can be used as a (very) lightweight alternative to Calendar.</p>   </text></doc>   <docgroup homogen-name='asctime' homogen-type='method'><doc><text><p>Return a string representing the time. Mostly useful for debug    purposes, the exact format is very locale (see    <ref>Gettext.setlocale</ref>) and OS dependent.</p>   </text></doc>   <method name='asctime'>   <arguments/> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='cast' homogen-type='method'><doc><text><p>Casted to an integer <ref resolved='predef::System.TM.unix_time'>unix_time</ref> will be returned.</p>   <p> Casting to a string will call <ref resolved='predef::System.TM.asctime'>asctime</ref>.</p>   </text></doc>   <method name='cast'>   <arguments><argument name='to'><type><string/></type></argument></arguments>   <returntype><or><int/><string/></or></returntype>   </method>   </docgroup>
autodoc.git/onepage.xml:134507:   </text></doc>   <variable name='wday'><type><int/></type></variable>   </docgroup>   <docgroup homogen-name='yday' homogen-type='variable'><doc><text><p>The day of the year, from 0 (the first day) to 365    This is calculated from the other fields and can not be changed directly.</p>   </text></doc>   <variable name='yday'><type><int/></type></variable>   </docgroup>   <docgroup homogen-name='zone' homogen-type='variable'><doc><text><p>The timezone of this structure</p>   </text></doc> - <variable name='zone'><type><string/></type></variable> + <variable name='zone'><type><or><string/><zero/></or></type></variable>   </docgroup>   </class>   <class name='Time'>   <doc><text><p>The current time as a structure containing a sec and a usec    member.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'><doc><text><p>If <ref resolved='predef::System.Time.create.fast'>fast</ref> is true, do not request a new time from the system,    instead use the global current time variable.</p>   <p> This will only work in callbacks, but can save significant amounts    of CPU.</p>