autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-02-19' version='Pike v8.0.5'> + <manual time-stamp='2020-02-26' version='Pike v8.0.5'>    <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:4662:   <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><p>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>.</p>   </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><p>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><p>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is    supported.</p>   </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><p>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.</p>
autodoc.git/onepage.xml:117027:   </method>   </docgroup>   <docgroup homogen-name='tcgetattr' homogen-type='method'><doc><text><p>Get current terminal attributes.</p>   <p> Currently only the following attributes are supported:</p>   <string><group><value>"columns"</value><text><p>Number of columns.</p>   </text></group><group><value>"rows"</value><text><p>Number of rows.</p>   </text></group><group><value>"ECHO"</value><text><p>Local character echo on (<expr>1</expr>) or off (<expr>0</expr> (zero)).</p>   </text></group><group><value>"ICANON"</value><text><p>Canonical input on (<expr>1</expr>) or off (<expr>0</expr> (zero)).</p>   </text></group></string>   </text><group><note/><text><p>Using this function currently bypasses the Readline layer.</p> - </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.File.tcgetattr'>Stdio.File()-&gt;tcgetattr()</ref></p> + </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.Fd.tcgetattr'>Stdio.File()-&gt;tcgetattr()</ref></p>   </text></group></doc>   <method name='tcgetattr'>   <arguments/>   <returntype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></returntype>   </method>   </docgroup>   <docgroup homogen-name='tcsetattr' homogen-type='method'><doc><text><p>Set terminal attributes.</p>   <p> Currently only the following attributes are supported:</p>   <string><group><value>"ECHO"</value><text><p>Local character echo on (<expr>1</expr>) or off (<expr>0</expr> (zero)).</p>   </text></group><group><value>"ICANON"</value><text><p>Canonical input on (<expr>1</expr>) or off (<expr>0</expr> (zero)).</p>   </text></group></string>   </text><group><note/><text><p>Using this function currently bypasses the Readline layer.</p> - </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.File.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref></p> + </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.Fd.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref></p>   </text></group></doc>   <method name='tcsetattr'>   <arguments><argument name='options'><type><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></type></argument><argument name='when'><type><or><string/><void/></or></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='write' homogen-type='method'><doc><text><p>Queues data to be sent to the other end of the connection.</p>   </text><group><param name='s'/><text><p>String to send.</p>   </text></group></doc>   <method name='write'>
autodoc.git/onepage.xml:131933:   <constant name='PROP_SHUTDOWN'><type><int/></type></constant>   </docgroup>   <docgroup homogen-name='PROP_TTY' homogen-type='constant'><doc><text><p>The <ref resolved='predef::Stdio.File'>Stdio.File</ref> object supports tty operations.</p>   </text><group><note/><text><p>This constant is only present on platforms where pseudo tty    (aka pty) operations are available, and may thus be used to    detect whether such operations should be attempted.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.File.pipe'>Stdio.File()-&gt;pipe()</ref></p>   </text></group></doc>   <constant name='PROP_TTY'><type><int/></type></constant>   </docgroup> - <docgroup homogen-name='TCSADRAIN' homogen-type='constant'><doc><text><p>Argument to <ref resolved='predef::Stdio.File.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref>.</p> + <docgroup homogen-name='TCSADRAIN' homogen-type='constant'><doc><text><p>Argument to <ref resolved='predef::Stdio.Fd.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref>.</p>   <p> Change after all output has been written.</p>   </text></doc>   <constant name='TCSADRAIN'><type><string/></type></constant>   </docgroup> - <docgroup homogen-name='TCSAFLUSH' homogen-type='constant'><doc><text><p>Argument to <ref resolved='predef::Stdio.File.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref>.</p> + <docgroup homogen-name='TCSAFLUSH' homogen-type='constant'><doc><text><p>Argument to <ref resolved='predef::Stdio.Fd.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref>.</p>   <p> Change after all output has been written,    and empty the input buffers.</p>   </text></doc>   <constant name='TCSAFLUSH'><type><string/></type></constant>   </docgroup> - <docgroup homogen-name='TCSANOW' homogen-type='constant'><doc><text><p>Argument to <ref resolved='predef::Stdio.File.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref>.</p> + <docgroup homogen-name='TCSANOW' homogen-type='constant'><doc><text><p>Argument to <ref resolved='predef::Stdio.Fd.tcsetattr'>Stdio.File()-&gt;tcsetattr()</ref>.</p>   <p> Change immediately.</p>   </text></doc>   <constant name='TCSANOW'><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='XATTR_CREATE' homogen-type='constant'><doc><text><p>Used by <ref resolved='predef::setxattr'>setxattr</ref> function and method to signify a pure    create, which will fail if the attribute already exists.</p>   </text></doc>   <constant name='XATTR_CREATE'/>   </docgroup>   <docgroup homogen-name='XATTR_REPLACE' homogen-type='constant'><doc><text><p>Used by <ref resolved='predef::setxattr'>setxattr</ref> function and method to signify a replace,
autodoc.git/onepage.xml:134226:    this object. As opposed to using <ref resolved='predef::Stdio.Fd.open'>open</ref> with a file descriptor    number, it will be closed by this object upon destruct or when    <ref resolved='predef::Stdio.Fd.close'>close</ref> is called.</p>   </text><group><seealso/><text><p><ref resolved='predef::Stdio.Fd.release_fd'>release_fd()</ref></p>   </text></group></doc>   <method name='take_fd'>   <arguments><argument name='fd'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> + <docgroup homogen-name='tcdrain' homogen-type='method'><doc><text><p>Wait for transmission buffers to empty.</p> + </text><group><returns/><text><p>Returns <expr>1</expr> on success and <expr>0</expr> (zero) on failure.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.Fd.tcflush'>tcflush()</ref></p> + </text></group></doc> + <method name='tcdrain'> + <arguments/> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='tcflush' homogen-type='method'><doc><text><p>Flush queued terminal control messages.</p> + </text><group><param name='flush_direction'/><text><string><group><value>"TCIFLUSH"</value><text><p>Flush received but not read.</p> + </text></group><group><value>"TCOFLUSH"</value><text><p>Flush written but not transmitted.</p> + </text></group><group><value>"TCIOFLUSH"</value><text><p>Flush both of the above. Default.</p> + </text></group></string> + </text></group><group><returns/><text><p>Returns <expr>1</expr> on success and <expr>0</expr> (zero) on failure.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.Fd.tcdrain'>tcdrain()</ref></p> + </text></group></doc> + <method name='tcflush'> + <arguments><argument name='flush_direction'><type><or><string/><void/></or></type></argument></arguments> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + <docgroup homogen-type='method'><doc><text><p>Gets/sets term attributes. The returned value/the <ref>attr</ref> parameter +  is a mapping on the form</p> + <mapping><group><member><type><int><min>-1</min><max/></int></type><index>"ispeed"</index></member><text><p>In baud rate.</p> + </text></group><group><member><type><int><min>-1</min><max/></int></type><index>"ospeed"</index></member><text><p>Out baud rate.</p> + </text></group><group><member><type><or><int><min>-1</min><max>-1</max></int><int><min>5</min><max>8</max></int></or></type><index>"csize"</index></member><text><p>Character size in bits.</p> + </text></group><group><member><type><int/></type><index>"rows"</index></member><text><p>Terminal rows.</p> + </text></group><group><member><type><int/></type><index>"columns"</index></member><text><p>Terminal columns.</p> + </text></group><group><member><type><int><min>0</min><max>1</max></int></type><index>flag_name</index></member><text><p>The value of a named flag. The flag name is +  the string describing the termios flags (IGNBRK, BRKINT, +  IGNPAR, PARMRK, INPCK, ISTRIP, INLCR, IGNCR, ICRNL, IUCLC, +  IXON, IXANY, IXOFF, IMAXBEL, OPOST, OLCUC, ONLCR, OCRNL, +  ONOCR, ONLRET, OFILL, OFDEL, OXTABS, ONOEOT, CSTOPB, CREAD, +  PARENB, PARODD, HUPCL, CLOCAL, CRTSCTS, ISIG, ICANON, XCASE, +  ECHO, ECHOE, ECHOK, ECHONL, ECHOCTL, ECHOPRT, ECHOKE, FLUSHO, +  NOFLSH, TOSTOP, PENDIN). See the manpage for termios or +  other documentation for more information. All flags are not +  available on all platforms.</p> + </text></group><group><member><type><int><min>0</min><max>255</max></int></type><index>character_name</index></member><text><p>Sets the value of a control character (VINTR, VQUIT, VERASE, +  VKILL, VEOF, VTIME, VMIN, VSWTC, VSTART, VSTOP, VSUSP, VEOL, +  VREPRINT, VDISCARD, VWERASE, VLNEXT, VEOL2). All control +  characters are not available on all platforms.</p> + </text></group></mapping><p>Negative values are not allowed as indata, but might appear in the +  result from <ref resolved='predef::Stdio.Fd.tcgetattr'>tcgetattr</ref> when the actual value is unknown. <ref resolved='predef::Stdio.Fd.tcsetattr'>tcsetattr</ref> +  returns 0 if failed.</p> + <p> The argument <ref>when</ref> to <ref resolved='predef::Stdio.Fd.tcsetattr'>tcsetattr</ref> describes when the +  changes are to take effect:</p> + <string><group><value>"TCSANOW"</value><text><p>The change occurs immediately (default).</p> + </text></group><group><value>"TCSADRAIN"</value><text><p>The change occurs after all output has been written.</p> + </text></group><group><value>"TCSAFLUSH"</value><text><p>The change occurs after all output has been written, +  and empties input buffers.</p> + </text></group></string> + </text><group><example/><text><p>// setting the terminal in raw mode: +  Stdio.stdin-&gt;tcsetattr((["ECHO":0,"ICANON":0,"VMIN":0,"VTIME":0]));</p> + </text></group><group><note/><text><p>Unknown flags are ignored by <ref resolved='predef::Stdio.Fd.tcsetattr'>tcsetattr()</ref>. <ref resolved='predef::Stdio.Fd.tcsetattr'>tcsetattr</ref> always +  changes the attribute, so only include attributes that actually +  should be altered in the attribute mapping.</p> + </text></group><group><bugs/><text><p>Terminal rows and columns setting by <ref resolved='predef::Stdio.Fd.tcsetattr'>tcsetattr()</ref> is not +  currently supported.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.Fd.tcsetsize'>tcsetsize()</ref></p> + </text></group></doc> + <method name='tcgetattr'> + <arguments/> + <returntype><mapping/></returntype> + </method> + <method name='tcsetattr'> + <arguments><argument name='attr'><type><mapping/></type></argument></arguments> + <returntype><int/></returntype> + </method> + <method name='tcsetattr'> + <arguments><argument name='attr'><type><mapping/></type></argument><argument name='when'><type><string/></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='tcsendbreak' homogen-type='method'><doc><text><p>Send a break signal.</p> + </text><group><param name='duration'/><text><p>Duration to send the signal for. <expr>0</expr> (zero) causes +  a break signal to be sent for between 0.25 and 0.5 seconds. +  Other values are operating system dependent:</p> + <dl><group><item name='SunOS'/><text><p>The number of joined break signals as above.</p> + </text></group><group><item name='Linux, AIX, Digital Unix, Tru64'/><text><p>The time in milliseconds.</p> + </text></group><group><item name='FreeBSD, NetBSD, HP-UX, MacOS'/><text><p>The value is ignored.</p> + </text></group><group><item name='Solaris, Unixware'/><text><p>The behavior is changed to be similar to <ref resolved='predef::Stdio.Fd.tcdrain'>tcdrain()</ref>.</p> + </text></group></dl> + </text></group><group><returns/><text><p>Returns <expr>1</expr> on success and <expr>0</expr> (zero) on failure.</p> + </text></group></doc> + <method name='tcsendbreak'> + <arguments><argument name='duration'><type><or><int/><void/></or></type></argument></arguments> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='tcsetsize' homogen-type='method'><doc><text><p>Set the number of rows and columns for a terminal.</p> + </text><group><returns/><text><p>Returns <expr>1</expr> on success and <expr>0</expr> (zero) on failure.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.Fd.tcgetattr'>tcgetattr()</ref>, <ref resolved='predef::Stdio.Fd.tcsetattr'>tcsetattr()</ref></p> + </text></group></doc> + <method name='tcsetsize'> + <arguments><argument name='rows'><type><int/></type></argument><argument name='cols'><type><int/></type></argument></arguments> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup>   <docgroup homogen-name='tell' homogen-type='method'><doc><text><p>Returns the current offset in the file.</p>   </text><group><seealso/><text><p><ref resolved='predef::Stdio.Fd.seek'>seek()</ref></p>   </text></group></doc>   <method name='tell'>   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='truncate' homogen-type='method'><doc><text><p>Truncate a file.</p>   <p> Truncates the file to the specified length <ref resolved='predef::Stdio.Fd.truncate.length'>length</ref>.</p>
autodoc.git/onepage.xml:134997:   </method>   <method name='set_nonblocking'>   <arguments><argument name='read_callback'><type><object resolved='predef::Stdio.File.read_callback_t'>read_callback_t</object></type></argument><argument name='write_callback'><type><object resolved='predef::Stdio.File.write_callback_t'>write_callback_t</object></type></argument><argument name='close_callback'><type><function><argtype><mixed/></argtype><returntype><int/></returntype></function></type></argument><argument name='read_oob_callback'><type><function><argtype><mixed/></argtype><argtype><string/></argtype><returntype><int/></returntype></function></type></argument><argument name='write_oob_callback'><type><function><argtype><mixed/></argtype><returntype><int/></returntype></function></type></argument></arguments>   <returntype><void/></returntype>   </method>   <method name='set_nonblocking'>   <arguments/>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-type='method'><doc><text><p>Gets/sets term attributes. The returned value/the <ref>attr</ref> parameter -  is a mapping on the form</p> - <mapping><group><member><type><int><min>-1</min><max/></int></type><index>"ispeed"</index></member><text><p>In baud rate.</p> - </text></group><group><member><type><int><min>-1</min><max/></int></type><index>"ospeed"</index></member><text><p>Out baud rate.</p> - </text></group><group><member><type><or><int><min>-1</min><max>-1</max></int><int><min>5</min><max>8</max></int></or></type><index>"csize"</index></member><text><p>Character size in bits.</p> - </text></group><group><member><type><int/></type><index>"rows"</index></member><text><p>Terminal rows.</p> - </text></group><group><member><type><int/></type><index>"columns"</index></member><text><p>Terminal columns.</p> - </text></group><group><member><type><int><min>0</min><max>1</max></int></type><index>flag_name</index></member><text><p>The value of a named flag. The flag name is -  the string describing the termios flags (IGNBRK, BRKINT, -  IGNPAR, PARMRK, INPCK, ISTRIP, INLCR, IGNCR, ICRNL, IUCLC, -  IXON, IXANY, IXOFF, IMAXBEL, OPOST, OLCUC, ONLCR, OCRNL, -  ONOCR, ONLRET, OFILL, OFDEL, OXTABS, ONOEOT, CSTOPB, CREAD, -  PARENB, PARODD, HUPCL, CLOCAL, CRTSCTS, ISIG, ICANON, XCASE, -  ECHO, ECHOE, ECHOK, ECHONL, ECHOCTL, ECHOPRT, ECHOKE, FLUSHO, -  NOFLSH, TOSTOP, PENDIN). See the manpage for termios or -  other documentation for more information. All flags are not -  available on all platforms.</p> - </text></group><group><member><type><int><min>0</min><max>255</max></int></type><index>character_name</index></member><text><p>Sets the value of a control character (VINTR, VQUIT, VERASE, -  VKILL, VEOF, VTIME, VMIN, VSWTC, VSTART, VSTOP, VSUSP, VEOL, -  VREPRINT, VDISCARD, VWERASE, VLNEXT, VEOL2). All control -  characters are not available on all platforms.</p> - </text></group></mapping><p>Negative values are not allowed as indata, but might appear in the -  result from <ref resolved='predef::Stdio.File.tcgetattr'>tcgetattr</ref> when the actual value is unknown. <ref resolved='predef::Stdio.File.tcsetattr'>tcsetattr</ref> -  returns 0 if failed.</p> - <p> The argument <ref>when</ref> to <ref resolved='predef::Stdio.File.tcsetattr'>tcsetattr</ref> describes when the -  changes are to take effect:</p> - <string><group><value>"TCSANOW"</value><text><p>The change occurs immediately (default).</p> - </text></group><group><value>"TCSADRAIN"</value><text><p>The change occurs after all output has been written.</p> - </text></group><group><value>"TCSAFLUSH"</value><text><p>The change occurs after all output has been written, -  and empties input buffers.</p> - </text></group></string> - </text><group><example/><text><p>// setting the terminal in raw mode: -  Stdio.stdin-&gt;tcsetattr((["ECHO":0,"ICANON":0,"VMIN":0,"VTIME":0]));</p> - </text></group><group><note/><text><p>Unknown flags are ignored by <ref resolved='predef::Stdio.File.tcsetattr'>tcsetattr()</ref>. <ref resolved='predef::Stdio.File.tcsetattr'>tcsetattr</ref> always -  changes the attribute, so only include attributes that actually -  should be altered in the attribute mapping.</p> - </text></group><group><bugs/><text><p>Terminal rows and columns setting by <ref resolved='predef::Stdio.File.tcsetattr'>tcsetattr()</ref> is not -  currently supported.</p> - </text></group></doc> - <method name='tcgetattr'> - <arguments/> - <returntype><mapping/></returntype> - </method> - <method name='tcsetattr'> - <arguments><argument name='attr'><type><mapping/></type></argument></arguments> - <returntype><int/></returntype> - </method> - <method name='tcsetattr'> - <arguments><argument name='attr'><type><mapping/></type></argument><argument name='when'><type><string/></type></argument></arguments> - <returntype><int/></returntype> - </method> - </docgroup> +    <docgroup homogen-name='write_callback_t' homogen-type='typedef'><doc><text><p>The various read_callback signatures.</p>   <p> The void version is used when buffer mode (see    <ref resolved='predef::Stdio.File.set_buffer_mode'>set_buffer_mode</ref>) has not been enabled for writing.</p>   <p> The Buffer version is used when an Buffer has been enabled    for reading, add data to that buffer to send it.</p>   </text></doc>   <typedef name='write_callback_t'><type><or><function><argtype><or><mixed/><void/></or></argtype><returntype><or><int/><void/></or></returntype></function><function><argtype><or><mixed/><void/></or></argtype><argtype><object resolved='predef::Stdio.Buffer'>Buffer</object></argtype><returntype><or><int/><void/></or></returntype></function></or></type></typedef>   </docgroup>   </class>   <class name='NonblockingStream'>
autodoc.git/onepage.xml:142601:   </text></doc>   <method name='get_as_image'>   <arguments><argument name='i'><type><object resolved='predef::Tools.PV.PVImage'>PVImage</object></type></argument></arguments>   <returntype><object resolved='predef::Image.Image'>Image.Image</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='Window' homogen-type='inherit'> - <inherit name='Window'><classname resolved='predef::GTK1.Window'>GTK.Window</classname></inherit> + <inherit name='Window'><classname resolved='predef::GTK2.Window'>GTK.Window</classname></inherit>   </docgroup>   <docgroup homogen-name='save' homogen-type='method'><doc><text><p>Write the image to a file. If no format is specified, PNG is used.    The alpha combination is done on the image before it's saved.</p>   </text></doc>   <method name='save'>   <arguments><argument name='filename'><type><string/></type></argument><argument name='format'><type><or><string/><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='scale' homogen-type='method'><doc><text><p>Scale the image before display with the specified factor.</p>