adlint 2.6.14 → 3.0.0

data/lib/adlint/cpp/util.rb

@@ -1,7 +1,7 @@
 # Miscellaneous utilities for C preprocessor language.
 #
 # 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,7 @@ module AdLint #:nodoc:
 module Cpp #:nodoc:
 
   class EscapeSequence
-    # TODO: Remove duplication in c/util.rb and cpp/util.rb .
+    # TODO: Remove duplication in cc1/util.rb and cpp/util.rb .
     def initialize(str)
       @str = str
     end
@@ -66,18 +66,21 @@ module Cpp #:nodoc:
     end
   end
 
-  class BasicSourceCharacterSet
-    def self.include?(string)
-      string.chars.all? { |ch| CHARS.include?(ch.ord) }
+  module BasicSourceCharacterSet
+    def include?(str)
+      str.chars.all? { |ch| CHARS.include?(ch.ord) }
     end
+    module_function :include?
 
-    def self.select_adapted(string)
-      string.chars.select { |ch| CHARS.include?(ch.ord) }
+    def select_adapted(str)
+      str.chars.select { |ch| CHARS.include?(ch.ord) }
     end
+    module_function :select_adapted
 
-    def self.select_not_adapted(string)
-      string.chars.to_a - select_adapted(string)
+    def select_not_adapted(str)
+      str.chars.to_a - select_adapted(str)
     end
+    module_function :select_not_adapted
 
     # NOTE: The ISO C99 standard says;
     #
@@ -109,15 +112,15 @@ module Cpp #:nodoc:
     #   the space character, and control characters representing horizontal
     #   tab, vertical tab, and form feed.
     CHARS = [
-      " ", "\t", "\v", "\f", "\n",
-      "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m",
-      "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z",
-      "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M",
-      "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z",
-      "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
-      "_", "{", "}", "[", "]", "#", "(", ")", "<", ">", "%", ":", ";",
-      ".", "?", "*", "+", "-", "/", "^", "&", "|", "~", "=", ",", "\\",
-      "\"", "'"
+      "A", "B" , "C" , "D" , "E" , "F", "G", "H", "I" , "J", "K", "L", "M",
+      "N", "O" , "P" , "Q" , "R" , "S", "T", "U", "V" , "W", "X", "Y", "Z",
+      "a", "b" , "c" , "d" , "e" , "f", "g", "h", "i" , "j", "k", "l", "m",
+      "n", "o" , "p" , "q" , "r" , "s", "t", "u", "v" , "w", "x", "y", "z",
+      "0", "1" , "2" , "3" , "4" , "5", "6", "7", "8" , "9",
+      "!", '"' , "#" , "%" , "&" , "'", "(", ")", "*" , "+", ",", "-", ".",
+      "/", ":" , ";" , "<" , "=" , ">", "?", "[", "\\", "]", "^", "_", "{",
+      "|", "}" , "~" ,
+      " ", "\t", "\v", "\f", "\n"
     ].map { |ch| ch.ord }.to_set.freeze
     private_constant :CHARS
   end

data/lib/adlint/driver.rb

@@ -1,7 +1,7 @@
 # Analysis drivers.
 #
 # 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.
 #
@@ -35,113 +35,106 @@ require "adlint/message"
 require "adlint/analyzer"
 
 module AdLint #:nodoc:
-  def setup(command, traits_fpath, verbose)
-    self.verbose = verbose
-    $stdout.sync = true if verbose?
-    at_exit { print_elapsed_time($stdout) if verbose? }
 
-    # NOTE: Psych::SyntaxError is a subclass of the builtin ::SyntaxError.
-    #       The rescue clause without error_type is equivalent to
-    #       `rescue StandardError'.  So, the rescue clause without error_type
-    #       cannot catch Psych::SyntaxError.
+  class AdLint
+    def initialize(traits_fpath, output_dpath = nil, verbose = false,
+                   cmd_name = File.basename($0))
+      @cmd_name     = cmd_name
+      @traits       = load_traits(traits_fpath)
+      @msg_catalog  = load_message_catalog(@traits)
+      @output_dpath = output_dpath
+      @verbose      = verbose
 
-    begin
-      Traits.instance.read_from(traits_fpath)
-      unless Traits.instance.valid?
-        $stderr.puts "#{command}: Traits file `#{traits_fpath}' is invalid."
-        $stderr.puts
-        $stderr.puts "Detailed message is below;"
-        Traits.instance.errors.each_with_index do |error, index|
-          $stderr.puts "#{index + 1}. #{error}"
-        end
-        $stderr.puts
-        exit 3
+      if verbose
+        $stdout.sync = true
+        at_exit { print_elapsed_time($stdout) }
       end
-    rescue SyntaxError, StandardError => ex
-      $stderr.puts "#{command}: Failed to read `#{traits_fpath}'."
-      $stderr.puts
-      $stderr.puts "Detailed message is below;"
-      $stderr.puts ex.message
-      $stderr.puts
-      exit 2
     end
 
-    begin
-      MessageCatalog.instance.load
-    rescue SyntaxError, StandardError => ex
-      $stderr.puts "#{command}: Failed to read the message catalog for " +
-        "`#{Traits.instance.of_message.language}'."
-      $stderr.puts
-      $stderr.puts "Detailed message is below;"
-      $stderr.puts ex.message
-      $stderr.puts
-      exit 2
+    attr_reader :traits
+    attr_reader :msg_catalog
+    attr_reader :verbose
+
+    def run_sma!(src_fpath, strip_num = 0)
+      FileUtils.mkdir_p(sma_output_dpath(src_fpath, strip_num, @output_dpath))
+      SingleModuleAnalyzer.new(@traits, @msg_catalog, src_fpath, strip_num,
+                               @output_dpath, @verbose).run
     end
-  end
-  module_function :setup
 
-  def sma(fpaths, strip_num = 0, output_dpath = nil)
-    failed = false
-    fpaths.each do |fpath|
-      FileUtils.mkdir_p(sma_output_dpath(fpath, strip_num, output_dpath))
-      unless SingleModuleAnalyzer.new(fpath, strip_num, output_dpath).run
-        failed = true
-      end
+    def run_cma!(met_fpaths)
+      FileUtils.mkdir_p(@output_dpath) if @output_dpath
+      CrossModuleAnalyzer.new(@traits, @msg_catalog, met_fpaths, @output_dpath,
+                              @verbose).run
     end
-    exit 4 if failed
-  rescue => ex
-    $stderr.puts ex.message, ex.backtrace
-    $stderr.puts
-    exit 2
-  end
-  module_function :sma
 
-  def cma(fpaths, output_dpath = nil)
-    FileUtils.mkdir_p(output_dpath) if output_dpath
-    unless CrossModuleAnalyzer.new(fpaths, output_dpath).run
-      exit 5
+    def run_chk!(src_fpath, strip_num = 0)
+      FileUtils.mkdir_p(sma_output_dpath(src_fpath, strip_num, @output_dpath))
+      ConfigurationValidator.new(@traits, @msg_catalog, src_fpath, strip_num,
+                                 @output_dpath, @verbose).run
     end
-  rescue => ex
-    $stderr.puts ex.message, ex.backtrace
-    $stderr.puts
-    exit 2
-  end
-  module_function :cma
 
-  def chk(fpaths, strip_num = 0, output_dpath = nil)
-    failed = false
-    fpaths.each do |fpath|
-      FileUtils.mkdir_p(chk_output_dpath(fpath, strip_num, output_dpath))
-      unless ConfigurationValidator.new(fpath, strip_num, output_dpath).run
-        failed = true
+    def met_fpaths_of(src_fpaths, strip_num)
+      src_fpaths.map do |fpath|
+        if @output_dpath
+          @output_dpath.join(fpath.strip(strip_num)).add_ext(".met.csv")
+        else
+          fpath.strip(strip_num).add_ext(".met.csv")
+        end
       end
     end
-    exit 6 if failed
-  rescue => ex
-    $stderr.puts ex.message, ex.backtrace
-    $stderr.puts
-    exit 2
-  end
-  module_function :chk
 
-  def sma_output_dpath(fpath, strip_num = 0, output_dpath = nil)
-    fpath.strip(strip_num).expand_path(output_dpath).dirname
-  end
-  module_function :sma_output_dpath
-
-  def chk_output_dpath(fpath, strip_num = 0, output_dpath = nil)
-    sma_output_dpath(fpath, strip_num, output_dpath)
-  end
-  module_function :chk_output_dpath
+    private
+    def load_traits(traits_fpath)
+      begin
+        traits = Traits.new(traits_fpath)
+        unless traits.valid?
+          $stderr.puts "#{@cmd_name}: Failed to read `#{traits_fpath}'."
+          $stderr.puts
+          $stderr.puts "Detailed message is below;"
+          traits.errors.each_with_index do |err, idx|
+            $stderr.puts "#{idx + 1}. #{err}"
+          end
+          $stderr.puts
+          exit 3
+        end
+        traits
+      rescue Psych::SyntaxError, StandardError => ex
+        $stderr.puts "#{@cmd_name}: Failed to read `#{traits_fpath}'."
+        $stderr.puts
+        $stderr.puts "Detailed message is below;"
+        $stderr.puts ex.message, ex.backtrace
+        $stderr.puts
+        exit 2
+      end
+    end
 
-  def sma_met_fpaths(fpaths, strip_num = 0, output_dpath = nil)
-    fpaths.map do |fpath|
-      if output_dpath
-        output_dpath.join(fpath.strip(strip_num)).add_ext(".met.csv")
-      else
-        fpath.strip(strip_num).add_ext(".met.csv")
+    def load_message_catalog(traits)
+      begin
+        MessageCatalog.new(traits)
+      rescue Psych::SyntaxError, StandardError => ex
+        $stderr.puts "#{@cmd_name}: Failed to read the message catalog for " +
+                     "`#{traits.of_message.language}'."
+        $stderr.puts
+        $stderr.puts "Detailed message is below;"
+        $stderr.puts ex.message, ex.backtrace
+        $stderr.puts
+        exit 2
       end
     end
+
+    def sma_output_dpath(src_fpath, strip_num, output_dpath)
+      src_fpath.strip(strip_num).expand_path(output_dpath).dirname
+    end
+
+    def print_elapsed_time(io)
+      tms = Process.times
+      io.print "  %.3fs user, %.3fs system, " % [tms.utime, tms.stime]
+      total = tms.utime + tms.stime
+      h = total / 3600
+      m = total / 60 % 60
+      s = (total % 60).floor
+      io.puts "%02d:%02d:%02d.%02d total" % [h, m, s, ((total % 60) - s) * 100]
+    end
   end
-  module_function :sma_met_fpaths
+
 end

data/lib/adlint/error.rb

@@ -1,7 +1,7 @@
 # AdLint specific runtime error 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.
 #
@@ -40,12 +40,12 @@ module AdLint #:nodoc:
     # Constructs an error object.
     #
     # === PARAMETER
-    # _message_:: String -- Error message.
-    # _location_:: Location -- Location where an error occured.
+    # _msg_:: String -- Error message.
+    # _loc_:: Location -- Location where an error occured.
     # _parts_:: Array< Object > -- Message formatting values.
-    def initialize(message, location = nil, *parts)
-      super(message)
-      @location = location
+    def initialize(msg, loc = nil, *parts)
+      super(msg)
+      @location = loc
       @parts = parts
     end
 
@@ -57,14 +57,7 @@ module AdLint #:nodoc:
     # Array -- Message formatting values.
     attr_reader :parts
 
-    # === DESCRIPTION
-    # Reads the message ID of this error.
-    #
-    # Subclasses must implement this method.
-    #
-    # === RETURN VALUE
-    # Symbol -- Message ID.
-    def id
+    def message_name
       subclass_responsibility
     end
   end
@@ -76,19 +69,14 @@ module AdLint #:nodoc:
     # Constructs an AdLint specific fatal internal error object.
     #
     # === PARAMETER
-    # _cause_:: Exception -- Cause exception object.
-    # _location_:: Location -- Location where an error occured.
-    def initialize(cause, location)
-      @cause = cause
-      super(cause.message, location, "#{cause.class} : #{cause.message}")
+    # _cause_ex_:: Exception -- Cause exception object.
+    # _loc_:: Location -- Location where an error occured.
+    def initialize(cause_ex, loc)
+      @cause_ex = cause_ex
+      super(cause_ex.message, loc, "#{cause_ex.class} : #{cause_ex.message}")
     end
 
-    # === DESCRIPTION
-    # Reads the message ID of this error.
-    #
-    # === RETURN VALUE
-    # Symbol -- Message ID.
-    def id
+    def message_name
       :X0001
     end
 
@@ -98,7 +86,7 @@ module AdLint #:nodoc:
     # === RETURN VALUE
     # String -- Error message.
     def message
-      @cause.message
+      @cause_ex.message
     end
 
     # === DESCRIPTION
@@ -107,7 +95,7 @@ module AdLint #:nodoc:
     # === RETURN VALUE
     # Array -- Backtrace information.
     def backtrace
-      @cause.backtrace
+      @cause_ex.backtrace
     end
   end
 
@@ -118,61 +106,54 @@ module AdLint #:nodoc:
     # Constructs a invalid message ID error.
     #
     # === PARAMETER
-    # _id_:: Symbol -- Invalid message ID.
-    # _location_:: Location -- Location where the error occured.
-    def initialize(package, id, location = nil)
-      super(id, location, package, id)
+    # _msg_id_:: Symbol -- Invalid message ID.
+    # _loc_:: Location -- Location where the error occured.
+    def initialize(msg_id, loc = nil)
+      super(msg_id.message_name, loc, msg_id.package_name, msg_id.message_name)
     end
 
-    # === DESCRIPTION
-    # Reads the message ID of this error.
-    #
-    # === RETURN VALUE
-    # String -- Message ID.
-    def id
+    def message_name
       :X0002
     end
   end
 
   class InvalidMessageFormatError < Error
-    def initialize(package, id, location = nil)
-      super(id, location, package, id)
+    def initialize(msg_id, loc = nil)
+      super(msg_id.message_name, loc, msg_id.package_name, msg_id.message_name)
     end
 
-    def id
+    def message_name
       :X0004
     end
   end
 
   class FatalError < Error
-    def id
+    def message_name
       :X0003
     end
   end
 
   class ParseError < FatalError
-    def initialize(location, msg_fpath, log_fpath)
-      super("failed to parse preprocessed file.", location,
-            msg_fpath, log_fpath)
+    def initialize(loc, msg_fpath, log_fpath)
+      super("failed to parse preprocessed file.", loc, msg_fpath, log_fpath)
     end
   end
 
   class MissingUserHeaderError < FatalError
-    def initialize(location, basename, msg_fpath, log_fpath)
-      super("cannot open \"#{basename}\".", location, msg_fpath, log_fpath)
+    def initialize(loc, basename, msg_fpath, log_fpath)
+      super("cannot open \"#{basename}\".", loc, msg_fpath, log_fpath)
     end
   end
 
   class MissingSystemHeaderError < FatalError
-    def initialize(location, basename, msg_fpath, log_fpath)
-      super("cannot open <#{basename}>.", location, msg_fpath, log_fpath)
+    def initialize(loc, basename, msg_fpath, log_fpath)
+      super("cannot open <#{basename}>.", loc, msg_fpath, log_fpath)
     end
   end
 
   class UnterminatedCommentError < FatalError
-    def initialize(location, msg_fpath, log_fpath)
-      super("unterminated comment block found.",
-            location, msg_fpath, log_fpath)
+    def initialize(loc, msg_fpath, log_fpath)
+      super("unterminated comment block found.", loc, msg_fpath, log_fpath)
     end
   end