adlint 1.0.0

data/lib/adlint/cpp/phase.rb

@@ -0,0 +1,176 @@
+# Analysis phases 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/>.
+#
+#++
+
+require "adlint/phase"
+require "adlint/monitor"
+require "adlint/cpp/lexer"
+require "adlint/cpp/eval"
+require "adlint/cpp/code"
+require "adlint/cpp/message"
+require "adlint/cpp/util"
+
+module AdLint #:nodoc:
+module Cpp #:nodoc:
+
+  class PreparePhase < Phase
+    private
+    def do_execute(context)
+      monitored_region("pr1") do
+        context[:c_source] = PreprocessedSource.new(context[:sources].first)
+
+        context[:cpp_macro_table] = MacroTable.new
+        context[:cpp_interpreter] = Preprocessor.new
+        context[:cpp_visitor] = SyntaxTreeMulticastVisitor.new
+
+        context[:cpp_commands] =
+          setup_code_extractions(context) + setup_message_detections(context)
+      end
+    end
+
+    def setup_code_extractions(context)
+      [
+        ObjectLikeMacroExtraction.new(context),
+        FuncLikeMacroExtraction.new(context),
+        IncludeDirectiveExtraction.new(context),
+        DirectiveExtraction.new(context)
+      ]
+    end
+
+    def setup_message_detections(context)
+      [
+        W0001.new(context),
+        W0025.new(context),
+        W0026.new(context),
+        W0053.new(context),
+        W0054.new(context),
+        W0055.new(context),
+        W0056.new(context),
+        W0057.new(context),
+        W0059.new(context),
+        W0060.new(context),
+        W0061.new(context),
+        W0069.new(context),
+        W0072.new(context),
+        W0073.new(context),
+        W0442.new(context),
+        W0443.new(context),
+        W0444.new(context),
+        W0445.new(context),
+        W0477.new(context),
+        W0478.new(context),
+        W0479.new(context),
+        W0480.new(context),
+        W0481.new(context),
+        W0482.new(context),
+        W0483.new(context),
+        W0511.new(context),
+        W0528.new(context),
+        W0549.new(context),
+        W0554.new(context),
+        W0574.new(context),
+        W0575.new(context),
+        W0576.new(context),
+        W0577.new(context),
+        W0696.new(context),
+        W0804.new(context),
+        W0831.new(context),
+        W9002.new(context)
+      ]
+    end
+  end
+
+  class EvalPhase < Phase
+    private
+    def do_execute(context)
+      monitored_region("cpp") do
+        pp_context = PreprocessContext.new(context)
+        process_cinit_header(context, pp_context)
+        process_pinit_header(context, pp_context)
+        process_target_source(context, pp_context)
+      end
+    end
+
+    def process_cinit_header(context, pp_context)
+      if fpath = Traits.instance.of_compiler.initial_header
+        init_header = Source.new(fpath)
+      else
+        init_header = EmptySource.new
+      end
+      syntax_tree = context[:cpp_interpreter].execute(pp_context, init_header)
+      context[:cpp_syntax_tree] = syntax_tree
+    end
+
+    def process_pinit_header(context, pp_context)
+      if fpath = Traits.instance.of_project.initial_header
+        init_header = Source.new(fpath)
+      else
+        init_header = EmptySource.new
+      end
+      syntax_tree = context[:cpp_interpreter].execute(pp_context, init_header)
+      context[:cpp_syntax_tree].concat(syntax_tree)
+    end
+
+    def process_target_source(context, pp_context)
+      source = context[:sources].first
+      syntax_tree = context[:cpp_interpreter].execute(pp_context, source)
+      context[:cpp_syntax_tree].concat(syntax_tree)
+    end
+  end
+
+  class SubstPhase < Phase
+    private
+    def do_execute(context)
+      monitored_region("sub") do
+        context[:c_source].substitute_code_blocks
+      end
+    end
+  end
+
+  class ReviewPhase < Phase
+    private
+    def do_execute(context)
+      monitored_region("rv1") do
+        context[:cpp_syntax_tree].accept(context[:cpp_visitor])
+      end
+    end
+  end
+
+  class CommandPhase < Phase
+    private
+    def do_execute(context)
+      monitored_region("cm1") do
+        context[:cpp_commands].each { |command| command.execute }
+      end
+    end
+  end
+
+end
+end

data/lib/adlint/cpp/scanner.rb

@@ -0,0 +1,93 @@
+# Scanner 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:
+
+  # == DESCRIPTION
+  # Utility module for scanning the C preprocessor language code.
+  module Scanner
+    # === DESCRIPTION
+    # Scans CPP keyword.
+    #
+    # === PARAMETER
+    # _content_:: StringContent -- Scanning source.
+    #
+    # === RETURN VALUE
+    # String -- Returns CPP keyword string if found at head of the content.
+    def scan_keyword(content)
+      content.scan(/defined\b/)
+    end
+
+    # === DESCRIPTION
+    # Scans CPP punctuator.
+    #
+    # === PARAMETER
+    # _content_:: StringContent -- Scanning source.
+    #
+    # === RETURN VALUE
+    # String -- Returns CPP punctuator string if found at head of the content.
+    def scan_punctuator(content)
+      if punctuator = Language::C.scan_punctuator(content)
+        return punctuator
+      end
+      content.scan(/##?/)
+    end
+
+    # === DESCRIPTION
+    # Scans CPP user header name.
+    #
+    # === PARAMETER
+    # _content_:: StringContent -- Scanning source.
+    #
+    # === RETURN VALUE
+    # String -- Returns CPP user header name string if found at head of the
+    # content.
+    def scan_user_header_name(content)
+      content.scan(/"[^"]*"/)
+    end
+
+    # === DESCRIPTION
+    # Scans CPP system header name.
+    #
+    # === PARAMETER
+    # _content_:: StringContent -- Scanning source.
+    #
+    # === RETURN VALUE
+    # String -- Returns CPP system header name string if found at head of the
+    # content.
+    def scan_system_header_name(content)
+      content.scan(/<[^>]*>/)
+    end
+  end
+
+end
+end

data/lib/adlint/cpp/source.rb

@@ -0,0 +1,169 @@
+# Preprocessed pure C language source.
+#
+# 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"
+require "adlint/util"
+require "adlint/cpp/subst"
+
+module AdLint #:nodoc:
+module Cpp #:nodoc:
+
+  class PreprocessedSource
+    def initialize(root_fpath)
+      @root_fpath = root_fpath
+      @tokens = []
+    end
+
+    extend Pluggable
+
+    def_plugin :on_language_extension
+
+    attr_reader :root_fpath
+
+    def add_token(token)
+      @tokens.push(token)
+    end
+
+    def pp_tokens
+      @tokens.select { |token| token.type == :PP_TOKEN }
+    end
+
+    def substitute_code_blocks
+      substitutions = Traits.instance.of_compiler.extension_substitution
+      substitutions.each do |pattern, replacement|
+        substitution = create_extension_substitution(pattern, replacement)
+        @tokens = substitution.execute(@tokens)
+      end
+
+      substitutions = Traits.instance.of_compiler.arbitrary_substitution
+      substitutions.each do |pattern, replacement|
+        substitution = create_arbitrary_substitution(pattern, replacement)
+        @tokens = substitution.execute(@tokens)
+      end
+      self
+    end
+
+    def to_s
+      @io = StringIO.new
+      @io.set_encoding(Encoding.default_external)
+      @last_fpath = nil
+      @last_line_no = 0
+      @last_column_no = 1
+      @last_token = nil
+      @tokens.each { |token| print(token) }
+      @io.string
+    end
+
+    private
+    def create_extension_substitution(pattern, replacement)
+      CodeSubstitution.new(pattern, replacement).tap do |subst|
+        subst.on_substitution += lambda { |location, matched|
+          on_language_extension.invoke(location, matched)
+        }
+      end
+    end
+
+    def create_arbitrary_substitution(pattern, replacement)
+      CodeSubstitution.new(pattern, replacement)
+    end
+
+    def print(token)
+      return if @last_column_no == 1 && token.type == :NEW_LINE
+
+      if token.location.fpath == @last_fpath
+        if @last_line_no < token.location.line_no
+          if (vspace = token.location.line_no - @last_line_no) > 3
+            insert_line_marker(token)
+          else
+            vspace.times { @io.puts }
+          end
+        end
+        if (hspace = token.location.appearance_column_no - @last_column_no) > 0
+          @io.print(" " * hspace)
+        elsif need_hspace?(token)
+          @io.print(" ")
+        end
+        if token.type == :NEW_LINE
+          @io.puts
+          @last_line_no = token.location.line_no + 1
+          @last_column_no = 1
+        else
+          @io.print(token.value.to_default_external)
+          @last_line_no = token.location.line_no
+          @last_column_no =
+            token.location.appearance_column_no + token.value.length
+        end
+      else
+        insert_line_marker(token)
+        print(token)
+      end
+
+      @last_token = token
+    end
+
+    def need_hspace?(token)
+      return false unless @last_token
+      if keyword_or_identifier?(@last_token.value)
+        !start_with_punctuator?(token.value)
+      else
+        !(end_with_punctuator?(@last_token.value) ||
+          start_with_punctuator?(token.value))
+      end
+    end
+
+    def start_with_punctuator?(str)
+      str !~ /\A[a-z_0-9]/i
+    end
+
+    def end_with_punctuator?(str)
+      str !~ /[a-z_0-9]\z/i
+    end
+
+    def keyword_or_identifier?(str)
+      str =~ /\A[a-z_][a-z_0-9]*\z/i
+    end
+
+    def insert_line_marker(token)
+      if @last_column_no > 1
+        @io.puts
+      end
+      line_marker =
+        "# #{token.location.line_no.to_s.to_default_external} " +
+        "\"#{token.location.fpath.to_s.to_default_external}\""
+      @io.puts(line_marker.to_default_external)
+      @last_fpath = token.location.fpath
+      @last_line_no = token.location.line_no
+      @last_column_no = 1
+    end
+  end
+
+end
+end