]> gitweb.factorcode.org Git - factor.git/blobdiff - basis/tools/crossref/crossref.factor
use reject instead of [ ... not ] filter.
[factor.git] / basis / tools / crossref / crossref.factor
index 36ccaadc9849f236bbb16e51ac99027f361d88e1..04aae88ae8776043f896e97aafa347da4be18146 100644 (file)
@@ -1,9 +1,106 @@
-! Copyright (C) 2005, 2009 Slava Pestov.
+! Copyright (C) 2005, 2010 Slava Pestov.
 ! See http://factorcode.org/license.txt for BSD license.
-USING: assocs definitions io io.styles kernel prettyprint
-sorting see ;
+USING: accessors arrays assocs combinators.smart compiler.units
+generic generic.single graphs hash-sets.identity hashtables help
+help.crossref help.markup help.topics init io io.pathnames
+io.styles kernel namespaces quotations see sequences sets
+sorting source-files threads vocabs words ;
 IN: tools.crossref
 
+SYMBOL: crossref
+
+GENERIC: uses ( defspec -- seq )
+
+<PRIVATE
+
+SYMBOL: visited
+
+GENERIC# quot-uses 1 ( obj set -- )
+
+M: object quot-uses 2drop ;
+
+M: word quot-uses over crossref? [ adjoin ] [ 2drop ] if ;
+
+: seq-uses ( seq set -- )
+    over visited get ?adjoin [
+        [ quot-uses ] curry each
+    ] [ 2drop ] if ; inline
+
+: assoc-uses ( assoc' set -- )
+    over visited get ?adjoin [
+        [ quot-uses ] curry [ bi@ ] curry assoc-each
+    ] [ 2drop ] if ; inline
+
+M: array quot-uses seq-uses ;
+
+M: hashtable quot-uses assoc-uses ;
+
+M: callable quot-uses seq-uses ;
+
+M: wrapper quot-uses [ wrapped>> ] dip quot-uses ;
+
+M: callable uses ( quot -- seq )
+    IHS{ } clone visited [
+        HS{ } clone [ quot-uses ] keep members
+    ] with-variable ;
+
+M: word uses def>> uses ;
+
+M: link uses
+    [ { $subsection $subsections $link $see-also } article-links [ >link ] map ]
+    [ { $vocab-link } article-links [ >vocab-link ] map ]
+    bi append ;
+
+M: pathname uses string>> source-file top-level-form>> [ uses ] [ { } ] if* ;
+
+! To make UI browser happy
+M: object uses drop f ;
+
+: crossref-def ( defspec -- )
+    dup uses crossref get-global add-vertex ;
+
+: defs-to-crossref ( -- seq )
+    [
+        all-words
+        [ [ generic? ] reject ]
+        [ [ subwords ] map concat ] bi
+
+        all-articles [ >link ] map
+
+        source-files get keys [ <pathname> ] map
+    ] append-outputs ;
+
+: build-crossref ( -- crossref )
+    "Computing usage index... " write flush yield
+    H{ } clone [
+        crossref set-global
+        defs-to-crossref [ crossref-def ] each
+    ] keep
+    "done" print flush ;
+
+: get-crossref ( -- crossref )
+    crossref get-global [ build-crossref ] unless* ;
+
+GENERIC: irrelevant? ( defspec -- ? )
+
+M: object irrelevant? drop f ;
+
+M: default-method irrelevant? drop t ;
+
+M: predicate-engine-word irrelevant? drop t ;
+
+PRIVATE>
+
+: usage ( defspec -- seq ) get-crossref at keys ;
+
+GENERIC: smart-usage ( defspec -- seq )
+
+M: object smart-usage usage [ irrelevant? ] reject ;
+
+M: method smart-usage "method-generic" word-prop smart-usage ;
+
+M: f smart-usage drop \ f smart-usage ;
+
 : synopsis-alist ( definitions -- alist )
     [ [ synopsis ] keep ] { } map>assoc ;
 
@@ -14,4 +111,36 @@ IN: tools.crossref
     synopsis-alist sort-keys definitions. ;
 
 : usage. ( word -- )
-    smart-usage sorted-definitions. ;
+    smart-usage
+    [ "No usages." print ] [ sorted-definitions. ] if-empty ;
+
+: vocab-xref ( vocab quot: ( defspec -- seq ) -- vocabs )
+    [ [ vocab-name ] [ words [ generic? ] reject ] bi ] dip map
+    [
+        [ [ word? ] [ generic? not ] bi and ] filter [
+            dup method?
+            [ "method-generic" word-prop ] when
+            vocabulary>>
+        ] map
+    ] gather natural-sort remove sift ; inline
+
+: vocabs. ( seq -- )
+    [ dup >vocab-link write-object nl ] each ;
+
+: vocab-uses ( vocab -- vocabs ) [ uses ] vocab-xref ;
+
+: vocab-uses. ( vocab -- ) vocab-uses vocabs. ;
+
+: vocab-usage ( vocab -- vocabs ) [ usage ] vocab-xref ;
+
+: vocab-usage. ( vocab -- ) vocab-usage vocabs. ;
+
+<PRIVATE
+
+SINGLETON: invalidate-crossref
+
+M: invalidate-crossref definitions-changed 2drop crossref global delete-at ;
+
+[ invalidate-crossref add-definition-observer ] "tools.crossref" add-startup-hook
+
+PRIVATE>