1 ! Copyright (C) 2008 Doug Coleman.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: assocs io.files io.pathnames io.directories
4 io.encodings.utf8 hashtables kernel namespaces sequences
5 vocabs.loader io combinators calendar accessors math.parser
6 io.streams.string ui.tools.operations quotations strings arrays
7 prettyprint words vocabs sorting sets classes math alien urls
8 splitting ascii combinators.short-circuit alarms words.symbol
12 SYMBOL: developer-name
15 ERROR: not-a-vocab-root string ;
16 ERROR: vocab-name-contains-separator path ;
17 ERROR: vocab-name-contains-dot path ;
18 ERROR: no-vocab vocab ;
19 ERROR: bad-developer-name name ;
21 M: bad-developer-name summary
22 drop "Developer name must be a string." ;
26 : vocab-root? ( string -- ? ) vocab-roots get member? ;
28 : contains-dot? ( string -- ? ) ".." swap subseq? ;
30 : contains-separator? ( string -- ? ) [ path-separator? ] any? ;
32 : ensure-vocab-exists ( string -- string )
33 dup vocabs member? [ no-vocab ] unless ;
35 : check-vocab-name ( string -- string )
37 [ contains-dot? [ vocab-name-contains-dot ] when ]
38 [ contains-separator? [ vocab-name-contains-separator ] when ] tri ;
40 : check-root ( string -- string )
41 dup vocab-root? [ not-a-vocab-root ] unless ;
43 : check-vocab ( vocab -- vocab )
44 dup find-vocab-root [ no-vocab ] unless ;
46 : check-vocab-root/vocab ( vocab-root string -- vocab-root string )
47 [ check-root ] [ check-vocab-name ] bi* ;
49 : replace-vocab-separators ( vocab -- path )
50 path-separator first CHAR: . associate substitute ; inline
52 : vocab-root/vocab>path ( vocab-root vocab -- path )
53 check-vocab-root/vocab
54 [ ] [ replace-vocab-separators ] bi* append-path ;
56 : vocab>path ( vocab -- path )
58 [ find-vocab-root ] keep vocab-root/vocab>path ;
60 : vocab-root/vocab/file>path ( vocab-root vocab file -- path )
61 [ vocab-root/vocab>path ] dip append-path ;
63 : vocab-root/vocab/suffix>path ( vocab-root vocab suffix -- path )
64 [ vocab-root/vocab>path dup file-name append-path ] dip append ;
66 : vocab/suffix>path ( vocab suffix -- path )
67 [ vocab>path dup file-name append-path ] dip append ;
69 : directory-exists ( path -- )
70 "Not creating a directory, it already exists: " write print ;
72 : scaffold-directory ( vocab-root vocab -- )
74 dup exists? [ directory-exists ] [ make-directories ] if ;
76 : not-scaffolding ( path -- path )
77 "Not creating scaffolding for " write dup <pathname> . ;
79 : scaffolding ( path -- path )
80 "Creating scaffolding for " write dup <pathname> . ;
82 : scaffolding? ( path -- path ? )
83 dup exists? [ not-scaffolding f ] [ scaffolding t ] if ;
85 : scaffold-copyright ( -- )
86 "! Copyright (C) " write now year>> number>string write
87 developer-name get [ "Your name" ] unless* bl write "." print
88 "! See http://factorcode.org/license.txt for BSD license." print ;
90 : main-file-string ( vocab -- string )
95 ] with-string-writer ;
97 : set-scaffold-main-file ( vocab path -- )
98 [ main-file-string ] dip utf8 set-file-contents ;
100 : scaffold-main ( vocab-root vocab -- )
101 tuck ".factor" vocab-root/vocab/suffix>path scaffolding? [
102 set-scaffold-main-file
107 : scaffold-authors ( vocab-root vocab -- )
109 "authors.txt" vocab-root/vocab/file>path scaffolding? [
110 developer-name get swap utf8 set-file-contents
118 : lookup-type ( string -- object/string ? )
119 "new" ?head drop [ { [ CHAR: ' = ] [ digit? ] } 1|| ] trim-tail
121 { "object" object } { "obj" object }
126 { "hashtable" hashtable }
128 { "ch" "a character" }
132 { "duration" duration }
133 { "path" "a pathname string" }
134 { "vocab" "a vocabulary specifier" }
135 { "vocab-root" "a vocabulary root string" }
139 { "alist" "an array of key/value pairs" }
140 { "keys" sequence } { "values" sequence }
141 { "class" class } { "tuple" tuple }
145 : add-using ( object -- )
146 vocabulary>> using get [ conjoin ] [ drop ] if* ;
148 : ($values.) ( array -- )
151 dup array? [ first ] when
154 [ [ pprint ] [ dup string? [ drop ] [ add-using ] if ] bi ] bi*
156 drop unparse write bl null pprint
165 : $values. ( word -- )
166 "declared-effect" word-prop [
167 [ in>> ] [ out>> ] bi
168 2dup [ empty? ] bi@ and [
173 [ [ nl 4bl ($values.) ] unless-empty ] bi*
178 : symbol-description. ( word -- )
180 "{ $var-description \"\" } ;" print ;
182 : $description. ( word -- )
184 "{ $description \"\" } ;" print ;
186 : docs-body. ( word/symbol -- )
190 [ $values. ] [ $description. ] bi
193 : docs-header. ( word -- )
194 "HELP: " write name>> print ;
196 : (help.) ( word -- )
197 [ docs-header. ] [ docs-body. ] bi ;
199 : interesting-words ( vocab -- array )
201 [ { [ "help" word-prop ] [ predicate? ] } 1|| not ] filter
204 : interesting-words. ( vocab -- )
205 interesting-words [ (help.) nl ] each ;
207 : docs-file-string ( vocab -- str2 )
210 [ "IN: " write print nl ]
211 [ interesting-words. ]
213 [ "ARTICLE: " write unparse dup write bl print ]
214 [ "{ $vocab-link " write pprint " }" print ] bi
217 [ "ABOUT: " write unparse print ]
219 ] with-string-writer ;
221 : write-using ( vocab -- )
224 { "help.markup" "help.syntax" } append natural-sort remove
228 : set-scaffold-docs-file ( vocab path -- )
231 [ docs-file-string ] [ write-using ] bi
233 ] with-output-stream ;
235 : with-scaffold ( quot -- )
236 [ H{ } clone using ] dip with-variable ; inline
238 : link-vocab ( vocab -- )
240 "Edit documentation: " write
241 "-docs.factor" vocab/suffix>path <pathname> . ;
246 [ (help.) ] [ nl vocabulary>> link-vocab ] bi ;
248 : scaffold-help ( vocab -- )
251 dup "-docs.factor" vocab/suffix>path scaffolding? [
252 set-scaffold-docs-file
258 : scaffold-undocumented ( string -- )
259 [ interesting-words. ] [ link-vocab ] bi ;
261 : scaffold-vocab ( vocab-root string -- )
263 [ scaffold-directory ]
269 : scaffold-core ( string -- ) "resource:core" swap scaffold-vocab ;
271 : scaffold-basis ( string -- ) "resource:basis" swap scaffold-vocab ;
273 : scaffold-extra ( string -- ) "resource:extra" swap scaffold-vocab ;
275 : scaffold-work ( string -- ) "resource:work" swap scaffold-vocab ;
279 : tests-file-string ( vocab -- string )
282 "USING: tools.test " write dup write " ;" print
283 "IN: " write write ".tests" print
284 ] with-string-writer ;
286 : set-scaffold-tests-file ( vocab path -- )
287 [ tests-file-string ] dip utf8 set-file-contents ;
291 : scaffold-tests ( vocab -- )
293 dup "-tests.factor" vocab/suffix>path
295 set-scaffold-tests-file
300 SYMBOL: examples-flag
304 "{ $example \"\" \"USING: prettyprint ;\""
308 } [ examples-flag get [ 4bl ] when print ] each ;
319 [ "Click to edit: " write <pathname> . ] bi ;
321 : scaffold-rc ( path -- )
322 [ home ] dip append-path touch. ;
324 : scaffold-factor-boot-rc ( -- )
325 os windows? "factor-boot-rc" ".factor-boot-rc" ? scaffold-rc ;
327 : scaffold-factor-rc ( -- )
328 os windows? "factor-rc" ".factor-rc" ? scaffold-rc ;
331 HOOK: scaffold-emacs os ( -- )
333 M: unix scaffold-emacs ( -- ) ".emacs" scaffold-rc ;