core: subseq-index? -> subseq-of?

[factor.git] / basis / help / lint / checks / checks.factor

diff --git a/basis/help/lint/checks/checks.factor b/basis/help/lint/checks/checks.factor
index 8a31cac7c553cff59507e98a98b190833c8ef322..dfac066116ed37f08d15db58316d03423f9f8fb9 100644 (file)
--- a/basis/help/lint/checks/checks.factor
+++ b/basis/help/lint/checks/checks.factor
@@ -1,12 +1,12 @@
 ! Copyright (C) 2009 Slava Pestov.
 ! See http://factorcode.org/license.txt for BSD license.
-USING: accessors arrays assocs classes classes.tuple combinators
-combinators.short-circuit debugger definitions effects eval
-formatting fry grouping help help.markup help.topics io io.streams.string
-kernel macros math namespaces sequences sequences.deep sets splitting
-strings summary threads tools.destructors unicode.categories vocabs vocabs.loader
-words words.constant words.symbol ;
-FROM: sets => members ;
+USING: accessors arrays assocs classes classes.struct
+classes.tuple combinators combinators.short-circuit debugger
+definitions effects eval formatting grouping help help.markup
+help.topics io io.streams.string kernel macros math
+math.statistics namespaces prettyprint sequences sequences.deep
+sets splitting strings summary tools.destructors unicode vocabs
+vocabs.loader words words.constant words.symbol ;
 IN: help.lint.checks
 
 ERROR: simple-lint-error message ;
@@ -16,39 +16,58 @@ M: simple-lint-error summary message>> ;
 M: simple-lint-error error. summary print ;
 
 SYMBOL: vocabs-quot
-SYMBOL: all-vocabs
 SYMBOL: vocab-articles
 
+: no-ui-disposables ( seq -- seq' )
+    [
+        class-of name>> {
+            "single-texture" "multi-texture" ! opengl.textures
+            "line" ! core-text
+            "layout" ! ui.text.pango
+            "script-string" ! windows.uniscribe
+            "linux-monitor" ! github issue #2014, race condition in disposing of child monitors
+            "event-stream"
+            "macosx-monitor"
+            "recursive-monitor"
+            "input-port"
+            "malloc-ptr"
+            "fd"
+        } member?
+    ] reject ;
+
 : check-example ( element -- )
     [
         '[
             _ rest [
-                but-last "\n" join
-                [ (eval>string) ] call( code -- output )
+                but-last join-lines
+                (eval-with-stack>string)
                 "\n" ?tail drop
             ] keep
             last assert=
         ] vocabs-quot get call( quot -- )
-    ] leaks members length [
-        "%d disposable(s) leaked in example" sprintf simple-lint-error
-    ] unless-zero ;
+    ] leaks members no-ui-disposables
+    dup length 0 > [
+       dup [ class-of ] histogram-by
+       [ "Leaked resources: " write ... ] with-string-writer simple-lint-error
+    ] [
+        drop
+    ] if ;
 
 : check-examples ( element -- )
     \ $example swap elements [ check-example ] each ;
 
 : extract-values ( element -- seq )
-    \ $values swap elements dup empty? [
-        first rest keys
-    ] unless ;
+    \ $values swap elements
+    [ f ] [ first rest keys ] if-empty ;
 
 : extract-value-effects ( element -- seq )
-    \ $values swap elements dup empty? [
+    \ $values swap elements [ f ] [
         first rest [
-            \ $quotation swap elements dup empty? [ drop f ] [
-                first second
-            ] if
+            \ $quotation swap elements [ f ] [
+                first second dup effect? [ effect>string ] when
+            ] if-empty
         ] map
-    ] unless ;
+    ] if-empty ;
 
 : effect-values ( word -- seq )
     stack-effect
@@ -79,6 +98,7 @@ SYMBOL: vocab-articles
         [ parsing-word? ]
         [ "declared-effect" word-prop not ]
         [ constant? ]
+        [ "help" word-prop not ]
     } 1|| ;
 
 : skip-check-values? ( word element -- ? )
@@ -94,24 +114,15 @@ SYMBOL: vocab-articles
     ] if ;
 
 : check-value-effects ( word element -- )
-    [ effect-effects ]
-    [ extract-value-effects ]
-    bi* [ 2dup and [ = ] [ 2drop t ] if ] 2all?
-    [ "$quotation documentation in $values don't match stack effect" simple-lint-error ]
-    unless ;
-
-: check-nulls ( element -- )
-    \ $values swap elements
-    null swap deep-member?
-    [ "$values should not contain null" simple-lint-error ] when ;
+    [ effect-effects ] [ extract-value-effects ] bi*
+    [ 2dup and [ = ] [ 2drop t ] if ] 2all? [
+        "$quotation stack effects in $values don't match"
+        simple-lint-error
+    ] unless ;
 
 : check-see-also ( element -- )
-    \ $see-also swap elements [
-        rest all-unique? t assert=
-    ] each ;
-
-: vocab-exists? ( name -- ? )
-    [ lookup-vocab ] [ all-vocabs get member? ] bi or ;
+    \ $see-also swap elements [ rest all-unique? ] all?
+    [ "$see-also are not unique" simple-lint-error ] unless ;
 
 : check-modules ( element -- )
     \ $vocab-link swap elements [
@@ -122,6 +133,10 @@ SYMBOL: vocab-articles
         ] unless
     ] each ;
 
+: check-slots-tables ( element -- )
+    \ $slots swap elements [ rest [ length 2 = ] all?  ] all?
+    [ "$slots have too many values in at least one row" simple-lint-error ] unless ;
+
 : check-rendering ( element -- )
     [ print-content ] with-string-writer drop ;
 
@@ -132,7 +147,7 @@ SYMBOL: vocab-articles
             simple-lint-error
         ] when
     ] [
-        "  " swap subseq? [
+        "  " subseq-of? [
             "Paragraph text should not contain double spaces"
             simple-lint-error
         ] when
@@ -154,8 +169,11 @@ SYMBOL: vocab-articles
 
 : check-class-description ( word element -- )
     \ $class-description swap elements over class? [
-        [ all-slots [ name>> ] map ] [ extract-slots ] bi*
-        [ swap member? not ] with filter [
+        [
+            dup struct-class? [ struct-slots ] [ all-slots ] if
+            [ name>> ] map
+        ] [ extract-slots ] bi*
+        [ swap member? ] with reject [
             ", " join "Described $slot does not exist: " prepend
             simple-lint-error
         ] unless-empty
@@ -194,10 +212,11 @@ SYMBOL: vocab-articles
         [ check-examples ]
         [ check-modules ]
         [ check-descriptions ]
+        [ check-slots-tables ]
     } cleave ;
 
 : files>vocabs ( -- assoc )
-    vocabs
+    loaded-vocab-names
     [ [ [ vocab-docs-path ] keep ] H{ } map>assoc ]
     [ [ [ vocab-source-path ] keep ] H{ } map>assoc ]
     bi assoc-union ;