steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

listener-docs: document the Ctrl-Break handler support

char-rename
Alexander Iljin 2016-11-02 00:12:10 +03:00 committed by John Benediktsson
parent 35a1ae61c3
commit 1156ea3d8b
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
basis/listener/listener-docs.factor
View File

@ -1,5 +1,5 @@
USING: help.markup help.syntax kernel io system prettyprint USING: continuations help.markup help.syntax io kernel parser
continuations quotations vocabs parser vocabs.loader ; prettyprint quotations system threads vocabs vocabs.loader ;
IN: listener IN: listener
ARTICLE: "listener-watch" "Watching variables in the listener" ARTICLE: "listener-watch" "Watching variables in the listener"
@ -62,6 +62,12 @@ $nl
{ $example "{ 1 2 3 } [\n .\n] each" "1\n2\n3" } { $example "{ 1 2 3 } [\n .\n] each" "1\n2\n3" }
"The listener will display the current contents of the datastack after every line of input." "The listener will display the current contents of the datastack after every line of input."
$nl $nl
"If your code runs too long, you can press C-Break to interrupt it (works only on Windows). To enable this feature, run the following code, or add it to your " { $link ".factor-rc" } ":"
{ $code
"USING: listener namespaces ;"
"t handle-ctrl-break set-global"
}
$nl
"The listener can watch dynamic variables:" "The listener can watch dynamic variables:"
{ $subsections "listener-watch" } { $subsections "listener-watch" }
"Nested listeners can be useful for testing code in other dynamic scopes. For example, when doing database maintenance using the " { $vocab-link "db.tuples" } " vocabulary, it can be useful to start a listener with a database connection:" "Nested listeners can be useful for testing code in other dynamic scopes. For example, when doing database maintenance using the " { $vocab-link "db.tuples" } " vocabulary, it can be useful to start a listener with a database connection:"
@ -76,6 +82,12 @@ $nl
"The listener's mechanism for reading multi-line expressions from the input stream can be called from user code:" "The listener's mechanism for reading multi-line expressions from the input stream can be called from user code:"
{ $subsections read-quot } ; { $subsections read-quot } ;
HELP: handle-ctrl-break
{ $description "If this variable is " { $link t } ", the listener will wrap the user code with calls to " { $link enable-ctrl-break } " and " { $link disable-ctrl-break } " to make it interruptible with C-Break. This includes both compilation and execution phases, so circular vocab import can be interrupted as well as infinite loops."
$nl
"This only works on Windows, and has no effect on other platforms."
{ $warning "If user code " { $link yield } "s or gets stuck on an asynchronous I/O operation, pressing C-Break will most likely crash the Factor VM." } } ;
ABOUT: "listener" ABOUT: "listener"
HELP: read-quot HELP: read-quot