1 ! Copyright (C) 2008, 2011 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: accessors arrays ascii assocs colors
4 combinators.short-circuit debugger formatting help help.home
5 help.topics help.vocabs html html.streams io.directories
6 io.encodings.ascii io.encodings.binary io.encodings.utf8
7 io.files io.files.temp io.pathnames kernel make math math.parser
8 namespaces regexp sequences sequences.deep serialize sets
9 sorting splitting strings system tools.completion vocabs
10 vocabs.hierarchy words xml.data xml.syntax xml.traversal
12 FROM: io.encodings.ascii => ascii ;
13 FROM: ascii => ascii? ;
16 : escape-char ( ch -- )
19 { CHAR: \" "__quo__" }
20 { CHAR: * "__star__" }
21 { CHAR: : "__colon__" }
25 { CHAR: \\ "__back__" }
26 { CHAR: | "__pipe__" }
27 { CHAR: / "__slash__" }
28 { CHAR: , "__comma__" }
30 { CHAR: # "__hash__" }
31 { CHAR: % "__percent__" }
33 ] [ number>string "__" "__" surround % ] if ;
35 : escape-filename ( string -- filename )
36 [ [ escape-char ] each ] "" make ;
38 GENERIC: topic>filename* ( topic -- name prefix )
40 M: word topic>filename*
42 [ name>> ] [ vocabulary>> ] bi 2array "word"
45 M: link topic>filename* name>> dup [ "article" ] [ topic>filename* ] if ;
46 M: word-link topic>filename* name>> topic>filename* ;
47 M: vocab-spec topic>filename* vocab-name "vocab" ;
48 M: vocab-tag topic>filename* name>> "tag" ;
49 M: vocab-author topic>filename* name>> "author" ;
50 M: f topic>filename* drop \ f topic>filename* ;
52 : topic>filename ( topic -- filename )
57 [ [ escape-filename ] map "," join ]
63 M: topic url-of topic>filename ;
66 string>> "resource:" ?head [
67 "https://github.com/factor/factor/blob/master/"
71 : help-stylesheet ( stylesheet -- xml )
72 "vocab:help/html/stylesheet.css" ascii file-contents
73 swap "\n" glue [XML <style><-></style> XML] ;
75 : help-meta ( -- xml )
78 content="width=device-width, initial-scale=1"
82 : help-navbar ( -- xml )
83 "conventions" >link topic>filename
87 <a href="https://factorcode.org">
88 <img src="favicon.ico" width="24" height="24" />
90 <a href="/">Handbook</a>
91 <a href=<->>Glossary</a>
92 <form method="get" action="/search" style="float: right;">
93 <input placeholder="Search" name="search" type="text"/>
94 <input type="submit" value="Go"/>
100 : help-footer ( -- xml )
101 version-info "\n" split1 drop
105 This documentation was generated offline from a
106 <code>load-all</code> image. If you want, you can also
107 browse the documentation from within the <a
108 href="article-ui-tools.html">UI developer tools</a>. See
109 the <a href="https://factorcode.org">Factor website</a>
110 for more information.
116 : bijective-base26 ( n -- name )
117 [ dup 0 > ] [ 1 - 26 /mod CHAR: a + ] "" produce-as nip reverse! ;
119 : css-class ( style classes -- name )
120 dup '[ drop _ assoc-size 1 + bijective-base26 ] cache ;
122 : fix-css-style ( style -- style' )
123 R/ font-size: \d+pt;/ [
124 "font-size: " ?head drop "pt;" ?tail drop
126 "font-size: %dpt;" sprintf
129 R/ padding: \d+px;/ [
130 "padding: " ?head drop "px;" ?tail drop
131 string>number dup even? [ 2 * 1 + ] [ 2 * ] if
132 number>string "padding: " "px;" surround
139 R/ background-color: #f3f2ea;/ [
140 drop "background-color: #f5f5f5;"
143 R/ font-family: monospace;/ [
144 " white-space: pre-wrap; line-height: 125%;" append
147 "font-family: monospace;" over subseq? [
148 "background-color:" over subseq?
150 " border: 1px solid #ccc; border-radius: 5px; margin: 15px; width: calc(100% - 30px);" append
153 : fix-help-header ( classes -- classes )
155 [ ".a" head? ] [ "#f4efd9;" swap subseq? ] bi and
157 "padding: 10px;" "padding: 0px;" replace
158 "background-color: #f4efd9;" "background-color: white;" replace
160 " border-bottom: 1px dashed #ccc; width: 100%; padding-top: 15px; padding-bottom: 10px; }"
161 append swap pick set-nth {
162 ".a a { color: black; font-size: 24pt; line-height: 100%; }"
163 ".a * a { color: #2a5db0; font-size: 12pt; }"
164 ".a td { border: none; }"
165 ".a tr:hover { background-color: white; }"
169 : dark-mode-css ( classes -- classes' )
170 { "" "/* Dark mode */" "@media (prefers-color-scheme:dark) {" }
173 "{" ?head drop "}" ?tail drop ";" split
174 [ [ blank? ] trim ] map harvest [ ";" append ] map
175 [ R/ (#[0-9a-fA-F]+|white|black);/ re-contains? ] filter
177 R/ (#[0-9a-fA-F]+|white|black);/ [
179 { "#000000;" "#bdc1c6;" }
180 { "#2a5db0;" "#8ab4f8;" }
181 { "#333333;" "#cccccc;" }
182 { "#373e48;" "#ffffff;" }
183 { "#8b4500;" "orange;" }
184 { "#e3e2db;" "#666666;" }
185 { "white;" "#202124;" }
186 { "black;" "white;" }
189 but-last parse-color inverse-color color>hex ";" append
192 ] map " " join "{ " " }" surround
193 ] re-replace-with " " prepend
194 "{ }" over subseq? [ drop f ] when
195 ] map harvest append "}" suffix ;
197 : mobile-css ( classes -- classes' )
198 { "" "/* Mobile */" "@media screen and (max-width: 600px) {" }
201 "{" ?head drop "}" ?tail drop ";" split
202 [ [ blank? ] trim ] map harvest [ ";" append ] map
203 { "margin: 15px;" "width: calc(100% - 30px);" } intersect
204 { "margin: 15px;" } { "margin: 15px 0px;" } replace
205 { "width: calc(100% - 30px);" } { "width: 100%;" } replace
206 " " join "{ " " }" surround
207 ] re-replace-with " " prepend
208 "{ }" over subseq? [ drop f ] when
209 ] map harvest append "}" suffix ;
211 : css-classes ( classes -- stylesheet )
213 [ fix-css-style " { " "}" surround ] [ "." prepend ] bi* prepend
214 ] { } assoc>map fix-help-header dup
215 [ dark-mode-css ] [ mobile-css ] bi 3append join-lines ;
217 :: css-styles-to-classes ( body -- stylesheet body )
218 H{ } clone :> classes
227 [ clone [ V{ } like ] change-alist ] change-attrs
228 "style" over delete-at* drop classes css-class
233 ] each classes sort-values css-classes body ;
235 : retina-image ( path -- path' )
236 "@2x" over subseq? [ "." split1-last "@2x." glue ] unless ;
238 : ?copy-file ( from to -- )
239 dup file-exists? [ 2drop ] [ copy-file ] if ;
241 : cache-images ( body -- body' )
245 T{ name { main "img" } } over tag-named? [
247 retina-image dup file-name
255 : help>html ( topic -- xml )
256 [ article-title " - Factor Documentation" append ]
258 [ print-topic ] with-html-writer
259 css-styles-to-classes cache-images
260 "resource:extra/websites/factorcode/favicon.ico" dup file-name ?copy-file
261 [ help-stylesheet help-meta prepend help-navbar ] dip help-footer
262 [XML <-><div class="page"><-><-></div> XML]
265 : generate-help-file ( topic -- )
266 dup topic>filename utf8 [ help>html write-xml ] with-file-writer ;
268 : all-vocabs-really ( -- seq )
269 all-disk-vocabs-recursive filter-vocabs
270 [ vocab-name "scratchpad" = ] reject ;
272 : all-topics ( -- topics )
274 articles get keys [ >link ] map %
275 all-words [ >link ] map %
276 all-authors [ <vocab-author> ] map %
277 all-tags [ <vocab-tag> ] map %
281 : serialize-index ( index file -- )
283 [ [ topic>filename ] dip ] { } assoc-map-as serialize
286 : generate-article-index ( -- )
287 articles get [ [ >link ] [ article-title ] bi* ] assoc-map
288 "articles.idx" serialize-index ;
290 : generate-word-index ( -- )
291 all-words [ dup name>> ] { } map>assoc
292 "words.idx" serialize-index ;
294 : generate-vocab-index ( -- )
295 all-vocabs-really [ dup vocab-name ] { } map>assoc
296 "vocabs.idx" serialize-index ;
298 : generate-indices ( -- )
299 generate-article-index
301 generate-vocab-index ;
303 : generate-help-files ( -- )
305 { recent-searches f }
307 { recent-articles f }
310 all-topics [ '[ _ generate-help-file ] try ] each
313 : generate-help ( -- )
323 MEMO: load-index ( name -- index )
324 binary file-contents bytes>object ;
326 : offline-apropos ( string index -- results )
327 load-index completions ;
329 : article-apropos ( string -- results )
330 "articles.idx" offline-apropos ;
332 : vocab-apropos ( string -- results )
333 "vocabs.idx" offline-apropos ;
335 : generate-qualified-index ( index -- )
338 over "," split1 nip ".html" ?tail drop
339 [ swap ":" glue 2array ] [ _ push-at ] bi
341 ] keep [ swap ] { } assoc-map-as
342 "qualified.idx" binary [ serialize ] with-file-writer ;
344 : qualified-index ( str index -- str index' )
347 dup file-exists? [ pick generate-qualified-index ] unless
348 load-index completions keys concat
349 ] [ drop f ] if [ append ] unless-empty ;
351 : word-apropos ( string -- results )
352 "words.idx" load-index qualified-index completions ;