1 USING: help.markup help.syntax vocabs.loader io.pathnames strings
2 definitions quotations compiler.units ;
5 ARTICLE: "source-files" "Source files"
6 "Words in the " { $vocab-link "source-files" } " vocabulary are used to keep track of loaded source files. This is used to implement " { $link "vocabs.refresh" } "."
8 "The source file database:"
9 { $subsections source-files }
10 "The class of source files:"
11 { $subsections source-file }
12 "Words intended for the parser:"
17 "Removing a source file from the database:"
18 { $subsections forget-source }
19 "Updating the database:"
20 { $subsections reset-checksums }
21 "The " { $link pathname } " class implements the definition protocol by working with the corresponding source file; see " { $link "definitions" } "." ;
26 { $var-description "An assoc mapping pathname strings to " { $link source-file-tuple } " instances, representing loaded source files." } ;
29 { $values { "path" "a pathname string" } { "source-file" source-file-tuple } }
30 { $description "Outputs the source file associated to a path name, creating the source file first if it doesn't exist. Source files are retained in the " { $link source-files } " variable." } ;
32 HELP: source-file-tuple
33 { $class-description "Instances retain information about loaded source files, and have the following slots:"
35 { { $slot "path" } " - a pathname string." }
36 { { $slot "checksum" } " - the CRC32 checksum of the source file's contents at the time it was most recently loaded." }
37 { { $slot "definitions" } " - a pair of assocs, containing definitions and classes defined in this source file, respectively" }
42 { $values { "lines" "a sequence of strings" } { "source-file" source-file } }
43 { $description "Records the CRC32 checksum of the source file's contents." }
47 { $description "Resets recorded modification times and CRC32 checksums for all loaded source files, creating a checkpoint for " { $link "vocabs.refresh" } "." } ;
50 { $values { "path" "a pathname string" } }
51 { $description "Forgets all information known about a source file." }
52 { $notes "This word must be called from inside " { $link with-compilation-unit } "." } ;
54 HELP: record-definitions
55 { $values { "file" source-file } }
56 { $description "Records that all " { $link new-definitions } " were defined in " { $snippet "file" } "." } ;
58 HELP: rollback-source-file
59 { $values { "file" source-file } }
60 { $description "Records information to the source file after an incomplete parse which ended with an error." } ;
63 { $var-description "Stores the " { $link source-file } " being parsed. The " { $snippet "path" } " of this object comes from the input parameter to " { $link with-source-file } "." } ;