Diff of autodoc.git/traditional.xml (1ca110d07d5b9aa6ca351f3032d227449ae641c0 » c4d7bb9381b723b9a71528a4a790f6e635fec245)

autodoc.git/traditional.xml:1: <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2018-07-02' version='Pike v8.1.13'> + <manual time-stamp='2018-07-07' version='Pike v8.1.13'> <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. Overview</url></dd> <dd><url href='chapter_1.html#2'>1.2. The history of Pike</url></dd> <dd><url href='chapter_1.html#3'>1.3. A comparison with other languages</url></dd> <dd><url href='chapter_1.html#4'>1.4. What is Pike</url></dd> <dd><url href='chapter_1.html#5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:98188: <returntype><program/></returntype> </method> </docgroup> <docgroup homogen-name='Reporter' homogen-type='inherit'><doc><text>Implements the <ref resolved='predef::Reporter'>Reporter</ref> API. </text><group><seealso/><text><ref resolved='predef::Reporter.report'>Reporter()->report()</ref>, <ref resolved='predef::Reporter.SeverityLevel'>Reporter()->SeverityLevel</ref> </text></group></doc> <inherit name='Reporter'><classname resolved='predef::Reporter'>Reporter</classname></inherit> </docgroup> <docgroup homogen-name='resolv' homogen-type='method'><doc><text>Look up <ref resolved='predef::CompilerEnvironment.resolv.identifier'>identifier</ref> in the current context. The default implementation calls the corresponding - function in the master object. - </text></doc> + function in the handlers (if any), falling back to + the master object. + </text><group><returns/><text>Returns the value of the <ref resolved='predef::CompilerEnvironment.resolv.identifier'>identifier</ref> if found, and + <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref> if not. + </text></group></doc> <method name='resolv'> - <arguments><argument name='identifier'><type><string/></type></argument><argument name='filename'><type><string/></type></argument><argument name='handler'><type><or><object resolved='predef::CompilerEnvironment.resolv'/><void/></or></type></argument></arguments> + <arguments><argument name='identifier'><type><string/></type></argument><argument name='filename'><type><string/></type></argument><argument name='handler'><type><or><object resolved='predef::CompilerEnvironment.resolv'/><void/></or></type></argument><argument name='compat_handler'><type><or><object resolved='predef::CompilerEnvironment.resolv'/><void/></or></type></argument></arguments> <returntype><mixed/></returntype> </method> </docgroup> <class name='PikeCompiler'> <doc><text>The Pike compiler. An object of this class compiles a single string of Pike code. </text></doc> <docgroup homogen-name='apply_attribute_constant' homogen-type='method'><doc><text>Handle constant arguments to attributed function argument types. </text><group><param name='attr'/><text>Attribute that <ref resolved='predef::CompilerEnvironment.PikeCompiler.apply_attribute_constant.arg_type'>arg_type</ref> had.
autodoc.git/traditional.xml:98388: </text><group><note/><text>In Pike 7.8 and earlier the report() function was not called in the handlers. </text></group><group><seealso/><text><ref resolved='predef::Reporter.report'>CompilerEnvironment()->report()</ref> </text></group></doc> <method name='report'> <arguments><argument name='severity'><type><object resolved='predef::Reporter.SeverityLevel'>SeverityLevel</object></type></argument><argument name='filename'><type><string/></type></argument><argument name='linenumber'><type><int/></type></argument><argument name='subsystem'><type><string/></type></argument><argument name='message'><type><string/></type></argument><argument name='extra_args'><type><varargs><mixed/></varargs></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='resolv' homogen-type='method'><doc><text>Resolve the symbol <ref resolved='predef::CompilerEnvironment.PikeCompiler.resolv.identifier'>identifier</ref>. - The default implementation calls the corresponding function - in any active handler, and otherwise falls back to - <ref resolved='predef::CompilerEnvironment.resolv'>CompilerEnvironment()->resolv()</ref> in the parent object. - </text></doc> + The default implementation calls <ref resolved='predef::CompilerEnvironment.resolv'>CompilerEnvironment()->resolv()</ref> + in the parent object, with the remaining arguments taken from the + current <ref resolved='predef::CompilerEnvironment.PikeCompiler'>PikeCompiler</ref> context. + </text><group><returns/><text>Returns the value of <ref>sym</ref> if found, and <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref> if not. + </text></group></doc> <method name='resolv'> - <arguments><argument name='identifier'><type><string/></type></argument><argument name='filename'><type><string/></type></argument><argument name='handler'><type><object resolved='predef::CompilerEnvironment.PikeCompiler.resolv'/></type></argument></arguments> + <arguments><argument name='identifier'><type><string/></type></argument></arguments> <returntype><mixed/></returntype> </method> </docgroup> <class name='CompilerState'> <doc><text>Keeps the state of a single program/class during compilation. </text><group><note/><text>Not in use yet! </text></group></doc> </class> </class> <class name='lock'>
autodoc.git/traditional.xml:113382: <method name='remove_program_path'> <arguments><argument name='tmp'><type><string/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='resolv' homogen-type='method'><doc><text>Resolve the <ref resolved='predef::MasterObject.CompatResolver.resolv.identifier'>identifier</ref> expression. </text><group><returns/><text>Returns the value of the <ref resolved='predef::MasterObject.CompatResolver.resolv.identifier'>identifier</ref> if it exists, and <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref> otherwise. </text></group></doc> <method name='resolv'> - <arguments><argument name='identifier'><type><string/></type></argument><argument name='current_file'><type><or><string/><void/></or></type></argument><argument name='current_handler'><type><or><object resolved='predef::MasterObject.CompatResolver.resolv'/><void/></or></type></argument></arguments> + <arguments><argument name='identifier'><type><string/></type></argument><argument name='current_file'><type><or><string/><void/></or></type></argument><argument name='current_handler'><type><or><object resolved='predef::MasterObject.CompatResolver.resolv'/><void/></or></type></argument><argument name='current_compat_handler'><type><or><object resolved='predef::MasterObject.CompatResolver.resolv'/><void/></or></type></argument></arguments> <returntype><mixed/></returntype> </method> </docgroup> <docgroup homogen-name='resolv_base' homogen-type='method'><doc><text>Look up <ref resolved='predef::MasterObject.CompatResolver.resolv_base.identifier'>identifier</ref> in the root module. </text></doc> <method name='resolv_base'> - <arguments><argument name='identifier'><type><string/></type></argument><argument name='current_file'><type><or><string/><void/></or></type></argument><argument name='current_handler'><type><or><object resolved='predef::MasterObject.CompatResolver.resolv_base'/><void/></or></type></argument></arguments> + <arguments><argument name='identifier'><type><string/></type></argument><argument name='current_file'><type><or><string/><void/></or></type></argument><argument name='current_handler'><type><or><object resolved='predef::MasterObject.CompatResolver.resolv_base'/><void/></or></type></argument><argument name='current_compat_handler'><type><or><object resolved='predef::MasterObject.CompatResolver.resolv_base'/><void/></or></type></argument></arguments> <returntype><mixed/></returntype> </method> </docgroup> <docgroup homogen-name='resolv_or_error' homogen-type='method'><doc><text>Same as <ref resolved='predef::MasterObject.CompatResolver.resolv'>resolv</ref>, but throws an error instead of returning <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref> if the resolv failed. </text></doc> <method name='resolv_or_error'> <arguments><argument name='identifier'><type><string/></type></argument><argument name='current_file'><type><or><string/><void/></or></type></argument><argument name='current_handler'><type><or><void/><object resolved='predef::MasterObject.CompatResolver.resolv_or_error'/></or></type></argument></arguments> <returntype><mixed/></returntype> </method>
autodoc.git/traditional.xml:127503: public keys must be set. </text></group><group><param name='name'/><text>The distinguished name for the certificate. </text></group><group><param name='attributes'/><text>Attributes from PKCS #9 to add to the certificate. </text></group><group><param name='hash'/><text>Hash algoritm to use for the CSR signature. Defaults to <ref resolved='predef::Crypto.SHA256'>Crypto.SHA256</ref>. </text></group><group><note/><text>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>. </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::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::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> <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>Sign a <ref resolved='predef::Standards.PKCS.CSR.CRI'>CRI</ref> to generate a Certificate Signing Request.
autodoc.git/traditional.xml:127953: Setting The signature. </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>Getting ASN.1 structure that has been signed. Setting ASN.1 structure that has been signed. </text></doc> - <variable name='tbs'><type><object resolved='predef::Object'>Object</object></type></variable> + <variable name='tbs'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></variable> </docgroup> </class> </module> </module> <module name='TLD'> <docgroup homogen-name='cc' homogen-type='constant'><doc><text>A mapping between country TLDs and the name of the country. </text></doc> <constant name='cc'/> </docgroup> <docgroup homogen-name='generic' homogen-type='variable'><doc><text>A multiset containing the generic TLDs, such as "com" and "info".
autodoc.git/traditional.xml:128465: <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>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. </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::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::Standards.ASN1.Types.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>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>. </text><group><param name='c'/><text>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.
autodoc.git/traditional.xml:128749: </docgroup> <docgroup homogen-name='ext_subjectKeyIdentifier' homogen-type='variable'><doc><text>Set to the value of the SubjectKeyIdentifier if the certificate contains the subjectKeyIdentifier extension. <rfc>3280:4.2.1.2</rfc>. </text></doc> <variable name='ext_subjectKeyIdentifier'><type><string/></type></variable> </docgroup> <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text>optional </text></group><group><note/><text>Read only </text></group></doc> - <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> + <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> </docgroup> <docgroup homogen-name='hash' homogen-type='variable'><doc><text>Algorithm hash if known and supported. Otherwise <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref>. </text><group><note/><text>Read only </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>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>. </text></doc> <method name='init'> - <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Object'>Object</object></or></type></argument></arguments> + <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Standards.ASN1.Types.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>optional </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>optional </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::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::Standards.ASN1.Types.Object'>Object</object></valuetype></mapping></type></variable> </docgroup> <docgroup homogen-name='issuer' homogen-type='variable'><doc><text>Certificate issuer. </text></doc> <variable name='issuer'><type><void/></type></variable> </docgroup> <docgroup homogen-name='issuer_id' homogen-type='variable'><doc><group><note/><text>optional </text></group></doc> <variable name='issuer_id'><type><void/></type></variable> </docgroup> <docgroup homogen-name='keyinfo' homogen-type='variable'>

autodoc.git / traditional.xml