Diff of autodoc.git/modref.xml (d7d4c86bb4a87b058fed9dcad184ee60f01eb2c0 » f0be93806b2adcd801b7582d68be3d244fdb6be1)

autodoc.git/modref.xml:1: <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-06-29' version='Pike v8.1.13'> + <manual time-stamp='2020-07-29' version='Pike v8.1.13'> <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:1126: </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>Implements Diffie-Hellman key-exchange. The following key exchange methods are implemented here: - <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>. + <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>. </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>Diffie-Hellman parameters.
autodoc.git/modref.xml:1743: <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable> </docgroup> <docgroup homogen-type='variable'><doc><text>Random cookies, sent and received with the hello-messages. </text></doc> <variable name='client_random'><type><string/></type></variable> <variable name='server_random'><type><string/></type></variable> </docgroup> <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='is_server'/><text>Whether this is the server end of the connection or not. </text></group><group><param name='ctx'/><text>The context for the connection. </text></group><group><param name='min_version'/><text>Minimum version of SSL to support. - Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. + Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. </text></group><group><param name='max_version'/><text>Maximum version of SSL to support. Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>. </text></group></doc> <method name='create'> <arguments><argument name='is_server'><type><int/></type></argument><argument name='ctx'><type><or><void/><object resolved='7.8::SSL.context'>SSL.context</object></or></type></argument><argument name='min_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument><argument name='max_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='handle_handshake' homogen-type='method'><doc><text>Do handshake processing. Type is one of HANDSHAKE_*, data is the contents of the packet, and raw is the raw packet received (needed
autodoc.git/modref.xml:1910: <variable name='rsa'><type><object resolved='7.8::Crypto.RSA'>Crypto.RSA</object></type></variable> </docgroup> <docgroup homogen-name='set_cipher_suite' homogen-type='method'><doc><text>Sets the proper authentication method and cipher specification for the given cipher <ref resolved='7.8::SSL.session.set_cipher_suite.suite'>suite</ref> and <ref>verison</ref>. </text></doc> <method name='set_cipher_suite'> <arguments><argument name='suite'><type><int/></type></argument><argument name='version'><type><or><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object><int/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> - <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is + <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is supported. </text></doc> <method name='set_compression_method'> <arguments><argument name='compr'><type><int/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> </class> <class name='sslfile'> <doc><text>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.
autodoc.git/modref.xml:72625: This function reads options even if they are written after the first non-option on the line. Index <expr>0</expr> (zero) of <ref resolved='predef::Getopt.find_option.argv'>argv</ref> is not scanned for options, since it is reserved for the program name. Only the first ocurrance of an option will be parsed. To parse multiple ocurrances, call <ref resolved='predef::Getopt.find_option'>find_option()</ref> multiple times. </text></group><group><seealso/><text><ref resolved='predef::Getopt.get_args'>Getopt.get_args()</ref> </text></group></doc> <method name='find_option'> <arguments><argument name='argv'><type><array><valuetype><string/></valuetype></array></type></argument><argument name='shortform'><type><or><array><valuetype><string/></valuetype></array><string/></or></type></argument><argument name='longform'><type><or><array><valuetype><string/></valuetype></array><string/><void/></or></type></argument><argument name='envvars'><type><or><array><valuetype><string/></valuetype></array><string/><void/></or></type></argument><argument name='def'><type><or><string/><int><min>0</min><max>1</max></int><void/></or></type></argument><argument name='throw_errors'><type><or><int/><void/></or></type></argument></arguments> - <returntype><or><string/><int><min>0</min><max>1</max></int></or></returntype> + <returntype><or><void/><string/><int><min>0</min><max>1</max></int></or></returntype> </method> </docgroup> <docgroup homogen-name='get_args' homogen-type='method'><doc><text>This function returns the remaining command line arguments after you have run <ref resolved='predef::Getopt.find_option'>find_option()</ref> or <ref resolved='predef::Getopt.find_all_options'>find_all_options()</ref> to find all the options in the argument list. If there are any options left not handled by <ref resolved='predef::Getopt.find_option'>find_option()</ref> or <ref resolved='predef::Getopt.find_all_options'>find_all_options()</ref> this function will fail. If <ref resolved='predef::Getopt.get_args.throw_errors'>throw_errors</ref> has been specified <ref resolved='predef::Getopt.get_args'>get_args()</ref> will throw errors on failure. If it has been left out, or is <tt>0</tt> (zero), it will instead print an error message on <ref resolved='predef::Stdio.stderr'>Stdio.stderr</ref> and exit the
autodoc.git/modref.xml:137032: </method> </docgroup> </class> <class name='Null'> <doc><text>Type for the <ref resolved='predef::Val.null'>Val.null</ref> object. Do not create more instances of this - use <ref resolved='predef::Val.null'>Val.null</ref> instead. </text></doc> </class> <class name='Range'> <doc><text>Generic lightweight range type. Supports any values for lower - and upper boundaries that implement the <expr>`<</expr> lfun. + and upper boundaries that implement <ref resolved='lfun::`<'>lfun::`<()</ref> and <ref>lfun::`</ref>()], + and preferrably also cast to <expr>int</expr> and <expr>string</expr>. </text><group><note/><text>Can only contain a single contiguous range. </text></group><group><note/><text>The empty range must be stored as <expr>(Math.inf, -Math.inf)</expr> if assigned directly to <ref resolved='predef::Val.Range.from'>from</ref> and <ref resolved='predef::Val.Range.till'>till</ref>. </text></group></doc> <docgroup homogen-name='`!' homogen-type='method'><doc><group><returns/><text>True if range is empty. - + </text></group><group><seealso/><text><ref resolved='predef::Val.Range.isempty'>isempty()</ref> </text></group></doc> <method name='`!'><modifiers><protected/><local/></modifiers> <arguments/> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='`&' homogen-type='method'><doc><text>Overlap: have points in common. </text></doc> <method name='`&'><modifiers><protected/></modifiers> - <arguments><argument name='that'><type><mixed/></type></argument></arguments> + <arguments><argument name='that'><type><object resolved='predef::Val.Range'>this_program</object></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='`*' homogen-type='method'><doc><text>Intersection </text></doc> <method name='`*'><modifiers><protected/></modifiers> - <arguments><argument name='that'><type><mixed/></type></argument></arguments> - <returntype><mixed/></returntype> + <arguments><argument name='that'><type><object resolved='predef::Val.Range'>this_program</object></type></argument></arguments> + <returntype><object resolved='predef::Val.Range'>this_program</object></returntype> </method> </docgroup> <docgroup homogen-name='`+' homogen-type='method'><doc><text>Union </text></doc> <method name='`+'><modifiers><protected/></modifiers> - <arguments><argument name='that'><type><mixed/></type></argument></arguments> - <returntype><mixed/></returntype> + <arguments><argument name='that'><type><object resolved='predef::Val.Range'>this_program</object></type></argument></arguments> + <returntype><object resolved='predef::Val.Range'>this_program</object></returntype> </method> </docgroup> <docgroup homogen-name='`-' homogen-type='method'><doc><text>Difference </text></doc> <method name='`-'><modifiers><protected/></modifiers> - <arguments><argument name='that'><type><mixed/></type></argument></arguments> - <returntype><mixed/></returntype> + <arguments><argument name='that'><type><object resolved='predef::Val.Range'>this_program</object></type></argument></arguments> + <returntype><object resolved='predef::Val.Range'>this_program</object></returntype> </method> </docgroup> <docgroup homogen-name='`<<' homogen-type='method'><doc><text>Strictly left of </text></doc> <method name='`<<'><modifiers><protected/></modifiers> - <arguments><argument name='that'><type><mixed/></type></argument></arguments> + <arguments><argument name='that'><type><object resolved='predef::Val.Range'>this_program</object></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='`>>' homogen-type='method'><doc><text>Strictly right of </text></doc> <method name='`>>'><modifiers><protected/></modifiers> - <arguments><argument name='that'><type><mixed/></type></argument></arguments> + <arguments><argument name='that'><type><object resolved='predef::Val.Range'>this_program</object></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='`|' homogen-type='method'><doc><text>Is adjacent to - </text></doc> + </text><group><fixme/><text>This does NOT seem like a good operator for this operation. + </text></group></doc> <method name='`|'><modifiers><protected/></modifiers> - <arguments><argument name='that'><type><mixed/></type></argument></arguments> + <arguments><argument name='that'><type><object resolved='predef::Val.Range'>this_program</object></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='contains' homogen-type='method'><doc><group><returns/><text>True if this range fully contains another range or element. </text></group></doc> <method name='contains'> - <arguments><argument name='other'><type><mixed/></type></argument></arguments> + <arguments><argument name='other'><type><or><object resolved='predef::Val.Range'>this_program</object><object>value_type</object></or></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='from'/><text>Lower inclusive boundary for the range. Specify no lower-boundary by filling in <expr>-Math.inf</expr>. </text></group><group><param name='till'/><text>Upper exclusive boundary for the range. Specify no upper-boundary by filling in <expr>Math.inf</expr>. </text></group><group><seealso/><text><ref resolved='predef::Math.inf'>Math.inf</ref> </text></group></doc> <method name='create'><modifiers><protected/><variant/></modifiers> - <arguments><argument name='from'><type><mixed/></type></argument><argument name='till'><type><mixed/></type></argument></arguments> + <arguments><argument name='from'><type><object>value_type</object></type></argument><argument name='till'><type><object>value_type</object></type></argument></arguments> <returntype><void/></returntype> </method> <method name='create'><modifiers><protected/><variant/></modifiers> <arguments><argument name='copy'><type><object resolved='predef::Val.Range'>this_program</object></type></argument></arguments> <returntype><void/></returntype> </method> <method name='create'><modifiers><protected/><variant/></modifiers> <arguments/> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='from' homogen-type='variable'><doc><text>The lower inclusive boundary. </text></doc> - <variable name='from'><type><mixed/></type></variable> + <variable name='from'><type><object>value_type</object></type></variable> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='interval' homogen-type='method'><doc><group><returns/><text>Calculates the value of the interval: <expr>till - from</expr>. Returns <expr>0</expr> if the range is empty. </text></group></doc> <method name='interval'> <arguments/> <returntype><mixed/></returntype> </method> </docgroup> <docgroup homogen-name='isempty' homogen-type='method'><doc><group><returns/><text>True if range is empty. - + </text></group><group><seealso/><text><ref resolved='predef::Val.Range.`!'>`!()</ref> </text></group></doc> <method name='isempty'><modifiers><local/></modifiers> <arguments/> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='merge' homogen-type='method'><doc><group><param name='other'/><text>Extends the current range to the smallest range which encompasses itself and all other given ranges. - + </text></group><group><fixme/><text>This seems like the operation that <expr>`|()</expr> ought to do. </text></group></doc> <method name='merge'> <arguments><argument name='other'><type><varargs><object resolved='predef::Val.Range'>this_program</object></varargs></type></argument></arguments> <returntype><object resolved='predef::Val.Range'>this_program</object></returntype> </method> </docgroup> <docgroup homogen-name='sql' homogen-type='method'><doc><group><returns/><text>A string representing the range using SQL-compliant syntax. </text></group></doc> <method name='sql'><modifiers><final/></modifiers> <arguments/> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='till' homogen-type='variable'><doc><text>The upper exclusive boundary. </text></doc> - <variable name='till'><type><mixed/></type></variable> + <variable name='till'><type><object>value_type</object></type></variable> </docgroup> </class> <class name='Time'> <doc><text>Lightweight time type. Stores absolute times in a day with nanosecond resolution. Normalised value range is between <expr>00:00:00.000000000</expr> and <expr>23:59:59.999999999</expr>. Values outside this range are accepted, and have arithmetically sound results. Supports arithmetic with <ref resolved='predef::Val.Interval'>Interval</ref> and <ref resolved='predef::Val.Date'>Date</ref> objects. Cast it to <expr>int</expr> or <expr>float</expr> to obtain seconds since <expr>00:00</expr>.

autodoc.git / modref.xml