adlint-postfilter 0.9.1

data/lib/adlint/postfilter/content.rb

@@ -0,0 +1,128 @@
+# Filtering contents.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2012, 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-2012, OGIS-RI Co.,Ltd.
+#
+# This file is part of adlint-postfilter.
+#
+# adlint-postfilter 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-postfilter 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-postfilter.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+require "csv"
+require "pathname"
+
+module AdLint #:nodoc:
+module Postfilter #:nodoc:
+
+  class FilteringContent < Array
+    def overwrite!
+      subclass_responsibility
+    end
+  end
+
+  class MessageFileContent < FilteringContent
+    def initialize(fpath)
+      @fpath = fpath
+      lines = File.read(fpath).lines.each_with_object([]) { |line, ary|
+        if line[0] == "V"
+          ary.push(OrdinaryLine.new(line.chomp))
+        else
+          ary.push(CsvMessageLine.new(line.chomp))
+        end
+      }
+      super(lines)
+    end
+
+    def overwrite!
+      File.open(@fpath, "w") { |io| io.puts self.compact }
+    end
+  end
+
+  class StderrContent < FilteringContent
+    def initialize(str)
+      lines = str.lines.each_with_object([]) { |line, ary|
+        if line =~ /:(?:warning|context):/
+          ary.push(PlainMessageLine.new(line.chomp))
+        else
+          ary.push(OrdinaryLine.new(line.chomp))
+        end
+      }
+      super(lines)
+    end
+
+    def overwrite!
+      $stderr.puts self.compact
+    end
+  end
+
+  class Line < String
+    def filterable?
+      subclass_responsibility
+    end
+  end
+
+  class OrdinaryLine < Line
+    def filterable?
+      false
+    end
+  end
+
+  class MessageLine < Line
+    def initialize(str, fpath_str, line_no_str, message_id_str)
+      super(str)
+
+      @fpath = Pathname.new(fpath_str).realpath
+      @line_no = line_no_str ? line_no_str.to_i : nil
+      @message_id = message_id_str.to_sym
+    end
+
+    attr_reader :fpath
+    attr_reader :line_no
+    attr_reader :message_id
+
+    def filterable?
+      true
+    end
+
+    def match_with?(suppression)
+      suppression._match_with?(self)
+    end
+  end
+
+  class CsvMessageLine < MessageLine
+    def initialize(str)
+      fields = CSV.parse(str).first
+      super(str, fields.fetch(1), fields.fetch(2), fields.fetch(4))
+    end
+  end
+
+  class PlainMessageLine < MessageLine
+    def initialize(str)
+      super(str, *str.scan(/\A(.*):(?:(\d*):\d*|):.*:(.*):/).first)
+    end
+  end
+
+end
+end

data/lib/adlint/postfilter/driver.rb

@@ -0,0 +1,76 @@
+# Filtering drivers.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2012, 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-2012, OGIS-RI Co.,Ltd.
+#
+# This file is part of adlint-postfilter.
+#
+# adlint-postfilter 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-postfilter 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-postfilter.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+require "fileutils"
+
+require "adlint/postfilter/command"
+
+module AdLint #:nodoc:
+
+  module Postfilter
+    def install_config_template(config_fpath)
+      FileUtils.cp(File.expand_path("conf.d/adlint_postfilter.yml", $etcdir),
+                   config_fpath)
+    end
+    module_function :install_config_template
+
+    def transform_makefile(makefile_fpath)
+      orig_fpath = makefile_fpath.add_ext(".orig")
+      FileUtils.mv(makefile_fpath, orig_fpath)
+
+      File.open(makefile_fpath, "w") do |dst_io|
+        dst_io.puts File.open(orig_fpath, "r") { |src_io|
+          src_io.each_line.map do |line|
+            case line
+            when /^(ADLINT =) (.*adlint)$/,
+                 /^(ADLINT_SMA =) (.*adlint_sma)$/,
+                 /^(ADLINT_CHK =) (.*adlint_chk)$/
+              "#{$1} adlint_flt -A #{$2}"
+            when /^(ADLINT_CMA =) (.*adlint_cma)$/
+              "#{$1} adlint_flt -V $(VPATH) -A #{$2}"
+            else
+              line.chomp
+            end
+          end
+        }
+      end
+    end
+    module_function :transform_makefile
+
+    def run(config_fpath, command_line, src_vpath)
+      command = AnalysisCommand.for(command_line, config_fpath, src_vpath)
+      command.execute.exitstatus
+    end
+    module_function :run
+  end
+
+end

data/lib/adlint/postfilter/filter.rb

@@ -0,0 +1,52 @@
+# Output filter.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2012, 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-2012, OGIS-RI Co.,Ltd.
+#
+# This file is part of adlint-postfilter.
+#
+# adlint-postfilter 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-postfilter 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-postfilter.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+require "adlint/postfilter/content"
+
+module AdLint #:nodoc:
+module Postfilter #:nodoc:
+
+  class MessageFilter
+    def initialize(config)
+      @config = config
+      @target_content = MessageFileContent.new(@config.msg_fpath)
+    end
+
+    def execute(stderr_content)
+      @config.suppression_list.apply_to(@target_content)
+      @target_content.overwrite!
+      @config.suppression_list.apply_to(stderr_content)
+    end
+  end
+
+end
+end

data/lib/adlint/postfilter/path.rb

@@ -0,0 +1,68 @@
+# Pathname creation utilities.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2012, 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-2012, OGIS-RI Co.,Ltd.
+#
+# This file is part of adlint-postfilter.
+#
+# adlint-postfilter 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-postfilter 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-postfilter.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+require "pathname"
+
+module AdLint #:nodoc:
+module Postfilter #:nodoc:
+
+  module PathUtil
+    def i_fpath_of(src_fpath, strip_num, output_dpath = nil)
+      if output_dpath
+        output_dpath.join(src_fpath.strip(strip_num)).sub_ext(".i")
+      else
+        src_fpath.strip(strip_num).sub_ext(".i")
+      end
+    end
+    module_function :i_fpath_of
+
+    def sma_msg_fpath_of(src_fpath, strip_num, output_dpath = nil)
+      if output_dpath
+        output_dpath.join(src_fpath.strip(strip_num)).add_ext(".msg.csv")
+      else
+        src_fpath.strip(strip_num).add_ext(".msg.csv")
+      end
+    end
+    module_function :sma_msg_fpath_of
+
+    def cma_msg_fpath_of(project_name, output_dpath = nil)
+      if output_dpath
+        output_dpath.join(Pathname.new(project_name)).add_ext(".msg.csv")
+      else
+        Pathname.new(project_name).add_ext(".msg.csv")
+      end
+    end
+    module_function :cma_msg_fpath_of
+  end
+
+end
+end

data/lib/adlint/postfilter/suppress.rb

@@ -0,0 +1,202 @@
+# Message suppression.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2012, 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-2012, OGIS-RI Co.,Ltd.
+#
+# This file is part of adlint-postfilter.
+#
+# adlint-postfilter 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-postfilter 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-postfilter.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+module AdLint #:nodoc:
+module Postfilter #:nodoc:
+
+  class MessageSuppression
+    def _match_with?(message_line)
+      subclass_responsibility
+    end
+  end
+
+  class AdLintInitialHeaderSuppression < MessageSuppression
+    def initialize(cinit_fpath, pinit_fpath)
+      @cinit_fpath = cinit_fpath
+      @pinit_fpath = pinit_fpath
+    end
+
+    def _match_with?(message_line)
+      message_line.fpath == @cinit_fpath || message_line.fpath == @pinit_fpath
+    end
+  end
+
+  class PlatformHeaderSuppression < MessageSuppression
+    def initialize(project_root_dpath)
+      @project_root_dpath = project_root_dpath.realpath
+    end
+
+    def _match_with?(message_line)
+      !message_line.fpath.to_s.start_with?(@project_root_dpath.to_s)
+    end
+  end
+
+  class MessageWiseSuppression < MessageSuppression
+    def initialize(message_id)
+      @message_id = message_id
+    end
+
+    attr_reader :message_id
+
+    def _match_with?(message_line)
+      message_line.message_id == @message_id
+    end
+  end
+
+  class ProjectWideSuppression < MessageWiseSuppression; end
+
+  module Deactivatable
+    attr_writer :active
+
+    def active?
+      @active
+    end
+  end
+
+  class FileWiseSuppression < MessageWiseSuppression
+    include Deactivatable
+
+    def initialize(message_id, fpath, active)
+      super(message_id)
+      @fpath = fpath
+      self.active = active
+    end
+
+    attr_reader :fpath
+
+    def _match_with?(message_line)
+      if self.active?
+        super && message_line.fpath == @fpath
+      else
+        false
+      end
+    end
+  end
+
+  class LineWiseSuppression < MessageWiseSuppression
+    include Deactivatable
+
+    def initialize(message_id, fpath, line_no, active)
+      super(message_id)
+      @fpath, @line_no = fpath, line_no
+      self.active = active
+    end
+
+    attr_reader :fpath
+    attr_reader :line_no
+
+    def _match_with?(message_line)
+      if self.active?
+        super &&
+          message_line.fpath == @fpath && message_line.line_no == @line_no
+      else
+        false
+      end
+    end
+  end
+
+  class MessageSuppressionList
+    def initialize(initial_header_suppression, platform_header_suppression,
+                   project_wide_suppressions,
+                   tunit_wide_suppressions, line_wise_suppressions)
+      @initial_header_suppression = initial_header_suppression
+      @platform_header_suppression = platform_header_suppression
+      @p_index = create_p_index(project_wide_suppressions)
+      @t_index = create_t_index(tunit_wide_suppressions)
+      @l_index = create_l_index(line_wise_suppressions)
+    end
+
+    def apply_to(content)
+      content.each_with_index do |line, index|
+        if line.filterable?
+          supps = suppressions_for(line.message_id, line.fpath, line.line_no)
+          if supps.any? { |supp| line.match_with?(supp) }
+            content[index] = nil
+          end
+        end
+      end
+    end
+
+    private
+    def suppressions_for(message_id, fpath, line_no)
+      p_hash = select_project_wide_suppressions(message_id)
+      t_hash = select_tunit_wide_suppressions(message_id, fpath)
+      l_hash = select_line_wise_suppressions(message_id, fpath, line_no)
+      [@initial_header_suppression, @platform_header_suppression] +
+        p_hash.merge(t_hash).merge(l_hash).values
+    end
+
+    def select_project_wide_suppressions(message_id)
+      (supp = @p_index[message_id]) ? {message_id => supp} : {}
+    end
+
+    def select_tunit_wide_suppressions(message_id, fpath)
+      (supp = @t_index[message_id][fpath]) ? {message_id => supp} : {}
+    end
+
+    def select_line_wise_suppressions(message_id, fpath, line_no)
+      @l_index[message_id][fpath].each_with_object({}) do |supp, result|
+        if supp.line_no == line_no
+          result[supp.message_id] = supp
+        end
+      end
+    end
+
+    def create_p_index(suppressions)
+      suppressions.each_with_object({}) do |supp, index|
+        index[supp.message_id] = supp
+      end
+    end
+
+    def create_t_index(suppressions)
+      index = Hash.new { |mesg_id_hash, mesg_id| mesg_id_hash[mesg_id] = {} }
+      suppressions.each do |supp|
+        index[supp.message_id][supp.fpath] = supp
+      end
+      index
+    end
+
+    def create_l_index(suppressions)
+      index = Hash.new { |mesg_id_hash, mesg_id|
+        mesg_id_hash[mesg_id] = Hash.new { |fpath_hash, fpath|
+          fpath_hash[fpath] = []
+        }
+      }
+      suppressions.each do |supp|
+        index[supp.message_id][supp.fpath].push(supp)
+      end
+      index
+    end
+  end
+
+end
+end

data/lib/adlint/postfilter/version.rb

@@ -0,0 +1,73 @@
+# Version information.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2012, 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-2012, OGIS-RI Co.,Ltd.
+#
+# This file is part of adlint-postfilter.
+#
+# adlint-postfilter 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-postfilter 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-postfilter.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+module AdLint #:nodoc:
+module Postfilter #:nodoc:
+
+  MAJOR_VERSION = 0
+  MINOR_VERSION = 9
+  PATCH_VERSION = 1
+  RELEASE_DATE  = "2012-04-17"
+
+  SHORT_VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}.#{PATCH_VERSION}"
+
+  VERSION = "#{SHORT_VERSION} (#{RELEASE_DATE})"
+
+  COPYRIGHT = <<EOS
+     ___    ____  __    ___   _________
+    /   |  / _  |/ /   / / | / /__  __/            Source Code Static Analyzer
+   / /| | / / / / /   / /  |/ /  / /                    AdLint - Advanced Lint
+  / __  |/ /_/ / /___/ / /|  /  / /
+ /_/  |_|_____/_____/_/_/ |_/  /_/    Copyright (C) 2010-2012, OGIS-RI Co.,Ltd.
+
+ adlint-postfilter 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-postfilter 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-postfilter.  If not, see <http://www.gnu.org/licenses/>.
+
+EOS
+
+  AUTHOR = <<EOS
+Written by Yutaka Yanoh and OGIS-RI Co.,Ltd.
+
+EOS
+
+end
+end

data/lib/adlint/postfilter.rb

@@ -0,0 +1,43 @@
+# adlint-postfilter package loader.
+#
+# Author::    Yutaka Yanoh <mailto:yanoh@users.sourceforge.net>
+# Copyright:: Copyright (C) 2010-2012, 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-2012, OGIS-RI Co.,Ltd.
+#
+# This file is part of adlint-postfilter.
+#
+# adlint-postfilter 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-postfilter 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-postfilter.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++
+
+require "adlint"
+
+require "adlint/postfilter/annotate"
+require "adlint/postfilter/command"
+require "adlint/postfilter/config"
+require "adlint/postfilter/content"
+require "adlint/postfilter/driver"
+require "adlint/postfilter/filter"
+require "adlint/postfilter/path"
+require "adlint/postfilter/suppress"
+require "adlint/postfilter/version"