1 ! Copyright (C) 2009 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: accessors arrays assocs classes classes.struct
4 classes.tuple combinators combinators.short-circuit debugger
5 definitions effects eval formatting fry grouping help
6 help.markup help.topics io io.streams.string kernel macros math
7 namespaces sequences sequences.deep sets splitting strings
8 summary tools.destructors unicode.categories vocabs
9 vocabs.loader words words.constant words.symbol ;
10 FROM: sets => members ;
13 ERROR: simple-lint-error message ;
15 M: simple-lint-error summary message>> ;
17 M: simple-lint-error error. summary print ;
21 SYMBOL: vocab-articles
23 : check-example ( element -- )
28 [ (eval>string) ] call( code -- output )
32 ] vocabs-quot get call( quot -- )
33 ] leaks members length [
34 "%d disposable(s) leaked in example" sprintf simple-lint-error
37 : check-examples ( element -- )
38 \ $example swap elements [ check-example ] each ;
40 : extract-values ( element -- seq )
41 \ $values swap elements
42 [ f ] [ first rest keys ] if-empty ;
44 : extract-value-effects ( element -- seq )
45 \ $values swap elements [ f ] [
47 \ $quotation swap elements [ f ] [
48 first second dup effect? [ effect>string ] when
53 : effect-values ( word -- seq )
55 [ in>> ] [ out>> ] bi append
56 [ dup pair? [ first ] when effect>string ] map members ;
58 : effect-effects ( word -- seq )
61 [ second dup effect? [ effect>string ] [ drop f ] if ]
65 : contains-funky-elements? ( element -- ? )
73 } swap '[ _ elements empty? not ] any? ;
75 : don't-check-word? ( word -- ? )
80 [ "declared-effect" word-prop not ]
84 : skip-check-values? ( word element -- ? )
85 [ don't-check-word? ] [ contains-funky-elements? ] bi* or ;
87 : check-values ( word element -- )
88 2dup skip-check-values? [ 2drop ] [
89 [ effect-values ] [ extract-values ] bi* 2dup
91 "$values don't match stack effect; expected %u, got %u" sprintf
96 : check-value-effects ( word element -- )
97 [ effect-effects ] [ extract-value-effects ] bi*
98 [ 2dup and [ = ] [ 2drop t ] if ] 2all? [
99 "$quotation stack effects in $values don't match"
103 : check-nulls ( element -- )
104 \ $values swap elements
105 null swap deep-member?
106 [ "$values should not contain null" simple-lint-error ] when ;
108 : check-see-also ( element -- )
109 \ $see-also swap elements [ rest all-unique? ] all?
110 [ "$see-also are not unique" simple-lint-error ] unless ;
112 : vocab-exists? ( name -- ? )
113 [ lookup-vocab ] [ all-vocabs get member? ] bi or ;
115 : check-modules ( element -- )
116 \ $vocab-link swap elements [
119 "$vocab-link to non-existent vocabulary"
124 : check-rendering ( element -- )
125 [ print-content ] with-string-writer drop ;
127 : check-strings ( str -- )
130 "Paragraph text should not contain \\n or \\t"
135 "Paragraph text should not contain double spaces"
140 : check-whitespace ( str1 str2 -- )
141 [ " " tail? ] [ " " head? ] bi* or
142 [ "Missing whitespace between strings" simple-lint-error ] unless ;
144 : check-bogus-nl ( element -- )
145 { { $nl } { { $nl } } } [ head? ] with any? [
146 "Simple element should not begin with a paragraph break"
150 : extract-slots ( elements -- seq )
151 [ dup pair? [ first \ $slot = ] [ drop f ] if ] deep-filter
154 : check-class-description ( word element -- )
155 \ $class-description swap elements over class? [
157 dup struct-class? [ struct-slots ] [ all-slots ] if
159 ] [ extract-slots ] bi*
160 [ swap member? ] with reject [
161 ", " join "Described $slot does not exist: " prepend
166 "A word that is not a class has a $class-description"
171 : check-article-title ( article -- )
172 article-title first LETTER?
173 [ "Article title must begin with a capital letter" simple-lint-error ] unless ;
175 : check-elements ( element -- )
178 [ [ string? ] filter [ check-strings ] each ]
179 [ [ simple-element? ] filter [ check-elements ] each ]
180 [ 2 <clumps> [ [ string? ] all? ] filter [ first2 check-whitespace ] each ]
183 : check-descriptions ( element -- )
184 { $description $class-description $var-description }
187 rest { { } { "" } } member?
188 [ "Empty $description" simple-lint-error ] when
192 : check-markup ( element -- )
198 [ check-descriptions ]
201 : files>vocabs ( -- assoc )
203 [ [ [ vocab-docs-path ] keep ] H{ } map>assoc ]
204 [ [ [ vocab-source-path ] keep ] H{ } map>assoc ]
207 : group-articles ( -- assoc )
213 [ first _ at _ push-at ] [ 2drop ] if
217 : all-word-help ( words -- seq )
218 [ word-help ] filter ;