adlint 2.6.14 → 3.0.0

data/lib/adlint/lexer.rb

@@ -1,7 +1,7 @@
 # Lexical analyzer base classes.
 #
 # Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
-# Copyright:: Copyright (C) 2010-2012, OGIS-RI Co.,Ltd.
+# Copyright:: Copyright (C) 2010-2013, OGIS-RI Co.,Ltd.
 # License::   GPLv3+: GNU General Public License version 3 or later
 #
 # Owner::     Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
@@ -11,7 +11,7 @@
 #    /   |  / _  |/ /   / / | / /__  __/           Source Code Static Analyzer
 #   / /| | / / / / /   / /  |/ /  / /                   AdLint - Advanced Lint
 #  / __  |/ /_/ / /___/ / /|  /  / /
-# /_/  |_|_____/_____/_/_/ |_/  /_/   Copyright (C) 2010-2012, OGIS-RI Co.,Ltd.
+# /_/  |_|_____/_____/_/_/ |_/  /_/   Copyright (C) 2010-2013, OGIS-RI Co.,Ltd.
 #
 # This file is part of AdLint.
 #
@@ -33,7 +33,6 @@ require "adlint/token"
 require "adlint/source"
 require "adlint/traits"
 require "adlint/error"
-require "adlint/util"
 
 module AdLint #:nodoc:
 
@@ -45,18 +44,18 @@ module AdLint #:nodoc:
     # token array.
     #
     # === PARAMETER
-    # _token_array_:: TokenArray -- Array of tokens.
-    def initialize(token_array = nil)
-      if token_array
+    # _token_ary_:: TokenArray -- Array of tokens.
+    def initialize(tok_ary = nil)
+      if tok_ary
         super
       else
         super()
       end
     end
 
-    def expect(token_type)
-      token = self.first
-      token && token.type == token_type ? true : false
+    def expect(tok_type)
+      tok = self.first
+      tok && tok.type == tok_type ? true : false
     end
   end
 
@@ -75,9 +74,6 @@ module AdLint #:nodoc:
   # == DESCRIPTION
   # Object represents the whole content of the string.
   class StringContent < Content
-    include CodingStyleAccessor
-    extend Memoizable
-
     # === DESCRIPTION
     # Constructs the content object of the string.
     #
@@ -85,11 +81,10 @@ module AdLint #:nodoc:
     # _str_:: String -- Target string.
     # _fpath_:: Pathname -- File path name contains the target string.
     # _line_no_:: Integer -- Initial line-no of the target string.
-    def initialize(str, fpath = nil, line_no = 1, column_no = 1)
+    def initialize(str, tab_width = 8, fpath = nil, line_no = 1, column_no = 1)
       @scanner = StringScanner.new(str)
-      @fpath = fpath
-      @line_no = line_no
-      @column_no = column_no
+      @tab_width = tab_width
+      @fpath, @line_no, @column_no = fpath, line_no, column_no
       @appearance_column_no = column_no
     end
 
@@ -107,10 +102,10 @@ module AdLint #:nodoc:
     # === RETURN VALUE
     # String -- Token string or nil.
     def scan(regexp)
-      token = @scanner.scan(regexp)
-      if token
-        update_location(token)
-        token
+      tok = @scanner.scan(regexp)
+      if tok
+        update_location(tok)
+        tok
       else
         nil
       end
@@ -124,12 +119,12 @@ module AdLint #:nodoc:
     # Skips a content.
     #
     # === PARAMETER
-    # _length_:: Integer -- Skipping content length.
+    # _len_:: Integer -- Skipping content length.
     #
     # === RETURN VALUE
     # String -- Eaten string.
-    def eat!(length = 1)
-      scan(/.{#{length}}/m)
+    def eat!(len = 1)
+      self.scan(/.{#{len}}/m)
     end
 
     # === DESCRIPTION
@@ -146,17 +141,17 @@ module AdLint #:nodoc:
     end
 
     private
-    def update_location(token)
-      if (nl_count = token.count("\n")) > 0
-        @line_no += nl_count
-        last_line = token[token.rindex("\n")..-1]
-        @column_no = last_line.length
-        @appearance_column_no = last_line.gsub(/\t/, " " * tab_width).length
+    def update_location(tok)
+      if (nl_cnt = tok.count("\n")) > 0
+        @line_no += nl_cnt
+        lst_line = tok[tok.rindex("\n")..-1]
+        @column_no = lst_line.length
+        @appearance_column_no = lst_line.gsub(/\t/, " " * @tab_width).length
       else
-        @column_no += token.length
-        @appearance_column_no += token.gsub(/\t/, " " * tab_width).length
+        @column_no += tok.length
+        @appearance_column_no += tok.gsub(/\t/, " " * @tab_width).length
       end
-      forget_location_memo
+      forget_memo_of__location
     end
   end
 
@@ -167,27 +162,35 @@ module AdLint #:nodoc:
     # Constructs the content object of the source file.
     #
     # === PARAMETER
-    # _source_:: Source -- Target source object.
-    def initialize(source)
-      super(source.open { |io| io.read }, source.fpath)
+    # _src_:: Source -- Target source object.
+    def initialize(src, tab_width)
+      super(src.open { |io| io.read }, tab_width, src.fpath)
     end
   end
 
   class TokensContent < Content
-    def initialize(token_array)
-      @token_array = token_array
+    def initialize(tok_ary)
+      @token_ary = tok_ary
     end
 
     def location
-      empty? ? nil : @token_array.first.location
+      if self.empty?
+        nil
+      else
+        @token_ary.first.location
+      end
     end
 
     def empty?
-      @token_array.empty?
+      @token_ary.empty?
     end
 
     def next_token
-      empty? ? nil : @token_array.shift
+      if empty?
+        nil
+      else
+        @token_ary.shift
+      end
     end
   end
 
@@ -198,9 +201,9 @@ module AdLint #:nodoc:
     # Constructs a lexical analysis context object.
     #
     # === PARAMETER
-    # _content_:: SourceContent | StringContent -- Target content.
-    def initialize(content)
-      @content = content
+    # _cont_:: SourceContent | StringContent -- Target content.
+    def initialize(cont)
+      @content = cont
     end
 
     # === VALUE
@@ -235,13 +238,13 @@ module AdLint #:nodoc:
     # === RETURN VALUE
     # TokenArray -- Scanned tokens.
     def execute
-      context = create_context(@str)
-      tokenize(context)
+      lexer_ctxt = create_lexer_context(@str)
+      tokenize(lexer_ctxt)
     rescue Error
       raise
     rescue => ex
-      if context
-        raise InternalError.new(ex, context.location)
+      if lexer_ctxt
+        raise InternalError.new(ex, lexer_ctxt.location)
       else
         raise InternalError.new(ex, nil)
       end
@@ -255,7 +258,7 @@ module AdLint #:nodoc:
     #
     # === PARAMETER
     # _str_:: String -- Target string object.
-    def create_context(str)
+    def create_lexer_context(str)
       subclass_responsibility
     end
 
@@ -265,31 +268,31 @@ module AdLint #:nodoc:
     # Subclasses must implement this method.
     #
     # === PARAMETER
-    # _context_:: LexerContext -- Lexical analysis context.
-    def tokenize(context)
+    # _lexer_ctxt_:: LexerContext -- Lexical analysis context.
+    def tokenize(lexer_ctxt)
       subclass_responsibility
     end
   end
 
   class TokensRelexer
-    def initialize(token_array)
-      @context = create_context(token_array)
+    def initialize(tok_ary)
+      @lexer_ctxt = create_lexer_context(tok_ary)
     end
 
     def next_token
-      tokenize(@context)
+      tokenize(@lexer_ctxt)
     rescue Error
       raise
     rescue => ex
-      raise InternalError.new(ex, @context.location)
+      raise InternalError.new(ex, @lexer_ctxt.location)
     end
 
     private
-    def create_context(token_array)
+    def create_lexer_context(tok_ary)
       subclass_responsibility
     end
 
-    def tokenize(context)
+    def tokenize(lexer_ctxt)
       subclass_responsibility
     end
   end

data/lib/adlint/location.rb

@@ -0,0 +1,140 @@
+# Location identifier of tokens.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2013, OGIS-RI Co.,Ltd.
+# License::   GPLv3+: GNU General Public License version 3 or later
+#
+# Owner::     Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+
+#--
+#     ___    ____  __    ___   _________
+#    /   |  / _  |/ /   / / | / /__  __/           Source Code Static Analyzer
+#   / /| | / / / / /   / /  |/ /  / /                   AdLint - Advanced Lint
+#  / __  |/ /_/ / /___/ / /|  /  / /
+# /_/  |_|_____/_____/_/_/ |_/  /_/   Copyright (C) 2010-2013, OGIS-RI Co.,Ltd.
+#
+# This file is part of AdLint.
+#
+# AdLint is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# AdLint is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# AdLint.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+module AdLint #:nodoc:
+
+  # == DESCRIPTION
+  # Location identifier of tokens.
+  class Location
+    # === Constructs a location identifier.
+    #
+    # Param:: _fpath_ (Pathname) Path name of the file contains the token.
+    # Param:: _line_no_ (Integer) Line-no where the token appears.
+    # Param:: _column_no_ (Integer) Column-no where the token appears.
+    def initialize(fpath = nil, line_no = nil, column_no = nil,
+                   appearance_column_no = column_no)
+      @fpath, @line_no, @column_no = fpath, line_no, column_no
+      @appearance_column_no = appearance_column_no
+    end
+
+    # === VALUE
+    # Pathname -- Path name of the file contains this token.
+    attr_reader :fpath
+
+    # === VALUE
+    # Integer -- Line-no where this token appears.
+    attr_reader :line_no
+
+    # === VALUE
+    # Integer -- Column-no where this token appears.
+    attr_reader :column_no
+
+    attr_reader :appearance_column_no
+
+    def in_analysis_target?(traits)
+      if @fpath
+        under_inclusion_paths?(@fpath, traits) &&
+          !under_exclusion_paths?(@fpath, traits) and
+        !@fpath.identical?(traits.of_project.initial_header) &&
+          !@fpath.identical?(traits.of_compiler.initial_header)
+      else
+        false
+      end
+    end
+    memoize :in_analysis_target?
+
+    def ==(rhs)
+      self.to_a == rhs.to_a
+    end
+
+    def eql?(rhs)
+      self == rhs
+    end
+
+    def hash
+      to_a.hash
+    end
+
+    # === DESCRIPTION
+    # Converts this location identifier to an array representation.
+    #
+    # === RETURN VALUE
+    # Array< Object > -- Array representation of this location identifier.
+    def to_a
+      [@fpath, @line_no, @column_no]
+    end
+
+    # === DESCRIPTION
+    # Converts this location to a human readable string representation.
+    #
+    # === RETURN VALUE
+    # String -- String representation of this location identifier.
+    def to_s
+      str = ""
+      str += "#{@fpath}:" if @fpath
+      str += "#{@line_no}:" if @line_no
+      str += "#{@column_no}" if @column_no
+      str
+    end
+
+    # === DESCRIPTION
+    # Converts this location to debugging dump representation.
+    #
+    # === RETURN VALUE
+    # String -- String representation of this location identifier.
+    def inspect
+      "#{@fpath ? @fpath : 'nil'}:" +
+        "#{@line_no ? @line_no : 'nil'}:#{@column_no ? @column_no : 'nil'}"
+    end
+
+    private
+    def under_inclusion_paths?(fpath, traits)
+      traits.of_project.target_files.inclusion_paths.any? do |dpath|
+        fpath.under?(dpath)
+      end
+    end
+
+    def under_exclusion_paths?(fpath, traits)
+      traits.of_project.target_files.exclusion_paths.any? do |dpath|
+        fpath.under?(dpath)
+      end
+    end
+  end
+
+  module LocationHolder
+    # NOTE: Host class must respond to #location.
+
+    def analysis_target?(traits)
+      location.in_analysis_target?(traits)
+    end
+  end
+
+end

data/lib/adlint/memo.rb

@@ -0,0 +1,157 @@
+# Memoizing utility.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2013, OGIS-RI Co.,Ltd.
+# License::   GPLv3+: GNU General Public License version 3 or later
+#
+# Owner::     Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+
+#--
+#     ___    ____  __    ___   _________
+#    /   |  / _  |/ /   / / | / /__  __/           Source Code Static Analyzer
+#   / /| | / / / / /   / /  |/ /  / /                   AdLint - Advanced Lint
+#  / __  |/ /_/ / /___/ / /|  /  / /
+# /_/  |_|_____/_____/_/_/ |_/  /_/   Copyright (C) 2010-2013, OGIS-RI Co.,Ltd.
+#
+# This file is part of AdLint.
+#
+# AdLint is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# AdLint is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# AdLint.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+module AdLint #:nodoc:
+
+  module Memoizable
+    def memoize(name, *key_indices)
+      var_name = name.to_s.sub("?", "Q")
+      org_name = "_org_#{name}"
+      class_eval <<-EOS
+        alias_method("#{org_name}", "#{name}")
+        private("#{org_name}")
+      EOS
+      if key_indices.empty?
+        if instance_method("#{name}").arity == 0
+          define_cache_manipulator(name, var_name)
+          class_eval <<-EOS
+            define_method("#{name}") do
+              @_cache_of__#{var_name}_initialized ||= false
+              if @_cache_of__#{var_name}_initialized
+                @_cache_of__#{var_name}_forbidden = false
+                @_cache_of__#{var_name}
+              else
+                @_cache_of__#{var_name}_forbidden ||= false
+                if @_cache_of__#{var_name}_forbidden
+                  @_cache_of__#{var_name}_forbidden = false
+                  #{org_name}
+                else
+                  @_cache_of__#{var_name}_initialized = true
+                  @_cache_of__#{var_name} = #{org_name}
+                end
+              end
+            end
+          EOS
+        else
+          define_cache_manipulator(name, var_name, key_indices)
+          class_eval <<-EOS
+            define_method("#{name}") do |*args|
+              @_cache_of__#{var_name}_initialized ||= false
+              if @_cache_of__#{var_name}_initialized
+                @_cache_of__#{var_name}_forbidden = false
+                if @_cache_of__#{var_name}.include?(args)
+                  @_cache_of__#{var_name}[args]
+                else
+                  @_cache_of__#{var_name}[args] = #{org_name}(*args)
+                end
+              else
+                @_cache_of__#{var_name}_forbidden ||= false
+                if @_cache_of__#{var_name}_forbidden
+                  @_cache_of__#{var_name}_forbidden = false
+                  #{org_name}(*args)
+                else
+                  @_cache_of__#{var_name}_initialized = true
+                  @_cache_of__#{var_name} = {}
+                  @_cache_of__#{var_name}[args] = #{org_name}(*args)
+                end
+              end
+            end
+          EOS
+        end
+      else
+        define_cache_manipulator(name, var_name, key_indices)
+        class_eval <<-EOS
+          define_method("#{name}") do |*args|
+            @_cache_of__#{var_name}_initialized ||= false
+            key = args.values_at(#{key_indices.join(',')})
+            if @_cache_of__#{var_name}_initialized
+              @_cache_of__#{var_name}_forbidden = false
+              if @_cache_of__#{var_name}.include?(key)
+                @_cache_of__#{var_name}[key]
+              else
+                @_cache_of__#{var_name}[key] = #{org_name}(*args)
+              end
+            else
+              @_cache_of__#{var_name}_forbidden ||= false
+              if @_cache_of__#{var_name}_forbidden
+                @_cache_of__#{var_name}_forbidden = false
+                #{org_name}(*args)
+              else
+                @_cache_of__#{var_name}_initialized = true
+                @_cache_of__#{var_name} = {}
+                @_cache_of__#{var_name}[key] = #{org_name}(*args)
+              end
+            end
+          end
+        EOS
+      end
+    end
+
+    private
+    def define_cache_manipulator(name, var_name, key_indices = nil)
+      class_eval <<-EOS
+        define_method("forbid_once_memo_of__#{name}") do
+          @_cache_of__#{var_name}_forbidden = true
+        end
+        define_method("clear_memo_of__#{name}") do
+          @_cache_of__#{var_name} = nil
+          @_cache_of__#{var_name}_initialized = false
+        end
+      EOS
+      case
+      when key_indices && key_indices.empty?
+        class_eval <<-EOS
+          define_method("forget_memo_of__#{name}") do |*args|
+            if @_cache_of__#{var_name}_initialized
+              @_cache_of__#{var_name}.delete(args)
+            end
+          end
+        EOS
+      when key_indices
+        class_eval <<-EOS
+          define_method("forget_memo_of__#{name}") do |*args|
+            if @_cache_of__#{var_name}_initialized
+              key = args.values_at(#{key_indices.join(',')})
+              @_cache_of__#{var_name}.delete(key)
+            end
+          end
+        EOS
+      else
+        class_eval <<-EOS
+          define_method("forget_memo_of__#{name}") do
+            clear_memo_of__#{name}
+          end
+        EOS
+      end
+    end
+  end
+
+end