Diff of autodoc.git/traditional_manual/chapter_21.html (e5265051c80ac644c0cbbda23da3ee096508dcb3 » 47a29e5c3859c3b3f6ce88bb779edc47fd1a9046)

autodoc.git/traditional_manual/chapter_21.html:6: <dd class='body--doc'>Pike has a builtin C-style preprocessor. It works similar to the ANSI-C preprocessor but has a few extra features. These and the default set of preprocessor macros are described here. The preprocessor is usually accessed via <code>MasterObject->compile_file()</code> or <code>MasterObject->compile_string()</code>, but may be accessed directly by calling <code>cpp()</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>compile()</code>, <code>cpp()</code>, <code>CompilerEnvironment.CPP</code> </dd></dl></dd></dl><dl><dt><h2 class='header'>Namespace predef::</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This is the default namespace and contains lots of global symbols. - </dd></dl> + </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Constant FUSE_MAJOR_VERSION Constant FUSE_MINOR_VERSION </dt> <dd><code><code class='datatype'>constant</code> <code class='constant'>FUSE_MAJOR_VERSION</code></code> <code><code class='datatype'>constant</code> <code class='constant'>FUSE_MINOR_VERSION</code></code></dd>
autodoc.git/traditional_manual/chapter_21.html:592: compiled programs. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>all_constants()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - add_include_path - </dt> - <dd><code><code class='datatype'>void</code> add_include_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a directory to search for include files. - This is the same as the command line option <tt>-I</tt>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Note that the added directory will only be searched when using - < > to quote the included file. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>remove_include_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_module_path - </dt> - <dd><code><code class='datatype'>void</code> add_module_path(<code class='datatype'>string</code> <code class='argument'>path</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>subpath</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a directory to search for modules. - This is the same as the command line option <tt>-M</tt>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>remove_module_path()</code> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>path</code></dt> - <dd></dd><dd class='body--doc'>a string containing a path to search for Pike modules. May be a - directory, or a path to a ZIP archive. If a ZIP archive path is - provided, modules will be loaded from a directory, "modules" within - the ZIP archive (see the subpath argument). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>subpath</code></dt> - <dd></dd><dd class='body--doc'>if path is a ZIP archive, this argument will determine the path within - the archive to be searched. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_program_path - </dt> - <dd><code><code class='datatype'>void</code> add_program_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a directory to search for programs. - This is the same as the command line option <tt>-P</tt>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>remove_program_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + aggregate </dt> <dd><code><code class='datatype'>array</code> aggregate(<code class='datatype'>mixed</code> ... <code class='argument'>elements</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Construct an array with the arguments as indices. This function could be written in Pike as: <pre><code>array aggregate(mixed ... elems) { return elems; } </code></pre> </dd>
autodoc.git/traditional_manual/chapter_21.html:1062: </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>compile_string()</code>, <code>compile_file()</code>, <code>cpp()</code>, <code>master()</code>, <code>CompilationHandler</code>, <code>DefaultCompilerEnvironment</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - compile - </dt> - <dd><code><code class='modifier'>protected</code> <code class='datatype'>program</code> compile(<code class='datatype'>string</code> <code class='argument'>source</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>major</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>minor</code>, <code class='datatype'>program</code>|<code class='datatype'>void</code> <code class='argument'>target</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>placeholder</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - compile_file - </dt> - <dd><code><code class='datatype'>program</code> compile_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>void</code>|<code class='datatype'>program</code> <code class='argument'>p</code>, <code class='datatype'>void</code>|<code class='datatype'>object</code> <code class='argument'>o</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Compile the Pike code contained in the file <code>filename</code> into a program. - This function will compile the file <code>filename</code> to a Pike program that can - later be instantiated. It is the same as doing - <code class='expr'><code>compile_string</code>(<code>Stdio.read_file</code>(<code>filename</code>), <code>filename</code>)</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile()</code>, <code>compile_string()</code>, <code>cpp()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - compile_string - </dt> - <dd><code><code class='datatype'>program</code> compile_string(<code class='datatype'>string</code> <code class='argument'>source</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>void</code>|<code class='datatype'>program</code> <code class='argument'>p</code>, <code class='datatype'>void</code>|<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>_show_if_constant_errors</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Compile the Pike code in the string <code>source</code> into a program. - If <code>filename</code> is not specified, it will default to <code class='expr'>"-"</code>. - Functionally equal to <code class='expr'><code>compile</code>(<code>cpp</code>(<code>source</code>, <code>filename</code>))</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile()</code>, <code>cpp()</code>, <code>compile_file()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + copy_value </dt> <dd><code><code class='datatype'>mixed</code> copy_value(<code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Copy a value recursively. If the result value is changed destructively (only possible for multisets, arrays and mappings) the copied value will not be changed. The resulting value will always be equal to the copied (as tested with the function <code>equal()</code>), but they may not the the same value (as tested
autodoc.git/traditional_manual/chapter_21.html:1203: </table> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>compile()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - cpp - </dt> - <dd><code><code class='modifier'>protected</code> <code class='datatype'>string</code> cpp(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>mapping</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>charset</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>compat_major</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>compat_minor</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>picky_cpp</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + ctime </dt> <dd><code><code class='datatype'>string</code> ctime(<code class='datatype'>int</code> <code class='argument'>timestamp</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Convert the output from a previous call to <code>time()</code> into a readable string containing the current year, month, day and time. Like <code>localtime</code>, this function might throw an error if the ctime(2) call failed on the system. It's platform dependent what time ranges that function can handle, e.g. Windows doesn't handle
autodoc.git/traditional_manual/chapter_21.html:1284: <dd><code><code class='datatype'>int(0..)</code> depth()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Calculate the depth of the tree. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - describe_backtrace - </dt> - <dd><code><code class='datatype'>string</code> describe_backtrace(<code class='datatype'>mixed</code> <code class='argument'>trace</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>linewidth</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return a readable message that describes where the backtrace - <code>trace</code> was made (by <code>backtrace</code>). - It may also be an error object or array (typically caught by a - <code>catch</code>), in which case the error message also is included in the - description. - Pass <code>linewidth</code> -1 to disable wrapping of the output. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>backtrace()</code>, <code>describe_error()</code>, <code>catch()</code>, <code>throw()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - describe_error - </dt> - <dd><code><code class='datatype'>string</code> describe_error(<code class='datatype'>mixed</code> <code class='argument'>err</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the error message from an error object or array (typically - caught by a <code>catch</code>). The type of the error is checked, hence - <code>err</code> is declared as <code class='expr'>mixed</code> and not <code class='expr'>object|array</code>. - If an error message couldn't be obtained, a fallback message - describing the failure is returned. No errors due to incorrectness - in <code>err</code> are thrown. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>describe_backtrace()</code>, <code>get_backtrace</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + destruct </dt> <dd><code><code class='datatype'>bool</code> destruct(<code class='datatype'>void</code>|<code class='datatype'>object</code> <code class='argument'>o</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Mark an object as destructed. Calls <code class='expr'>o->_destruct()</code>, and then clears all variables in the object. If no argument is given, the current object is destructed. All pointers and function pointers to this object will become zero. The destructed object will be freed from memory as soon as possible.
autodoc.git/traditional_manual/chapter_21.html:1472: </td></tr> </table> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>copy_value()</code>, <code>`==()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - error - </dt> - <dd><code><code class='datatype'>void</code> error(<code class='object unresolved'>sprintf_format</code> <code class='argument'>f</code>, <code class='object unresolved'>sprintf_args</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Throws an error. A more readable version of the code - <code class='expr'>throw( ({ sprintf(f, @args), backtrace() }) )</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Constant is_gssapi_error Constant error_type </dt> <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>is_gssapi_error</code></code> <code><code class='datatype'>constant</code> <code class='datatype'>string</code> <code class='constant'>error_type</code></code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Object recognition constants.
autodoc.git/traditional_manual/chapter_21.html:1743: which can cause more things to be freed or allocated. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Pike.gc_parameters</code>, <code>Debug.gc_status</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_active_compilation_handler - </dt> - <dd><code><code class='object unresolved'>CompilationHandler</code> get_active_compilation_handler()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the currently active compilation compatibility handler, or - <tt>0</tt> (zero) if none is active. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function should only be used during a call of <code>compile()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_active_error_handler()</code>, <code>compile()</code>, - <code>master()->get_compilation_handler()</code>, <code>CompilationHandler</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + get_active_compiler </dt> <dd><code><code class='object unresolved'>CompilerEnvironment.PikeCompiler</code> get_active_compiler()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns the most recent of the currently active pike compilers, or <code>UNDEFINED</code> if none is active. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>This function should only be used during a call of <code>compile()</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>get_active_error_handler()</code>, <code>compile()</code>, <code>master()->get_compilation_handler()</code>, <code>CompilationHandler</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_active_error_handler - </dt> - <dd><code><code class='object unresolved'>CompilationHandler</code> get_active_error_handler()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the currently active compilation error handler - (second argument to <code>compile()</code>), or <tt>0</tt> (zero) if none - is active. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function should only be used during a call of <code>compile()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_active_compilation_handler()</code>, <code>compile()</code>, <code>CompilationHandler</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + get_all_groups </dt> <dd><code><code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>))) get_all_groups()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns an array of arrays with all groups in the system groups source. Each element in the returned array has the same structure as in <code>getgrent</code> function. </dd> <dt class='head--doc'>Note</dt>
autodoc.git/traditional_manual/chapter_21.html:1850: <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>getpwent()</code> <code>getpwnam()</code> <code>getpwuid()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_backtrace - </dt> - <dd><code><code class='datatype'>array</code> get_backtrace(<code class='datatype'>object</code>|<code class='datatype'>array</code> <code class='argument'>err</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the backtrace array from an error object or array - (typically caught by a <code>catch</code>), or zero if there is none. Errors - are thrown on if there are problems retrieving the backtrace. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>describe_backtrace()</code>, <code>describe_error()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + get_groups_for_user </dt> <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) get_groups_for_user(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>user</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Gets all groups which a given user is a member of. </dd> <dt class='head--doc'>Parameter <code class='parameter'>user</code></dt> <dd></dd><dd class='body--doc'>UID or loginname of the user </dd>
autodoc.git/traditional_manual/chapter_21.html:1935: object. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Iterator</code>, <code>lfun::_get_iterator</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - getenv - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) getenv(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>force_update</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Queries the environment variables. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>force_update</code></dt> - <dd></dd><dd class='body--doc'>A cached copy of the real environment is kept to make this - function quicker. If the optional flag <code>force_update</code> is nonzero - then the real environment is queried and the cache is updated from - it. That can be necessary if the environment changes through other - means than <code>putenv</code>, typically from a C-level library. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the whole environment as a mapping. Destructive - operations on the mapping will not affect the internal - environment representation. - Variable names and values cannot be wide strings nor contain - <code class='expr'>'\0'</code> characters. Variable names also cannot contain - <code class='expr'>'='</code> characters. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>On NT the environment variable name is case insensitive. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>putenv()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getenv - </dt> - <dd><code><code class='datatype'>string</code> getenv(<code class='datatype'>string</code> <code class='argument'>varname</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>force_update</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Query the value of a specific environment variable. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>varname</code></dt> - <dd></dd><dd class='body--doc'>Environment variable to query. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>force_update</code></dt> - <dd></dd><dd class='body--doc'>A cached copy of the real environment is kept to make this - function quicker. If the optional flag <code>force_update</code> is nonzero - then the real environment is queried and the cache is updated from - it. That can be necessary if the environment changes through other - means than <code>putenv</code>, typically from a C-level library. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the value of the environment variable <code>varname</code> - if it exists, and <code class='expr'>0</code> (zero) otherwise. - Variable names and values cannot be wide strings nor contain - <code class='expr'>'\0'</code> characters. Variable names also cannot contain - <code class='expr'>'='</code> characters. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>On NT the environment variable name is case insensitive. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>putenv()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + getgrgid </dt> <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>)) getgrgid(<code class='datatype'>int</code> <code class='argument'>gid</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get the group entry for the group with the id <code>gid</code> using the systemfunction <tt>getgrid(3)</tt>. </dd> <dt class='head--doc'>Parameter <code class='parameter'>gid</code></dt> <dd></dd><dd class='body--doc'>The id of the group
autodoc.git/traditional_manual/chapter_21.html:2556: <dt class='head--doc'>Note</dt> <dd class='body--doc'>This is the hashing method used by mappings. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>lfun::__hash()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - is_absolute_path - </dt> - <dd><code><code class='datatype'>int</code> is_absolute_path(<code class='datatype'>string</code> <code class='argument'>p</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Check if a path <code>p</code> is fully qualified (ie not relative). - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns 1 if the path is absolute, 0 otherwise. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Constant is_sql_null </dt> <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>is_sql_null</code></code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>SQL Null marker. </dd> <dt class='head--doc'>Deprecated</dt> <dd class='body--doc'>Replaced by <code>is_val_null</code>.
autodoc.git/traditional_manual/chapter_21.html:3115: and into the future). </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>time()</code>, <code>ctime()</code>, <code>localtime()</code>, <code>gmtime()</code>, <code>strftime()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - normalize_path - </dt> - <dd><code><code class='datatype'>string</code> normalize_path(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Replaces "\" with "/" if runing on MS Windows. It is - adviced to use <code>System.normalize_path</code> instead. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + nth </dt> <dd><code><code class='datatype'>mixed</code> nth(<code class='datatype'>int(0..)</code> <code class='argument'>n</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get the <code class='expr'>n</code>th entry in order. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>An array <code class='expr'>({ key, value })</code>. </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:3198: <code>x</code> as argument. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>exp()</code>, <code>log()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - putenv - </dt> - <dd><code><code class='datatype'>void</code> putenv(<code class='datatype'>string</code> <code class='argument'>varname</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>value</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the environment variable <code>varname</code> to <code>value</code>. - If <code>value</code> is omitted or zero, the environment variable - <code>varname</code> is removed. - <code>varname</code> and <code>value</code> cannot be wide strings nor contain - <code class='expr'>'\0'</code> characters. <code>varname</code> also cannot contain - <code class='expr'>'='</code> characters. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>On NT the environment variable name is case insensitive. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>getenv()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + query_num_arg </dt> <dd><code><code class='datatype'>int</code> query_num_arg()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns the number of arguments given when the previous function was called. This is useful for functions that take a variable number of arguments. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>call_function()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - random - </dt> - <dd><code><code class='datatype'>array</code> random(<code class='datatype'>mapping</code> <code class='argument'>m</code>)</code> - <code><code class='datatype'>float</code> random(<code class='datatype'>float</code> <code class='argument'>max</code>)</code> - <code><code class='datatype'>int</code> random(<code class='datatype'>int</code> <code class='argument'>max</code>)</code> - <code><code class='datatype'>mixed</code> random(<code class='datatype'>object</code> <code class='argument'>o</code>)</code> - <code><code class='datatype'>mixed</code> random(<code class='datatype'>array</code>|<code class='datatype'>multiset</code> <code class='argument'>x</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get a random value generated by the default <code>RandomSystem</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>RandomSystem()->random()</code>, <code>random_string()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + random_seed </dt> <dd><code><code class='datatype'>void</code> random_seed(<code class='datatype'>int</code> <code class='argument'>seed</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function sets the initial value for the random generator. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>random()</code> </dd> <dt class='head--doc'>Deprecated</dt> <dd class='body--doc'><code>Random.Deterministic</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - random_string - </dt> - <dd><code><code class='datatype'>string</code> random_string(<code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get a string of random characters <code class='expr'>0..255</code> with the length <code>len</code> - from the default <code>RandomSystem</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>RandomSystem()->random_string()</code>, <code>random()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_include_path - </dt> - <dd><code><code class='datatype'>void</code> remove_include_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for include files. - This function performs the reverse operation of <code>add_include_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_include_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_module_path - </dt> - <dd><code><code class='datatype'>void</code> remove_module_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for modules. - This function performs the reverse operation of <code>add_module_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_module_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_program_path - </dt> - <dd><code><code class='datatype'>void</code> remove_program_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for programs. - This function performs the reverse operation of <code>add_program_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_program_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + removexattr </dt> <dd><code><code class='datatype'>void</code> removexattr(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>string</code> <code class='argument'>attr</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>symlink</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Remove the specified extended attribute. </dd></dl> <hr />
autodoc.git/traditional_manual/chapter_21.html:5070: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Report the version of Pike. Does the same as <pre><code>sprintf("Pike v%d.%d release %d", __REAL_VERSION__, __REAL_MINOR__, __REAL_BUILD__); </code></pre> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>__VERSION__</code>, <code>__MINOR__</code>, <code>__BUILD__</code>, <code>__REAL_VERSION__</code>, <code>__REAL_MINOR__</code>, <code>__REAL_BUILD__</code>, </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - werror - </dt> - <dd><code><code class='datatype'>int</code> werror(<code class='datatype'>string</code> <code class='argument'>fmt</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Writes a string on stderr. Works just like <code>Stdio.File.write</code> - on <code>Stdio.stderr</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - write - </dt> - <dd><code><code class='datatype'>int</code> write(<code class='datatype'>string</code> <code class='argument'>fmt</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Writes a string on stdout. Works just like <code>Stdio.File.write</code> - on <code>Stdio.stdout</code>. - </dd></dl> - <dl><dt><h2 class='header'>Enum bool</h2> + <dl><dt><h2 class='header'>Class Codec</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Boolean datatype. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - false - Constant - true - </dt> - <dd><code><code class='datatype'>constant</code> <code class='constant'>false</code></code> - <code><code class='datatype'>constant</code> <code class='constant'>true</code></code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class Codec</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> + <dd class='body--doc'>An <code>Encoder</code> and a <code>Decoder</code> lumped into a single instance which can be used for both encoding and decoding. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Inherit Decoder </dt> <dd><code>inherit Decoder : Decoder</code></dd>
autodoc.git/traditional_manual/chapter_21.html:5360: </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns the resolved value, or <code>UNDEFINED</code> on failure. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>get_predefines()</code> </dd></dl> </dd></dl><dl><dt><h2 class='header'>Class CompilerEnvironment</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>predef::CompilerEnvironment</code> that supports handlers. - The compiler environment. + <dd class='body--doc'>The compiler environment. By inheriting this class and overloading the functions, it is possible to make a custom Pike compiler. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>Prior to Pike 7.8 this sort of customization has to be done either via custom master objects, or via <code>CompilationHandler</code>s. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>CompilationHandler</code>, <code>MasterObject</code>, <code>master()</code>, <code>replace_master()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method compile </dt> - <dd><code><code class='datatype'>program</code> compile(<code class='datatype'>string</code> <code class='argument'>source</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>major</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>minor</code>, <code class='datatype'>program</code>|<code class='datatype'>void</code> <code class='argument'>target</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>placeholder</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - compile - </dt> + <dd><code><code class='datatype'>program</code> compile(<code class='datatype'>string</code> <code class='argument'>source</code>, <code class='object unresolved'>CompilationHandler</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>major</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>minor</code>, <code class='datatype'>program</code>|<code class='datatype'>void</code> <code class='argument'>target</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>placeholder</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Compile a string to a program. This function takes a piece of Pike code as a string and compiles it into a clonable program. The optional argument <code>handler</code> is used to specify an alternative error handler. If it is not specified the current master object will be used. The optional arguments <code>major</code> and <code>minor</code> are used to tell the
autodoc.git/traditional_manual/chapter_21.html:5423: </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>compile_string()</code>, <code>compile_file()</code>, <code>cpp()</code>, <code>master()</code>, <code>CompilationHandler</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - compile_exception - </dt> - <dd><code><code class='datatype'>int</code> compile_exception(<code class='datatype'>mixed</code> <code class='argument'>err</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - format_exception - </dt> - <dd><code><code class='datatype'>string</code> format_exception(<code class='datatype'>mixed</code> <code class='argument'>err</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + get_compilation_handler </dt> <dd><code><code class='datatype'>object</code> get_compilation_handler(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get compatibility handler for Pike <code>major</code>.<code>minor</code>. The default implementation calls the corresponding function in the master object. </dd> <dt class='head--doc'>Note</dt>
autodoc.git/traditional_manual/chapter_21.html:5508: in the master object. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>MasterObject()->handle_import()</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - handle_import - </dt> - <dd><code><code class='datatype'>program</code> handle_import(<code class='datatype'>string</code> <code class='argument'>module</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>compat_handler</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + handle_inherit </dt> <dd><code><code class='datatype'>program</code> handle_inherit(<code class='datatype'>string</code> <code class='argument'>inh</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Look up an inherit <code>inh</code>. The default implementation calls the corresponding function in the master object. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>MasterObject()->handle_inherit()</code>. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - handle_inherit - </dt> - <dd><code><code class='datatype'>program</code> handle_inherit(<code class='datatype'>string</code> <code class='argument'>inh</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>compat_handler</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Inherit - OrigCompilerEnvironment - </dt> - <dd><code>inherit predef::CompilerEnvironment : OrigCompilerEnvironment</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit + Reporter </dt> <dd><code>inherit Reporter : Reporter</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Implements the <code>Reporter</code> API. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Reporter()->report()</code>, <code>Reporter()->SeverityLevel</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method resolv </dt> <dd><code><code class='datatype'>mixed</code> resolv(<code class='datatype'>string</code> <code class='argument'>identifier</code>, <code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>compat_handler</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - resolv - </dt> - <dd><code><code class='datatype'>mixed</code> resolv(<code class='datatype'>string</code> <code class='argument'>identifier</code>, <code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>compat_handler</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Look up <code>identifier</code> in the current context. The default implementation calls the corresponding function in the handlers (if any), falling back to the master object. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns the value of the <code>identifier</code> if found, and <code>UNDEFINED</code> if not. </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:5602: <dt class='head--doc'>Description</dt> <dd class='body--doc'>The state for an instance of the preprocessor. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>predef::cpp()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - apply_handler - </dt> - <dd><code><code class='modifier'>protected</code> <code class='datatype'>mixed</code> apply_handler(<code class='datatype'>string</code> <code class='argument'>fun</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + change_cpp_compatibility </dt> <dd><code><code class='datatype'>void</code> change_cpp_compatibility(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - change_cpp_compatibility - </dt> - <dd><code><code class='datatype'>void</code> change_cpp_compatibility(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Change the pike compatibility level for this preprocessor to the specified version of Pike. </dd> <dt class='head--doc'>Parameter <code class='parameter'>major</code></dt> <dd></dd><dd class='body--doc'>Major version of Pike to attempt to be compatible with. Specifying a major version of <code class='expr'>-1</code> is a short hand for specifying <code>__REAL_MAJOR__</code> and <code>__REAL_MINOR__</code>. </dd> <dt class='head--doc'>Parameter <code class='parameter'>minor</code></dt>
autodoc.git/traditional_manual/chapter_21.html:5663: It is recomended to call this function when the <code>CPP</code> object is no longer to be used. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>define_macro()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - handler - Variable - compat_handler - </dt> - <dd><code><code class='datatype'>object</code> CompilerEnvironment.CPP.handler</code> - <code><code class='datatype'>object</code> CompilerEnvironment.CPP.compat_handler</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - compile_exception - </dt> - <dd><code><code class='datatype'>int</code> compile_exception(<code class='datatype'>mixed</code> <code class='argument'>err</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + cpp_error </dt> <dd><code><code class='datatype'>void</code> cpp_error(<code class='object unresolved'>sprintf_format</code> <code class='argument'>msg</code>, <code class='object unresolved'>sprintf_args</code> ... <code class='argument'>arguments</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Convenience function for reporting a cpp error at the current position. This function calls <code>report()</code> with the same arguments, but prefixed with suitable defaults. </dd>
autodoc.git/traditional_manual/chapter_21.html:5734: <tr><td><code><code class='key'>"compat_minor"</code> : <code class='datatype'>int</code></code></td><td>Sets the minor pike version used for compat handling. </td></tr> <tr><td><code><code class='key'>"picky_cpp"</code> : <code class='datatype'>int</code></code></td><td>Generate more warnings. </td></tr> <tr><td><code><code class='key'>"keep_comments"</code> : <code class='datatype'>int</code></code></td><td>This option keeps <code>cpp()</code> from removing comments. Useful in combination with the prefix feature below. </td></tr> <tr><td><code><code class='key'>"prefix"</code> : <code class='datatype'>string</code></code></td><td>If a prefix is given, only prefixed directives will be processed. For example, if the prefix is <code class='expr'>"foo"</code>, then <code class='expr'>#foo_ifdef COND</code> and <code class='expr'>foo___LINE__</code> would be - processed, <code class='expr'>#ifdef COND</code> and <code class='expr'>__LINE__</code> - would not. - </td></tr> - </table> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>current_file</code></dt> - <dd></dd><dd class='body--doc'>If the <code>current_file</code> argument has not been specified, - it will default to <code class='expr'>"-"</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>charset</code></dt> - <dd></dd><dd class='body--doc'>Turn on automatic character set detection if <code class='expr'>1</code>, otherwise - specifies the character set used by the input. - Defaults to <code class='expr'>"ISO-10646"</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>CompilerEnvironment.CPP CompilerEnvironment.CPP(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>charset</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>compat_major</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>compat_minor</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>picky_cpp</code>)</code> - <code>CompilerEnvironment.CPP CompilerEnvironment.CPP(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) <code class='argument'>options</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Initialize the preprocessor. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>options</code></dt> - <dd></dd><dd class='body--doc'>If the first argument is a mapping, no other arguments may follow. - Instead, they have to be given as members of the mapping (if wanted). - The following members are then recognized: - <table class='box'><tr><td><code><code class='key'>"current_file"</code> : <code class='datatype'>string</code></code></td><td>Name of the current file. It is used for generating - #line directives and for locating include files. - </td></tr> - <tr><td><code><code class='key'>"charset"</code> : <code class='datatype'>int</code>|<code class='datatype'>string</code></code></td><td>Charset to use when processing <code class='expr'>data</code>. - </td></tr> - <tr><td><code><code class='key'>"handler"</code> : <code class='datatype'>object</code></code></td><td>Compilation handler. - </td></tr> - <tr><td><code><code class='key'>"compat_major"</code> : <code class='datatype'>int</code></code></td><td>Sets the major pike version used for compat handling. - </td></tr> - <tr><td><code><code class='key'>"compat_minor"</code> : <code class='datatype'>int</code></code></td><td>Sets the minor pike version used for compat handling. - </td></tr> - <tr><td><code><code class='key'>"picky_cpp"</code> : <code class='datatype'>int</code></code></td><td>Generate more warnings. - </td></tr> - <tr><td><code><code class='key'>"keep_comments"</code> : <code class='datatype'>int</code></code></td><td>This option keeps <code>cpp()</code> from removing comments. - Useful in combination with the prefix feature below. - </td></tr> - <tr><td><code><code class='key'>"prefix"</code> : <code class='datatype'>string</code></code></td><td>If a prefix is given, only prefixed directives will be - processed. For example, if the prefix is <code class='expr'>"foo"</code>, then - <code class='expr'>#foo_ifdef COND</code> and <code class='expr'>foo___LINE__</code> would be + processed, <code class='expr'>#ifdef COND</code> and <code class='expr'>__LINE__</code> would not. </td></tr> <tr><td><code><code class='key'>"predefines"</code> : <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>)</code></td><td>Mapping of predefined macros in addition to those returned by <code>CPP()->get_predefines()</code>. </td></tr> </table> </dd> <dt class='head--doc'>Parameter <code class='parameter'>current_file</code></dt> <dd></dd><dd class='body--doc'>If the <code>current_file</code> argument has not been specified, it will default to <code class='expr'>"-"</code>.
autodoc.git/traditional_manual/chapter_21.html:5902: <dd class='body--doc'><code>define_macro()</code>, <code>define_ansi_macros()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method format_exception </dt> <dd><code><code class='datatype'>string</code> format_exception(<code class='datatype'>mixed</code> <code class='argument'>err</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - format_exception - </dt> - <dd><code><code class='datatype'>string</code> format_exception(<code class='datatype'>mixed</code> <code class='argument'>err</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Format an exception caught by cpp as a suitable cpp error message. </dd> <dt class='head--doc'>Parameter <code class='parameter'>err</code></dt> <dd></dd><dd class='body--doc'>Caught value. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns one of: <table class='box'><tr><td><code><code class='datatype'>zero</code></code></td><td>Generate a cpp error using the default format (ie call
autodoc.git/traditional_manual/chapter_21.html:5935: <tr><td><code><code class='datatype'>string</code></code></td><td>Cpp error message to <code>report()</code>. The empty string supresses the cpp error. </td></tr> </table>The default implementation just returns <code class='expr'>0</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_compilation_handler - </dt> - <dd><code><code class='datatype'>object</code> get_compilation_handler(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + get_predefines </dt> <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>object</code>) get_predefines()</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_predefines - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>object</code>) get_predefines()</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get the predefined macros for this preprocessor. This function is called by <code>init_pike_cpp()</code> to retrieve the set of macros to define at initialization. The default implementation returns the internal set of predefined macros unless <code>_take_over_initial_predefines()</code> has been called, in which case it instead calls the corresponding function in the master. </dd> <dt class='head--doc'>Note</dt>
autodoc.git/traditional_manual/chapter_21.html:5979: </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>init_pike_cpp()</code>, <code>define_multiple_macros()</code>, <code>_take_over_initial_predefines()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - handle_include - </dt> - <dd><code><code class='datatype'>string</code> handle_include(<code class='datatype'>string</code> <code class='argument'>header_file</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>bool</code> <code class='argument'>is_local_ref</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - this_program - </dt> - <dd><code>inherit ::this_program : this_program</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + init_pike_cpp </dt> <dd><code><code class='datatype'>void</code> init_pike_cpp()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Convenience function for initializing the preprocessor to Pike defaults. The default implementation is essentially: <pre><code>{ define_ansi_macros(); define_pike_macros(); define_multiple_macros(get_predefines()); } </code></pre></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - read_include - </dt> - <dd><code><code class='datatype'>string</code> read_include(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + report </dt> - <dd><code><code class='datatype'>void</code> report(<code class='object unresolved'>SeverityLevel</code> <code class='argument'>severity</code>, <code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int(1..)</code> <code class='argument'>linenumber</code>, <code class='datatype'>string</code> <code class='argument'>subsystem</code>, <code class='object unresolved'>sprintf_format</code> <code class='argument'>message</code>, <code class='object unresolved'>sprintf_args</code> ... <code class='argument'>extra_args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Report a diagnostic from the preprocessor. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>severity</code></dt> - <dd></dd><dd class='body--doc'>The severity of the diagnostic. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>filename</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>linenumber</code></dt> - <dd></dd><dd class='body--doc'>Location which triggered the diagnostic. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>subsystem</code></dt> - <dd></dd><dd class='body--doc'>Typically <code class='expr'>"cpp"</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>message</code></dt> - <dd></dd><dd class='body--doc'>String with the diagnostic message, with optional - <code>sprintf()</code>-style formatting (if any <code>extra_args</code>). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>extra_args</code></dt> - <dd></dd><dd class='body--doc'>Extra arguments to <code>sprintf()</code>. - The default implementation does the following: - <ul> - <li>If there's a handler which implements <code>Reporter()->report()</code>, - call it with the same arguments. - </li><li>Otherwise if there's a handler which implements - <code>compile_warning()</code> or <code>compile_error()</code> that matches - <code>severity</code>, call it with suitable arguments. - </li><li>Otherwise if there's a compat handler, use it in the same - manner as the handler. - </li><li>Otherwise fall back to calling <code>::report()</code> with the - same arguments. - </li></ul> - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>In Pike 8.0 and earlier <code>MasterObject()->report()</code> was not called. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Reporter()->report()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - report - </dt> + <dd><code><code class='datatype'>void</code> report(<code class='object unresolved'>SeverityLevel</code> <code class='argument'>severity</code>, <code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int(1..)</code> <code class='argument'>linenumber</code>, <code class='datatype'>string</code> <code class='argument'>subsystem</code>, <code class='datatype'>string</code> <code class='argument'>message</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Report a diagnostic from the preprocessor. </dd> <dt class='head--doc'>Parameter <code class='parameter'>severity</code></dt> <dd></dd><dd class='body--doc'>The severity of the diagnostic. </dd> <dt class='head--doc'>Parameter <code class='parameter'>filename</code></dt> <dd></dd>
autodoc.git/traditional_manual/chapter_21.html:6112: <dd class='body--doc'><code>Reporter()->report()</code>, <code>cpp_error()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method resolv </dt> <dd><code><code class='datatype'>mixed</code> resolv(<code class='datatype'>string</code> <code class='argument'>sym</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - resolv - </dt> - <dd><code><code class='datatype'>mixed</code> resolv(<code class='datatype'>string</code> <code class='argument'>sym</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Attempt to resolve a symbol. The default implementation calls <code>CompilerEnvironment()->resolv()</code> in the parent object, with the remaining arguments taken from the current <code>CPP</code> context. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns the value of <code>sym</code> if found, and <code>UNDEFINED</code> if not. </dd></dl> </dd></dl><dl><dt><h2 class='header'>Class CompilerEnvironment.PikeCompiler</h2>
autodoc.git/traditional_manual/chapter_21.html:6182: Returns <tt>UNDEFINED</tt> otherwise (this is not an error indication). </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>pop_type_attribute()</code>, <code>push_type_attribute()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - apply_handler - </dt> - <dd><code><code class='modifier'>protected</code> <code class='datatype'>mixed</code> apply_handler(<code class='datatype'>string</code> <code class='argument'>fun</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + apply_type_attribute </dt> <dd><code><code class='datatype'>bool</code> apply_type_attribute(<code class='datatype'>string</code> <code class='argument'>attribute</code>, <code class='type'>type</code> <code class='argument'>a</code>, <code class='type'>type</code>|<code class='datatype'>void</code> <code class='argument'>b</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Type attribute handler. </dd> <dt class='head--doc'>Parameter <code class='parameter'>attribute</code></dt> <dd></dd><dd class='body--doc'>Attribute that <code>a</code> had. </dd>
autodoc.git/traditional_manual/chapter_21.html:6230: <dd class='body--doc'><code>pop_type_attribute()</code>, <code>push_type_attribute()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method change_compiler_compatibility </dt> <dd><code><code class='datatype'>void</code> change_compiler_compatibility(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - change_compiler_compatibility - </dt> - <dd><code><code class='datatype'>void</code> change_compiler_compatibility(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Change compiler to attempt to be compatible with Pike <code>major</code>.<code>minor</code>. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - handler - Variable - compat_handler - </dt> - <dd><code><code class='datatype'>object</code> CompilerEnvironment.PikeCompiler.handler</code> - <code><code class='datatype'>object</code> CompilerEnvironment.PikeCompiler.compat_handler</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method compile </dt> <dd><code><code class='datatype'>program</code> compile()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Compile the current source into a program. This function compiles the current Pike source code into a clonable program. </dd>
autodoc.git/traditional_manual/chapter_21.html:6332: object will be destructed. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>compile_string()</code>, <code>compile_file()</code>, <code>cpp()</code>, <code>master()</code>, <code>CompilationHandler</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>CompilerEnvironment.PikeCompiler CompilerEnvironment.PikeCompiler(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>source</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>major</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>minor</code>, <code class='datatype'>program</code>|<code class='datatype'>void</code> <code class='argument'>target</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>placeholder</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Variable current_file </dt> <dd><code><code class='datatype'>string</code> CompilerEnvironment.PikeCompiler.current_file</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>The name of the file currently being compiled (during an active compilation). </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:6370: <dd class='body--doc'>The current line number (during an active compilation). </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method get_compilation_handler </dt> <dd><code><code class='datatype'>object</code> get_compilation_handler(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_compilation_handler - </dt> - <dd><code><code class='datatype'>object</code> get_compilation_handler(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get compatibility handler for Pike <code>major</code>.<code>minor</code>. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>This function is called by <code>change_compiler_compatibility()</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method get_default_module </dt> <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>)|<code class='datatype'>object</code> get_default_module()</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_default_module - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>)|<code class='datatype'>object</code> get_default_module()</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get the default module for the current compatibility level (ie typically the value returned by <code>predef::all_constants()</code>). The default implementation calls the corresponding function in the current handler, the current compatibility handler or in the parent <code>CompilerEnvironment</code> in that order. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><table class='box'><tr><td><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>)|<code class='datatype'>object</code></code></td><td>Constant table to use. </td></tr>
autodoc.git/traditional_manual/chapter_21.html:6429: <dd class='body--doc'>This function is called by <code>change_compiler_compatibility()</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method handle_import </dt> <dd><code><code class='datatype'>program</code> handle_import(<code class='datatype'>string</code> <code class='argument'>module</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - handle_import - </dt> - <dd><code><code class='datatype'>program</code> handle_import(<code class='datatype'>string</code> <code class='argument'>module</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Look up an import <code>module</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method handle_inherit </dt> <dd><code><code class='datatype'>program</code> handle_inherit(<code class='datatype'>string</code> <code class='argument'>inh</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - handle_inherit - </dt> - <dd><code><code class='datatype'>program</code> handle_inherit(<code class='datatype'>string</code> <code class='argument'>inh</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Look up an inherit <code>inh</code> in the current program. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method index_type_attribute </dt>
autodoc.git/traditional_manual/chapter_21.html:6492: (ie <code class='expr'>__attribute__(attribute, a)[i]</code>), and <code class='expr'>0</code> (zero) otherwise. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>pop_type_attribute()</code>, <code>push_type_attribute()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - this_program - </dt> - <dd><code>inherit ::this_program : this_program</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method pop_type_attribute </dt> <dd><code><code class='datatype'>bool</code> pop_type_attribute(<code class='datatype'>string</code> <code class='argument'>attribute</code>, <code class='type'>type</code> <code class='argument'>a</code>, <code class='type'>type</code> <code class='argument'>b</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Type attribute handler. Called during type checking when <code class='expr'>a <= b</code> and <code>a</code> had the type attribute <code>attribute</code> before the comparison.
autodoc.git/traditional_manual/chapter_21.html:6555: <dd class='body--doc'><code>pop_type_attribute()</code>, <code>index_type_attribute()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method report </dt> <dd><code><code class='datatype'>void</code> report(<code class='object unresolved'>SeverityLevel</code> <code class='argument'>severity</code>, <code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>linenumber</code>, <code class='datatype'>string</code> <code class='argument'>subsystem</code>, <code class='datatype'>string</code> <code class='argument'>message</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - report - </dt> - <dd><code><code class='datatype'>void</code> report(<code class='object unresolved'>SeverityLevel</code> <code class='argument'>severity</code>, <code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>linenumber</code>, <code class='datatype'>string</code> <code class='argument'>subsystem</code>, <code class='datatype'>string</code> <code class='argument'>message</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Report a diagnostic from the compiler. The default implementation attempts to call the first corresponding function in the active handlers in priority order: <ol> <li>Call handler->report(). </li><li>Call handler->compile_warning() or handler->compile_error() depending on <code>severity</code>. </li><li>Call compat->report(). </li><li>Call compat->compile_warning() or compat->compile_error()
autodoc.git/traditional_manual/chapter_21.html:6609: <dd class='body--doc'><code>CompilerEnvironment()->report()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method resolv </dt> <dd><code><code class='datatype'>mixed</code> resolv(<code class='datatype'>string</code> <code class='argument'>identifier</code>)</code></dd> - </dl> + - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - resolv - </dt> - <dd><code><code class='datatype'>mixed</code> resolv(<code class='datatype'>string</code> <code class='argument'>identifier</code>)</code></dd> - + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Resolve the symbol <code>identifier</code>. The default implementation calls <code>CompilerEnvironment()->resolv()</code> in the parent object, with the remaining arguments taken from the current <code>PikeCompiler</code> context. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns the value of <code>sym</code> if found, and <code>UNDEFINED</code> if not. </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:7080: <dt class='head--type'>Method value </dt> <dd><code><code class='datatype'>mixed</code> value()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns the current value, or <code>UNDEFINED</code> if the iterator doesn't point to any item. </dd></dl> </dd></dl><dl><dt><h2 class='header'>Class MasterObject</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Master control program for Pike. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>predef::master()</code>, <code>predef::replace_master()</code> - </dd></dl> + </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Variable Decoder </dt> <dd><code><code class='datatype'>program</code> MasterObject.Decoder</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This program in the master is cloned and used as codec by
autodoc.git/traditional_manual/chapter_21.html:7129: function. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Encoder</code>, <code>Pike.Encoder</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _main - </dt> - <dd><code><code class='datatype'>void</code> _main(<code class='datatype'>array</code>(<code class='datatype'>string(8bit)</code>) <code class='argument'>orig_argv</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called when all the driver is done with all setup - of modules, efuns, tables etc. etc. and is ready to start executing - _real_ programs. It receives the arguments not meant for the driver. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - _pike_file_name - Variable - _master_file_name - </dt> - <dd><code><code class='datatype'>string</code> MasterObject._pike_file_name</code> - <code><code class='datatype'>string</code> MasterObject._master_file_name</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>These are useful if you want to start other Pike processes - with the same options as this one was started with. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_filesystem_handler - </dt> - <dd><code><code class='datatype'>mixed</code> add_filesystem_handler(<code class='datatype'>string</code> <code class='argument'>mountpoint</code>, <code class='datatype'>object</code> <code class='argument'>filesystem</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>mount a filesystem handler to be used by the resolver. on its own does noting, - but may be used with <code>add_module_path</code> and friends to enable modules to be loaded - from Filesystem objects. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>mountpoint</code></dt> - <dd></dd><dd class='body--doc'>the location in the filesystem to mount the handler - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>filesystem</code></dt> - <dd></dd><dd class='body--doc'>a filesystem object that will handle requests for the given mountpoint. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>master()->add_filesystem_handler("/foo/bar.zip", Filesystem.Zip("/foo/bar.zip")); - master()->add_module_path("/foo/bar.zip/lib"); - </pre></dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>find_handler_for_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - asyncp - </dt> - <dd><code><code class='datatype'>bool</code> asyncp()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns 1 if we're in async-mode, e.g. if the main method has - returned a negative number. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - backend_thread - </dt> - <dd><code><code class='datatype'>object</code> backend_thread()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The backend_thread() function is useful to determine if you are - the backend thread - important when doing async/sync protocols. - This method is only available if thread_create is present. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - bt_max_string_len - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> MasterObject.<code class='constant'>bt_max_string_len</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This constant contains the maximum length of a function entry in a - backtrace. Defaults to 200 if no BT_MAX_STRING_LEN define has been - given. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + cast_to_object </dt> - <dd><code><code class='datatype'>object</code> cast_to_object(<code class='datatype'>string</code> <code class='argument'>oname</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>current_handler</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called when the drivers wants to cast a string - to an object because of an implict or explicit cast. This function - may also receive more arguments in the future. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - cast_to_object - </dt> + <dd><code><code class='datatype'>object</code> cast_to_object(<code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Called by the Pike runtime to cast strings to objects. </dd> <dt class='head--doc'>Parameter <code class='parameter'>str</code></dt> <dd></dd><dd class='body--doc'>String to cast to object. </dd> <dt class='head--doc'>Parameter <code class='parameter'>current_file</code></dt> <dd></dd><dd class='body--doc'>Filename of the file that attempts to perform the cast.
autodoc.git/traditional_manual/chapter_21.html:7267: <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>cast_to_program()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method cast_to_program </dt> - <dd><code><code class='datatype'>program</code> cast_to_program(<code class='datatype'>string</code> <code class='argument'>pname</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called when the driver wants to cast a string - to a program, this might be because of an explicit cast, an inherit - or a implict cast. In the future it might receive more arguments, - to aid the master finding the right program. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - cast_to_program - </dt> + <dd><code><code class='datatype'>program</code> cast_to_program(<code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Called by the Pike runtime to cast strings to programs. </dd> <dt class='head--doc'>Parameter <code class='parameter'>str</code></dt> <dd></dd><dd class='body--doc'>String to cast to object. </dd> <dt class='head--doc'>Parameter <code class='parameter'>current_file</code></dt> <dd></dd><dd class='body--doc'>Filename of the file that attempts to perform the cast.
autodoc.git/traditional_manual/chapter_21.html:7303: <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns the resulting program. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>cast_to_object()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Variable - cflags - </dt> - <dd><code><code class='datatype'>string</code> MasterObject.cflags</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Flags suitable for use when compiling Pike C modules - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - compat_major - </dt> - <dd><code><code class='datatype'>int</code> MasterObject.compat_major</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Major pike version to emulate. - This is typically set via the option <code class='expr'>"-V"</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compat_minor</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - compat_minor - </dt> - <dd><code><code class='datatype'>int</code> MasterObject.compat_minor</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Minor pike version to emulate. - This is typically set via the option <code class='expr'>"-V"</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compat_major</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - compile_error - </dt> - <dd><code><code class='datatype'>void</code> compile_error(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>int</code> <code class='argument'>line</code>, <code class='datatype'>string</code> <code class='argument'>err</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called whenever a compile error occurs. <code>line</code> - is zero for errors that aren't associated with any specific line. - <code>err</code> is not newline terminated. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile_warning()</code>, <code>compile_exception()</code>, - <code>get_inhibit_compile_errors()</code>, <code>set_inhibit_compile_errors()</code>, - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - compile_exception - </dt> - <dd><code><code class='datatype'>int</code> compile_exception(<code class='datatype'>array</code>|<code class='datatype'>object</code> <code class='argument'>trace</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called when an exception is caught during - compilation. Its message is also reported to <code>compile_error</code> if - this function returns zero. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile_error()</code>, <code>compile_warning()</code>, - <code>get_inhibit_compile_errors()</code>, <code>set_inhibit_compile_errors()</code>, - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - compile_warning - </dt> - <dd><code><code class='datatype'>void</code> compile_warning(<code class='datatype'>string</code> <code class='argument'>file</code>, <code class='datatype'>int</code> <code class='argument'>line</code>, <code class='datatype'>string</code> <code class='argument'>err</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called whenever a compile warning occurs. <code>line</code> - is zero for warnings that aren't associated with any specific - line. <code>err</code> is not newline terminated. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>compile_error()</code>, <code>compile_exception()</code>, - <code>get_inhibit_compile_errors()</code>, <code>set_inhibit_compile_errors()</code>, - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - currentversion - </dt> - <dd><code><code class='object unresolved'>Version</code> MasterObject.currentversion</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Version information about the current Pike version. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + decode_charset </dt> - <dd><code><code class='datatype'>string</code> decode_charset(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>string</code> <code class='argument'>charset</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called by cpp() when it wants to do - character code conversion. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - decode_charset - </dt> + <dd><code><code class='datatype'>string</code> decode_charset(<code class='datatype'>string</code> <code class='argument'>raw</code>, <code class='datatype'>string</code> <code class='argument'>charset</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Convert <code>raw</code> from encoding <code>charset</code> to UNICODE. This function is called by <code>cpp()</code> when it encounters <code class='expr'>#charset</code> directives. </dd> <dt class='head--doc'>Parameter <code class='parameter'>raw</code></dt> <dd></dd><dd class='body--doc'>String to convert. </dd>
autodoc.git/traditional_manual/chapter_21.html:7486: with <code>add_constant()</code>. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>predef::describe_backtrace()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - describe_function - </dt> - <dd><code><code class='datatype'>string</code> describe_function(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Function called by <code>describe_backtrace()</code> to describe - functions in the backtrace. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - describe_module - </dt> - <dd><code><code class='datatype'>string</code> describe_module(<code class='datatype'>object</code>|<code class='datatype'>program</code> <code class='argument'>mod</code>, <code class='datatype'>array</code>(<code class='datatype'>object</code>)|<code class='datatype'>void</code> <code class='argument'>ret_obj</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Describe the path to the module <code>mod</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>mod</code></dt> - <dd></dd><dd class='body--doc'>If <code>mod</code> is a program, attempt to describe the path - to a clone of <code>mod</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>ret_obj</code></dt> - <dd></dd><dd class='body--doc'>If an instance of <code>mod</code> is found, it will be returned - by changing element <code class='expr'>0</code> of <code>ret_obj</code>. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The a description of the path. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The returned description will end with a proper indexing method - currently either <code class='expr'>"."</code> or <code class='expr'>"->"</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - describe_object - </dt> - <dd><code><code class='datatype'>string</code> describe_object(<code class='datatype'>object</code> <code class='argument'>o</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Function called by <code class='expr'>sprintf("%O")</code> for objects that don't - have an <code>lfun::_sprintf()</code>, or have one that returns <code class='expr'>UNDEFINED</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - describe_program - </dt> - <dd><code><code class='datatype'>string</code> describe_program(<code class='datatype'>program</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>p</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Function called by <code class='expr'>sprintf("%O")</code> for programs. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - doc_prefix - </dt> - <dd><code><code class='datatype'>string</code> MasterObject.doc_prefix</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Prefix for autodoc files. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - programs - Variable - documentation - Variable - source_cache - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>program</code>|<code class='object unresolved'>NoValue</code>) MasterObject.programs</code> - <code><code class='datatype'>mapping</code>(<code class='datatype'>program</code>:<code class='datatype'>object</code>) MasterObject.documentation</code> - <code><code class='datatype'>mapping</code>(<code class='datatype'>program</code>:<code class='datatype'>string</code>) MasterObject.source_cache</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Mapping containing the cache of currently compiled files. - This mapping currently has the following structure: - <table class='box'><tr><td><code><code class='key'>filename</code> : <code class='datatype'>program</code></code></td></tr> - </table>The filename path separator is / on both NT and UNIX. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Special cases: The current master program is available under the - name <code class='expr'>"/master"</code>, and the program containing the <code>main</code> - function under <code class='expr'>"/main"</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - enable_source_cache - </dt> - <dd><code><code class='datatype'>void</code> enable_source_cache()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Enable caching of sources from compile_string() - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - fc_reverse_lookup - </dt> - <dd><code><code class='datatype'>string</code> fc_reverse_lookup(<code class='datatype'>object</code> <code class='argument'>obj</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the path for <code>obj</code> in <code>fc</code>, if it got any. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - find_handler_for_path - </dt> - <dd><code><code class='datatype'>string</code> find_handler_for_path(<code class='datatype'>string</code> <code class='argument'>file</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the mountpoint for the filesystem handler handling the - <code>file</code> (if any). - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_filesystem_handler()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_compat_master - </dt> - <dd><code><code class='datatype'>object</code> get_compat_master(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return a master object compatible with the specified version of Pike. - This function is used to implement the various compatibility versions - of <code>master()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_compilation_handler()</code>, <code>master()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + get_compilation_handler </dt> <dd><code><code class='object unresolved'>CompilationHandler</code> get_compilation_handler(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Get compilation handler for simulation of Pike v<code>major</code>.<code>minor</code>. This function is called by <code>cpp()</code> when it encounters <code class='expr'>#pike</code> directives. </dd> <dt class='head--doc'>Parameter <code class='parameter'>major</code></dt>
autodoc.git/traditional_manual/chapter_21.html:7669: <dd></dd><dd class='body--doc'>Minor version. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns a compilation handler for Pike >= <code>major</code>.<code>minor</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - get_inhibit_compile_errors - </dt> - <dd><code><code class='datatype'>mixed</code> get_inhibit_compile_errors()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get the current compile error, warning and exception behaviour. - See <code>set_inhibit_compile_errors()</code> for details. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_inhibit_compile_errors()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_precompiled_mtime - </dt> - <dd><code><code class='datatype'>int</code> get_precompiled_mtime(<code class='datatype'>string</code> <code class='argument'>id</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Given an identifier returned by query_precompiled_names, returns - the mtime of the precompiled entry. Returns -1 if there is no - entry. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - handle_attribute - </dt> - <dd><code><code class='modifier'>optional</code> <code class='datatype'>bool</code> handle_attribute(<code class='datatype'>mixed</code> <code class='argument'>value</code>, <code class='datatype'>string</code> <code class='argument'>attribute</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called in runtime check_types mode (<tt>-rt</tt>), - when encountering a soft cast to an attributed type. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>Value that is about to receive the attribute. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>attribute</code></dt> - <dd></dd><dd class='body--doc'>Type attribute to validate. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns one of: - <table class='box'><tr><td><code><code class='key'>1</code></code></td><td>If the attribute is valid for the value. - </td></tr> - <tr><td><code><code class='key'>0</code></code></td><td>If the attribute is not valid for the value. - </td></tr> - <tr><td><code><code class='key'>UNDEFINED</code></code></td><td>If the attribute is unsupported. - </td></tr> - </table>The default master implements validation of the <code class='expr'>"utf8"</code> - attribute. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + handle_error </dt> <dd><code><code class='datatype'>void</code> handle_error(<code class='datatype'>mixed</code> <code class='argument'>exception</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Called by the Pike runtime if an exception isn't caught. </dd> <dt class='head--doc'>Parameter <code class='parameter'>exception</code></dt> <dd></dd><dd class='body--doc'>Value that was <code>throw()</code>'n. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>describe_backtrace()</code> </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - handle_error - </dt> - <dd><code><code class='datatype'>void</code> handle_error(<code class='datatype'>array</code>|<code class='datatype'>object</code> <code class='argument'>trace</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called when an error occurs that is not caught - with catch(). - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - handle_inherit - </dt> - <dd><code><code class='datatype'>program</code> handle_inherit(<code class='datatype'>string</code> <code class='argument'>pname</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>handler</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called whenever a inherit is called for. - It is supposed to return the program to inherit. - The first argument is the argument given to inherit, and the second - is the file name of the program currently compiling. Note that the - file name can be changed with #line, or set by compile_string, so - it can not be 100% trusted to be a filename. - previous_object(), can be virtually anything in this function, as it - is called from the compiler. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - include_prefix - </dt> - <dd><code><code class='datatype'>string</code> MasterObject.include_prefix</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Prefix for Pike-related C header files. - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Inherit - Codec - </dt> - <dd><code>inherit Codec : Codec</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - CompatResolver - </dt> - <dd><code>inherit CompatResolver : CompatResolver</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit + CompilationHandler </dt> <dd><code>inherit CompilationHandler : CompilationHandler</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>The master object acts as fallback compilation handler for <code>compile()</code> and <code>cpp()</code>. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - Pike_8_0_master - </dt> - <dd><code><code class='modifier'>protected</code> inherit Pike_8_0_master : Pike_8_0_master</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Namespaces for compat masters. - This inherit is used to provide compatibility namespaces - for <code>get_compat_master()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_compat_master()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - is_pike_master - </dt> - <dd><code><code class='datatype'>int</code> MasterObject.is_pike_master</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This integer variable should exist in any object that aspires to be - the master. It gets set to 1 when the master is installed, and is - therefore set in any object that is or has been the master. That - makes the Encoder class encode references to the master and all - ex-masters as references to the current master object. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - ldflags - </dt> - <dd><code><code class='datatype'>string</code> MasterObject.ldflags</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Flags suitable for use when linking Pike C modules - </dd></dl> - - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method - master_read_file - </dt> - <dd><code><code class='datatype'>string</code> master_read_file(<code class='datatype'>string</code> <code class='argument'>file</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read a file from the master filesystem. - The master filesystem defaults to the system filesystem, - but additional mountpoints may be added via - <code>add_filesystem_handler()</code>. - All file I/O performed by the <code>MasterObject</code> is performed - via this function and its related functions. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_filesystem_handler()</code>, <code>find_handler_for_path()</code>, - <code>master_get_dir()</code>, <code>master_file_stat()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - module_defined - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) module_defined(<code class='datatype'>object</code>|<code class='datatype'>program</code> <code class='argument'>mod</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Find the files in which <code>mod</code> is defined, as they may be hidden away in - joinnodes and dirnodes - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>mod</code></dt> - <dd></dd><dd class='body--doc'>The module we are looking for. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>An array of strings with filenames. - (one for each file in a joinnode, or just one otherwise) - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - objects_reverse_lookup - </dt> - <dd><code><code class='datatype'>program</code> objects_reverse_lookup(<code class='datatype'>object</code> <code class='argument'>obj</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the program for <code>obj</code>, if known to the master. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - out_of_date_warning - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> MasterObject.<code class='constant'>out_of_date_warning</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Should Pike complain about out of date compiled files. - 1 means yes and 0 means no. Controlled by the OUT_OF_DATE_WARNING - define. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - program_path_to_name - </dt> - <dd><code><code class='datatype'>string</code> program_path_to_name(<code class='datatype'>string</code> <code class='argument'>path</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>module_prefix</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>module_suffix</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>object_suffix</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Converts a module path on the form <code class='expr'>"Foo.pmod/Bar.pmod"</code> or - <code class='expr'>"/path/to/pike/lib/modules/Foo.pmod/Bar.pmod"</code> to a module - identifier on the form <code class='expr'>"Foo.Bar"</code>. - If <code>module_prefix</code> or <code>module_suffix</code> are given, they are - prepended and appended, respectively, to the returned string if - it's a module file (i.e. ends with <code class='expr'>".pmod"</code> or - <code class='expr'>".so"</code>). If <code>object_suffix</code> is given, it's appended to the - returned string if it's an object file (i.e. ends with - <code class='expr'>".pike"</code>). - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - programs_reverse_lookup - </dt> - <dd><code><code class='datatype'>string</code> programs_reverse_lookup(<code class='datatype'>program</code> <code class='argument'>prog</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the path for <code>prog</code> in <code>programs</code>, if it got any. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - query_precompiled_names - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) query_precompiled_names(<code class='datatype'>string</code> <code class='argument'>fname</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns identifiers (e.g. file names) of potentially precompiled - files in priority order. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read_precompiled - </dt> - <dd><code><code class='datatype'>string</code> read_precompiled(<code class='datatype'>string</code> <code class='argument'>id</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Given an identifier returned by query_precompiled_names, returns - the precompiled entry. Can assume the entry exists. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + runtime_warning </dt> <dd><code><code class='datatype'>void</code> runtime_warning(<code class='datatype'>string</code> <code class='argument'>subsystem</code>, <code class='datatype'>string</code> <code class='argument'>msg</code>, <code class='datatype'>mixed</code>|<code class='datatype'>void</code> <code class='argument'>data</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Called by the Pike runtime to warn about data inconsistencies. </dd> <dt class='head--doc'>Parameter <code class='parameter'>subsystem</code></dt> <dd></dd><dd class='body--doc'>Runtime subsystem where the warning was generated. Currently the following subsystems may call this function:
autodoc.git/traditional_manual/chapter_21.html:8024: </table> </dd> <dt class='head--doc'>Parameter <code class='parameter'>data</code></dt> <dd></dd><dd class='body--doc'>Optional data that further describes the warning specified by <code>msg</code>. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - runtime_warning - </dt> - <dd><code><code class='datatype'>void</code> runtime_warning(<code class='datatype'>string</code> <code class='argument'>where</code>, <code class='datatype'>string</code> <code class='argument'>what</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Called for every runtime warning. The first argument identifies - where the warning comes from, the second identifies the specific - message, and the rest depends on that. See code below for currently - implemented warnings. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_inhibit_compile_errors - </dt> - <dd><code><code class='datatype'>void</code> set_inhibit_compile_errors(<code class='datatype'>mixed</code> <code class='argument'>behaviour</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set the compile error, warning and exception behaviour. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>behaviour</code></dt> - <dd></dd><dd class='body--doc'>The desired behaviour. One of: - <table class='box'><tr><td><code><code class='datatype'>int(0..0)</code></code></td><td>Output compilation errors and warnings to <tt>stderr</tt>. - This is the default behaviour. - </td></tr> - <tr><td><code><code class='datatype'>int(1..1)</code></code></td><td>Inhibit output of compilator diagnostics. - </td></tr> - <tr><td><code><code class='datatype'>function</code>(<code class='datatype'>string</code>, <code class='datatype'>int</code>, <code class='datatype'>string</code>:<code class='datatype'>void</code>)</code></td><td>Function to call for compilation errors. Compilation - warnings and exceptions are inhibited. - The function will be called with the same arguments - as those passed to <code>compile_error()</code>. - </td></tr> - <tr><td><code><code class='object unresolved'>CompilationHandler</code></code></td><td>Compilation handler to use for diagnostics. - </td></tr> - </table> - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Note that the behaviour is thread local, and is not copied - to new threads when they are created. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_inhibit_compile_errors()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - show_doc - </dt> - <dd><code><code class='datatype'>object</code> show_doc(<code class='datatype'>program</code>|<code class='datatype'>object</code>|<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>obj</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Show documentation for the item <code>obj</code> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>obj</code></dt> - <dd></dd><dd class='body--doc'>The object for which the documentation should be shown - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>an AutoDoc object - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - show_if_constant_errors - </dt> - <dd><code><code class='datatype'>int</code> MasterObject.show_if_constant_errors</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Show compilation warnings from compilation of <code>cpp()</code> - <code class='expr'>#if constant()</code> expressions. - This is typically set via the option <code class='expr'>"--picky-cpp"</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method + thread_quanta_exceeded </dt> <dd><code><code class='datatype'>void</code> thread_quanta_exceeded(<code class='object unresolved'>Thread.Thread</code> <code class='argument'>thread</code>, <code class='datatype'>int</code> <code class='argument'>ns</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Function called when a thread has exceeded the thread quanta. </dd> <dt class='head--doc'>Parameter <code class='parameter'>thread</code></dt> <dd></dd><dd class='body--doc'>Thread that exceeded the thread quanta. </dd>
autodoc.git/traditional_manual/chapter_21.html:8148: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Unregister a program that was only partially compiled. Called by <code>compile()</code> to clean up references to partially compiled programs. </dd> <dt class='head--doc'>Parameter <code class='parameter'>p</code></dt> <dd></dd><dd class='body--doc'>Partially compiled program that should no longer be referenced. </dd><dt class='head--fixme'>FIXME</dt> <dd class='body--fixme'>Shouldn't this function be in the compilation handler? </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - want_warnings - </dt> - <dd><code><code class='datatype'>int</code> MasterObject.want_warnings</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>If not zero compilation warnings will be written out on stderr. - </dd></dl> - <dl><dt><h2 class='header'>Class MasterObject.Codec</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>Encoder</code> and <code>Decoder</code> rolled into one. This is for mainly - compatibility; there's typically no use combining encoding and - decoding into the same object. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>MasterObject.Codec MasterObject.Codec(<code class='datatype'>void</code>|<code class='datatype'>mixed</code> <code class='argument'>encoded</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The optional argument is the thing to encode; it's passed on to - <code>Encoder</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Decoder - </dt> - <dd><code>inherit Decoder : Decoder</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Encoder - </dt> - <dd><code>inherit Encoder : Encoder</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class MasterObject.CompatResolver</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Resolver of symbols not located in the program being compiled. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_include_path - </dt> - <dd><code><code class='datatype'>void</code> add_include_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a directory to search for include files. - This is the same as the command line option <tt>-I</tt>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Note that the added directory will only be searched when using - < > to quote the included file. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>remove_include_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_module_path - </dt> - <dd><code><code class='datatype'>void</code> add_module_path(<code class='datatype'>string</code> <code class='argument'>path</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>subpath</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a directory to search for modules. - This is the same as the command line option <tt>-M</tt>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>remove_module_path()</code> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>path</code></dt> - <dd></dd><dd class='body--doc'>a string containing a path to search for Pike modules. May be a - directory, or a path to a ZIP archive. If a ZIP archive path is - provided, modules will be loaded from a directory, "modules" within - the ZIP archive (see the subpath argument). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>subpath</code></dt> - <dd></dd><dd class='body--doc'>if path is a ZIP archive, this argument will determine the path within - the archive to be searched. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_predefine - </dt> - <dd><code><code class='datatype'>void</code> add_predefine(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mixed</code> <code class='argument'>value</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a define (without arguments) which will be implicitly - defined in <code>cpp</code> calls. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - add_program_path - </dt> - <dd><code><code class='datatype'>void</code> add_program_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Add a directory to search for programs. - This is the same as the command line option <tt>-P</tt>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>remove_program_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>MasterObject.CompatResolver MasterObject.CompatResolver(<code class='datatype'>mixed</code> <code class='argument'>version</code>, <code class='object unresolved'>CompatResolver</code>|<code class='datatype'>void</code> <code class='argument'>fallback_resolver</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The CompatResolver is initialized with a value that can be - casted into a "%d.%d" string, e.g. a version object. - It can also optionally be initialized with a fallback resolver. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - fallback_resolver - </dt> - <dd><code><code class='object unresolved'>CompatResolver</code> MasterObject.CompatResolver.fallback_resolver</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>If we fail to resolv, try the fallback. - Typical configuration: - <pre>0.6->7.0->7.2-> ... ->master</pre> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_default_module - </dt> - <dd><code><code class='datatype'>mapping</code> get_default_module()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Return the default module for the <code>CompatResolver</code>. - This is the mapping that corresponds to the <code>predef::</code> - name space for the compatibility level, and is the - value returned by <code>all_constants()</code> for the same. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - get_predefines - </dt> - <dd><code><code class='datatype'>mapping</code> get_predefines()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns a mapping with the current predefines. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - handle_include - </dt> - <dd><code><code class='datatype'>string</code> handle_include(<code class='datatype'>string</code> <code class='argument'>f</code>, <code class='datatype'>string</code> <code class='argument'>current_file</code>, <code class='datatype'>int</code> <code class='argument'>local_include</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function is called whenever an #include directive is - encountered. It receives the argument for #include and should - return the file name of the file to include. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read_include()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - handler_root_modules - </dt> - <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>object</code>:<code class='object unresolved'>joinnode</code>) MasterObject.CompatResolver.handler_root_modules</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Lookup from handler module to corresponding root_module. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - instantiate_static_modules - </dt> - <dd><code><code class='modifier'>protected</code> <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) instantiate_static_modules(<code class='datatype'>object</code>|<code class='datatype'>mapping</code> <code class='argument'>static_modules</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Instantiate static modules in the same way that dynamic modules - are instantiated. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - pike_include_path - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) MasterObject.CompatResolver.pike_include_path</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The complete include search path - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - pike_module_path - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) MasterObject.CompatResolver.pike_module_path</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The complete module search path - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - pike_program_path - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) MasterObject.CompatResolver.pike_program_path</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The complete program search path - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read_include - </dt> - <dd><code><code class='datatype'>string</code> read_include(<code class='datatype'>string</code> <code class='argument'>f</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read the file specified by <code>handle_include()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>handle_include()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_include_path - </dt> - <dd><code><code class='datatype'>void</code> remove_include_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for include files. - This function performs the reverse operation of <code>add_include_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_include_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_module_path - </dt> - <dd><code><code class='datatype'>void</code> remove_module_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for modules. - This function performs the reverse operation of <code>add_module_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_module_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_predefine - </dt> - <dd><code><code class='datatype'>void</code> remove_predefine(<code class='datatype'>string</code> <code class='argument'>name</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a define from the set that are implicitly defined in - <code>cpp</code> calls. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - remove_program_path - </dt> - <dd><code><code class='datatype'>void</code> remove_program_path(<code class='datatype'>string</code> <code class='argument'>tmp</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a directory to search for programs. - This function performs the reverse operation of <code>add_program_path()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_program_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - resolv - </dt> - <dd><code><code class='datatype'>mixed</code> resolv(<code class='datatype'>string</code> <code class='argument'>identifier</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>current_handler</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>current_compat_handler</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Resolve the <code>identifier</code> expression. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the value of the <code>identifier</code> if it exists, - and <code>UNDEFINED</code> otherwise. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - resolv_base - </dt> - <dd><code><code class='datatype'>mixed</code> resolv_base(<code class='datatype'>string</code> <code class='argument'>identifier</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>current_handler</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>current_compat_handler</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Look up <code>identifier</code> in the root module. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - resolv_or_error - </dt> - <dd><code><code class='datatype'>mixed</code> resolv_or_error(<code class='datatype'>string</code> <code class='argument'>identifier</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>current_file</code>, <code class='datatype'>void</code>|<code class='datatype'>object</code> <code class='argument'>current_handler</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Same as <code>resolv</code>, but throws an error instead of returning - <code>UNDEFINED</code> if the resolv failed. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - root_module - </dt> - <dd><code><code class='object unresolved'>joinnode</code> MasterObject.CompatResolver.root_module</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Join node of the root modules for this resolver. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - system_module_path - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) MasterObject.CompatResolver.system_module_path</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The pike system module path, not including any set by the user. - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class MasterObject.Decoder</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Codec for use with <code>decode_value</code>. This is the decoder - corresponding to <code>Encoder</code>. See that one for more details. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>MasterObject.Decoder MasterObject.Decoder(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>fname</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>mkobj</code>, <code class='datatype'>void</code>|<code class='datatype'>object</code> <code class='argument'>handler</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - decode_object - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>mixed</code>) decode_object(<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>mixed</code> <code class='argument'>data</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Restore the state of an encoded object. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>o</code></dt> - <dd></dd><dd class='body--doc'>Object to modify. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>data</code></dt> - <dd></dd><dd class='body--doc'>State information from <code>Encoder()->encode_object()</code>. - The default implementation calls <code class='expr'>o->_decode(data)</code> - if the object has an <code class='expr'>_decode()</code>, otherwise if - <code>data</code> is an array, returns it to indicate that <code>lfun::create()</code> - should be called. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is called before <code>lfun::create()</code> - in the object has been called, but after <code>lfun::__INIT()</code> - has been called. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns an array to indicate to the caller that - <code>lfun::create()</code> should be called with the elements - of the array as arguments. - Returns <code class='expr'>0</code> (zero) to inhibit calling of <code>lfun::create()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Encoder()->encode_object()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - fname - Variable - mkobj - Variable - handler - </dt> - <dd><code><code class='datatype'>void</code>|<code class='datatype'>string</code> MasterObject.Decoder.fname</code> - <code><code class='datatype'>void</code>|<code class='datatype'>int</code> MasterObject.Decoder.mkobj</code> - <code><code class='datatype'>void</code>|<code class='datatype'>object</code> MasterObject.Decoder.handler</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class MasterObject.Describer</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Class used by <code>describe_backtrace()</code> to describe values in backtraces. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - DestructImmediate - </dt> - <dd><code>inherit _static_modules.Builtin.DestructImmediate : DestructImmediate</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class MasterObject.Encoder</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Codec for use with <code>encode_value</code>. It understands all the - standard references to builtin functions, pike modules, and the - main program script. - The format of the produced identifiers are documented here to - allow extension of this class: - The produced names are either strings or arrays. The string - variant specifies the thing to look up according to the first - character: - 'c' Look up in all_constants(). - 's' Look up in _static_modules. - 'r' Look up with resolv(). - 'p' Look up in programs. - 'o' Look up in programs, then look up the result in objects. - 'f' Look up in fc. - In the array format, the first element is a string as above and - the rest specify a series of things to do with the result: - A string Look up this string in the result. - 'm' Get module object in dirnode. - 'p' Do object_program(result). - All lowercase letters and the symbols ':', '/' and '.' are - reserved for internal use in both cases where characters are used - above. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>MasterObject.Encoder MasterObject.Encoder(<code class='datatype'>void</code>|<code class='datatype'>mixed</code> <code class='argument'>encoded</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates an encoder instance. If <code>encoded</code> is specified, it's - encoded instead of being reverse resolved to a name. That's - necessary to encode programs. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - nameof - </dt> - <dd><code><code class='datatype'>string</code>|<code class='datatype'>array</code> nameof(<code class='datatype'>mixed</code> <code class='argument'>what</code>, <code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>object</code>) <code class='argument'>module_object</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>When <code>module_object</code> is set and the name would end with an - <code class='expr'>object_program</code> step (i.e. <code class='expr'>'p'</code>), then drop that - step so that the name corresponds to the object instead. - <code class='expr'><code>module_object</code>[0]</code> will receive the found object. - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class MasterObject.Pike_7_8_master</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pike 7.8 master compatibility interface. - Most of the interface is implemented via mixin, - or overloading by more recent masters. - This interface is used for compatibility with - Pike 7.8. - </dd> - <dt class='head--doc'>Deprecated</dt> - <dd class='body--doc'>Replaced by <code>predef::MasterObject</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_compat_master()</code>, <code>master()</code>, <code>predef::MasterObject</code> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Class MasterObject.Pike_8_0_master</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Pike 8.0 master compatibility interface. - Most of the interface is implemented via mixin, - or overloading by more recent masters. - This interface is used for compatibility with - Pike 8.0. - </dd> - <dt class='head--doc'>Deprecated</dt> - <dd class='body--doc'>Replaced by <code>predef::MasterObject</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>get_compat_master()</code>, <code>master()</code>, <code>predef::MasterObject</code> - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Pike_7_8_master - </dt> - <dd><code>inherit Pike_7_8_master : Pike_7_8_master</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class MasterObject.Version</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Contains version information about a Pike version. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - `< - Method - `> - Method - `== - Method - __hash - </dt> - <dd><code><code class='datatype'>int</code> res = <code class='class'>MasterObject.Version()</code> < <code class='class'>v</code></code> - <code><code class='datatype'>int</code> res = <code class='class'>MasterObject.Version()</code> > <code class='class'>v</code></code> - <code><code class='datatype'>int</code> res = <code class='class'>MasterObject.Version()</code> == <code class='class'>v</code></code> - <code><code class='datatype'>int</code> hash_value( MasterObject.Version arg )</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Methods define so that version objects - can be compared and ordered. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - cast - </dt> - <dd><code>(int)MasterObject.Version() (float)MasterObject.Version() (string)MasterObject.Version() (array)MasterObject.Version() (mapping)MasterObject.Version() (multiset)MasterObject.Version()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The version object can be casted into a string. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>MasterObject.Version MasterObject.Version(<code class='datatype'>int</code> <code class='argument'>major</code>, <code class='datatype'>int</code> <code class='argument'>minor</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set the version in the object. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - major - Variable - minor - </dt> - <dd><code><code class='datatype'>int</code> MasterObject.Version.major</code> - <code><code class='datatype'>int</code> MasterObject.Version.minor</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The major and minor parts of the version. - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class MasterObject.dirnode</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Module node representing a single directory. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>joinnode</code> - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - dirname - Variable - compilation_handler - Variable - name - </dt> - <dd><code><code class='datatype'>string</code> MasterObject.dirnode.dirname</code> - <code><code class='datatype'>object</code>|<code class='datatype'>void</code> MasterObject.dirnode.compilation_handler</code> - <code><code class='datatype'>string</code>|<code class='datatype'>void</code> MasterObject.dirnode.name</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>MasterObject.dirnode MasterObject.dirnode(<code class='datatype'>string</code> <code class='argument'>dirname</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>compilation_handler</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>name</code>)</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class MasterObject.joinnode</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Module node holding possibly multiple directories, - and optionally falling back to another level. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>dirnode</code> - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - joined_modules - Variable - compilation_handler - Variable - fallback_module - Variable - name - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>object</code>|<code class='datatype'>mapping</code>) MasterObject.joinnode.joined_modules</code> - <code><code class='datatype'>object</code>|<code class='datatype'>void</code> MasterObject.joinnode.compilation_handler</code> - <code><code class='object unresolved'>joinnode</code>|<code class='datatype'>mapping</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int(0..0)</code>)|<code class='datatype'>void</code> MasterObject.joinnode.fallback_module</code> - <code><code class='datatype'>string</code>|<code class='datatype'>void</code> MasterObject.joinnode.name</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>MasterObject.joinnode MasterObject.joinnode(<code class='datatype'>array</code>(<code class='datatype'>object</code>|<code class='datatype'>mapping</code>) <code class='argument'>joined_modules</code>, <code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>compilation_handler</code>, <code class='object unresolved'>joinnode</code>|<code class='datatype'>mapping</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int(0..0)</code>)|<code class='datatype'>void</code> <code class='argument'>fallback_module</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>name</code>)</code></dd> - </dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Class RandomInterface</h2> + </dd></dl><dl><dt><h2 class='header'>Class RandomInterface</h2> </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Method random </dt> <dd><code><code class='datatype'>array</code> random(<code class='datatype'>mapping</code> <code class='argument'>m</code>)</code></dd> <dt class='head--doc'>Description</dt>
autodoc.git/traditional_manual/chapter_21.html:9057: Constant ERROR Constant FATAL </dt> <dd><code><code class='datatype'>constant</code> Reporter.<code class='constant'>NOTICE</code></code> <code><code class='datatype'>constant</code> Reporter.<code class='constant'>WARNING</code></code> <code><code class='datatype'>constant</code> Reporter.<code class='constant'>ERROR</code></code> <code><code class='datatype'>constant</code> Reporter.<code class='constant'>FATAL</code></code></dd> </dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Class __dirnode</h2> + </dd></dl></dd></dl><dl><dt><h2 class='header'>Class mklibpike</h2> </dt><dd> <hr /> <dl class='group--doc'> - <dt class='head--type'>Inherit - dirnode - </dt> - <dd><code>inherit MasterObject.dirnode : dirnode</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class __joinnode</h2> - </dt><dd> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - joinnode - </dt> - <dd><code>inherit MasterObject.joinnode : joinnode</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class mklibpike</h2> - </dt><dd> - - <hr /> - <dl class='group--doc'> + <dt class='head--type'>Method parse </dt> <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='object unresolved'>Parser.C.Token</code>))) parse(<code class='datatype'>array</code>(<code class='object unresolved'>Parser.C.Token</code>) <code class='argument'>tokens</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns a mapping from symbol to a tuple of return type and parameters. </dd></dl> <dl><dt><h2 class='header'>Class mklibpike.C_Include_Handler</h2> </dt><dd>
autodoc.git/traditional_manual/chapter_21.html:27227: be used as such. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>MIME.encode_crypt64()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + decode_headerfield_params + </dt> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>ADT.OrderedMapping</code>) decode_headerfield_params(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Decodes the given string as a key-value parameter cascade + according to e.g. <a href='http://pike.lysator.liu.se/rfc7239.xml#4'>RFC 7239 section 4</a>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function will decode all conforming inputs, but it will also + be forgiving when presented with non-conforming inputs. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>encode_headerfield_params</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method decode_qp </dt> <dd><code><code class='datatype'>string</code> decode_qp(<code class='datatype'>string</code> <code class='argument'>encoded_data</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function decodes data encoded using the <tt>quoted-printable</tt> (a.k.a. quoted-unreadable) transfer encoding. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>MIME.encode_qp()</code>, <code>MIME.decode()</code>
autodoc.git/traditional_manual/chapter_21.html:27520: be used as such. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>MIME.decode_crypt64()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + encode_headerfield_params + </dt> + <dd><code><code class='datatype'>string</code> encode_headerfield_params(<code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>)|<code class='object unresolved'>ADT.OrderedMapping</code>) <code class='argument'>params</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Encodes the given key-value parameters as a string + according to e.g. <a href='http://pike.lysator.liu.se/rfc7239.xml#4'>RFC 7239 section 4</a>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>decode_headerfield_params</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method encode_qp </dt> <dd><code><code class='datatype'>string</code> encode_qp(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>no_linebreaks</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function encodes data using the <tt>quoted-printable</tt> (a.k.a. quoted-unreadable) transfer encoding. If a nonzero value is passed as <code>no_linebreaks</code>, the result string will not contain any linebreaks. </dd>

autodoc.git / traditional_manual / chapter_21.html