basis/debugger/debugger-docs.factor

   1 USING: alien arrays generic generic.math help.markup help.syntax
   2 kernel math memory strings sbufs vectors io io.files classes
   3 help generic.standard continuations system debugger.private
   4 io.files.private listener ;
   5 IN: debugger
   6
   7 ARTICLE: "debugger" "The debugger"
   8 "Caught errors can be logged in human-readable form:"
   9 { $subsection print-error }
  10 { $subsection try }
  11 "User-defined errors can have customized printed representation by implementing a generic word:"
  12 { $subsection error. }
  13 "A number of words facilitate interactive debugging of errors:"
  14 { $subsection :s }
  15 { $subsection :r }
  16 { $subsection :c }
  17 { $subsection :get }
  18 "Most types of errors are documented, and the documentation is instantly accessible:"
  19 { $subsection :help }
  20 "If the error was restartable, a list of restarts is also printed, and a numbered restart can be invoked:"
  21 { $subsection :1 }
  22 { $subsection :2 }
  23 { $subsection :3 }
  24 { $subsection :res }
  25 "Assertions:"
  26 { $subsection "errors-assert" }
  27 "You can read more about error handling in " { $link "errors" } "." ;
  28
  29 ABOUT: "debugger"
  30
  31 HELP: :s
  32 { $description "Prints the data stack at the time of the most recent error. Used for interactive debugging." } ;
  33
  34 HELP: :r
  35 { $description "Prints the retain stack at the time of the most recent error. Used for interactive debugging." } ;
  36
  37 HELP: :c
  38 { $description "Prints the call stack at the time of the most recent error. Used for interactive debugging." } ;
  39
  40 HELP: :get
  41 { $values { "variable" "an object" } { "value" "the value, or f" } }
  42 { $description "Looks up the value of a variable at the time of the most recent error." } ;
  43
  44 HELP: :res
  45 { $values { "n" "a positive integer" } }
  46 { $description "Continues executing the " { $snippet "n" } "th restart. Since restarts may only be invoked once, this resets the " { $link restarts } " global variable." } ;
  47
  48 HELP: :1
  49 { $description "A shortcut for invoking the first restart." } ;
  50
  51 HELP: :2
  52 { $description "A shortcut for invoking the second restart." } ;
  53
  54 HELP: :3
  55 { $description "A shortcut for invoking the third restart." } ;
  56
  57 HELP: error.
  58 { $values { "error" "an error" } }
  59 { $contract "Print an error to " { $link output-stream } ". You can define methods on this generic word to print human-readable messages for custom errors." }
  60 { $notes "Code should call " { $link print-error } " instead, which handles the case where the printing of the error itself throws an error." } ;
  61
  62 HELP: error-help
  63 { $values { "error" "an error" } { "topic" "an article name or word" } }
  64 { $contract "Outputs a help article which explains the error." } ;
  65
  66 { error-help :help } related-words
  67
  68 HELP: print-error
  69 { $values { "error" "an error" } }
  70 { $description "Print an error to " { $link output-stream } "." }
  71 { $notes "This word is called by the listener and other tools which report caught errors to the user." } ;
  72
  73 HELP: restarts.
  74 { $description "Print a list of restarts for the most recently thrown error to " { $link output-stream } "." } ;
  75
  76 HELP: try
  77 { $values { "quot" "a quotation" } }
  78 { $description "Attempts to call a quotation; if it throws an error, the error is printed to " { $link output-stream } ", stacks are restored, and execution continues after the call to " { $link try } "." }
  79 { $examples
  80     "The following example prints an error and keeps going:"
  81     { $code
  82         "[ \"error\" throw ] try"
  83         "\"still running...\" print"
  84     }
  85     { $link "listener" } " uses " { $link try } " to recover from user errors."
  86 } ;
  87
  88 HELP: expired-error.
  89 { $error-description "Thrown by " { $link alien-address } " and " { $link alien-invoke } " if an " { $link alien } " object passed in as a parameter has expired. Alien objects expire if they are saved an image which is subsequently loaded; this prevents a certain class of programming errors, usually attempts to use uninitialized objects, since holding a C address is meaningless between sessions." }
  90 { $notes "You can check if an alien object has expired by calling " { $link expired? } "." } ;
  91
  92 HELP: io-error.
  93 { $error-description "Thrown by the C streams I/O primitives if an I/O error occurs." } ;
  94
  95 HELP: type-check-error.
  96 { $error-description "Thrown by various primitives if one of the inputs does not have the expected type. Generic words throw " { $link no-method } " and " { $link no-math-method } " errors in such cases instead." } ;
  97
  98 HELP: divide-by-zero-error.
  99 { $error-description "This error is thrown when " { $link / } " or " { $link /i } " is called with with a zero denominator." }
 100 { $see-also "division-by-zero" } ;
 101
 102 HELP: signal-error.
 103 { $error-description
 104     "Thrown by the Factor VM when a Unix signal is received. While signal numbers are system-specific, the following are relatively standard:"
 105     { $list
 106         { "4 - Illegal instruction. If you see this error, it is a bug in Factor's compiler and should be reported." }
 107         { "8 - Arithmetic exception. Most likely a divide by zero in " { $link /i } "." }
 108         { "10, 11 - Memory protection fault. This error suggests invalid values are being passed to C functions by an " { $link alien-invoke } ". Factor also uses memory protection to trap stack underflows and overflows, but usually these are reported as their own errors. Sometimes they'll show up as a generic signal 11, though." }
 109     }
 110     "The Windows equivalent of a signal 11 is a SEH fault. When one occurs, the runtime throws a singal error, even though it does not correspond to a Unix signal."
 111 } ;
 112
 113 HELP: array-size-error.
 114 { $error-description "Thrown by " { $link <array> } ", " { $link <string> } ", " { $link <vector> } " and " { $link <sbuf> } " if the specified capacity is negative or too large." } ;
 115
 116 HELP: c-string-error.
 117 { $error-description "Thrown by " { $link alien-invoke } " and various primitives if a string containing null bytes, or characters with values higher than 255 is passed in where a C string is expected. See " { $link "c-strings" } "." } ;
 118
 119 HELP: ffi-error.
 120 { $error-description "Thrown by " { $link dlopen } " and " { $link dlsym } " if a problem occurs while loading a native library or looking up a symbol. See " { $link "alien" } "." } ;
 121
 122 HELP: heap-scan-error.
 123 { $error-description "Thrown if " { $link next-object } " is called outside of a " { $link begin-scan } "/" { $link end-scan } " pair." } ;
 124
 125 HELP: undefined-symbol-error.
 126 { $error-description "Thrown if a previously-compiled " { $link alien-invoke } " call refers to a native library symbol which no longer exists." } ;
 127
 128 HELP: datastack-underflow.
 129 { $error-description "Thrown by the Factor VM if an attempt is made to pop elements from an empty data stack." }
 130 { $notes "You can use the stack effect tool to statically check stack effects of quotations. See " { $link "inference" } "." } ;
 131
 132 HELP: datastack-overflow.
 133 { $error-description "Thrown by the Factor VM if an attempt is made to push elements on a full data stack." }
 134 { $notes "This error usually indicates a run-away recursion, however if you legitimately need a data stack larger than the default, see " { $link "runtime-cli-args" } "." } ;
 135
 136 HELP: retainstack-underflow.
 137 { $error-description "Thrown by the Factor VM if " { $link r> } " is called while the retain stack is empty." }
 138 { $notes "You can use the stack effect tool to statically check stack effects of quotations. See " { $link "inference" } "." } ;
 139
 140 HELP: retainstack-overflow.
 141 { $error-description "Thrown by the Factor VM if " { $link >r } " is called when the retain stack is full." }
 142 { $notes "This error usually indicates a run-away recursion, however if you legitimately need a retain stack larger than the default, see " { $link "runtime-cli-args" } "." } ;
 143
 144 HELP: memory-error.
 145 { $error-description "Thrown by the Factor VM if an invalid memory access occurs." }
 146 { $notes "This can be a result of incorrect usage of C library interface words, a bug in the compiler, or a bug in the VM." } ;
 147
 148 HELP: primitive-error.
 149 { $error-description "Thrown by the Factor VM if an unsupported primitive word is called." }
 150 { $notes "This word is only ever thrown on Windows CE, where the " { $link cwd } ", " { $link cd } ", and " { $link os-env } " primitives are unsupported." } ;