Log of autodoc.git/traditional_manual/chapter

2002-07-14

2002-07-14 23:24:33 by Martin Nilsson <mani@lysator.liu.se>

50af35eef7170ec7dc7c5e74eb64f084c3afac15 (3397 lines) (+904/-2493) ^{[

Show
| Annotate

]}
Branch: 8.0

Build with hilfe documentation

Rev: refdoc/structure/traditional.xml:1.17

1: <!doctype html><html><head><title>Pike Reference Manual</title> <meta charset='utf-8'></head> - <body><dl><dt><h1 class='header'>9. Parsers</h1></dt><dd><dl><dt><h2 class='header'>Module Parser.XML</h2> - </dt><dd><dl><dt><h2 class='header'>Class Parser.XML.Simple</h2> + <body><dl><dt><h1 class='header'>9. Specific Datatype Modules</h1></dt><dd><dl><dt><h2 class='header'>Module String</h2> </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - allow_rxml_entities + capitalize </dt> - <dd><code><code class='datatype'>void</code> allow_rxml_entities(<code class='datatype'>bool</code> <code class='argument'>yes_no</code>)</code></dd> - </dl> + <dd><code><code class='datatype'>string</code> capitalize(<code class='datatype'>string</code> <code class='argument'>str</code>)</code></dd> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - autoconvert - </dt> - <dd><code><code class='datatype'>string</code> autoconvert(<code class='datatype'>string</code> <code class='argument'>xml</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - define_entity - </dt> - <dd><code><code class='datatype'>void</code> define_entity(<code class='datatype'>string</code> <code class='argument'>entity</code>, <code class='datatype'>string</code> <code class='argument'>raw</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extras</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - define_entity_raw - </dt> - <dd><code><code class='datatype'>void</code> define_entity_raw(<code class='datatype'>string</code> <code class='argument'>entity</code>, <code class='datatype'>string</code> <code class='argument'>raw</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - parse_dtd - </dt> - <dd><code><code class='datatype'>mixed</code> parse_dtd(<code class='datatype'>string</code> <code class='argument'>dtd</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extras</code>)</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class Parser.XML.Validating</h2> - </dt><dd> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Simple - </dt> - <dd><code>inherit Parser.XML.Simple : Simple</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - parse - </dt> - <dd><code><code class='datatype'>array</code> parse(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>function</code>(<code class='datatype'>string</code>, <code class='datatype'>string</code>, <code class='datatype'>mapping</code>, <code class='datatype'>array</code>|<code class='datatype'>string</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>), <code class='datatype'>mixed</code> ... :<code class='datatype'>mixed</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</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 - parse_dtd - </dt> - <dd><code><code class='datatype'>array</code> parse_dtd(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>function</code>(<code class='datatype'>string</code>, <code class='datatype'>string</code>, <code class='datatype'>mapping</code>, <code class='datatype'>array</code>|<code class='datatype'>string</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>), <code class='datatype'>mixed</code> ... :<code class='datatype'>mixed</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</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 Parser.XML.NSTree</h2> - </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> - <dd class='body--doc'>A namespace aware version of Parser.XML.Tree. This implementation - does as little validation as possible, so e.g. you can call your - namespace xmlfoo without complaints. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Tree - </dt> - <dd><code>inherit Parser.XML.Tree : Tree</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - parse_input - </dt> - <dd><code><code class='object unresolved'>NSNode</code> parse_input(<code class='datatype'>string</code> <code class='argument'>data</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Takes a XML string <code>data</code> and produces a namespace node tree. + <dd class='body--doc'>Convert the first character in <code>str</code> to upper case, and return the + new string. </dd> - <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an <code>error</code> when an error is encountered during XML - parsing. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>lower_case()</code>, <code>upper_case()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - visualize + common_prefix </dt> - <dd><code><code class='datatype'>string</code> visualize(<code class='object unresolved'>Node</code> <code class='argument'>n</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>indent</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Makes a visualization of a node graph suitable for - printing out on a terminal. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>> object x = parse_input("<a><c/>d<e/><f>g</f></a>"); - > write(visualize(x)); - Node(ROOT) - NSNode(ELEMENT,"a") - NSNode(ELEMENT,"b") - NSNode(ELEMENT,"c") - NSNode(TEXT) - NSNode(ELEMENT,"b") - NSNode(ELEMENT,"e") - NSNode(ELEMENT,"f") - NSNode(TEXT) - Result 1: 201 - </pre></dd></dl> - <dl><dt><h2 class='header'>Class Parser.XML.NSTree.NSNode</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Namespace aware node. + <dd class='body--doc'>Find the longest common prefix from an array of strings. </dd></dl> - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - diff_namespaces - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) diff_namespaces()</code></dd> + - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the difference between this nodes and its parents namespaces. - </dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_default_ns + expand_tabs </dt> - <dd><code><code class='datatype'>string</code> get_default_ns()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the default namespace in the current scope. + <dd class='body--doc'>Expands tabs in a string to ordinary spaces, according to common + tabulation rules. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_defined_nss + fuzzymatch </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) get_defined_nss()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns a mapping with all the namespaces defined in the current - scope, except the default namespace. + <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> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The return mapping is the same as the one in the node, so - destructive changes will affect the node. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_ns + implode_nicely </dt> - <dd><code><code class='datatype'>string</code> get_ns()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the namespace in which the current element is defined in. + <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> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>`*()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_ns_attributes + int2roman </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>)) get_ns_attributes()</code></dd> + <dd><code><code class='datatype'>string</code> int2roman(<code class='datatype'>int</code> <code class='argument'>m</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns all the attributes in all namespaces that is associated with - this node. + <dd class='body--doc'>Converts the provided integer to a roman integer (i.e. a string). </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_ns_attributes + int2size </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) get_ns_attributes(<code class='datatype'>string</code> <code class='argument'>namespace</code>)</code></dd> + <dd><code><code class='datatype'>string</code> int2size(<code class='datatype'>int</code> <code class='argument'>size</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the attributes in this node that is declared in the provided - namespace. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_xml_name + sillycaps </dt> - <dd><code><code class='datatype'>string</code> get_xml_name()</code></dd> + <dd><code><code class='datatype'>string</code> sillycaps(<code class='datatype'>string</code> <code class='argument'>str</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the element name as it occurs in xml files. E.g. - "zonk:name" for the element "name" defined in a namespace - denoted with "zonk". It will look up a symbol for the namespace - in the symbol tables for the node and its parents. If none is - found a new label will be generated by hashing the namespace. + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - Node - </dt> - <dd><code>inherit Node : Node</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - remove_child + soundex </dt> - <dd><code><code class='datatype'>void</code> remove_child(<code class='object unresolved'>NSNode</code> <code class='argument'>child</code>)</code></dd> + <dd><code><code class='datatype'>string</code> soundex(<code class='datatype'>string</code> <code class='argument'>word</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The remove_child is a not updated to take care of name - space issues. To properly remove all the parents name spaces - from the chid, call <code>remove_node</code> in the child. + <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. </dd></dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Module Parser.XML.Tree</h2> - </dt><dd> + - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - STOP_WALK - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>STOP_WALK</code></code></dd> - </dl> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Constant - XML_ATTR - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_ATTR</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Attribute nodes are created on demand - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - XML_COMMENT - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_COMMENT</code></code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - XML_DOCTYPE - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_DOCTYPE</code></code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - XML_ELEMENT - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_ELEMENT</code></code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - XML_HEADER - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_HEADER</code></code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - XML_NODE - </dt> - <dd><code><code class='datatype'>constant</code> Parser.XML.Tree.<code class='constant'>XML_NODE</code></code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - XML_PI - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_PI</code></code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - XML_ROOT - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_ROOT</code></code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - XML_TEXT - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_TEXT</code></code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - parse_file + strmult </dt> - <dd><code><code class='object unresolved'>Node</code> parse_file(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> + <dd><code><code class='datatype'>string</code> strmult(<code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>int</code> <code class='argument'>num</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Loads the XML file <code>path</code>, creates a node tree representation and - returns the root node. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - parse_input - </dt> - <dd><code><code class='object unresolved'>Node</code> parse_input(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>no_fallback</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>force_lowercase</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Takes a XML string and produces a node tree. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - parse_xml_callback - </dt> - <dd><code><code class='datatype'>mixed</code> parse_xml_callback(<code class='datatype'>string</code> <code class='argument'>type</code>, <code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mapping</code> <code class='argument'>attr</code>, <code class='datatype'>string</code>|<code class='datatype'>array</code> <code class='argument'>contents</code>, <code class='datatype'>mixed</code> <code class='argument'>location</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</code>)</code></dd> - </dl> - <dl><dt><h2 class='header'>Class Parser.XML.Tree.AbstractNode</h2> - </dt><dd> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - `[] - </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> res = <code class='class'>Parser.XML.Tree.AbstractNode()</code>[ <code class='class'>pos</code> ]</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The [] operator indexes among the node children, so - <code class='expr'>node[0]</code> returns the first node and <code class='expr'>node[-1]</code> the last. + <dd class='body--doc'>This function multiplies <code>str</code> by <code>num</code>. The return value is the same + as appending <code>str</code> to an empty string <code>num</code> times. </dd> <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The [] operator will select a node from all the nodes children, - not just its element children. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_child - </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> add_child(<code class='object unresolved'>AbstractNode</code> <code class='argument'>c</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Adds a child node to this node. The child node is - added last in the child list and its parent reference - is updated. + <dd class='body--doc'>This function is obsolete, since this functionality has been incorporated + into <code>`*()</code>. </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The updated child node is returned. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>`*()</code> </dd></dl> - + <dl><dt><h2 class='header'>Class String.SplitIterator</h2> + </dt><dd> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - clone + create </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> clone(<code class='datatype'>void</code>|<code class='datatype'>int(-1..1)</code> <code class='argument'>direction</code>)</code></dd> + <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> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the corresponding node in a clone of the tree. - </dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - count_children + elite_string </dt> - <dd><code><code class='datatype'>int</code> count_children()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the number of children of the node. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_ancestors + elite_word </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_ancestors(<code class='datatype'>bool</code> <code class='argument'>include_self</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns a list of all ancestors, with the top node last. - The list will start with this node if <code>include_self</code> is set. + <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></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_children - </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_children()</code></dd> - + </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'>Returns all the nodes children. + <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 - get_descendants + pad_rows </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_descendants(<code class='datatype'>bool</code> <code class='argument'>include_self</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns a list of all descendants in document order. Includes - this node if <code>include_self</code> is set. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_following + select </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_following()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns all the nodes that follows after the current one. - </dd></dl> + <dd class='body--doc'>Creates an HTML select list. + </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> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_following_siblings + simple_obox </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_following_siblings()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns all following siblings, i.e. all siblings present after this node - in the parents children list. + <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> + <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></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_last_child - </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> get_last_child()</code></dd> - + <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'>Returns the last childe node or zero. + <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 - get_parent + add_cell </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> get_parent()</code></dd> + <dd><code><code class='datatype'>void</code> add_cell(<code class='datatype'>string</code> <code class='argument'>contents</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the parent node. + <dd class='body--doc'>Adds a cell with the provided content. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_preceding + add_raw_cell </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_preceding()</code></dd> + <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'>Returns all preceding nodes, excluding this nodes ancestors. + <dd class='body--doc'>Adds this cell to the table unmodified, e.g. it should have an enclosing + td or th element. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_preceding_siblings + add_row </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_preceding_siblings()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns all preceding siblings, i.e. all siblings present before this node - in the parents children list. + <dd class='body--doc'>Adds a complete row. If the current row is nonempty a + new row will be started. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_root + add_tagdata_cell </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> get_root()</code></dd> + <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'>Follows all parent pointers and returns the root node. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_siblings - </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_siblings()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns all siblings, including this node. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - iterate_children - </dt> - <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> iterate_children(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</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'>Iterates over the nodes children from left to right, calling the callback - function for every node. If the callback function returns <code>STOP_WALK</code> - the iteration is promptly aborted and <code>STOP_WALK</code> is returned. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_child - </dt> - <dd><code><code class='datatype'>void</code> remove_child(<code class='object unresolved'>AbstractNode</code> <code class='argument'>c</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Removes all occurences of the provided node from the called nodes - list of children. The removed nodes parent reference is set to null. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_node - </dt> - <dd><code><code class='datatype'>void</code> remove_node()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Removes this node from its parent. The parent reference is set to null. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - replace_child - </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> replace_child(<code class='object unresolved'>AbstractNode</code> <code class='argument'>old</code>, <code class='object unresolved'>AbstractNode</code> <code class='argument'>new</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Replaces the first occurence of the old node child with - the new node child. All parent references are updated. + <dd class='body--doc'>Creates a cell from the provided arguments and adds it to the table. </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the new child node. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - replace_children - </dt> - <dd><code><code class='datatype'>void</code> replace_children(<code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) <code class='argument'>children</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Replaces the nodes children with the provided ones. All parent - references are updated. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - replace_node - </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> replace_node(<code class='object unresolved'>AbstractNode</code> <code class='argument'>new</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Replaces this node with the provided one. + <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'>Returns</dt> - <dd class='body--doc'>Returns the new node. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_parent - </dt> - <dd><code><code class='datatype'>void</code> set_parent(<code class='object unresolved'>AbstractNode</code> <code class='argument'>parent</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the parent node to <code>parent</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - walk_inorder - </dt> - <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> walk_inorder(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</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'>Traverse the node subtree in inorder, left subtree first, then - root node, and finally the remaining subtrees, calling the callback - function for every node. If the callback function returns - <code>STOP_WALK</code> the traverse is promptly aborted and <code>STOP_WALK</code> - is returned. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - walk_postorder - </dt> - <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> walk_postorder(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</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'>Traverse the node subtree in postorder, first subtrees from left to - right, then the root node, calling the callback function for every - node. If the callback function returns <code>STOP_WALK</code> the traverse - is promptly aborted and <code>STOP_WALK</code> is returned. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - walk_preorder - </dt> - <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> walk_preorder(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</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'>Traverse the node subtree in preorder, root node first, then - subtrees from left to right, calling the callback function - for every node. If the callback function returns <code>STOP_WALK</code> - the traverse is promptly aborted and <code>STOP_WALK</code> is returned. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - walk_preorder_2 - </dt> - <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> walk_preorder_2(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</code>|<code class='datatype'>void</code>) <code class='argument'>callback_1</code>, <code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</code>|<code class='datatype'>void</code>) <code class='argument'>callback_2</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Traverse the node subtree in preorder, root node first, then - subtrees from left to right. For each node we call callback_1 - before iterating through children, and then callback_2 - (which always gets called even if the walk is aborted earlier). - If the callback function returns <code>STOP_WALK</code> the traverse - decend is aborted and <code>STOP_WALK</code> is returned once all waiting - callback_2 functions has been called. - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Parser.XML.Tree.Node</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Node in XML tree - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + cast </dt> - <dd><code>(int)Parser.XML.Tree.Node() (float)Parser.XML.Tree.Node() (string)Parser.XML.Tree.Node() (array)Parser.XML.Tree.Node() (mapping)Parser.XML.Tree.Node() (multiset)Parser.XML.Tree.Node()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>It is possible to cast a node to a string, which will return - <code>render_xml()</code> for that node. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - clone - </dt> - <dd><code><code class='object unresolved'>Node</code> clone(<code class='datatype'>void</code>|<code class='datatype'>int(-1..1)</code> <code class='argument'>direction</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Clones the node, optionally connected to parts of the tree. - If direction is -1 the cloned nodes parent will be set, if - direction is 1 the clone nodes childen will be set. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + create </dt> - <dd><code>Parser.XML.Tree.Node Parser.XML.Tree.Node(<code class='datatype'>int</code> <code class='argument'>type</code>, <code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mapping</code> <code class='argument'>attr</code>, <code class='datatype'>string</code> <code class='argument'>text</code>)</code></dd> + <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> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_any_name + new_row </dt> - <dd><code><code class='datatype'>string</code> get_any_name()</code></dd> + <dd><code><code class='datatype'>void</code> new_row()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return name of tag or name of attribute node. + <dd class='body--doc'>Begin a new row. Succeeding cells will be added to this + row instead of the current. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_attr_name + pad_rows </dt> - <dd><code><code class='datatype'>string</code> get_attr_name()</code></dd> + <dd><code><code class='datatype'>void</code> pad_rows()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the name of the attribute node. + <dd class='body--doc'>Ensures that all rows have the same number of cells. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_attribute_nodes + render </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>Node</code>) get_attribute_nodes()</code></dd> + <dd><code><code class='datatype'>string</code> render()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates and returns an array of new nodes; they will not be - added as proper children to the parent node, but the parent - link in the nodes are set so that upwards traversal is made - possible. + <dd class='body--doc'>Returns the result. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_attributes + set_cell_callback </dt> - <dd><code><code class='datatype'>mapping</code> get_attributes()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns this nodes attributes, which can be altered - destructivly to alter the nodes attributes. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_doc_order - </dt> - <dd><code><code class='datatype'>int</code> get_doc_order()</code></dd> + <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> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_elements + set_extra_args </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_elements(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>name</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns all element children to this node. If a <code>name</code> - is provided, only elements with that name is returned. + <dd class='body--doc'>The argument in the mappings will be added to the cell in the + cooresponding column of the table. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_first_element + set_extra_args </dt> - <dd><code><code class='object unresolved'>AbstractNode</code> get_first_element(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>name</code>)</code></dd> + <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'>Returns the first element child to this node. If a <code>name</code> - is provided, the first element child with that name is - returned. Returns 0 if no matching node was found. + <dd class='body--doc'>The argument in the mapping will be added to all created table cells. </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 - get_node_type + arrayify </dt> - <dd><code><code class='datatype'>int</code> get_node_type()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the node type. See defined node type constants. + <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> + <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 + </dd> + <dt>zero_type(x)</dt> + <dd>arrayify(x) => ({}) + </dd> + <dt>otherwise</dt> + <dd>arrayify(x) => ({ x }) + </dd> + </dl> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_tag_name + count </dt> - <dd><code><code class='datatype'>string</code> get_tag_name()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the name of the element node, or the nearest element above if - an attribute node. + <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> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>String.count</code>, <code>search</code>, <code>has_value</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_text + dwim_sort_func </dt> - <dd><code><code class='datatype'>string</code> get_text()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns text content in node. + <dd class='body--doc'>Sort without respect to number formatting (most notably leading + zeroes). </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - AbstractNode - </dt> - <dd><code>inherit AbstractNode : AbstractNode</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - render_xml + flatten </dt> - <dd><code><code class='datatype'>string</code> render_xml()</code></dd> + <dd><code><code class='datatype'>array</code> flatten(<code class='datatype'>array</code> <code class='argument'>a</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates an XML representation of the nodes sub tree. + <dd class='body--doc'>Flatten a multi-dimensional array to a one-dimensional array. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_doc_order + greedy_diff </dt> - <dd><code><code class='datatype'>void</code> set_doc_order(<code class='datatype'>int</code> <code class='argument'>o</code>)</code></dd> - </dl> + <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> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - value_of_node - </dt> - <dd><code><code class='datatype'>string</code> value_of_node()</code></dd> - + <dt class='head--doc'>Description</dt> - <dd class='body--doc'>If the node is an attribute node or a text node, its value is returned. - Otherwise the child text nodes are concatenated and returned. + <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></dl> - </dd></dl></dd></dl></dd></dl><dl><dt><h2 class='header'>Class Parser.HTML</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This is a simple parser for SGML structured markups. - It's not really HTML, but it's useful for that - purpose. + - - The simple way to use it is to give it some information - about available tags and containers, and what - callbacks those is to call. + - - The object is easily reused, by calling the <code>clone</code>() - function. - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>add_tag</code>, <code>add_container</code>, <code>clone</code></dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _inspect + lyskom_sort_func </dt> - <dd><code><code class='object unresolved'>mapping </code> _inspect()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This is a low-level way of debugging a parser. - This gives a mapping of the internal state - of the Parser.HTML object. - - - The format and contents of this mapping may - change without further notice. + <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 - _set_tag_callback - Method - _set_entity_callback - Method - _set_data_callback + oid_sort_func </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> _set_tag_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>to_call</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> _set_entity_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>to_call</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> _set_data_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>to_call</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - These functions set up the parser object to - call the given callbacks upon tags, entities - and/or data. - - - The callbacks will only be called if there isn't - another tag/container/entity handler for these. - - - The function will be called with the parser - object as first argument, and the active string - as second. - - - Note that no parsing of the contents has been done. - Both endtags and normal tags are called, there is - no container parsing. - - - The return values from the callbacks are handled in the - same way as the return values from callbacks registered with - <code>add_tag</code> and similar functions. - - - The data callback will be called as seldom as possible with - the longest possible string, as long as it doesn't get called - out of order with any other callback. It will never be called - with a zero length string. - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the called object + <dd class='body--doc'>Sort with care of numerical sort for OID values: + "1.2.1" before "1.11.1" </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - add_tag - Method - add_container - Method - add_entity - Method - add_quote_tag - Method - add_tags - Method - add_containers - Method - add_entities + random </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> add_tag(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mixed</code> <code class='argument'>to_do</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> add_container(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mixed</code> <code class='argument'>to_do</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> add_entity(<code class='datatype'>string</code> <code class='argument'>entity</code>, <code class='datatype'>mixed</code> <code class='argument'>to_do</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> add_quote_tag(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mixed</code> <code class='argument'>to_do</code>, <code class='datatype'>string</code> <code class='argument'>end</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> add_tags(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) <code class='argument'>tags</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> add_containers(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) <code class='argument'>containers</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> add_entities(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) <code class='argument'>entities</code>)</code></dd> + <dd><code><code class='datatype'>mixed</code> random(<code class='datatype'>array</code> <code class='argument'>in</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Registers the actions to take when parsing various things. - Tags, containers, entities are as usual. add_quote_tag() adds - a special kind of tag that reads any data until the next - occurrence of the end string immediately before a tag end. - - <tt>to_do</tt> can be: - - <ul> - <li>a function to be called. The function is on the form - <pre> - mixed tag_callback(Parser.HTML parser,mapping args,mixed ... extra) - mixed container_callback(Parser.HTML parser,mapping args,string content,mixed ... extra) - mixed entity_callback(Parser.HTML parser,mixed ... extra) - mixed quote_tag_callback(Parser.HTML parser,string content,mixed ... extra) - </pre> - depending on what realm the function is called by.</li><li>a string. This tag/container/entity is then replaced - by the string. The string is normally not reparsed, i.e. it's - equivalent to writing a function that returns the string in an - array (but a lot faster). If <code>reparse_strings</code> is - set the string will be reparsed, though.</li><li>an array. The first element is a function as above. - It will receive the rest of the array as extra arguments. If - extra arguments are given by <code>set_extra</code>(), they will - appear after the ones in this array.</li><li>zero. If there is a tag/container/entity with the - given name in the parser, it's removed.</li></ul> - - The callback function can return: - - <ul> - <li>a string; this string will be pushed on the parser - stack and be parsed. Be careful not to return anything - in this way that could lead to a infinite recursion.</li><li>an array; the element(s) of the array is the result - of the function. This will not be parsed. This is useful for - avoiding infinite recursion. The array can be of any size, - this means the empty array is the most effective to return if - you don't care about the result. If the parser is operating in - <code>mixed_mode</code>, the array can contain anything. - Otherwise only strings are allowed.</li><li>zero; this means "don't do anything", ie the - item that generated the callback is left as it is, and - the parser continues.</li><li>one; reparse the last item again. This is useful to - parse a tag as a container, or vice versa: just add or remove - callbacks for the tag and return this to jump to the right - callback.</li></ul> - - - </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>tags</code>, <code>containers</code>, <code>entities</code></dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - at - Method - at_line - Method - at_char - Method - at_column - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) at()</code> - <code><code class='object unresolved'>int </code> at_line()</code> - <code><code class='object unresolved'>int </code> at_char()</code> - <code><code class='object unresolved'>int </code> at_column()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Returns the current position. Characters and columns count - from 0, lines count from 1. - - - <code>at</code>() gives an array consisting of - ({line,char,column}), in that order. + <dd class='body--doc'>Returns a random element from the <code>in</code> array. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - case_insensitive_tag - Method - ignore_tags - Method - ignore_unknown - Method - lazy_argument_end - Method - lazy_entity_end - Method - match_tag - Method - max_parse_depth - Method - mixed_mode - Method - reparse_strings - Method - ws_before_tag_name - Method - xml_tag_syntax + reduce </dt> - <dd><code><code class='object unresolved'>int </code> case_insensitive_tag(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> ignore_tags(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> ignore_unknown(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> lazy_argument_end(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> lazy_entity_end(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> match_tag(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> max_parse_depth(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> mixed_mode(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> reparse_strings(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> ws_before_tag_name(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>int </code> xml_tag_syntax(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Functions to query or set flags. These set the associated flag - to the value if any is given and returns the old value. - - - The flags are: - - <ul> - <li>case_insensitive_tag: All tags and containers - are matched case insensitively, and argument names are - converted to lowercase. Tags added with - <code>add_quote_tag</code>() are not affected, though. Switching - to case insensitive mode and back won't preserve the case of - registered tags and containers.</li><li>ignore_tags: Do not look for tags at all. - Normally tags are matched even when there's no callbacks for - them at all. When this is set, the tag delimiters '<' and - '>' will be treated as any normal character.</li><li>ignore_unknown: Treat unknown tags and entities - as text data, continuing parsing for tags and entities inside - them.</li><li>lazy_argument_end: A '>' in a tag argument - closes both the argument and the tag, even if the argument is - quoted.</li><li>lazy_entity_end: Normally, the parser search - indefinitely for the entity end character (i.e. ';'). When - this flag is set, the characters '&', '<', '>', '"', - ''', and any whitespace breaks the search for the entity end, - and the entity text is then ignored, i.e. treated as data.</li><li>match_tag: Unquoted nested tag starters and - enders will be balanced when parsing tags. This is the - default.</li><li>max_stack_depth: Maximum recursion depth during - parsing. Recursion occurs when a tag/container/entity/quote - tag callback function returns a string to be reparsed. The - default value is 10.</li><li>mixed_mode: Allow callbacks to return arbitrary - data in the arrays, which will be concatenated in the output.</li><li>reparse_strings: When a plain string is used as - a tag/container/entity/quote tag callback, it's not reparsed - if this flag is unset. Setting it causes all such strings to - be reparsed.</li><li>ws_before_tag_name: Allow whitespace between the - tag start character and the tag name.</li><li>xml_tag_syntax: Whether or not to use XML syntax - to tell empty tags and container tags apart: - - 0: Use HTML syntax only. If there's a '/' last in a - tag, it's just treated as any other argument. - - 1: Use HTML syntax, but ignore a '/' if it comes - last in a tag. This is the default. - - 2: Use XML syntax, but when a tag that does not end - with '/>' is found which only got a non-container tag - callback, treat it as a non-container (i.e. don't start to - seek for the container end). - - 3: Use XML syntax only. If a tag got both container - and non-container callbacks, the non-container callback is - called when the empty element form (i.e. the one ending with - '/>') is used, and the container callback otherwise. If - only a container callback exists, it gets the empty string as - content when there's none to be parsed. If only a - non-container callback exists, it will be called (without the - content argument) for both kinds of tags.</li></ul> - + <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> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - When functions are specified with - <code>_set_tag_callback</code>() or - <code>_set_entity_callback</code>(), all tags or entities, - respectively, are considered known. However, if one of those - functions return 1 and ignore_unknown is set, they are treated - as text data instead of making another call to the same + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>rreduce()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - clear_tags - Method - clear_containers - Method - clear_entities - Method - clear_quote_tags + rreduce </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> clear_tags()</code> - <code><code class='object unresolved'>Parser.HTML </code> clear_containers()</code> - <code><code class='object unresolved'>Parser.HTML </code> clear_entities()</code> - <code><code class='object unresolved'>Parser.HTML </code> clear_quote_tags()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Removes all registered definitions in the different - categories. - + <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> - <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>add_tag</code>, <code>add_tags</code>, <code>add_container</code>, <code>add_containers</code>, <code>add_entity</code>, <code>add_entities</code></dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - clone - </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> clone(<code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Clones the <code>Parser.HTML</code> object. - A new object of the same class is created, - filled with the parse setup from the - old object. - - - This is the simpliest way of flushing a - parse feed/output. - - - The arguments to clone is sent to the - new object, simplifying work for custom classes - that inherits <code>Parser.HTML</code>. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new object. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - create is called _before_ the setup is copied. + <dd class='body--doc'><code>reduce()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - tags - Method - containers - Method - entities - Method - quote_tags + search_array </dt> - <dd><code><code class='object unresolved'>mapping </code> tags()</code> - <code><code class='object unresolved'>mapping </code> containers()</code> - <code><code class='object unresolved'>mapping </code> entities()</code> - <code><code class='object unresolved'>mapping </code> quote_tags()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Returns the current callback settings. For quote_tags, the - values are arrays ({callback, end_quote}). - - - Note that when matching is done case insensitively, all names - will be returned in lowercase. - - - Implementation note: With the exception of quote_tags(), these - run in constant time since they return copy-on-write mappings. - However, quote_tags() allocates a new mapping and thus runs in - linear time. - + <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>add_tag</code>, <code>add_tags</code>, <code>add_container</code>, <code>add_containers</code>, <code>add_entity</code>, <code>add_entities</code></dd></dl> + <dd class='body--doc'><code>sum()</code>, <code>map()</code> + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - context + shuffle </dt> - <dd><code><code class='object unresolved'>string </code> context()</code></dd> + <dd><code><code class='datatype'>array</code> shuffle(<code class='datatype'>array</code> <code class='argument'>arr</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Returns the current output context as a string: - - <ul> - <li>"data": In top level data. This is always returned - when called from tag or container callbacks.</li><li>"arg": In an unquoted argument.</li><li>A single character string: In a quoted argument. - The string contains the starting quote character.</li><li>"splice_arg": In a splice argument.</li></ul> - - - This function is typically only useful in entity callbacks, - which can be called both from text and argument values of - different sorts. - + <dd class='body--doc'><code>shuffle()</code> gives back the same elements, but in random order. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>splice_arg</code></dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - current - </dt> - <dd><code><code class='object unresolved'>string </code> current()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Gives the current range of data, ie the whole tag/entity/etc - being parsed in the current callback. Returns zero if there's - no current range, i.e. when the function is not called in a - callback. + <dd class='body--doc'><code>permute()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - feed + sort_array </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> feed()</code> - <code><code class='object unresolved'>Parser.HTML </code> feed(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> - <code><code class='object unresolved'>Parser.HTML </code> feed(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>do_parse</code>)</code></dd> + <dd><code><code class='datatype'>array</code> sort_array(<code class='datatype'>array</code> <code class='argument'>foo</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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Feed new data to the <code>Parser.HTML</code> - object. This will start a scan and may result in - callbacks. Note that it's possible that all - data feeded isn't processed - to do that, call - <code>finish</code>(). - - - If the function is called without arguments, - no data is feeded, but the parser is run. - - - If the string argument is followed by a 0, - <tt>->feed(s,0);</tt>, the string is feeded, - but the parser isn't run. - + <dd class='body--doc'>This function sorts an array 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. + 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> - <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>finish</code>, <code>read</code>, <code>feed_insert</code></dd></dl> + <dd class='body--doc'><code>map()</code>, <code>sort()</code>, <code>`>()</code>, <code>dwim_sort_func</code>, <code>lyskom_sort_func</code> + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - feed_insert + sum </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> feed_insert(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + <dd><code><code class='datatype'>mixed</code> sum(<code class='datatype'>array</code> <code class='argument'>a</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This pushes a string on the parser stack. - (I'll write more about this mechanism later.) - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the called object + <dd class='body--doc'>Sum the elements of an array using `+ </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - finish + sum_arrays </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> finish()</code> - <code><code class='object unresolved'>Parser.HTML </code> finish(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Finish a parser pass. A string may be sent here, similar to - feed(). - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the called object + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_extra + uniq2 </dt> - <dd><code><code class='object unresolved'>array </code> get_extra()</code></dd> + <dd><code><code class='datatype'>array</code> uniq2(<code class='datatype'>array</code> <code class='argument'>a</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Gets the extra arguments set by <code>set_extra</code>(). - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the called object + <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></dl> - + </dd></dl><dl><dt><h2 class='header'>Module Function</h2> + </dt><dd> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - parse_tag_args + splice_call </dt> - <dd><code><code class='object unresolved'>mapping </code> parse_tag_args(<code class='datatype'>string</code> <code class='argument'>tag</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Parses the tag arguments from a tag string without the name - and surrounding brackets, i.e. a string on the form - "<tt>some="tag" args</tt>". + <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'>Returns</dt> - <dd class='body--doc'> - a mapping containing the tag arguments + <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'>See also</dt> - <dd class='body--doc'> - <code>tag_args</code></dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - parse_tag_name - </dt> - <dd><code><code class='object unresolved'>string </code> parse_tag_name(<code class='datatype'>string</code> <code class='argument'>tag</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Parses the tag name from a tag string without the surrounding - brackets, i.e. a string on the form "<tt>tagname some="tag" - args</tt>". + <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'>Returns</dt> - <dd class='body--doc'> - the tag name or an empty string if none - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read - </dt> - <dd><code><code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>mixed</code>) read()</code> - <code><code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>mixed</code>) read(<code class='datatype'>int</code> <code class='argument'>max_elems</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Read parsed data from the parser object. - - <code>mixed_mode</code>, an array of arbitrary data otherwise. + <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'> - a string of parsed data if the parser isn't in - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_extra - </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> set_extra(<code class='datatype'>mixed</code> <code class='argument'>...args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Sets the extra arguments passed to all tag, container and - entity callbacks. - + <dd class='body--doc'>Whatever the supplied function <tt>f</tt> returns </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the called object - </dd></dl> + <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> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - splice_arg + all_inherits </dt> - <dd><code><code class='object unresolved'>string </code> splice_arg(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>name</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - If given a string, it sets the splice argument name to it. It - - If a splice argument name is set, it's parsed in all tags, - both those with callbacks and those without. Wherever it - occurs, its value (after being parsed for entities in the - normal way) is inserted directly into the tag. E.g: - <pre> - <foo arg1="val 1" splice="arg2='val 2' arg3" arg4> - </pre> - becomes - <pre> - <foo arg1="val 1" arg2='val 2' arg3 arg4> - </pre> - if "splice" is set as the splice argument name. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the old splice argument name. + <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> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - tag - Method - tag_name - Method - tag_args - Method - tag_content + inherit_tree </dt> - <dd><code><code class='object unresolved'>array </code> tag()</code> - <code><code class='object unresolved'>string </code> tag_name()</code> - <code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) tag_args()</code> - <code><code class='object unresolved'>string </code> tag_content()</code> - <code><code class='object unresolved'>array </code> tag(<code class='datatype'>mixed</code> <code class='argument'>default_value</code>)</code> - <code><code class='object unresolved'>string </code> tag_args(<code class='datatype'>mixed</code> <code class='argument'>default_value</code>)</code></dd> + <dd><code><code class='datatype'>array</code> inherit_tree(<code class='datatype'>program</code> <code class='argument'>p</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - These give parsed information about the current thing being - parsed, e.g. the current tag, container or entity. They return - zero if they're not applicable. - - - <tt>tag_name</tt> gives the name of the current tag. If used - from an entity callback, it gives the string inside the - entity. - - - <tt>tag_args</tt> gives the arguments of the current tag, - parsed to a convenient mapping consisting of key:value pairs. - If the current thing isn't a tag, it gives zero. default_value - is used for arguments which have no value in the tag. If - default_value isn't given, the value is set to the same string - as the key. - - - <tt>tag_content</tt> gives the content of the current tag, if - it's a container or quote tag. - - - <tt>tag()</tt> gives the equivalent of - <tt>({tag_name(),tag_args(), tag_content()})</tt>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - write_out - </dt> - <dd><code><code class='object unresolved'>Parser.HTML </code> write_out(<code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Send data to the output stream, i.e. it won't be parsed and - it won't be sent to the data callback, if any. - - - Any data is allowed when the parser is running in - <code>mixed_mode</code>. Only strings are allowed otherwise. - + <dd class='body--doc'>Recursively builds a inheritance tree by + fetching programs inheritance lists. </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the called object - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module Parser</h2> + <dd class='body--doc'>Returns an array with programs or arrays + as elements. + </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> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - . + adjust </dt> - <dd><code> .()</code></dd> - </dl> + <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> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - decode_numeric_xml_entity + push </dt> - <dd><code><code class='datatype'>string</code> decode_numeric_xml_entity(<code class='datatype'>string</code> <code class='argument'>chref</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Decodes the numeric XML entity <code>chref</code>, e.g. <tt>"&#x34;"</tt> and - returns the character as a string. <code>chref</code> is the name part of - the entity, i.e. without the leading '&' and trailing ';'. Returns - zero if <code>chref</code> isn't on a recognized form or if the character - number is too large to be represented in a string. + <dd><code><code class='datatype'>void</code> push(<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> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_xml_parser + size </dt> - <dd><code><code class='object unresolved'>Parser.HTML</code> get_xml_parser()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns a <code>Parser.HTML</code> initialized for parsing XML. It has all - the flags set properly for XML syntax and callbacks to ignore - comments, CDATA blocks and unknown PI tags, but it has no - registered tags and doesn't decode any entities. + <dd><code><code class='datatype'>int</code> size()</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 - html_entity_parser - Method - parse_html_entities + top </dt> - <dd><code><code class='object unresolved'>HTML</code> html_entity_parser()</code> - <code><code class='datatype'>string</code> parse_html_entities(<code class='datatype'>string</code> <code class='argument'>in</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Parse any HTML entities in the string to unicode characters. - Either return a complete parser (to build on or use) or parse - a string. Throw an error if there is an unrecognized entity in - the string. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Currently using XHTML 1.0 tables. + <dd><code><code class='datatype'>mixed</code> top()</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function </dd></dl> - <dl><dt><h2 class='header'>Class Parser.RCS</h2> + </dd></dl><dl><dt><h2 class='header'>Class ADT.History</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>A RCS file parser that eats a RCS *,v file and presents nice pike - data structures of its contents. + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - access + <dt class='head--type'>Method + _sizeof </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) Parser.RCS.access</code></dd> + <dd><code><code class='datatype'>int</code> sizeof( ADT.History arg )</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The usernames listed in the ACCESS section of the RCS file + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - branch + <dt class='head--type'>Method + `[] </dt> - <dd><code><code class='datatype'>string</code>|<code class='datatype'>int(0..0)</code> Parser.RCS.branch</code></dd> + <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.History()</code>[ <code class='class'>i</code> ]</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The default branch (or revision), if present, <code class='expr'>0</code> otherwise + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - branches - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) Parser.RCS.branches</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Maps branch numbers (indices) to branch names (values) - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - comment - </dt> - <dd><code><code class='datatype'>string</code>|<code class='datatype'>int(0..0)</code> Parser.RCS.comment</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The RCS file comment if present, <code class='expr'>0</code> otherwise - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method create </dt> - <dd><code>Parser.RCS Parser.RCS(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>file_name</code>, <code class='datatype'>string</code>|<code class='datatype'>int(0..0)</code>|<code class='datatype'>void</code> <code class='argument'>file_contents</code>)</code></dd> + <dd><code>ADT.History ADT.History(<code class='datatype'>int</code> <code class='argument'>max_size</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Initializes the RCS object. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>file_name</code></dt> - <dd></dd><dd class='body--doc'>The path to the raw RCS file (includes trailing ",v"). Used - mainly for error reporting (truncated RCS file). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>file_contents</code></dt> - <dd></dd><dd class='body--doc'>If a string is provided, that string will be parsed to - initialize the RCS object. If a zero (<code class='expr'>0</code>) is sent, no - initialization will be performed at all. If no value is given at - all, but <code>file_name</code> was provided, that file will be loaded and - parsed for object initialization. + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - description + <dt class='head--type'>Method + flush </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.description</code></dd> + <dd><code><code class='datatype'>void</code> flush()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The RCS file description + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - expand + <dt class='head--type'>Method + get_first_entry_num </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.expand</code></dd> + <dd><code><code class='datatype'>int</code> get_first_entry_num()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The keyword expansion options (as named by RCS) if present, - <code class='expr'>0</code> otherwise + <dd class='body--doc'>Returns the absolute sequence number of the + oldest result still in the history. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - head + <dt class='head--type'>Method + get_latest_entry_num </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.head</code></dd> + <dd><code><code class='datatype'>int</code> get_latest_entry_num()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Version number of the head version of the file + <dd class='body--doc'>Returns the absolute sequence number of the latest + result inserted into the history. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - locks - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) Parser.RCS.locks</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Maps from username to revision for users that have acquired locks - on this file - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - parse + get_maxsize </dt> - <dd><code><code class='object unresolved'>this_program</code> parse(<code class='datatype'>string</code> <code class='argument'>raw</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>string</code>:<code class='datatype'>void</code>) <code class='argument'>progress_callback</code>)</code></dd> + <dd><code><code class='datatype'>int</code> get_maxsize()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Parse the RCS file <code>raw</code> and initialize all members of this object - fully initialized. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>raw</code></dt> - <dd></dd><dd class='body--doc'>The unprocessed RCS file. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>progress_callback</code></dt> - <dd></dd><dd class='body--doc'>Passed on to <code>parse_deltatext_sections</code>. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The fully initialized object (only returned for API convenience; - the object itself is destructively modified to match the data - extracted from <code>raw</code>) - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>parse_admin_section</code>, <code>parse_delta_sections</code>, - <code>parse_deltatext_sections</code>, <code>create</code> + <dd class='body--doc'>Returns the maximum number of values in the history </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - parse_admin_section + push </dt> - <dd><code><code class='datatype'>string</code> parse_admin_section(<code class='datatype'>string</code> <code class='argument'>raw</code>)</code></dd> + <dd><code><code class='datatype'>void</code> push(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Lower-level API function for parsing only the admin section (the - initial chunk of an RCS file, see manpage rcsfile(5)) of an RCS - file. After running <code>parse_admin_section</code>, the RCS object will be - initialized with the values for <code>head</code>, <code>branch</code>, <code>access</code>, - <code>branches</code>, <code>tags</code>, <code>locks</code>, <code>strict_locks</code>, <code>comment</code> and - <code>expand</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>raw</code></dt> - <dd></dd><dd class='body--doc'>The unprocessed RCS file. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The rest of the RCS file, admin section removed. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>parse_delta_sections</code>, <code>parse_deltatext_sections</code>, <code>parse</code>, <code>create</code> - </dd><dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Does not handle rcsfile(5) newphrase skipping. + <dd class='body--doc'>Push a new value into the history. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - parse_delta_sections + set_maxsize </dt> - <dd><code><code class='datatype'>string</code> parse_delta_sections(<code class='datatype'>string</code> <code class='argument'>raw</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_maxsize(<code class='datatype'>int</code> <code class='argument'>_maxsize</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Lower-level API function for parsing only the delta sections (the - second chunk of an RCS file, see manpage rcsfile(5)) of an RCS - file. After running <code>parse_delta_sections</code>, the RCS object will - be initialized with the value of <code>description</code> and populated - <code>revisions</code> mapping and <code>trunk</code> array. Their <code>Revision</code> members - are however only populated with the members <code>Revision->revision</code>, - <code>Revision->branch</code>, <code>Revision->time</code>, <code>Revision->author</code>, - <code>Revision->state</code>, <code>Revision->branches</code>, <code>Revision->rcs_next</code>, - <code>Revision->ancestor</code> and <code>Revision->next</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>raw</code></dt> - <dd></dd><dd class='body--doc'>The unprocessed RCS file, with admin section removed. (See - <code>parse_admin_section</code>.) - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The rest of the RCS file, delta sections removed. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>parse_admin_section</code>, <code>parse_deltatext_sections</code>, <code>parse</code>, <code>create</code> - </dd><dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Does not handle rcsfile(5) newphrase skipping. + <dd class='body--doc'>Set the maximume number of entries that can be + stored in the history simultaneous. </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 - parse_deltatext_sections + adjust_pri </dt> - <dd><code><code class='datatype'>void</code> parse_deltatext_sections(<code class='datatype'>string</code> <code class='argument'>raw</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>string</code>:<code class='datatype'>void</code>) <code class='argument'>progress_callback</code>, <code class='datatype'>array</code>|<code class='datatype'>void</code> <code class='argument'>callback_args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Lower-level API function for parsing only the deltatext sections - (the final and typically largest chunk of an RCS file, see manpage - rcsfile(5)) of an RCS file. After a <code>parse_deltatext_sections</code> - run, the RCS object will be fully populated. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>raw</code></dt> - <dd></dd><dd class='body--doc'>The unprocessed RCS file, with admin and delta sections removed. - (See <code>parse_admin_section</code> and <code>parse_delta_sections</code>.) - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>progress_callback</code></dt> - <dd></dd><dd class='body--doc'>This optional callback is invoked with the revision of the - deltatext about to be parsed (useful for progress indicators). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> - <dd></dd><dd class='body--doc'>Optional extra trailing arguments to be sent to <code>progress_callback</code> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>parse_admin_section</code>, <code>parse_delta_sections</code>, <code>parse</code>, <code>create</code> - </dd><dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Does not handle rcsfile(5) newphrase skipping. + <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'>Variable - revisions + <dt class='head--type'>Inherit + Heap </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='object unresolved'>Revision</code>) Parser.RCS.revisions</code></dd> + <dd><code>inherit .Heap : Heap</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Data for all revisions of the file. The indices of the mapping are - the revision numbers, whereas the values are the data from the - corresponding revision. - </dd></dl> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - strict_locks + <dt class='head--type'>Method + pop </dt> - <dd><code><code class='datatype'>bool</code> Parser.RCS.strict_locks</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>1 if strict locking is set, 0 otherwise + <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> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - tags + <dt class='head--type'>Method + push </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) Parser.RCS.tags</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Maps tag names (indices) to tagged revision numbers (values) + <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> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - trunk - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>mapping</code>) Parser.RCS.trunk</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Data for all revisions on the trunk, sorted in the same order as the - RCS file stored them - ie descending, most recent first, I'd assume - (rcsfile(5), of course, fails to state such irrelevant information). - </dd></dl> - <dl><dt><h2 class='header'>Class Parser.RCS.DeltatextIterator</h2> + </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'>Iterator for the deltatext sections of the RCS file. Typical usage: - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>string raw = Stdio.read_file(my_rcs_filename); - Parser.RCS rcs = Parser.RCS(my_rcs_filename, 0); - raw = rcs->parse_delta_sections(rcs->parse_admin_section(raw)); - foreach(rcs->DeltatextIterator(raw); int n; Parser.RCS.Revision rev) - do_something(rev); - </pre></dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - `! - </dt> - <dd><code><code class='datatype'>bool</code> res = !<code class='class'>Parser.RCS.DeltatextIterator()</code></code></dd> - - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>1 if the iterator has processed all deltatext entries, 0 otherwise. + <dd class='body--doc'>A simple FIFO queue. </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method create </dt> - <dd><code>Parser.RCS.DeltatextIterator Parser.RCS.DeltatextIterator(<code class='datatype'>string</code> <code class='argument'>deltatext_section</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>string</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>progress_callback</code>, <code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>mixed</code>) <code class='argument'>progress_callback_args</code>)</code></dd> - - <dt class='head--doc'>Parameter <code class='parameter'>deltatext_section</code></dt> - <dd></dd><dd class='body--doc'>the deltatext section of the RCS file in its entirety - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>progress_callback</code></dt> - <dd></dd><dd class='body--doc'>This optional callback is invoked with the revision of the - deltatext about to be parsed (useful for progress indicators). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>progress_callback_args</code></dt> - <dd></dd><dd class='body--doc'>Optional extra trailing arguments to be sent to <code>progress_callback</code> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'>the <tt>rcsfile(5)</tt> manpage outlines the sections of an RCS file + <dd><code>ADT.Queue ADT.Queue(<code class='datatype'>mixed</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 - first + flush </dt> - <dd><code><code class='datatype'>bool</code> first()</code></dd> + <dd><code><code class='datatype'>void</code> flush()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Restart not implemented; always returns 0 (==failed) + <dd class='body--doc'>Empties the queue. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - index + read + Method + get </dt> - <dd><code><code class='datatype'>int</code> index()</code></dd> + <dd><code><code class='datatype'>mixed</code> read()</code> + <code><code class='datatype'>mixed</code> get()</code></dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>the number of deltatext entries processed so far (0..N-1, N - being the total number of revisions in the rcs file) + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns the next element from the queue. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - next + is_empty </dt> - <dd><code><code class='datatype'>bool</code> next()</code></dd> + <dd><code><code class='datatype'>bool</code> is_empty()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>like <code class='expr'><code>`+=</code>(1)</code>, but returns 0 if the iterator is finished + <dd class='body--doc'>Returns true if the queue is empty, + otherwise zero. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - parse_deltatext_section + peek </dt> - <dd><code><code class='modifier'>protected</code> <code class='datatype'>string</code> parse_deltatext_section(<code class='datatype'>string</code> <code class='argument'>raw</code>)</code></dd> + <dd><code><code class='datatype'>mixed</code> peek()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Chops off the first deltatext section from the string <code>raw</code> and - returns the rest of the string, or the value <code class='expr'>0</code> (zero) if - we had already visited the final deltatext entry. The deltatext's - data is stored destructively in the appropriate entry of the - <code>revisions</code> array. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'><code>raw</code> must start with a deltatext entry for this method to work - </dd><dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>does not handle rcsfile(5) newphrase skipping - </dd><dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>if the rcs file is truncated, this method writes a descriptive - error to stderr and then returns 0 - some nicer error handling - wouldn't hurt + <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 - read_next + write + Method + put </dt> - <dd><code><code class='modifier'>protected</code> <code class='datatype'>bool</code> read_next()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>drops the leading whitespace before next revision's deltatext - entry and sets this_rev to the revision number we're about to read. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>this method requires that <code>raw</code> starts with a valid deltatext entry + <dd class='body--doc'>Adds the <code>item</code> to the queue. </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - value - </dt> - <dd><code><code class='object unresolved'>Revision</code> value()</code></dd> - - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>the <code>Revision</code> at whose deltatext data we are, updated with its info - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Parser.RCS.Revision</h2> + </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'>All data tied to a particular revision of the file. + <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'>Variable - added + <dt class='head--type'>Method + _sizeof </dt> - <dd><code><code class='datatype'>int</code> Parser.RCS.Revision.added</code></dd> + <dd><code><code class='datatype'>int</code> sizeof( ADT.Stack arg )</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the number of lines that were added from the previous revision - to make this revision (for the initial revision too) + <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'>Variable - ancestor + <dt class='head--type'>Method + _values </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.Revision.ancestor</code></dd> + <dd><code><code class='datatype'>array</code> values( ADT.Stack arg )</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the revision of the ancestor of this revision, or 0 if this was - the initial revision + <dd class='body--doc'><code>values</code> on a stack returns all the entries in + the stack, in order. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - author + <dt class='head--type'>Method + `+ </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.Revision.author</code></dd> + <dd><code><code class='object unresolved'>this_program</code> res = <code class='class'>ADT.Stack()</code> + <code class='class'>s</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the name of the user that committed the revision + <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'>Variable - branch - </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.Revision.branch</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the branch name on which this revision was committed (calculated - according to how cvs manages branches) - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - branches - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) Parser.RCS.Revision.branches</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>when there are branches from this revision, an array of the - revision numbers where each branch starts, otherwise 0 - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - expand_keywords + create </dt> - <dd><code><code class='datatype'>string</code> expand_keywords(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>text</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>override_binary</code>)</code></dd> + <dd><code>ADT.Stack ADT.Stack(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Expand keywords and return the resulting text according to the - expansion rules set for the file. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>text</code></dt> - <dd></dd><dd class='body--doc'>If supplied, substitutes keywords for that text instead, using values - that would apply for this revision. Otherwise, this revision is used. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>override_binary</code></dt> - <dd></dd><dd class='body--doc'>Perform expansion even if the file was checked in as binary. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The Log keyword (which lacks sane quoting rules) is not - expanded. Keyword expansion rules set in CVSROOT/cvswrappers - are ignored. Only implements the -kkv and -kb expansion modes. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_contents</code> + <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 - get_contents + pop </dt> - <dd><code><code class='datatype'>string</code> get_contents()</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the file contents from this revision, without performing - any keyword expansion. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>expand_keywords</code> + <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'>Variable - lines - </dt> - <dd><code><code class='datatype'>int</code> Parser.RCS.Revision.lines</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the number of lines this revision contained, altogether (not of - particular interest for binary files) - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - log - </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.Revision.log</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the log message associated with the revision - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - next - </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.Revision.next</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the revision that succeeds this revision, or 0 if none exists - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - rcs_next - </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.Revision.rcs_next</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the revision stored next in the rcs file, or 0 if none exists - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - removed - </dt> - <dd><code><code class='datatype'>int</code> Parser.RCS.Revision.removed</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the number of lines that were removed from the previous revision - to make this revision - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - revision - </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.Revision.revision</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the revision number (i e <code>RCS</code>->revisions["1.1"]->revision == "1.1") - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - state - </dt> - <dd><code><code class='datatype'>string</code> Parser.RCS.Revision.state</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the state of the revision - typically "Exp" or "dead" - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - time - </dt> - <dd><code><code class='object unresolved'>Calendar.ISO.Second</code> Parser.RCS.Revision.time</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>the (UTC) date and time when the revision was committed - </dd></dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Class Parser.SGML</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This is a handy simple parser of SGML-like - syntax like HTML. It doesn't do anything advanced, - but finding the corresponding end-tags. - It's used like this: - <code class='expr'>array res=Parser.SGML()->feed(string)->finish()->result();</code> - The resulting structure is an array of atoms, - where the atom can be a string or a tag. - A tag contains a similar array, as data. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>A string - <tt>"<gat>&nbsp;<gurka>&nbsp;</gurka>&nbsp;<banan>&nbsp;<kiwi>&nbsp;</gat>"</tt> - results in - <pre> - ({ - tag "gat" object with data: - ({ - tag "gurka" object with data: - ({ - " " - }) - tag "banan" object with data: - ({ - " " - tag "kiwi" object with data: - ({ - " " - }) - }) - }) - }) - </pre> - ie, simple "tags" (not containers) are not detected, - but containers are ended implicitely by a surrounding - container _with_ an end tag. - The 'tag' is an object with the following variables: - <pre> - string name; - name of tag - mapping args; - argument to tag - int line,char,column; - position of tag - string file; - filename (see <ref>create</ref>) - array(SGMLatom) data; - contained data - </pre> - </pre></dd></dl> - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - create + push </dt> - <dd><code>Parser.SGML Parser.SGML()</code> - <code>Parser.SGML Parser.SGML(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> + <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'>This object is created with this filename. - It's passed to all created tags, for debug and trace purposes. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>No, it doesn't read the file itself. See <code>feed()</code>. + <dd class='body--doc'>Push an element on the top of the stack. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - feed - Method - finish - Method - result + quick_pop </dt> - <dd><code><code class='datatype'>object</code> feed(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> - <code><code class='datatype'>array</code>(<code class='object unresolved'>SGMLatom</code>|<code class='datatype'>string</code>) finish()</code> - <code><code class='datatype'>array</code>(<code class='object unresolved'>SGMLatom</code>|<code class='datatype'>string</code>) result(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + <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'>Feed new data to the object, or finish the stream. - No result can be used until <code>finish()</code> is called. - Both <code>finish()</code> and <code>result()</code> return the computed data. - <code>feed()</code> returns the called object. + <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></dl> - </dd></dl><dl><dt><h2 class='header'>Module Parser.LR</h2> - </dt><dd><dl><dt><h2 class='header'>Enum Parser.LR.SeverityLevel</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Severity level - </dd></dl> + - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - NOTICE - Constant - WARNING - Constant - ERROR - </dt> - <dd><code><code class='datatype'>constant</code> Parser.LR.<code class='constant'>NOTICE</code></code> - <code><code class='datatype'>constant</code> Parser.LR.<code class='constant'>WARNING</code></code> - <code><code class='datatype'>constant</code> Parser.LR.<code class='constant'>ERROR</code></code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class Parser.LR.ErrorHandler</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Class handling reporting of errors and warnings. - </dd></dl> + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + reset </dt> - <dd><code>Parser.LR.ErrorHandler Parser.LR.ErrorHandler(<code class='datatype'>int(-1..1)</code>|<code class='datatype'>void</code> <code class='argument'>verbosity</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Create a new error handler. + <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> - <dt class='head--doc'>Parameter <code class='parameter'>verbosity</code></dt> - <dd></dd><dd class='body--doc'>Level of verbosity. - </dd> + <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>verbose</code> + <dd class='body--doc'><code>create</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - verbose - </dt> - <dd><code><code class='modifier'>optional</code> <code class='datatype'>int(-1..1)</code> Parser.LR.ErrorHandler.verbose</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Verbosity level - <table class='box'><tr><td><code><code class='key'>-1</code></code></td><td>Just errors. - </td></tr> - <tr><td><code><code class='key'>0</code></code></td><td>Errors and warnings. - </td></tr> - <tr><td><code><code class='key'>1</code></code></td><td>Also notices. - </td></tr> - </table> - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Parser.LR.Parser</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This object implements an LALR(1) parser and compiler. - Normal use of this object would be: - <pre> - set_error_handler - {add_rule, set_priority, set_associativity}* - set_symbol_to_string - compile - {parse}* - </pre> - </dd></dl> - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - _sprintf + set_stack </dt> - <dd><code>string sprintf(string format, ... Parser.LR.Parser arg ... )</code></dd> + <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'>Pretty-prints the current grammar to a string. + <dd class='body--doc'>Sets the stacks content to the provided array. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - add_rule + top </dt> - <dd><code><code class='datatype'>void</code> add_rule(<code class='object unresolved'>Rule</code> <code class='argument'>r</code>)</code></dd> + <dd><code><code class='datatype'>mixed</code> top()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a rule to the grammar. + <dd class='body--doc'>Returns the top element from the stack, without + popping it. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd><dd class='body--doc'>Rule to add. + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'>Throws an error if called on an empty stack. </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 - cast + _sizeof </dt> - <dd><code>(int)Parser.LR.Parser() (float)Parser.LR.Parser() (string)Parser.LR.Parser() (array)Parser.LR.Parser() (mapping)Parser.LR.Parser() (multiset)Parser.LR.Parser()</code></dd> + <dd><code><code class='datatype'>mixed</code> sizeof( ADT.Relation.Binary arg )</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Implements casting. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>type</code></dt> - <dd></dd><dd class='body--doc'>Type to cast to. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - compile + `& </dt> - <dd><code><code class='datatype'>int</code> compile()</code></dd> + <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Relation.Binary()</code> & <code class='class'>rel</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Compiles the grammar into a parser, so that parse() can be called. + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - error_handler + <dt class='head--type'>Method + `() </dt> - <dd><code><code class='datatype'>function</code>(<code class='object unresolved'>SeverityLevel</code>, <code class='datatype'>string</code>, <code class='datatype'>string</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) Parser.LR.Parser.error_handler</code></dd> + <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Relation.Binary()</code>()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Compile error and warning handler. + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - grammar + <dt class='head--type'>Method + `- </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>int</code>:<code class='datatype'>array</code>(<code class='object unresolved'>Rule</code>)) Parser.LR.Parser.grammar</code></dd> + <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Relation.Binary()</code> - <code class='class'>rel</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The grammar itself. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - item_to_string + `| </dt> - <dd><code><code class='datatype'>string</code> item_to_string(<code class='object unresolved'>Item</code> <code class='argument'>i</code>)</code></dd> + <dd><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Relation.Binary()</code> | <code class='class'>rel</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pretty-prints an item to a string. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>i</code></dt> - <dd></dd><dd class='body--doc'>Item to pretty-print. + <dd class='body--doc'>The expression `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'>Variable - known_states - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='object unresolved'>Kernel</code>) Parser.LR.Parser.known_states</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>LR0 states that are already known to the compiler. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - lr_error - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Parser.lr_error</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Error code - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - parse + add </dt> - <dd><code><code class='datatype'>mixed</code> parse(<code class='datatype'>object</code>|<code class='datatype'>function</code>(<code class='datatype'>void</code>:<code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>|<code class='datatype'>mixed</code>)) <code class='argument'>scanner</code>, <code class='datatype'>void</code>|<code class='datatype'>object</code> <code class='argument'>action_object</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Parse the input according to the compiled grammar. - The last value reduced is returned. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The parser must have been compiled (with compile()) - prior to calling this function. - </dd> - <dt class='head--doc'>Bugs</dt> - <dd class='body--doc'>Errors should be throw()n. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>scanner</code></dt> - <dd></dd><dd class='body--doc'>The scanner function. It returns the next symbol from the input. - It should either return a string (terminal) or an array with - a string (terminal) and a mixed (value). - EOF is indicated with the empty string. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>action_object</code></dt> - <dd></dd><dd class='body--doc'>Object used to resolve those actions that have been specified as - strings. + <dd class='body--doc'>Adds "<code>left</code> R <code>right</code>" as a member of the relation. Returns + the same relation. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rule_to_string + contains </dt> - <dd><code><code class='datatype'>string</code> rule_to_string(<code class='object unresolved'>Rule</code> <code class='argument'>r</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pretty-prints a rule to a string. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd><dd class='body--doc'>Rule to print. + <dd class='body--doc'>Return true/false: does the relation "<code>left</code> R <code>right</code>" exist? </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - s_q - </dt> - <dd><code><code class='object unresolved'>StateQueue</code> Parser.LR.Parser.s_q</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Contains all states used. - In the queue section are the states that remain to be compiled. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - set_associativity + filter </dt> - <dd><code><code class='datatype'>void</code> set_associativity(<code class='datatype'>string</code> <code class='argument'>terminal</code>, <code class='datatype'>int</code> <code class='argument'>assoc</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the associativity of a terminal. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>terminal</code></dt> - <dd></dd><dd class='body--doc'>Terminal to set the associativity for. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>assoc</code></dt> - <dd></dd><dd class='body--doc'>Associativity; negative - left, positive - right, - zero - no associativity. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_error_handler + filter_destructively </dt> - <dd><code><code class='datatype'>void</code> set_error_handler(<code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='object unresolved'>SeverityLevel</code>, <code class='datatype'>string</code>, <code class='datatype'>string</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>handler</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the error report function. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>handler</code></dt> - <dd></dd><dd class='body--doc'>Function to call to report errors and warnings. - If zero or not specifier, use the built-in function. + <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 - set_priority + get_id </dt> - <dd><code><code class='datatype'>void</code> set_priority(<code class='datatype'>string</code> <code class='argument'>terminal</code>, <code class='datatype'>int</code> <code class='argument'>pri_val</code>)</code></dd> + <dd><code><code class='datatype'>mixed</code> get_id()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the priority of a terminal. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>terminal</code></dt> - <dd></dd><dd class='body--doc'>Terminal to set the priority for. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>pri_val</code></dt> - <dd></dd><dd class='body--doc'>Priority; higher = prefer this terminal. + <dd class='body--doc'>Return the ID value which was given as first argument to create(). </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_symbol_to_string + map </dt> - <dd><code><code class='datatype'>void</code> set_symbol_to_string(<code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>s_to_s</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the symbol to string conversion function. - The conversion function is used by the various *_to_string functions - to make comprehensible output. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>s_to_s</code></dt> - <dd></dd><dd class='body--doc'>Symbol to string conversion function. - If zero or not specified, use the built-in function. + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - start_state - </dt> - <dd><code><code class='object unresolved'>Kernel</code> Parser.LR.Parser.start_state</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The initial LR0 state. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - state_to_string + remove </dt> - <dd><code><code class='datatype'>string</code> state_to_string(<code class='object unresolved'>Kernel</code> <code class='argument'>state</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pretty-prints a state to a string. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>state</code></dt> - <dd></dd><dd class='body--doc'>State to pretty-print. + <dd class='body--doc'>Removes "<code>left</code> R <code>right</code>" as a member of the relation. Returns + the same relation. </dd></dl> - <dl><dt><h2 class='header'>Class Parser.LR.Parser.Item</h2> + <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 LR(0) item, a partially parsed rule. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - counter - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Parser.Item.counter</code></dd> - + <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'>Depth counter (used when compiling). - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - direct_lookahead - </dt> - <dd><code><code class='datatype'>multiset</code>(<code class='datatype'>string</code>) Parser.LR.Parser.Item.direct_lookahead</code></dd> - + <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'>Look-ahead set for this item. + <dd class='body--doc'>The table base-class. </dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - error_lookahead + <dt class='head--type'>Method + _indices </dt> - <dd><code><code class='datatype'>multiset</code>(<code class='datatype'>string</code>) Parser.LR.Parser.Item.error_lookahead</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) indices( ADT.Table.table arg )</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Look-ahead set used for detecting conflicts + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - item_id + <dt class='head--type'>Method + _sizeof </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Parser.Item.item_id</code></dd> + <dd><code><code class='datatype'>int</code> sizeof( ADT.Table.table arg )</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Used to identify the item. - Equal to r->number + offset. + <dd class='body--doc'>This method returns the number of rows in the table. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - master_item + <dt class='head--type'>Method + _values </dt> - <dd><code><code class='object unresolved'>Item</code> Parser.LR.Parser.Item.master_item</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>array</code>) values( ADT.Table.table arg )</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Item representing this one (used for shifts). + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - next_state + <dt class='head--type'>Method + `== </dt> - <dd><code><code class='object unresolved'>Kernel</code> Parser.LR.Parser.Item.next_state</code></dd> + <dd><code><code class='datatype'>int</code> res = <code class='class'>ADT.Table.table()</code> == <code class='class'>table</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The state we will get if we shift according to this rule + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - number + <dt class='head--type'>Method + `[] </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Parser.Item.number</code></dd> + <dd><code><code class='datatype'>array</code> res = <code class='class'>ADT.Table.table()</code>[ <code class='class'>column</code> ]</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Item identification number (used when compiling). + <dd class='body--doc'>Same as <code>col()</code>. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - offset + <dt class='head--type'>Method + append_bottom </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Parser.Item.offset</code></dd> + <dd><code><code class='datatype'>object</code> append_bottom(<code class='datatype'>object</code> <code class='argument'>table</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>How long into the rule the parsing has come. + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - r + <dt class='head--type'>Method + append_right </dt> - <dd><code><code class='object unresolved'>Rule</code> Parser.LR.Parser.Item.r</code></dd> + <dd><code><code class='datatype'>object</code> append_right(<code class='datatype'>object</code> <code class='argument'>table</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The rule + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - relation - </dt> - <dd><code><code class='datatype'>multiset</code>(<code class='object unresolved'>Item</code>) Parser.LR.Parser.Item.relation</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Relation to other items (used when compiling). - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Parser.LR.Parser.Kernel</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Implements an LR(1) state - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - action - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>:<code class='object unresolved'>Kernel</code>|<code class='object unresolved'>Rule</code>) Parser.LR.Parser.Kernel.action</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The action table for this state - <pre> - object(kernel) SHIFT to this state on this symbol. - object(rule) REDUCE according to this rule on this symbol. - </pre> - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - add_item + col </dt> - <dd><code><code class='datatype'>void</code> add_item(<code class='object unresolved'>Item</code> <code class='argument'>i</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add an item to the state. + <dd class='body--doc'>This method returns the contents of a given column as an array. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - closure + create </dt> - <dd><code><code class='datatype'>void</code> closure(<code class='datatype'>int</code> <code class='argument'>nonterminal</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Make the closure of this state. + <dd class='body--doc'>The <code>ADT.Table.table</code> class takes two or three arguments: </dd> - <dt class='head--doc'>Parameter <code class='parameter'>nonterminal</code></dt> - <dd></dd><dd class='body--doc'>Nonterminal to make the closure on. + <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>. + </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. + </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. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>ADT.Table.ASCII.encode()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - closure_set + <dt class='head--type'>Method + decode </dt> - <dd><code><code class='datatype'>multiset</code> Parser.LR.Parser.Kernel.closure_set</code></dd> + <dd><code><code class='datatype'>object</code> decode(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The symbols that closure has been called on. + <dd class='body--doc'>This method returns a table object from a binary string + representation of a table, as returned by <code>encode()</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - do_goto + distinct </dt> - <dd><code><code class='object unresolved'>Kernel</code> do_goto(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>symbol</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Generates the state reached when doing goto on the specified symbol. - i.e. it compiles the LR(0) state. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>symbol</code></dt> - <dd></dd><dd class='body--doc'>Symbol to make goto on. + <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. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - goto_set + encode </dt> - <dd><code><code class='datatype'>multiset</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>) goto_set()</code></dd> + <dd><code><code class='datatype'>string</code> encode()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Make the goto-set of this state. + <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. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - item_id_to_item + <dt class='head--type'>Method + group </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>int</code>:<code class='object unresolved'>Item</code>) Parser.LR.Parser.Kernel.item_id_to_item</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Used to lookup items given rule and offset + <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></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - items + <dt class='head--type'>Method + limit </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>Item</code>) Parser.LR.Parser.Kernel.items</code></dd> + <dd><code><code class='datatype'>object</code> limit(<code class='datatype'>int</code> <code class='argument'>n</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Contains the items in this state. + <dd class='body--doc'>This method truncates the table to the first <code>n</code> rows and returns + a new object. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - rules + <dt class='head--type'>Method + map </dt> - <dd><code><code class='datatype'>multiset</code>(<code class='object unresolved'>Rule</code>) Parser.LR.Parser.Kernel.rules</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Used to check if a rule already has been added when doing closures. + <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. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - symbol_items + <dt class='head--type'>Method + remove </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>int</code>:<code class='datatype'>multiset</code>(<code class='object unresolved'>Item</code>)) Parser.LR.Parser.Kernel.symbol_items</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Contains the items whose next symbol is this non-terminal. + <dd class='body--doc'>Like <code>select()</code>, but the given <code>columns</code> will not be in the + resulting table. </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Parser.LR.Parser.StateQueue</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This is a queue, which keeps the elements even after they are retrieved. - </dd></dl> + - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - arr - </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>Kernel</code>) Parser.LR.Parser.StateQueue.arr</code></dd> + - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The queue itself. - </dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - head + <dt class='head--type'>Method + rename </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Parser.StateQueue.head</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Index of the head of the queue. + <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></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - next + reverse </dt> - <dd><code><code class='object unresolved'>Kernel</code> next()</code></dd> + <dd><code><code class='datatype'>object</code> reverse()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the next state from the queue. + <dd class='body--doc'>This method reverses the rows of the table and returns a + new table object. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - push + row </dt> - <dd><code><code class='object unresolved'>Kernel</code> push(<code class='object unresolved'>Kernel</code> <code class='argument'>state</code>)</code></dd> + <dd><code><code class='datatype'>array</code> row(<code class='datatype'>int</code> <code class='argument'>row_number</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pushes the state on the queue. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>state</code></dt> - <dd></dd><dd class='body--doc'>State to push. + <dd class='body--doc'>This method returns the contents of a given row as an array. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - tail + <dt class='head--type'>Method + rsort </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Parser.StateQueue.tail</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Index of the tail of the queue. + <dd class='body--doc'>Like <code>sort()</code>, but in descending order. </dd></dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Class Parser.LR.Priority</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Specifies the priority and associativity of a rule. - </dd></dl> + - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - assoc - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Priority.assoc</code></dd> + - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Associativity - <table class='box'><tr><td><code><code class='key'>-1</code></code></td><td>Left - </td></tr> - <tr><td><code><code class='key'>0</code></code></td><td>None - </td></tr> - <tr><td><code><code class='key'>1</code></code></td><td>Right - </td></tr> - </table> - </dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + select </dt> - <dd><code>Parser.LR.Priority Parser.LR.Priority(<code class='datatype'>int</code> <code class='argument'>p</code>, <code class='datatype'>int</code> <code class='argument'>a</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Create a new priority object. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>p</code></dt> - <dd></dd><dd class='body--doc'>Priority. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>a</code></dt> - <dd></dd><dd class='body--doc'>Associativity. + <dd class='body--doc'>This method returns a new table object with the selected columns only. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - value - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Priority.value</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Priority value - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Parser.LR.Rule</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This object is used to represent a BNF-rule in the LR parser. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - action - </dt> - <dd><code><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>string</code> Parser.LR.Rule.action</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Action to do when reducing this rule. - function - call this function. - string - call this function by name in the object given to the parser. - The function is called with arguments corresponding to the values of - the elements of the rule. The return value of the function will be - the value of this non-terminal. The default rule is to return the first - argument. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - create + sort </dt> - <dd><code>Parser.LR.Rule Parser.LR.Rule(<code class='datatype'>int</code> <code class='argument'>nt</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>|<code class='datatype'>int</code>) <code class='argument'>r</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>a</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Create a BNF rule. + <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'>Example</dt> - <dd class='example'><pre>The rule - rule : nonterminal ":" symbols ";" { add_rule }; - might be created as - rule(4, ({ 9, ":", 5, ";" }), "add_rule"); - where 4 corresponds to the nonterminal "rule", 9 to "nonterminal" - and 5 to "symbols", and the function "add_rule" is too be called - when this rule is reduced. - </pre></dd> - <dt class='head--doc'>Parameter <code class='parameter'>nt</code></dt> - <dd></dd><dd class='body--doc'>Non-terminal to reduce to. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd><dd class='body--doc'>Symbol sequence that reduces to nt. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>a</code></dt> - <dd></dd><dd class='body--doc'>Action to do when reducing according to this rule. - function - Call this function. - string - Call this function by name in the object given to the parser. - The function is called with arguments corresponding to the values of - the elements of the rule. The return value of the function will become - the value of this non-terminal. The default rule is to return the first - argument. + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>rsort()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - has_tokens - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Rule.has_tokens</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This rule contains tokens - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - nonterminal - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Rule.nonterminal</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Non-terminal this rule reduces to. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - num_nonnullables - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Rule.num_nonnullables</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This rule has this many non-nullable symbols at the moment. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - number - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.Rule.number</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sequence number of this rule (used for conflict resolving) - Also used to identify the rule. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - pri - </dt> - <dd><code><code class='object unresolved'>Priority</code> Parser.LR.Rule.pri</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Priority and associativity of this rule. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - symbols - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>|<code class='datatype'>int</code>) Parser.LR.Rule.symbols</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The actual rule - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module Parser.LR.GrammarParser</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This module generates an LR parser from a grammar specified according - to the following grammar: - <pre> - directives : directive ; - directives : directives directive ; - directive : declaration ; - directive : rule ; - declaration : "%token" terminals ";" ; - rule : nonterminal ":" symbols ";" ; - rule : nonterminal ":" symbols action ";" ; - symbols : symbol ; - symbols : symbols symbol ; - terminals : terminal ; - terminals : terminals terminal ; - symbol : nonterminal ; - symbol : "string" ; - action : "{" "identifier" "}" ; - nonterminal : "identifier" ; - terminal : "string"; - </pre> - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - lr_error - </dt> - <dd><code><code class='datatype'>int</code> Parser.LR.GrammarParser.lr_error</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Error code from the parsing. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - make_parser + sum </dt> - <dd><code><code class='object unresolved'>Parser</code> make_parser(<code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>m</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Compiles the parser-specification given in the first argument. - Named actions are taken from the object if available, otherwise - left as is. - </dd> - <dt class='head--doc'>Bugs</dt> - <dd class='body--doc'>Returns error-code in both GrammarParser.error and - return_value->lr_error. + <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. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - make_parser_from_file + type </dt> - <dd><code><code class='datatype'>int</code>|<code class='object unresolved'>Parser</code> make_parser_from_file(<code class='datatype'>string</code> <code class='argument'>fname</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>m</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Compiles the file specified in the first argument into an LR parser. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>make_parser</code> + <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></dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Module Parser.Pike</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This module parses and tokanizes Pike source code. - </dd></dl> + - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - "C.pmod" - </dt> - <dd><code>inherit "C.pmod" : "C.pmod"</code></dd> - </dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - split + where </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) split(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>void</code>|<code class='datatype'>mapping</code> <code class='argument'>state</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Splits the <code>data</code> string into an array of tokens. An additional - element with a newline will be added to the resulting array of - tokens. If the optional argument <code>state</code> is provided the split - function is able to pause and resume splitting inside #"" and - /**/ tokens. The <code>state</code> argument should be an initially empty - mapping, in which split will store its state between successive - calls. + <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></dl> - </dd></dl><dl><dt><h2 class='header'>Module Parser.Python</h2> + </dd></dl><dl><dt><h2 class='header'>Module ADT.Table.ASCII</h2> </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - split + encode </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) split(<code class='datatype'>string</code> <code class='argument'>data</code>)</code></dd> + <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> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the provided string with Python code as - an array with tokens. + <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></dl></dd></dl></dd></dl></body></html> + </dd></dl></dd></dl></dd></dl></dd></dl></body></html>

autodoc.git/ traditional_manual/ chapter_9.html

2002-07-14

2002-07-14 23:24:33 by Martin Nilsson <mani@lysator.liu.se>