Log of autodoc.git/traditional_manual/chapter

2003-02-04

2003-02-04 23:58:40 by Martin Nilsson <mani@lysator.liu.se>

c3fe7432ef3f4ea6707828b8020ff08ff03a9292 (2582 lines) (+1379/-1203) ^{[

Show
| Annotate

]}
Branch: 8.0

Added preprocessor chapter

Rev: refdoc/structure/traditional.xml:1.19

1: <!doctype html><html><head><title>Pike Reference Manual</title> <meta charset='utf-8'></head> - <body><dl><dt><h1 class='header'>9. Specific Datatype Modules</h1></dt><dd><dl><dt><h2 class='header'>Module String</h2> - </dt><dd> + <body><dl><dt><h1 class='header'>9. I/O</h1></dt><dd><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'>This is the basic I/O object, it provides socket communication as well + as file access. It does not buffer reads and writes or provide line-by-line + reading, that is done with <code>Stdio.FILE</code> object. + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - capitalize + assign </dt> - <dd><code><code class='datatype'>string</code> capitalize(<code class='datatype'>string</code> <code class='argument'>str</code>)</code></dd> + <dd><code><code class='datatype'>int</code> assign(<code class='object unresolved'>File</code>|<code class='object unresolved'>Fd</code> <code class='argument'>o</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Convert the first character in <code>str</code> to upper case, and return the - new string. + <dd class='body--doc'>This function takes a clone of Stdio.File and assigns all + variables of this file from it. It can be used together with <code>dup()</code> + to move files around. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>lower_case()</code>, <code>upper_case()</code> + <dd class='body--doc'><code>dup()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - common_prefix + async_connect </dt> - <dd><code><code class='datatype'>string</code> common_prefix(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>strs</code>)</code></dd> + <dd><code><code class='datatype'>int</code> async_connect(<code class='datatype'>string</code> <code class='argument'>host</code>, <code class='datatype'>int</code> <code class='argument'>port</code>, <code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Find the longest common prefix from an array of strings. + <dd class='body--doc'>Open a TCP/IP connection asynchronously. + This function is similar to <code>connect()</code>, but works asynchronously. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>host</code></dt> + <dd></dd><dd class='body--doc'>Hostname or IP to connect to. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>port</code></dt> + <dd></dd><dd class='body--doc'>Port number to connect to. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>callback</code></dt> + <dd></dd><dd class='body--doc'>Function to be called on completion. + The first argument will be <tt>1</tt> if a connection was + successfully estabished, and <tt>0</tt> (zero) on failure. + The rest of the arguments to <code>callback</code> are passed + verbatim from <code>args</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> + <dd></dd><dd class='body--doc'>Extra arguments to pass to <code>callback</code>. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <tt>0</tt> on failure, and <tt>1</tt> if <code>callback</code> + will be used. + </dd> + <dt class='head--doc'>Note</dt> + <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 <tt>-1</tt>). + The socket will be in non-blocking state if <tt>1</tt> has been + returned, and any 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> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - expand_tabs + close </dt> - <dd><code><code class='datatype'>string</code> expand_tabs(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>tab_width</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>substitute_tab</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>substitute_space</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>substitute_newline</code>)</code></dd> + <dd><code><code class='datatype'>int</code> close()</code> + <code><code class='datatype'>int</code> close(<code class='datatype'>string</code> <code class='argument'>direction</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Expands tabs in a string to ordinary spaces, according to common - tabulation rules. + <dd class='body--doc'>Close the file. Optionally, specify "r", "w" or "rw" to close just + the read, just the write or both read and write directions of the file + respectively. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function will not call the <tt>close_callback</tt>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>open</code>, <code>open_socket</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - fuzzymatch + connect </dt> - <dd><code><code class='datatype'>int(0..100)</code> fuzzymatch(<code class='datatype'>string</code> <code class='argument'>a</code>, <code class='datatype'>string</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>int</code> connect(<code class='datatype'>string</code> <code class='argument'>host</code>, <code class='datatype'>int</code> <code class='argument'>port</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>client</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>client_port</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function compares two strings using a fuzzy matching - routine. The higher the resulting value, the better the strings match. + <dd class='body--doc'>This function connects a socket previously created with + <code>open_socket()</code> to a remote socket through TCP/IP. The + <code>host</code> argument is the hostname or IP number of the remote machine. + A local IP and port can be explicitly bound by specifying <code>client</code> + and <code>client_port</code>. </dd> - + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>This function returns 1 for success, 0 otherwise. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>In nonblocking mode <tt>0</tt> (zero) may be returned and <code>errno()</code> set to + <tt>EWOULDBLOCK</tt> or <tt>WSAEWOULDBLOCK</tt>. This should not be regarded + as a connection failure. In nonblocking mode you need to wait for a write + or close callback before you know if the connection failed or not. + </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Array.diff()</code>, <code>Array.diff_compare_table()</code> - <code>Array.diff_longest_sequence()</code> + <dd class='body--doc'><code>query_address()</code>, <code>async_connect()</code>, <code>connect_unix()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - implode_nicely + connect_unix </dt> - <dd><code><code class='datatype'>string</code> implode_nicely(<code class='datatype'>array</code>(<code class='datatype'>string</code>|<code class='datatype'>int</code>|<code class='datatype'>float</code>) <code class='argument'>foo</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>separator</code>)</code></dd> + <dd><code><code class='datatype'>int</code> connect_unix(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function implodes a list of words to a readable string, e.g. - ({"straw","berry","pie"}) becomes "straw, berry and pie". - If the separator is omitted, the default is <tt>"and"</tt>. - If the words are numbers they are converted to strings first. + <dd class='body--doc'>Open a UNIX domain socket connection to the specified destination. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>`*()</code> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <tt>1</tt> on success, and <tt>0</tt> on failure. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Nonblocking mode is not supported while connecting </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - int2roman + create </dt> - <dd><code><code class='datatype'>string</code> int2roman(<code class='datatype'>int</code> <code class='argument'>m</code>)</code></dd> + <dd><code>Stdio.File Stdio.File()</code> + <code>Stdio.File Stdio.File(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> + <code>Stdio.File Stdio.File(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> + <code>Stdio.File Stdio.File(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>, <code class='datatype'>int</code> <code class='argument'>mask</code>)</code> + <code>Stdio.File Stdio.File(<code class='datatype'>string</code> <code class='argument'>descriptorname</code>)</code> + <code>Stdio.File Stdio.File(<code class='datatype'>int</code> <code class='argument'>fd</code>)</code> + <code>Stdio.File Stdio.File(<code class='datatype'>int</code> <code class='argument'>fd</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Converts the provided integer to a roman integer (i.e. a string). + <dd class='body--doc'>There are four basic ways to create a Stdio.File object. + The first is calling it without any arguments, in which case the you'd + have to call <code>open()</code>, <code>connect()</code> or some other method which connects + the File object with a stream. + The second way is calling it with a <code>filename</code> and open <code>mode</code>. This is + the same thing as cloning and then calling <code>open()</code>, except shorter and + faster. + The third way is to call it with <code>descriptorname</code> of <tt>"stdin"</tt>, + <tt>"stdout"</tt> or <tt>"stderr"</tt>. This will open the specified + standard stream. + For the advanced users, you can use the file descriptors of the + systems (note: emulated by pike on some systems - like NT). This is + only useful for streaming purposes on unix systems. This is not + recommended at all if you don't know what you're into. Default + <code>mode</code> for this is <tt>"rw"</tt>. </dd> - <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an error if <code>m</code> is outside the range 0 to 10000. + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Open mode will be filtered through the system UMASK. You + might need to use <code>chmod()</code> later. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>open()</code>, <code>connect()</code>, <code>Stdio.FILE</code>, </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - int2size + dup </dt> - <dd><code><code class='datatype'>string</code> int2size(<code class='datatype'>int</code> <code class='argument'>size</code>)</code></dd> + <dd><code><code class='object unresolved'>File</code> dup()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the size as a memory size string with suffix, - e.g. 43210 is converted into "42.2 kb". To be correct - to the latest standards it should really read "42.2 KiB", - but we have chosen to keep the old notation for a while. - The function knows about the quantifiers kilo, mega, giga, - tera, peta, exa, zetta and yotta. + <dd class='body--doc'>This function returns a clone of Stdio.File with all variables + copied from this file. </dd> - <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an error is <code>size</code> is less than zero. + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>All variables, even <tt>id</tt>, are copied. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>assign()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - sillycaps + errno </dt> - <dd><code><code class='datatype'>string</code> sillycaps(<code class='datatype'>string</code> <code class='argument'>str</code>)</code></dd> + <dd><code><code class='datatype'>int</code> errno()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Convert the first character in each word (separated by spaces) in - <code>str</code> to upper case, and return the new string. + <dd class='body--doc'>Returns the error code for the last command on this file. + Error code is normally cleared when a command is successful. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - soundex + <dt class='head--type'>Inherit + Fd_ref </dt> - <dd><code><code class='datatype'>string</code> soundex(<code class='datatype'>string</code> <code class='argument'>word</code>)</code></dd> + <dd><code><code class='modifier'>optional</code> inherit Fd_ref : Fd_ref</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the soundex value of <code>word</code> according to - the original Soundex algorithm, patented by Margaret O´Dell - and Robert C. Russel in 1918. The method is based on the phonetic - classification of sounds by how they are made. It was only intended - for hashing of english surnames, and even at that it isn't that - much of a help. - </dd></dl> - <dl><dt><h2 class='header'>Class String.SplitIterator</h2> - </dt><dd> + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + line_iterator </dt> - <dd><code>String.SplitIterator String.SplitIterator(<code class='datatype'>string</code> <code class='argument'>buffer</code>, <code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>)|<code class='datatype'>multiset</code>(<code class='datatype'>int</code>) <code class='argument'>split_set</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>flags</code>, <code class='datatype'>function</code>(:<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>feed</code>)</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Module String.Elite</h2> - </dt><dd> + <dd><code><code class='datatype'>object</code> line_iterator(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>trim</code>)</code></dd> - + <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. + </dd></dl> + + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - elite_string + open </dt> - <dd><code><code class='datatype'>string</code> elite_string(<code class='datatype'>string</code> <code class='argument'>in</code>, <code class='datatype'>void</code>|<code class='datatype'>int(0..100)</code> <code class='argument'>leetp</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>eightbit</code>)</code></dd> + <dd><code><code class='datatype'>int</code> open(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> + <code><code class='datatype'>int</code> open(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>, <code class='datatype'>int</code> <code class='argument'>mask</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Translates a string to 1337. The optional - argument leetp is the maximum percentage of - leetness (100=max leet, 0=no leet). - The translation is performed in three steps, - first the neccesary elite translations (picture -> pic, - cool->kewl etc), then optional translations - (ok->k, dude->dood, -ers -> -orz), then - calls elite_word on the resulting words. + <dd class='body--doc'>Open a file for read, write or append. The parameter <code>mode</code> should + contain one or more of the following letters: + <table class='box'><tr><td><code><code class='key'>'r'</code></code></td><td>Open file for reading. + </td></tr> + <tr><td><code><code class='key'>'w'</code></code></td><td>Open file for writing. + </td></tr> + <tr><td><code><code class='key'>'a'</code></code></td><td>Open file for append (use with <tt>'w'</tt>). + </td></tr> + <tr><td><code><code class='key'>'t'</code></code></td><td>Truncate file at open (use with <tt>'w'</tt>). + </td></tr> + <tr><td><code><code class='key'>'c'</code></code></td><td>Create file if it doesn't exist (use with <tt>'w'</tt>). + </td></tr> + <tr><td><code><code class='key'>'x'</code></code></td><td>Fail if file already exists (use with <tt>'c'</tt>). + </td></tr> + </table><code>mode</code> should always contain at least one of the letters <tt>'r'</tt> or + <tt>'w'</tt>. + The parameter <code>mask</code> is protection bits to use if the file is created. + Default is <tt>0666</tt> (read+write for all in octal notation). + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>This function returns 1 for success, 0 otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>close()</code>, <code>create()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - elite_word + open_socket </dt> - <dd><code><code class='datatype'>string</code> elite_word(<code class='datatype'>string</code> <code class='argument'>in</code>, <code class='datatype'>void</code>|<code class='datatype'>int(0..100)</code> <code class='argument'>leetp</code>, <code class='datatype'>void</code>|<code class='datatype'>int(0..2)</code> <code class='argument'>eightbit</code>)</code></dd> + <dd><code><code class='datatype'>int</code> open_socket(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>port</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>address</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Translates one word to 1337. The optional - argument leetp is the maximum percentage of - leetness (100=max leet, 0=no leet). - elite_word only do character-based translation, - for instance from "k" to "|<", but no language - translation (no "cool" to "kewl"). + <dd class='body--doc'>This makes this file into a socket ready for connections. The reason + for this function is so that you can set the socket to nonblocking + or blocking (default is blocking) before you call <code>connect()</code>. + If you give a <code>port</code> number to this function, the socket will be + bound to this <code>port</code> locally before connecting anywhere. This is + only useful for some silly protocols like FTP. You may also + specify an <code>address</code> to bind to if your machine has many IP numbers. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>This function returns 1 for success, 0 otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>connect()</code>, <code>set_nonblocking()</code>, <code>set_blocking()</code> </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module String.HTML</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Functions that helps generating HTML. All functions generates - HTML that is XHTML compliant as well as backwards compatible - with old HTML standards in what extent is possible. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - pad_rows + pipe </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>string</code>)) pad_rows(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>string</code>)) <code class='argument'>rows</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>padding</code>)</code></dd> + <dd><code><code class='object unresolved'>File</code> pipe(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>how</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pads out the rows in a array of rows to equal length. The new elements in - the rows will have the value provided in <code>padding</code>, or "&nbsp;". + <dd class='body--doc'>This function creates a bi-directional pipe between the object it + was called in and an object that is returned. The two ends of the + pipe are indistinguishable. If the File object this function is + called in was open to begin with, it will be closed before the pipe + is created. + </dd><dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document the <tt>PROP_</tt> properties. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Process.create_process()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - select + query_close_callback </dt> - <dd><code><code class='datatype'>string</code> select(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>string</code>)) <code class='argument'>choices</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>selected</code>)</code></dd> + <dd><code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) query_close_callback()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates an HTML select list. + <dd class='body--doc'>This function returns the <tt>close_callback</tt>, which has been set with + <code>set_nonblocking()</code> or <code>set_close_callback()</code>. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>name</code></dt> - <dd></dd><dd class='body--doc'>The name of the select list. Will be used in the name attribute - of the select element. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>choices</code></dt> - <dd></dd><dd class='body--doc'>May either be an array of strings, where each string is a choice, - or an array of pairs. A pair is an array with two strings. The - first string is the value of the choice while the second string - is the presentation text associated with the value. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>selected</code></dt> - <dd></dd><dd class='body--doc'>The value that should be selected by default, if any. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>select("language", - ({ ({ "eng", "English" }), - ({ "swe", "Swedish" }), - ({ "nor", "Norwegian" }) }), - "swe"); - </pre></dd></dl> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>set_nonblocking()</code>, <code>set_close_callback()</code> + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - simple_obox + query_id </dt> - <dd><code><code class='datatype'>string</code> simple_obox(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>string</code>)) <code class='argument'>rows</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>frame_color</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>cell_color</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>width</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>padding</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>int</code>, <code class='datatype'>string</code>, <code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>cell_callback</code>)</code></dd> + <dd><code><code class='datatype'>mixed</code> query_id()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function should solve most of the obox needs that arises. It creates a table out - of the array of arrays of strings fed into it. The tables will (with default settings) - have a thin black outline around the table and between its cells. Much effort has gone - into finding a simple HTML reresentation of such obox that is rendered in a similar way - in all popular browsers. The current implementation has been tested against IE, Netscape, - Mozilla, Opera and Konquest. + <dd class='body--doc'>This function returns the <tt>id</tt> that has been set with <code>set_id()</code>. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>rows</code></dt> - <dd></dd><dd class='body--doc'>Simply an array of arrays with strings. The strings are the values that should appear - in the table cells. All rows should have equal number of cells, otherwise the result - will not be very eye pleasing. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>frame_color</code></dt> - <dd></dd><dd class='body--doc'>The color of the surrounding frame. Defaults to "#000000". - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>cell_color</code></dt> - <dd></dd><dd class='body--doc'>The background color of the cells. Defaults to "#ffffff". - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>width</code></dt> - <dd></dd><dd class='body--doc'>The border width. Defaults to "1". - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>padding</code></dt> - <dd></dd><dd class='body--doc'>The amount of padding in each cell. Defaults to "3". - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>cell_callback</code></dt> - <dd></dd><dd class='body--doc'>If provided, the cell callback will be called for each cell. As in parameters it - will get the current x and y coordinates in the table. The upper left cell is 0,0. - In addition to the coordinates it will also recieve the background color and the - contents of the current cell. It is expected to return a td-element. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>function cb = lambda(int x, int y, string bgcolor, string contents) { - if(y%2) return "<td bgcolor='#aaaaff'>"+contents+"</td>"; - return "<td bgcolor='"+bgcolor+"'>"+contents+"</td>"; - } - simple_obox(my_rows, "#0000a0", 0, "1", "3", cb); - </pre></dd> + <dt class='head--doc'>See also</dt> - <dd class='body--doc'>pad_rows + <dd class='body--doc'><code>set_id()</code> </dd></dl> - <dl><dt><h2 class='header'>Class String.HTML.OBox</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Provides the same functionality as the <code>simple_obox</code> function, - in a "streaming" way. The real gain is different addtition methods - as well as the possibility to change the cell callback at any time. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'>simple_obox - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - add_cell + query_read_callback </dt> - <dd><code><code class='datatype'>void</code> add_cell(<code class='datatype'>string</code> <code class='argument'>contents</code>)</code></dd> + <dd><code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>void</code>) query_read_callback()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Adds a cell with the provided content. + <dd class='body--doc'>This function returns the <tt>read_callback</tt>, which has been set with + <code>set_nonblocking()</code> or <code>set_read_callback()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>set_nonblocking()</code>, <code>set_read_callback</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - add_raw_cell + query_read_oob_callback </dt> - <dd><code><code class='datatype'>void</code> add_raw_cell(<code class='datatype'>string</code> <code class='argument'>cell</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Adds this cell to the table unmodified, e.g. it should have an enclosing - td or th element. + <dd><code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>void</code>) query_read_oob_callback()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - add_row + query_write_callback </dt> - <dd><code><code class='datatype'>void</code> add_row(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>cells</code>)</code></dd> + <dd><code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) query_write_callback()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Adds a complete row. If the current row is nonempty a - new row will be started. + <dd class='body--doc'>This function returns the <tt>write_callback</tt>, which has been set with + <code>set_nonblocking()</code> or <code>set_write_callback()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>set_nonblocking()</code>, <code>set_write_callback</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - add_tagdata_cell + query_write_oob_callback </dt> - <dd><code><code class='datatype'>void</code> add_tagdata_cell(<code class='datatype'>string</code> <code class='argument'>tag</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>args</code>, <code class='datatype'>string</code> <code class='argument'>contents</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates a cell from the provided arguments and adds it to the table. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>tag</code></dt> - <dd></dd><dd class='body--doc'>The name of the element that should be produces. Typically - "td" or "th". - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> - <dd></dd><dd class='body--doc'>A mapping with the elements attributes. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>contents</code></dt> - <dd></dd><dd class='body--doc'>The element contents. + <dd><code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) query_write_oob_callback()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - cast + read_function </dt> - <dd><code>(int)String.HTML.OBox() (float)String.HTML.OBox() (string)String.HTML.OBox() (array)String.HTML.OBox() (mapping)String.HTML.OBox() (multiset)String.HTML.OBox()</code></dd> + <dd><code><code class='datatype'>function</code>(:<code class='datatype'>string</code>) read_function(<code class='datatype'>int</code> <code class='argument'>nbytes</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>It is possible to case this object to a string, which does the same - as calling <code>render</code>, and to an array, which returns the cells in an - array of rows. + <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. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + set_blocking </dt> - <dd><code>String.HTML.OBox String.HTML.OBox(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>frame_color</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>cell_color</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>width</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>padding</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>int</code>, <code class='datatype'>string</code>, <code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>cell_callback</code>)</code></dd> - </dl> + <dd><code><code class='datatype'>void</code> set_blocking()</code></dd> - + <dt class='head--doc'>Description</dt> + <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'>See also</dt> + <dd class='body--doc'><code>set_nonblocking()</code> + </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - new_row + set_nonblocking_keep_callbacks + Method + set_blocking_keep_callbacks </dt> - <dd><code><code class='datatype'>void</code> new_row()</code></dd> + <dd><code><code class='datatype'>void</code> set_nonblocking_keep_callbacks()</code> + <code><code class='datatype'>void</code> set_blocking_keep_callbacks()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Begin a new row. Succeeding cells will be added to this - row instead of the current. + <dd class='body--doc'>toggle between blocking and nonblocking, + without changing the callbacks </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - pad_rows + set_close_callback </dt> - <dd><code><code class='datatype'>void</code> pad_rows()</code></dd> + <dd><code><code class='datatype'>void</code> set_close_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>close_cb</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Ensures that all rows have the same number of cells. + <dd class='body--doc'>This function sets the <tt>close_callback</tt> for the file. The + <tt>close callback</tt> is called when the remote end of a socket or + pipe is closed. + The callback is called with the <tt>id</tt> of the file as argument. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function does not set the file nonblocking. + </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>, + <code>set_write_callback()</code>, <code>set_id()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - render + set_id </dt> - <dd><code><code class='datatype'>string</code> render()</code></dd> + <dd><code><code class='datatype'>void</code> set_id(<code class='datatype'>mixed</code> <code class='argument'>id</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the result. + <dd class='body--doc'>This function sets the <tt>id</tt> of this file. The <tt>id</tt> is mainly + used as an identifier that is sent as the first argument to all + callbacks. The default <tt>id</tt> is <tt>0</tt> (zero). Another possible + use of the <tt>id</tt> is to hold all data related to this file in a + mapping or array. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>query_id()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_cell_callback + set_nonblocking </dt> - <dd><code><code class='datatype'>void</code> set_cell_callback(<code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>int</code>, <code class='datatype'>string</code>, <code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>cell_callback</code>)</code></dd> - </dl> + <dd><code><code class='datatype'>void</code> set_nonblocking(<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 class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>write_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>close_callback</code>)</code> + <code><code class='datatype'>void</code> set_nonblocking(<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 class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>write_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>close_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>void</code>) <code class='argument'>read_oob_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>write_oob_callback</code>)</code> + <code><code class='datatype'>void</code> set_nonblocking()</code></dd> - + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function sets a stream to nonblocking mode. When data arrives on + the stream, <code>read_callback</code> will be called with some or all of this + data. When the stream has buffer space over for writing, + <code>write_callback</code> will be called so that you can write more data to it. + If the stream is closed at the other end, <code>close_callback</code> will be + called. + When out-of-band data arrives on the stream, <code>read_oob_callback</code> will + 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. + </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 + 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> + </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_extra_args + set_read_callback </dt> - <dd><code><code class='datatype'>void</code> set_extra_args(<code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>)) <code class='argument'>extra_args</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_cb</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The argument in the mappings will be added to the cell in the - cooresponding column of the table. + <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. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function does not set the file nonblocking. + </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>, + <code>set_close_callback()</code>, <code>set_read_oob_callback</code> + <code>set_write_oob_callback()</code>, <code>set_id()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_extra_args + set_read_oob_callback </dt> - <dd><code><code class='datatype'>void</code> set_extra_args(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>extra_args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The argument in the mapping will be added to all created table cells. + <dd><code><code class='datatype'>void</code> set_read_oob_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_oob_cb</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function. </dd></dl> - </dd></dl></dd></dl></dd></dl><dl><dt><h2 class='header'>Module Array</h2> - </dt><dd> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - arrayify + set_write_callback </dt> - <dd><code><code class='datatype'>array</code> arrayify(<code class='datatype'>void</code>|<code class='datatype'>array</code>|<code class='datatype'>mixed</code> <code class='argument'>x</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_write_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>write_cb</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Make an array of the argument, if it isn't already. A zero_type - argument gives the empty array. This is useful when something is - either an array or a basic datatype, for instance in headers from - the MIME module or Protocols.HTTP.Server. + <dd class='body--doc'>This function sets the <tt>write_callback</tt> for the file. The + <tt>write_callback</tt> is called whenever there is buffer space + available to write to for the file. + The callback is called with the <tt>id</tt> of the file as argument. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd><dd class='body--doc'>Result depends of the argument type: - <dl class='group--doc'><dt>arrayp(x)</dt> - <dd>arrayify(x) => x + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function does not set the file nonblocking. </dd> - <dt>zero_type(x)</dt> - <dd>arrayify(x) => ({}) - </dd> - <dt>otherwise</dt> - <dd>arrayify(x) => ({ x }) - </dd> - </dl> + <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>, + <code>set_close_callback()</code>, <code>set_read_oob_callback</code> + <code>set_write_oob_callback()</code>, <code>set_id()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - common_prefix + set_write_oob_callback </dt> - <dd><code><code class='datatype'>array</code> common_prefix(<code class='datatype'>array</code>(<code class='datatype'>array</code>) <code class='argument'>arrs</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Find the longest common prefix from an array of arrays. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>String.common_prefix</code> + <dd><code><code class='datatype'>void</code> set_write_oob_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>write_oob_cb</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - count + tcgetattr + Method + tcsetattr </dt> - <dd><code><code class='datatype'>int</code> count(<code class='datatype'>array</code>|<code class='datatype'>mapping</code>|<code class='datatype'>multiset</code> <code class='argument'>haystack</code>, <code class='datatype'>mixed</code> <code class='argument'>needle</code>)</code> - <code><code class='datatype'>mapping</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) count(<code class='datatype'>array</code>|<code class='datatype'>mapping</code>|<code class='datatype'>multiset</code> <code class='argument'>haystack</code>)</code></dd> + <dd><code><code class='datatype'>mapping</code> tcgetattr()</code> + <code><code class='datatype'>int</code> tcsetattr(<code class='datatype'>mapping</code> <code class='argument'>attr</code>)</code> + <code><code class='datatype'>int</code> tcsetattr(<code class='datatype'>mapping</code> <code class='argument'>attr</code>, <code class='datatype'>string</code> <code class='argument'>when</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the number of occurrences of <code>needle</code> in <code>haystack</code>. - If the optional <code>needle</code> argument is omitted, <code>count</code> instead - works similar to the unix command <tt>sort|uniq -c</tt>, returning - a mapping with the number of occurrences of each element in - <code>haystack</code>. For array or mapping <code>haystack</code>s, it's the values - that are counted, for multisets the indices, as you'd expect. + <dd class='body--doc'>Gets/sets term attributes. The returned value/the <code>attr</code> parameter + is a mapping on the form + <table class='box'><tr><td><code><code class='key'>"ispeed"</code> : <code class='datatype'>int(-1..)</code></code></td><td>In baud rate. + </td></tr> + <tr><td><code><code class='key'>"ospeed"</code> : <code class='datatype'>int(-1..)</code></code></td><td>Out baud rate. + </td></tr> + <tr><td><code><code class='key'>"csize"</code> : <code class='datatype'>int(-1..-1)</code>|<code class='datatype'>int(5..8)</code></code></td><td>Character size. + </td></tr> + <tr><td><code><code class='key'>"rows"</code> : <code class='datatype'>int</code></code></td><td>Terminal rows. + </td></tr> + <tr><td><code><code class='key'>"columns"</code> : <code class='datatype'>int</code></code></td><td>Terminal columns. + </td></tr> + <tr><td><code><code class='key'>flag_name</code> : <code class='datatype'>bool</code></code></td><td>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. + </td></tr> + <tr><td><code><code class='key'>character_name</code> : <code class='datatype'>int(8bit)</code></code></td><td>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. + </td></tr> + </table>Negative values are not allowed as indata, but might appear in the + result from <code>tcgetattr</code> when the actual value is unknown. <code>tcsetattr</code> + returns 0 if failed. + The argument <code>when</code> to <code>tcsetattr</code> describes when the + changes are to take effect: + <table class='box'><tr><td><code><code class='key'>"TCSANOW"</code></code></td><td>The change occurs immediately (default). + </td></tr> + <tr><td><code><code class='key'>"TCSADRAIN"</code></code></td><td>The change occurs after all output has been written. + </td></tr> + <tr><td><code><code class='key'>"TCSAFLUSH"</code></code></td><td>The change occurs after all output has been written, + and empties input buffers. + </td></tr> + </table> </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>String.count</code>, <code>search</code>, <code>has_value</code> + <dt class='head--doc'>Example</dt> + <dd class='example'><pre>// setting the terminal in raw mode: + Stdio.stdin->tcsetattr((["ECHO":0,"ICANON":0,"VMIN":0,"VTIME":0])); + </pre></dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Unknown flags are ignored by <code>tcsetattr()</code>. <code>tcsetattr</code> always + changes the attribute, so only include attributes that actually + should be altered in the attribute mapping. + </dd> + <dt class='head--doc'>Bugs</dt> + <dd class='body--doc'>Terminal rows and columns setting by <code>tcsetattr()</code> is not + currently supported. </dd></dl> - + </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></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - dwim_sort_func + _get_iterator </dt> - <dd><code><code class='datatype'>int</code> dwim_sort_func(<code class='datatype'>string</code> <code class='argument'>a</code>, <code class='datatype'>string</code> <code class='argument'>b</code>)</code></dd> + <dd><code>Stdio.FILE a; + foreach( a; index; value ) or </code><code><code class='modifier'>protected</code> <code class='datatype'>object</code> _get_iterator()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sort without respect to number formatting (most notably leading - zeroes). + <dd class='body--doc'>Returns an iterator that will loop over the lines in this file. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>line_iterator()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - flatten + getchar </dt> - <dd><code><code class='datatype'>array</code> flatten(<code class='datatype'>array</code> <code class='argument'>a</code>)</code></dd> + <dd><code><code class='datatype'>int</code> getchar()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Flatten a multi-dimensional array to a one-dimensional array. + <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> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Returns an <tt>int</tt> and not a <tt>string</tt> of length 1. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - greedy_diff + gets </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>array</code>)) greedy_diff(<code class='datatype'>array</code> <code class='argument'>from</code>, <code class='datatype'>array</code> <code class='argument'>to</code>)</code></dd> + <dd><code><code class='datatype'>string</code> gets()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Like <code>Array.diff</code>, but tries to generate bigger continuous chunks of the - differences, instead of maximizing the number of difference chunks. More - specifically, <code>greedy_diff</code> optimizes the cases where <code>Array.diff</code> returns - <code class='expr'>({ ..., A, Z, B, ({}), C, ... })</code> - <code class='expr'>({ ..., A, X, B,  Y+B, C, ... })</code> - into the somewhat shorter diff arrays - <code class='expr'>({ ..., A, Z,     B+C, ... })</code> - <code class='expr'>({ ..., A, X+B+Y, B+C, ... })</code> + <dd class='body--doc'>Read one line of input with support for input conversion. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>This function returns the line read if successful, and <tt>0</tt> if + no more lines are available. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>ngets()</code>, <code>read()</code>, <code>line_iterator()</code>, <code>set_charset()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - lyskom_sort_func + <dt class='head--type'>Inherit + file </dt> - <dd><code><code class='datatype'>int</code> lyskom_sort_func(<code class='datatype'>string</code> <code class='argument'>a</code>, <code class='datatype'>string</code> <code class='argument'>b</code>)</code></dd> + <dd><code>inherit File : file</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sort comparison function that does not care about case, nor about - the contents of any parts of the string enclosed with '()' - Example: "Foo (bar)" is given the same weight as "foo (really!)" - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - oid_sort_func + line_iterator </dt> - <dd><code><code class='datatype'>int</code> oid_sort_func(<code class='datatype'>string</code> <code class='argument'>a0</code>, <code class='datatype'>string</code> <code class='argument'>b0</code>)</code></dd> + <dd><code><code class='datatype'>object</code> line_iterator(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>trim</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sort with care of numerical sort for OID values: - "1.2.1" before "1.11.1" + <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. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>sort_array</code> + <dd class='body--doc'><code>_get_iterator()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - reduce + printf </dt> - <dd><code><code class='datatype'>mixed</code> reduce(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>fun</code>, <code class='datatype'>array</code> <code class='argument'>arr</code>, <code class='datatype'>mixed</code>|<code class='datatype'>void</code> <code class='argument'>zero</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>reduce()</code> sends the first two elements in <code>arr</code> to <code>fun</code>, - then the result and the next element in <code>arr</code> to <code>fun</code> and - so on. Then it returns the result. The function will return - <code>zero</code> if <code>arr</code> is the empty array. If <code>arr</code> has - only one element, that element will be returned. + <dd class='body--doc'>This function does approximately the same as: + <code class='expr'><code>write</code>(<code>sprintf</code>(<code>format</code>,@<code>data</code>))</code>. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>rreduce()</code> + <dd class='body--doc'><code>write()</code>, <code>sprintf()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rreduce + read </dt> - <dd><code><code class='datatype'>mixed</code> rreduce(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>fun</code>, <code class='datatype'>array</code> <code class='argument'>arr</code>, <code class='datatype'>mixed</code>|<code class='datatype'>void</code> <code class='argument'>zero</code>)</code></dd> + <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'><code>rreduce()</code> sends the last two elements in <code>arr</code> to <code>fun</code>, - then the third last element in <code>arr</code> and the result to <code>fun</code> and - so on. Then it returns the result. The function will return - <code>zero</code> if <code>arr</code> is the empty array. If <code>arr</code> has - only one element, that element will be returned. + <dd class='body--doc'>Read <code>bytes</code> with buffering and support for input conversion. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>reduce()</code> + <dd class='body--doc'><code>Stdio.File()->read()</code>, <code>set_charset()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - search_array + set_charset </dt> - <dd><code><code class='datatype'>int</code> search_array(<code class='datatype'>array</code> <code class='argument'>arr</code>, <code class='datatype'>string</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>int</code> <code class='argument'>fun</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_charset(<code class='datatype'>string</code> <code class='argument'>charset</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>search_array()</code> works like <code>map()</code>, only it returns the index - of the first call that returnes true instead. - If no call returns true, -1 is returned. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>sum()</code>, <code>map()</code> + <dd class='body--doc'>Sets the input and output charset of this file to the specified + charset. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - shuffle + ungets </dt> - <dd><code><code class='datatype'>array</code> shuffle(<code class='datatype'>array</code> <code class='argument'>arr</code>)</code></dd> + <dd><code><code class='datatype'>void</code> ungets(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>shuffle()</code> gives back the same elements, but in random order. - The array is modified destructively. + <dd class='body--doc'>This function puts a string back in the input buffer. The string + can then be read with eg <code>read()</code>, <code>gets()</code> or <code>getchar()</code>. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>permute()</code> + <dd class='body--doc'><code>read()</code>, <code>gets()</code>, <code>getchar()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - sort_array + write </dt> - <dd><code><code class='datatype'>array</code> sort_array(<code class='datatype'>array</code> <code class='argument'>arr</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>void</code> <code class='argument'>cmp</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> + <dd><code><code class='datatype'>int</code> write(<code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code> <code class='argument'>what</code>, <code class='datatype'>mixed</code> ... <code class='argument'>fmt</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function sorts the array <code>arr</code> after a compare-function - <code>cmp</code> which takes two arguments and should return <tt>1</tt> if the - first argument is larger then the second. Returns the sorted array - - <code>arr</code> is not sorted destructively. - The remaining arguments <code>args</code> will be sent as 3rd, 4th etc. argument - to <code>cmp</code>. - If <code>cmp</code> is omitted, <code>`>()</code> is used instead. + <dd class='body--doc'>Write <code>what</code> with support for output_conversion. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>map()</code>, <code>sort()</code>, <code>`>()</code>, <code>dwim_sort_func</code>, <code>lyskom_sort_func</code>, - <code>oid_sort_func</code> + <dd class='body--doc'><code>Stdio.File()->write()</code> </dd></dl> - + </dd></dl><dl><dt><h2 class='header'>Class Stdio.Port</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Handles listening to socket ports. Whenever you need a bound + socket that is open and listens for connections you should + use this program. + </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - sum + accept </dt> - <dd><code><code class='datatype'>mixed</code> sum(<code class='datatype'>array</code> <code class='argument'>a</code>)</code></dd> + <dd><code><code class='object unresolved'>File</code> accept()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sum the elements of an array using `+ + <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. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - sum_arrays + bind </dt> - <dd><code><code class='datatype'>array</code> sum_arrays(<code class='datatype'>function</code>(<code class='datatype'>mixed</code> ... :<code class='datatype'>mixed</code>) <code class='argument'>sum</code>, <code class='datatype'>array</code> ... <code class='argument'>args</code>)</code></dd> + <dd><code><code class='datatype'>int</code> bind(<code class='datatype'>int</code> <code class='argument'>port</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>ip</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Applies the function <code>sum</code> columnwise on the elements in the - provided arrays. E.g. <tt>sum_array(`+,a,b,c)</tt> does the same - as <tt>`+(a[*],b[*],c[*])</tt>. + <dd class='body--doc'>Bind opens a sockets and binds it to port number on the local machine. + If the second argument is present, the socket is set to nonblocking + and the callback funcition is called whenever something connects to + the socket. The callback will receive the id for this port as argument. + Bind returns 1 on success, and zero on failiure. + If the optional argument 'ip' is given, bind will try to bind to + this ip name or number. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>accept</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - uniq2 + create </dt> - <dd><code><code class='datatype'>array</code> uniq2(<code class='datatype'>array</code> <code class='argument'>a</code>)</code></dd> + <dd><code>Stdio.Port Stdio.Port()</code> + <code>Stdio.Port Stdio.Port(<code class='datatype'>int</code> <code class='argument'>port</code>)</code> + <code>Stdio.Port Stdio.Port(<code class='datatype'>int</code> <code class='argument'>port</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code>)</code> + <code>Stdio.Port Stdio.Port(<code class='datatype'>int</code> <code class='argument'>port</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code>, <code class='datatype'>string</code> <code class='argument'>ip</code>)</code> + <code>Stdio.Port Stdio.Port(<code class='argument'>"stdin"</code>)</code> + <code>Stdio.Port Stdio.Port(<code class='argument'>"stdin"</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Perform the same action as the Unix uniq command on an array, - that is, fold consecutive occurrences of the same element into - a single element of the result array: - aabbbcaababb -> abcabab. - See also the <code>uniq</code> function. + <dd class='body--doc'>If the first argument is other than <tt>"stdin"</tt> the arguments will + be passed to <code>bind()</code>. + When create is called with <tt>"stdin"</tt> as the first argument, a + socket is created out of the file descriptor <tt>0</tt>. This is only + useful if that actually is a socket to begin with. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>bind</code> </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module Function</h2> - </dt><dd> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - splice_call + errno </dt> - <dd><code><code class='datatype'>mixed</code> splice_call(<code class='datatype'>array</code> <code class='argument'>args</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>mixed</code>|<code class='datatype'>void</code> ... <code class='argument'>extra</code>)</code></dd> + <dd><code><code class='datatype'>int</code> errno()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Calls the given function with the <tt>args</tt> array plus the optional - extra arguments as its arguments and returns the result. - Most useful in conjunction with <code>map</code>, and particularly in combination - with <code>sscanf</code> with <tt>"...%{...%}..."</tt> scan strings (which indeed - was what it was invented for in the first place). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> - <dd></dd><dd class='body--doc'>The first arguments the function <tt>f</tt> expects - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>f</code></dt> - <dd></dd><dd class='body--doc'>The function to apply the arguments on - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>extra</code></dt> - <dd></dd><dd class='body--doc'>Optional extra arguments to send to <tt>f</tt> - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Whatever the supplied function <tt>f</tt> returns - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre><code class='expr'> -    class Product(string name, string version) -    { -      string _sprintf() -      { -        return sprintf("Product(%s/%s)", name, version); -      } -    } -    map(({ ({ "pike",   "7.1.11" }), -           ({ "whitefish", "0.1" }) }), -        Function.splice_call, Product); -    ({ /* 2 elements */ -  Product(pike/7.1.11), -  Product(whitefish/0.1) -    }) -    </code> - </pre></dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module Program</h2> - </dt><dd> + <dd class='body--doc'>If the last call done on this port failed, errno will return an + integer describing what went wrong. Refer to your unix manual for + further information. + </dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - all_inherits + <dt class='head--type'>Inherit + _port </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>program</code>) all_inherits(<code class='datatype'>program</code> <code class='argument'>p</code>)</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function. - </dd></dl> + <dd><code>inherit _port : _port</code></dd> + </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - inherit_tree + listen_fd </dt> - <dd><code><code class='datatype'>array</code> inherit_tree(<code class='datatype'>program</code> <code class='argument'>p</code>)</code></dd> + <dd><code><code class='datatype'>int</code> listen_fd(<code class='datatype'>int</code> <code class='argument'>fd</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Recursively builds a inheritance tree by - fetching programs inheritance lists. + <dd class='body--doc'>This function does the same as port->bind, except that instead + of creating a new socket and bind it to a port, it expects that + the filedescriptor 'fd' is an already open port. </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns an array with programs or arrays - as elements. + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function is only for the advanced user, and is generally used + when sockets are passed to Pike at exec time. </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>> class a{} - > class b{} - > class c{ inherit a; } - > class d{ inherit b; inherit c; } - > Program.inherit_tree(d); - Result: ({ /* 3 elements */ - d, - ({ /* 1 element */ - program - }), - ({ /* 2 elements */ - c, - ({ /* 1 element */ - program - }) - }) - }) - </pre></dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module ADT</h2> - </dt><dd><dl><dt><h2 class='header'>Class ADT.Heap</h2> - </dt><dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>bind</code>, <code>accept</code> + </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - adjust + port_accept </dt> - <dd><code><code class='datatype'>void</code> adjust(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function - </dd></dl> + <dd><code><code class='object unresolved'>Stdio.File</code> port_accept()</code></dd> + </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - push + query_address </dt> - <dd><code><code class='datatype'>void</code> push(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> + <dd><code><code class='datatype'>string</code> query_address(<code class='datatype'>string</code> <code class='argument'>arg1</code>)</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function + <dd class='body--fixme'>Document this function. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - size + query_id </dt> - <dd><code><code class='datatype'>int</code> size()</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function + <dd><code><code class='datatype'>mixed</code> query_id()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function returns the id for this port. The id is normally the + first argument to accept_callback. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>set_id</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - top + set_id </dt> - <dd><code><code class='datatype'>mixed</code> top()</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function + <dd><code><code class='datatype'>mixed</code> set_id(<code class='datatype'>mixed</code> <code class='argument'>id</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This function sets the id used for accept_callback by this port. + The default id is <code>this_object()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>query_id</code> </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class ADT.History</h2> + </dd></dl><dl><dt><h2 class='header'>Class Stdio.UDP</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>A history is a stack where you can only push entries. When the stack has - reached a certain size the oldest entries are removed on every push. - Other proposed names for this data type is leaking stack and table - (where you push objects onto the table in one end and objects are falling - off the table in the other. + <dd class='body--doc'>UDP (User Datagram Protocol) handling. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - _indices + <dt class='head--type'>Constant + MSG_OOB </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) indices( ADT.History arg )</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the index numbers of the history entries - available. + <dd><code><code class='datatype'>constant</code> Stdio.UDP.<code class='constant'>MSG_OOB</code></code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this constant. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - _sizeof + <dt class='head--type'>Constant + MSG_PEEK </dt> - <dd><code><code class='datatype'>int</code> sizeof( ADT.History arg )</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>A <code>sizeof</code> operation on this object returns the number - of elements currently in the history, e.g. <= the current - max size. + <dd><code><code class='datatype'>constant</code> Stdio.UDP.<code class='constant'>MSG_PEEK</code></code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this constant. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _values + bind </dt> - <dd><code><code class='datatype'>array</code> values( ADT.History arg )</code></dd> + <dd><code><code class='datatype'>object</code> bind(<code class='datatype'>int</code> <code class='argument'>port</code>)</code> + <code><code class='datatype'>object</code> bind(<code class='datatype'>int</code> <code class='argument'>port</code>, <code class='datatype'>string</code> <code class='argument'>address</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the values of the available history entries. + <dd class='body--doc'>Binds a port for recieving or transmitting UDP. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `[] + connect </dt> - <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.History()</code>[ <code class='class'>i</code> ]</code></dd> + <dd><code><code class='datatype'>bool</code> connect(<code class='datatype'>string</code> <code class='argument'>address</code>, <code class='datatype'>int</code> <code class='argument'>port</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get a value from the history as if it was an array, e.g. - both positive and negative numbers may be used. The positive - numbers are however offset with 1, so [1] is the first entry - in the history and [-1] is the last. + <dd class='body--doc'>Establish an UDP connection. + This function connects an UDP socket previously created with + <code>Stdio.UDP()</code> to a remote socket. The <code>address</code> is the IP name or + number for the remote machine. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <tt>1</tt> on success, <tt>0</tt> (zero) otherwise. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>If the socket is in nonblocking mode, you have to wait + for a write or close callback before you know if the connection + failed or not. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>bind()</code>, <code>query_address()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `[]= + enable_broadcast </dt> - <dd><code><code class='class'>ADT.History()</code>[ <code class='class'>i</code> ] = <code class='class'>value</code></code></dd> + <dd><code><code class='datatype'>bool</code> enable_broadcast()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Overwrite one value in the history. The history position may be - identified either by positive or negative offset, like <code>`[]</code>. + <dd class='body--doc'>Set the broadcast flag. + If enabled then sockets receive packets sent to a broadcast + address and they are allowed to send packets to a + broadcast address. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <tt>1</tt> on success, <tt>0</tt> (zero) otherwise. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This is normally only avalable to root users. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + errno </dt> - <dd><code>ADT.History ADT.History(<code class='datatype'>int</code> <code class='argument'>max_size</code>)</code></dd> + <dd><code><code class='datatype'>int</code> errno()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>max_size</code> is the maximum number of entries that can reside in the - history at the same time. + <dd class='body--doc'>Returns the error code for the last command on this object. + Error code is normally cleared when a command is successful. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - flush + get_type </dt> - <dd><code><code class='datatype'>void</code> flush()</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) get_type()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Empties the history. All entries in the history are - removed, to allow garbage collect to remove them. - The entry sequence counter is not reset. + <dd class='body--doc'>Returns socket type and protocol family. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - get_first_entry_num + <dt class='head--type'>Inherit + UDP </dt> - <dd><code><code class='datatype'>int</code> get_first_entry_num()</code></dd> + <dd><code>inherit files.UDP : UDP</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the absolute sequence number of the - oldest result still in the history. Returns 0 - if there are no results in the history. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_latest_entry_num + query_address </dt> - <dd><code><code class='datatype'>int</code> get_latest_entry_num()</code></dd> + <dd><code><code class='datatype'>string</code> query_address()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the absolute sequence number of the latest - result inserted into the history. + <dd class='body--doc'>Returns the local address of a socket on the form "x.x.x.x port". + If this file is not a socket, not connected or some other error occurs, + zero is returned. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_maxsize + read </dt> - <dd><code><code class='datatype'>int</code> get_maxsize()</code></dd> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>) read()</code> + <code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>) read(<code class='datatype'>int</code> <code class='argument'>flag</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the maximum number of values in the history + <dd class='body--doc'>Read from the UDP socket. + Flag <code>flag</code> is a bitfield, 1 for out of band data and 2 for peek </dd> - + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>mapping(string:int|string) in the form + ([ + "data" : string recieved data + "ip" : string recieved from this ip + "port" : int ...and this port + ]) + </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_maxsize</code> + <dd class='body--doc'><code>set_read_callback()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - push + send </dt> - <dd><code><code class='datatype'>void</code> push(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> + <dd><code><code class='datatype'>int</code> send(<code class='datatype'>string</code> <code class='argument'>to</code>, <code class='datatype'>int</code> <code class='argument'>port</code>, <code class='datatype'>string</code> <code class='argument'>message</code>)</code> + <code><code class='datatype'>int</code> send(<code class='datatype'>string</code> <code class='argument'>to</code>, <code class='datatype'>int</code> <code class='argument'>port</code>, <code class='datatype'>string</code> <code class='argument'>message</code>, <code class='datatype'>int</code> <code class='argument'>flags</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Push a new value into the history. + <dd class='body--doc'>Send data to a UDP socket. The recepient address will be <code>to</code> + and port will be <code>port</code>. + Flag <code>flag</code> is a bitfield, 1 for out of band data and + 2 for don't route flag. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>The number of bytes that were actually written. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - query_no_adjacent_duplicates + set_blocking </dt> - <dd><code><code class='datatype'>bool</code> query_no_adjacent_duplicates()</code></dd> + <dd><code><code class='datatype'>object</code> set_blocking()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Tells if the History object allows adjacent equal - values. 1 means that only uniqe values are allowed - adter each other. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_no_adjacent_duplicates</code> + <dd class='body--doc'>Sets this object to be blocking. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_maxsize + set_nonblocking </dt> - <dd><code><code class='datatype'>void</code> set_maxsize(<code class='datatype'>int</code> <code class='argument'>_maxsize</code>)</code></dd> + <dd><code><code class='object unresolved'>UDP</code> set_nonblocking()</code> + <code><code class='object unresolved'>UDP</code> set_nonblocking(<code class='datatype'>function</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>), <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>read_cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set the maximume number of entries that can be - stored in the history simultaneous. + <dd class='body--doc'>Set this object to nonblocking mode. + If <code>read_cb</code> and <code>extra_args</code> are specified, they will be passed on + to <code>set_read_callback()</code>. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_maxsize</code> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>The called object. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_no_adjacent_duplicates + set_read_callback </dt> - <dd><code><code class='datatype'>void</code> set_no_adjacent_duplicates(<code class='datatype'>bool</code> <code class='argument'>i</code>)</code></dd> + <dd><code><code class='object unresolved'>UDP</code> set_read_callback(<code class='datatype'>function</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>), <code class='datatype'>mixed</code> ... :<code class='datatype void'>void</code>) <code class='argument'>read_cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Change how the History object should treat two - identical values in a row. If 1 than only unique - values are allowed after each other. + <dd class='body--doc'>The <code>read_cb</code> function will receive a mapping similar to the mapping + returned by <code>read()</code>: + <table class='box'><tr><td><code><code class='key'>"data"</code> : <code class='datatype'>string</code></code></td><td>Received data. + </td></tr> + <tr><td><code><code class='key'>"ip"</code> : <code class='datatype'>string</code></code></td><td>Data was sent from this IP. + </td></tr> + <tr><td><code><code class='key'>"port"</code> : <code class='datatype'>int</code></code></td><td>Data was sent from this port. + </td></tr> + </table> </dd> - + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>The called object. + </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>query_no_adjacent_duplicates</code> + <dd class='body--doc'><code>read()</code> </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class ADT.Priority_queue</h2> - </dt><dd> + - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - adjust_pri - </dt> - <dd><code><code class='datatype'>void</code> adjust_pri(<code class='datatype'>mixed</code> <code class='argument'>handle</code>, <code class='datatype'>int</code> <code class='argument'>new_pri</code>)</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function - </dd></dl> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - Heap - </dt> - <dd><code>inherit .Heap : Heap</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - pop + set_type </dt> - <dd><code><code class='datatype'>mixed</code> pop()</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function - </dd></dl> + <dd><code><code class='datatype'>object</code> set_type(<code class='datatype'>int</code> <code class='argument'>sock_type</code>)</code> + <code><code class='datatype'>object</code> set_type(<code class='datatype'>int</code> <code class='argument'>sock_type</code>, <code class='datatype'>int</code> <code class='argument'>family</code>)</code></dd> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - push - </dt> - <dd><code><code class='datatype'>mixed</code> push(<code class='datatype'>int</code> <code class='argument'>pri</code>, <code class='datatype'>mixed</code> <code class='argument'>val</code>)</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class ADT.Queue</h2> - </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> - <dd class='body--doc'>A simple FIFO queue. + <dd class='body--doc'>Sets socket type and protocol family. </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - cast + wait </dt> - <dd><code>(int)ADT.Queue() (float)ADT.Queue() (string)ADT.Queue() (array)ADT.Queue() (mapping)ADT.Queue() (multiset)ADT.Queue()</code></dd> + <dd><code><code class='datatype'>bool</code> wait(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>timeout</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>It is possible to cast ADT.Queue to an array. + <dd class='body--doc'>Check for data and wait max. <code>timeout</code> seconds. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <tt>1</tt> if data are ready, <tt>0</tt> (zero) otherwise. </dd></dl> - + </dd></dl><dl><dt><h2 class='header'>Module Stdio.Terminfo</h2> + </dt><dd> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + getFallbackTerm </dt> - <dd><code>ADT.Queue ADT.Queue(<code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> + <dd><code><code class='modifier'>protected</code> <code class='object unresolved'>Termcap</code> getFallbackTerm(<code class='datatype'>string</code> <code class='argument'>term</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates a queue with the initial items <code>args</code> in it. + <dd class='body--doc'>Returns an object describing the fallback terminal for the terminal + <code>term</code>. This is usually equvivalent to <code>Stdio.Terminfo.getTerm("dumb")</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'>Stdio.Terminfo.getTerm </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - flush + getTerm </dt> - <dd><code><code class='datatype'>void</code> flush()</code></dd> + <dd><code><code class='object unresolved'>Termcap</code> getTerm(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>term</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Empties the queue. + <dd class='body--doc'>Returns an object describing the terminal term. If term is not specified, it will + default to <code>getenv("TERM")</code> or if that fails to "dumb". + Lookup of terminal information will first be done in the systems terminfo + database, and if that fails in the termcap database. If neither database exists, a + hardcoded entry for "dumb" will be used. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'>Stdio.Terminfo.getTerminfo, Stdio.Terminfo.getTermcap, Stdio.getFallbackTerm </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - read - Method - get + getTermcap </dt> - <dd><code><code class='datatype'>mixed</code> read()</code> - <code><code class='datatype'>mixed</code> get()</code></dd> + <dd><code><code class='object unresolved'>Termcap</code> getTermcap(<code class='datatype'>string</code> <code class='argument'>term</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the next element from the queue. + <dd class='body--doc'>Returns the terminal description object for <code>term</code> from the + systems termcap database. Returns 0 if not found. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'>Stdio.Terminfo.getTerm, Stdio.Terminfo.getTerminfo </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - is_empty + getTerminfo </dt> - <dd><code><code class='datatype'>bool</code> is_empty()</code></dd> + <dd><code><code class='object unresolved'>Terminfo</code> getTerminfo(<code class='datatype'>string</code> <code class='argument'>term</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns true if the queue is empty, - otherwise zero. + <dd class='body--doc'>Returns the terminal description object for <code>term</code> from the + systems terminfo database. Returns 0 if not found. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'>Stdio.Terminfo.getTerm, Stdio.Terminfo.getTermcap </dd></dl> - + <dl><dt><h2 class='header'>Class Stdio.Terminfo.Termcap</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Termcap terminal description object. + </dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - peek + <dt class='head--type'>Variable + aliases </dt> - <dd><code><code class='datatype'>mixed</code> peek()</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) Stdio.Terminfo.Termcap.aliases</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the next element from the queue - without removing it from the queue. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - write - Method - put + create </dt> - <dd><code><code class='datatype'>void</code> write(<code class='datatype'>mixed</code> <code class='argument'>item</code>)</code> - <code><code class='datatype'>void</code> put(<code class='datatype'>mixed</code> <code class='argument'>item</code>)</code></dd> + <dd><code>Stdio.Terminfo.Termcap Stdio.Terminfo.Termcap(<code class='datatype'>string</code> <code class='argument'>cap</code>, <code class='object unresolved'>TermcapDB</code>|<code class='datatype'>void</code> <code class='argument'>tcdb</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>maxrecurse</code>)</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Adds the <code>item</code> to the queue. - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class ADT.Stack</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This class implements a simple stack. Instead of adding and removing - elements to an array, and thus making it vary in size for every push - and pop operation, this stack tries to keep the stack size constant. - If however the stack risks to overflow, it will allocate double its - current size, i.e. pushing an element on an full 32 slot stack will - result in a 64 slot stack with 33 elements. - </dd></dl> + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - _sizeof + <dt class='head--type'>Inherit + TermMachine </dt> - <dd><code><code class='datatype'>int</code> sizeof( ADT.Stack arg )</code></dd> + <dd><code>inherit TermMachine : TermMachine</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>sizeof</code> on a stack returns the number of entries - in the stack. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _values + tputs </dt> - <dd><code><code class='datatype'>array</code> values( ADT.Stack arg )</code></dd> + <dd><code><code class='datatype'>string</code> tputs(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>values</code> on a stack returns all the entries in - the stack, in order. + <dd class='body--doc'>Put termcap string </dd></dl> - + </dd></dl><dl><dt><h2 class='header'>Class Stdio.Terminfo.Terminfo</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Terminfo terminal description object + </dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - `+ + <dt class='head--type'>Variable + aliases </dt> - <dd><code><code class='object unresolved'>this_program</code> res = <code class='class'>ADT.Stack()</code> + <code class='class'>s</code></code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) Stdio.Terminfo.Terminfo.aliases</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>A stack added with another stack yields a third - a third stack will all the stack elements from - the two first stacks. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method create </dt> - <dd><code>ADT.Stack ADT.Stack(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code>)</code></dd> + <dd><code>Stdio.Terminfo.Terminfo Stdio.Terminfo.Terminfo(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An initial stack size can be given when - a stack is cloned. The default value is - 32. - </dd></dl> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - pop + <dt class='head--type'>Inherit + TermMachine </dt> - <dd><code><code class='datatype'>mixed</code> pop(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>val</code>)</code></dd> + <dd><code>inherit TermMachine : TermMachine</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pops and returns entry <code>val</code> from the stack, counting - from the top. If no value is given the top element is - popped and returned. All popped entries are freed from - the stack. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - push + tputs </dt> - <dd><code><code class='datatype'>void</code> push(<code class='datatype'>mixed</code> <code class='argument'>val</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Push an element on the top of the stack. + <dd><code><code class='datatype'>string</code> tputs(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> - + </dd></dl></dd></dl><dl><dt><h2 class='header'>Class Stdio.Readline</h2> + </dt><dd> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - quick_pop + add_to_kill_ring </dt> - <dd><code><code class='datatype'>void</code> quick_pop(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>val</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pops <code>val</code> entries from the stack, or one entry - if no value is given. The popped entries are not - actually freed, only the stack pointer is moved. + <dd><code><code class='datatype'>void</code> add_to_kill_ring(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - reset + create </dt> - <dd><code><code class='datatype'>void</code> reset(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code>)</code></dd> + <dd><code>Stdio.Readline Stdio.Readline(<code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>infd</code>, <code class='datatype'>object</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>interm</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>outfd</code>, <code class='datatype'>object</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>outterm</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Empties the stack, resets the stack pointer - and shrinks the stack size to the given value - or 32 if none is given. + <dd class='body--doc'>Creates a Readline object, that takes input from <code>infd</code> and has output + on <code>outfd</code>. </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>create</code> + <dt class='head--doc'>Parameter <code class='parameter'>infd</code></dt> + <dd></dd><dd class='body--doc'>Defaults to <code>Stdio.stdout</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>interm</code></dt> + <dd></dd><dd class='body--doc'>Defaults to <code>Stdio.Terminfo.getTerm()</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>outfd</code></dt> + <dd></dd><dd class='body--doc'>Defaults to <code>infd</code>, unless <code>infd</code> is 0, in which case + <code>outfd</code> defaults to <code>Stdio.stdout</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>outterm</code></dt> + <dd></dd><dd class='body--doc'>Defaults to <code>interm</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_stack + delete </dt> - <dd><code><code class='datatype'>void</code> set_stack(<code class='datatype'>array</code> <code class='argument'>stack</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the stacks content to the provided array. + <dd><code><code class='datatype'>void</code> delete(<code class='datatype'>int</code> <code class='argument'>p1</code>, <code class='datatype'>int</code> <code class='argument'>p2</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - top + delta_history </dt> - <dd><code><code class='datatype'>mixed</code> top()</code></dd> + <dd><code><code class='datatype'>void</code> delta_history(<code class='datatype'>int</code> <code class='argument'>d</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the top element from the stack, without - popping it. + <dd class='body--doc'>Changes the line to a line from the history <code>d</code> steps from the + current entry (0 being the current line, negative values older, + and positive values newer). </dd> - <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an error if called on an empty stack. + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Only effective if you have a history object. </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class ADT.Struct</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Implements a struct which can be used for serialization and - deserialization of data. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>class ID3 { - inherit ADT.Struct; - Item head = Chars(3); - Item title = Chars(30); - Item artist = Chars(30); - Item album = Chars(30); - Item year = Chars(4); - Item genre = Byte(); - Item Comment = Chars(30); - } - Stdio.File f = Stdio.File("foo.mp3"); - f->seek(-128); - ADT.Struct tag = ID3(f); - if(tag->head=="TAG") { - write("Title: %s\n", tag->title); - tag->title = "A new title" + "\0"*19; - f->seek(-128); - f->write( (string)tag ); - } - </pre></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _indices + destroy </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) indices( ADT.Struct arg )</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The indices of a struct is the name of the struct items. + <dd><code><code class='datatype'>void</code> destroy()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _sizeof + edit </dt> - <dd><code><code class='datatype'>int</code> sizeof( ADT.Struct arg )</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The size of the struct object is the number of bytes - allocated for the struct. + <dd><code><code class='datatype'>string</code> edit(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>local_prompt</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>attrs</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _values + enable_history </dt> - <dd><code><code class='datatype'>array</code> values( ADT.Struct arg )</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The values of a struct is the values of the struct items. + <dd><code><code class='datatype'>void</code> enable_history(<code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='object unresolved'>History</code>|<code class='datatype'>int</code> <code class='argument'>hist</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `[] - Method - `-> + eof </dt> - <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Struct()</code>[ <code class='class'>item</code> ]</code> - <code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Struct()</code>->X</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The struct can be indexed by item name to get the - associated value. + <dd><code><code class='datatype'>void</code> eof()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `[]= - Method - `->= + get_history </dt> - <dd><code><code class='class'>ADT.Struct()</code>[ <code class='class'>item</code> ] = y</code> - <code><code class='class'>ADT.Struct()</code>->X = y</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>It is possible to assign a new value to a struct - item by indexing it by name and assign a value. + <dd><code><code class='object unresolved'>History</code> get_history()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - cast + get_input_controller </dt> - <dd><code>(int)ADT.Struct() (float)ADT.Struct() (string)ADT.Struct() (array)ADT.Struct() (mapping)ADT.Struct() (multiset)ADT.Struct()</code></dd> + <dd><code><code class='object unresolved'>InputController</code> get_input_controller()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The struct can be casted into a string, which is eqivivalent - to running <code>encode</code>, or into an array. When casted into an - array each array element is the encoded value of that struct - item. + <dd class='body--doc'>get current input control object + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Terminal input controller object </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + get_output_controller </dt> - <dd><code>ADT.Struct ADT.Struct(<code class='datatype'>void</code>|<code class='datatype'>string</code>|<code class='object unresolved'>Stdio.File</code> <code class='argument'>data</code>)</code></dd> + <dd><code><code class='object unresolved'>OutputController</code> get_output_controller()</code></dd> - <dt class='head--doc'>Parameter <code class='parameter'>data</code></dt> - <dd></dd><dd class='body--doc'>Data to be decoded and populate the struct. Can - either be a file object or a string. + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>get current output control object + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Terminal output controller object </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - decode + get_prompt </dt> - <dd><code><code class='datatype'>void</code> decode(<code class='datatype'>string</code>|<code class='object unresolved'>Stdio.File</code> <code class='argument'>data</code>)</code></dd> + <dd><code><code class='datatype'>string</code> get_prompt()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Decodes <code>data</code> according to the struct and populates - the struct variables. The <code>data</code> can either be a file - object or a string. + <dd class='body--doc'>Return the current prompt string. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - encode + getcursorpos </dt> - <dd><code><code class='datatype'>string</code> encode()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Serializes the struct into a string. This string is equal - to the string fed to <code>decode</code> if nothing in the struct - has been altered. + <dd><code><code class='datatype'>int</code> getcursorpos()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> - <dl><dt><h2 class='header'>Class ADT.Struct.Byte</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>One byte, integer value between 0 and 255. - </dd></dl> + - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>ADT.Struct.Byte ADT.Struct.Byte(<code class='datatype'>void</code>|<code class='datatype'>int(8bit)</code> <code class='argument'>initial_value</code>)</code></dd> + - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The byte can be initialized with an optional value. - </dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - Item - </dt> - <dd><code>inherit Item : Item</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class ADT.Struct.Chars</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>A string of bytes. - </dd></dl> - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - create + getmark </dt> - <dd><code>ADT.Struct.Chars ADT.Struct.Chars(<code class='datatype'>int</code> <code class='argument'>size</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>value</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The number of bytes that are part of this struct item. - The initial value of the char string is <code>value</code> or, - if not provided, a string of zero bytes. + <dd><code><code class='datatype'>int</code> getmark()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - Item - </dt> - <dd><code>inherit Item : Item</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class ADT.Struct.Item</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Interface class for struct items. - </dd></dl></dd></dl><dl><dt><h2 class='header'>Class ADT.Struct.Word</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>One word in network order, integer value between 0 and 65535. - </dd></dl> - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - create + gettext </dt> - <dd><code>ADT.Struct.Word ADT.Struct.Word(<code class='datatype'>void</code>|<code class='datatype'>int(16bit)</code> <code class='argument'>initial_value</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The byte can be initialized with an optional value. + <dd><code><code class='datatype'>string</code> gettext()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - Item - </dt> - <dd><code>inherit Item : Item</code></dd> - </dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Class ADT.struct</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>generic data structure - </dd></dl> - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - add_data + history </dt> - <dd><code><code class='datatype'>void</code> add_data(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add data to struct - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> - <dd></dd><dd class='body--doc'>data to add to end of struct + <dd><code><code class='datatype'>void</code> history(<code class='datatype'>int</code> <code class='argument'>n</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - contents + insert </dt> - <dd><code><code class='datatype'>string</code> contents()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return data, without removing it - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>contents of struct + <dd><code><code class='datatype'>void</code> insert(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>p</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + kill </dt> - <dd><code>ADT.struct ADT.struct(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>create a new struct - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>s</code></dt> - <dd></dd><dd class='body--doc'>initial data in struct + <dd><code><code class='datatype'>void</code> kill(<code class='datatype'>int</code> <code class='argument'>p1</code>, <code class='datatype'>int</code> <code class='argument'>p2</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_fix_string + kill_ring_yank </dt> - <dd><code><code class='datatype'>string</code> get_fix_string(<code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> + <dd><code><code class='datatype'>string</code> kill_ring_yank()</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_fix_uint_array + list_completions </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>mixed</code>) get_fix_uint_array(<code class='datatype'>int</code> <code class='argument'>item_size</code>, <code class='datatype'>int</code> <code class='argument'>size</code>)</code></dd> + <dd><code><code class='datatype'>void</code> list_completions(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>c</code>)</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_rest + message </dt> - <dd><code><code class='datatype'>string</code> get_rest()</code></dd> + <dd><code><code class='datatype'>void</code> message(<code class='datatype'>string</code> <code class='argument'>msg</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>get remainder of data from struct, clearing the struct - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Remaining contents of struct + <dd class='body--doc'>Print a message to the output device </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_uint + newline </dt> - <dd><code><code class='datatype'>int</code> get_uint(<code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> + <dd><code><code class='datatype'>string</code> newline()</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_var_string + pointmark </dt> - <dd><code><code class='datatype'>string</code> get_var_string(<code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) pointmark()</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_var_uint_array + read </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>mixed</code>) get_var_uint_array(<code class='datatype'>int</code> <code class='argument'>item_size</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> + <dd><code><code class='datatype'>string</code> read(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>prompt</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>attrs</code>)</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - is_empty + redisplay </dt> - <dd><code><code class='datatype'>int</code> is_empty()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>is struct empty? - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>1 if empty, 0 otherwise + <dd><code><code class='datatype'>void</code> redisplay(<code class='datatype'>int</code> <code class='argument'>clear</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>nobackup</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - pop_data + region </dt> - <dd><code><code class='datatype'>string</code> pop_data()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return all data in struct, emptying the struct - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>contents of struct + <dd><code><code class='datatype'>string</code> region(<code class='datatype'>int</code> ... <code class='argument'>args</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - put_bignum + set_blocking </dt> - <dd><code><code class='datatype'>void</code> put_bignum(<code class='datatype'>object</code> <code class='argument'>i</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>len</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_blocking()</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - put_fix_string + set_echo </dt> - <dd><code><code class='datatype'>void</code> put_fix_string(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd><code><code class='datatype'>void</code> set_echo(<code class='datatype'>int</code> <code class='argument'>onoff</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Set text echo on or off. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>onoff</code></dt> + <dd></dd><dd class='body--doc'>1 for echo, 0 for no echo. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - put_fix_uint_array + set_nonblocking </dt> - <dd><code><code class='datatype'>void</code> put_fix_uint_array(<code class='datatype'>array</code>(<code class='datatype'>int</code>) <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>item_size</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_nonblocking(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>)</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - put_uint + set_prompt </dt> - <dd><code><code class='datatype'>void</code> put_uint(<code class='datatype'>int</code> <code class='argument'>i</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> + <dd><code><code class='datatype'>string</code> set_prompt(<code class='datatype'>string</code> <code class='argument'>newp</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>newattrs</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Append an unsigned integer to struct + <dd class='body--doc'>Set the prompt string. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>i</code></dt> - <dd></dd><dd class='body--doc'>unsigned integer to append + <dt class='head--doc'>Parameter <code class='parameter'>newp</code></dt> + <dd></dd><dd class='body--doc'>New prompt string </dd> - <dt class='head--doc'>Parameter <code class='parameter'>len</code></dt> - <dd></dd><dd class='body--doc'>length of integer in bytes + <dt class='head--doc'>Parameter <code class='parameter'>newattrs</code></dt> + <dd></dd><dd class='body--doc'>Terminal attributes </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - put_var_string + setcursorpos </dt> - <dd><code><code class='datatype'>void</code> put_var_string(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> + <dd><code><code class='datatype'>int</code> setcursorpos(<code class='datatype'>int</code> <code class='argument'>p</code>)</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - put_var_uint_array + setmark </dt> - <dd><code><code class='datatype'>void</code> put_var_uint_array(<code class='datatype'>array</code>(<code class='datatype'>int</code>) <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>item_size</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> + <dd><code><code class='datatype'>int</code> setmark(<code class='datatype'>int</code> <code class='argument'>p</code>)</code></dd> <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>document me! + <dd class='body--fixme'>Document this function </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module ADT.Relation</h2> - </dt><dd><dl><dt><h2 class='header'>Class ADT.Relation.Binary</h2> - </dt><dd> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _sizeof + write </dt> - <dd><code><code class='datatype'>mixed</code> sizeof( ADT.Relation.Binary arg )</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the number of relation entries in the relation. (Or with - other words: the number of relations in the relation set.) + <dd><code><code class='datatype'>void</code> write(<code class='datatype'>string</code> <code class='argument'>msg</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>word_wrap</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> - + </dd></dl><dl><dt><h2 class='header'>Module Stdio</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>An instance of FILE("stdin"), 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. + </dd> + <dt class='head--doc'>Example</dt> + <dd class='example'><pre>int main() + { + int line; + while(string s=Stdio.stdin.gets()) + write(sprintf("%5d: %s\n",line++,s)); + } + </pre></dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `& + append_file </dt> - <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Relation.Binary()</code> & <code class='class'>rel</code></code></dd> + <dd><code><code class='datatype'>int</code> append_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>access</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The expression `rel1 & rel2' returns a new relation which has - those and only those relation entries that are present in both - rel1 and rel2. + <dd class='body--doc'>Append the string <code>str</code> onto the file <code>filename</code>. + For a description of <code>access</code>, see <code>Stdio.File->open()</code>. + </dd> + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'>Throws an error if <code>filename</code> couldn't be opened for writing. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns the number of bytes written. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>write_file()</code>, <code>read_bytes()</code>, <code>Stdio.File()->open()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `() + append_path </dt> - <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Relation.Binary()</code>()</code></dd> + <dd><code><code class='datatype'>string</code> append_path(<code class='datatype'>string</code> <code class='argument'>absolute</code>, <code class='datatype'>string</code> ... <code class='argument'>relative</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Does the same as the <code>contains</code> function: returns true if the - relation "<code>left</code> R <code>right</code>" exists, and otherwise false. + <dd class='body--doc'>Append <code>relative</code> paths to an <code>absolute</code> path and remove any + <tt>"//"</tt>, <tt>"../"</tt> or <tt>"/."</tt> to produce a straightforward + absolute path as a result. + <tt>"../"</tt> is ignorded in the relative paths if it makes the + created path begin with something else than the absolute path + (or so far created path). + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Warning: This does not work on NT. + (Consider paths like: k:/fnord) + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>combine_path()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Syntax</dt> - <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Relation.Binary()</code> | <code class='class'>rel</code></code><code><code class='datatype'>mixed</code> ADT.Relation.Binary.`+</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The expression `rel1 | rel2' and `rel1 + rel2' returns a new - relation which has all the relation entries present in rel1, - or rel2, or both. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - `- + async_cp </dt> - <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Relation.Binary()</code> - <code class='class'>rel</code></code></dd> + <dd><code><code class='datatype'>void</code> async_cp(<code class='datatype'>string</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>, <code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The expression `rel1 - rel2' returns a new relation which has - those and only those relation entries that are present in rel1 - and not present in rel2. + <dd class='body--doc'>Copy a file asynchronously. + This function is similar to <code>cp()</code>, but works asynchronously. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>from</code></dt> + <dd></dd><dd class='body--doc'>Name of file to copy. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>to</code></dt> + <dd></dd><dd class='body--doc'>Name of file to create or replace with a copy of <code>from</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>cb</code></dt> + <dd></dd><dd class='body--doc'>Function to be called on completion. + The first argument will be <tt>1</tt> on success, and <tt>0</tt> (zero) + otherwise. The rest of the arguments tp <code>callback</code> are passed + verbatim from <code>args</code>. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> + <dd></dd><dd class='body--doc'>Extra arguments to pass to <code>callback</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>For <code>callback</code> to be called, the backend must be active (ie + <code>main()</code> must have returned <tt>-1</tt>). + </dd> + <dt class='head--doc'>Bugs</dt> + <dd class='body--doc'>Currently the file sizes are not compared, so the destination file + (<code>to</code>) may be truncated. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>cp()</code>, <code>sendfile()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - add + exist </dt> - <dd><code><code class='datatype'>mixed</code> add(<code class='datatype'>mixed</code> <code class='argument'>left</code>, <code class='datatype'>mixed</code> <code class='argument'>right</code>)</code></dd> + <dd><code><code class='datatype'>int</code> exist(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Adds "<code>left</code> R <code>right</code>" as a member of the relation. Returns - the same relation. + <dd class='body--doc'>Check if a <code>path</code> exists. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns true if the given path exists (is a directory or file), + otherwise false. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>is_dir()</code>, <code>is_file()</code>, <code>is_link()</code>, <code>file_stat()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - contains + file_equal </dt> - <dd><code><code class='datatype'>mixed</code> contains(<code class='datatype'>mixed</code> <code class='argument'>left</code>, <code class='datatype'>mixed</code> <code class='argument'>right</code>)</code></dd> + <dd><code><code class='datatype'>int</code> file_equal(<code class='datatype'>string</code> <code class='argument'>file_1</code>, <code class='datatype'>string</code> <code class='argument'>file_2</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return true/false: does the relation "<code>left</code> R <code>right</code>" exist? + <dd class='body--doc'>Returns nonzero if the given paths are files with identical + content, returns zero otherwise. Zero is also returned for any + sort of I/O error. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - filter + file_size </dt> - <dd><code><code class='datatype'>object</code> filter(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>)</code></dd> + <dd><code><code class='datatype'>int</code> file_size(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Filters the entries in the relation, and returns a relation with - all those entries for which the filtering function <code>f</code> returned - true. The function <code>f</code> gets two arguments: the left and the right - value for every entry in the relation. + <dd class='body--doc'>Give the size of a file. Size -1 indicates that the file either + does not exist, or that it is not readable by you. Size -2 + indicates that it is a directory. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>file_stat()</code>, <code>write_file()</code>, <code>read_bytes()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - filter_destructively + <dt class='head--type'>Inherit + files </dt> - <dd><code><code class='datatype'>object</code> filter_destructively(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>)</code></dd> + <dd><code>inherit files : files</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Filters the entries in the relation destructively, removing all - entries for which the filtering function <code>f</code> returns false. - The function <code>f</code> gets two arguments: the left and the right value - for each entry in the relation. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - find_shortest_path + is_dir </dt> - <dd><code><code class='datatype'>array</code> find_shortest_path(<code class='datatype'>mixed</code> <code class='argument'>from</code>, <code class='datatype'>mixed</code> <code class='argument'>to</code>, <code class='datatype'>void</code>|<code class='datatype'>multiset</code> <code class='argument'>avoiding</code>)</code></dd> + <dd><code><code class='datatype'>int</code> is_dir(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Assuming the relation's domain and range sets are equal, and that - the relation xRy means "there is a path from node x to node y", - <code>find_shortest_path</code> attempts to find a path with a minimum number - of steps from one given node to another. The path is returned as an - array of nodes (including the starting and ending node), or 0 if no - path was found. If several equally short paths exist, one of them - will be chosen pseudorandomly. - Trying to find a path from a node to itself will always succeed, - returning an array of one element: the node itself. (Or in other - words, a path with no steps, only a starting/ending point). - The argument <code>avoiding</code> is either 0 (or omitted), or a multiset of - nodes that must not be part of the path. + <dd class='body--doc'>Check if a <code>path</code> is a directory. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns true if the given path is a directory, otherwise false. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>exist()</code>, <code>is_file()</code>, <code>is_link()</code>, <code>file_stat()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_id + is_file </dt> - <dd><code><code class='datatype'>mixed</code> get_id()</code></dd> + <dd><code><code class='datatype'>int</code> is_file(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the ID value which was given as first argument to create(). + <dd class='body--doc'>Check if a <code>path</code> is a file. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns true if the given path is a file, otherwise false. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>exist()</code>, <code>is_dir()</code>, <code>is_link()</code>, <code>file_stat()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - make_symmetric + is_link </dt> - <dd><code><code class='datatype'>object</code> make_symmetric()</code></dd> + <dd><code><code class='datatype'>int</code> is_link(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Makes the relation symmetric, i.e. makes sure that if xRy is part - of the relation set, then yRx should also be a part of the relation - set. + <dd class='body--doc'>Check if a <code>path</code> is a symbolic link. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns true if the given path is a symbolic link, otherwise false. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>exist()</code>, <code>is_dir()</code>, <code>is_file()</code>, <code>file_stat()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - map + mkdirhier </dt> - <dd><code><code class='datatype'>array</code> map(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>)</code></dd> + <dd><code><code class='datatype'>int</code> mkdirhier(<code class='datatype'>string</code> <code class='argument'>pathname</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>mode</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Maps every entry in the relation. The function f gets two - arguments: the left and the right relation value. Returns - an array with the return values of f for each and every - mapped entry. - Note: since the entries in the relation are not ordered, - the returned array will have its elements in no particular - order. If you need to know which relation entry produced which - result in the array, you have to make that information part - of the value that <code>f</code> returns. + <dd class='body--doc'>Creates zero or more directories to ensure that the given <code>pathname</code> is + a directory. + If a <code>mode</code> is given, it's used for the new directories after being &'ed + with the current umask (on OS'es that support this). + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns zero if it fails and nonzero if it is successful. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>mkdir()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - remove + perror </dt> - <dd><code><code class='datatype'>mixed</code> remove(<code class='datatype'>mixed</code> <code class='argument'>left</code>, <code class='datatype'>mixed</code> <code class='argument'>right</code>)</code></dd> + <dd><code><code class='datatype'>void</code> perror(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Removes "<code>left</code> R <code>right</code>" as a member of the relation. Returns - the same relation. + <dd class='body--doc'>This function prints a message to stderr along with a description + of what went wrong if available. It uses the system errno to find + out what went wrong, so it is only applicable to IO errors. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>werror()</code> </dd></dl> - <dl><dt><h2 class='header'>Class ADT.Relation.Binary._get_iterator</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An iterator which makes all the left/right entities in the relation - available as index/value pairs. - </dd></dl></dd></dl></dd></dl></dd></dl><dl><dt><h2 class='header'>Module ADT.Table</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>ADT.Table is a generic module for manipulating tables. - Each table contains one or several columns. - Each column is associated with a name, the column name. - Optionally, one can provide a column type. The Table module can do a number - of operations on a given table, like computing the sum of a column, - grouping, sorting etc. - All column references are case insensitive. A column can be referred to by - its position (starting from zero). All operations are non-destructive. That - means that a new table object will be returned after, for example, a sort. - </dd></dl><dl><dt><h2 class='header'>Class ADT.Table.table</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The table base-class. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _indices + read_bytes </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) indices( ADT.Table.table arg )</code></dd> + <dd><code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code> + <code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>)</code> + <code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns the column names for the table. The case used when - the table was created will be returned. + <dd class='body--doc'>Read <code>len</code> number of bytes from the file <code>filename</code> starting at byte + <code>start</code>, and return it as a string. + If <code>len</code> is omitted, the rest of the file will be returned. + If <code>start</code> is also omitted, the entire file will be returned. + </dd> + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'>Throws an error if <code>filename</code> isn't a regular file. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns <tt>0</tt> (zero) on failure to open <code>filename</code>. + Returns a string with the requested data otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>read_file</code>, <code>write_file()</code>, <code>append_file()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _sizeof + read_file </dt> - <dd><code><code class='datatype'>int</code> sizeof( ADT.Table.table arg )</code></dd> + <dd><code><code class='datatype'>string</code> read_file(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> + <code><code class='datatype'>string</code> read_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns the number of rows in the table. + <dd class='body--doc'>Read <code>len</code> lines from a file <code>filename</code> after skipping <code>start</code> lines + and return those lines as a string. If both <code>start</code> and <code>len</code> are omitted + the whole file is read. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>read_bytes()</code>, <code>write_file()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _values + recursive_rm </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>array</code>) values( ADT.Table.table arg )</code></dd> + <dd><code><code class='datatype'>int</code> recursive_rm(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns the contents of a table as a two dimensional array. - The format is an array of rows. Each row is an array of columns. + <dd class='body--doc'>Remove a file or directory a directory tree. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns 0 on failure, nonzero otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>rm</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `== + sendfile </dt> - <dd><code><code class='datatype'>int</code> res = <code class='class'>ADT.Table.table()</code> == <code class='class'>table</code></code></dd> + <dd><code><code class='datatype'>object</code> sendfile(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>headers</code>, <code class='object unresolved'>File</code> <code class='argument'>from</code>, <code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>int</code> <code class='argument'>len</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>trailers</code>, <code class='object unresolved'>File</code> <code class='argument'>to</code>)</code> + <code><code class='datatype'>object</code> sendfile(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>headers</code>, <code class='object unresolved'>File</code> <code class='argument'>from</code>, <code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>int</code> <code class='argument'>len</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>trailers</code>, <code class='object unresolved'>File</code> <code class='argument'>to</code>, <code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method compares two tables. They are equal if the contents - of the tables and the column names are equal. The column name - comparison is case insensitive. + <dd class='body--doc'>Sends <code>headers</code> followed by <code>len</code> bytes starting at <code>offset</code> + from the file <code>from</code> followed by <code>trailers</code> to the file <code>to</code>. + When completed <code>callback</code> will be called with the total number of + bytes sent as the first argument, followed by <code>args</code>. + Any of <code>headers</code>, <code>from</code> and <code>trailers</code> may be left out + by setting them to <tt>0</tt>. + Setting <code>offset</code> to <tt>-1</tt> means send from the current position in + <code>from</code>. + Setting <code>len</code> to <tt>-1</tt> means send until <code>from</code>'s end of file is + reached. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The sending is performed asynchronously, and may complete + before the function returns. + For <code>callback</code> to be called, the backend must be active (ie + <code>main()</code> must have returned <tt>-1</tt>). + In some cases, the backend must also be active for any sending to + be performed at all. + </dd> + <dt class='head--doc'>Bugs</dt> + <dd class='body--doc'>FIXME: Support for timeouts? + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File->set_nonblocking()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `[] + simplify_path </dt> - <dd><code><code class='datatype'>array</code> res = <code class='class'>ADT.Table.table()</code>[ <code class='class'>column</code> ]</code></dd> + <dd><code><code class='datatype'>string</code> simplify_path(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Same as <code>col()</code>. + <dd class='body--doc'>Returns a canonic representation of <code>path</code> (without /./, /../, // + and similar path segments). </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - append_bottom + <dt class='head--type'>Variable + stderr </dt> - <dd><code><code class='datatype'>object</code> append_bottom(<code class='datatype'>object</code> <code class='argument'>table</code>)</code></dd> + <dd><code><code class='object unresolved'>File</code> Stdio.stderr</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method appends two tables. The table given as an argument will be - added at the bottom of the current table. Note, the column names must - be equal. The column name comparison is case insensitive. + <dd class='body--doc'>An instance of FILE("stderr"), the standard error stream. Use this + when you want to output error messages. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - append_right + <dt class='head--type'>Variable + stdout </dt> - <dd><code><code class='datatype'>object</code> append_right(<code class='datatype'>object</code> <code class='argument'>table</code>)</code></dd> + <dd><code><code class='object unresolved'>File</code> Stdio.stdout</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method appends two tables. The table given as an argument will be - added on the right side of the current table. Note that the number of - rows in both tables must be equal. + <dd class='body--doc'>An instance of FILE("stdout"), the standatd output stream. Use this + when you want to write anything to the standard output. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - col + werror </dt> - <dd><code><code class='datatype'>array</code> col(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>column</code>)</code></dd> + <dd><code><code class='datatype'>void</code> werror(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns the contents of a given column as an array. + <dd class='body--doc'>Write a message to stderr. Stderr is normally the console, even if + the process output has been redirected to a file or pipe. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + write_file </dt> - <dd><code>ADT.Table.table ADT.Table.table(<code class='datatype'>array</code>(<code class='datatype'>array</code>) <code class='argument'>table</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>column_names</code>, <code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>))|<code class='datatype'>void</code> <code class='argument'>column_types</code>)</code></dd> + <dd><code><code class='datatype'>int</code> write_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>access</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The <code>ADT.Table.table</code> class takes two or three arguments: + <dd class='body--doc'>Write the string <code>str</code> onto the file <code>filename</code>. Any existing + data in the file is overwritten. + For a description of <code>access</code>, see <code>Stdio.File()->open()</code>. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>table</code></dt> - <dd></dd><dd class='body--doc'>The first argument is a two-dimensional array consisting of - one array of columns per row. All rows must have the same - number of columns as specified in <code>column_names</code>. + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'>Throws an error if <code>filename</code> couldn't be opened for writing. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>column_names</code></dt> - <dd></dd><dd class='body--doc'>This argument is an array of column names associated with each - column in the table. References by column name are case insensitive. - The case used in <code>column_names</code> will be used when the table is - displayed. A column can also be referred to by its position, - starting from zero. + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns the number of bytes written. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>column_types</code></dt> - <dd></dd><dd class='body--doc'>This is an optional array of mappings. The column type - information is only used when displaying the table. Currently, only the - keyword <tt>"type"</tt> is recognized. The type can be specified as - <tt>"text"</tt> or <tt>"num"</tt> (numerical). Text columns are left - adjusted, whereas numerical columns are right adjusted. If a mapping - in the array is 0 (zero), it will be assumed to be a text column. - If <code>column_types</code> is omitted, all columns will displayed as text. - See <code>ADT.Table.ASCII.encode()</code> on how to display a table. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>append_file()</code>, <code>read_bytes()</code>, <code>Stdio.File()->open()</code> + </dd></dl> + <dl><dt><h2 class='header'>Class Stdio.BlockFile</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>The Stdio.BlockFile API. + This class exists purely for typing reasons. + Use in types in place of <code>Stdio.File</code> where only blocking + I/O is done with the object. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>ADT.Table.ASCII.encode()</code> + <dd class='body--doc'><code>Stream</code>, <code>NonblockingStream</code>, <code>File</code>, <code>FILE</code> </dd></dl> - + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Inherit + Stream + </dt> + <dd><code>inherit Stream : Stream</code></dd> + </dl> + </dd></dl><dl><dt><h2 class='header'>Class Stdio.FakeFile</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>A string wrapper that pretends to be a <code>Stdio.File</code> object. + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - decode + close </dt> - <dd><code><code class='datatype'>object</code> decode(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + <dd><code><code class='datatype'>int</code> close(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>direction</code>)</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns a table object from a binary string - representation of a table, as returned by <code>encode()</code>. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->close()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - distinct + create </dt> - <dd><code><code class='datatype'>object</code> distinct(<code class='datatype'>int</code>|<code class='datatype'>string</code> ... <code class='argument'>columns</code>)</code></dd> + <dd><code>Stdio.FakeFile Stdio.FakeFile(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>type</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>pointer</code>)</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method groups by the given columns and returns a table with only - unique rows. When no columns are given, all rows will be unique. A new - table object will be returned. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->create()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - encode + dup </dt> - <dd><code><code class='datatype'>string</code> encode()</code></dd> + <dd><code><code class='object unresolved'>this_program</code> dup()</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns a binary string representation of the table. It is - useful when one wants to store a the table, for example in a file. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->dup()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - group + errno </dt> - <dd><code><code class='datatype'>object</code> group(<code class='datatype'>mapping</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>:<code class='datatype'>function</code>(:<code class='datatype void'>void</code>))|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> + <dd><code><code class='datatype'>int</code> errno()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method calls the function <code>f</code> for each column each time a - non uniqe row will be joined. The table will be grouped by the - columns not listed. The result will be returned as a new table object. + <dd class='body--doc'>Always returns 0. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->errno()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - limit + <dt class='head--type'>Constant + is_fake_file </dt> - <dd><code><code class='datatype'>object</code> limit(<code class='datatype'>int</code> <code class='argument'>n</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.FakeFile.<code class='constant'>is_fake_file</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method truncates the table to the first <code>n</code> rows and returns - a new object. + <dd class='body--doc'>This constant can be used to distinguish a FakeFile object + from a real <code>Stdio.File</code> object. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - map + line_iterator </dt> - <dd><code><code class='datatype'>object</code> map(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>)|<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>columns</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> + <dd><code><code class='object unresolved'>String.SplitIterator</code> line_iterator(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>trim</code>)</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method calls the function <code>f</code> for all rows in the table. - The value returned will replace the values in the columns given - as argument to map. If the function returns an array, several - columns will be replaced. Otherwise the first column will be - replaced. The result will be returned as a new table object. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->line_iterator()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - remove + peek </dt> - <dd><code><code class='datatype'>object</code> remove(<code class='datatype'>int</code>|<code class='datatype'>string</code> ... <code class='argument'>columns</code>)</code></dd> + <dd><code><code class='datatype'>int(-1..1)</code> peek(<code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>void</code> <code class='argument'>timeout</code>)</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Like <code>select()</code>, but the given <code>columns</code> will not be in the - resulting table. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->peek()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rename + query_address </dt> - <dd><code><code class='datatype'>object</code> rename(<code class='datatype'>string</code>|<code class='datatype'>int</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>)</code></dd> + <dd><code><code class='datatype'>int(0..0)</code> query_address(<code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>is_local</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method renames the column named <code>from</code> to <code>to</code> and - returns a new table object. Note that <code>from</code> can be the column - position. + <dd class='body--doc'>Always returns 0. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->query_address()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - reverse + query_id </dt> - <dd><code><code class='datatype'>object</code> reverse()</code></dd> + <dd><code><code class='datatype'>mixed</code> query_id()</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method reverses the rows of the table and returns a - new table object. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->query_id()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - row + read </dt> - <dd><code><code class='datatype'>array</code> row(<code class='datatype'>int</code> <code class='argument'>row_number</code>)</code></dd> + <dd><code><code class='datatype'>string</code> read(<code class='datatype'>void</code>|<code class='datatype'>int(0..)</code> <code class='argument'>len</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>not_all</code>)</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns the contents of a given row as an array. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->read()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rsort + read_function </dt> - <dd><code><code class='datatype'>object</code> rsort(<code class='datatype'>int</code>|<code class='datatype'>string</code> ... <code class='argument'>columns</code>)</code></dd> + <dd><code><code class='datatype'>function</code>(:<code class='datatype'>string</code>) read_function(<code class='datatype'>int</code> <code class='argument'>nbytes</code>)</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Like <code>sort()</code>, but in descending order. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->read_function()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - select + seek </dt> - <dd><code><code class='datatype'>object</code> select(<code class='datatype'>int</code>|<code class='datatype'>string</code> ... <code class='argument'>columns</code>)</code></dd> + <dd><code><code class='datatype'>int</code> seek(<code class='datatype'>int</code> <code class='argument'>pos</code>, <code class='datatype'>int</code> <code class='argument'>mult</code>, <code class='datatype'>int</code> <code class='argument'>add</code>)</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns a new table object with the selected columns only. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->seek()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - sort + set_id </dt> - <dd><code><code class='datatype'>object</code> sort(<code class='datatype'>int</code>|<code class='datatype'>string</code> ... <code class='argument'>columns</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_id(<code class='datatype'>mixed</code> <code class='argument'>_id</code>)</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method sorts the table in ascendent order on one or several columns - and returns a new table object. The left most column is sorted last. Note - that the sort is stable. - </dd> + <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>rsort()</code> + <dd class='body--doc'><code>Stdio.File()->set_id()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - sum + tell </dt> - <dd><code><code class='datatype'>object</code> sum(<code class='datatype'>int</code>|<code class='datatype'>string</code> ... <code class='argument'>columns</code>)</code></dd> + <dd><code><code class='datatype'>int</code> tell()</code></dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method sums all equal rows. The table will be grouped by the - columns not listed. The result will be returned as a new table object. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->tell()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - type + truncate </dt> - <dd><code><code class='datatype'>mapping</code> type(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>column</code>, <code class='datatype'>void</code>|<code class='datatype'>mapping</code> <code class='argument'>type</code>)</code></dd> + <dd><code><code class='datatype'>bool</code> truncate(<code class='datatype'>int</code> <code class='argument'>length</code>)</code></dd> - + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->truncate()</code> + </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class Stdio.NonblockingStream</h2> + </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method gives the type for the given <code>column</code>. - If a second argument is given, the old type will be replaced - with <code>type</code>. The column type is only used when the table is displayed. - The format is as specified in <code>create()</code>. + <dd class='body--doc'>The Stdio.NonblockingStream API. + This class exists purely for typing reasons. + Use in types in place of <code>Stdio.File</code> where nonblocking and/or blocking + stream-oriented I/O is done with the object. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stream</code>, <code>BlockFile</code>, <code>File</code>, <code>FILE</code> </dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - where + <dt class='head--type'>Inherit + Stream </dt> - <dd><code><code class='datatype'>object</code> where(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>)|<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>columns</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - + <dd><code>inherit Stream : Stream</code></dd> + </dl> + </dd></dl><dl><dt><h2 class='header'>Class Stdio.Stat</h2> + </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method calls the function for each row. If the function - returns zero, the row will be thrown away. If the function - returns something non-zero, the row will be kept. The result - will be returned as a new table object. + <dd class='body--doc'>This object is used to represent file status information + from e.g. <code>file_stat()</code>. + It contains the following items usually found in a C <tt>struct + stat</tt>: + <dl class='group--doc'><dt>mode</dt> + <dd>File mode (see <tt>mknod(2)</tt>). + </dd> + <dt>size</dt> + <dd>File size in bytes. + </dd> + <dt>uid</dt> + <dd>User ID of the file's owner. + </dd> + <dt>gid</dt> + <dd>Group ID of the file's owner. + </dd> + <dt>atime</dt> + <dd>Time of last access in seconds since 00:00:00 UTC, 1970-01-01. + </dd> + <dt>mtime</dt> + <dd>Time of last data modification. + </dd> + <dt>ctime</dt> + <dd>Time of last file status change. + </dd> + <dt>ino</dt> + <dd>Inode number. + </dd> + <dt>nlink</dt> + <dd>Number of links. + </dd> + <dt>dev</dt> + <dd>ID of the device containing a directory entry for this file. + </dd> + <dt>rdev</dt> + <dd>ID of the device. + </dd> + </dl>It also contains some items that correspond to the C <tt>IS*</tt> macros: + <dl class='group--doc'><dt>isreg</dt> + <dd>Set if the file is a regular file. + </dd> + <dt>isdir</dt> + <dd>Set if the file is a directory. + </dd> + <dt>islnk</dt> + <dd>Set if the file is a symbolic link. Note that symbolic links + are normally followed by the stat functions, so this might + only be set if you turn that off, e.g. by giving a nonzero + second argument to <code>file_stat()</code>. + </dd> + <dt>isfifo</dt> + <dd>Set if the file is a FIFO (aka named pipe). + </dd> + <dt>issock</dt> + <dd>Set if the file is a socket. + </dd> + <dt>ischr</dt> + <dd>Set if the file is a character device. + </dd> + <dt>isblk</dt> + <dd>Set if the file is a block device. + </dd> + </dl>There are also some items that provide alternative representations + of the above: + <dl class='group--doc'><dt>type</dt> + <dd>The type as a string, can be any of <tt>"reg"</tt>, + <tt>"dir"</tt>, <tt>"lnk"</tt>, <tt>"fifo"</tt>, <tt>"sock"</tt>, + <tt>"chr"</tt>, <tt>"blk"</tt>, and <tt>"unknown"</tt>. + </dd> + <dt>mode_string</dt> + <dd>The file mode encoded as a string in <tt>ls -l</tt> style, e.g. + <tt>"drwxr-xr-x"</tt>. + </dd> + </dl>Note that some items might not exist or have meaningful values + on some platforms. + Additionally, the object may be initialized from or casted to an + <tt>array</tt> on the form of a 'traditional' LPC stat-array, and + it's also possible to index the object directly with integers as + if it were such an array. The stat-array has this format: + <table class='box'><tr><td colspan='2'>Array</td></tr> + <tr><td><code><code class='datatype'>int</code> <code class='key'>0</code></code></td><td>File mode, same as <tt>mode</tt>. + </td></tr> + <tr><td><code><code class='datatype'>int</code> <code class='key'>1</code></code></td><td>If zero or greater, the file is a regular file and this is + its size in bytes. If less than zero it gives the type: + -2=directory, -3=symlink and -4=device. + </td></tr> + <tr><td><code><code class='datatype'>int</code> <code class='key'>2</code></code></td><td>Time of last access, same as <tt>atime</tt>. + </td></tr> + <tr><td><code><code class='datatype'>int</code> <code class='key'>3</code></code></td><td>Time of last data modification, same as <tt>mtime</tt>. + </td></tr> + <tr><td><code><code class='datatype'>int</code> <code class='key'>4</code></code></td><td>Time of last file status change, same as <tt>ctime</tt>. + </td></tr> + <tr><td><code><code class='datatype'>int</code> <code class='key'>5</code></code></td><td>User ID of the file's owner, same as <tt>uid</tt>. + </td></tr> + <tr><td><code><code class='datatype'>int</code> <code class='key'>6</code></code></td><td>Group ID of the file's owner, same as <tt>gid</tt>. + </td></tr> + </table>It's possible to modify the stat struct by assigning values to + the items. They essentially work as variables, although some of + them affect others, e.g. setting <tt>isdir</tt> clears <tt>isreg</tt> + and setting <tt>mode_string</tt> changes many of the other items. </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module ADT.Table.ASCII</h2> - </dt><dd> + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - encode + create </dt> - <dd><code><code class='datatype'>string</code> encode(<code class='datatype'>object</code> <code class='argument'>table</code>, <code class='datatype'>void</code>|<code class='datatype'>mapping</code> <code class='argument'>options</code>)</code></dd> + <dd><code>Stdio.Stat Stdio.Stat(<code class='datatype'>void</code>|<code class='datatype'>object</code>|<code class='datatype'>array</code> <code class='argument'>stat</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This method returns a table represented in ASCII suitable for human eyes. - <code>options</code> is an optional mapping. If the keyword <tt>"indent"</tt> is used - with a number, the table will be indented with that number of space - characters. - </dd></dl> + <dd class='body--doc'>A new <code>Stdio.Stat</code> object can be initialized in two ways: + <ul> + <li><code>stat</code> is an object, typically another <code>Stdio.Stat</code>. The + stat info is copied from the object by getting the values of + <tt>mode</tt>, <tt>size</tt>, <tt>atime</tt>, <tt>mtime</tt>, <tt>ctime</tt>, + <tt>uid</tt>, <tt>gid</tt>, <tt>dev</tt>, <tt>ino</tt>, <tt>nlink</tt>, and + <tt>rdev</tt>. + </li><li><code>stat</code> is a seven element array on the 'traditional' LPC + stat-array form (see the class doc). + </li></ul></dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class Stdio.Stream</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>The Stdio.Stream API. + This class exists purely for typing reasons. + Use in types in place of <code>Stdio.File</code> where only blocking stream-oriented + I/O is done with the object. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>NonblockingStream</code>, <code>BlockFile</code>, <code>File</code>, <code>FILE</code> </dd></dl></dd></dl></dd></dl></dd></dl></body></html>

autodoc.git/ traditional_manual/ chapter_9.html

2003-02-04

2003-02-04 23:58:40 by Martin Nilsson <mani@lysator.liu.se>