Documents - Factor Documentation (original) (raw)

The documents vocabulary implements 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 Editor gadgets can display these models.
document
( -- document )

Getting and setting the contents of the entire document:

doc-string ( document -- str )

set-doc-string ( string document -- )
clear-doc ( document -- )

Getting and setting subranges:

doc-line ( n document -- string )

doc-lines ( from to document -- slice )
doc-range ( from to document -- string )
set-doc-range ( string from to document -- )
remove-doc-range ( from to document -- )

A combinator:

each-doc-line ( ... from to quot: ( ... line -- ... ) -- ... )

map-doc-lines ( ... from to quot: ( ... line -- ... result ) -- ... results )

More info:
Document locations
Document elements

See also
Editor gadgets