Diff of autodoc.git/traditional.xml (c147c16bc2e4eccb2e0c967f9fd48536a2f8442d » 6f9a72182851f9969f262b51b8f0ae6afbb2df2b)

autodoc.git/traditional.xml:1: <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2014-10-02' version='Pike v8.0.5'> + <manual time-stamp='2018-04-26' version='Pike v8.0.5'> <dir name='./traditional_manual'> <file name='./traditional_manual/index.html'> <chapter title='Table of Contents' unnumbered='1'> <dl><dt><url href='index.html'>Table of Contents</url></dt> <dt><url href='chapter_1.html'>1. Introduction</url></dt> <dd><url href='chapter_1.html#1'>1.1. Overview</url></dd> <dd><url href='chapter_1.html#2'>1.2. The history of Pike</url></dd> <dd><url href='chapter_1.html#3'>1.3. A comparison with other languages</url></dd> <dd><url href='chapter_1.html#4'>1.4. What is Pike</url></dd> <dd><url href='chapter_1.html#5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:3831: All error messages from Pike will use these line numbers. Optionally the number may be followed by a file name, e.g. <tt>#line 1 "/home/pike/program.pike.in"</tt>. Then this filename will be used instead of the current file for error messages. </text></doc> <directive name='#line'/> <directive name='#<integer>'/> </docgroup></namespace></autodoc> - <autodoc hidden='1'><namespace hidden='1' name='cpp'><docgroup homogen-name='#""' homogen-type='directive'><doc><text>If a string literal is opened with <tt>#"</tt> newlines in the + <autodoc hidden='1'><namespace hidden='1' name='cpp'><docgroup homogen-name='#""' homogen-type='directive'><doc><text>If a string literal is opened with <tt>#"</tt> newlines in the string will end up in the string literal, instead of triggering a <tt>"newline in string"</tt> error. </text><group><note/><text>Newlines will be converted to <tt>\n</tt> characters in the string even if the newlines in the file are something else. This preprocessor directive may appear anywhere a string may appear. </text></group><group><seealso/><text><ref resolved='cpp::'>#string</ref> </text></group></doc> - <directive name='#""'/> + <directive name='#""'/> </docgroup></namespace></autodoc> <autodoc hidden='1'><namespace hidden='1' name='cpp'><docgroup homogen-name='#string' homogen-type='directive'><doc><text>The preprocessor directive <ref resolved='cpp::'>#string</ref> will load the file in the string that follows and insert its contents as a string. This preprocessor directive may appear anywhere a string may appear. </text><group><example/><text><code><text>do_something(#string "the_file.wks"); </text></code> </text></group><group><seealso/><text><ref resolved='cpp::'>#include</ref> </text></group></doc> <directive name='#string'/>
autodoc.git/traditional.xml:9473: <arguments/> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='open' homogen-type='method'><doc><text>Open a file, or use an existing fd. If <ref resolved='predef::Stdio.Fd.open.filename'>filename</ref> is given, attempt to open the named file. If <ref resolved='predef::Stdio.Fd.open.fd'>fd</ref> is given instead, it should be the file descriptor for an already opened file, which will then be used by this object. <ref resolved='predef::Stdio.Fd.open.mode'>mode</ref> describes how the file is opened. It's a case-insensitive string consisting of one or more of the following letters: - <dl><group><item name='"r"'/><text>Open for reading. - </text></group><group><item name='"w"'/><text>Open for writing. - </text></group><group><item name='"a"'/><text>Append new data to the end. - </text></group><group><item name='"c"'/><text>Create the file if it doesn't exist already. - </text></group><group><item name='"t"'/><text>Truncate the file to zero length if it already contains data. + <dl><group><item name='"r"'/><text>Open for reading. + </text></group><group><item name='"w"'/><text>Open for writing. + </text></group><group><item name='"a"'/><text>Append new data to the end. + </text></group><group><item name='"c"'/><text>Create the file if it doesn't exist already. + </text></group><group><item name='"t"'/><text>Truncate the file to zero length if it already contains data. Use only together with <expr>"w"</expr>. - </text></group><group><item name='"x"'/><text>Open exclusively - the open fails if the file already exists. + </text></group><group><item name='"x"'/><text>Open exclusively - the open fails if the file already exists. Use only together with <expr>"c"</expr>. Note that it's not safe to assume that this is atomic on some systems. </text></group></dl><ref resolved='predef::Stdio.Fd.open.access'>access</ref> specifies the permissions to use if a new file is created. It is a UNIX style permission bitfield: <dl><group><item name='0400'/><text>User has read permission. </text></group><group><item name='0200'/><text>User has write permission. </text></group><group><item name='0100'/><text>User has execute permission. </text></group><group><item name='0040'/><text>Group has read permission. </text></group><group><item name='0020'/><text>Group has write permission. </text></group><group><item name='0010'/><text>Group has execute permission.
autodoc.git/traditional.xml:18333: </text></doc> <docgroup homogen-type='constant'><constant name='NOTICE'/> <constant name='WARNING'/> <constant name='ERROR'/> </docgroup> </enum> </module> <module name='Pike'> <doc><text>This module parses and tokenizes Pike source code. </text></doc> - <docgroup homogen-name='"C.pmod"' homogen-type='inherit'> - <inherit name='"C.pmod"'><classname resolved='predef::Parser.C'>"C.pmod"</classname></inherit> + <docgroup homogen-name='"C.pmod"' homogen-type='inherit'> + <inherit name='"C.pmod"'><classname resolved='predef::Parser.C'>"C.pmod"</classname></inherit> </docgroup> </module> <module name='Python'> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='split' homogen-type='method'><doc><text>Returns the provided string with Python code as an array with tokens. </text></doc> <method name='split'>
autodoc.git/traditional.xml:23143: <dt>The variables in the expression:</dt> <dt>L</dt><dd>The active layer</dd> <dt>S</dt><dd>The source layer (the sum of the layers below)</dd> <dt>D</dt><dd>The destintion layer (the result)</dd> <dt>Xrgb</dt><dd>Layer red (Xr), green (Xg) or blue channel (Xb) </dd> <dt>Xhsv</dt><dd>Layer hue (Xh), saturation (Xs) or value channel (Xv) (virtual channels)</dd> <dt>Xhls</dt><dd>Layer hue (Xh), lightness channel (Xl) or saturation (Xs) (virtual channels)</dd> <dt>aX</dt><dd>Layer alpha, channel in layer alpha</dd> </dl> All channels are calculated separately, if nothing else is specified. - <table cellpadding='1' cellspacing='0'><tr><td align='left' colspan='2'>top layer</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.1.png' height='80' width='480'>layers.c.0.png</image></td><td align='left' valign='center'/></tr> - <tr><td align='left' colspan='2'>bottom layer</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.2.png' height='80' width='480'>layers.c.1.png</image></td><td align='left' valign='center'/></tr> - <tr><td align='left' colspan='2'>normal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.3.png' height='80' width='480'>layers.c.2.png</image></td><td align='left' valign='center'>D=L applied with alpha: D=(L*aL+S*(1-aL)*aS) / (aL+(1-aL)*aS), aD=(aL+(1-aL)*aS)</td></tr> - <tr><td> </td></tr><tr><td align='left' colspan='2'>add</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.4.png' height='80' width='480'>layers.c.3.png</image></td><td align='left' valign='center'>D=L+S applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>subtract</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.5.png' height='80' width='480'>layers.c.4.png</image></td><td align='left' valign='center'>D=S-L applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>multiply</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.6.png' height='80' width='480'>layers.c.5.png</image></td><td align='left' valign='center'>D=S*L applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>divide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.7.png' height='80' width='480'>layers.c.6.png</image></td><td align='left' valign='center'>D=S/L applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>negdivide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.8.png' height='80' width='480'>layers.c.7.png</image></td><td align='left' valign='center'>D=1.0-S/L applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>modulo</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.9.png' height='80' width='480'>layers.c.8.png</image></td><td align='left' valign='center'>D=S%L applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>invsubtract</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.10.png' height='80' width='480'>layers.c.9.png</image></td><td align='left' valign='center'>D=L-S applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>invdivide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.11.png' height='80' width='480'>layers.c.10.png</image></td><td align='left' valign='center'>D=L/S applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>invmodulo</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.12.png' height='80' width='480'>layers.c.11.png</image></td><td align='left' valign='center'>D=L%S applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>imultiply</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.13.png' height='80' width='480'>layers.c.12.png</image></td><td align='left' valign='center'>D=(1-L)*S applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>idivide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.14.png' height='80' width='480'>layers.c.13.png</image></td><td align='left' valign='center'>D=S/(1-L) applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>invidivide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.15.png' height='80' width='480'>layers.c.14.png</image></td><td align='left' valign='center'>D=L/(1-S) applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>difference</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.16.png' height='80' width='480'>layers.c.15.png</image></td><td align='left' valign='center'>D=abs(L-S) applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>max</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.17.png' height='80' width='480'>layers.c.16.png</image></td><td align='left' valign='center'>D=max(L,S) applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>min</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.18.png' height='80' width='480'>layers.c.17.png</image></td><td align='left' valign='center'>D=min(L,S) applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>bitwise_and</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.19.png' height='80' width='480'>layers.c.18.png</image></td><td align='left' valign='center'>D=L&amp;amp;S applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>bitwise_or</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.20.png' height='80' width='480'>layers.c.19.png</image></td><td align='left' valign='center'>D=L|S applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>bitwise_xor</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.21.png' height='80' width='480'>layers.c.20.png</image></td><td align='left' valign='center'>D=L^S applied with alpha, aD=aS</td></tr> - <tr><td> </td></tr><tr><td align='left' colspan='2'>replace</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.22.png' height='80' width='480'>layers.c.21.png</image></td><td align='left' valign='center'>D=(L*aL+S*(1-aL)*aS) / (aL+(1-aL)*aS), aD=aS</td></tr> - <tr><td align='left' colspan='2'>red</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.23.png' height='80' width='480'>layers.c.22.png</image></td><td align='left' valign='center'>Dr=(Lr*aLr+Sr*(1-aLr)*aSr) / (aLr+(1-aLr)*aSr), Dgb=Sgb, aD=aS</td></tr> - <tr><td align='left' colspan='2'>green</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.24.png' height='80' width='480'>layers.c.23.png</image></td><td align='left' valign='center'>Dg=(Lg*aLg+Sg*(1-aLg)*aSg) / (aLg+(1-aLg)*aSg), Drb=Srb, aD=aS</td></tr> - <tr><td align='left' colspan='2'>blue</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.25.png' height='80' width='480'>layers.c.24.png</image></td><td align='left' valign='center'>Db=(Lb*aLb+Sb*(1-aLb)*aSb) / (aLb+(1-aLb)*aSb), Drg=Srg, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hardlight</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.26.png' height='80' width='480'>layers.c.25.png</image></td><td align='left' valign='center'>Like photoshop hardlight layer mode, aD=aS</td></tr> - <tr><td> </td></tr><tr><td align='left' colspan='2'>replace_hsv</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.27.png' height='80' width='480'>layers.c.26.png</image></td><td align='left' valign='center'>Dhsv=Lhsv apply with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hue</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.28.png' height='80' width='480'>layers.c.27.png</image></td><td align='left' valign='center'>Dh=Lh apply with alpha, Dsv=Lsv, aD=aS</td></tr> - <tr><td align='left' colspan='2'>saturation</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.29.png' height='80' width='480'>layers.c.28.png</image></td><td align='left' valign='center'>Ds=Ls apply with alpha, Dhv=Lhv, aD=aS</td></tr> - <tr><td align='left' colspan='2'>value</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.30.png' height='80' width='480'>layers.c.29.png</image></td><td align='left' valign='center'>Dv=Lv apply with alpha, Dhs=Lhs, aD=aS</td></tr> - <tr><td align='left' colspan='2'>color</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.31.png' height='80' width='480'>layers.c.30.png</image></td><td align='left' valign='center'>Dhs=Lhs apply with alpha, Dv=Lv, aD=aS</td></tr> - <tr><td align='left' colspan='2'>value_mul</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.32.png' height='80' width='480'>layers.c.31.png</image></td><td align='left' valign='center'>Dv=Lv*Sv apply with alpha, Dhs=Lhs, aD=aS</td></tr> - <tr><td> </td></tr><tr><td align='left' colspan='2'>darken</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.33.png' height='80' width='480'>layers.c.32.png</image></td><td align='left' valign='center'>Dv=min(Lv,Sv) apply with alpha, Dhs=Lhs, aD=aS</td></tr> - <tr><td align='left' colspan='2'>lighten</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.34.png' height='80' width='480'>layers.c.33.png</image></td><td align='left' valign='center'>Dv=max(Lv,Sv) apply with alpha, Dhs=Lhs, aD=aS</td></tr> - <tr><td align='left' colspan='2'>saturate</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.35.png' height='80' width='480'>layers.c.34.png</image></td><td align='left' valign='center'>Ds=max(Ls,Ss) apply with alpha, Dhv=Lhv, aD=aS</td></tr> - <tr><td align='left' colspan='2'>desaturate</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.36.png' height='80' width='480'>layers.c.35.png</image></td><td align='left' valign='center'>Ds=min(Ls,Ss) apply with alpha, Dhv=Lhv, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_replace</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.37.png' height='80' width='480'>layers.c.36.png</image></td><td align='left' valign='center'>Dhls=Lhls apply with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_hue</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.38.png' height='80' width='480'>layers.c.37.png</image></td><td align='left' valign='center'>Dh=Lh apply with alpha, Dsv=Lsv, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_saturation</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.39.png' height='80' width='480'>layers.c.38.png</image></td><td align='left' valign='center'>Ds=Ls apply with alpha, Dhv=Lhv, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_lightness</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.40.png' height='80' width='480'>layers.c.39.png</image></td><td align='left' valign='center'>Dl=Ll apply with alpha, Dhs=Lhs, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_color</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.41.png' height='80' width='480'>layers.c.40.png</image></td><td align='left' valign='center'>Dhs=Lhs apply with alpha, Dl=Ll, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_lightness_mul</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.42.png' height='80' width='480'>layers.c.41.png</image></td><td align='left' valign='center'>Dl=Ll*Sl apply with alpha, Dhs=Lhs, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_darken</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.43.png' height='80' width='480'>layers.c.42.png</image></td><td align='left' valign='center'>Dl=min(Ll,Sl) apply with alpha, Dhs=Lhs, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_lighten</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.44.png' height='80' width='480'>layers.c.43.png</image></td><td align='left' valign='center'>Dl=max(Ll,Sl) apply with alpha, Dhs=Lhs, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_saturate</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.45.png' height='80' width='480'>layers.c.44.png</image></td><td align='left' valign='center'>Ds=max(Ls,Ss) apply with alpha, Dhl=Lhl, aD=aS</td></tr> - <tr><td align='left' colspan='2'>hls_desaturate</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.46.png' height='80' width='480'>layers.c.45.png</image></td><td align='left' valign='center'>Ds=min(Ls,Ss) apply with alpha, Dhl=Lhl, aD=aS</td></tr> - <tr><td> </td></tr><tr><td align='left' colspan='2'>dissolve</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.47.png' height='80' width='480'>layers.c.46.png</image></td><td align='left' valign='center'>i=random 0 or 1, D=i?L:S, aD=i+aS</td></tr> - <tr><td align='left' colspan='2'>behind</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.48.png' height='80' width='480'>layers.c.47.png</image></td><td align='left' valign='center'>D=(S*aS+L*(1-aS)*aL) / (aS+(1-aS)*aL), aD=(aS+(1-aS)*aL); simply swap S and L</td></tr> - <tr><td align='left' colspan='2'>erase</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.49.png' height='80' width='480'>layers.c.48.png</image></td><td align='left' valign='center'>D=S, aD=aS*(1-aL)</td></tr> - <tr><td> </td></tr><tr><td align='left' colspan='2'>screen</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.50.png' height='80' width='480'>layers.c.49.png</image></td><td align='left' valign='center'>1-(1-S)*(1-L) applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>overlay</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.51.png' height='80' width='480'>layers.c.50.png</image></td><td align='left' valign='center'>(1-(1-a)*(1-b)-a*b)*a+a*b applied with alpha, aD=aS</td></tr> - <tr><td align='left' colspan='2'>burn_alpha</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.52.png' height='80' width='480'>layers.c.51.png</image></td><td align='left' valign='center'>aD=aL+aS applied with alpha, D=L+S; experimental, may change or be removed</td></tr> - <tr><td> </td></tr><tr><td align='left' colspan='2'>equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.53.png' height='80' width='480'>layers.c.52.png</image></td><td align='left' valign='center'>each channel D=max if L==S, 0 otherwise, apply with alpha</td></tr> - <tr><td align='left' colspan='2'>not_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.54.png' height='80' width='480'>layers.c.53.png</image></td><td align='left' valign='center'>each channel D=max if L!=S, 0 otherwise, apply with alpha</td></tr> - <tr><td align='left' colspan='2'>less</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.55.png' height='80' width='480'>layers.c.54.png</image></td><td align='left' valign='center'>each channel D=max if L&amp;lt;S, 0 otherwise, apply with alpha</td></tr> - <tr><td align='left' colspan='2'>more</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.56.png' height='80' width='480'>layers.c.55.png</image></td><td align='left' valign='center'>each channel D=max if L&amp;gt;S, 0 otherwise, apply with alpha</td></tr> - <tr><td align='left' colspan='2'>less_or_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.57.png' height='80' width='480'>layers.c.56.png</image></td><td align='left' valign='center'>each channel D=max if L&amp;lt;=S, 0 otherwise, apply with alpha</td></tr> - <tr><td align='left' colspan='2'>more_or_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.58.png' height='80' width='480'>layers.c.57.png</image></td><td align='left' valign='center'>each channel D=max if L&amp;gt;=S, 0 otherwise, apply with alpha</td></tr> - <tr><td> </td></tr><tr><td align='left' colspan='2'>logic_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.59.png' height='80' width='480'>layers.c.58.png</image></td><td align='left' valign='center'>logic: D=white and opaque if L==S, black and transparent otherwise</td></tr> - <tr><td align='left' colspan='2'>logic_not_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.60.png' height='80' width='480'>layers.c.59.png</image></td><td align='left' valign='center'>logic: D=white and opaque if any L!=S, black and transparent otherwise</td></tr> - <tr><td align='left' colspan='2'>logic_strict_less</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.61.png' height='80' width='480'>layers.c.60.png</image></td><td align='left' valign='center'>logic: D=white and opaque if all L&amp;lt;S, black and transparent otherwise</td></tr> - <tr><td align='left' colspan='2'>logic_strict_more</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.62.png' height='80' width='480'>layers.c.61.png</image></td><td align='left' valign='center'>logic: D=white and opaque if all L&amp;gt;S, black and transparent otherwise</td></tr> - <tr><td align='left' colspan='2'>logic_strict_less_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.63.png' height='80' width='480'>layers.c.62.png</image></td><td align='left' valign='center'>logic: D=white and opaque if all L&amp;lt;=L, black and transparent otherwise</td></tr> - <tr><td align='left' colspan='2'>logic_strict_more_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.64.png' height='80' width='480'>layers.c.63.png</image></td><td align='left' valign='center'>logic: D=white and opaque if all L&amp;gt;=L, black and transparent otherwise</td></tr> + <table cellpadding='1' cellspacing='0'><tr><td align='left' colspan='2'>top layer</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.1.jpeg' height='80' width='480'>layers.c.0.jpeg</image></td><td align='left' valign='center'/></tr> + <tr><td align='left' colspan='2'>bottom layer</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.2.jpeg' height='80' width='480'>layers.c.1.jpeg</image></td><td align='left' valign='center'/></tr> + <tr><td align='left' colspan='2'>normal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.3.jpeg' height='80' width='480'>layers.c.2.jpeg</image></td><td align='left' valign='center'>D=L applied with alpha: D=(L*aL+S*(1-aL)*aS) / (aL+(1-aL)*aS), aD=(aL+(1-aL)*aS)</td></tr> + <tr><td> </td></tr><tr><td align='left' colspan='2'>add</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.4.jpeg' height='80' width='480'>layers.c.3.jpeg</image></td><td align='left' valign='center'>D=L+S applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>subtract</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.5.jpeg' height='80' width='480'>layers.c.4.jpeg</image></td><td align='left' valign='center'>D=S-L applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>multiply</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.6.jpeg' height='80' width='480'>layers.c.5.jpeg</image></td><td align='left' valign='center'>D=S*L applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>divide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.7.jpeg' height='80' width='480'>layers.c.6.jpeg</image></td><td align='left' valign='center'>D=S/L applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>negdivide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.8.jpeg' height='80' width='480'>layers.c.7.jpeg</image></td><td align='left' valign='center'>D=1.0-S/L applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>modulo</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.9.jpeg' height='80' width='480'>layers.c.8.jpeg</image></td><td align='left' valign='center'>D=S%L applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>invsubtract</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.10.jpeg' height='80' width='480'>layers.c.9.jpeg</image></td><td align='left' valign='center'>D=L-S applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>invdivide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.11.jpeg' height='80' width='480'>layers.c.10.jpeg</image></td><td align='left' valign='center'>D=L/S applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>invmodulo</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.12.jpeg' height='80' width='480'>layers.c.11.jpeg</image></td><td align='left' valign='center'>D=L%S applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>imultiply</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.13.jpeg' height='80' width='480'>layers.c.12.jpeg</image></td><td align='left' valign='center'>D=(1-L)*S applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>idivide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.14.jpeg' height='80' width='480'>layers.c.13.jpeg</image></td><td align='left' valign='center'>D=S/(1-L) applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>invidivide</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.15.jpeg' height='80' width='480'>layers.c.14.jpeg</image></td><td align='left' valign='center'>D=L/(1-S) applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>difference</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.16.jpeg' height='80' width='480'>layers.c.15.jpeg</image></td><td align='left' valign='center'>D=abs(L-S) applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>max</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.17.jpeg' height='80' width='480'>layers.c.16.jpeg</image></td><td align='left' valign='center'>D=max(L,S) applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>min</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.18.jpeg' height='80' width='480'>layers.c.17.jpeg</image></td><td align='left' valign='center'>D=min(L,S) applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>bitwise_and</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.19.jpeg' height='80' width='480'>layers.c.18.jpeg</image></td><td align='left' valign='center'>D=L&amp;amp;S applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>bitwise_or</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.20.jpeg' height='80' width='480'>layers.c.19.jpeg</image></td><td align='left' valign='center'>D=L|S applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>bitwise_xor</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.21.jpeg' height='80' width='480'>layers.c.20.jpeg</image></td><td align='left' valign='center'>D=L^S applied with alpha, aD=aS</td></tr> + <tr><td> </td></tr><tr><td align='left' colspan='2'>replace</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.22.jpeg' height='80' width='480'>layers.c.21.jpeg</image></td><td align='left' valign='center'>D=(L*aL+S*(1-aL)*aS) / (aL+(1-aL)*aS), aD=aS</td></tr> + <tr><td align='left' colspan='2'>red</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.23.jpeg' height='80' width='480'>layers.c.22.jpeg</image></td><td align='left' valign='center'>Dr=(Lr*aLr+Sr*(1-aLr)*aSr) / (aLr+(1-aLr)*aSr), Dgb=Sgb, aD=aS</td></tr> + <tr><td align='left' colspan='2'>green</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.24.jpeg' height='80' width='480'>layers.c.23.jpeg</image></td><td align='left' valign='center'>Dg=(Lg*aLg+Sg*(1-aLg)*aSg) / (aLg+(1-aLg)*aSg), Drb=Srb, aD=aS</td></tr> + <tr><td align='left' colspan='2'>blue</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.25.jpeg' height='80' width='480'>layers.c.24.jpeg</image></td><td align='left' valign='center'>Db=(Lb*aLb+Sb*(1-aLb)*aSb) / (aLb+(1-aLb)*aSb), Drg=Srg, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hardlight</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.26.jpeg' height='80' width='480'>layers.c.25.jpeg</image></td><td align='left' valign='center'>Like photoshop hardlight layer mode, aD=aS</td></tr> + <tr><td> </td></tr><tr><td align='left' colspan='2'>replace_hsv</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.27.jpeg' height='80' width='480'>layers.c.26.jpeg</image></td><td align='left' valign='center'>Dhsv=Lhsv apply with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hue</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.28.jpeg' height='80' width='480'>layers.c.27.jpeg</image></td><td align='left' valign='center'>Dh=Lh apply with alpha, Dsv=Lsv, aD=aS</td></tr> + <tr><td align='left' colspan='2'>saturation</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.29.jpeg' height='80' width='480'>layers.c.28.jpeg</image></td><td align='left' valign='center'>Ds=Ls apply with alpha, Dhv=Lhv, aD=aS</td></tr> + <tr><td align='left' colspan='2'>value</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.30.jpeg' height='80' width='480'>layers.c.29.jpeg</image></td><td align='left' valign='center'>Dv=Lv apply with alpha, Dhs=Lhs, aD=aS</td></tr> + <tr><td align='left' colspan='2'>color</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.31.jpeg' height='80' width='480'>layers.c.30.jpeg</image></td><td align='left' valign='center'>Dhs=Lhs apply with alpha, Dv=Lv, aD=aS</td></tr> + <tr><td align='left' colspan='2'>value_mul</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.32.jpeg' height='80' width='480'>layers.c.31.jpeg</image></td><td align='left' valign='center'>Dv=Lv*Sv apply with alpha, Dhs=Lhs, aD=aS</td></tr> + <tr><td> </td></tr><tr><td align='left' colspan='2'>darken</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.33.jpeg' height='80' width='480'>layers.c.32.jpeg</image></td><td align='left' valign='center'>Dv=min(Lv,Sv) apply with alpha, Dhs=Lhs, aD=aS</td></tr> + <tr><td align='left' colspan='2'>lighten</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.34.jpeg' height='80' width='480'>layers.c.33.jpeg</image></td><td align='left' valign='center'>Dv=max(Lv,Sv) apply with alpha, Dhs=Lhs, aD=aS</td></tr> + <tr><td align='left' colspan='2'>saturate</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.35.jpeg' height='80' width='480'>layers.c.34.jpeg</image></td><td align='left' valign='center'>Ds=max(Ls,Ss) apply with alpha, Dhv=Lhv, aD=aS</td></tr> + <tr><td align='left' colspan='2'>desaturate</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.36.jpeg' height='80' width='480'>layers.c.35.jpeg</image></td><td align='left' valign='center'>Ds=min(Ls,Ss) apply with alpha, Dhv=Lhv, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_replace</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.37.jpeg' height='80' width='480'>layers.c.36.jpeg</image></td><td align='left' valign='center'>Dhls=Lhls apply with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_hue</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.38.jpeg' height='80' width='480'>layers.c.37.jpeg</image></td><td align='left' valign='center'>Dh=Lh apply with alpha, Dsv=Lsv, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_saturation</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.39.jpeg' height='80' width='480'>layers.c.38.jpeg</image></td><td align='left' valign='center'>Ds=Ls apply with alpha, Dhv=Lhv, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_lightness</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.40.jpeg' height='80' width='480'>layers.c.39.jpeg</image></td><td align='left' valign='center'>Dl=Ll apply with alpha, Dhs=Lhs, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_color</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.41.jpeg' height='80' width='480'>layers.c.40.jpeg</image></td><td align='left' valign='center'>Dhs=Lhs apply with alpha, Dl=Ll, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_lightness_mul</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.42.jpeg' height='80' width='480'>layers.c.41.jpeg</image></td><td align='left' valign='center'>Dl=Ll*Sl apply with alpha, Dhs=Lhs, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_darken</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.43.jpeg' height='80' width='480'>layers.c.42.jpeg</image></td><td align='left' valign='center'>Dl=min(Ll,Sl) apply with alpha, Dhs=Lhs, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_lighten</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.44.jpeg' height='80' width='480'>layers.c.43.jpeg</image></td><td align='left' valign='center'>Dl=max(Ll,Sl) apply with alpha, Dhs=Lhs, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_saturate</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.45.jpeg' height='80' width='480'>layers.c.44.jpeg</image></td><td align='left' valign='center'>Ds=max(Ls,Ss) apply with alpha, Dhl=Lhl, aD=aS</td></tr> + <tr><td align='left' colspan='2'>hls_desaturate</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.46.jpeg' height='80' width='480'>layers.c.45.jpeg</image></td><td align='left' valign='center'>Ds=min(Ls,Ss) apply with alpha, Dhl=Lhl, aD=aS</td></tr> + <tr><td> </td></tr><tr><td align='left' colspan='2'>dissolve</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.47.jpeg' height='80' width='480'>layers.c.46.jpeg</image></td><td align='left' valign='center'>i=random 0 or 1, D=i?L:S, aD=i+aS</td></tr> + <tr><td align='left' colspan='2'>behind</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.48.jpeg' height='80' width='480'>layers.c.47.jpeg</image></td><td align='left' valign='center'>D=(S*aS+L*(1-aS)*aL) / (aS+(1-aS)*aL), aD=(aS+(1-aS)*aL); simply swap S and L</td></tr> + <tr><td align='left' colspan='2'>erase</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.49.jpeg' height='80' width='480'>layers.c.48.jpeg</image></td><td align='left' valign='center'>D=S, aD=aS*(1-aL)</td></tr> + <tr><td> </td></tr><tr><td align='left' colspan='2'>screen</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.50.jpeg' height='80' width='480'>layers.c.49.jpeg</image></td><td align='left' valign='center'>1-(1-S)*(1-L) applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>overlay</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.51.jpeg' height='80' width='480'>layers.c.50.jpeg</image></td><td align='left' valign='center'>(1-(1-a)*(1-b)-a*b)*a+a*b applied with alpha, aD=aS</td></tr> + <tr><td align='left' colspan='2'>burn_alpha</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.52.jpeg' height='80' width='480'>layers.c.51.jpeg</image></td><td align='left' valign='center'>aD=aL+aS applied with alpha, D=L+S; experimental, may change or be removed</td></tr> + <tr><td> </td></tr><tr><td align='left' colspan='2'>equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.53.jpeg' height='80' width='480'>layers.c.52.jpeg</image></td><td align='left' valign='center'>each channel D=max if L==S, 0 otherwise, apply with alpha</td></tr> + <tr><td align='left' colspan='2'>not_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.54.jpeg' height='80' width='480'>layers.c.53.jpeg</image></td><td align='left' valign='center'>each channel D=max if L!=S, 0 otherwise, apply with alpha</td></tr> + <tr><td align='left' colspan='2'>less</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.55.jpeg' height='80' width='480'>layers.c.54.jpeg</image></td><td align='left' valign='center'>each channel D=max if L&amp;lt;S, 0 otherwise, apply with alpha</td></tr> + <tr><td align='left' colspan='2'>more</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.56.jpeg' height='80' width='480'>layers.c.55.jpeg</image></td><td align='left' valign='center'>each channel D=max if L&amp;gt;S, 0 otherwise, apply with alpha</td></tr> + <tr><td align='left' colspan='2'>less_or_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.57.jpeg' height='80' width='480'>layers.c.56.jpeg</image></td><td align='left' valign='center'>each channel D=max if L&amp;lt;=S, 0 otherwise, apply with alpha</td></tr> + <tr><td align='left' colspan='2'>more_or_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.58.jpeg' height='80' width='480'>layers.c.57.jpeg</image></td><td align='left' valign='center'>each channel D=max if L&amp;gt;=S, 0 otherwise, apply with alpha</td></tr> + <tr><td> </td></tr><tr><td align='left' colspan='2'>logic_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.59.jpeg' height='80' width='480'>layers.c.58.jpeg</image></td><td align='left' valign='center'>logic: D=white and opaque if L==S, black and transparent otherwise</td></tr> + <tr><td align='left' colspan='2'>logic_not_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.60.jpeg' height='80' width='480'>layers.c.59.jpeg</image></td><td align='left' valign='center'>logic: D=white and opaque if any L!=S, black and transparent otherwise</td></tr> + <tr><td align='left' colspan='2'>logic_strict_less</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.61.jpeg' height='80' width='480'>layers.c.60.jpeg</image></td><td align='left' valign='center'>logic: D=white and opaque if all L&amp;lt;S, black and transparent otherwise</td></tr> + <tr><td align='left' colspan='2'>logic_strict_more</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.62.jpeg' height='80' width='480'>layers.c.61.jpeg</image></td><td align='left' valign='center'>logic: D=white and opaque if all L&amp;gt;S, black and transparent otherwise</td></tr> + <tr><td align='left' colspan='2'>logic_strict_less_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.63.jpeg' height='80' width='480'>layers.c.62.jpeg</image></td><td align='left' valign='center'>logic: D=white and opaque if all L&amp;lt;=L, black and transparent otherwise</td></tr> + <tr><td align='left' colspan='2'>logic_strict_more_equal</td></tr><tr><td align='right'><image file='predef.Image.Layer.set_mode.64.jpeg' height='80' width='480'>layers.c.63.jpeg</image></td><td align='left' valign='center'>logic: D=white and opaque if all L&amp;gt;=L, black and transparent otherwise</td></tr> </table> <ref resolved='predef::Image.Layer.available_modes'>available_modes</ref>() simply gives an array containing the names of these modes. </text> <group><note/><text> image and alpha channel must be of the same size, or canceled. </text></group>
autodoc.git/traditional.xml:27246: <expr>"error"</expr>. </text></doc> <method name='exif_decode'> <arguments><argument name='data'><type><string/></type></argument><argument name='options'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><mapping/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"____Image_JPEG"' homogen-type='inherit'> - <inherit name='"____Image_JPEG"'><classname>"____Image_JPEG"</classname></inherit> + <docgroup homogen-name='"____Image_JPEG"' homogen-type='inherit'> + <inherit name='"____Image_JPEG"'><classname>"____Image_JPEG"</classname></inherit> </docgroup> <docgroup homogen-name='quant_tables' homogen-type='method'><doc><group><fixme/><text>Document this function </text></group></doc> <method name='quant_tables'> <arguments><argument name='a'><type><or><int/><void/></or></type></argument></arguments> <returntype><mapping><indextype><int/></indextype><valuetype><array><valuetype><array><valuetype><int/></valuetype></array></valuetype></array></valuetype></mapping></returntype> </method> </docgroup> <class name='Marker'> <docgroup homogen-name='APP0' homogen-type='constant'>
autodoc.git/traditional.xml:28430: </text></group><group><member><type><int/></type><index>"NewSubfileType"</index></member><member><type><string/></type><index>"BitsPerSample"</index></member><member><type><int/></type><index>"Compression"</index></member><member><type><int/></type><index>"PhotometricInterpretation"</index></member><member><type><string/></type><index>"Make"</index></member><member><type><string/></type><index>"Model"</index></member><member><type><int/></type><index>"SamplesPerPixel"</index></member><member><type><int/></type><index>"ResolutionUnit"</index></member><member><type><string/></type><index>"Software"</index></member><member><type><string/></type><index>"DateTime"</index></member><member><type><int/></type><index>"Predictor"</index></member><member><type><string/></type><index>"XMP"</index></member></group></mapping> </text></doc> <method name='decode_header'><modifiers><public/></modifiers> <arguments><argument name='data'><type><string/></type></argument></arguments> <returntype><mapping/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"____Image_TIFF"' homogen-type='inherit'> - <inherit name='"____Image_TIFF"'><classname>"____Image_TIFF"</classname></inherit> + <docgroup homogen-name='"____Image_TIFF"' homogen-type='inherit'> + <inherit name='"____Image_TIFF"'><classname>"____Image_TIFF"</classname></inherit> </docgroup> </module> <module name='TIM'> <doc> <text> Handle decoding of TIM images. TIM is the framebuffer format of the PSX game system. It is a simple, uncompressed, truecolor or CLUT format
autodoc.git/traditional.xml:30865: <ref resolved='predef::Stdio.Port.bind'>Stdio.Port.bind</ref> for more information </text></group></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='callback'><type><function><argtype><object resolved='predef::Protocols.HTTP.Server.Request'>Request</object></argtype><returntype><void/></returntype></function></type></argument><argument name='port'><type><or><void/><int/></or></type></argument><argument name='interface'><type><or><void/><string/></or></type></argument><argument name='key'><type><or><void/><string/><object>Crypto.Sign.State</object></or></type></argument><argument name='certificate'><type><or><void/><string/><array><valuetype><string/></valuetype></array></or></type></argument><argument name='share'><type><or><void/><int/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.HTTP.Server'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.HTTP.Server'>"."</classname></import> </docgroup> <docgroup homogen-name='Port' homogen-type='inherit'> <inherit name='Port'><classname resolved='predef::SSL.Port'>SSL.Port</classname></inherit> </docgroup> <docgroup homogen-name='new_connection' homogen-type='method'><doc><text>The port accept callback </text></doc> <method name='new_connection'><modifiers><protected/></modifiers> <arguments/> <returntype><void/></returntype> </method>
autodoc.git/traditional.xml:31789: send_packet() function to transmit packets. </text></doc> <method name='handle_handshake'> <arguments><argument name='type'><type><int/></type></argument><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument><argument name='raw'><type><string><min>0</min><max>255</max></string></type></argument></arguments> <returntype><int><min>-1</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='Connection' homogen-type='inherit'> <inherit name='Connection'><classname resolved='predef::SSL.Connection'>Connection</classname></inherit> </docgroup> <docgroup homogen-name='send_renegotiate' homogen-type='method'><doc><text>Renegotiate the connection (client initiated). Sends a <ref resolved='predef::SSL.ClientConnection.client_hello'>client_hello</ref> to force a new round of handshaking. </text></doc>
autodoc.git/traditional.xml:32587: </docgroup> <docgroup homogen-name='heartbleed_probe' homogen-type='variable'><doc><text>If set, the other peer will be probed for the heartbleed bug during handshake. If heartbleed is found the connection is closed with insufficient security fatal error. </text></doc> <variable name='heartbleed_probe'><type><int><min>0</min><max>1</max></int></type></variable> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-type='variable'><doc><text>Temporary, non-certified, private keys, used for RSA key exchange in export mode. They are used as follows: <ref resolved='predef::SSL.Context.short_rsa'>short_rsa</ref> is a 512-bit RSA key used for the SSL 3.0 and TLS 1.0 export cipher suites. <ref resolved='predef::SSL.Context.long_rsa'>long_rsa</ref> is a 1024-bit RSA key to be used for the RSA_EXPORT1024 suites from draft-ietf-tls-56-bit-ciphersuites-01.txt.
autodoc.git/traditional.xml:33453: send_packet() function to transmit packets. </text></doc> <method name='handle_handshake'> <arguments><argument name='type'><type><int/></type></argument><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument><argument name='raw'><type><string><min>0</min><max>255</max></string></type></argument></arguments> <returntype><int><min>-1</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='Connection' homogen-type='inherit'> <inherit name='Connection'><classname resolved='predef::SSL.Connection'>Connection</classname></inherit> </docgroup> <docgroup homogen-name='send_renegotiate' homogen-type='method'><doc><text>Renegotiate the connection (server initiated). Sends a <ref>hello_request</ref> to force a new round of handshaking. </text></doc>
autodoc.git/traditional.xml:33563: </text></doc> <variable name='heartbeat_mode'><type><object>HeartBeatModeType</object></type></variable> </docgroup> <docgroup homogen-name='identity' homogen-type='variable'><doc><text>Identifies the session to the server </text></doc> <variable name='identity'><type><string><min>0</min><max>255</max></string></type></variable> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='is_supported_cert' homogen-type='method'><doc><text>Used to filter certificates not supported by the peer. </text><group><param name='cp'/><text>Candidate <ref resolved='predef::SSL.Constants.CertificatePair'>CertificatePair</ref>. </text></group><group><param name='version'/><text>Negotiated version of SSL. </text></group><group><param name='ecc_curves'/><text>The set of ecc_curves supported by the peer. </text></group></doc> <method name='is_supported_cert'><modifiers><protected/></modifiers>
autodoc.git/traditional.xml:33730: <docgroup homogen-name='encrypt_packet' homogen-type='method'><doc><text>Encrypts a packet (including deflating and MAC-generation). </text></doc> <method name='encrypt_packet'> <arguments><argument name='packet'><type><object resolved='predef::SSL.Packet'>Packet</object></type></argument></arguments> <returntype><or><object resolved='predef::SSL.Alert'>Alert</object><object resolved='predef::SSL.Packet'>Packet</object></or></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='mac' homogen-type='variable'><doc><text>Message Authentication Code </text></doc> <variable name='mac'><type><object resolved='predef::SSL.Cipher.MACAlgorithm'>Cipher.MACAlgorithm</object></type></variable> </docgroup> <docgroup homogen-name='salt' homogen-type='variable'><doc><text>TLS 1.2 IV salt. This is used as a prefix for the IV for the AEAD cipher algorithms.
autodoc.git/traditional.xml:33818: <returntype><void/></returntype> </method> <method name='create'> <arguments><argument name='server'><type><string/></type></argument><argument name='options'><type><mapping/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.LysKOM'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.LysKOM'>"."</classname></import> </docgroup> <docgroup homogen-type='variable'><doc><text>Description of the connected server. </text></doc> <variable name='protocol_level'><type><int/></type></variable> <variable name='session_software'><type><string/></type></variable> <variable name='software_version'><type><string/></type></variable> </docgroup> </class> <module name='ProtocolTypes'> <doc><text>Data types as defined by the LysKOM protocol specification.
autodoc.git/traditional.xml:34010: <returntype><object resolved='predef::Protocols.LysKOM.Session.create_text'/></returntype> </method> <method name='create_text'> <arguments><argument name='subject'><type><string/></type></argument><argument name='body'><type><string/></type></argument><argument name='options'><type><mapping/></type></argument><argument name='callback'><type><function/></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments> <returntype><object resolved='predef::Protocols.LysKOM.Session.create_text'/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.LysKOM'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.LysKOM'>"."</classname></import> </docgroup> <docgroup homogen-name='login' homogen-type='method'><doc><text>Performs a login. Throws a lyskom error if unsuccessful. </text><group><returns/><text>The session object logged in. </text></group></doc> <method name='login'> <arguments><argument name='user_no'><type><int/></type></argument><argument name='password'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Protocols.LysKOM.Session.login'/></returntype> </method> <method name='login'> <arguments><argument name='user_no'><type><int/></type></argument><argument name='password'><type><string/></type></argument><argument name='invisible'><type><int/></type></argument></arguments>
autodoc.git/traditional.xml:35806: </text></group></mapping> </text></group></doc> <method name='create'> <arguments><argument name='server'><type><or><string/><object resolved='predef::Protocols.IRC.Client.create'/></or></type></argument><argument name='options'><type><or><void/><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.IRC'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.IRC'>"."</classname></import> </docgroup> </class> <class name='Person'> <doc><text>Abstract class for a person. </text></doc> <docgroup homogen-name='ip' homogen-type='variable'><doc><text>User domain, e.g. <expr>"mistel.idonex.se"</expr>. </text></doc> <variable name='ip'><type><string/></type></variable> </docgroup> <docgroup homogen-name='last_action' homogen-type='variable'><doc><text>Time of last action, represented as posix time.
autodoc.git/traditional.xml:36225: name is returned. </text></doc> <method name='get_constant_name'> <arguments><argument name='val'><type><mixed/></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols'>"."</classname></import> </docgroup> <docgroup homogen-name='ldap_decode_string' homogen-type='method'><doc><text>Decodes all <expr>\xx</expr> escapes in <ref resolved='predef::Protocols.LDAP.ldap_decode_string.str'>str</ref>. </text><group><seealso/><text><ref resolved='predef::Protocols.LDAP.ldap_encode_string'>ldap_encode_string</ref> </text></group></doc> <method name='ldap_decode_string'> <arguments><argument name='str'><type><string/></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='ldap_encode_string' homogen-type='method'><doc><text>Quote characters in the given string as necessary for use as a
autodoc.git/traditional.xml:36628: </text><group><seealso/><text><ref resolved='predef::Protocols.LDAP.client.search'>search</ref> </text></group></doc> <method name='get_supported_controls'> <arguments/> <returntype><multiset><indextype><string/></indextype></multiset></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.LDAP'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.LDAP'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>SSL.Constants</classname></import> </docgroup> <docgroup homogen-name='Types' homogen-type='import'> <import name='Types'><classname resolved='predef::Standards.ASN1.Types'>Standards.ASN1.Types</classname></import> </docgroup> <docgroup homogen-name='info' homogen-type='variable'><doc><text>Several information about code itself and about active connection too </text></doc> <variable name='info'><type><mapping/></type></variable>
autodoc.git/traditional.xml:38307: </text></group><group><returns/><text>the function associated with oid, if any </text></group></doc> <method name='get_set_oid_callback'> <arguments><argument name='oid'><type><string/></type></argument></arguments> <returntype><or><void/><function/></or></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"protocol"' homogen-type='inherit'> - <inherit name='"protocol"'><classname resolved='predef::Protocols.SNMP.protocol'>"protocol"</classname></inherit> + <docgroup homogen-name='"protocol"' homogen-type='inherit'> + <inherit name='"protocol"'><classname resolved='predef::Protocols.SNMP.protocol'>"protocol"</classname></inherit> </docgroup> <docgroup homogen-name='set_get_communities' homogen-type='method'><doc><text>set the valid community strings for Get requests </text><group><param name='communities'/><text>an array of valid Get communities </text></group><group><note/><text>send an empty array to disable Get requests </text></group></doc> <method name='set_get_communities'> <arguments><argument name='communities'><type><array/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup>
autodoc.git/traditional.xml:40313: <arguments><argument name='str'><type><string/></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></returntype> </method> </docgroup> <docgroup homogen-name='QueryTextExtents_req' homogen-type='method'> <method name='QueryTextExtents_req'> <arguments><argument name='str'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Protocols.X.Types.Font.QueryTextExtents_req'/></returntype> </method> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.X.Types'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.X.Types'>"."</classname></import> </docgroup> <docgroup homogen-name='XResource' homogen-type='inherit'> <inherit name='XResource'><classname resolved='predef::Protocols.X.Types.XResource'>XResource</classname></inherit> </docgroup> </class> <class name='GC'> <docgroup homogen-name='ChangeGC' homogen-type='method'> <method name='ChangeGC'> <arguments><argument name='attributes'><type><mapping/></type></argument></arguments> <returntype><void/></returntype>
autodoc.git/traditional.xml:97896: </text></group></dl>Unless something else is mentioned above, <ref resolved='predef::filter.fun'>fun</ref> is used as filter like this: <dl><group><item name='function'/><text><ref resolved='predef::filter.fun'>fun</ref> is called for each element. It gets the current element as the first argument and <ref resolved='predef::filter.extra'>extra</ref> as the rest. The element is kept if it returns true, otherwise it's filtered out. </text></group><group><item name='object'/><text>The object is used as a function like above, i.e. the <ref resolved='lfun::`()'>lfun::`()</ref> method in it is called. </text></group><group><item name='multiset'/><item name='mapping'/><text><ref resolved='predef::filter.fun'>fun</ref> is indexed with each element. The element is kept if the result is nonzero, otherwise it's filtered out. - </text></group><group><item name='"zero or left out"'/><text>Each element that is callable is called with <ref resolved='predef::filter.extra'>extra</ref> as + </text></group><group><item name='"zero or left out"'/><text>Each element that is callable is called with <ref resolved='predef::filter.extra'>extra</ref> as arguments. The element is kept if the result of the call is nonzero, otherwise it's filtered out. Elements that aren't callable are also filtered out. </text></group><group><item name='string'/><text>Each element is indexed with the given string. If the result of that is zero then the element is filtered out, otherwise the result is called with <ref resolved='predef::filter.extra'>extra</ref> as arguments. The element is kept if the return value is nonzero, otherwise it's filtered out. This is typically used when <ref resolved='predef::filter.arr'>arr</ref> is a collection of objects, and <ref resolved='predef::filter.fun'>fun</ref> is the name of some predicate function
autodoc.git/traditional.xml:98700: a multiset, in that order, which is then handled as described above. </text></group></dl><ref resolved='predef::map.fun'>fun</ref> is applied in different ways depending on its type: <dl><group><item name='function'/><text><ref resolved='predef::map.fun'>fun</ref> is called for each element. It gets the current element as the first argument and <ref resolved='predef::map.extra'>extra</ref> as the rest. The result of the call is collected. </text></group><group><item name='object'/><text><ref resolved='predef::map.fun'>fun</ref> is used as a function like above, i.e. the <ref resolved='lfun::`()'>lfun::`()</ref> method in it is called. </text></group><group><item name='multiset'/><item name='mapping'/><text><ref resolved='predef::map.fun'>fun</ref> is indexed with each element. The result of that is collected. - </text></group><group><item name='"zero or left out"'/><text>Each element that is callable is called with <ref resolved='predef::map.extra'>extra</ref> as + </text></group><group><item name='"zero or left out"'/><text>Each element that is callable is called with <ref resolved='predef::map.extra'>extra</ref> as arguments. The result of the calls are collected. Elements that aren't callable gets zero as result. </text></group><group><item name='string'/><text>Each element is indexed with the given string. If the result of that is zero then a zero is collected, otherwise it's called with <ref resolved='predef::map.extra'>extra</ref> as arguments and the result of that call is collected. This is typically used when <ref resolved='predef::map.arr'>arr</ref> is a collection of objects, and <ref resolved='predef::map.fun'>fun</ref> is the name of some function in them. </text></group></dl> </text><group><note/><text>The function is never destructive on <ref resolved='predef::map.arr'>arr</ref>.
autodoc.git/traditional.xml:102144: <returntype><object resolved='predef::Calendar.Event.Event'>Event.Event</object></returntype> </method> <method name='`->'> <arguments><argument name='region'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Calendar.Event.Event'>Event.Event</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Calendar'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Calendar'>"."</classname></import> </docgroup> </module> <module name='Gregorian'> <doc><text>This is the standard conservative christian calendar, used regularly in some countries - USA, for instance - and which derivate - the <ref resolved='predef::Calendar.ISO'>ISO</ref> calendar - is used in most of Europe. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import>
autodoc.git/traditional.xml:105923: </docgroup> <docgroup homogen-name='get_default_module' homogen-type='method'><doc><text>Get the default module for the current compatibility level (ie typically the value returned by <ref resolved='predef::all_constants'>predef::all_constants()</ref>). The default implementation calls the corresponding function in the master object. </text><group><returns/><text><mixed><group><type><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><object resolved='predef::CompilerEnvironment.get_default_module'/></or></type><text>Constant table to use. </text></group><group><type><int><min>0</min><max>0</max></int></type><text>Use the builtin constant table. </text></group></mixed> </text></group><group><note/><text>This function is typically called by <ref>Pike_compiler()->get_default_module()</ref>. - </text></group><group><seealso/><text><ref resolved='predef::MasterObject.CompatResolver.get_default_module'>MasterObject()->get_default_module()</ref>. + </text></group><group><seealso/><text><ref resolved='predef::CompilationHandler.get_default_module'>MasterObject()->get_default_module()</ref>. </text></group></doc> <method name='get_default_module'> <arguments/> <returntype><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><object resolved='predef::CompilerEnvironment.get_default_module'/></or></returntype> </method> </docgroup> <docgroup homogen-name='handle_inherit' homogen-type='method'><doc><text>Look up an inherit <ref resolved='predef::CompilerEnvironment.handle_inherit.inh'>inh</ref>. The default implementation calls the corresponding function in the master object. </text><group><seealso/><text><ref resolved='predef::MasterObject.handle_inherit'>MasterObject()->handle_inherit()</ref>.
autodoc.git/traditional.xml:110206: <ref resolved='predef::Fuse.Operations'>Operations</ref> class, clone it and pass it to the <ref resolved='predef::Fuse.run'>run</ref> method. You do not need to implemnent all functions, but at least getattr, readdir and read are needed to make a useable filesystem. A tip: ERRNO constants are available in the System module, and if one is missing /usr/include/asm[-generic]/errno.h can be included in pike programs on Linux. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Fuse"' homogen-type='inherit'> - <inherit name='"___Fuse"'><classname>"___Fuse"</classname></inherit> + <docgroup homogen-name='"___Fuse"' homogen-type='inherit'> + <inherit name='"___Fuse"'><classname>"___Fuse"</classname></inherit> </docgroup> <docgroup homogen-name='run' homogen-type='method'><doc><text>Start fuse. Args is as in argv in main(). This function will not return. The first argument (argv[0], program name) is used as the filesystem name. The first non-flag argument after argv[0] is used as the mountpoint. Otherwise these arguments are supported: <pre> -d enable debug output (implies -f) -f foreground operation -s disable multithreaded operation
autodoc.git/traditional.xml:119010: <docgroup homogen-name='crc32' homogen-type='method'><doc><text>This function calculates the standard ISO3309 Cyclic Redundancy Check. </text></doc> <method name='crc32'> <arguments><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument><argument name='start_value'><type><or><void/><int/></or></type></argument></arguments> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Gz"' homogen-type='inherit'> - <inherit name='"___Gz"'><classname>"___Gz"</classname></inherit> + <docgroup homogen-name='"___Gz"' homogen-type='inherit'> + <inherit name='"___Gz"'><classname>"___Gz"</classname></inherit> </docgroup> <docgroup homogen-name='uncompress' homogen-type='method'><doc><text>Uncompresses the <ref resolved='predef::Gz.uncompress.data'>data</ref> and returns it. The <ref resolved='predef::Gz.uncompress.raw'>raw</ref> parameter tells the decoder that the indata lacks the data header and footer defined in RFC 1950. </text></doc> <method name='uncompress'> <arguments><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument><argument name='raw'><type><or><void/><int><min>0</min><max>1</max></int></or></type></argument></arguments> <returntype><string><min>0</min><max>255</max></string></returntype> </method> </docgroup>
autodoc.git/traditional.xml:119712: </docgroup> <docgroup homogen-name='JString' homogen-type='method'> <method name='JString'> <arguments><argument name='s'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Java.jobject'>jobject</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Java"' homogen-type='inherit'> - <inherit name='"___Java"'><classname>"___Java"</classname></inherit> + <docgroup homogen-name='"___Java"' homogen-type='inherit'> + <inherit name='"___Java"'><classname>"___Java"</classname></inherit> </docgroup> <docgroup homogen-name='pkg' homogen-type='variable'><doc><text>Singleton 'package' object. Usage: object cls = Java.pkg.java.lang.String; or: object cls = Java.pkg["java/lang/String"]; cls is a jclass object; call it to create a jobject, which will have all the methods of the Java class. Example: Java.pkg.FooClass()->getResult(); </text></doc> <variable name='pkg'><type><object resolved='predef::Java'/></type></variable> </docgroup> <class name='jclass'>
autodoc.git/traditional.xml:120404: <returntype><string/></returntype> </method> </docgroup> </class> <module name='cat'> <doc><text>Catalan language locale. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='ces'> <doc><text>Czech language locale by Jan Petrous 16.10.1997, based on Slovenian language module by Iztok Umek. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='deu'> <doc><text>German language locale by Tvns Böker. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='eng'> <doc><text>English language locale. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='fin'> <doc><text>Finnish language locale created by Janne Edelman, Turku Unix Users Group ry, Turku, Finland </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='fra'> <doc><text>French language locale by Patrick Kremer. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='hrv'> <doc><text>Croatian language locale by Klara Makovac 1997/07/02 </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='hun'> <doc><text>Hungarian language locale by Zsolt Varga. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='ita'> <doc><text>Italian language locale by Francesco Chemolli </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='jpn'> <doc><text>Japanese language locale. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='mri'> <doc><text>Maaori (New Zealand) language locale by Jason Rumney </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='nld'> <doc><text>Dutch language locale by Stephen R. van den Berg </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='nor'> <doc><text>Norwegian language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='pol'> <doc><text>Polish language locale by Piotr Klaban <makler@man.torun.pl>. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='por'> <doc><text>Portuguese language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='rus'> <doc><text>Russian language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='slv'> <doc><text>Slovenian language locale by Iztok Umek 7. 8. 1997 </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='spa'> <doc><text>Spanish language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='srp'> <doc><text>Serbian language locale by Goran Opacic 1996/12/11 </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='swe'> <doc><text>Swedish language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> </module> <class name='LanguageListObject'> <modifiers><protected/></modifiers> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='languages'><type><array><valuetype><string/></valuetype></array></type></argument></arguments> <returntype><void/></returntype> </method>
autodoc.git/traditional.xml:122519: <returntype><array><valuetype><int/></valuetype></array></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='inf' homogen-type='constant'><doc><text>Floating point infinity. </text></doc> <constant name='inf'/> </docgroup> - <docgroup homogen-name='"___Math"' homogen-type='inherit'> - <inherit name='"___Math"'><classname>"___Math"</classname></inherit> + <docgroup homogen-name='"___Math"' homogen-type='inherit'> + <inherit name='"___Math"'><classname>"___Math"</classname></inherit> </docgroup> <docgroup homogen-name='log10' homogen-type='method'><doc><text>The 10-logarithm of <ref resolved='predef::Math.log10.x'>x</ref>. </text></doc> <method name='log10'> <arguments><argument name='x'><type><or><int/><float/></or></type></argument></arguments> <returntype><float/></returntype> </method> </docgroup> <docgroup homogen-name='log2' homogen-type='method'><doc><text>The 2-logarithm of <ref resolved='predef::Math.log2.x'>x</ref>. </text></doc>
autodoc.git/traditional.xml:128201: <constant name='limit_value'/> </docgroup> <docgroup homogen-name='pid' homogen-type='method'><doc><text>Returns the process identifier of the process. </text></doc> <method name='pid'> <arguments/> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='set_priority' homogen-type='method'><doc><text>Sets the priority of the process. <ref resolved='predef::Process.create_process.set_priority.priority'>priority</ref> is one of the strings - <dl><group><item name='"realtime"'/><item name='"highest"'/><item name='"higher"'/><item name='"high"'/><item name='"low"'/><item name='"lowest"'/></group></dl></text></doc> + <dl><group><item name='"realtime"'/><item name='"highest"'/><item name='"higher"'/><item name='"high"'/><item name='"low"'/><item name='"lowest"'/></group></dl></text></doc> <method name='set_priority'> <arguments><argument name='priority'><type><string/></type></argument></arguments> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='status' homogen-type='method'><doc><text>Returns the status of the process: <int><group><value>-1</value><text>Unknown </text></group><group><value>0</value><text>Running </text></group><group><value>1</value><text>Stopped </text></group><group><value>2</value><text>Exited
autodoc.git/traditional.xml:128247: <docgroup homogen-name='`()' homogen-type='method'><doc><text>Convenience/compatibility method to get a <ref resolved='predef::Regexp.SimpleRegexp'>SimpleRegexp</ref> object. </text></doc> <method name='`()'> <arguments><argument name='regexp'><type><or><void/><string/></or></type></argument></arguments> <returntype><object resolved='predef::Regexp.SimpleRegexp'>SimpleRegexp</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Regexp"' homogen-type='inherit'> - <inherit name='"___Regexp"'><classname>"___Regexp"</classname></inherit> + <docgroup homogen-name='"___Regexp"' homogen-type='inherit'> + <inherit name='"___Regexp"'><classname>"___Regexp"</classname></inherit> </docgroup> <docgroup homogen-name='match' homogen-type='method'><doc><text>Calls <ref resolved='predef::Regexp.PCRE.Plain.match'>Regexp.PCRE.Plain.match</ref> in a temporary regexp object. Faster to type but slower to run... </text></doc> <method name='match'> <arguments><argument name='regexp'><type><string/></type></argument><argument name='data'><type><string/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='replace' homogen-type='method'><doc><text>Calls <ref resolved='predef::Regexp.PCRE.Plain.replace'>Regexp.PCRE.Plain.replace</ref> in a temporary regexp object.
autodoc.git/traditional.xml:128352: "The output is an integer that is set to one if UTF-8 support is available; otherwise it is set to zero." This constant is calculated when the module is initiated by using pcre_config(3). </text></doc> <constant name='buildconfig_UTF8'/> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"____Regexp_PCRE"' homogen-type='inherit'> - <inherit name='"____Regexp_PCRE"'><classname>"____Regexp_PCRE"</classname></inherit> + <docgroup homogen-name='"____Regexp_PCRE"' homogen-type='inherit'> + <inherit name='"____Regexp_PCRE"'><classname>"____Regexp_PCRE"</classname></inherit> </docgroup> <docgroup homogen-name='split_subject' homogen-type='method'><doc><text>Convenience function that splits a subject string on the result from _pcre->exec() equal to map(previous_result/2, lambda(array v) { return subject[v[0]..v[1]-1]; }) </text></doc> <method name='split_subject'> <arguments><argument name='subject'><type><string/></type></argument><argument name='previous_result'><type><array><valuetype><int/></valuetype></array></type></argument></arguments> <returntype><array><valuetype><string/></valuetype></array></returntype>
autodoc.git/traditional.xml:129051: <docgroup homogen-name='get' homogen-type='method'><doc><text>Get a named object from the remote server. </text></doc> <method name='get'> <arguments><argument name='name'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Remote.Client.get'/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Remote'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Remote'>"."</classname></import> </docgroup> <docgroup homogen-name='provide' homogen-type='method'><doc><text>Provide a named <ref resolved='predef::Remote.Client.provide.thing'>thing</ref> to the <ref resolved='predef::Remote.Server'>Remote.Server</ref>. </text><group><param name='name'/><text>Name to provide <ref resolved='predef::Remote.Client.provide.thing'>thing</ref> under. </text></group><group><param name='thing'/><text>Thing to provide. </text></group></doc> <method name='provide'> <arguments><argument name='name'><type><string/></type></argument><argument name='thing'><type><mixed/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup>
autodoc.git/traditional.xml:129300: </text></group><group><param name='max_call_threads'/><text>Maximum number of concurrent threads. </text></group></doc> <method name='create'> <arguments><argument name='host'><type><string/></type></argument><argument name='port'><type><int/></type></argument><argument name='max_call_threads'><type><or><void/><int/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Remote'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Remote'>"."</classname></import> </docgroup> <docgroup homogen-name='port' homogen-type='variable'><doc><text>Port for the <ref resolved='predef::Remote.Server'>Remote.Server</ref>. </text></doc> <variable name='port'><type><object resolved='predef::Stdio.Port'>Stdio.Port</object></type></variable> </docgroup> <docgroup homogen-name='provide' homogen-type='method'><doc><text>Provide a named <ref resolved='predef::Remote.Server.provide.thing'>thing</ref> to the <ref resolved='predef::Remote.Client'>Remote.Client</ref>(s). </text><group><param name='name'/><text>Name to provide <ref resolved='predef::Remote.Server.provide.thing'>thing</ref> under. </text></group><group><param name='thing'/><text>Thing to provide. </text></group></doc> <method name='provide'>
autodoc.git/traditional.xml:131435: <class name='DefaultParser'> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='opt'><type><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><void/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Search.Grammar'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Search.Grammar'>"."</classname></import> </docgroup> <docgroup homogen-name='AbstractParser' homogen-type='inherit'> <inherit name='AbstractParser'><modifiers><protected/></modifiers><classname resolved='predef::Search.Grammar.AbstractParser'>.AbstractParser</classname></inherit> </docgroup> <docgroup homogen-name='Lexer' homogen-type='inherit'> <inherit name='Lexer'><modifiers><protected/></modifiers><classname resolved='predef::Search.Grammar.Lexer'>.Lexer</classname></inherit> </docgroup> <docgroup homogen-name='options' homogen-type='variable'> <variable name='options'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></variable> </docgroup>
autodoc.git/traditional.xml:138815: classes, modules, methods, variables ... The classes can produce XML representations of themselves. </text></doc> <docgroup homogen-name='EmptyDoc' homogen-type='variable'><doc><text>The empty <ref resolved='predef::Tools.AutoDoc.PikeObjects.Documentation'>Documentation</ref>. </text></doc> <variable name='EmptyDoc'><modifiers><protected/></modifiers><type><object resolved='predef::Tools.AutoDoc.PikeObjects.Documentation'>Documentation</object></type></variable> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"module.pmod"' homogen-type='inherit'> - <inherit name='"module.pmod"'><modifiers><protected/></modifiers><classname resolved='predef::Tools.AutoDoc'>"module.pmod"</classname></inherit> + <docgroup homogen-name='"module.pmod"' homogen-type='inherit'> + <inherit name='"module.pmod"'><modifiers><protected/></modifiers><classname resolved='predef::Tools.AutoDoc'>"module.pmod"</classname></inherit> </docgroup> <docgroup homogen-name='Tree' homogen-type='inherit'> <inherit name='Tree'><modifiers><protected/></modifiers><classname resolved='predef::Parser.XML.Tree'>Parser.XML.Tree</classname></inherit> </docgroup> <class name='ArrayType'> <doc><text>The class for representing array types. </text><group><seealso/><text><ref resolved='predef::Tools.AutoDoc.PikeObjects.Type'>Type</ref> </text></group></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'>
autodoc.git/traditional.xml:139776: </text><group><param name='root'/><text>The root (<tt><autodoc></tt>) node of the documentation tree. </text></group></doc> <method name='handleAppears'> <arguments><argument name='root'><type><object resolved='predef::Parser.XML.Tree.SimpleNode'>SimpleNode</object></type></argument><argument name='flags'><type><or><object resolved='predef::Tools.AutoDoc.Flags'>.Flags</object><void/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"module.pmod"' homogen-type='inherit'> - <inherit name='"module.pmod"'><modifiers><protected/></modifiers><classname resolved='predef::Tools.AutoDoc'>"module.pmod"</classname></inherit> + <docgroup homogen-name='"module.pmod"' homogen-type='inherit'> + <inherit name='"module.pmod"'><modifiers><protected/></modifiers><classname resolved='predef::Tools.AutoDoc'>"module.pmod"</classname></inherit> </docgroup> <docgroup homogen-name='Tree' homogen-type='inherit'> <inherit name='Tree'><modifiers><protected/></modifiers><classname resolved='predef::Parser.XML.Tree'>Parser.XML.Tree</classname></inherit> </docgroup> <docgroup homogen-name='mergeTrees' homogen-type='method'><doc><text>Puts all children of <ref resolved='predef::Tools.AutoDoc.ProcessXML.mergeTrees.source'>source</ref> into the tree <ref resolved='predef::Tools.AutoDoc.ProcessXML.mergeTrees.dest'>dest</ref>, in their correct place module-hierarchically. Used to merge the results of extractions of different Pike and C files. Some minor effort is expended to normalize the result to some sort of canonical order. </text><group><param name='source'/><param name='dest'/><text>The nodes <ref resolved='predef::Tools.AutoDoc.ProcessXML.mergeTrees.source'>source</ref> and <ref resolved='predef::Tools.AutoDoc.ProcessXML.mergeTrees.dest'>dest</ref> are <tt><class></tt>, <tt><module></tt>,
autodoc.git/traditional.xml:139915: </docgroup> <docgroup homogen-name='xml' homogen-type='method'><doc><group><returns/><text>Returns a string with an XML-fragment describing the source position. </text></group></doc> <method name='xml'> <arguments><argument name='flags'><type><or><object resolved='predef::Tools.AutoDoc.Flags'>Flags</object><void/></or></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> </class> </module> + <module name='Hilfe'> + <docgroup homogen-name='format_hr_time' homogen-type='method'><doc><text>Helper function that formats a time span in nanoseconds to + something more human readable (ns, ms or s). + </text></doc> + <method name='format_hr_time'> + <arguments><argument name='i'><type><int/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='' homogen-type='import'> + <import name=''><classname resolved='predef::'>predef::</classname></import> + </docgroup> + <class name='Command'> + <doc><text>Abstract class for Hilfe commands. + </text></doc> + <docgroup homogen-name='doc' homogen-type='method'><doc><text>A more elaborate documentation of the command. This should be + less than 68 characters per line. + </text></doc> + <method name='doc'> + <arguments><argument name='what'><type><string/></type></argument><argument name='with'><type><string/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='exec' homogen-type='method'><doc><text>The actual command callback. Messages to the user should be + written out by using the safe_write method in the <ref resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</ref> + object. + </text></doc> + <method name='exec'> + <arguments><argument name='e'><type><object resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</object></type></argument><argument name='line'><type><string/></type></argument><argument name='words'><type><array><valuetype><string/></valuetype></array></type></argument><argument name='tokens'><type><array><valuetype><string/></valuetype></array></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='help' homogen-type='method'><doc><text>Returns a one line description of the command. This help should + be shorter than 54 characters. + </text></doc> + <method name='help'> + <arguments><argument name='what'><type><string/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + </class> + <class name='CommandReset'> + <doc><text>Variable reset command. Put ___Hilfe->commands->reset = + Tools.Hilfe.CommandReset(); in your .hilferc to have this command + defined when you open Hilfe. + </text></doc> + <docgroup homogen-name='Command' homogen-type='inherit'> + <inherit name='Command'><classname resolved='predef::Tools.Hilfe.Command'>Command</classname></inherit> + </docgroup> + </class> + <class name='CommandSet'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='Command' homogen-type='inherit'> + <inherit name='Command'><classname resolved='predef::Tools.Hilfe.Command'>Command</classname></inherit> + </docgroup> + <class name='Intwriter'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='type'><type><string/></type></argument><argument name='fallback'><type><function/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-type='variable'> + <variable name='type'><type><string/></type></variable> + <variable name='fallback'><type><function/></type></variable> + </docgroup> + </class> + <class name='Reswriter'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='format'><type><string/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='format' homogen-type='variable'> + <variable name='format'><type><string/></type></variable> + </docgroup> + </class> + </class> + <class name='Evaluator'> + <doc><text>This class implements the actual Hilfe interpreter. It is accessible + as ___Hilfe from Hilfe expressions. + </text></doc> + <docgroup homogen-name='add_buffer' homogen-type='method'><doc><text>Add buffer tokenizes the input string and determines if the + new line is a Hilfe command. If not, it updates the current + state with the new tokens and sends any and all complete + expressions to evaluation in <ref resolved='predef::Tools.Hilfe.Evaluator.parse_expression'>parse_expression</ref>. + </text></doc> + <method name='add_buffer'> + <arguments><argument name='s'><type><string/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='add_input_hook' homogen-type='method'><doc><text>Adds a function to the input hook, making + all user data be fed into the function. + </text><group><seealso/><text><ref resolved='predef::Tools.Hilfe.Evaluator.remove_input_hook'>remove_input_hook</ref> + </text></group></doc> + <method name='add_input_hook'> + <arguments><argument name='new'><type><or><function/><object resolved='predef::Tools.Hilfe.Evaluator.add_input_hook'/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='add_input_line' homogen-type='method'><doc><text>Input a line of text into Hilfe. It checks if <ref resolved='predef::Tools.Hilfe.Evaluator.add_input_line.s'>s</ref> is + ".", in which case it calls state->flush(). Otherwise + just calls add_buffer. + </text></doc> + <method name='add_input_line'> + <arguments><argument name='s'><type><string/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='add_writer' homogen-type='method'><doc><text>Adds another output function. + </text></doc> + <method name='add_writer'> + <arguments><argument name='new'><type><or><object resolved='predef::Tools.Hilfe.Evaluator.add_writer'/><function><argtype><string/></argtype><returntype><int><min>0</min><max/></int></returntype></function></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='assembler_debug_level' homogen-type='variable'><doc><text>The current assembler debug level. + Only available if Pike is compiled with RTL debug. + </text></doc> + <variable name='assembler_debug_level'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='commands' homogen-type='variable'><doc><text>This mapping contains the available Hilfe commands, including the + built in ones (dump, exit, help, new, quit), so it is possible to + replace or remove them. The name of a command should be 10 + characters or less. + </text></doc> + <variable name='commands'><type><mapping><indextype><string/></indextype><valuetype><object resolved='predef::Tools.Hilfe.Command'>Command</object></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='compiler_trace_level' homogen-type='variable'><doc><text>The current compiler trace level. + Only available if Pike is compiled with RTL debug. + </text></doc> + <variable name='compiler_trace_level'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='constants' homogen-type='variable'><doc><text>The locally defined constants (name:value). + </text></doc> + <variable name='constants'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='debug_level' homogen-type='variable'><doc><text>The current debug level. + Only available if Pike is compiled with RTL debug. + </text></doc> + <variable name='debug_level'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='evaluate' homogen-type='method'><doc><text>Compiles the Pike code <ref resolved='predef::Tools.Hilfe.Evaluator.evaluate.a'>a</ref> and evaluates it by + calling ___HilfeWrapper in the generated object. + If <ref resolved='predef::Tools.Hilfe.Evaluator.evaluate.show_result'>show_result</ref> is set the result will be displayed + and the result buffer updated with its value. + </text></doc> + <method name='evaluate'> + <arguments><argument name='a'><type><string/></type></argument><argument name='show_result'><type><int><min>0</min><max>1</max></int></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='functions' homogen-type='variable'><doc><text>The locally defined functions (name:value). + </text></doc> + <variable name='functions'><type><mapping><indextype><string/></indextype><valuetype><function/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='hilfe_compile' homogen-type='method'><doc><text>Creates a wrapper and compiles the pike code <ref resolved='predef::Tools.Hilfe.Evaluator.hilfe_compile.f'>f</ref> in it. + If a new variable is compiled to be tested, its name + should be given in <ref resolved='predef::Tools.Hilfe.Evaluator.hilfe_compile.new_var'>new_var</ref> so that magically defined + entities can be undefined and a warning printed. + </text></doc> + <method name='hilfe_compile'> + <arguments><argument name='f'><type><string/></type></argument><argument name='new_var'><type><or><void/><string/></or></type></argument></arguments> + <returntype><object resolved='predef::Tools.Hilfe.Evaluator.hilfe_compile'/></returntype> + </method> + </docgroup> + <docgroup homogen-name='history' homogen-type='variable'><doc><text>The current result history. + </text></doc> + <variable name='history'><type><object resolved='predef::Tools.Hilfe.HilfeHistory'>HilfeHistory</object></type></variable> + </docgroup> + <docgroup homogen-name='imports' homogen-type='variable'><doc><text>The current imports. + </text></doc> + <variable name='imports'><type><array><valuetype><string/></valuetype></array></type></variable> + </docgroup> + <docgroup homogen-name='inherits' homogen-type='variable'><doc><text>The current inherits. + </text></doc> + <variable name='inherits'><type><array><valuetype><string/></valuetype></array></type></variable> + </docgroup> + <docgroup homogen-name='last_compile_time' homogen-type='variable'><doc><text>The last compile time; + </text></doc> + <variable name='last_compile_time'><type><int><min>0</min><max/></int></type></variable> + </docgroup> + <docgroup homogen-name='last_compiled_expr' homogen-type='variable'><doc><text>The last created wrapper in which an expression was evaluated. + </text></doc> + <variable name='last_compiled_expr'><type><string/></type></variable> + </docgroup> + <docgroup homogen-name='last_else' homogen-type='variable'><doc><text>Should an else expression be carried out? + </text></doc> + <variable name='last_else'><type><int><min>0</min><max>1</max></int></type></variable> + </docgroup> + <docgroup homogen-name='last_eval_time' homogen-type='variable'><doc><text>The last evaluation time; + </text></doc> + <variable name='last_eval_time'><type><int><min>0</min><max/></int></type></variable> + </docgroup> + <docgroup homogen-name='parse_expression' homogen-type='method'><doc><text>Parses a Pike expression. Returns 0 if everything went well, + or a string with an error message otherwise. + </text></doc> + <method name='parse_expression'> + <arguments><argument name='expr'><type><object resolved='predef::Tools.Hilfe.Expression'>Expression</object></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='print_version' homogen-type='method'><doc><text>Displays the current version of Hilfe. + </text></doc> + <method name='print_version'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='programs' homogen-type='variable'><doc><text>The locally defined programs (name:value). + </text></doc> + <variable name='programs'><type><mapping><indextype><string/></indextype><valuetype><program/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='remove_input_hook' homogen-type='method'><doc><text>Removes a function from the input hook. + </text><group><seealso/><text><ref resolved='predef::Tools.Hilfe.Evaluator.add_input_hook'>add_input_hook</ref> + </text></group></doc> + <method name='remove_input_hook'> + <arguments><argument name='old'><type><or><function/><object resolved='predef::Tools.Hilfe.Evaluator.remove_input_hook'/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='remove_writer' homogen-type='method'><doc><text>Removes an output function. + </text></doc> + <method name='remove_writer'> + <arguments><argument name='old'><type><or><object resolved='predef::Tools.Hilfe.Evaluator.remove_writer'/><function/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='reset_evaluator' homogen-type='method'><doc><text>Clears the current state, history and removes all locally + defined variables, constants, functions and programs. Removes + all imports and inherits. It does not reset the command mapping + nor reevaluate the .hilferc file. + </text></doc> + <method name='reset_evaluator'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='reswrite' homogen-type='variable'><doc><text>The function used to write results. + Gets as arguments in order: The safe_write function + (function(string, mixed ...:int), the result as a string (string), + the history entry number (int), the result (mixed), the compilation + time (int) and the evaulation time (int). If the evaluated expression + didn't return anything (e.g. a for loop) then 0 will be given as the + result string. + </text></doc> + <variable name='reswrite'><type><function/></type></variable> + </docgroup> + <docgroup homogen-name='safe_write' homogen-type='method'><doc><text>An output method that shouldn't crash. + </text></doc> + <method name='safe_write'> + <arguments><argument name='in'><type><or><array><valuetype><string/></valuetype></array><string/></or></type></argument><argument name='args'><type><varargs><mixed/></varargs></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='state' homogen-type='variable'><doc><text>Keeps the state, e.g. multiline input in process etc. + </text></doc> + <variable name='state'><type><object resolved='predef::Tools.Hilfe.ParserState'>ParserState</object></type></variable> + </docgroup> + <docgroup homogen-name='std_reswrite' homogen-type='method'><doc><text>The standard <ref resolved='predef::Tools.Hilfe.Evaluator.reswrite'>reswrite</ref> function. + </text></doc> + <method name='std_reswrite'> + <arguments><argument name='w'><type><function/></type></argument><argument name='sres'><type><string/></type></argument><argument name='num'><type><int/></type></argument><argument name='res'><type><mixed/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='strict_types' homogen-type='variable'><doc><text>Strict types? + </text></doc> + <variable name='strict_types'><type><int><min>0</min><max>1</max></int></type></variable> + </docgroup> + <docgroup homogen-name='trace_level' homogen-type='variable'><doc><text>The current trace level. + </text></doc> + <variable name='trace_level'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='types' homogen-type='variable'><doc><text>The types of the locally defined variables (name:type). + </text></doc> + <variable name='types'><type><mapping><indextype><string/></indextype><valuetype><string/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='variables' homogen-type='variable'><doc><text>The locally defined variables (name:value). + </text></doc> + <variable name='variables'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='warnings' homogen-type='variable'><doc><text>Show warnings? + </text></doc> + <variable name='warnings'><type><int><min>0</min><max>1</max></int></type></variable> + </docgroup> + <docgroup homogen-name='write' homogen-type='variable'><doc><text>The function to use when writing to the user. + </text></doc> + <variable name='write'><type><or><array/><object resolved='predef::Tools.Hilfe.Evaluator'/><function><argtype><string/></argtype><returntype><int><min>0</min><max/></int></returntype></function></or></type></variable> + </docgroup> + <class name='HilfeCompileHandler'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='stack_level'><type><int/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='stack_level' homogen-type='variable'> + <variable name='stack_level'><type><int/></type></variable> + </docgroup> + </class> + </class> + <class name='Expression'> + <doc><text>Represents a Pike expression + </text></doc> + <docgroup homogen-name='_sizeof' homogen-type='method'><doc><text>The number of non-whitespace tokens in the expression. + </text></doc> + <method name='_sizeof'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='`[]' homogen-type='method'><doc><text>Returns a token or a token range without whitespaces. + </text></doc> + <method name='`[]'> + <arguments><argument name='f'><type><int/></type></argument><argument name='t'><type><or><void/><int/></or></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='`[]=' homogen-type='method'><doc><text>Replaces a token with a new token. + </text></doc> + <method name='`[]='> + <arguments><argument name='f'><type><int/></type></argument><argument name='v'><type><string/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='cast' homogen-type='method'><doc><text>An Expression object can be cast to an array or a string. In + both forms all tokens, including white spaces will be returned. + </text></doc> + <method name='cast'><modifiers><protected/></modifiers> + <arguments><argument name='to'><type><string/></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup> + <docgroup homogen-name='check_modifiers' homogen-type='method'><doc><text>See if there are any forbidden modifiers used in the expression, + e.g. "private int x;" is not valid inside Hilfe. + </text><group><returns/><text>Returns an error message as a string if the expression + contains a forbidden modifier, otherwise <expr>0</expr>. + </text></group></doc> + <method name='check_modifiers'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='code' homogen-type='method'><doc><text>Returns the expression verbatim. + </text></doc> + <method name='code'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='t'/><text>An array of Pike tokens. + </text></group></doc> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='t'><type><array><valuetype><string/></valuetype></array></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='depth' homogen-type='method'><doc><text>Return the parenthesis depth at the given position. + </text></doc> + <method name='depth'> + <arguments><argument name='f'><type><int/></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='endoftype' homogen-type='method'><doc><text>Returns at which position the type declaration that begins at + position <ref resolved='predef::Tools.Hilfe.Expression.endoftype.position'>position</ref> ends. A return value of -1 means that the + token or tokens from <ref resolved='predef::Tools.Hilfe.Expression.endoftype.position'>position</ref> can not be a type declaration. + </text></doc> + <method name='endoftype'> + <arguments><argument name='position'><type><int><min>-1</min><max/></int></type></argument></arguments> + <returntype><int><min>-1</min><max/></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='find_matching' homogen-type='method'><doc><text>Returns the position of the matching parenthesis of the given + kind, starting from the given position. The position should be + the position after the opening parenthesis, or later. Assuming + balanced code. Returns -1 on failure. + </text></doc> + <method name='find_matching'> + <arguments><argument name='token'><type><string/></type></argument><argument name='pos'><type><or><int><min>0</min><max/></int><void/></or></type></argument></arguments> + <returntype><int><min>-1</min><max/></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='in_sscanf' homogen-type='method'><doc><text>Returns 1 if the current position is within a sscanf expression. + </text></doc> + <method name='in_sscanf'> + <arguments><argument name='f'><type><int/></type></argument></arguments> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='is_block' homogen-type='method'><doc><text>Is there a block starting at <ref resolved='predef::Tools.Hilfe.Expression.is_block.pos'>pos</ref>? + </text></doc> + <method name='is_block'> + <arguments><argument name='pos'><type><int/></type></argument></arguments> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + </class> + <class name='GenericAsyncHilfe'> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='infile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument><argument name='outfile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-type='variable'> + <variable name='infile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></variable> + <variable name='outfile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></variable> + </docgroup> + <docgroup homogen-name='Evaluator' homogen-type='inherit'> + <inherit name='Evaluator'><classname resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</classname></inherit> + </docgroup> + </class> + <class name='GenericHilfe'> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='in'><type><object resolved='predef::Stdio.FILE'>Stdio.FILE</object></type></argument><argument name='out'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='Evaluator' homogen-type='inherit'> + <inherit name='Evaluator'><classname resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</classname></inherit> + </docgroup> + </class> + <class name='HilfeHistory'> + <modifiers><protected/></modifiers> + <doc><text>In every Hilfe object (<ref resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</ref>) there is a HilfeHistory + object that manages the result history. That history object is + accessible both from __ and ___Hilfe->history in Hilfe expressions. + </text></doc> + <docgroup homogen-name='History' homogen-type='inherit'> + <inherit name='History'><classname resolved='predef::ADT.History'>ADT.History</classname></inherit> + </docgroup> + </class> + <class name='ParserState'> + <modifiers><protected/></modifiers> + <doc><text>In every Hilfe object (<ref resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</ref>) there is a ParserState object + that manages the current state of the parser. Essentially tokens are + entered in one end and complete expressions are outputted in the other. + The parser object is accessible as ___Hilfe->state from Hilfe expressions. + </text></doc> + <docgroup homogen-name='datap' homogen-type='method'><doc><text>Returns true if there is any waiting expression that can be fetched + with <ref resolved='predef::Tools.Hilfe.ParserState.read'>read</ref>. + </text></doc> + <method name='datap'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='feed' homogen-type='method'><doc><text>Feed more tokens into the state. + </text></doc> + <method name='feed'> + <arguments><argument name='tokens'><type><array><valuetype><string/></valuetype></array></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='finishedp' homogen-type='method'><doc><text>Are we in the middle of an expression. Used e.g. for changing the + Hilfe prompt when entering multiline expressions. + </text></doc> + <method name='finishedp'> + <arguments/> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='flush' homogen-type='method'><doc><text>Clear the current state. + </text></doc> + <method name='flush'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='push_string' homogen-type='method'><doc><text>Sends the input <ref resolved='predef::Tools.Hilfe.ParserState.push_string.line'>line</ref> to <ref resolved='predef::Parser.Pike'>Parser.Pike</ref> for tokenization, + but keeps a state between each call to handle multiline + /**/ comments and multiline #"" strings. + </text></doc> + <method name='push_string'> + <arguments><argument name='line'><type><string/></type></argument></arguments> + <returntype><array><valuetype><string/></valuetype></array></returntype> + </method> + </docgroup> + <docgroup homogen-name='read' homogen-type='method'><doc><text>Read out completed expressions. Returns an array where every element + is an expression represented as an array of tokens. + </text></doc> + <method name='read'> + <arguments/> + <returntype><array><valuetype><object resolved='predef::Tools.Hilfe.Expression'>Expression</object></valuetype></array></returntype> + </method> + </docgroup> + <docgroup homogen-name='show_error' homogen-type='method'><doc><text>Prints out any error that might have occurred while + <ref resolved='predef::Tools.Hilfe.ParserState.push_string'>push_string</ref> was executed. The error will be + printed with the print function <ref resolved='predef::Tools.Hilfe.ParserState.show_error.w'>w</ref>. + </text></doc> + <method name='show_error'> + <arguments><argument name='w'><type><function><argtype><or><array><valuetype><string/></valuetype></array><string/></or></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><int/></returntype></function></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='status' homogen-type='method'><doc><text>Returns the current parser state. Used by "dump state". + </text></doc> + <method name='status'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + </class> + <class name='StdinHilfe'> + <doc><text>This is a wrapper containing a user interface to the Hilfe <ref resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</ref> + so that it can actually be used. This wrapper uses the <ref resolved='predef::Stdio.Readline'>Stdio.Readline</ref> + module to interface with the user. All input history is handled by + that module, and as a consequence loading and saving .hilfe_history is + handled in this class. Also .hilferc is handled by this class. + </text></doc> + <docgroup homogen-name='create' homogen-type='method'><doc><text>Any hilfe statements given in the init array will be executed + once .hilferc has been executed. + </text></doc> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='init'><type><or><void/><array><valuetype><string/></valuetype></array></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='Evaluator' homogen-type='inherit'> + <inherit name='Evaluator'><classname resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</classname></inherit> + </docgroup> + <docgroup homogen-name='readline' homogen-type='variable'><doc><text>The readline object, + </text></doc> + <variable name='readline'><type><object resolved='predef::Stdio.Readline'>Stdio.Readline</object></type></variable> + </docgroup> + <docgroup homogen-name='save_history' homogen-type='method'><doc><text>Saves the user input history, if possible, when called. + </text></doc> + <method name='save_history'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + </class> + <class name='SubSysLogger'> + <modifiers><protected/></modifiers> + <class name='Logger'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='e'><type><object resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</object></type></argument><argument name='logfile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-type='variable'> + <variable name='e'><type><object resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</object></type></variable> + <variable name='logfile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></variable> + </docgroup> + </class> + </class> + </module> <module name='Install'> <doc><text>Common routines which are useful for various install scripts based on Pike. </text></doc> <docgroup homogen-name='features' homogen-type='method'><doc><text>Return an array of enabled features. </text><group><note/><text>Used by the <ref resolved='predef::master'>master</ref> when given the option <tt>--features</tt>. </text></group><group><seealso/><text><ref>Tools.Standalone.features</ref> </text></group></doc> <method name='features'> <arguments/> <returntype><array><valuetype><string/></valuetype></array></returntype>
autodoc.git/traditional.xml:140358: </text></doc> <method name='get_as_image'> <arguments><argument name='i'><type><object resolved='predef::Tools.PV.PVImage'>PVImage</object></type></argument></arguments> <returntype><object resolved='predef::Image.Image'>Image.Image</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='Window' homogen-type='inherit'> - <inherit name='Window'><classname resolved='predef::GTK2.Window'>GTK.Window</classname></inherit> + <inherit name='Window'><classname resolved='predef::GTK1.Window'>GTK.Window</classname></inherit> </docgroup> <docgroup homogen-name='save' homogen-type='method'><doc><text>Write the image to a file. If no format is specified, PNG is used. The alpha combination is done on the image before it's saved. </text></doc> <method name='save'> <arguments><argument name='filename'><type><string/></type></argument><argument name='format'><type><or><string/><void/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='scale' homogen-type='method'><doc><text>Scale the image before display with the specified factor.
autodoc.git/traditional.xml:142209: <docgroup homogen-name='default_domain' homogen-type='method'><doc><text>Returns the default yp-domain. </text></doc> <method name='default_domain'> <arguments/> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Yp"' homogen-type='inherit'> - <inherit name='"___Yp"'><classname>"___Yp"</classname></inherit> + <docgroup homogen-name='"___Yp"' homogen-type='inherit'> + <inherit name='"___Yp"'><classname>"___Yp"</classname></inherit> </docgroup> <class name='Domain'> <docgroup homogen-name='all' homogen-type='method'><doc><text>Returns the whole map as a mapping. <ref resolved='predef::Yp.Domain.all.map'>map</ref> is the YP-map to search in. This must be the full map name, you have to use <tt>passwd.byname</tt> instead of just <tt>passwd</tt>. </text></doc> <method name='all'> <arguments><argument name='map'><type><string/></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><string/></valuetype></mapping></returntype> </method>

autodoc.git / traditional.xml