adlint 1.0.0

data/lib/adlint/cpp/util.rb

@@ -0,0 +1,97 @@
+# Miscellaneous utilities for C preprocessor language.
+#
+# 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/>.
+#
+#++
+
+module AdLint #:nodoc:
+module Cpp #:nodoc:
+
+  class EscapeSequence
+    # TODO: Remove duplication in c/util.rb and cpp/util.rb .
+    def initialize(str)
+      @str = str
+    end
+
+    def value
+      case @str
+      when "\\'" then "'".ord
+      when "\\\"" then "\"".ord
+      when "\\?" then "?".ord
+      when "\\\\" then "\\".ord
+      when "\\a" then "\a".ord
+      when "\\b" then "\b".ord
+      when "\\f" then "\f".ord
+      when "\\n" then "\n".ord
+      when "\\r" then "\r".ord
+      when "\\t" then "\t".ord
+      when "\\v" then "\v".ord
+      else
+        case @str
+        when /\A\\([0-9]{1,3})\z/
+          $1.to_i(8)
+        when /\A\\x([0-9A-F]+)\z/i
+          $1.to_i(16)
+        when /\A\\u([0-9A-F]{4,8})\z/i
+          $1.to_i(16)
+        else
+          0
+        end
+      end
+    end
+  end
+
+  class BasicSourceCharacterSet
+    def self.include?(string)
+      string.chars.all? { |ch| CHARS.include?(ch.ord) }
+    end
+
+    def self.select_adapted(string)
+      string.chars.select { |ch| CHARS.include?(ch.ord) }
+    end
+
+    def self.select_not_adapted(string)
+      string.chars.to_a - select_adapted(string)
+    end
+
+    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",
+      "_", "{", "}", "[", "]", "#", "(", ")", "<", ">", "%", ":", ";",
+      ".", "?", "*", "+", "-", "/", "^", "&", "|", "~", "=", ",", "\\",
+      "\"", "'"
+    ].map { |ch| ch.ord }.to_set.freeze
+    private_constant :CHARS
+  end
+
+end
+end

data/lib/adlint/cpp.rb

@@ -0,0 +1,43 @@
+# AdLint::Cpp 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.
+#
+# 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 "adlint/cpp/code"
+require "adlint/cpp/eval"
+require "adlint/cpp/constexpr"
+require "adlint/cpp/lexer"
+require "adlint/cpp/macro"
+require "adlint/cpp/message"
+require "adlint/cpp/phase"
+require "adlint/cpp/scanner"
+require "adlint/cpp/source"
+require "adlint/cpp/subst"
+require "adlint/cpp/syntax"
+require "adlint/cpp/util"

data/lib/adlint/driver.rb

@@ -0,0 +1,147 @@
+# Analysis 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.
+#
+# 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 "adlint/prelude"
+require "adlint/traits"
+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.
+
+    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
+      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, ex.backtrace
+      $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, ex.backtrace
+      $stderr.puts
+      exit 2
+    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
+    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
+    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
+      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
+
+  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")
+      end
+    end
+  end
+  module_function :sma_met_fpaths
+end

data/lib/adlint/error.rb

@@ -0,0 +1,179 @@
+# AdLint specific runtime error classes.
+#
+# 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 "adlint/token"
+
+module AdLint #:nodoc:
+
+  # == DESCRIPTION
+  # Error base class for AdLint specific errors.
+  class Error < StandardError
+    # === DESCRIPTION
+    # Constructs an error object.
+    #
+    # === PARAMETER
+    # _message_:: String -- Error message.
+    # _location_:: Location -- Location where an error occured.
+    # _parts_:: Array< Object > -- Message formatting values.
+    def initialize(message, location = nil, *parts)
+      super(message)
+      @location = location
+      @parts = parts
+    end
+
+    # === VALUE
+    # Location -- The location where this error occured.
+    attr_reader :location
+
+    # === VALUE
+    # 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
+      subclass_responsibility
+    end
+  end
+
+  # == DESCRIPTION
+  # \AdLint fatal internal error.
+  class InternalError < Error
+    # === DESCRIPTION
+    # 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}")
+    end
+
+    # === DESCRIPTION
+    # Reads the message ID of this error.
+    #
+    # === RETURN VALUE
+    # Symbol -- Message ID.
+    def id
+      :X0001
+    end
+
+    # === DESCRIPTION
+    # Reads the message of this error.
+    #
+    # === RETURN VALUE
+    # String -- Error message.
+    def message
+      @cause.message
+    end
+
+    # === DESCRIPTION
+    # Reads the backtrace information of this error.
+    #
+    # === RETURN VALUE
+    # Array -- Backtrace information.
+    def backtrace
+      @cause.backtrace
+    end
+  end
+
+  # == DESCRIPTION
+  # Internal error which indicates invalid message ID used.
+  class InvalidMessageIdError < Error
+    # === DESCRIPTION
+    # Constructs a invalid message ID error.
+    #
+    # === PARAMETER
+    # _id_:: Symbol -- Invalid message ID.
+    # _location_:: Location -- Location where the error occured.
+    def initialize(id, location = nil)
+      super(id, location, id)
+    end
+
+    # === DESCRIPTION
+    # Reads the message ID of this error.
+    #
+    # === RETURN VALUE
+    # String -- Message ID.
+    def id
+      :X0002
+    end
+  end
+
+  class InvalidMessageFormatError < Error
+    def initialize(id, location = nil)
+      super(id, location, id)
+    end
+
+    def id
+      :X0004
+    end
+  end
+
+  class FatalError < Error
+    def id
+      :X0003
+    end
+  end
+
+  class ParseError < FatalError
+    def initialize(location, msg_fpath, log_fpath)
+      super("failed to parse preprocessed file.", location,
+            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)
+    end
+  end
+
+  class MissingSystemHeaderError < FatalError
+    def initialize(location, basename, msg_fpath, log_fpath)
+      super("cannot open <#{basename}>.", location, 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)
+    end
+  end
+
+end

data/lib/adlint/lang.rb

@@ -0,0 +1,97 @@
+# Programming language detection mechanism.
+#
+# 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 "adlint/cpp/scanner"
+require "adlint/cpp/phase"
+require "adlint/c/scanner"
+require "adlint/c/phase"
+
+module AdLint #:nodoc:
+
+  # == DESCRIPTION
+  # Programming language.
+  class Language
+    # === DESCRIPTION
+    # Detects programming language of the specified source file.
+    #
+    # === PARAMETER
+    # _fpath_:: Pathname -- File path of the source file.
+    #
+    # === RETURN VALUE
+    # Language -- Object of the derived class of Language class.
+    def self.of(fpath)
+      # FIXME: Dummy implementation.
+      C
+    end
+
+    class Cpp
+      extend AdLint::Cpp::Scanner
+
+      class << self
+        def single_module_phases; [] end
+        def check_phases; [] end
+      end
+    end
+
+    class C
+      include AdLint::C::ScannerConstants
+      extend AdLint::C::Scanner
+
+      class << self
+        def single_module_phases
+          [
+            AdLint::Cpp::PreparePhase,
+            AdLint::Cpp::EvalPhase,
+            AdLint::Cpp::SubstPhase,
+            AdLint::C::ParsePhase,
+            AdLint::C::ResolvePhase,
+            AdLint::C::PreparePhase,
+            AdLint::C::InterpPhase,
+            AdLint::Cpp::ReviewPhase,
+            AdLint::C::ReviewPhase,
+            AdLint::Cpp::CommandPhase,
+            AdLint::C::CommandPhase
+          ].freeze
+        end
+
+        def check_phases
+          [
+            AdLint::Cpp::PreparePhase,
+            AdLint::Cpp::EvalPhase,
+            AdLint::Cpp::SubstPhase,
+            AdLint::C::ParsePhase
+          ].freeze
+        end
+      end
+    end
+  end
+
+end