1 ! Copyright (C) 2008 Doug Coleman.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: accessors alien arrays assocs byte-arrays calendar
4 classes classes.error combinators combinators.short-circuit fry
5 hashtables help.markup interpolate io io.directories
6 io.encodings.utf8 io.files io.pathnames io.streams.string kernel
7 math math.parser namespaces prettyprint quotations sequences
8 sets sorting splitting strings system timers unicode urls vocabs
9 vocabs.loader vocabs.metadata words words.symbol ;
12 SYMBOL: developer-name
15 ERROR: not-a-vocab-root string ;
17 ERROR: vocab-must-not-exist string ;
21 : vocab-root? ( string -- ? )
22 trim-tail-separators vocab-roots get member? ;
24 : ensure-vocab-exists ( string -- string )
25 dup loaded-vocab-names member? [ no-vocab ] unless ;
27 : check-root ( string -- string )
28 dup vocab-root? [ not-a-vocab-root ] unless ;
30 : check-vocab-root/vocab ( vocab-root string -- vocab-root string )
31 [ check-root ] [ check-vocab-name ] bi* ;
33 : check-vocab-exists ( string -- string )
34 dup vocab-exists? [ vocab-must-not-exist ] when ;
36 : replace-vocab-separators ( vocab -- path )
37 path-separator first CHAR: . associate substitute ; inline
39 : vocab-root/vocab>path ( vocab-root vocab -- path )
40 check-vocab-root/vocab
41 [ ] [ replace-vocab-separators ] bi* append-path ;
43 : vocab>path ( vocab -- path )
44 check-vocab [ find-vocab-root ] keep vocab-root/vocab>path ;
46 : vocab-root/vocab/file>path ( vocab-root vocab file -- path )
47 [ vocab-root/vocab>path ] dip append-path ;
49 : vocab-root/vocab/suffix>path ( vocab-root vocab suffix -- path )
50 [ vocab-root/vocab>path dup file-name append-path ] dip append ;
52 : vocab/file>path ( vocab file -- path )
53 [ vocab>path ] dip append-path ;
55 : vocab/suffix>path ( vocab suffix -- path )
56 [ vocab>path dup file-name append-path ] dip append ;
58 : directory-exists ( path -- )
59 "Not creating a directory, it already exists: " write print ;
61 : scaffold-directory ( vocab-root vocab -- )
63 dup exists? [ directory-exists ] [ make-directories ] if ;
65 : not-scaffolding ( path -- path )
66 "Not creating scaffolding for " write dup <pathname> . ;
68 : scaffolding ( path -- path )
69 "Creating scaffolding for " write dup <pathname> . ;
71 : scaffolding? ( path -- path ? )
72 dup exists? [ not-scaffolding f ] [ scaffolding t ] if ;
74 : scaffold-copyright ( -- )
75 "! Copyright (C) " write now year>> number>string write
76 developer-name get [ "Your name" ] unless* bl write "." print
77 "! See http://factorcode.org/license.txt for BSD license." print ;
79 : main-file-string ( vocab -- string )
84 ] with-string-writer ;
86 : set-scaffold-main-file ( vocab path -- )
87 [ main-file-string 1array ] dip utf8 set-file-lines ;
89 : scaffold-main ( vocab-root vocab -- )
90 [ ".factor" vocab-root/vocab/suffix>path ] keep swap scaffolding? [
91 set-scaffold-main-file
96 : scaffold-metadata ( vocab file contents -- )
97 [ ensure-vocab-exists ] 2dip
99 [ vocab/file>path ] dip 1array swap scaffolding? [
108 : lookup-type ( string -- object/string ? )
110 "new" ?head drop [ { [ CHAR: ' = ] [ digit? ] } 1|| ] trim-tail
118 { "hashtable" hashtable }
120 { "ch" "a character" }
123 { "byte-array" byte-array }
125 { "duration" duration }
126 { "path" "a pathname string" }
127 { "vocab" "a vocabulary specifier" }
128 { "vocab-root" "a vocabulary root string" }
130 { "sequence" sequence }
132 { "exemplar" object }
134 { "alist" "an array of key/value pairs" }
136 { "values" sequence }
140 } at* [ swap [ \ $maybe swap 2array ] when ] dip ;
142 GENERIC: add-using ( object -- )
144 M: array add-using [ add-using ] each ;
146 M: string add-using drop ;
148 M: object add-using ( object -- )
149 vocabulary>> using get [ adjoin ] [ drop ] if* ;
151 : ($values.) ( array -- )
156 dup array? [ first ] when
159 [ [ pprint ] [ add-using ] bi ] bi*
161 drop unparse write bl null pprint
168 : ?print-nl ( seq1 seq2 -- )
169 [ empty? ] either? [ nl ] unless ;
171 : $values. ( word -- )
172 "declared-effect" word-prop [
173 [ in>> ] [ out>> ] bi
174 2dup [ empty? ] both? [
177 [ members ] dip over diff
181 [ nip ($values.) ] 2tri
186 : error-description. ( word -- )
188 "{ $description \"Throws " write
189 name>> dup a/an write " \" { $link " write
190 write " } \" error.\" }" print
191 ] bi "{ $error-description \"\" } ;" print ;
193 : class-description. ( word -- )
194 drop "{ $class-description \"\" } ;" print ;
196 : symbol-description. ( word -- )
197 drop "{ $var-description \"\" } ;" print ;
199 : $description. ( word -- )
200 drop "{ $description \"\" } ;" print ;
202 : docs-body. ( word/symbol -- )
204 { [ dup error-class? ] [ error-description. ] }
205 { [ dup class? ] [ class-description. ] }
206 { [ dup symbol? ] [ symbol-description. ] }
207 [ [ $values. ] [ $description. ] bi ]
210 : docs-header. ( word -- )
211 "HELP: " write name>> print ;
213 : (help.) ( word -- )
214 [ docs-header. ] [ docs-body. ] bi ;
216 : interesting-words ( vocab -- array )
218 [ { [ "help" word-prop ] [ predicate? ] } 1|| ] reject
221 : interesting-words. ( vocab -- )
222 interesting-words [ (help.) nl ] each ;
224 : docs-file-string ( vocab -- str2 )
227 [ "IN: " write print nl ]
228 [ interesting-words. ]
230 [ "ARTICLE: " write unparse dup write bl print ]
231 [ "{ $vocab-link " write pprint " }" print ] bi
234 [ "ABOUT: " write unparse print ]
236 ] with-string-writer ;
238 : write-using ( vocab -- )
241 { "help.markup" "help.syntax" } append natural-sort remove
245 : set-scaffold-docs-file ( vocab path -- )
248 [ docs-file-string ] [ write-using ] bi
250 ] with-output-stream ;
252 : with-scaffold ( quot -- )
253 [ HS{ } clone using ] dip with-variable ; inline
255 : link-vocab ( vocab -- )
257 "Edit documentation: " write
258 "-docs.factor" vocab/suffix>path <pathname> . ;
263 [ (help.) ] [ nl vocabulary>> link-vocab ] bi ;
265 : scaffold-docs ( vocab -- )
268 dup "-docs.factor" vocab/suffix>path scaffolding? [
269 set-scaffold-docs-file
275 : scaffold-undocumented ( string -- )
276 [ interesting-words. ] [ link-vocab ] bi ;
278 : scaffold-authors ( vocab -- )
279 "authors.txt" developer-name get scaffold-metadata ;
281 : scaffold-tags ( vocab tags -- )
282 [ "tags.txt" ] dip scaffold-metadata ;
284 : scaffold-summary ( vocab summary -- )
285 [ "summary.txt" ] dip scaffold-metadata ;
287 : scaffold-platforms ( vocab platforms -- )
288 [ "platforms.txt" ] dip scaffold-metadata ;
290 : scaffold-vocab ( vocab-root string -- )
292 [ scaffold-directory ]
295 [ nip scaffold-authors ]
298 : scaffold-core ( string -- ) "resource:core" swap scaffold-vocab ;
300 : scaffold-basis ( string -- ) "resource:basis" swap scaffold-vocab ;
302 : scaffold-extra ( string -- ) "resource:extra" swap scaffold-vocab ;
304 : scaffold-work ( string -- ) "resource:work" swap scaffold-vocab ;
308 : tests-file-string ( vocab -- string )
311 "USING: tools.test " write dup write " ;" print
312 "IN: " write write ".tests" print
313 ] with-string-writer ;
315 : set-scaffold-tests-file ( vocab path -- )
316 [ tests-file-string ] dip utf8 set-file-contents ;
320 : scaffold-tests ( vocab -- )
322 dup "-tests.factor" vocab/suffix>path
324 set-scaffold-tests-file
329 SYMBOL: nested-examples
331 : example-using ( using -- )
332 " " join "example-using" [
333 nested-examples get 4 0 ? CHAR: \s <string> "example-indent" [
334 "${example-indent}\"Example:\"
335 ${example-indent}{ $example \"USING: ${example-using} ;\"
336 ${example-indent} \"\"
337 ${example-indent} \"\"
344 : n-examples-using ( n using -- )
345 '[ _ example-using ] times ;
347 : scaffold-n-examples ( n word -- )
348 vocabulary>> "prettyprint" 2array
349 [ t nested-examples ] 2dip
356 : scaffold-examples ( word -- )
357 2 swap scaffold-n-examples ;
359 : scaffold-file ( path -- )
361 [ "Click to edit: " write <pathname> . ] bi ;
363 : scaffold-factor-boot-rc ( -- )
364 "~/.factor-boot-rc" scaffold-file ;
366 : scaffold-factor-rc ( -- )
367 "~/.factor-rc" scaffold-file ;
369 : scaffold-mason-rc ( -- )
370 "~/.factor-mason-rc" scaffold-file ;
372 : scaffold-factor-roots ( -- )
373 "~/.factor-roots" scaffold-file ;
375 HOOK: scaffold-emacs os ( -- )
377 M: unix scaffold-emacs ( -- ) "~/.emacs" scaffold-file ;