Documentation updates
Slava Pestov
parent
a8160d74ad
commit
e1be77ee6f
|
|
@ -1,4 +1,4 @@
|
|||
USING: help.markup help.syntax ;
|
||||
USING: help.markup help.syntax help words definitions classes ;
|
||||
IN: classes.mixin
|
||||
|
||||
ARTICLE: "mixins" "Mixin classes"
|
||||
|
|
@ -11,4 +11,21 @@ ARTICLE: "mixins" "Mixin classes"
|
|||
{ $subsection mixin-class }
|
||||
{ $subsection mixin-class? } ;
|
||||
|
||||
HELP: mixin-class
|
||||
{ $class-description "The class of mixin classes." } ;
|
||||
|
||||
HELP: define-mixin-class
|
||||
{ $values { "class" word } }
|
||||
{ $description "Defines a mixin class. This is the run-time equivalent of " { $link POSTPONE: MIXIN: } "." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
|
||||
{ $side-effects "class" } ;
|
||||
|
||||
HELP: add-mixin-instance
|
||||
{ $values { "class" class } { "mixin" class } }
|
||||
{ $description "Defines a class to be an instance of a mixin class. This is the run-time equivalent of " { $link POSTPONE: INSTANCE: } "." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
|
||||
{ $side-effects "class" } ;
|
||||
|
||||
{ mixin-class define-mixin-class add-mixin-instance POSTPONE: MIXIN: POSTPONE: INSTANCE: } related-words
|
||||
|
||||
ABOUT: "mixins"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
USING: generic help.markup help.syntax kernel kernel.private
|
||||
namespaces sequences words arrays layouts help effects math
|
||||
layouts classes.private classes ;
|
||||
layouts classes.private classes definitions ;
|
||||
IN: classes.predicate
|
||||
|
||||
ARTICLE: "predicates" "Predicate classes"
|
||||
|
|
@ -15,7 +15,9 @@ ABOUT: "predicates"
|
|||
|
||||
HELP: define-predicate-class
|
||||
{ $values { "superclass" class } { "class" class } { "definition" "a quotation with stack effect " { $snippet "( superclass -- ? )" } } }
|
||||
{ $description "Defines a predicate class." } ;
|
||||
{ $description "Defines a predicate class. This is the run-time equivalent of " { $link POSTPONE: PREDICATE: } "." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
|
||||
{ $side-effects "class" } ;
|
||||
|
||||
{ predicate-class define-predicate-class POSTPONE: PREDICATE: } related-words
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
USING: generic help.markup help.syntax kernel kernel.private
|
||||
namespaces sequences words arrays layouts help effects math
|
||||
layouts classes.private classes ;
|
||||
layouts classes.private classes definitions ;
|
||||
IN: classes.union
|
||||
|
||||
ARTICLE: "unions" "Union classes"
|
||||
|
|
@ -17,7 +17,9 @@ ABOUT: "unions"
|
|||
|
||||
HELP: define-union-class
|
||||
{ $values { "class" class } { "members" "a sequence of classes" } }
|
||||
{ $description "Defines a union class with specified members." } ;
|
||||
{ $description "Defines a union class with specified members. This is the run-time equivalent of " { $link POSTPONE: UNION: } "." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
|
||||
{ $side-effects "class" } ;
|
||||
|
||||
{ union-class define-union-class POSTPONE: UNION: } related-words
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
USING: help.markup help.syntax words math ;
|
||||
USING: help.markup help.syntax words math source-files
|
||||
parser quotations ;
|
||||
IN: definitions
|
||||
|
||||
ARTICLE: "definition-protocol" "Definition protocol"
|
||||
|
|
@ -18,17 +19,66 @@ $nl
|
|||
{ $subsection definer }
|
||||
{ $subsection definition } ;
|
||||
|
||||
ARTICLE: "definitions" "Definitions"
|
||||
"A " { $emphasis "definition" } " is an artifact read from a source file. This includes words, methods, and help articles. Words for working with definitions are found in the " { $vocab-link "definitions" } " vocabulary."
|
||||
{ $subsection "definition-protocol" }
|
||||
ARTICLE: "definition-crossref" "Definition cross referencing"
|
||||
"A common cross-referencing system is used to track definition usages:"
|
||||
{ $subsection crossref }
|
||||
{ $subsection xref }
|
||||
{ $subsection unxref }
|
||||
{ $subsection delete-xref }
|
||||
{ $subsection usage }
|
||||
"Implementations of the definition protocol include pathnames, words, methods, and help articles."
|
||||
{ $see-also "source-files" "words" "generic" "help-impl" } ;
|
||||
{ $subsection usage } ;
|
||||
|
||||
ARTICLE: "definition-checking" "Definition sanity checking"
|
||||
"When a source file is reloaded, the parser compares the previous list of definitions with the current list; any definitions which are no longer present in the file are removed by a call to " { $link forget } ". A warning message is printed if any other definitions still depend on the removed definitions."
|
||||
$nl
|
||||
"The parser also catches forward references when reloading source files. This is best illustrated with an example. Suppose we load a source file " { $snippet "a.factor" } ":"
|
||||
{ $code
|
||||
"USING: io sequences ;"
|
||||
"IN: a"
|
||||
": hello \"Hello\" ;"
|
||||
": world \"world\" ;"
|
||||
": hello-world hello " " world 3append print ;"
|
||||
}
|
||||
"The definitions for " { $snippet "hello" } ", " { $snippet "world" } ", and " { $snippet "hello-world" } " are in the dictionary."
|
||||
$nl
|
||||
"Now, after some heavily editing and refactoring, the file looks like this:"
|
||||
{ $code
|
||||
"USING: namespaces ;"
|
||||
"IN: a"
|
||||
": hello \"Hello\" % ;"
|
||||
": hello-world [ hello " " % world ] \"\" make ;"
|
||||
": world \"world\" % ;"
|
||||
}
|
||||
"Note that the developer has made a mistake, placing the definition of " { $snippet "world" } " " { $emphasis "after" } " its usage in " { $snippet "hello-world" } "."
|
||||
$nl
|
||||
"If the parser did not have special checks for this case, then the modified source file would still load, because when the definition of " { $snippet "hello-world" } " on line 4 is being parsed, the " { $snippet "world" } " word is already present in the dictionary from an earlier run. The developer would then not discover this mistake until attempting to load the source file into a fresh image."
|
||||
$nl
|
||||
"Since this is undesirable, the parser explicitly raises an error if a source file refers to a word which is in the dictionary, but defined after it is used."
|
||||
{ $subsection forward-error }
|
||||
"If a source file raises a " { $link forward-error } " when loaded into a development image, then it would have raised a " { $link no-word } " error when loaded into a fresh image."
|
||||
$nl
|
||||
"The parser also catches duplicate definitions. If an artifact is defined twice in the same source file, the earlier definition will never be accessible, and this is almost always a mistake, perhaps due to a bad choice of word names, or a copy and paste error. The parser raises an error in this case."
|
||||
{ $subsection redefine-error } ;
|
||||
|
||||
ARTICLE: "compilation-units" "Compilation units"
|
||||
"A " { $emphasis "compilation unit" } " scopes a group of related definitions. They are compiled and entered into the system in one atomic operation."
|
||||
$nl
|
||||
"The parser groups all definitions in a source file into one compilation unit, and parsing words do not need to concern themselves with compilation units. However, if definitions are being created at run-time, a compilation unit must be created explicitly:"
|
||||
{ $subsection with-compilation-unit }
|
||||
"Words called to associate a definition with a source file location:"
|
||||
{ $subsection remember-definition }
|
||||
{ $subsection remember-class }
|
||||
"Forward reference checking (see " { $link "definition-checking" } "):"
|
||||
{ $subsection forward-reference? }
|
||||
"A hook to be called at the end of the compilation unit. If the optimizing compiler is loaded, this compiles new words with the " { $link "compiler" } ":"
|
||||
{ $subsection recompile-hook } ;
|
||||
|
||||
ARTICLE: "definitions" "Definitions"
|
||||
"A " { $emphasis "definition" } " is an artifact read from a source file. This includes words, methods, and help articles. Words for working with definitions are found in the " { $vocab-link "definitions" } " vocabulary. Implementations of the definition protocol include pathnames, words, methods, and help articles."
|
||||
{ $subsection "definition-protocol" }
|
||||
{ $subsection "definition-crossref" }
|
||||
{ $subsection "definition-checking" }
|
||||
{ $subsection "compilation-units" }
|
||||
{ $see-also "parser" "source-files" "words" "generic" "help-impl" } ;
|
||||
|
||||
ABOUT: "definitions"
|
||||
|
||||
|
|
@ -43,7 +93,13 @@ HELP: set-where
|
|||
|
||||
HELP: forget
|
||||
{ $values { "defspec" "a definition specifier" } }
|
||||
{ $description "Forgets about a definition. For example, if it is a word, it will be removed from its vocabulary." } ;
|
||||
{ $description "Forgets about a definition. For example, if it is a word, it will be removed from its vocabulary." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." } ;
|
||||
|
||||
HELP: forget-all
|
||||
{ $values { "definitions" "a sequence of definition specifiers" } }
|
||||
{ $description "Forgets every definition in a sequence." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." } ;
|
||||
|
||||
HELP: uses
|
||||
{ $values { "defspec" "a definition specifier" } { "seq" "a sequence of definition specifiers" } }
|
||||
|
|
@ -104,3 +160,11 @@ HELP: forward-error
|
|||
{ $values { "word" word } }
|
||||
{ $description "Throws a " { $link forward-error } "." }
|
||||
{ $description "Indicates a word is being referenced prior to the location of its most recent definition. This can only happen if a source file is loaded, and subsequently edited such that two dependent definitions are reversed." } ;
|
||||
|
||||
HELP: with-compilation-unit
|
||||
{ $values { "quot" quotation } }
|
||||
{ $description "Calls a quotation in a new compilation unit. The quotation can define new words and classes, as well as forget words. When the quotation returns, any changed words are recompiled and applied atomically." }
|
||||
{ $notes "Compilation units may be nested. The parser wraps every source file in a compilation unit, so parsing words may define new words without having to perform extra work; to define new words at any other time, you must wrap your defining code with this combinator." } ;
|
||||
|
||||
HELP: recompile-hook
|
||||
{ $var-description "Quotation with stack effect " { $snippet "( words -- )" } ", called at the end of " { $link with-compilation-unit } "." } ;
|
||||
|
|
|
|||
|
|
@ -81,7 +81,17 @@ SYMBOL: recompile-hook
|
|||
|
||||
: <definitions> ( -- pair ) { H{ } H{ } } [ clone ] map ;
|
||||
|
||||
: with-compilation-unit ( quot -- new-defs )
|
||||
TUPLE: no-compilation-unit word ;
|
||||
|
||||
: no-compilation-unit ( word -- * )
|
||||
\ no-compilation-unit construct-boa throw ;
|
||||
|
||||
: changed-word ( word -- )
|
||||
dup changed-words get
|
||||
[ no-compilation-unit ] unless*
|
||||
set-at ;
|
||||
|
||||
: with-compilation-unit ( quot -- )
|
||||
[
|
||||
H{ } clone changed-words set
|
||||
<definitions> new-definitions set
|
||||
|
|
|
|||
|
|
@ -13,9 +13,7 @@ $nl
|
|||
{ $subsection define-if-intrinsic }
|
||||
{ $subsection define-if-intrinsics }
|
||||
"The main entry point into the code generator:"
|
||||
{ $subsection generate }
|
||||
"Primitive compiler interface exported by the Factor VM:"
|
||||
{ $subsection modify-code-heap } ;
|
||||
{ $subsection generate } ;
|
||||
|
||||
ABOUT: "generator"
|
||||
|
||||
|
|
|
|||
|
|
@ -564,7 +564,3 @@ $nl
|
|||
"[ P ] [ Q ] [ ] while T"
|
||||
}
|
||||
"However, depending on the stack effects of " { $snippet "pred" } " and " { $snippet "quot" } ", the " { $snippet "tail" } " quotation might need to be non-empty in order to balance out the stack effect of branches for stack effect inference." } ;
|
||||
|
||||
HELP: modify-code-heap ( array -- )
|
||||
{ $values { "array" "an array of 6-element arrays having shape " { $snippet "{ word code labels rel words literals }" } } }
|
||||
{ $description "Stores compiled code definitions in the code heap and updates words to point at those definitions." } ;
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ $nl
|
|||
"The following variables can be rebound inside a nested scope to customize the behavior of a listener; this can be done to create a development tool with a custom interaction loop:"
|
||||
{ $subsection listener-hook }
|
||||
"Finally, the multi-line expression reading word can be used independently of the rest of the listener:"
|
||||
{ $subsection parse-interactive } ;
|
||||
{ $subsection read-quot } ;
|
||||
|
||||
ABOUT: "listener"
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ HELP: quit-flag
|
|||
HELP: listener-hook
|
||||
{ $var-description "Variable holding a quotation called by the listener before reading an input expression. The UI sets this variable to a quotation which updates the stack display in a listener gadget." } ;
|
||||
|
||||
HELP: parse-interactive
|
||||
HELP: read-quot
|
||||
{ $values { "stream" "an input stream" } { "quot/f" "a parsed quotation, or " { $link f } " indicating end of file" } }
|
||||
{ $description "Reads a Factor expression from the stream, possibly spanning more than line. Additional lines of input are read while the parser stack height is greater than one. Since structural parsing words push partial quotations on the stack, this will keep on reading input until all delimited parsing words are terminated." } ;
|
||||
|
||||
|
|
|
|||
|
|
@ -154,44 +154,11 @@ ARTICLE: "parser-files" "Parsing source files"
|
|||
{ $subsection parse-file }
|
||||
{ $subsection bootstrap-file }
|
||||
"The parser cross-references source files and definitions. This allows it to keep track of removed definitions, and prevent forward references and accidental redefinitions."
|
||||
$nl
|
||||
"When a source file is reloaded, the parser compares the previous list of definitions with the current list; any definitions which are no longer present in the file are removed by a call to " { $link forget } ". A warning message is printed if any other definitions still depend on the removed definitions."
|
||||
$nl
|
||||
"The parser also catches forward references when reloading source files. This is best illustrated with an example. Suppose we load a source file " { $snippet "a.factor" } ":"
|
||||
{ $code
|
||||
"USING: io sequences ;"
|
||||
"IN: a"
|
||||
": hello \"Hello\" ;"
|
||||
": world \"world\" ;"
|
||||
": hello-world hello " " world 3append print ;"
|
||||
}
|
||||
"The definitions for " { $snippet "hello" } ", " { $snippet "world" } ", and " { $snippet "hello-world" } " are in the dictionary."
|
||||
$nl
|
||||
"Now, after some heavily editing and refactoring, the file looks like this:"
|
||||
{ $code
|
||||
"USING: namespaces ;"
|
||||
"IN: a"
|
||||
": hello \"Hello\" % ;"
|
||||
": hello-world [ hello " " % world ] \"\" make ;"
|
||||
": world \"world\" % ;"
|
||||
}
|
||||
"Note that the developer has made a mistake, placing the definition of " { $snippet "world" } " " { $emphasis "after" } " its usage in " { $snippet "hello-world" } "."
|
||||
$nl
|
||||
"If the parser did not have special checks for this case, then the modified source file would still load, because when the definition of " { $snippet "hello-world" } " on line 4 is being parsed, the " { $snippet "world" } " word is already present in the dictionary from an earlier run. The developer would then not discover this mistake until attempting to load the source file into a fresh image."
|
||||
$nl
|
||||
"Since this is undesirable, the parser explicitly raises an error if a source file refers to a word which is in the dictionary, but defined after it is used."
|
||||
{ $subsection forward-error }
|
||||
"If a source file raises a " { $link forward-error } " when loaded into a development image, then it would have raised a " { $link no-word } " error when loaded into a fresh image."
|
||||
$nl
|
||||
"The parser also catches duplicate definitions. If an artifact is defined twice in the same source file, the earlier definition will never be accessible, and this is almost always a mistake, perhaps due to a bad choice of word names, or a copy and paste error. The parser raises an error in this case."
|
||||
{ $subsection redefine-error }
|
||||
{ $see-also "source-files" } ;
|
||||
|
||||
ARTICLE: "parser-usage" "Reflective parser usage"
|
||||
"The parser can be called on a string:"
|
||||
{ $subsection eval }
|
||||
{ $subsection parse }
|
||||
{ $subsection parse-fresh }
|
||||
"The parser can also parse from a stream:"
|
||||
{ $subsection parse-stream } ;
|
||||
|
||||
|
|
@ -204,7 +171,8 @@ $nl
|
|||
{ $subsection "parser-usage" }
|
||||
"The parser can be extended."
|
||||
{ $subsection "parsing-words" }
|
||||
{ $subsection "parser-lexer" } ;
|
||||
{ $subsection "parser-lexer" }
|
||||
{ $see-also "definitions" "definition-checking" } ;
|
||||
|
||||
ABOUT: "parser"
|
||||
|
||||
|
|
@ -327,7 +295,7 @@ HELP: still-parsing?
|
|||
HELP: use
|
||||
{ $var-description "A variable holding the current vocabulary search path as a sequence of assocs." } ;
|
||||
|
||||
{ use in use+ (use+) set-use set-in POSTPONE: USING: POSTPONE: USE: with-with-default-vocabs } related-words
|
||||
{ use in use+ (use+) set-use set-in POSTPONE: USING: POSTPONE: USE: with-file-vocabs with-interactive-vocabs } related-words
|
||||
|
||||
HELP: in
|
||||
{ $var-description "A variable holding the name of the current vocabulary for new definitions." } ;
|
||||
|
|
@ -465,7 +433,7 @@ $parsing-note ;
|
|||
HELP: parse-literal
|
||||
{ $values { "accum" vector } { "end" word } { "quot" "a quotation with stack effect " { $snippet "( seq -- obj )" } } }
|
||||
{ $description "Parses objects from parser input until " { $snippet "end" } ", applies the quotation to the resulting sequence, and adds the output value to the accumulator." }
|
||||
{ $examples "This word is used to implement " { $link POSTPONE: C{ } "." }
|
||||
{ $examples "This word is used to implement " { $link POSTPONE: [ } "." }
|
||||
$parsing-note ;
|
||||
|
||||
HELP: parse-definition
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
USING: generic help.markup help.syntax kernel
|
||||
tuples.private classes slots quotations words arrays
|
||||
generic.standard sequences ;
|
||||
generic.standard sequences definitions ;
|
||||
IN: tuples
|
||||
|
||||
ARTICLE: "tuple-constructors" "Constructors and slots"
|
||||
|
|
@ -144,7 +144,9 @@ HELP: check-tuple
|
|||
|
||||
HELP: define-tuple-class
|
||||
{ $values { "class" word } { "slots" "a sequence of strings" } }
|
||||
{ $description "Defines a tuple class with slots named by " { $snippet "slots" } "." } ;
|
||||
{ $description "Defines a tuple class with slots named by " { $snippet "slots" } ". This is the run-time equivalent of " { $link POSTPONE: TUPLE: } "." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
|
||||
{ $side-effects "class" } ;
|
||||
|
||||
{ tuple-class define-tuple-class POSTPONE: TUPLE: } related-words
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ $nl
|
|||
"Parsing words add definitions to the current vocabulary. When a source file is being parsed, the current vocabulary is initially set to " { $vocab-link "scratchpad" } ". The current vocabulary may be changed with the " { $link POSTPONE: IN: } " parsing word (see " { $link "vocabulary-search" } ")."
|
||||
{ $subsection create }
|
||||
{ $subsection create-in }
|
||||
{ $subsection gensym }
|
||||
{ $subsection lookup }
|
||||
"Words can output their name and vocabulary:"
|
||||
{ $subsection word-name }
|
||||
|
|
@ -19,6 +18,14 @@ $nl
|
|||
"Testing if a word object is part of a vocabulary:"
|
||||
{ $subsection interned? } ;
|
||||
|
||||
ARTICLE: "uninterned-words" "Uninterned words"
|
||||
"A word that is not a member of any vocabulary is said to be " { $emphasis "uninterned" } "."
|
||||
$nl
|
||||
"There are several ways of creating an uninterned word:"
|
||||
{ $subsection <word> }
|
||||
{ $subsection gensym }
|
||||
{ $subsection define-temp } ;
|
||||
|
||||
ARTICLE: "colon-definition" "Compound definitions"
|
||||
"A compound definition associates a word name with a quotation that is called when the word is executed."
|
||||
{ $subsection compound }
|
||||
|
|
@ -143,7 +150,9 @@ ARTICLE: "word.private" "Word implementation details"
|
|||
{ $subsection word-def }
|
||||
{ $subsection set-word-def }
|
||||
"An " { $emphasis "XT" } " (execution token) is the machine code address of a word:"
|
||||
{ $subsection word-xt } ;
|
||||
{ $subsection word-xt }
|
||||
"Low-level compiler interface exported by the Factor VM:"
|
||||
{ $subsection modify-code-heap } ;
|
||||
|
||||
ARTICLE: "words" "Words"
|
||||
"Words are the Factor equivalent of functions or procedures; a word is a body of code with a unique name and some additional meta-data. Words are defined in the " { $vocab-link "words" } " vocabulary."
|
||||
|
|
@ -159,6 +168,7 @@ $nl
|
|||
{ $subsection word }
|
||||
{ $subsection word? }
|
||||
{ $subsection "interned-words" }
|
||||
{ $subsection "uninterned-words" }
|
||||
{ $subsection "word-definition" }
|
||||
{ $subsection "word-props" }
|
||||
{ $subsection "word.private" }
|
||||
|
|
@ -238,12 +248,14 @@ $low-level-note
|
|||
|
||||
HELP: define-symbol
|
||||
{ $values { "word" word } }
|
||||
{ $description "Defines the word to push itself on the stack when executed." }
|
||||
{ $description "Defines the word to push itself on the stack when executed. This is the run-time equivalent of " { $link POSTPONE: SYMBOL: } "." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
|
||||
{ $side-effects "word" } ;
|
||||
|
||||
HELP: define-compound
|
||||
{ $values { "word" word } { "def" quotation } }
|
||||
{ $description "Defines the word to call a quotation when executed." }
|
||||
{ $description "Defines the word to call a quotation when executed. This is the run-time equivalent of " { $link POSTPONE: : } "." }
|
||||
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
|
||||
{ $side-effects "word" } ;
|
||||
|
||||
HELP: reset-props
|
||||
|
|
@ -340,6 +352,7 @@ HELP: define-temp
|
|||
"The following phrases are equivalent:"
|
||||
{ $code "[ 2 2 + . ] call" }
|
||||
{ $code "[ 2 2 + . ] define-temp execute" }
|
||||
"This word must be called from inside " { $link with-compilation-unit } "."
|
||||
} ;
|
||||
|
||||
HELP: quot-uses
|
||||
|
|
@ -382,3 +395,12 @@ HELP: define-inline
|
|||
{ $values { "word" word } { "quot" quotation } }
|
||||
{ $description "Defines a compound word and makes it " { $link POSTPONE: inline } "." }
|
||||
{ $side-effects "word" } ;
|
||||
|
||||
HELP: modify-code-heap ( alist -- )
|
||||
{ $values { "alist" "an alist" } }
|
||||
{ $description "Stores compiled code definitions in the code heap. The alist maps words to the following:"
|
||||
{ $list
|
||||
{ { $link f } " - in this case, the word is compiled with the non-optimizing compiler part of the VM." }
|
||||
{ { $snippet "{ code labels rel words literals profiler-prologue }" } " - in this case, a code heap block is allocated with the given data." }
|
||||
} }
|
||||
{ $notes "This word is called at the end of " { $link with-compilation-unit } "." } ;
|
||||
|
|
|
|||
|
|
@ -127,6 +127,7 @@ PRIVATE>
|
|||
|
||||
: reset-word ( word -- )
|
||||
{
|
||||
"unannotated-def"
|
||||
"parsing" "inline" "foldable"
|
||||
"predicating"
|
||||
"reading" "writing"
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
USING: help.markup help.crossref help.topics help.syntax
|
||||
definitions io prettyprint inspector help.lint arrays math ;
|
||||
definitions io prettyprint inspector arrays math ;
|
||||
IN: help
|
||||
|
||||
ARTICLE: "printing-elements" "Printing markup elements"
|
||||
|
|
@ -160,3 +160,5 @@ HELP: sort-articles
|
|||
HELP: $predicate
|
||||
{ $values { "element" "a markup element of the form " { $snippet "{ word }" } } }
|
||||
{ $description "Prints the boilerplate description of a class membership predicate word such as " { $link array? } " or " { $link integer? } "." } ;
|
||||
|
||||
USE: help.lint
|
||||
|
|
|
|||
|
|
@ -4,8 +4,6 @@ USING: kernel words parser io inspector quotations sequences
|
|||
prettyprint continuations effects definitions ;
|
||||
IN: tools.annotations
|
||||
|
||||
<PRIVATE
|
||||
|
||||
: check-compound ( word -- )
|
||||
compound? [
|
||||
"Annotations can only be used with compound words" throw
|
||||
|
|
@ -17,6 +15,7 @@ IN: tools.annotations
|
|||
|
||||
: annotate ( word quot -- )
|
||||
over check-compound
|
||||
over dup word-def "unannotated-def" set-word-prop
|
||||
[
|
||||
>r dup word-def r> call define-compound
|
||||
] with-compilation-unit ; inline
|
||||
|
|
@ -42,8 +41,6 @@ IN: tools.annotations
|
|||
rot [ leaving ] curry
|
||||
swapd 3append ;
|
||||
|
||||
PRIVATE>
|
||||
|
||||
: watch ( word -- )
|
||||
dup [ (watch) ] annotate ;
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue