1 USING: help.markup help.syntax kernel math models sequences
6 { $values { "loc" "a pair of integers" } { "n" integer } { "newloc" "a pair of integers" } }
7 { $description "Adds an integer to the column number of a line/column pair." } ;
9 { +col +line =col =line } related-words
12 { $values { "loc" "a pair of integers" } { "n" integer } { "newloc" "a pair of integers" } }
13 { $description "Adds an integer to the line number of a line/column pair." } ;
16 { $values { "n" integer } { "loc" "a pair of integers" } { "newloc" "a pair of integers" } }
17 { $description "Sets the column number of a line/column pair." } ;
20 { $values { "n" integer } { "loc" "a pair of integers" } { "newloc" "a pair of integers" } }
21 { $description "Sets the line number of a line/column pair." } ;
24 { $values { "loc1" "a pair of integers" } { "loc2" "a pair of integers" } { "?" boolean } }
25 { $description "Tests if both line/column pairs have the same line number." } ;
28 { $class-description "A document is a " { $link model } " containing editable text, stored as an array of lines. Documents are created by calling " { $link <document> } ". Documents can be edited with editor gadgets; see " { $vocab-link "ui.gadgets.editors" } "." } ;
31 { $values { "document" "a new " { $link document } } }
32 { $description "Creates a new, empty " { $link document } "." } ;
35 { $values { "n" "a non-negative integer" } { "document" document } { "string" string } }
36 { $description "Outputs the " { $snippet "n" } "th line of the document." }
37 { $errors "Throws an error if " { $snippet "n" } " is out of bounds." } ;
40 { $values { "from" "a non-negative integer" } { "to" "a non-negative integer" } { "document" document } { "slice" slice } }
41 { $description "Outputs a range of lines from the document." }
42 { $notes "The range is created by calling " { $link <slice> } "." }
43 { $errors "Throws an error if " { $snippet "from" } " or " { $snippet "to" } " is out of bounds." } ;
46 { $values { "from" "a non-negative integer" } { "to" "a non-negative integer" } { "quot" { $quotation ( ... line -- ... ) } } }
47 { $description "Applies the quotation to each line in the range." }
48 { $notes "The range is created by calling " { $link <slice> } "." }
49 { $errors "Throws an error if " { $snippet "from" } " or " { $snippet "to" } " is out of bounds." } ;
52 { $values { "from" "a pair of integers" } { "to" "a pair of integers" } { "document" document } { "string" "a new " { $link string } } }
53 { $description "Outputs all text in between two line/column number pairs. Lines are separated by " { $snippet "\\n" } "." }
54 { $errors "Throws an error if " { $snippet "from" } " or " { $snippet "to" } " is out of bounds." } ;
57 { $values { "string" string } { "from" "a pair of integers" } { "to" "a pair of integers" } { "document" document } }
58 { $description "Replaces all text between two line/column number pairs with " { $snippet "string" } ". The string may use either " { $snippet "\\n" } ", " { $snippet "\\r\\n" } " or " { $snippet "\\r" } " line separators." }
59 { $errors "Throws an error if " { $snippet "from" } " or " { $snippet "to" } " is out of bounds." }
60 { $side-effects "document" } ;
63 { $values { "string" string } { "from" "a pair of integers" } { "to" "a pair of integers" } { "document" document } }
64 { $description "Replaces all text between two line/column number pairs with " { $snippet "string" } ". The string may use either " { $snippet "\\n" } ", " { $snippet "\\r\\n" } " or " { $snippet "\\r" } " line separators.\n\nThis word differs from " { $link set-doc-range } " in that it does not include changes in the Undo and Redo actions." }
65 { $errors "Throws an error if " { $snippet "from" } " or " { $snippet "to" } " is out of bounds." }
66 { $side-effects "document" } ;
68 HELP: remove-doc-range
69 { $values { "from" "a pair of integers" } { "to" "a pair of integers" } { "document" document } }
70 { $description "Removes all text between two line/column number pairs." }
71 { $errors "Throws an error if " { $snippet "from" } " or " { $snippet "to" } " is out of bounds." }
72 { $side-effects "document" } ;
75 { $values { "loc" "a pair of integers" } { "document" document } { "newloc" "a pair of integers" } }
76 { $description "Ensures that the line and column numbers in " { $snippet "loc" } " are valid, clamping them to the permitted range if they are not." } ;
79 { $values { "line#" "a non-negative integer" } { "document" document } { "loc" "a pair of integers" } }
80 { $description "Outputs the location where " { $snippet "line#" } " ends." }
81 { $errors "Throws an error if " { $snippet "line#" } " is out of bounds." } ;
84 { $values { "document" document } { "loc" "a pair of integers" } }
85 { $description "Outputs the location of the end of the document." } ;
88 { $values { "document" document } { "str" "a new " { $link string } } }
89 { $description "Outputs the contents of the document as a string. Lines are separated by " { $snippet "\\n" } "." } ;
92 { $values { "string" string } { "document" document } }
93 { $description "Sets the contents of the document to a string, which may use either " { $snippet "\\n" } ", " { $snippet "\\r\\n" } " or " { $snippet "\\r" } " line separators." }
94 { $side-effects "document" } ;
97 { $values { "document" document } }
98 { $description "Removes all text from the document." }
99 { $side-effects "document" } ;
101 ARTICLE: "documents" "Documents"
102 "The " { $vocab-link "documents" } " vocabulary implements " { $emphasis "documents" } ", which are models storing a passage of text as a sequence of lines. Operations are defined for operating on subranges of the text, and " { $link "ui.gadgets.editors" } " can display these models."
107 "Getting and setting the contents of the entire document:"
113 "Getting and setting subranges:"
122 { $subsections each-line }
128 { $see-also "ui.gadgets.editors" } ;
130 ARTICLE: "document-locs" "Document locations"
131 "Locations in the document are represented as a line/column number pair, with both indices being zero-based. There are some words for manipulating locations:"
138 "Miscellaneous words for working with locations:"