autodoc.git
/
modref.xml
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/modref.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
-
11
' version='Pike v8.0.5'>
<dir name='./ignored'> <file name='./ignored/ignored'> <chapter number='1' title='ignored'> <autodoc> <namespace name=''> <doc><text><p>Symbols implicitly inherited from the virtual base class.</p> <p> These symbols exist mainly to simplify implementation of the corresponding lfuns.</p> </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p> </text></group></doc>
autodoc.git/modref.xml:5018:
ANSI-C preprocessor but has a few extra features. These and the default set of preprocessor macros are described here.</p> </text></doc> <docgroup homogen-name='#!' homogen-type='directive'><doc><text><p>All lines beginning with <ref resolved='cpp::'>#!</ref> will be regarded as comments, to enable shell integration. It is recommended that Pike applications begin with the line <tt>"#! /usr/bin/env pike"</tt> for maximum cross platform compatibility.</p> </text></doc> <directive name='#!'/> </docgroup>
-
<docgroup homogen-name='#
""
' homogen-type='directive'><doc><text><p>If a string literal is opened with <tt>#"</tt> newlines in the
+
<docgroup homogen-name='#
""
' homogen-type='directive'><doc><text><p>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.</p> </text><group><note/><text><p>Newlines will be converted to <tt>\n</tt> characters in the string even if the newlines in the file are something else.</p> <p> This preprocessor directive may appear anywhere a string may appear.</p> </text></group><group><seealso/><text><p><ref resolved='cpp::'>#string</ref></p> </text></group></doc>
-
<directive name='#
""
'/>
+
<directive name='#
""
'/>
</docgroup> <docgroup homogen-type='directive'><doc><text><p>A hash character followed by a number or by the string <tt>"line"</tt> and a number will make the preprocessor line counter set this number as the line number for the next line and adjust the following lines accordingly.</p> <p> All error messages from Pike will use these line numbers.</p> <p> 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.</p>
autodoc.git/modref.xml:8473:
</text></group></dl><p>Unless something else is mentioned above, <ref resolved='predef::filter.fun'>fun</ref> is used as filter like this:</p> <dl><group><item name='function'/><text><p><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.</p> </text></group><group><item name='object'/><text><p>The object is used as a function like above, i.e. the <ref resolved='lfun::`()'>lfun::`()</ref> method in it is called.</p> </text></group><group><item name='multiset'/><item name='mapping'/><text><p><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.</p>
-
</text></group><group><item name='
"
zero or left out
"
'/><text><p>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><p>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.</p> </text></group><group><item name='string'/><text><p>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.</p> <p> 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/modref.xml:9277:
a multiset, in that order, which is then handled as described above.</p> </text></group></dl><p><ref resolved='predef::map.fun'>fun</ref> is applied in different ways depending on its type:</p> <dl><group><item name='function'/><text><p><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.</p> </text></group><group><item name='object'/><text><p><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.</p> </text></group><group><item name='multiset'/><item name='mapping'/><text><p><ref resolved='predef::map.fun'>fun</ref> is indexed with each element. The result of that is collected.</p>
-
</text></group><group><item name='
"
zero or left out
"
'/><text><p>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><p>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.</p> </text></group><group><item name='string'/><text><p>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.</p> <p> 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.</p> </text></group></dl> </text><group><note/><text><p>The function is never destructive on <ref resolved='predef::map.arr'>arr</ref>.</p>
autodoc.git/modref.xml:16734:
<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><p>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.</p> </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import>
autodoc.git/modref.xml:20513:
</docgroup> <docgroup homogen-name='get_default_module' homogen-type='method'><doc><text><p>Get the default module for the current compatibility level (ie typically the value returned by <ref resolved='predef::all_constants'>predef::all_constants()</ref>).</p> <p> The default implementation calls the corresponding function in the master object.</p> </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><p>Constant table to use.</p> </text></group><group><type><int><min>0</min><max>0</max></int></type><text><p>Use the builtin constant table.</p> </text></group></mixed> </text></group><group><note/><text><p>This function is typically called by <ref>Pike_compiler()->get_default_module()</ref>.</p>
-
</text></group><group><seealso/><text><p><ref resolved='predef::
MasterObject
.
CompatResolver.
get_default_module'>MasterObject()->get_default_module()</ref>.</p>
+
</text></group><group><seealso/><text><p><ref resolved='predef::
CompilationHandler
.get_default_module'>MasterObject()->get_default_module()</ref>.</p>
</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><p>Look up an inherit <ref resolved='predef::CompilerEnvironment.handle_inherit.inh'>inh</ref>.</p> <p> The default implementation calls the corresponding function in the master object.</p> </text><group><seealso/><text><p><ref resolved='predef::MasterObject.handle_inherit'>MasterObject()->handle_inherit()</ref>.</p>
autodoc.git/modref.xml:24951:
<ref resolved='predef::Fuse.Operations'>Operations</ref> class, clone it and pass it to the <ref resolved='predef::Fuse.run'>run</ref> method.</p> <p> You do not need to implemnent all functions, but at least getattr, readdir and read are needed to make a useable filesystem.</p> <p> 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.</p> </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><p>Start fuse. Args is as in argv in main(). This function will not return.</p> <p> 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/modref.xml:83756:
<docgroup homogen-name='crc32' homogen-type='method'><doc><text><p>This function calculates the standard ISO3309 Cyclic Redundancy Check.</p> </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><p>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.</p> </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/modref.xml:91839:
<expr>"error"</expr>.</p> </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><p>Document this function</p> </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/modref.xml:92070:
<dt><i>The variables in the expression:</i></dt> <dt>L</dt><dd><i>The active layer</i></dd> <dt>S</dt><dd><i>The source layer (the sum of the layers below)</i></dd> <dt>D</dt><dd><i>The destintion layer (the result)</i></dd> <dt>Xrgb</dt><dd><i>Layer red (<b>Xr</b>), green (<b>Xg</b>) or blue channel (<b>Xb</b>) </i></dd> <dt>Xhsv</dt><dd><i>Layer hue (<b>Xh</b>), saturation (<b>Xs</b>) or value channel (<b>Xv</b>) (virtual channels)</i></dd> <dt>Xhls</dt><dd><i>Layer hue (<b>Xh</b>), lightness channel (<b>Xl</b>) or saturation (<b>Xs</b>) (virtual channels)</i></dd> <dt>aX</dt><dd><i>Layer alpha, channel in layer alpha</i></dd> </dl> <i>All channels are calculated separately, if nothing else is specified.</i>
-
<table cellpadding='1' cellspacing='0'><tr><td align='left' colspan='2'><b>top layer</b></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'><b>bottom layer</b></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'><b>normal</b></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'><b>add</b></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'><b>subtract</b></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'><b>multiply</b></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'><b>divide</b></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'><b>negdivide</b></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'><b>modulo</b></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'><b>invsubtract</b></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'><b>invdivide</b></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'><b>invmodulo</b></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'><b>imultiply</b></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'><b>idivide</b></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'><b>invidivide</b></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'><b>difference</b></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'><b>max</b></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'><b>min</b></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'><b>bitwise_and</b></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'><b>bitwise_or</b></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'><b>bitwise_xor</b></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'><b>replace</b></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'><b>red</b></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'><b>green</b></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'><b>blue</b></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'><b>hardlight</b></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'><b>replace_hsv</b></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'><b>hue</b></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'><b>saturation</b></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'><b>value</b></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'><b>color</b></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'><b>value_mul</b></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'><b>darken</b></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'><b>lighten</b></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'><b>saturate</b></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'><b>desaturate</b></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'><b>hls_replace</b></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'><b>hls_hue</b></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'><b>hls_saturation</b></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'><b>hls_lightness</b></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'><b>hls_color</b></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'><b>hls_lightness_mul</b></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'><b>hls_darken</b></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'><b>hls_lighten</b></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'><b>hls_saturate</b></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'><b>hls_desaturate</b></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'><b>dissolve</b></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'><b>behind</b></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'><b>erase</b></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'><b>screen</b></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'><b>overlay</b></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'><b>burn_alpha</b></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'><b>equal</b></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'><b>not_equal</b></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'><b>less</b></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'><b>more</b></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'><b>less_or_equal</b></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'><b>more_or_equal</b></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'><b>logic_equal</b></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'><b>logic_not_equal</b></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'><b>logic_strict_less</b></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'><b>logic_strict_more</b></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'><b>logic_strict_less_equal</b></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'><b>logic_strict_more_equal</b></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'><b>top layer</b></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'><b>bottom layer</b></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'><b>normal</b></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'><b>add</b></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'><b>subtract</b></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'><b>multiply</b></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'><b>divide</b></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'><b>negdivide</b></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'><b>modulo</b></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'><b>invsubtract</b></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'><b>invdivide</b></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'><b>invmodulo</b></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'><b>imultiply</b></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'><b>idivide</b></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'><b>invidivide</b></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'><b>difference</b></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'><b>max</b></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'><b>min</b></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'><b>bitwise_and</b></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'><b>bitwise_or</b></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'><b>bitwise_xor</b></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'><b>replace</b></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'><b>red</b></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'><b>green</b></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'><b>blue</b></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'><b>hardlight</b></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'><b>replace_hsv</b></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'><b>hue</b></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'><b>saturation</b></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'><b>value</b></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'><b>color</b></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'><b>value_mul</b></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'><b>darken</b></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'><b>lighten</b></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'><b>saturate</b></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'><b>desaturate</b></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'><b>hls_replace</b></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'><b>hls_hue</b></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'><b>hls_saturation</b></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'><b>hls_lightness</b></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'><b>hls_color</b></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'><b>hls_lightness_mul</b></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'><b>hls_darken</b></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'><b>hls_lighten</b></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'><b>hls_saturate</b></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'><b>hls_desaturate</b></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'><b>dissolve</b></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'><b>behind</b></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'><b>erase</b></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'><b>screen</b></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'><b>overlay</b></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'><b>burn_alpha</b></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'><b>equal</b></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'><b>not_equal</b></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'><b>less</b></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'><b>more</b></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'><b>less_or_equal</b></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'><b>more_or_equal</b></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'><b>logic_equal</b></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'><b>logic_not_equal</b></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'><b>logic_strict_less</b></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'><b>logic_strict_more</b></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'><b>logic_strict_less_equal</b></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'><b>logic_strict_more_equal</b></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></p> <p> <ref resolved='predef::Image.Layer.available_modes'>available_modes</ref>() simply gives an array containing the names of these modes. </p> </text> <group><note/><text> <p>image and alpha channel must be of the same size, or canceled.</p> </text></group>
autodoc.git/modref.xml:93560:
</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> <p> Handle decoding of TIM images.</p> <p>TIM is the framebuffer format of the PSX game system. It is a simple, uncompressed, truecolor or CLUT format
autodoc.git/modref.xml:95460:
</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><p>Singleton 'package' object.</p> <p> Usage: object cls = Java.pkg.java.lang.String;</p> <p> or: object cls = Java.pkg["java/lang/String"];</p> <p> cls is a jclass object; call it to create a jobject, which will have all the methods of the Java class.</p> <p> Example: Java.pkg.FooClass()->getResult();</p> </text></doc> <variable name='pkg'><type><object resolved='predef::Java'/></type></variable> </docgroup> <class name='jclass'>
autodoc.git/modref.xml:96152:
<returntype><string/></returntype> </method> </docgroup> </class> <module name='cat'> <doc><text><p>Catalan language locale.</p> </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><p>Czech language locale by Jan Petrous 16.10.1997, based on Slovenian language module by Iztok Umek.</p> </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><p>German language locale by Tvns Böker.</p> </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><p>English language locale.</p> </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><p>Finnish language locale created by Janne Edelman, Turku Unix Users Group ry, Turku, Finland</p> </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><p>French language locale by Patrick Kremer.</p> </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><p>Croatian language locale by Klara Makovac 1997/07/02</p> </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><p>Hungarian language locale by Zsolt Varga.</p> </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><p>Italian language locale by Francesco Chemolli</p> </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><p>Japanese language locale.</p> </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><p>Maaori (New Zealand) language locale by Jason Rumney</p> </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><p>Dutch language locale by Stephen R. van den Berg</p> </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><p>Norwegian language locale</p> </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><p>Polish language locale by Piotr Klaban <makler@man.torun.pl>.</p> </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><p>Portuguese language locale</p> </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><p>Russian language locale</p> </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><p>Slovenian language locale by Iztok Umek 7. 8. 1997</p> </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><p>Spanish language locale</p> </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><p>Serbian language locale by Goran Opacic 1996/12/11</p> </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><p>Swedish language locale</p> </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/modref.xml:98310:
<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><p>Floating point infinity.</p> </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><p>The 10-logarithm of <ref resolved='predef::Math.log10.x'>x</ref>.</p> </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><p>The 2-logarithm of <ref resolved='predef::Math.log2.x'>x</ref>.</p> </text></doc>
autodoc.git/modref.xml:104996:
</text></doc> <docgroup homogen-type='constant'><constant name='NOTICE'/> <constant name='WARNING'/> <constant name='ERROR'/> </docgroup> </enum> </module> <module name='Pike'> <doc><text><p>This module parses and tokenizes Pike source code.</p> </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><p>Returns the provided string with Python code as an array with tokens.</p> </text></doc> <method name='split'>
autodoc.git/modref.xml:109226:
<constant name='limit_value'/> </docgroup> <docgroup homogen-name='pid' homogen-type='method'><doc><text><p>Returns the process identifier of the process.</p> </text></doc> <method name='pid'> <arguments/> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='set_priority' homogen-type='method'><doc><text><p>Sets the priority of the process. <ref resolved='predef::Process.create_process.set_priority.priority'>priority</ref> is one of the strings</p>
-
<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><p>Returns the status of the process:</p> <int><group><value>-1</value><text><p>Unknown</p> </text></group><group><value>0</value><text><p>Running</p> </text></group><group><value>1</value><text><p>Stopped</p> </text></group><group><value>2</value><text><p>Exited</p>
autodoc.git/modref.xml:111590:
<ref resolved='predef::Stdio.Port.bind'>Stdio.Port.bind</ref> for more information</p> </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><p>The port accept callback</p> </text></doc> <method name='new_connection'><modifiers><protected/></modifiers> <arguments/> <returntype><void/></returntype> </method>
autodoc.git/modref.xml:112067:
</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><p>Abstract class for a person.</p> </text></doc> <docgroup homogen-name='ip' homogen-type='variable'><doc><text><p>User domain, e.g. <expr>"mistel.idonex.se"</expr>.</p> </text></doc> <variable name='ip'><type><string/></type></variable> </docgroup> <docgroup homogen-name='last_action' homogen-type='variable'><doc><text><p>Time of last action, represented as posix time.</p>
autodoc.git/modref.xml:112486:
name is returned.</p> </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><p>Decodes all <expr>\xx</expr> escapes in <ref resolved='predef::Protocols.LDAP.ldap_decode_string.str'>str</ref>.</p> </text><group><seealso/><text><p><ref resolved='predef::Protocols.LDAP.ldap_encode_string'>ldap_encode_string</ref></p> </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><p>Quote characters in the given string as necessary for use as a
autodoc.git/modref.xml:112889:
</text><group><seealso/><text><p><ref resolved='predef::Protocols.LDAP.client.search'>search</ref></p> </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><p>Several information about code itself and about active connection too</p> </text></doc> <variable name='info'><type><mapping/></type></variable>
autodoc.git/modref.xml:113672:
<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><p>Description of the connected server.</p> </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><p>Data types as defined by the LysKOM protocol specification.</p>
autodoc.git/modref.xml:113864:
<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><p>Performs a login. Throws a lyskom error if unsuccessful.</p> </text><group><returns/><text><p>The session object logged in.</p> </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/modref.xml:115068:
</text></group><group><returns/><text><p>the function associated with oid, if any</p> </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><p>set the valid community strings for Get requests</p> </text><group><param name='communities'/><text><p>an array of valid Get communities</p> </text></group><group><note/><text><p>send an empty array to disable Get requests</p> </text></group></doc> <method name='set_get_communities'> <arguments><argument name='communities'><type><array/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup>
autodoc.git/modref.xml:117074:
<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/modref.xml:117884:
<docgroup homogen-name='`()' homogen-type='method'><doc><text><p>Convenience/compatibility method to get a <ref resolved='predef::Regexp.SimpleRegexp'>SimpleRegexp</ref> object.</p> </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><p>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...</p> </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><p>Calls <ref resolved='predef::Regexp.PCRE.Plain.replace'>Regexp.PCRE.Plain.replace</ref> in a temporary regexp object.
autodoc.git/modref.xml:117989:
"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).</p> </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><p>Convenience function that splits a subject string on the result from _pcre->exec()</p> <p> equal to map(previous_result/2, lambda(array v) { return subject[v[0]..v[1]-1]; })</p> </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/modref.xml:118688:
<docgroup homogen-name='get' homogen-type='method'><doc><text><p>Get a named object from the remote server.</p> </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><p>Provide a named <ref resolved='predef::Remote.Client.provide.thing'>thing</ref> to the <ref resolved='predef::Remote.Server'>Remote.Server</ref>.</p> </text><group><param name='name'/><text><p>Name to provide <ref resolved='predef::Remote.Client.provide.thing'>thing</ref> under.</p> </text></group><group><param name='thing'/><text><p>Thing to provide.</p> </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/modref.xml:118937:
</text></group><group><param name='max_call_threads'/><text><p>Maximum number of concurrent threads.</p> </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><p>Port for the <ref resolved='predef::Remote.Server'>Remote.Server</ref>.</p> </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><p>Provide a named <ref resolved='predef::Remote.Server.provide.thing'>thing</ref> to the <ref resolved='predef::Remote.Client'>Remote.Client</ref>(s).</p> </text><group><param name='name'/><text><p>Name to provide <ref resolved='predef::Remote.Server.provide.thing'>thing</ref> under.</p> </text></group><group><param name='thing'/><text><p>Thing to provide.</p> </text></group></doc> <method name='provide'>
autodoc.git/modref.xml:121105:
send_packet() function to transmit packets.</p> </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><p>Renegotiate the connection (client initiated).</p> <p> Sends a <ref resolved='predef::SSL.ClientConnection.client_hello'>client_hello</ref> to force a new round of handshaking.</p> </text></doc>
autodoc.git/modref.xml:121903:
</docgroup> <docgroup homogen-name='heartbleed_probe' homogen-type='variable'><doc><text><p>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.</p> </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><p>Temporary, non-certified, private keys, used for RSA key exchange in export mode. They are used as follows:</p> <p> <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.</p> <p> <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.</p>
autodoc.git/modref.xml:122769:
send_packet() function to transmit packets.</p> </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><p>Renegotiate the connection (server initiated).</p> <p> Sends a <ref>hello_request</ref> to force a new round of handshaking.</p> </text></doc>
autodoc.git/modref.xml:122879:
</text></doc> <variable name='heartbeat_mode'><type><object>HeartBeatModeType</object></type></variable> </docgroup> <docgroup homogen-name='identity' homogen-type='variable'><doc><text><p>Identifies the session to the server</p> </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><p>Used to filter certificates not supported by the peer.</p> </text><group><param name='cp'/><text><p>Candidate <ref resolved='predef::SSL.Constants.CertificatePair'>CertificatePair</ref>.</p> </text></group><group><param name='version'/><text><p>Negotiated version of SSL.</p> </text></group><group><param name='ecc_curves'/><text><p>The set of ecc_curves supported by the peer.</p> </text></group></doc> <method name='is_supported_cert'><modifiers><protected/></modifiers>
autodoc.git/modref.xml:123046:
<docgroup homogen-name='encrypt_packet' homogen-type='method'><doc><text><p>Encrypts a packet (including deflating and MAC-generation).</p> </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><p>Message Authentication Code</p> </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><p>TLS 1.2 IV salt. This is used as a prefix for the IV for the AEAD cipher algorithms.</p>
autodoc.git/modref.xml:123618:
<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/modref.xml:132171:
<arguments/> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='open' homogen-type='method'><doc><text><p>Open a file, or use an existing fd.</p> <p> 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.</p> <p> <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:</p>
-
<dl><group><item name='
"
r
"
'/><text><p>Open for reading.</p>
-
</text></group><group><item name='
"
w
"
'/><text><p>Open for writing.</p>
-
</text></group><group><item name='
"
a
"
'/><text><p>Append new data to the end.</p>
-
</text></group><group><item name='
"
c
"
'/><text><p>Create the file if it doesn't exist already.</p>
-
</text></group><group><item name='
"
t
"
'/><text><p>Truncate the file to zero length if it already contains data.
+
<dl><group><item name='
"
r
"
'/><text><p>Open for reading.</p>
+
</text></group><group><item name='
"
w
"
'/><text><p>Open for writing.</p>
+
</text></group><group><item name='
"
a
"
'/><text><p>Append new data to the end.</p>
+
</text></group><group><item name='
"
c
"
'/><text><p>Create the file if it doesn't exist already.</p>
+
</text></group><group><item name='
"
t
"
'/><text><p>Truncate the file to zero length if it already contains data.
Use only together with <expr>"w"</expr>.</p>
-
</text></group><group><item name='
"
x
"
'/><text><p>Open exclusively - the open fails if the file already exists.
+
</text></group><group><item name='
"
x
"
'/><text><p>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.</p> </text></group></dl><p><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:</p> <dl><group><item name='0400'/><text><p>User has read permission.</p> </text></group><group><item name='0200'/><text><p>User has write permission.</p> </text></group><group><item name='0100'/><text><p>User has execute permission.</p> </text></group><group><item name='0040'/><text><p>Group has read permission.</p> </text></group><group><item name='0020'/><text><p>Group has write permission.</p> </text></group><group><item name='0010'/><text><p>Group has execute permission.</p>
autodoc.git/modref.xml:138941:
classes, modules, methods, variables ... The classes can produce XML representations of themselves.</p> </text></doc> <docgroup homogen-name='EmptyDoc' homogen-type='variable'><doc><text><p>The empty <ref resolved='predef::Tools.AutoDoc.PikeObjects.Documentation'>Documentation</ref>.</p> </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><p>The class for representing array types.</p> </text><group><seealso/><text><p><ref resolved='predef::Tools.AutoDoc.PikeObjects.Type'>Type</ref></p> </text></group></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'>
autodoc.git/modref.xml:139902:
</text><group><param name='root'/><text><p>The root (<tt><autodoc></tt>) node of the documentation tree.</p> </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><p>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.</p> <p> Used to merge the results of extractions of different Pike and C files.</p> <p> Some minor effort is expended to normalize the result to some sort of canonical order.</p> </text><group><param name='source'/><param name='dest'/><text><p>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/modref.xml:140484:
</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><p>Write the image to a file. If no format is specified, PNG is used. The alpha combination is done on the image before it's saved.</p> </text></doc> <method name='save'> <arguments><argument name='filename'><type><string/></type></argument><argument name='format'><type><or><string/><void/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='scale' homogen-type='method'><doc><text><p>Scale the image before display with the specified factor.</p>
autodoc.git/modref.xml:140547:
<docgroup homogen-name='Solid' homogen-type='constant'><doc><text><p>Solid color.</p> </text></doc> <constant name='Solid'/> </docgroup> <docgroup homogen-name='Squares' homogen-type='constant'><doc><text><p>Checkerboard pattern (default).</p> </text></doc> <constant name='Squares'/> </docgroup> </enum> </class>
+
<module name='Sass'>
+
<docgroup homogen-type='constant'><doc><text><p>Description:</p>
+
<string><group><value>HTTP_IMPORT_NONE</value><text><p>Default value of <ref>Compiler.http_import</ref>. Prohibits imports over HTTP.</p>
+
</text></group><group><value>HTTP_IMPORT_GREEDY</value><text><p>Allow imports over HTTP only if the returned content type is
+
<tt>text/scss</tt>.</p>
+
</text></group><group><value>HTTP_IMPORT_ANY</value><text><p>Anything goes.</p>
+
</text></group></string></text></doc>
+
<constant name='HTTP_IMPORT_NONE'><type><int/></type></constant>
+
<constant name='HTTP_IMPORT_GREEDY'><type><int/></type></constant>
+
<constant name='HTTP_IMPORT_ANY'><type><int/></type></constant>
+
</docgroup>
+
<docgroup homogen-name='LIBSASS_VERSION' homogen-type='constant'><doc><text><p>The <tt>libsass</tt> version, as a string, this module was compiled agains.</p>
+
</text></doc>
+
<constant name='LIBSASS_VERSION'><type><string/></type></constant>
+
</docgroup>
+
<docgroup homogen-type='constant'><doc><text><p>Styling of output. Use as argument to <ref>Compiler.set_output_style()</ref></p>
+
<string><group><value>STYLE_NESTED</value><text><p>The default setting. The output will look like:</p>
+
<code><text><p>a {
+
property: value;
+
other-property: value; }
+
a:hover {
+
property: value; }
+
b {
+
property: value; }</p>
+
</text></code>
+
</text></group><group><value>STYLE_EXPANDED</value><text><p>Fully expanded output:</p>
+
<code><text><p>a {
+
property: value;
+
other-property: value;
+
}
+
a:hover {
+
property: value;
+
}
+
b {
+
property: value;
+
}</p>
+
</text></code>
+
</text></group><group><value>STYLE_COMPACT</value><text><p>Somewhat minified output:</p>
+
<code><text><p>a { property: value; other-prop: value }
+
a:hover { property: value; }
+
b { property: value; }</p>
+
</text></code>
+
</text></group><group><value>STYLE_COMPRESSED</value><text><p>Minified output</p>
+
<code><text><p>a{property:value;other-property:value}a:hover{property:value}b{property:value}</p>
+
</text></code></text></group></string></text></doc>
+
<constant name='STYLE_NESTED'><type><int/></type></constant>
+
<constant name='STYLE_EXPANDED'><type><int/></type></constant>
+
<constant name='STYLE_COMPACT'><type><int/></type></constant>
+
<constant name='STYLE_COMPRESSED'><type><int/></type></constant>
+
</docgroup>
+
<docgroup homogen-name='libsass_language_version' homogen-type='method'><doc><text><p>Returns the <tt>language</tt> version of Sass this module was compiled against</p>
+
</text></doc>
+
<method name='libsass_language_version'>
+
<arguments/>
+
<returntype><string/></returntype>
+
</method>
+
</docgroup>
+
<docgroup homogen-name='libsass_version' homogen-type='method'><doc><text><p>Returns the <tt>libsass</tt> version this module was compiled against</p>
+
</text></doc>
+
<method name='libsass_version'>
+
<arguments/>
+
<returntype><string/></returntype>
+
</method>
+
</docgroup>
+
<docgroup homogen-name='sass2scss_version' homogen-type='method'><doc><text><p>Returns the <tt>sass2scss</tt> version this module was compiled against</p>
+
</text></doc>
+
<method name='sass2scss_version'>
+
<arguments/>
+
<returntype><string/></returntype>
+
</method>
+
</docgroup>
+
<class name='Compiler'>
+
<docgroup homogen-name='compile_string' homogen-type='method'><doc><text><p>Compiles the string <ref resolved='predef::Tools.Sass.Compiler.compile_string.source'>source</ref> and returns the generated CSS.</p>
+
</text><group><note/><text><p>If the <ref resolved='predef::Tools.Sass.Compiler.compile_string.source'>source</ref> contain <tt>@import</tt> directives you have to
+
explicitly set the include path via <ref resolved='predef::Tools.Sass.Compiler.include_path'>include_path</ref>.</p>
+
</text></group><group><param name='source'/><text><p>The string to compile</p>
+
</text></group></doc>
+
<method name='compile_string'>
+
<arguments><argument name='source'><type><string><min>0</min><max>255</max></string></type></argument></arguments>
+
<returntype><string><min>0</min><max>255</max></string></returntype>
+
</method>
+
</docgroup>
+
<docgroup homogen-name='include_path' homogen-type='variable'><doc><text><p>The base path of <tt>@import</tt>s. Note! This needs to be set when
+
<ref resolved='predef::Tools.Sass.Compiler.compile_string'>compile_string()</ref> is used.</p>
+
</text></doc>
+
<variable name='include_path'><type><string><min>0</min><max>255</max></string></type></variable>
+
</docgroup>
+
<docgroup homogen-name='omit_source_map_url' homogen-type='variable'><doc><text><p>Set whether writing the <tt>sourceMappingUrl=#</tt> or not.</p>
+
</text></doc>
+
<variable name='omit_source_map_url'><type><object>bool</object></type></variable>
+
</docgroup>
+
<docgroup homogen-name='output_style' homogen-type='variable'><doc><text><p>Determines the level of compression on the generated output.</p>
+
</text><group><seealso/><text><p><ref resolved='predef::Tools.Sass.STYLE_NESTED'>STYLE_NESTED</ref>, <ref resolved='predef::Tools.Sass.STYLE_EXPANDED'>STYLE_EXPANDED</ref>, <ref resolved='predef::Tools.Sass.STYLE_COMPACT'>STYLE_COMPACT</ref> and
+
<ref resolved='predef::Tools.Sass.STYLE_COMPRESSED'>STYLE_COMPRESSED</ref>.</p>
+
</text></group></doc>
+
<variable name='output_style'><type><int><min>0</min><max>3</max></int></type></variable>
+
</docgroup>
+
<docgroup homogen-name='precision' homogen-type='variable'><doc><text><p>Set the precision of fractional numbers. Default is <tt>5</tt>.</p>
+
</text></doc>
+
<variable name='precision'><type><int/></type></variable>
+
</docgroup>
+
<docgroup homogen-name='source_comments' homogen-type='variable'><doc><text><p>Emit comments in the generated CSS indicating the corresponding source
+
line. Default is <tt>false</tt>.</p>
+
</text></doc>
+
<variable name='source_comments'><type><object>bool</object></type></variable>
+
</docgroup>
+
<docgroup homogen-name='source_map_embed' homogen-type='variable'><doc><text><p>Set whether embedding <tt>sourceMappingUrl=#</tt> as data uri or not.</p>
+
</text></doc>
+
<variable name='source_map_embed'><type><object>bool</object></type></variable>
+
</docgroup>
+
<docgroup homogen-name='source_map_file' homogen-type='variable'><doc><text><p>Set the path of the source map file.</p>
+
</text></doc>
+
<variable name='source_map_file'><type><string><min>0</min><max>255</max></string></type></variable>
+
</docgroup>
+
<docgroup homogen-name='source_map_root' homogen-type='variable'><doc><text><p>Set the root path of the source files, relative to where the source.map
+
file is written.</p>
+
</text></doc>
+
<variable name='source_map_root'><type><string><min>0</min><max>255</max></string></type></variable>
+
</docgroup>
+
</class>
+
</module>
<module name='Shoot'> <class name='Test'> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='name' homogen-type='constant'><doc><text><p>The name of the test.</p> </text></doc> <constant name='name'><type><string/></type></constant> </docgroup> <docgroup homogen-name='perform' homogen-type='method'><doc><text><p>perform() is the function called in the tests,
autodoc.git/modref.xml:142671:
<docgroup homogen-name='default_domain' homogen-type='method'><doc><text><p>Returns the default yp-domain.</p> </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><p>Returns the whole map as a mapping.</p> <p> <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>.</p> </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/modref.xml:143050:
</module>
+
<module name='_Sass'>
+
<doc><text><p>Sass is a scripting language that is interpreted into Cascading Style
+
Sheets (CSS). This module is a glue for <tt>libsass</tt>.</p>
+
</text><group><seealso/><text><p>SASS <url>http://sass-lang.com/</url></p>
+
</text></group></doc>
+
<docgroup homogen-name='' homogen-type='import'>
+
<import name=''><classname resolved='predef::'>predef::</classname></import>
+
</docgroup>
+
<docgroup homogen-name='s8' homogen-type='typedef'><doc><text><p>Shorthand for <tt>string(8bit)</tt></p>
+
</text></doc>
+
<typedef name='s8'><type><string><min>0</min><max>255</max></string></type></typedef>
+
</docgroup>
+
<class name='Compiler'>
+
<doc><text><p>Sass/SCSS compiler.</p>
+
</text><group><example/><text><code><text><p>Tools.Sass.Compiler compiler = Tools.Sass.Compiler();</p>
+
<p> // Allow for HTTP imports, disallowed by default.
+
compiler->http_import = Tools.Sass.HTTP_IMPORT_ANY;</p>
+
<p> // Minify the output and create a source map file.
+
compiler->set_options(([
+
"output_style" : Tools.Sass.STYLE_COMPRESSED,
+
"source_map_file" : "path/to/write/source.map"
+
]));</p>
+
<p> if (mixed e = catch(compiler->compile_file("input.scss", "output.css"))) {
+
werror("Failed compiling input.scss to output.css\n");
+
}</p>
+
</text></code>
+
</text></group></doc>
+
<docgroup homogen-name='check_file_access' homogen-type='variable'><doc><text><p>Should file access be tested right away when paths are set or should that
+
be left to Sass to handle? The default value is <tt>true</tt>.</p>
+
</text></doc>
+
<variable name='check_file_access'><modifiers><public/></modifiers><type><object>bool</object></type></variable>
+
</docgroup>
+
<docgroup homogen-name='compile_file' homogen-type='method'><doc><text><p>Compile the file <ref resolved='predef::_Sass.Compiler.compile_file.input_file'>input_file</ref> and return the result</p>
+
</text><group><param name='input_file'/><text><p>The SCSS file to compile</p>
+
</text></group><group><returns/><text><p>A mapping with the generated CSS and source mapping file if such is
+
set to be generated</p>
+
<mapping><group><member><type><string><min>0</min><max>255</max></string></type><index>"css"</index></member><text><p>The generated CSS</p>
+
</text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"map"</index></member><text><p>The generated source mapping data</p>
+
</text></group></mapping>
+
</text></group></doc>
+
<method name='compile_file'>
+
<arguments><argument name='input_file'><type><object resolved='predef::_Sass.s8'>s8</object></type></argument></arguments>
+
<returntype><mapping><indextype><object resolved='predef::_Sass.s8'>s8</object></indextype><valuetype><object resolved='predef::_Sass.s8'>s8</object></valuetype></mapping></returntype>
+
</method>
+
</docgroup>
+
<docgroup homogen-name='compile_file' homogen-type='method'><doc><text><p>Compile the file <ref resolved='predef::_Sass.Compiler.compile_file.input_file'>input_file</ref> and write the result to <ref resolved='predef::_Sass.Compiler.compile_file.output_file'>output_file</ref>.
+
If a source mapping file is set to be generated either via
+
<ref resolved='predef::_Sass.Compiler.set_options'>set_options()</ref> or <ref>source_map_file</ref> it will be written as per
+
the value set in the option.</p>
+
</text><group><param name='input_file'/><text><p>The SCSS file to compile</p>
+
</text></group><group><param name='output_file'/><text><p>The name of the CSS file to save the result in.</p>
+
</text></group></doc>
+
<method name='compile_file'><modifiers><variant/></modifiers>
+
<arguments><argument name='input_file'><type><object resolved='predef::_Sass.s8'>s8</object></type></argument><argument name='output_file'><type><object resolved='predef::_Sass.s8'>s8</object></type></argument></arguments>
+
<returntype><void/></returntype>
+
</method>
+
</docgroup>
+
<docgroup homogen-name='handle_sass_import' homogen-type='method'><doc><text><p>Resolve imports in sass/scss files.</p>
+
</text><group><note/><text><p>In general this method doesn't need to overloaded. In principle it's
+
only necessary if the Sass files reside in a non-standard filesystem.</p>
+
</text></group><group><note/><text><p>If overloaded <ref>abs_path</ref> and <ref>rel_path</ref> is the absolute and relaive
+
paths of the file containing the import statement <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref>.
+
If the Sass/SCSS files are located in a normal filesystem this method
+
can return the contents of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref> as a string and <tt>libsass</tt> will
+
resolve the paths to the imports by itself.</p>
+
<p> However, if the files are not located in a normal filesystem this
+
function should return an array of two indices, where the first index
+
should be the contents of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref> and the second the calculated absolute
+
path of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref>.</p>
+
</text></group><group><param name='path'/><text><p>This is the value of `path` in <tt>@import 'path'</tt>.</p>
+
</text></group><group><param name='absolute_path'/><text><p>This is the absolute path of the file containing the <tt>@import</tt>
+
statement.</p>
+
</text></group><group><param name='relative_path'/><text><p>The relative path of <ref resolved='predef::_Sass.Compiler.handle_sass_import.absolute_path'>absolute_path</ref> in relation to the prevoius
+
<ref resolved='predef::_Sass.Compiler.handle_sass_import.absolute_path'>absolute_path</ref></p>
+
</text></group><group><returns/><text><mixed><group><type><int><min>0</min><max>0</max></int></type><text><p>If undefined is returned the import resolution is given back to
+
<tt>libsass</tt>.</p>
+
</text></group><group><type><string><min>0</min><max>255</max></string></type><text><p>The contents of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref></p>
+
</text></group><group><type><array><valuetype><string><min>0</min><max>255</max></string></valuetype></array></type><text><p>if an array is returned it should contain two indices, where the first
+
if the contents of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref> and the second should be the absolute path
+
<ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref>. This is only useful (needed) if the Sass files doesn't
+
reside in a normal filesystem that <tt>libsass</tt> can read.</p>
+
</text></group></mixed>
+
</text></group></doc>
+
<method name='handle_sass_import'><modifiers><protected/></modifiers>
+
<arguments><argument name='path'><type><string><min>0</min><max>255</max></string></type></argument><argument name='absolute_path'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument><argument name='relative_path'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument></arguments>
+
<returntype><or><string/><array><valuetype><string><min>0</min><max>255</max></string></valuetype></array></or></returntype>
+
</method>
+
</docgroup>
+
<docgroup homogen-name='http_import' homogen-type='variable'><doc><text><p>If a Sass file is importing an external URI this flag determines if
+
thats allowed at all, or if the content type of the imported file has
+
to be in <ref resolved='predef::_Sass.Compiler.http_import_allow_ct'>http_import_allow_ct</ref>, or if anything goes.
+
Default is <ref>HTTP_IMPORT_NONE</ref>.</p>
+
</text><group><seealso/><text><p><ref>HTTP_IMPORT_NONE</ref>, <ref>HTTP_IMPORT_GREEDY</ref> and
+
<ref>HTTP_IMPORT_ANY</ref>.</p>
+
</text></group></doc>
+
<variable name='http_import'><modifiers><public/></modifiers><type><int><min>0</min><max>2</max></int></type></variable>
+
</docgroup>
+
<docgroup homogen-name='http_import_allow_ct' homogen-type='variable'><doc><text><p>List of allowed content types if <ref resolved='predef::_Sass.Compiler.http_import'>http_import</ref> is set to
+
<ref>HTTP_IMPORT_GREEDY</ref>. The default is to allow <tt>text/scss</tt> and
+
<tt>text/sass</tt>.</p>
+
</text></doc>
+
<variable name='http_import_allow_ct'><modifiers><public/></modifiers><type><multiset><indextype><object resolved='predef::_Sass.s8'>s8</object></indextype></multiset></type></variable>
+
</docgroup>
+
<docgroup homogen-name='set_options' homogen-type='method'><doc><text><p>Set options to the SASS compiler.</p>
+
</text><group><param name='opts'/><text><mapping><group><member><type><int/></type><index>"output_style"</index></member><text><p>Any of the <ref>STYLE_NESTED</ref>, <ref>STYLE_EXPANDED</ref>, <ref>STYLE_COMPACT</ref>
+
or <ref>STYLE_COMPRESSED</ref> constants. See also <ref>output_style</ref>.</p>
+
</text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"include_path"</index></member><text><p>Path to root of incude files. See also <ref>include_path</ref>.</p>
+
</text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"source_map_file"</index></member><text><p>File to write source map file to.
+
See also <ref>source_map_file</ref>.</p>
+
</text></group><group><member><type><object>bool</object></type><index>"source_comments"</index></member><text><p>Turn on/off comments in the output containing info about the source
+
file - line numbers and such. Default of <tt>false</tt>. See also
+
<ref>source_comments</ref>.</p>
+
</text></group><group><member><type><object>bool</object></type><index>"source_map_embed"</index></member><text><p>Turn on/off if a source map should be embedded in the output or not.
+
Default is <tt>false</tt>. See also <ref>source_map_embed</ref>.</p>
+
</text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"source_map_root"</index></member><text><p>Set the root path of the source files, relative to where the
+
source.map file is written.
+
See also <ref>source_map_root</ref></p>
+
</text></group><group><member><type><object>bool</object></type><index>"omit_source_map_url"</index></member><text><p>Omit the #sourceMappingURL or not.
+
See also <ref>omit_source_map_url</ref></p>
+
</text></group><group><member><type><int/></type><index>"precision"</index></member><text><p>Floating point precision. See also <ref>precision</ref>.</p>
+
</text></group></mapping>
+
</text></group></doc>
+
<method name='set_options'>
+
<arguments><argument name='opts'><type><mapping><indextype><object resolved='predef::_Sass.s8'>s8</object></indextype><valuetype><or><object resolved='predef::_Sass.s8'>s8</object><int/></or></valuetype></mapping></type></argument></arguments>
+
<returntype><void/></returntype>
+
</method>
+
</docgroup>
+
</class>
+
</module>
<module name='__builtin'> <module name='Nettle'> <class name='AEAD'> <doc><text><p>Base class for AEAD (Authenticated Encryption with Associated Data) algorithms.</p> <p> AEAD algorithms behave like a combination of a <ref resolved='predef::__builtin.Nettle.Cipher'>Cipher</ref> and a HMAC.</p> <p> Note that no actual AEAD algorithm is implemented in the base class. They are implemented in classes that inherit this class.</p>