{ $values { "seq" "a sequence" } { "quot" "a quotation with stack effect " { $snippet "( prev elt -- next )" } } { "final" "the final result" } { "newseq" "a new sequence" } }
{ $description "Combines successive elements of the sequence using a binary operation, and outputs a sequence of intermediate results together with the final result. On the first iteration, the two inputs to the quotation are " { $snippet "identity" } ", and the first element of the sequence. On successive iterations, the first input is the result of the previous iteration, and the second input is the corresponding element of the sequence. Given the empty sequence, outputs a one-element sequence consisting of " { $snippet "identity" } "." }
{ $examples
- { $example "{ 2 2 2 2 2 } 0 [ + ] accumulate . ." "{ 0 2 4 6 8 } 10" }
+ { $example "{ 2 2 2 2 2 } 0 [ + ] accumulate . ." "{ 0 2 4 6 8 }\n10" }
} ;
HELP: map
{ $description "Applies the relation to successive pairs of elements in the sequence, testing for a truth value. The relation should be a transitive relation, such as a total order or an equality relation." }
{ $examples
"Testing if a sequence is non-decreasing:"
- { $example "{ 1 1 2 } [ >= ] monotonic?" "t" }
+ { $example "{ 1 1 2 } [ >= ] monotonic? ." "t" }
"Testing if a sequence is decreasing:"
- { $example "{ 9 8 6 7 } [ < ] monotonic?" "f" }
+ { $example "{ 9 8 6 7 } [ < ] monotonic? ." "f" }
}
{ $see-also all-eq? all-equal? } ;
"\"nachos\" \"v\" get push-new"
"\"salsa\" \"v\" get push-new"
"\"v\" get ."
- "V{ \"beans\" \"cheese\" \"salsa\" \"nachos\" }"
+ "V{ \"beans\" \"cheese\" \"nachos\" \"salsa\" }"
}
}
{ $side-effects "seq" }
}
{ $errors "Throws a " { $link no-cond } " error if none of the test quotations yield a true value." }
{ $examples
- { $example
+ { $code
"{"
" { [ dup 0 > ] [ \"positive\" ] }"
" { [ dup 0 < ] [ \"negative\" ] }"
{ $values { "stack" "a sequence" } { "word" "a word" } { "newstack" "a sequence" } }
{ $description "Executes " { $snippet "word" } " with the given data stack contents, and outputs the new data stack after the word returns. Does not affect the data stack in surrounding code, other than consuming the two inputs and pushing the output." }
{ $examples
- { $example "{ 3 7 } \ + with-datastack ." "V{ 10 }" }
+ { $example "{ 3 7 } \\ + with-datastack ." "V{ 10 }" }
} ;
}
"You can define a word for invoking it:"
{ $example
- "LIBRARY: foo\nFUNCTION: the_answer ( char* question, int value ) ;\n\ the_answer compile\n\"the question\" 42 the-answer" "The answer to the question is 42."
+ "LIBRARY: foo\nFUNCTION: void the_answer ( char* question, int value ) ;\n\\ the_answer compile\n\"the question\" 42 the-answer" "The answer to the question is 42."
} }
{ $notes "Note that the parentheses and commas are only syntax sugar and can be omitted; they serve no purpose other than to make the declaration slightly easier to read:"
{ $code
2dup delegate-slots swap append "slots" set-word-prop
define-slots ;
-PREDICATE: class tuple-class tuple-size ;
+PREDICATE: class tuple-class tuple-size >boolean ;
TUPLE: check-tuple class ;
: check-tuple ( class -- class )
{ $values { "seq" "a sequence" } { "quot" "a quotation with stack effect " { $snippet "( elt -- )" } } }
{ $description "Applies the quotation to each element of the sequence, printing a comma between each pair of elements." }
{ $examples
- { $example "{ \"fish\" \"chips\" \"salt\" } [ write ] textual-list print" "fish, chips, salt" }
+ { $example "{ \"fish\" \"chips\" \"salt\" } [ write ] textual-list" "fish, chips, salt" }
} ;
HELP: $links
{ $description "Declares that the elements at the top of the stack are instances of the classes in " { $snippet "spec" } "." }
{ $warning "The compiler blindly trusts declarations, and false declarations can lead to crashes, memory corruption and other undesirable behavior." }
{ $examples
- "The optimizer cannot do anything with the below quotation:"
- { $example "[ 2 + 10 * ] f dataflow." "[ 2 + 10 * ]" }
+ "The optimizer cannot do anything with the below code as you can verify with " { $link "ui-dataflow" } ":"
+ { $code "2 + 10 *" }
"However, if we declare that the top of the stack is a " { $link float } ", then type checks and generic dispatch are eliminated, and the compiler can use unsafe intrinsics:"
- { $example "[ { float } declare 2 + 10 * ] f dataflow." "[ 2.0 float+ 10.0 float* ]" }
+ { $code "{ float } declare 2 + 10 *" }
} ;
HELP: array-capacity
{ $description "Outputs an object which evaluates to " { $snippet "obj" } " when placed in a quotation. If " { $snippet "obj" } " is not self-evaluating (for example, it is a word), then it will be wrapped." }
{ $examples
{ $example "5 literalize ." "5" }
- { $example "[ + ] [ litealize ] map ." "[ \\ + ]" }
+ { $example "[ + ] [ literalize ] map ." "[ \\ + ]" }
}
{ $see-also curry <wrapper> } ;
{ $syntax "\"string...\"" }
{ $values { "string" "literal and escaped characters" } }
{ $description "Reads from the input string until the next occurrence of " { $link POSTPONE: " } ", and appends the resulting string to the parse tree. String literals cannot span multiple lines. Strings containing the " { $link POSTPONE: " } " character and various other special characters can be read by inserting escape sequences." }
-{ $examples { $example "\"Hello\nworld\" print" "Hello\nworld" } } ;
+{ $examples { $example "\"Hello\\nworld\" print" "Hello\nworld" } } ;
HELP: SBUF"
{ $syntax "SBUF\" string... \"" }
IN: gadgets-outliners
USING: help gadgets gadgets-buttons kernel ;
-TUPLE: guide
+HELP: guide
{ $class-description "A class implementing the " { $link draw-interior } " generic word to draw a single vertical line." } ;
-TUPLE: outliner
+HELP: outliner
{ $class-description "A gadget with an expander arrow which can be clicked to show and hide a child gadget generated by the quotation stored in the " { $link outliner-quot } " slot. Outliners are created by calling " { $link <outliner> } "." }
{ $see-also <outliner> "presentations" } ;
projects / factor.git / commitdiff