1 USING: help.syntax help.markup kernel prettyprint sequences strings words math ;
4 ARTICLE: "etags" "Etags file"
5 { $emphasis "Etags" } " generates a index file of every factor word in etags format as supported by emacs and other editors. More information can be found at " { $url "http://en.wikipedia.org/wiki/Ctags#Etags_2" } "."
7 { $subsection etags-write }
8 { $subsection etag-strings }
9 { $subsection etag-header }
11 HELP: etags ( path -- )
12 { $values { "path" string } }
13 { $description "Generates a index file in etags format and stores in " { $snippet "path" } "." }
16 "USING: ctags.etags ;"
22 HELP: etags-write ( alist path -- )
23 { $values { "alist" sequence }
25 { $description "Stores a " { $snippet "alist" } " in " { $snippet "path" } ". " { $snippet "alist" } " must be an association list with etags format: its key must be a resource path and its value a vector, containing pairs of words and lines" }
28 "USING: kernel etags.ctags ;"
29 "{ { \"resource:extra/unix/unix.factor\" V{ { dup2 91 } } } } \"ETAGS\" etags-write"
34 HELP: etag-strings ( alist -- seq )
35 { $values { "alist" sequence }
37 { $description "Converts an " { $snippet "alist" } " with etag format (a path as key and a vector containing word/line pairs) in a " { $snippet "seq" } " of strings." } ;