]> gitweb.factorcode.org Git - factor.git/blobdiff - extra/lint/lint.factor
use reject instead of [ ... not ] filter.
[factor.git] / extra / lint / lint.factor
index dcf52f723a341e31b349a30cfb6d5ae28161e63a..2d33c0352026d90307fbd1dbea9087c65ab846b4 100644 (file)
-! Copyright (C) 2007 Doug Coleman.
+! Copyright (C) 2007, 2008, 2011 Doug Coleman.
 ! See http://factorcode.org/license.txt for BSD license.
-USING: alien alien.accessors arrays assocs combinators.lib io kernel
-macros math namespaces prettyprint quotations sequences
-vectors vocabs words html.elements slots.private tar ;
-IN: lint
-
-SYMBOL: def-hash
-SYMBOL: def-hash-keys
 
-: set-hash-vector ( val key hash -- )
-    2dup at -rot >r >r ?push r> r> set-at ;
+USING: accessors alien arrays assocs classes
+classes.tuple.private combinators.short-circuit continuations
+fry hashtables io kernel kernel.private locals.backend make math
+math.private namespaces prettyprint quotations sequences
+sequences.deep shuffle slots.private splitting stack-checker
+vectors vocabs words words.alias ;
 
-: add-word-def ( word quot -- )
-    dup callable? [
-        def-hash get-global set-hash-vector
-    ] [
-        2drop
-    ] if ;
+IN: lint
 
-: more-defs
+<PRIVATE
+
+CONSTANT: manual-substitutions
+    H{
+        { -rot [ swap [ swap ] dip ] }
+        { -rot [ swap swapd ] }
+        { rot [ [ swap ] dip swap ] }
+        { rot [ swapd swap ] }
+        { over [ dup swap ] }
+        { swapd [ [ swap ] dip ] }
+        { 2nip [ nip nip ] }
+        { 2drop [ drop drop ] }
+        { 3drop [ drop drop drop ] }
+        { pop* [ pop drop ] }
+        { when [ [ ] if ] }
+        { >boolean [ f = not ] }
+    }
+
+CONSTANT: trivial-defs
     {
-        { [ swap >r swap r> ] -rot }
-        { [ swap swapd ] -rot }
-        { [ >r swap r> swap ] rot }
-        { [ swapd swap ] rot }
-        { [ dup swap ] over }
-        { [ dup -rot ] tuck }
-        { [ >r swap r> ] swapd }
-        { [ nip nip ] 2nip }
-        { [ drop drop ] 2drop }
-        { [ drop drop drop ] 3drop }
-        { [ 0 = ] zero? }
-        { [ pop drop ] pop* }
-        { [ [ ] if ] when }
-    } [ first2 swap add-word-def ] each ;
-
-: accessor-words ( -- seq )
-{
-    alien-signed-1 alien-signed-2 alien-signed-4 alien-signed-8
-    alien-unsigned-1 alien-unsigned-2 alien-unsigned-4 alien-unsigned-8
-    <displaced-alien> alien-unsigned-cell set-alien-signed-cell
-    set-alien-unsigned-1 set-alien-signed-1 set-alien-unsigned-2
-    set-alien-signed-2 set-alien-unsigned-4 set-alien-signed-4
-    set-alien-unsigned-8 set-alien-signed-8
-    alien-cell alien-signed-cell set-alien-cell set-alien-unsigned-cell
-    set-alien-float alien-float
-} ;
-
-: trivial-defs
+        [ ">" write ] [ "/>" write ] [ " " write ]
+        [ 0 or + ]
+        [ dup length iota ]
+        [ 0 swap copy ]
+        [ dup length ]
+        [ 0 swap ]
+        [ 2dup = ] [ 2dup eq? ]
+        [ = not ] [ eq? not ]
+        [ boa throw ]
+        [ with each ] [ with map ]
+        [ curry filter ]
+        [ compose compose ]
+        [ empty? ] [ empty? not ]
+        [ dup empty? ] [ dup empty? not ]
+        [ 2dup both-fixnums? ]
+        [ [ drop ] prepose ]
+        [ 1 0 ? ]
+    }
+
+: lintable-word? ( word -- ? )
     {
-        [ get ] [ t ] [ { } ] [ . ] [ drop f ]
-        [ drop ] [ f ] [ first ] [ second ] [ third ] [ fourth ]
-        [ ">" write-html ] [ <unimplemented-typeflag> throw ]
-        [ "/>" write-html ]
-    } ;
-
-H{ } clone def-hash set-global
-all-words [ dup word-def add-word-def ] each
-more-defs
-
-! Remove empty word defs
-def-hash get-global [
-    drop empty? not
-] assoc-subset
-
-! Remove constants [ 1 ]
-[
-    drop dup length 1 = swap first number? and not
-] assoc-subset
-
-! Remove set-alien-cell, etc.
-[
-    drop [ accessor-words swap seq-diff ] keep [ length ] bi@ =
-] assoc-subset
-
-! Remove trivial defs
-[
-    drop trivial-defs member? not
-] assoc-subset
-
-! Remove n m shift defs
-[
-    drop dup length 3 = [
-        dup first2 [ number? ] both?
-        swap third \ shift = and not
-    ] [ drop t ] if
-] assoc-subset 
-
-! Remove [ n slot ]
-[
-    drop dup length 2 = [
-        first2 \ slot = swap number? and not
-    ] [ drop t ] if
-] assoc-subset def-hash set-global
-
-: find-duplicates
-    def-hash get-global [
-        nip length 1 >
-    ] assoc-subset ;
-
-def-hash get-global keys def-hash-keys set-global
+        [ vocabulary>> "specialized-" head? ]
+        [ vocabulary>> "windows-messages" = ]
+        [ alias? ]
+    } 1|| not ;
 
-GENERIC: lint ( obj -- seq )
+: lintable-words ( -- words )
+    all-words [ lintable-word? ] filter ;
 
-M: object lint ( obj -- seq )
-    drop f ;
+: ignore-def? ( def -- ? )
+    {
+        ! Remove small defs
+        [ length 1 <= ]
+
+        ! Remove trivial defs
+        [ trivial-defs member? ]
+
+        ! Remove curry only defs
+        [ [ \ curry = ] all? ]
+
+        ! Remove words with locals
+        [ [ \ load-locals = ] any? ]
+
+        ! Remove stuff with wrappers
+        [ [ wrapper? ] any? ]
+
+        ! Remove trivial math
+        [ [ { [ number? ] [ { + - / * /i /f >integer } member? ] } 1|| ] all? ]
+
+        ! Remove more trival defs
+        [
+            {
+                [ length 2 = ]
+                [ first2 [ word? ] either? ]
+                [ first2 [ { dip dup over swap drop } member? ] either? ]
+            } 1&&
+        ]
+
+        ! Remove [ V{ } clone ] and related
+        [
+            {
+                [ length 2 = ]
+                [ first { [ sequence? ] [ assoc? ] } 1|| ]
+                [ second { clone clone-like like assoc-like make } member? ]
+            } 1&&
+        ]
+
+        ! Remove [ foo get ] and related
+        [
+            {
+                [ length 2 = ]
+                [ first word? ]
+                [ second { get get-global , % } member? ]
+            } 1&&
+        ]
+
+        ! Remove [ first second ] and related
+        [
+            {
+                [ length 2 = ]
+                [ first { first second third } member? ]
+                [ second { first second third } member? ]
+            } 1&&
+        ]
+
+        ! Remove [ [ trivial ] if ] and related
+        [
+            {
+                [ length 2 = ]
+                [ first { [ quotation? ] [ ignore-def? ] } 1&& ]
+                [ second { if if* unless unless* when when* curry } member? ]
+            } 1&&
+        ]
+
+        ! Remove [ n - ] and related
+        [
+            {
+                [ length 2 = ]
+                [ first { [ number? ] [ boolean? ] } 1|| ]
+                [ second { + - / * < <= = >= > shift bitand bitor bitxor eq? } member? ]
+            } 1&&
+        ]
+
+        ! Remove [ dup 0 > ] and related
+        [
+            {
+                [ length 3 = ]
+                [ first { dup over } member? ]
+                [ second number? ]
+                [ third { + - / * < <= = >= > } member? ]
+            } 1&&
+        ]
+
+        ! Remove [ drop f f ] and related
+        [
+            {
+                [ length 4 <= ]
+                [ first { drop 2drop 3drop nip 2nip } member? ]
+                [ rest-slice [ boolean? ] all? ]
+            } 1&&
+        ]
+
+        ! Remove [ length 1 = ] and related
+        [
+            {
+                [ length 3 = ]
+                [ first \ length = ]
+                [ second number? ]
+                [ third { + - / * < <= = >= > } member? ]
+            } 1&&
+        ]
+
+        ! Remove [ dup length 1 = ] and related
+        [
+            {
+                [ length 4 = ]
+                [ first { dup over } member? ]
+                [ second \ length = ]
+                [ third number? ]
+                [ fourth { + - / * < <= = >= > } member? ]
+            } 1&&
+        ]
+
+        ! Remove numbers/t/f only defs
+        [
+            [ { [ number? ] [ boolean? ] } 1|| ] all?
+        ]
+
+        ! Remove [ tag n eq? ]
+        [
+            {
+                [ length 3 = ]
+                [ first \ tag = ] [ second number? ] [ third \ eq? = ]
+            } 1&&
+        ]
+
+        ! Remove [ { foo } declare class-of ]
+        [
+            {
+                [ length 3 = ]
+                [ first { [ array? ] [ length 1 = ] } 1&& ]
+                [ second \ declare = ]
+                [ third \ class-of = ]
+            } 1&&
+        ]
+
+        ! Remove [ m n shift ]
+        [
+            {
+                [ length 3 = ]
+                [ first2 [ number? ] both? ] [ third \ shift = ]
+            } 1&&
+        ]
+
+        ! Remove [ layout-of n slot ]
+        [
+            {
+                [ length 3 = ]
+                [ first \ layout-of = ]
+                [ second number? ]
+                [ third \ slot = ]
+            } 1&&
+        ]
+    } 1|| ;
+
+: all-callables ( def -- seq )
+    [ { [ callable? ] [ ignore-def? not ] } 1&& ] deep-filter ;
+
+: (load-definitions) ( word def hash -- )
+    [ all-callables ] dip '[ _ push-at ] with each ;
+
+: load-definitions ( words -- hash )
+    H{ } clone [ '[ dup def>> _ (load-definitions) ] each ] keep ;
+
+SYMBOL: lint-definitions
+SYMBOL: lint-definitions-keys
+
+: reload-definitions ( -- )
+    ! Load lintable and non-ignored definitions
+    lintable-words load-definitions
+
+    ! Remove words that are their own definition
+    [ [ [ def>> ] [ 1quotation ] bi = ] reject ] assoc-map
+
+    ! Add manual definitions
+    manual-substitutions over '[ _ push-at ] assoc-each
+
+    ! Set globals to new values
+    [ lint-definitions set-global ]
+    [ keys lint-definitions-keys set-global ] bi ;
+
+: find-duplicates ( -- seq )
+    lint-definitions get-global [ nip length 1 > ] assoc-filter ;
+
+GENERIC: lint ( obj -- seq )
 
-: subseq/member? ( subseq/member seq -- ? )
-    { [ 2dup start ] [ 2dup member? ] } || 2nip ;
+M: object lint ( obj -- seq ) drop f ;
 
 M: callable lint ( quot -- seq )
-    def-hash-keys get [
-        swap subseq/member?
-    ] with subset ;
+    [ lint-definitions-keys get-global ] dip '[ _ subseq? ] filter ;
 
-M: word lint ( word -- seq )
-    word-def dup callable? [ lint ] [ drop f ] if ;
+M: word lint ( word -- seq/f )
+    def>> [ callable? ] deep-filter [ lint ] map concat ;
 
 : word-path. ( word -- )
-    [ word-vocabulary ":" ] keep unparse 3append write nl ;
+    [ vocabulary>> write ":" write ] [ . ] bi ;
+
+: 4bl ( -- ) bl bl bl bl ;
 
 : (lint.) ( pair -- )
-    first2 >r word-path. r> [
-        bl bl bl bl
-        dup .
-        "-----------------------------------" print
-        def-hash get at [ bl bl bl bl word-path. ] each
-        nl
-    ] each nl nl ;
-
-: lint. ( alist -- )
-    [ (lint.) ] each ;
-    
+    first2 [ word-path. ] dip [
+        [ 4bl .  "-----------------------------------" print ]
+        [ lint-definitions get-global at [ 4bl word-path. ] each nl ] bi
+    ] each nl ;
+
+: lint. ( alist -- ) [ (lint.) ] each ;
 
 GENERIC: run-lint ( obj -- obj )
 
-: (trim-self)
-    def-hash get-global at* [
-        dupd remove empty? not
-    ] [
-        drop f
-    ] if ;
+: (trim-self) ( val key -- obj ? )
+    lint-definitions get-global at*
+    [ dupd remove empty? not ] [ drop f ] if ;
 
 : trim-self ( seq -- newseq )
-    [ [ (trim-self) ] subset ] assoc-map ;
+    [ [ (trim-self) ] filter ] assoc-map ;
 
 : filter-symbols ( alist -- alist )
     [
-        nip first dup def-hash get at
+        nip first dup lint-definitions get-global at
         [ first ] bi@ literalize = not
-    ] assoc-subset ;
+    ] assoc-filter ;
 
 M: sequence run-lint ( seq -- seq )
-    [
-        global [ dup . flush ] bind
-        dup lint
-    ] { } map>assoc
-    trim-self
-    [ second empty? not ] subset
-    filter-symbols ;
+    [ dup lint ] { } map>assoc trim-self
+    [ second empty? ] reject filter-symbols ;
 
-M: word run-lint ( word -- seq )
-    1array run-lint ;
+M: word run-lint ( word -- seq ) 1array run-lint ;
+
+PRIVATE>
+
+: find-swap/swap ( word -- ? )
+    def>> [ callable? ] deep-filter
+    [
+        {
+            [ [ \ swap = ] count 2 >= ]
+            [
+                { swap } split rest but-last
+                [ [ infer ] [ 2drop ( -- ) ] recover ( x -- x ) = ] any?
+            ]
+        } 1&&
+    ] any? ;
+
+: find-redundant-word-props ( -- seq )
+    all-words [
+        {
+            [ { [ foldable? ] [ flushable? ] } 1|| ]
+            [ inline? ]
+        } 1&&
+    ] filter ;
 
 : lint-all ( -- seq )
     all-words run-lint dup lint. ;
@@ -169,5 +316,10 @@ M: word run-lint ( word -- seq )
 : lint-vocab ( vocab -- seq )
     words run-lint dup lint. ;
 
+: lint-vocabs ( prefix -- seq )
+    [ vocabs ] dip [ head? ] curry filter [ lint-vocab ] map ;
+
 : lint-word ( word -- seq )
     1array run-lint dup lint. ;
+
+reload-definitions