adlint-postfilter 0.9.1

data/INSTALL

@@ -0,0 +1,61 @@
+--
+     ___    ____  __    ___   _________
+    /   |  / _  |/ /   / / | / /__  __/            Source Code Static Analyzer
+   / /| | / / / / /   / /  |/ /  / /                    AdLint - Advanced Lint
+  / __  |/ /_/ / /___/ / /|  /  / /
+ /_/  |_|_____/_____/_/_/ |_/  /_/    Copyright (C) 2010-2012, 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/>.
+
+++
+
+=== Requirements
+
+* \AdLint 1.0.0 or later [*mandatory*]
+
+
+=== Installation
+
+You can install adlint-postfilter by following command.
+
+If \AdLint 1.0.0 or later version has not been installed, it will be installed
+automatically before installing adlint-postfilter.
+
+ % gem install adlint-postfilter
+or
+ % sudo gem install adlint-postfilter
+
+
+=== Usage
+
+First, copy a template of adlint-postfilter's configuration file to the root of
+the analysis project and transform the analysis +GNUmakefile+.
+
+ % cd path/to/analysis/project
+ % adlint_flt -it
+
+Following files will be generated or overwritten.
+
+* [+adlint_postfilter.yml+] Project-wide message suppression settings.
+* [+GNUmakefile+] Overwritten +GNUmakefile+ to use adlint-postfilter.
+* [+GNUmakefile.orig+] Backup of the original +GNUmakefile+.
+
+Second, edit project-wide message suppression settings in
++adlint_postfilter.yml+ and add translation-unit-wide and line-wise message
+control annotations to source files if needed.
+
+Finally, do analysis by ordinary instructions of the \AdLint analysis.
+
+ % make verbose-all

data/MANIFEST

@@ -0,0 +1,20 @@
+AUTHORS
+COPYING
+ChangeLog
+INSTALL
+MANIFEST
+NEWS
+README
+Rakefile
+bin/adlint_flt
+etc/conf.d/adlint_postfilter.yml
+lib/adlint/postfilter.rb
+lib/adlint/postfilter/annotate.rb
+lib/adlint/postfilter/command.rb
+lib/adlint/postfilter/config.rb
+lib/adlint/postfilter/content.rb
+lib/adlint/postfilter/driver.rb
+lib/adlint/postfilter/filter.rb
+lib/adlint/postfilter/path.rb
+lib/adlint/postfilter/suppress.rb
+lib/adlint/postfilter/version.rb

data/NEWS

@@ -0,0 +1,35 @@
+--
+     ___    ____  __    ___   _________
+    /   |  / _  |/ /   / / | / /__  __/            Source Code Static Analyzer
+   / /| | / / / / /   / /  |/ /  / /                    AdLint - Advanced Lint
+  / __  |/ /_/ / /___/ / /|  /  / /
+ /_/  |_|_____/_____/_/_/ |_/  /_/    Copyright (C) 2010-2012, 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/>.
+
+++
+
+=== 1.0.0 is released (2012-04-17)
+
+This is the initial GA release of adlint-postfilter.
+
+==== Implemented features
+
+* Platform headers' warning message suppression
+* AdLint initial headers' warning message suppression
+* Project-wide warning message suppression
+* Translation-unit-wide warning message control (both enable/disable
+  suppressions)
+* Line-wise warning message control (both enable/disable suppressions)

data/README

@@ -0,0 +1,192 @@
+--
+     ___    ____  __    ___   _________
+    /   |  / _  |/ /   / / | / /__  __/            Source Code Static Analyzer
+   / /| | / / / / /   / /  |/ /  / /                    AdLint - Advanced Lint
+  / __  |/ /_/ / /___/ / /|  /  / /
+ /_/  |_|_____/_____/_/_/ |_/  /_/    Copyright (C) 2010-2012, 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/>.
+
+++
+
+== What is
+
+adlint-postfilter is an ad-hoc filtering wrapper for \AdLint to suppress
+useless warning messages.
+
+== News
+
+:include:NEWS
+
+== How to Install
+
+:include:INSTALL
+
+
+== Interface
+
+=== +adlint_flt+ command
+
+ % adlint_flt --help
+ Usage: adlint_flt --analyze <analysis command line> | [other options]
+ 
+ Analysis Options:
+   -A, --analyze                  Execute AdLint analysis command
+   -P, --sma-strip NUM            Use NUM as VPATH_COMPONENTS (CMA only)
+ 
+ Other Options:
+   -i, --install                  Generate adlint_filter.yml template
+   -t, --transform                Transform project's GNUmakefile
+   -f, --force                    Force to overwrite existing files
+       --version                  Display version information
+       --copyright                Display copyright information
+       --prefix                   Display prefix directory of adlint-postfilter
+   -h, --help                     Display this message
+
+=== Project-wide message control file (+adlint_postfilter.yml+)
+
++adlint_postfilter.yml+ file should be written in YAML format.
+
+==== Syntax in informal BNF
+
+ adlint-postfilter-yml : message-traits-section
+
+ message-traits-section : "message_traits:" NEW_LINE suppression-list-section NEW_LINE individual-suppression-control-section NEW_LINE
+
+ suppression-list-section : SPACE SPACE "suppression_list:" NEW_LINE message-suppression-list
+
+ message-suppression-list :
+			  | message-suppression-list message-suppression-record
+
+ message-suppression-record : SPACE SPACE SPACE SPACE "-" message-id NEW_LINE
+
+ message-id : A string exactly matches with regexp /[WC][0-9]{4}/
+
+ individual-suppression-control-section : SPACE SPACE "enable_individual_suppression_control:" SPACE boolean-value NEW_LINE
+
+ boolean-value : "true" | "false"
+
+==== Example
+
+ % cat adlint_postfilter.yml
+ ...snip...
+ message_traits:
+
+   suppression_list:
+     - W0001
+     - W0002
+     - W0003
+
+   enable_individual_suppression_control : true
+ ...snip...
+   
+=== Translation-unit-wide message control annotation
+
+A translation-unit-wide message control annotation should be written as an
+ordinary comment of C language.
+
+It can appear at any line in the target source file.
+
+==== Syntax in informal BNF
+
+ tunit-wide-annotation : "/*" tunit-wide-message-controller "*/"
+                       | "/*" arbitrary-comment tunit-wide-message-controller "*/"
+                       | "/*" tunit-wide-message-controller arbitrary-comment "*/"
+                       | "/*" arbitrary-comment tunit-wide-message-controller arbitrary-comment "*/"
+
+ arbitrary-comment : A sequence of any characters which does not match with regexp /ADLINT:TUNIT:/i
+
+ tunit-wide-message-controller : tunit-wide-message-control-head "[" message-control-list "]"
+
+ tunit-wide-message-control-head : "ADLINT:TUNIT:"
+
+ message-control-list : message-control
+                      | message-control-list "," message-control
+
+ message-control : message-suppression-activation
+                 | message-suppression-deactivation
+
+ message-suppression-activation : "-" message-id
+
+ message-suppression-deactivation : "+" message-id
+
+ message-id : Described in `Project-wide message control file' section
+
+==== Example
+
+ % head target.c
+ /* ADLINT:TUNIT:[-W0001,-W0002,+W0003] added by yanoh */
+ ...snip...
+
+=== Line-wise message control annotation
+
+A line-wise message control annotation should be written as an ordinary comment
+of C language.
+
+It should appear in the target line.
+
+==== Syntax in informal BNF
+
+ line-wise-annotation : "/*" line-wise-message-controller "*/"
+                      | "/*" arbitrary-comment line-wise-message-controller "*/"
+                      | "/*" line-wise-message-controller arbitrary-comment "*/"
+                      | "/*" arbitrary-comment line-wise-message-controller arbitrary-comment "*/"
+
+ arbitrary-comment : A sequence of any characters which does not match to regexp /ADLINT::/i and /ADLINT:LINE:/i
+
+ line-wise-message-controller : line-wise-message-control-head "[" message-control-list "]"
+
+ line-wise-message-control-head : "ADLINT::" | "ADLINT:LINE:"
+
+ message-control-list : Described in `Translation-unit-wide message control annotation' section
+
+ message-control : Described in `Translation-unit-wide message control annotation' section
+
+ message-suppression-activation : Described in `Translation-unit-wide message control annotation' section
+
+ message-suppression-deactivation : Described in `Translation-unit-wide message control annotation' section
+
+ message-id : Described in `Translation-unit-wide message control annotation' section
+
+==== Example
+
+ % cat target.c
+ ...snip...
+ const unsigned int ui1 = -1; /* ADLINT:LINE:[-W0607,+W0167] added by yanoh */
+ const unsigned int ui2 = -1; /* FIXME: ADLINT::[-W0607,+W0167] added by yanoh */
+ ...snip...
+
+
+== License
+
+Copyright (C) 2010-2012, {OGIS-RI}[http://www.ogis-ri.co.jp/] 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/}[http://www.gnu.org/licenses/]>.
+
+== Authors
+
+:include:AUTHORS

data/Rakefile

@@ -0,0 +1,86 @@
+#--
+#     ___    ____  __    ___   _________
+#    /   |  / _  |/ /   / / | / /__  __/           Source Code Static Analyzer
+#   / /| | / / / / /   / /  |/ /  / /                   AdLint - Advanced Lint
+#  / __  |/ /_/ / /___/ / /|  /  / /
+# /_/  |_|_____/_____/_/_/ |_/  /_/   Copyright (C) 2010-2012, 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/>.
+#
+#++
+
+require "rubygems/package_task"
+require "rdoc/task"
+
+$: << File.expand_path("lib", File.dirname(__FILE__))
+require "adlint/postfilter/version"
+
+task :default => [:gem]
+task :clobber => [:clobber_package, :clobber_rdoc]
+
+gemspec = Gem::Specification.new do |s|
+  s.name        = "adlint-postfilter"
+  s.version     = AdLint::Postfilter::SHORT_VERSION
+  s.date        = AdLint::Postfilter::RELEASE_DATE
+  s.homepage    = "http://adlint-goodies.sourceforge.net/"
+  s.licenses    = ["GPLv3+: GNU General Public License version 3 or later"]
+  s.author      = "Yutaka Yanoh"
+  s.email       = "yanoh@users.sourceforge.net"
+  s.summary     = "An ad-hoc filtering wrapper for AdLint"
+  s.description = <<EOS
+adlint-postfilter is an ad-hoc filtering wrapper for AdLint to suppress useless
+warning messages.
+EOS
+
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
+
+  s.executables   = %w(adlint_flt)
+  s.require_paths = %w(lib)
+  manifest_fpath  = File.expand_path("MANIFEST", File.dirname(__FILE__))
+  s.files         = File.readlines(manifest_fpath).map { |str| str.chomp }
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README)
+  s.rdoc_options     = ["--main", "README", "--charset", "utf-8"]
+
+  s.add_dependency("adlint", ">= 1.0.0")
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar_bz2 = true
+end
+
+RDoc::Task.new(:rdoc) do |rd|
+  rd.rdoc_dir = "rdoc"
+  rd.title = "adlint-postfilter #{AdLint::Postfilter::SHORT_VERSION}"
+  rd.main = "README"
+  rd.rdoc_files.include("README")
+  rd.rdoc_files.include("bin/*")
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.options << "--charset=utf-8" << "--all"
+end
+
+desc "Remove package products and RDoc HTML files"
+task :clobber
+
+desc "Generate tags file"
+task :tags do
+  ctags *Dir["bin/*", "lib/**/*.rb"]
+end
+
+def ctags(*files)
+  sh "ctags " + files.join(" ")
+end

data/bin/adlint_flt

@@ -0,0 +1,154 @@
+#! /usr/bin/env ruby
+#
+# An ad-hoc filtering wrapper command for AdLint to suppress useless warning
+# messages.
+#
+# 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.
+#
+# 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/>.
+#
+#++
+
+require "pathname"
+
+$bindir = Pathname.new(__FILE__).realpath.dirname
+$prefix = Pathname.new("..").expand_path($bindir)
+$libdir = Pathname.new("lib").expand_path($prefix)
+$etcdir = Pathname.new("etc").expand_path($prefix)
+
+$stdout.set_encoding(Encoding.default_external)
+$stderr.set_encoding(Encoding.default_external)
+
+$:.unshift($libdir.to_s)
+
+require "adlint/postfilter"
+
+POSTFILTER_VERSION = "adlint-postfilter #{AdLint::Postfilter::VERSION}"
+
+USAGE = <<EOS
+Usage: adlint_flt --analyze <analysis command line> | [other options]
+
+Analysis Options:
+  -A, --analyze                  Execute AdLint analysis command
+  -V, --src-vpath DIR            Use DIR as VPATH (CMA only)
+
+Other Options:
+  -i, --install                  Generate adlint_filter.yml template
+  -t, --transform                Transform project's GNUmakefile
+  -f, --force                    Force to overwrite existing files
+      --version                  Display version information
+      --copyright                Display copyright information
+      --prefix                   Display prefix directory of adlint-postfilter
+  -h, --help                     Display this message
+EOS
+
+require "getoptlong"
+
+parser = GetoptLong.new(["--analyze", "-A", GetoptLong::NO_ARGUMENT],
+                        ["--src-vpath", "-V", GetoptLong::REQUIRED_ARGUMENT],
+                        ["--install", "-i", GetoptLong::NO_ARGUMENT],
+                        ["--transform", "-t", GetoptLong::NO_ARGUMENT],
+                        ["--force", "-f", GetoptLong::NO_ARGUMENT],
+                        ["--version", GetoptLong::NO_ARGUMENT],
+                        ["--copyright", GetoptLong::NO_ARGUMENT],
+                        ["--prefix", GetoptLong::NO_ARGUMENT],
+                        ["--help", "-h", GetoptLong::NO_ARGUMENT])
+parser.quiet = true
+
+begin
+  actions = {}
+  config_fpath = Pathname.new("./adlint_postfilter.yml")
+  makefile_fpath = Pathname.new("./GNUmakefile")
+  command_line = nil
+  force_overwrite = false
+  src_vpath = nil
+
+  parser.each_option do |optname, optarg|
+    case optname
+    when "--analyze"
+      actions[:analyze] = true
+      command_line = ARGV.join(" ")
+      break
+    when "--src-vpath"
+      src_vpath = Pathname.new(optarg)
+    when "--install"
+      actions[:install] = true
+    when "--transform"
+      actions[:transform] = true
+    when "--force"
+      force_overwrite = true
+    when "--version"
+      puts POSTFILTER_VERSION, AdLint::Postfilter::AUTHOR
+      exit 0
+    when "--copyright"
+      puts AdLint::Postfilter::COPYRIGHT
+      exit 0
+    when "--prefix"
+      puts $prefix
+      exit 0
+    when "--help"
+      puts USAGE
+      exit 0
+    end
+  end
+rescue
+end
+
+if actions.empty?
+  $stderr.puts "#{File.basename(__FILE__)}: nothing to be done"
+  $stderr.puts USAGE
+  exit 10
+end
+
+if actions[:install]
+  if !config_fpath.exist? || force_overwrite
+    AdLint::Postfilter.install_config_template(config_fpath)
+  else
+    $stderr.puts "#{File.basename(__FILE__)}: #{config_fpath} already exists"
+    exit 10
+  end
+end
+
+if actions[:transform]
+  if makefile_fpath.exist?
+    AdLint::Postfilter.transform_makefile(makefile_fpath)
+  else
+    $stderr.puts "#{File.basename(__FILE__)}: cannot access #{makefile_fpath}"
+    exit 10
+  end
+end
+
+if actions[:analyze]
+  if command_line
+    exit AdLint::Postfilter.run(config_fpath, command_line, src_vpath)
+  else
+    $stderr.puts "#{File.basename(__FILE__)}: no analysis command line"
+    $stderr.puts USAGE
+    exit 10
+  end
+end
+
+exit 0

data/etc/conf.d/adlint_postfilter.yml

@@ -0,0 +1,21 @@
+#     ___    ____  __    ___   _________
+#    /   |  / _  |/ /   / / | / /__  __/           Source Code Static Analyzer
+#   / /| | / / / / /   / /  |/ /  / /                   AdLint - Advanced Lint
+#  / __  |/ /_/ / /___/ / /|  /  / /
+# /_/  |_|_____/_____/_/_/ |_/  /_/   Copyright (C) 2010-2012, OGIS-RI Co.,Ltd.
+#
+# Configuration file for adlint_flt command of adlint-postfilter.
+#
+
+message_traits:
+
+  # Project-wide message suppressions.
+  # Ex.
+  #   suppression_list:
+  #     - W0001
+  #     - W0002
+  #     - C0003
+  suppression_list:
+
+  # Enable message control annotations in source files?
+  enable_individual_suppression_control: true