autodoc.git / traditional.xml

version» Context lines:

autodoc.git/traditional.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2019-06-21' version='Pike v8.1.13'> + <manual time-stamp='2019-06-22' version='Pike v8.1.13'>    <dir name='./traditional_manual'>    <file name='./traditional_manual/index.html'>    <chapter title='Table of Contents' unnumbered='1'>    <dl><dt><url href='index.html'>Table of Contents</url></dt>   <dt><url href='chapter_1.html'>1. Introduction</url></dt>   <dd><url href='chapter_1.html#1'>1.1. Overview</url></dd>   <dd><url href='chapter_1.html#2'>1.2. The history of Pike</url></dd>   <dd><url href='chapter_1.html#3'>1.3. A comparison with other languages</url></dd>   <dd><url href='chapter_1.html#4'>1.4. What is Pike</url></dd>   <dd><url href='chapter_1.html#5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:99536:   </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()-&gt;get_default_module()</ref>.</p> - </text></group><group><seealso/><text><p><ref resolved='predef::MasterObject.CompatResolver.get_default_module'>MasterObject()-&gt;get_default_module()</ref>.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::CompilationHandler.get_default_module'>MasterObject()-&gt;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_import' homogen-type='method'><doc><text><p>Look up an import <ref resolved='predef::CompilerEnvironment.handle_import.module'>module</ref>.</p>   <p> The default implementation calls the corresponding function    in the master object.</p>   </text><group><seealso/><text><p><ref resolved='predef::CompilationHandler.handle_import'>MasterObject()-&gt;handle_import()</ref>.</p>
autodoc.git/traditional.xml:142475:   <docgroup homogen-name='get_methods' homogen-type='method'><doc><group><returns/><text><p>A structure describing all available methods on the current wsdl.</p>   </text></group></doc>   <method name='get_methods'><modifiers><final/></modifiers>   <arguments/>   <returntype><object>Arguments</object></returntype>   </method>   </docgroup>   </class>   </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-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> + <string><group><value>HTTP_IMPORT_NONE</value><text><p>Default value of <ref resolved='predef::Web.Sass.Compiler.http_import'>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>
autodoc.git/traditional.xml:142524:    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='' homogen-type='import'> + <import name=''><classname resolved='predef::'>predef::</classname></import> + </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='s8' homogen-type='typedef'><doc><text><p>Shorthand for <tt>string(8bit)</tt></p> + </text></doc> + <typedef name='s8'><modifiers><protected/></modifiers><type><string><min>0</min><max>255</max></string></type></typedef> + </docgroup>   <docgroup homogen-name='sass2scss' homogen-type='method'><doc><text><p>Convert Sass syntax (i.e. indented syntax) to SCSS syntax.</p>   </text><group><param name='data'/><text><p>Sass syntax text to convert to SCSS syntax.</p>   </text></group><group><param name='options'/><text><p>This is a bitwise union of compression level (<ref resolved='predef::Web.Sass.STYLE_NESTED'>STYLE_NESTED</ref>,    <ref resolved='predef::Web.Sass.STYLE_EXPANDED'>STYLE_EXPANDED</ref>, <ref resolved='predef::Web.Sass.STYLE_COMPACT'>STYLE_COMPACT</ref> and $[STYLE_COMPRESSED]) and the    <tt>SASS2SCSS_*</tt> constants <ref>SASS2SCSS_KEEP_COMMENT</ref>,    <ref>SASS2SCSS_STRIP_COMMENT</ref> and <ref>SASS2SCSS_CONVERT_COMMENT</ref>.    It defaults to <expr>STYLE_NESTED|SASS2SCSS_KEEP_COMMENT</expr>.</p>   </text></group><group><returns/><text><p><ref resolved='predef::Web.Sass.sass2scss.data'>data</ref> converted to SCSS syntax.</p>   </text></group></doc>   <method name='sass2scss'>
autodoc.git/traditional.xml:142565:   </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='Api'>   <doc><text><p>Low-level Sass/SCSS compiler.</p> - <p> You probably want to use <ref>Compiler</ref> instead of this class.</p> - </text><group><seealso/><text><p><ref>Compiler</ref></p> + <p> You probably want to use <ref resolved='predef::Web.Sass.Compiler'>Compiler</ref> instead of this class.</p> + </text><group><seealso/><text><p><ref resolved='predef::Web.Sass.Compiler'>Compiler</ref></p>   </text></group></doc>   <docgroup homogen-name='compile_string' homogen-type='method'><doc><text><p>Compiles the string <ref resolved='predef::Web.Sass.Api.compile_string.source'>source</ref> and returns the generated CSS.</p>   </text><group><param name='source'/><text><p>The string 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><group><note/><text><p>If the <ref resolved='predef::Web.Sass.Api.compile_string.source'>source</ref> contain <tt>@import</tt> directives you have to    explicitly set the include path via <ref resolved='predef::Web.Sass.Api.include_path'>include_path</ref>.</p>
autodoc.git/traditional.xml:142626:   <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> + <class name='Compiler'> + <doc><text><p>Sass/SCSS compiler.</p> + </text><group><example/><text><code><text><p>Web.Sass.Compiler compiler = Web.Sass.Compiler();</p> + <p> // Allow for HTTP imports, disallowed by default. +  compiler-&gt;http_import = Web.Sass.HTTP_IMPORT_ANY;</p> + <p> // Minify the output and create a source map file. +  compiler-&gt;set_options(([ +  "output_style" : Web.Sass.STYLE_COMPRESSED, +  "source_map_file" : "path/to/write/source.map" +  ]));</p> + <p> if (mixed e = catch(compiler-&gt;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 resolved='predef::bool'>bool</object></type></variable> + </docgroup> + <docgroup homogen-name='compile_file' homogen-type='method'><doc><text><p>Compile the file <ref resolved='predef::Web.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::Web.Sass.s8'>s8</object></type></argument></arguments> + <returntype><mapping><indextype><object resolved='predef::Web.Sass.s8'>s8</object></indextype><valuetype><object resolved='predef::Web.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::Web.Sass.Compiler.compile_file.input_file'>input_file</ref> and write the result to <ref resolved='predef::Web.Sass.Compiler.compile_file.output_file'>output_file</ref>. +  If a source mapping file is set to be generated either via +  <ref resolved='predef::Web.Sass.Compiler.set_options'>set_options()</ref> or <ref resolved='predef::Web.Sass.Api.source_map_file'>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::Web.Sass.s8'>s8</object></type></argument><argument name='output_file'><type><object resolved='predef::Web.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::Web.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::Web.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::Web.Sass.Compiler.handle_sass_import.path'>path</ref> and the second the calculated absolute +  path of <ref resolved='predef::Web.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::Web.Sass.Compiler.handle_sass_import.absolute_path'>absolute_path</ref> in relation to the prevoius +  <ref resolved='predef::Web.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::Web.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::Web.Sass.Compiler.handle_sass_import.path'>path</ref> and the second should be the absolute path +  <ref resolved='predef::Web.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::Web.Sass.Compiler.http_import_allow_ct'>http_import_allow_ct</ref>, or if anything goes. +  Default is <ref resolved='predef::Web.Sass.HTTP_IMPORT_NONE'>HTTP_IMPORT_NONE</ref>.</p> + </text><group><seealso/><text><p><ref resolved='predef::Web.Sass.HTTP_IMPORT_NONE'>HTTP_IMPORT_NONE</ref>, <ref resolved='predef::Web.Sass.HTTP_IMPORT_GREEDY'>HTTP_IMPORT_GREEDY</ref> and +  <ref resolved='predef::Web.Sass.HTTP_IMPORT_ANY'>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::Web.Sass.Compiler.http_import'>http_import</ref> is set to +  <ref resolved='predef::Web.Sass.HTTP_IMPORT_GREEDY'>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::Web.Sass.s8'>s8</object></indextype></multiset></type></variable> + </docgroup> + <docgroup homogen-name='Api' homogen-type='inherit'> + <inherit name='Api'><classname resolved='predef::Web.Sass.Api'>Api</classname></inherit> + </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 resolved='predef::Web.Sass.STYLE_NESTED'>STYLE_NESTED</ref>, <ref resolved='predef::Web.Sass.STYLE_EXPANDED'>STYLE_EXPANDED</ref>, <ref resolved='predef::Web.Sass.STYLE_COMPACT'>STYLE_COMPACT</ref> +  or <ref resolved='predef::Web.Sass.STYLE_COMPRESSED'>STYLE_COMPRESSED</ref> constants. See also <ref resolved='predef::Web.Sass.Api.output_style'>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 resolved='predef::Web.Sass.Api.include_path'>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 resolved='predef::Web.Sass.Api.source_map_file'>source_map_file</ref>.</p> + </text></group><group><member><type><object resolved='predef::bool'>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 resolved='predef::Web.Sass.Api.source_comments'>source_comments</ref>.</p> + </text></group><group><member><type><object resolved='predef::bool'>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 resolved='predef::Web.Sass.Api.source_map_embed'>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 resolved='predef::Web.Sass.Api.source_map_root'>source_map_root</ref></p> + </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"omit_source_map_url"</index></member><text><p>Omit the #sourceMappingURL or not. +  See also <ref resolved='predef::Web.Sass.Api.omit_source_map_url'>omit_source_map_url</ref></p> + </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"sass_syntax"</index></member><text><p>Turn on/off Sass syntax, i.e. indented syntax. Only necessary when +  using <ref resolved='predef::Web.Sass.Api.compile_string'>compile_string()</ref></p> + </text></group><group><member><type><int/></type><index>"precision"</index></member><text><p>Floating point precision. See also <ref resolved='predef::Web.Sass.Api.precision'>precision</ref>.</p> + </text></group></mapping> + </text></group></doc> + <method name='set_options'> + <arguments><argument name='opts'><type><mapping><indextype><object resolved='predef::Web.Sass.s8'>s8</object></indextype><valuetype><or><object resolved='predef::Web.Sass.s8'>s8</object><int/></or></valuetype></mapping></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + </class>   </module>   <module name='SocketIO'>   <doc><text><p>This is an implementation of the Socket.IO server-side communication's    driver. It basically is a real-time bidirectional object-oriented    communication's protocol for communicating between a webbrowser    and a server.</p>   <p> This module supports the following features:</p>   <ul><group><item/><text><p>Passing any arbitrarily deep nested data object    which can be represented in basic JavaScript datatypes.</p>   </text></group><group><item/><text><p>In addition to the normal JavaScript datatypes, it also
autodoc.git/traditional.xml:143238:   </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'><modifiers><protected/></modifiers><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>Web.Sass.Compiler compiler = Web.Sass.Compiler();</p> - <p> // Allow for HTTP imports, disallowed by default. -  compiler-&gt;http_import = Web.Sass.HTTP_IMPORT_ANY;</p> - <p> // Minify the output and create a source map file. -  compiler-&gt;set_options(([ -  "output_style" : Web.Sass.STYLE_COMPRESSED, -  "source_map_file" : "path/to/write/source.map" -  ]));</p> - <p> if (mixed e = catch(compiler-&gt;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 resolved='predef::bool'>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='Api' homogen-type='inherit'> - <inherit name='Api'><classname>Api</classname></inherit> - </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 resolved='predef::bool'>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 resolved='predef::bool'>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 resolved='predef::bool'>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><object resolved='predef::bool'>bool</object></type><index>"sass_syntax"</index></member><text><p>Turn on/off Sass syntax, i.e. indented syntax. Only necessary when -  using <ref resolved='predef::compile_string'>compile_string()</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='AE'>   <doc><text><p>Base class for AE (Authenticated Encryption) algorithms.</p>   <p> AE algorithms behave like a combination of a <ref resolved='predef::__builtin.Nettle.Cipher'>Cipher</ref> and    a HMAC.</p>   <p> Note that no actual AE algorithm is implemented    in the base class. They are implemented in classes    that inherit this class.</p>   </text><group><seealso/><text><p><ref resolved='predef::__builtin.Nettle.AEAD'>AEAD</ref></p>