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 vocabs.metadata io combinators calendar accessors
6 math.parser io.streams.string ui.tools.operations quotations
7 strings arrays prettyprint words vocabs sorting sets classes
8 math alien urls splitting ascii combinators.short-circuit timers
9 words.symbol system summary ;
10 FROM: sets => members ;
13 SYMBOL: developer-name
16 ERROR: not-a-vocab-root string ;
17 ERROR: vocab-name-contains-separator path ;
18 ERROR: vocab-name-contains-dot path ;
19 ERROR: bad-developer-name name ;
21 M: bad-developer-name summary
22 drop "Developer name must be a string." ;
26 : vocab-root? ( string -- ? )
28 vocab-roots get member? ;
30 : contains-dot? ( string -- ? ) ".." swap subseq? ;
32 : contains-separator? ( string -- ? ) [ path-separator? ] any? ;
34 : ensure-vocab-exists ( string -- string )
35 dup vocabs member? [ no-vocab ] unless ;
37 : check-vocab-name ( string -- string )
39 [ contains-dot? [ vocab-name-contains-dot ] when ]
40 [ contains-separator? [ vocab-name-contains-separator ] when ] tri ;
42 : check-root ( string -- string )
43 dup vocab-root? [ not-a-vocab-root ] unless ;
45 : check-vocab-root/vocab ( vocab-root string -- vocab-root string )
46 [ check-root ] [ check-vocab-name ] bi* ;
48 : replace-vocab-separators ( vocab -- path )
49 path-separator first CHAR: . associate substitute ; inline
51 : vocab-root/vocab>path ( vocab-root vocab -- path )
52 check-vocab-root/vocab
53 [ ] [ replace-vocab-separators ] bi* append-path ;
55 : vocab>path ( vocab -- path )
57 [ find-vocab-root ] keep vocab-root/vocab>path ;
59 : vocab-root/vocab/file>path ( vocab-root vocab file -- path )
60 [ vocab-root/vocab>path ] dip append-path ;
62 : vocab-root/vocab/suffix>path ( vocab-root vocab suffix -- path )
63 [ vocab-root/vocab>path dup file-name append-path ] dip append ;
65 : vocab/file>path ( vocab file -- path )
66 [ vocab>path ] dip append-path ;
68 : vocab/suffix>path ( vocab suffix -- path )
69 [ vocab>path dup file-name append-path ] dip append ;
71 : directory-exists ( path -- )
72 "Not creating a directory, it already exists: " write print ;
74 : scaffold-directory ( vocab-root vocab -- )
76 dup exists? [ directory-exists ] [ make-directories ] if ;
78 : not-scaffolding ( path -- path )
79 "Not creating scaffolding for " write dup <pathname> . ;
81 : scaffolding ( path -- path )
82 "Creating scaffolding for " write dup <pathname> . ;
84 : scaffolding? ( path -- path ? )
85 dup exists? [ not-scaffolding f ] [ scaffolding t ] if ;
87 : scaffold-copyright ( -- )
88 "! Copyright (C) " write now year>> number>string write
89 developer-name get [ "Your name" ] unless* bl write "." print
90 "! See http://factorcode.org/license.txt for BSD license." print ;
92 : main-file-string ( vocab -- string )
97 ] with-string-writer ;
99 : set-scaffold-main-file ( vocab path -- )
100 [ main-file-string 1array ] dip utf8 set-file-lines ;
102 : scaffold-main ( vocab-root vocab -- )
103 [ ".factor" vocab-root/vocab/suffix>path ] keep swap scaffolding? [
104 set-scaffold-main-file
109 : scaffold-metadata ( vocab file contents -- )
110 [ ensure-vocab-exists ] 2dip
112 [ vocab/file>path ] dip 1array swap scaffolding? [
121 : lookup-type ( string -- object/string ? )
122 "new" ?head drop [ { [ CHAR: ' = ] [ digit? ] } 1|| ] trim-tail
124 { "object" object } { "obj" object }
129 { "hashtable" hashtable }
131 { "ch" "a character" }
135 { "duration" duration }
136 { "path" "a pathname string" }
137 { "vocab" "a vocabulary specifier" }
138 { "vocab-root" "a vocabulary root string" }
142 { "alist" "an array of key/value pairs" }
143 { "keys" sequence } { "values" sequence }
144 { "class" class } { "tuple" tuple }
148 : add-using ( object -- )
149 vocabulary>> using get [ conjoin ] [ drop ] if* ;
151 : ($values.) ( array -- )
154 dup array? [ first ] when
157 [ [ pprint ] [ dup string? [ drop ] [ add-using ] if ] bi ] bi*
159 drop unparse write bl null pprint
168 : ?print-nl ( seq1 seq2 -- )
169 { [ nip empty? ] [ drop empty? ] } 2|| not
171 : $values. ( word -- )
172 "declared-effect" word-prop [
173 [ in>> ] [ out>> ] bi
174 2dup [ empty? ] bi@ and [
177 [ members ] dip over diff
179 [ drop 4bl ($values.) ]
181 [ nip 4bl ($values.) ] 2tri
186 : symbol-description. ( word -- )
188 "{ $var-description \"\" } ;" print ;
190 : $description. ( word -- )
192 "{ $description \"\" } ;" print ;
194 : docs-body. ( word/symbol -- )
198 [ $values. ] [ $description. ] bi
201 : docs-header. ( word -- )
202 "HELP: " write name>> print ;
204 : (help.) ( word -- )
205 [ docs-header. ] [ docs-body. ] bi ;
207 : interesting-words ( vocab -- array )
209 [ { [ "help" word-prop ] [ predicate? ] } 1|| not ] filter
212 : interesting-words. ( vocab -- )
213 interesting-words [ (help.) nl ] each ;
215 : docs-file-string ( vocab -- str2 )
218 [ "IN: " write print nl ]
219 [ interesting-words. ]
221 [ "ARTICLE: " write unparse dup write bl print ]
222 [ "{ $vocab-link " write pprint " }" print ] bi
225 [ "ABOUT: " write unparse print ]
227 ] with-string-writer ;
229 : write-using ( vocab -- )
232 { "help.markup" "help.syntax" } append natural-sort remove
236 : set-scaffold-docs-file ( vocab path -- )
239 [ docs-file-string ] [ write-using ] bi
241 ] with-output-stream ;
243 : with-scaffold ( quot -- )
244 [ H{ } clone using ] dip with-variable ; inline
246 : link-vocab ( vocab -- )
248 "Edit documentation: " write
249 "-docs.factor" vocab/suffix>path <pathname> . ;
254 [ (help.) ] [ nl vocabulary>> link-vocab ] bi ;
256 : scaffold-help ( vocab -- )
259 dup "-docs.factor" vocab/suffix>path scaffolding? [
260 set-scaffold-docs-file
266 : scaffold-undocumented ( string -- )
267 [ interesting-words. ] [ link-vocab ] bi ;
269 : scaffold-authors ( vocab -- )
270 "authors.txt" developer-name get scaffold-metadata ;
272 : scaffold-tags ( vocab tags -- )
273 [ "tags.txt" ] dip scaffold-metadata ;
275 : scaffold-summary ( vocab summary -- )
276 [ "summary.txt" ] dip scaffold-metadata ;
278 : scaffold-platforms ( vocab platforms -- )
279 [ "platforms.txt" ] dip scaffold-metadata ;
281 : scaffold-vocab ( vocab-root string -- )
283 [ scaffold-directory ]
286 [ nip scaffold-authors ]
289 : scaffold-core ( string -- ) "resource:core" swap scaffold-vocab ;
291 : scaffold-basis ( string -- ) "resource:basis" swap scaffold-vocab ;
293 : scaffold-extra ( string -- ) "resource:extra" swap scaffold-vocab ;
295 : scaffold-work ( string -- ) "resource:work" swap scaffold-vocab ;
299 : tests-file-string ( vocab -- string )
302 "USING: tools.test " write dup write " ;" print
303 "IN: " write write ".tests" print
304 ] with-string-writer ;
306 : set-scaffold-tests-file ( vocab path -- )
307 [ tests-file-string ] dip utf8 set-file-contents ;
311 : scaffold-tests ( vocab -- )
313 dup "-tests.factor" vocab/suffix>path
315 set-scaffold-tests-file
320 SYMBOL: examples-flag
324 "{ $example \"\" \"USING: prettyprint ;\""
328 } [ examples-flag get [ 4bl ] when print ] each ;
339 [ "Click to edit: " write <pathname> . ] bi ;
341 : scaffold-rc ( path -- )
342 [ home ] dip append-path touch. ;
344 : scaffold-factor-boot-rc ( -- )
345 os windows? "factor-boot-rc" ".factor-boot-rc" ? scaffold-rc ;
347 : scaffold-factor-rc ( -- )
348 os windows? "factor-rc" ".factor-rc" ? scaffold-rc ;
351 HOOK: scaffold-emacs os ( -- )
353 M: unix scaffold-emacs ( -- ) ".emacs" scaffold-rc ;