HELP: align
{ $values { "n" integer } { "bitstream" bit-reader } }
-{ $description "Moves the read cursor of the bit-reader forward until its position in bits from the start of the stream is an even multiple of n. If it is already such a multiple, the cursor is not moved at all. " } ;
+{ $description "Moves the read cursor of the bit-reader forward until its position in bits from the start of the stream is an even multiple of n. If it is already such a multiple, the cursor is not moved at all." } ;
HELP: enough-bits?
{ $values { "n" integer } { "bs" bit-reader } { "?" boolean } }
HELP: emit-node
{ $values { "block" basic-block } { "node" node } { "block'" basic-block } }
-{ $description "Emits CFG instructions for the given SSA node. The word can add one or more basic blocks to the " { $link cfg } ". The next block to operate on is pushed onto the stack. "
+{ $description "Emits CFG instructions for the given SSA node. The word can add one or more basic blocks to the " { $link cfg } ". The next block to operate on is pushed onto the stack."
$nl
"The following classes emit-node methods does not change the current block:"
{ $list
{ $table
{
{ $slot "number" }
- { "The blocks sequence number. Generated by calling " { $link number-blocks } ". " }
+ { "The blocks sequence number. Generated by calling " { $link number-blocks } "." }
}
{
{ $slot "successors" }
{ "test" quotation }
{ "block'" basic-block }
}
-{ $description "Combinator used to simplify writing intrinsic emitting code. If the 'test' quotation yields " { $link t } " when called on the '#call' nodes inputs, then the 'quot' quotation is used to emit intrinsic instructions. Otherwise a primitive call is emitted. " } ;
+{ $description "Combinator used to simplify writing intrinsic emitting code. If the 'test' quotation yields " { $link t } " when called on the '#call' nodes inputs, then the 'quot' quotation is used to emit intrinsic instructions. Otherwise a primitive call is emitted." } ;
{ $see-also alien-invoke } ;
HELP: #alien-callback
-{ $class-description "SSA tree node that constructs an alien callback. It is not a subclass of " { $link #alien-node } ". " } ;
+{ $class-description "SSA tree node that constructs an alien callback. It is not a subclass of " { $link #alien-node } "." } ;
HELP: #call
{ $class-description "SSA tree node that calls a word. It has the following slots:"
{ $values
{ "lzw" lzw }
}
-{ $description "Reset the LZW uncompressor state (either at initialization time or immediately after receiving a Clear Code). " } ;
+{ $description "Reset the LZW uncompressor state (either at initialization time or immediately after receiving a Clear Code)." } ;
ARTICLE: "compression.lzw.differences" "LZW differences between TIFF and GIF"
{ $vocab-link "compression.lzw" }
HELP: %prepare-var-args
{ $values { "reg-inputs" sequence } }
-{ $description "Emits code needed for calling variadic functions. On " { $link unix } " " { $link x86.64 } ", the " { $link AL } " register must contain the number of float registers used. " } ;
+{ $description "Emits code needed for calling variadic functions. On " { $link unix } " " { $link x86.64 } ", the " { $link AL } " register must contain the number of float registers used." } ;
HELP: JLE
{ $values { "dst" "destination offset (relative to the instruction pointer register)" } }
"Let's make a tuple and store it in a database. To follow along, click on each code example and run it in the listener. If you forget to run an example, just start at the top and run them all again in order." $nl
"We're going to store books in this tutorial."
{ $code "TUPLE: book id title author date-published edition cover-price condition ;" }
-"The title, author, and publisher should be strings; the date-published a timestamp; the edition an integer; the cover-price a float. These are the Factor types for which we will need to look up the corresponding " { $link "db.types" } ". " $nl
+"The title, author, and publisher should be strings; the date-published a timestamp; the edition an integer; the cover-price a float. These are the Factor types for which we will need to look up the corresponding " { $link "db.types" } "." $nl
"To actually bind the tuple slots to the database types, we'll use " { $link define-persistent } "."
{ $code
"USING: db.tuples db.types ;
HELP: update-user
{ $values { "user" user } { "provider" "an authentication provider" } }
-{ $contract "Stores a user back to an authentication provider after being changed. This is a no-op with in-memory providers; providers which use an external store will save the user in this word. " } ;
+{ $contract "Stores a user back to an authentication provider after being changed. This is a no-op with in-memory providers; providers which use an external store will save the user in this word." } ;
ARTICLE: "furnace.auth.providers.protocol" "Authentication provider protocol"
"The " { $vocab-link "furnace.auth.providers" } " vocabulary implements a protocol for persistence and authentication of users."
HELP: nrot
{ $values { "n" integer } }
{ $description "A generalization of " { $link rot } " that works for any "
-"number of items on the stack. "
+"number of items on the stack."
}
{ $examples
{ $example "USING: arrays generalizations kernel prettyprint ;" "1 2 3 4 4 nrot 4array ." "{ 2 3 4 1 }" }
HELP: -nrot
{ $values { "n" integer } }
{ $description "A generalization of " { $link -rot } " that works for any "
-"number of items on the stack. "
+"number of items on the stack."
}
{ $examples
{ $example "USING: arrays generalizations kernel prettyprint ;" "1 2 3 4 4 -nrot 4array ." "{ 4 1 2 3 }" }
HELP: match
{ $values { "value1" object } { "value2" object } { "bindings" assoc }
}
-{ $description "Pattern match " { $snippet "value1" } " against " { $snippet "value2" } ". These values can be any Factor value, including sequences and tuples. The values can contain pattern variables, which are symbols that begin with '?'. The result is a hashtable of the bindings, mapping the pattern variables from one sequence to the equivalent value in the other sequence. The " { $link _ } " symbol can be used to ignore the value at that point in the pattern for the match. " }
+{ $description "Pattern match " { $snippet "value1" } " against " { $snippet "value2" } ". These values can be any Factor value, including sequences and tuples. The values can contain pattern variables, which are symbols that begin with '?'. The result is a hashtable of the bindings, mapping the pattern variables from one sequence to the equivalent value in the other sequence. The " { $link _ } " symbol can be used to ignore the value at that point in the pattern for the match." }
{ $examples
{ $unchecked-example "USE: match" "MATCH-VARS: ?a ?b ;\n{ ?a { 2 ?b } 5 } { 1 { 2 3 } _ } match ." "H{ { ?a 1 } { ?b 3 } }" }
}
ARTICLE: "peg.ebnf.tokenizers" "EBNF Tokenizers"
"It is possible to override the tokenizer in an EBNF defined parser. "
"Usually the input sequence to be parsed is an array of characters or a string. "
-"Terminals in a rule match successive characters in the array or string. "
+"Terminals in a rule match successive characters in the array or string."
{ $examples
{ $code
"USING: multiline ;"
"instead of the string \"++--\". With the new tokenizer \"....\" sequences "
"in the grammar are matched for equality against the token, rather than a "
"string comparison against successive items in the sequence. This can be used "
-"to match an AST from a tokenizer. "
+"to match an AST from a tokenizer."
$nl
"In this example I split the tokenizer into a separate parser and use "
"'foreign' to call it from the main one. This allows testing of the "
"This tokenizer strips out whitespace and newlines. Some rules in the grammar "
"require checking for a newline. In particular the automatic semicolon insertion "
"rule (managed by the 'Sc' rule here). If there is a newline, the semicolon can "
-"be optional in places. "
+"be optional in places."
{ $examples
{ $code
"\"do\" Stmt:s \"while\" \"(\" Expr:c \")\" Sc => [[ s c ast-do-while boa ]]"
ARTICLE: "peg.ebnf" "EBNF"
"The " { $vocab-link "peg.ebnf" } " vocabulary provides a DSL that allows writing PEG parsers that look like "
"EBNF syntax. It provides three parsing words described below. These words all "
-"accept the same EBNF syntax. The difference is in how they are used. "
+"accept the same EBNF syntax. The difference is in how they are used."
{ $subsections
POSTPONE: EBNF:
POSTPONE: EBNF[[
{ $class-description "A " { $link block } " section printed on its own line if it can fit entirely on one line." } ;
HELP: <flow
-{ $description "Begins a " { $link flow } " section. " } ;
+{ $description "Begins a " { $link flow } " section." } ;
HELP: colon
{ $class-description "A " { $link block } " section. When printed as a " { $link long-section } ", indents every line except the first." }
HELP: <action-field>
{ $values { "quot" { $quotation ( string -- ) } } { "gadget" editor } }
-{ $description "Creates an editor gadget with a blank model. Whenever a value is entered into the editor and Return pressed, the value is pushed on the stack as a string and the specified quotation is called. Note that the quotation cannot update the value in the field. " } ;
+{ $description "Creates an editor gadget with a blank model. Whenever a value is entered into the editor and Return pressed, the value is pushed on the stack as a string and the specified quotation is called. Note that the quotation cannot update the value in the field." } ;
HELP: editor-string
clear-gadget
}
"The children of a gadget are available via the "
-{ $snippet "children" } " slot. "
+{ $snippet "children" } " slot."
$nl
"Working with gadget children:"
{ $subsections
HELP: free-callback
{ $values { "alien" alien } }
-{ $description "Releases the callback heap memory allocated for an alien callback. " }
+{ $description "Releases the callback heap memory allocated for an alien callback." }
{ $warning "If the callback is invoked (either from C or Factor) after it has been freed, then Factor may crash." } ;
HELP: with-callback
{ $description "Adds the definition to the unit's " { $link changed-definitions } "." } ;
HELP: changed-definitions
-{ $var-description "A set that contains all words and vocabs whose definitions have changed or are new. " }
+{ $var-description "A set that contains all words and vocabs whose definitions have changed or are new." }
{ $see-also changed-definition } ;
HELP: changed-effects
ABOUT: "slots"
HELP: bad-initial-value
-{ $error-description "Thrown by " { $link POSTPONE: TUPLE: } " if a slot has an impossible initial value. "
+{ $error-description "Thrown by " { $link POSTPONE: TUPLE: } " if a slot has an impossible initial value."
{ $examples
{ $unchecked-example
"TUPLE: a { b integer initial: \"invalid\" } ;"
ARTICLE: "24-game" "The Game of 24"
"A classic math game, where one attempts to create 24, by applying "
-"arithmetical operations and some shuffle words to a stack of 4 numbers. "
+"arithmetical operations and some shuffle words to a stack of 4 numbers."
{ $subsections
24-game
make-24
HELP: mesh>vertices
{ $values { "mesh-tag" tag } { "pair" pair } }
-{ $description "Convert the mesh tag's vertices element to a pair for further lookup in " { $link collect-sources } ". " } ;
+{ $description "Convert the mesh tag's vertices element to a pair for further lookup in " { $link collect-sources } "." } ;
HELP: collect-sources
{ $values { "sources" hashtable } { "vertices" pair } { "inputs" tag sequence } { "seq" sequence } }
HELP: md
{ $values { "material-dictionary" assoc } }
-{ $description "Convenience word for accessing the material dictionary while parsing primitives. " } ;
+{ $description "Convenience word for accessing the material dictionary while parsing primitives." } ;
HELP: strings>numbers
{ $values { "strings" sequence } { "numbers" sequence } }
{ $heading "Special messages" }
"Some special messages that are created by the library and not by the irc server."
{ $table
- { { $link irc-chat-end } "sent to a chat when it has been detached from the client, the chat should stop after it receives this message. " }
+ { { $link irc-chat-end } "sent to a chat when it has been detached from the client, the chat should stop after it receives this message." }
{ { $link irc-end } " sent when the client isn't running anymore, the chat should stop after it receives this message." }
{ { $link irc-disconnected } " sent to notify chats that connection was lost." }
{ { $link irc-connected } " sent to notify chats that a connection with the irc server was established." } }
}
}
$nl
-"The messages marked for deletion are actually deleted only when " { $link close } " is called. This should be the last command you issue. "
+"The messages marked for deletion are actually deleted only when " { $link close } " is called. This should be the last command you issue."
{ $subsections close }
{ $examples
{ $code
HELP: successor
{ $values { "str" string } { "str'" string } }
{ $description
- "Returns the successor to " { $snippet "str" } ". The successor is calculated by incrementing characters starting from the rightmost alphanumeric (or the rightmost character if there are no alphanumerics) in the string. Incrementing a digit always results in another digit, and incrementing a letter results in another letter of the same case. "
+ "Returns the successor to " { $snippet "str" } ". The successor is calculated by incrementing characters starting from the rightmost alphanumeric (or the rightmost character if there are no alphanumerics) in the string. Incrementing a digit always results in another digit, and incrementing a letter results in another letter of the same case."
$nl
- "If the increment generates a carry, the character to the left of it is incremented. This process repeats until there is no carry, adding an additional character if necessary. "
+ "If the increment generates a carry, the character to the left of it is incremented. This process repeats until there is no carry, adding an additional character if necessary."
} ;
projects / factor.git / commitdiff