adlint-exam-c_staging 0.2.0

data/ChangeLog

@@ -0,0 +1,33 @@
+Fri Sep 21 16:48:06 2012  Yutaka Yanoh  <yanoh@users.sourceforge.net>
+
+	* release.ga : 0.2.0
+	  - Add requested code check W2001 which detects an absolute pathname
+	    as argument of #include directive.
+	  - Add requested code check W2002 which detects inclusion of a user
+	    header by #include <...> directive.
+
+Wed Sep 19 17:20:01 2012  Yutaka Yanoh  <yanoh@users.sourceforge.net>
+
+	* release.rc : 0.1.1
+	  - Add requested code check W2002 which detects inclusion of a user
+	    header by #include <...> directive.
+
+Wed Sep 19 16:11:38 2012  Yutaka Yanoh  <yanoh@users.sourceforge.net>
+
+	* features/code_check/W2002.feature : Add W2002 specification.
+	* MANIFEST : Ditto.
+
+	* lib/adlint/exam/c_staging/cpp_check.rb : Add W2002 detection.
+
+Thu Sep 13 17:23:37 2012  Yutaka Yanoh  <yanoh@users.sourceforge.net>
+
+	* release.rc : 0.1.0
+	  - Add requested code check W2001 which detects an absolute pathname
+	    as argument of #include directive.
+
+Thu Sep 13 16:32:44 2012  Yutaka Yanoh  <yanoh@users.sourceforge.net>
+
+	* features/code_check/W2001.feature : Add W2001 specification.
+	* MANIFEST : Ditto.
+
+	* lib/adlint/exam/c_staging/cpp_check.rb : Add W2001 detection.

data/INSTALL

@@ -0,0 +1,98 @@
+--
+     ___    ____  __    ___   _________
+    /   |  / _  |/ /   / / | / /__  __/            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
+
+* Ruby 1.9.3-p0 or later for normal use [*mandatory*]
+* GNU Make 3 or later to use adlintized Makefile [optional but recommended]
+* Racc 1.4.7 for development [optional]
+
+=== Installation
+
+Setup your Ruby interpreter.
+Then, you can install \AdLint by following instruction.
+
+ % gem install adlint adlint-exam-c_staging
+or
+ % sudo gem install adlint adlint-exam-c_staging
+
+=== Evaluation
+
+Tiny sample C language projects are bundled with \AdLint gem.
+You can evaluate \AdLint by following instructions.
+
+First, copy \`intro_demo' project into your workspace.  "+adlint+ +--prefix+"
+command prints the prefix pathname of the \AdLint installation directory.
+
+ % cp -r `adlint --prefix`/share/demo/intro_demo .
+
+Second, generate configuration files for \AdLint.
+
+ % cd intro_demo
+ % adlintize
+
+Following files will be generated.
+
+* [+GNUmakefile+] Automatic analysis Makefile for GNU Make.
+* [+adlint_traits.yml+] \AdLint configuration file.
+* [+adlint_pinit.h+] Project specific initial header file.
+* [+adlint_cinit.h+] Compiler specific initial header file.
+* [+adlint_all.sh+] Automatic analysis shell script.
+* [+adlint_all.bat+] Automatic analysis mswin bat file.
+* [+adlint_files.txt+] List file for sh script and bat file.
+
+Third, edit +adlint_traits.yml+ to use adlint-exam-c_staging examination
+package.
+
+ % cp adlint_traits.yml adlint_traits.yml.orig
+ % vi adlint_traits.yml
+ % diff -u adlint_traits.yml.orig adlint_traits.yml
+ --- adlint_traits.yml.orig      2012-09-13 15:16:12.345684410 +0900
+ +++ adlint_traits.yml   2012-09-13 15:16:46.312257169 +0900
+ @@ -17,6 +17,7 @@
+  # list to specify which examination packages are to be run.
+  exam_packages:
+    - "c_builtin"
+ +  - "c_staging"
+  
+  #
+  # Project specific traits section
+
+Finally, do analysis.
+
+ % make verbose-all
+ adlint --verbose -t adlint_traits.yml -o . intro_demo.c
+                   intro_demo.c [fin] |============================| 0.401s
+                     intro_demo [fin] |============================| 0.029s
+   1.125s user, 0.765s system, 00:00:01.89 total
+
+Following files will be generated.
+
+* [+intro_demo.i+]         Preprocessed source of +intro_demo.c+.
+* [+intro_demo.c.met.csv+] Single module code structure and metric information.
+* [+intro_demo.c.msg.csv+] Single module warning messages.
+* [+intro_demo.met.csv+]   Cross module metric information.
+* [+intro_demo.msg.csv+]   Cross module warning messages.
+
+\`+intro_demo.c.msg.csv+' will tell you that the control will never reach to
+some statements and that division by zero will occur in \`+intro_demo.c+'.

data/MANIFEST

@@ -0,0 +1,17 @@
+AUTHORS
+COPYING
+ChangeLog
+INSTALL
+MANIFEST
+NEWS
+README
+Rakefile
+TODO
+etc/mesg.d/c_staging/en_US/messages.yml
+etc/mesg.d/c_staging/ja_JP/messages.yml
+features/code_check/W2001.feature
+features/code_check/W2002.feature
+features/step_definitions/code_check_steps.rb
+features/support/env.rb
+lib/adlint/exam/c_staging.rb
+lib/adlint/exam/c_staging/cpp_check.rb

data/NEWS

@@ -0,0 +1,30 @@
+--
+     ___    ____  __    ___   _________
+    /   |  / _  |/ /   / / | / /__  __/            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/>.
+
+++
+
+=== adlint-exam-c_staging 0.2.0 is released (2012-09-21)
+
+==== Including source code examination features
+
+* W2001 detects that an absolute pathname as argument of #include directive
+* W2002 detects that a header file under the project root directory is included
+  as a system header

data/README

@@ -0,0 +1,60 @@
+--
+     ___    ____  __    ___   _________
+    /   |  / _  |/ /   / / | / /__  __/            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-exam-c_staging is an experimental C language code examination package
+for \AdLint.
+
+== News
+
+:include:NEWS
+
+== How to Install
+
+:include:INSTALL
+
+== License
+
+Copyright (C) 2010-2012, {OGIS-RI}[http://www.ogis-ri.co.jp/] Co.,Ltd.
+
+\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/}[http://www.gnu.org/licenses/]>.
+
+== TODO
+
+:include:TODO
+
+== Authors
+
+:include:AUTHORS

data/Rakefile

@@ -0,0 +1,109 @@
+#--
+#     ___    ____  __    ___   _________
+#    /   |  / _  |/ /   / / | / /__  __/           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"
+require "rspec/core/rake_task"
+require "cucumber/rake/task"
+
+$: << File.expand_path("lib", File.dirname(__FILE__))
+require "adlint/exam/c_staging"
+
+task :default => [:gem]
+#task :gem => [:doc]
+#task :package => [:doc]
+
+gemspec = Gem::Specification.new do |s|
+  s.name        = "adlint-exam-c_staging"
+  s.version     = AdLint::Exam::CStaging::Catalog.short_version
+  s.date        = AdLint::Exam::CStaging::Catalog.release_date
+  s.homepage    = "http://adlint.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     = <<EOS
+Experimental C language code examination package for AdLint
+EOS
+  s.description = <<EOS
+Experimental C language code examination package for AdLint
+EOS
+
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
+
+  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", ">= 2.3.0")
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar_bz2 = true
+end
+
+desc "Build Texinfo HTML files"
+task :doc do
+  chdir "share/doc" do
+    make "all"
+  end
+end
+
+RDoc::Task.new(:rdoc) do |rd|
+  rd.rdoc_dir = "rdoc"
+  rd.title = "adlint-exam-c_staging " +
+             AdLint::Exam::CStaging::Catalog.short_version
+  rd.main = "README"
+  rd.rdoc_files.include("README")
+  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
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = %w(-w)
+  t.rspec_opts = %w(-f html -o spec.html)
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = %w(--strict --quiet -f html -o features.html)
+end
+
+def make(*targets)
+  sh "make " + targets.join(" ")
+end
+
+def ctags(*files)
+  sh "ctags " + files.join(" ")
+end

data/TODO

@@ -0,0 +1,26 @@
+--
+     ___    ____  __    ___   _________
+    /   |  / _  |/ /   / / | / /__  __/            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/>.
+
+++
+
+* Add many more requested source code examination features
+
+Any contributions are welcome!

data/etc/mesg.d/c_staging/en_US/messages.yml

@@ -0,0 +1,52 @@
+#     ___    ____  __    ___   _________
+#    /   |  / _  |/ /   / / | / /__  __/           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/>.
+#
+#
+# Default message catalog of c_staging examination package for ja_JP locale.
+#
+#                      *********************************
+#                      ***** DO NOT EDIT THIS FILE *****
+#                      *********************************
+#
+# To override default messages, edit `change_list' section of the traits file.
+#
+# [Example]
+#
+# % tail traits.yml
+# message_traits:
+#   change_list:
+#     W9999:
+#       package: "c_staging"
+#       classes:
+#         - "REL:A10"
+#         - "PRT:B20"
+#       format: "Your custom message for the warning of W9999."
+
+version: "0.2.0"
+
+message_definition:
+  W2001:
+    classes:
+      - "UNC:X99"
+    format: "`%s' is included with an absolute pathname."
+  W2002:
+    classes:
+      - "UNC:X99"
+    format: "`%s' under the project root directory is included with #include <...> directive."

data/etc/mesg.d/c_staging/ja_JP/messages.yml

@@ -0,0 +1,52 @@
+#     ___    ____  __    ___   _________
+#    /   |  / _  |/ /   / / | / /__  __/           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/>.
+#
+#
+# Default message catalog of c_staging examination package for ja_JP locale.
+#
+#                      *********************************
+#                      ***** DO NOT EDIT THIS FILE *****
+#                      *********************************
+#
+# To override default messages, edit `change_list' section of the traits file.
+#
+# [Example]
+#
+# % tail traits.yml
+# message_traits:
+#   change_list:
+#     W9999:
+#       package: "c_staging"
+#       classes:
+#         - "REL:A10"
+#         - "PRT:B20"
+#       format: "Your custom message for the warning of W9999."
+
+version: "0.2.0"
+
+message_definition:
+  W2001:
+    classes:
+      - "UNC:X99"
+    format: "`%s' は絶対パス指定でインクルードされています。"
+  W2002:
+    classes:
+      - "UNC:X99"
+    format: "プロジェクトルートディレクトリ内の `%s' が #include <...> ディレクティブによりインクルードされています。"

data/features/code_check/W2001.feature

@@ -0,0 +1,25 @@
+Feature: W2001
+
+  W2001 detects that an absolute pathname as argument of #include directive.
+
+  Scenario: an absolute pathname in #include "..." directive
+    Given a target source named "fixture.c" with:
+      """
+      #include "/dev/null" /* W2001 */
+      """
+    When I successfully run `adlint fixture.c` on noarch
+    Then the output should exactly match with:
+      | mesg  | line | column |
+      | W2001 | 1    | 1      |
+
+  Scenario: an absolute pathname in #include <...> directive
+    Given a target source named "fixture.c" with:
+      """
+      #include </dev/null> /* W2001 */
+      """
+    When I successfully run `adlint fixture.c` on noarch
+    Then the output should exactly match with:
+      | mesg  | line | column |
+      | W2001 | 1    | 1      |
+
+# vim:ts=2:sw=2:sts=2:et:

data/features/code_check/W2002.feature

@@ -0,0 +1,33 @@
+Feature: W2002
+
+  W2002 detects that a header file under the project root directory is included
+  as a system header.
+
+  Scenario: including as a user header
+    Given a target source named "fixture.c" with:
+      """
+      #include "config.h" /* OK */
+      """
+    And a target source named "config.h" with:
+      """
+      #define HAVE_STDIO_H
+      """
+    When I successfully run `adlint fixture.c` on noarch
+    Then the output should exactly match with:
+      | mesg  | line | column |
+
+  Scenario: including as a system header
+    Given a target source named "fixture.c" with:
+      """
+      #include <config.h> /* W2002 */
+      """
+    And a target source named "config.h" with:
+      """
+      #define HAVE_STDIO_H
+      """
+    When I successfully run `adlint fixture.c` on noarch
+    Then the output should exactly match with:
+      | mesg  | line | column |
+      | W2002 | 1    | 1      |
+
+# vim:ts=2:sw=2:sts=2:et:

data/features/step_definitions/code_check_steps.rb

@@ -0,0 +1,18 @@
+Given /^a target source named "(.*)" with:$/ do |src_name, content|
+  create_src_file(src_name, content)
+end
+
+When /^I successfully run `(.*)` on noarch$/ do |abbrev_cmd|
+  cmd, src = abbrev_cmd.split
+  run_adlint(cmd, src, "-t", "noarch_traits.yml")
+end
+
+Then /^the output should exactly match with:$/ do |mesg_table|
+  $all_output.each_line.zip(mesg_table.hashes).each do |line, row|
+    if row
+      line.should =~ /#{row[:line]}:#{row[:column]}:.*:.*:#{row[:mesg]}/
+    else
+      line.should =~ /::.*:/
+    end
+  end
+end