1 ! Copyright (C) 2009, 2010 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: accessors arrays assocs classes classes.builtin
4 classes.intersection classes.mixin classes.predicate classes.singleton
5 classes.tuple classes.union combinators definitions effects generic
6 generic.single generic.standard generic.hook io io.pathnames
7 io.streams.string io.styles kernel make namespaces prettyprint
8 prettyprint.backend prettyprint.config prettyprint.custom
9 prettyprint.sections sequences sets sorting strings summary words
10 words.symbol words.constant words.alias vocabs slots ;
11 FROM: namespaces => set ;
12 FROM: classes => members ;
15 GENERIC: synopsis* ( defspec -- )
17 GENERIC: see* ( defspec -- )
19 : see ( defspec -- ) see* nl ;
21 : synopsis ( defspec -- str )
26 ] with-string-writer ;
28 : definer. ( defspec -- )
29 definer drop pprint-word ;
31 : comment. ( text -- )
32 H{ { font-style italic } } styled-text ;
34 GENERIC: print-stack-effect? ( word -- ? )
36 M: parsing-word print-stack-effect? drop f ;
37 M: symbol print-stack-effect? drop f ;
38 M: constant print-stack-effect? drop f ;
39 M: alias print-stack-effect? drop f ;
40 M: word print-stack-effect? drop t ;
42 : stack-effect. ( word -- )
43 [ print-stack-effect? ] [ stack-effect ] bi and
44 [ pprint-effect ] when* ;
48 : seeing-word ( word -- )
49 vocabulary>> dup [ vocab ] when pprinter-in set ;
51 : word-synopsis ( word -- )
59 M: word synopsis* word-synopsis ;
61 M: simple-generic synopsis* word-synopsis ;
63 M: standard-generic synopsis*
72 M: hook-generic synopsis*
77 [ "combination" word-prop var>> pprint* ]
83 [ "method-class" word-prop pprint-word ]
84 [ "method-generic" word-prop pprint-word ] tri ;
86 M: mixin-instance synopsis*
88 [ class>> pprint-word ]
89 [ mixin>> pprint-word ] tri ;
91 M: pathname synopsis* pprint* ;
93 M: word summary synopsis ;
95 GENERIC: declarations. ( obj -- )
97 M: object declarations. drop ;
99 : declaration. ( word prop -- )
100 [ nip ] [ name>> word-prop ] 2bi
101 [ pprint-word ] [ drop ] if ;
103 M: word declarations.
111 } [ declaration. ] with each ;
113 : pprint-; ( -- ) \ ; pprint-word ;
120 <block dup definition pprint-elements block>
121 dup definer nip [ pprint-word ] when* declarations.
125 GENERIC: see-class* ( word -- )
127 M: union-class see-class*
128 <colon \ UNION: pprint-word
130 members pprint-elements pprint-; block> ;
132 M: intersection-class see-class*
133 <colon \ INTERSECTION: pprint-word
135 participants pprint-elements pprint-; block> ;
137 M: mixin-class see-class*
138 <block \ MIXIN: pprint-word
139 dup pprint-word <block
142 \ INSTANCE: pprint-word pprint-word pprint-word
143 ] with each block> block> ;
145 M: predicate-class see-class*
146 <colon \ PREDICATE: pprint-word
149 dup superclass pprint-word
151 "predicate-definition" word-prop pprint-elements
152 pprint-; block> block> ;
154 M: singleton-class see-class* ( class -- )
155 \ SINGLETON: pprint-word pprint-word ;
157 GENERIC: pprint-slot-name ( object -- )
159 M: string pprint-slot-name text ;
161 M: array pprint-slot-name
162 <flow \ { pprint-word
163 f <inset unclip text pprint-elements block>
164 \ } pprint-word block> ;
166 : unparse-slot ( slot-spec -- array )
169 dup class>> object eq? [
175 dup [ class>> object eq? not ] [ initial>> ] bi or [
182 : pprint-slot ( slot-spec -- )
184 dup length 1 = [ first ] when
187 : tuple-declarations. ( class -- )
188 \ final declaration. ;
190 : superclass. ( class -- )
191 superclass dup tuple eq? [ drop ] [ "<" text pprint-word ] if ;
193 M: tuple-class see-class*
194 <colon \ TUPLE: pprint-word
198 [ <block "slots" word-prop [ pprint-slot ] each block> pprint-; ]
199 [ tuple-declarations. ]
203 M: word see-class* drop ;
205 M: builtin-class see-class*
206 drop "! Built-in class" comment. ;
208 : see-class ( class -- )
211 [ seeing-word ] [ see-class* ] bi
217 [ [ class? ] [ symbol? not ] bi and [ nl nl ] when ]
219 dup [ class? ] [ symbol? ] bi and
220 [ drop ] [ call-next-method ] if
223 : seeing-implementors ( class -- seq )
225 [ [ reader? ] [ writer? ] bi or not ] filter
229 : seeing-methods ( generic -- seq )
230 "methods" word-prop values natural-sort ;
235 natural-sort [ nl nl ] [ see* ] interleave ;
237 : methods ( word -- seq )
239 dup class? [ dup seeing-implementors % ] when
240 dup generic? [ dup seeing-methods % ] when
244 : see-methods ( word -- )