autodoc.git / traditional.xml

version» Context lines:

autodoc.git/traditional.xml:100197:    function. The total size of the program code is stored with index    <expr>0</expr>.</p>   </text></doc>   <method name='get_program_layout'>   <arguments><argument name='p'><type><program/></type></argument></arguments>   <returntype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></returntype>   </method>   </docgroup>   <docgroup homogen-name='globals' homogen-type='variable'><doc><text><p>Can be custom filled from within your program in order to    have global references to explore live datastructures using -  <ref resolved='predef::Debug.Peek'>Peek</ref>; comes preinitialised with the empty mapping, ready for use.</p> +  <ref resolved='predef::Debug.Inspect'>Inspect</ref>; comes preinitialised with the empty mapping, ready for use.</p>   </text></doc>   <variable name='globals'><type><mapping/></type></variable>   </docgroup>   <docgroup homogen-name='hexdump' homogen-type='method'><doc><text><p>Write a hexadecimal dump of the contents of <ref resolved='predef::Debug.hexdump.raw'>raw</ref> to <ref resolved='predef::Stdio.stderr'>Stdio.stderr</ref>.</p>   </text></doc>   <method name='hexdump'>   <arguments><argument name='raw'><type><string><min>0</min><max>255</max></string></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>
autodoc.git/traditional.xml:100409:   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='input'><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='input' homogen-type='variable'>   <variable name='input'><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type></variable>   </docgroup>   </class> - <class name='Peek'> + <class name='Inspect'>   <doc><text><p>Allows for interactive debugging and live data structure inspection    in both single- and multi-threaded programs. -  Creates an independent background thread that every <ref resolved='predef::Debug.Peek.pollinterval'>pollinterval</ref> +  Creates an independent background thread that every <ref resolved='predef::Debug.Inspect.pollinterval'>pollinterval</ref>    will show a list of running threads. -  Optionally, a <ref resolved='predef::Debug.Peek.triggersignal'>triggersignal</ref> can be specified which allows the dump to +  Optionally, a <ref resolved='predef::Debug.Inspect.triggersignal'>triggersignal</ref> can be specified which allows the dump to    be triggered by a signal.</p>   <p> Example:    In the program you'd like to inspect, insert the following one-liner:</p> - <code><text><p>Debug.Peek("/tmp/test.pike");</p> + <code><text><p>Debug.Inspect("/tmp/test.pike");</p>   </text></code><p>Then start the program and keep it running.    Next you create a /tmp/test.pike with the following content:</p>   <code><text><p>void create() {    werror("Only once per modification of test.pike\n");   }</p>   <p>int main() {    werror("This will run every iteration\n");    werror("By returning 1 here, we disable the stacktrace dumps\n");    return 0;   }</p>   <p>void destroy() {    werror("destroy() runs just as often as create()\n");   }</p>   </text></code><p>Whenever you edit /tmp/test.pike, it will automatically reload    the file.</p>   </text></doc>   <docgroup homogen-name='_callback' homogen-type='variable'><doc><text><p>Either the callback function which is invoked on each iteration, or the    name of a file which contains a class which is (re)compiled automatically    and called on each iteration.</p> - </text><group><seealso/><text><p><ref resolved='predef::Debug.Peek.create'>create</ref></p> + </text><group><seealso/><text><p><ref resolved='predef::Debug.Inspect.create'>create</ref></p>   </text></group></doc>   <variable name='_callback'><type><or><string/><function><argtype><void/></argtype><returntype><void/></returntype></function></or></type></variable>   </docgroup> - <docgroup homogen-name='_loopthread' homogen-type='variable'><doc><text><p>The peek-thread. It will not appear in the displayed thread-list.</p> + <docgroup homogen-name='_loopthread' homogen-type='variable'><doc><text><p>The inspect-thread. It will not appear in the displayed thread-list.</p>   </text></doc>   <variable name='_loopthread'><type><object resolved='predef::Thread.Thread'>Thread.Thread</object></type></variable>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Starts up the background thread.</p>   </text><group><param name='cb'/><text><p>Specifies either the callback function which is invoked on each iteration,    or the    name of a file which contains a class which is (re)compiled automatically    with an optional <expr>main()</expr> method, which will be called on each    iteration.    If the <expr>main()</expr> method returns 0, new stacktraces will be dumped    every iteration; if it returns 1, stacktrace dumping will be suppressed.</p>   </text></group><group><note/><text><p>The compilation and the running of the callback is guarded by    a catch(), so that failures (to compile) in that section will not    interfere with the running program.</p>   </text></group><group><note/><text><p>If the list of running threads did not change, displaying the list again    will be suppressed.</p> - </text></group><group><seealso/><text><p><ref resolved='predef::Debug.Peek.triggersignal'>triggersignal</ref>, <ref resolved='predef::Debug.Peek.pollinterval'>pollinterval</ref>, <ref resolved='predef::Debug.Peek._loopthread'>_loopthread</ref>, <ref resolved='predef::Debug.Peek._callback'>_callback</ref>, + </text></group><group><seealso/><text><p><ref resolved='predef::Debug.Inspect.triggersignal'>triggersignal</ref>, <ref resolved='predef::Debug.Inspect.pollinterval'>pollinterval</ref>, <ref resolved='predef::Debug.Inspect._loopthread'>_loopthread</ref>, <ref resolved='predef::Debug.Inspect._callback'>_callback</ref>,    <ref resolved='predef::Debug.globals'>Debug.globals</ref></p>   </text></group></doc>   <method name='create'>   <arguments><argument name='cb'><type><or><string/><function><argtype><void/></argtype><returntype><void/></returntype></function><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup> - <docgroup homogen-name='peek' homogen-type='method'><doc><text><p>The internal function which does all the work each pollinterval.</p> + <docgroup homogen-name='inspect' homogen-type='method'><doc><text><p>The internal function which does all the work each pollinterval.</p>   </text></doc> - <method name='peek'><modifiers><private/></modifiers> + <method name='inspect'><modifiers><private/></modifiers>   <arguments/>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='pollinterval' homogen-type='variable'><doc><text><p>The polling interval in seconds, defaults to 4.</p>   </text></doc>   <variable name='pollinterval'><type><int/></type></variable>   </docgroup> - <docgroup homogen-name='triggersignal' homogen-type='variable'><doc><text><p>If assigned to, it will allow the diagnostics peek to be triggered + <docgroup homogen-name='triggersignal' homogen-type='variable'><doc><text><p>If assigned to, it will allow the diagnostics inspection to be triggered    by this signal.</p>   </text></doc>   <variable name='triggersignal'><type><int/></type></variable>   </docgroup>   </class>   <module name='Profiling'>   <docgroup homogen-name='display' homogen-type='method'><doc><text><p>Show profiling information in a more-or-less readable manner.    This only works if pike has been compiled with profiling support.</p>   <p> The function will print to stderr using werror.</p>   <p> This is mainly here for use from the <ref>Debug.Watchdog</ref> class, if