adlint 2.6.14 → 3.0.0

data/lib/adlint/source.rb

@@ -1,7 +1,7 @@
 # Analyzing source files.
 #
 # 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.
 #
@@ -31,7 +31,6 @@
 
 require "adlint/traits"
 require "adlint/report"
-require "adlint/traits"
 require "adlint/util"
 
 module AdLint #:nodoc:
@@ -45,10 +44,11 @@ module AdLint #:nodoc:
     # === PARAMETER
     # _fpath_:: Pathname -- Path name of the target source file.
     # _content_:: String -- Source content.
-    def initialize(fpath, included_at = Location.new)
-      @fpath = fpath
+    def initialize(fpath, fenc, included_at = Location.new)
+      @fpath       = fpath
+      @fenc        = fenc
       @included_at = included_at
-      @content = nil
+      @content     = nil
     end
 
     extend Pluggable
@@ -71,6 +71,10 @@ module AdLint #:nodoc:
       false
     end
 
+    def analysis_target?(traits)
+      Location.new(@fpath).in_analysis_target?(traits)
+    end
+
     # === DESCRIPTION
     # Opens the target source file.
     #
@@ -81,7 +85,7 @@ module AdLint #:nodoc:
       io = StringIO.new(@content)
       yield(io)
     ensure
-      io.close if io
+      io && io.close
     end
 
     # === DESCRIPTION
@@ -95,47 +99,42 @@ module AdLint #:nodoc:
 
     private
     def read_content(fpath)
-      if encoding = Traits.instance.of_project.file_encoding
-        content = IO.read(fpath, mode: "rb", encoding: encoding)
-      else
-        content = IO.read(fpath, mode: "rb", encoding: "ASCII-8BIT")
-      end
+      cont = IO.read(fpath, mode: "rb", encoding: @fenc || "binary")
 
-      if content =~ /\r/
+      if cont =~ /\r/
         notify_cr_at_eol_found(Location.new(fpath))
-        content = content.gsub(/\r\n|\r/, "\n")
+        cont = cont.gsub(/\r\n|\r/, "\n")
       end
 
-      if content =~ /\x1a/
+      if cont =~ /\x1a/
         notify_eof_mark_at_eof_found(Location.new(fpath))
-        content = content.gsub(/\x1a/, "")
+        cont = cont.gsub(/\x1a/, "")
       end
 
-      unless content.end_with?("\n")
+      unless cont.end_with?("\n")
         notify_eof_newline_not_found(Location.new(fpath))
-        content << "\n"
+        cont << "\n"
       end
 
-      content
+      cont
     end
 
-    def notify_cr_at_eol_found(location)
-      on_cr_at_eol_found.invoke(location)
+    def notify_cr_at_eol_found(loc)
+      on_cr_at_eol_found.invoke(loc)
     end
 
-    def notify_eof_mark_at_eof_found(location)
-      on_eof_mark_at_eof_found.invoke(location)
+    def notify_eof_mark_at_eof_found(loc)
+      on_eof_mark_at_eof_found.invoke(loc)
     end
 
-    def notify_eof_newline_not_found(location)
-      on_eof_newline_not_found.invoke(location)
+    def notify_eof_newline_not_found(loc)
+      on_eof_newline_not_found.invoke(loc)
     end
   end
 
   class EmptySource < Source
     def initialize
-      @fpath = IO::NULL
-      @included_at = nil
+      super(File::NULL, nil, nil)
       @content = "\n"
     end
   end

data/lib/adlint/supp.rb

@@ -0,0 +1,131 @@
+# Message suppressions.
+#
+# 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:
+
+  class MessageSuppressorSet
+    def initialize
+      @file_wise_suppressions = {}
+      @line_wise_suppressions = {}
+    end
+
+    def add(supp)
+      case
+      when supp.file_wise?
+        @file_wise_suppressions[supp.key] = supp
+      when supp.line_wise?
+        @line_wise_suppressions[supp.key] = supp
+      end
+    end
+
+    def suppress?(msg)
+      (supp = @file_wise_suppressions[file_wise_key_of(msg)]) &&
+        supp.suppress?(msg) or
+      (supp = @line_wise_suppressions[line_wise_key_of(msg)]) &&
+        supp.suppress?(msg) or
+      false
+    end
+
+    private
+    def file_wise_key_of(msg)
+      FileWiseMessageSuppressor.key_of(msg.location)
+    end
+
+    def line_wise_key_of(msg)
+      LineWiseMessageSuppressor.key_of(msg.location)
+    end
+  end
+
+  class MessageSuppressor
+    def initialize(target_msg_ids)
+      @target_msg_ids = target_msg_ids
+    end
+
+    def key
+      subclass_responsibility
+    end
+
+    def file_wise?
+      subclass_responsibility
+    end
+
+    def line_wise?
+      subclass_responsibility
+    end
+
+    def suppress?(msg)
+      @target_msg_ids.include?(msg.id)
+    end
+  end
+
+  class FileWiseMessageSuppressor < MessageSuppressor
+    def self.key_of(loc)
+      [loc.fpath]
+    end
+
+    def initialize(target_msg_ids, annot_loc)
+      super(target_msg_ids)
+      @key = [annot_loc.fpath]
+    end
+
+    attr_reader :key
+
+    def file_wise?
+      true
+    end
+
+    def line_wise?
+      false
+    end
+  end
+
+  class LineWiseMessageSuppressor < MessageSuppressor
+    def self.key_of(loc)
+      [loc.fpath, loc.line_no]
+    end
+
+    def initialize(target_msg_ids, annot_loc)
+      super(target_msg_ids)
+      @key = [annot_loc.fpath, annot_loc.line_no]
+    end
+
+    attr_reader :key
+
+    def file_wise?
+      false
+    end
+
+    def line_wise?
+      true
+    end
+  end
+
+end

data/lib/adlint/symbol.rb

@@ -1,7 +1,7 @@
 # Reference recordable symbols.
 #
 # 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.
 #
@@ -34,9 +34,9 @@ require "adlint/source"
 module AdLint #:nodoc:
 
   class Symbol
-    def initialize(identifier)
-      @identifier = identifier
-      @referred = false
+    def initialize(id)
+      @identifier = id
+      @referred   = false
     end
 
     attr_writer :referred
@@ -101,24 +101,22 @@ module AdLint #:nodoc:
       @hash = Hash.new { |hash, key| hash[key] = [] }
     end
 
-    def create_new_symbol(symbol_class, identifier)
-      symbol = symbol_class.new(identifier)
-      @hash[symbol.location.fpath].push(symbol)
-      symbol
+    def create_new_symbol(sym_class, id)
+      sym = sym_class.new(id)
+      @hash[sym.location.fpath].push(sym)
+      sym
     end
 
-    def symbols_appeared_in(source)
-      @hash[source.fpath]
+    def symbols_appeared_in(src)
+      @hash[src.fpath]
     end
   end
 
   module SymbolicElement
-    def symbol
-      subclass_responsibility
-    end
+    # NOTE: Host class must respond to #symbol.
 
-    def mark_as_referred_by(token)
-      unless token.location.fpath == symbol.location.fpath
+    def mark_as_referred_by(tok)
+      unless tok.location.fpath == symbol.location.fpath
         symbol.referred = true
       end
     end

data/lib/adlint/token.rb

@@ -1,7 +1,7 @@
 # Lexical token 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.
 #
@@ -29,11 +29,14 @@
 #
 #++
 
+require "adlint/location"
+
 module AdLint #:nodoc:
 
   # == DESCRIPTION
   # Token.
   class Token
+    include LocationHolder
     include Comparable
 
     # === DESCRIPTION
@@ -41,11 +44,11 @@ module AdLint #:nodoc:
     #
     # === PARAMETER
     # _type_:: Symbol | String -- Type of the token.
-    # _value_:: String -- String value of the token.
-    # _location_:: Location -- Location of the token.
+    # _val_:: String -- String value of the token.
+    # _loc_:: Location -- Location of the token.
     # _type_hint_:: Symbol | String -- Hint of the token type.
-    def initialize(type, value, location, type_hint = nil)
-      @type, @value, @location = type, value, location
+    def initialize(type, val, loc, type_hint = nil)
+      @type, @value, @location = type, val, loc
       @type_hint = type_hint
     end
 
@@ -87,10 +90,10 @@ module AdLint #:nodoc:
         @type <=> rhs
       when Token
         if (type_diff = @type <=> rhs.type) == 0
-          if (value_diff = @value <=> rhs.value) == 0
+          if (val_diff = @value <=> rhs.value) == 0
             @location <=> rhs.location
           else
-            value_diff
+            val_diff
           end
         else
           type_diff
@@ -100,9 +103,9 @@ module AdLint #:nodoc:
       end
     end
 
-    def eql?(rhs_token)
-      @type == rhs_token.type && @value == rhs_token.value &&
-        @location == rhs_token.location
+    def eql?(rhs_tok)
+      @type == rhs_tok.type && @value == rhs_tok.value &&
+        @location == rhs_tok.location
     end
 
     def hash
@@ -111,10 +114,9 @@ module AdLint #:nodoc:
   end
 
   class ReplacedToken < Token
-    def initialize(type, value, location, type_hint = nil,
-                   need_no_further_replacement = true)
-      super(type, value, location, type_hint)
-      @need_no_further_replacement = need_no_further_replacement
+    def initialize(type, val, loc, type_hint = nil, no_further_repl = true)
+      super(type, val, loc, type_hint)
+      @need_no_further_replacement = no_further_repl
     end
 
     def need_no_further_replacement?
@@ -125,8 +127,8 @@ module AdLint #:nodoc:
       true
     end
 
-    def eql?(rhs_token)
-      equal?(rhs_token)
+    def eql?(rhs_tok)
+      equal?(rhs_tok)
     end
 
     def hash
@@ -134,80 +136,6 @@ module AdLint #:nodoc:
     end
   end
 
-  # == 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 ==(rhs)
-      @fpath == rhs.fpath &&
-        @line_no == rhs.line_no && @column_no == rhs.column_no
-    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
-      result = ""
-      result += "#{@fpath}:" if @fpath
-      result += "#{@line_no}:" if @line_no
-      result += "#{@column_no}" if @column_no
-      result
-    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
-  end
-
   # == DESCRIPTION
   # Array of tokens.
   class TokenArray < Array; end