Log of autodoc.git/traditional_manual/chapter

2003-07-22

2003-07-22 16:57:10 by Henrik Grubbström (Grubba) <grubba@grubba.org>

0f4adfbcad44eeebb47ff8ba10b38954a3391158 (120 lines) (+85/-35) ^{[

Show
| Annotate

]}
Branch: 8.0

AutoDoc updates.

Rev: lib/modules/Stdio.pmod/module.pmod:1.178

81: <dd class='body--doc'>The socket may be opened with <code>open_socket()</code> ahead of the call to this function, but it is not required. For <code>callback</code> to be called, the backend must be active (ie - <code>main()</code> must have returned <code class='expr'>-1</code>). + <code>main()</code> must have returned <code class='expr'>-1</code>, or <code>Pike.DefaultBackend</code> + get called in some other way). The socket will be in non-blocking state if <code class='expr'>1</code> has been - returned, and any callbacks will be cleared. + returned, and any non-blocking callbacks will be cleared. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>connect()</code>, <code>open_socket()</code>, <code>set_nonblocking()</code>
383: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns an iterator that will loop over the lines in this file. - If trim is true, all '\r' characters will be removed from the - input. + If trim is true, all <tt>'\r'</tt> characters will be removed from + the input. </dd></dl>
808: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns a function that when called will call <code>read</code> with nbytes as argument. Can be used to get various callback - functions, as an example the fourth argument to - String.SplitIterator. + functions, eg for the fourth argument to + <code>String.SplitIterator</code>. </dd></dl>
883: <dd class='body--doc'>This function sets a stream to blocking mode. i.e. all reads and writes will wait until data has been transferred before returning. </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Calling this function will also clear all non-blocking callbacks. + </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_nonblocking()</code> + <dd class='body--doc'><code>set_nonblocking()</code>, <code>set_nonblocking_keep_callbacks()</code>, + <code>set_blocking_keep_callbacks()</code> </dd></dl>
915: <code><code class='datatype'>void</code> set_blocking_keep_callbacks()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>toggle between blocking and nonblocking, - without changing the callbacks + <dd class='body--doc'>Toggle between blocking and nonblocking, + without changing the callbacks. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>set_nonblocking()</code>, <code>set_blocking()</code> </dd></dl>
959: <dt class='head--doc'>Note</dt> <dd class='body--doc'>This function does not set the file nonblocking. </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The <tt>close_callback</tt> can also be set by calling + <code>set_nonblocking()</code>. + </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>set_nonblocking()</code>, <code>close</code> <code>query_close_callback()</code>, <code>set_read_callback()</code>,
1048: be called with some or all of this data. When the stream allows out-of-band data to be sent, <code>write_oob_callback</code> will be called so that you can write out-of-band data to it. - All callbacks will have the <tt>id</tt> of file as first argument when called - (see <code>set_id()</code>). - If no arguments are given, the callbacks will not be changed. The - stream will just be set to nonblocking mode. + All callbacks will have the <tt>id</tt> of the file as first argument + when called (see <code>set_id()</code>). </dd> <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Out-of-band data will note be supported if Pike was compiled with the + <dd class='body--doc'>If no arguments are given, the callbacks will be cleared. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Out-of-band data will not be supported if Pike was compiled with the option <tt>'--without-oob'</tt>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>set_blocking()</code>, <code>set_id()</code>, <code>set_read_callback()</code>, - <code>set_write_callback()</code>, <code>set_close_callback()</code> + <code>set_write_callback()</code>, <code>set_close_callback()</code> + <code>set_nonblocking_keep_callbacks()</code>, <code>set_blocking_keep_callbacks()</code> </dd></dl>
1068: <dt class='head--type'>Method set_read_callback </dt> - <dd><code><code class='datatype'>void</code> set_read_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>void</code>) <code class='argument'>read_cb</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_read_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>void</code>) <code class='argument'>read_callback</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function sets the <tt>read_callback</tt> for the file. The <tt>read_callback</tt> is called whenever there is data to read from the file. - The callback is called with the <tt>id</tt> of the file as first argument and - some or all of its data as second. + The callback is called with the <tt>id</tt> of the file as + first argument and some or all of its data as second. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>This function does not set the file nonblocking. </dd> - + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The <tt>read_callback</tt> can also be set by calling + <code>set_nonblocking()</code>. + </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>set_nonblocking()</code>, <code>read()</code>, <code>query_read_callback()</code>, <code>set_write_callback()</code>,
1115: <dt class='head--doc'>Note</dt> <dd class='body--doc'>This function does not set the file nonblocking. </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The <tt>write_callback</tt> can also be set by calling + <code>set_nonblocking()</code>. + </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>set_nonblocking()</code>, <code>write()</code>, <code>query_write_callback()</code>, <code>set_read_callback()</code>,
1353: </dd></dl><dl><dt><h2 class='header'>Class Stdio.FILE</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Stdio.FILE is a buffered version of Stdio.File, it inherits Stdio.File and - has most of the functionality of Stdio.File. However, it has an input buffer - that allows line-by-line input. Note that the output part of Stdio.FILE is - not buffered at this moment. + <dd class='body--doc'><code>Stdio.FILE</code> is a buffered version of <code>Stdio.File</code>, it inherits + <code>Stdio.File</code> and has most of the functionality of <code>Stdio.File</code>. + However, it has an input buffer that allows line-by-line input. + It also has support for automatic charset conversion for both input + and output (see <code>Stdio.FILE()->set_charset()</code>). + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The output part of <code>Stdio.FILE</code> is currently not buffered. </dd></dl> <hr />
1386: <dd class='body--doc'>This function returns one character from the input stream. </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the ASCII value of the character. + <dd class='body--doc'>Returns the ISO-10646 (Unicode) value of the character. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>Returns an <code class='expr'>int</code> and not a <code class='expr'>string</code> of length 1.
1430: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns an iterator that will loop over the lines in this file. - If trim is true, all '\r' characters will be removed from the - input. + If <code>trim</code> is true, all <tt>'\r'</tt> characters will be removed + from the input. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>_get_iterator()</code>
1456: <hr /> <dl class='group--doc'> <dt class='head--type'>Method + pipe + </dt> + <dd><code><code class='object unresolved'>File</code> pipe(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>flags</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Same as <code>Stdio.File()->pipe()</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Returns an <code>Stdio.File</code> object, NOT a <code>Stdio.FILE</code> object. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method printf </dt> <dd><code><code class='datatype'>int</code> printf(<code class='datatype'>string</code> <code class='argument'>format</code>, <code class='datatype'>mixed</code> ... <code class='argument'>data</code>)</code></dd>
1477: <dd><code><code class='datatype'>string</code> read(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>bytes</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>now</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read <code>bytes</code> with buffering and support for input conversion. + <dd class='body--doc'>Read <code>bytes</code> (wide-) characters with buffering and support for + input conversion. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Stdio.File()->read()</code>, <code>set_charset()</code>
1493: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Sets the input and output charset of this file to the specified - charset. + <code>charset</code>. + The default charset is <tt>"ISO-8859-1"</tt>. </dd></dl>
1547: <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function completes a connection made from a remote machine to this port. It returns a two-way stream in the form of a clone of - Stdio.File. The new file is by default set to blocking mode. + <code>Stdio.File</code>. The new file is by initially set to blocking mode. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Stdio.File</code>
1592: be passed to <code>bind()</code>. When create is called with <code class='expr'>"stdin"</code> as the first argument, a socket is created out of the file descriptor <code class='expr'>0</code>. This is only - useful if that actually is a socket to begin with. + useful if it actually is a socket to begin with. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>bind</code>
3861: <dd><code><code class='object unresolved'>File</code> Stdio.stderr</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An instance of FILE("stderr"), the standard error stream. Use this + <dd class='body--doc'>An instance of <tt>FILE("stderr")</tt>, the standard error stream. Use this when you want to output error messages. - + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>predef::werror()</code> </dd></dl>
3874: <dd><code><code class='object unresolved'>FILE</code> Stdio.stdin</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An instance of FILE("stdin"), the standard input stream. Use this + <dd class='body--doc'>An instance of <tt>FILE("stdin")</tt>, the standard input stream. Use this when you want to read anything from the standard input. This example will read lines from standard input for as long as there are more lines to read. Each line will then be written to stdout together - with the line number. We could use <code>Stdio.stdout.write</code> instead - of just <code>write</code>, since they are the same function. + with the line number. We could use <code>Stdio.stdout.write()</code> instead + of just <code>write()</code>, since they are the same function. </dd> <dt class='head--doc'>Example</dt> <dd class='example'><pre>int main()
3899: <dd><code><code class='object unresolved'>File</code> Stdio.stdout</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An instance of FILE("stdout"), the standatd output stream. Use this + <dd class='body--doc'>An instance of <tt>FILE("stdout")</tt>, the standatd output stream. Use this when you want to write anything to the standard output. - + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>predef::write()</code> </dd></dl>

autodoc.git/ traditional_manual/ chapter_9.html

2003-07-22

2003-07-22 16:57:10 by Henrik Grubbström (Grubba) <grubba@grubba.org>