1 ! Copyright (C) 2005, 2010 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: words assocs definitions io io.pathnames io.styles kernel
4 prettyprint sorting see sets sequences arrays hashtables help
5 help.crossref help.topics help.markup quotations accessors
6 source-files namespaces graphs vocabs generic generic.single
7 threads compiler.units init combinators.smart ;
12 GENERIC: uses ( defspec -- seq )
18 GENERIC# quot-uses 1 ( obj assoc -- )
20 M: object quot-uses 2drop ;
22 M: word quot-uses over crossref? [ conjoin ] [ 2drop ] if ;
24 : (seq-uses) ( seq assoc -- )
25 [ quot-uses ] curry each ;
27 : seq-uses ( seq assoc -- )
28 over visited get member-eq? [ 2drop ] [
33 : assoc-uses ( assoc' assoc -- )
34 over visited get member-eq? [ 2drop ] [
36 [ >alist ] dip (seq-uses)
39 M: array quot-uses seq-uses ;
41 M: hashtable quot-uses assoc-uses ;
43 M: callable quot-uses seq-uses ;
45 M: wrapper quot-uses [ wrapped>> ] dip quot-uses ;
47 M: callable uses ( quot -- assoc )
49 H{ } clone [ quot-uses ] keep keys
52 M: word uses def>> uses ;
55 [ { $subsection $subsections $link $see-also } article-links [ >link ] map ]
56 [ { $vocab-link } article-links [ >vocab-link ] map ]
59 M: pathname uses string>> source-file top-level-form>> [ uses ] [ { } ] if* ;
61 ! To make UI browser happy
62 M: vocab uses drop f ;
64 : crossref-def ( defspec -- )
65 dup uses crossref get add-vertex ;
67 : defs-to-crossref ( -- seq )
70 [ [ generic? not ] filter ]
71 [ [ subwords ] map concat ] bi
73 all-articles [ >link ] map
75 source-files get keys [ <pathname> ] map
78 : build-crossref ( -- crossref )
79 "Computing usage index... " write flush yield
82 defs-to-crossref [ crossref-def ] each
86 : get-crossref ( -- crossref )
87 crossref get-global [ build-crossref ] unless* ;
89 GENERIC: irrelevant? ( defspec -- ? )
91 M: object irrelevant? drop f ;
93 M: default-method irrelevant? drop t ;
95 M: predicate-engine irrelevant? drop t ;
99 : usage ( defspec -- seq ) get-crossref at keys ;
101 GENERIC: smart-usage ( defspec -- seq )
103 M: object smart-usage usage [ irrelevant? not ] filter ;
105 M: method smart-usage "method-generic" word-prop smart-usage ;
107 M: f smart-usage drop \ f smart-usage ;
109 : synopsis-alist ( definitions -- alist )
110 [ [ synopsis ] keep ] { } map>assoc ;
112 : definitions. ( alist -- )
113 [ write-object nl ] assoc-each ;
115 : sorted-definitions. ( definitions -- )
116 synopsis-alist sort-keys definitions. ;
120 [ "No usages." print ] [ sorted-definitions. ] if-empty ;
122 : vocab-xref ( vocab quot -- vocabs )
123 [ [ vocab-name ] [ words [ generic? not ] filter ] bi ] dip map
125 [ [ word? ] [ generic? not ] bi and ] filter [
127 [ "method-generic" word-prop ] when
130 ] gather natural-sort remove sift ; inline
133 [ dup >vocab-link write-object nl ] each ;
135 : vocab-uses ( vocab -- vocabs ) [ uses ] vocab-xref ;
137 : vocab-uses. ( vocab -- ) vocab-uses vocabs. ;
139 : vocab-usage ( vocab -- vocabs ) [ usage ] vocab-xref ;
141 : vocab-usage. ( vocab -- ) vocab-usage vocabs. ;
145 SINGLETON: invalidate-crossref
147 M: invalidate-crossref definitions-changed 2drop crossref global delete-at ;
149 [ invalidate-crossref add-definition-observer ] "tools.crossref" add-startup-hook