adlint 2.6.14 → 3.0.0

data/lib/adlint/cpp/phase.rb

@@ -1,7 +1,7 @@
 # Analysis phases 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.
 #
@@ -30,6 +30,7 @@
 #++
 
 require "adlint/phase"
+require "adlint/annot"
 require "adlint/cpp/lexer"
 require "adlint/cpp/eval"
 require "adlint/cpp/util"
@@ -38,28 +39,46 @@ module AdLint #:nodoc:
 module Cpp #:nodoc:
 
   class CppPhase < Phase
-    def initialize(context, phase_name)
-      super(context, "cpp", phase_name)
+    def initialize(phase_ctxt, phase_name)
+      super(phase_ctxt, "cpp", phase_name)
     end
   end
 
   class Prepare1Phase < CppPhase
-    def initialize(context)
-      super(context, "pr1")
+    def initialize(phase_ctxt)
+      super(phase_ctxt, "pr1")
     end
 
     private
-    def do_execute(context, *)
-      context[:c_source] = PreprocessedSource.new(context[:sources].first)
-      context[:cpp_macro_table] = MacroTable.new
-      context[:cpp_interpreter] = Preprocessor.new
-      context[:cpp_visitor] = SyntaxTreeMulticastVisitor.new
+    def do_execute(phase_ctxt, *)
+      root_src = phase_ctxt[:sources].first
+      phase_ctxt[:cc1_source]      = PreprocessedSource.new(root_src)
+      phase_ctxt[:cpp_macro_table] = MacroTable.new
+      phase_ctxt[:cpp_interpreter] = Preprocessor.new
+      phase_ctxt[:cpp_visitor]     = SyntaxTreeMulticastVisitor.new
+      register_annotation_parser
+    end
+
+    def register_annotation_parser
+      parser = method(:parse_annotation)
+      @phase_ctxt[:cpp_interpreter].on_line_comment_found  += parser
+      @phase_ctxt[:cpp_interpreter].on_block_comment_found += parser
+    end
+
+    def parse_annotation(comment, loc)
+      if annot = Annotation.parse(comment, loc)
+        @phase_ctxt[:annotations].push(annot)
+        if annot.message_suppression_specifier? &&
+            traits.of_message.individual_suppression
+          @phase_ctxt[:suppressors].add(annot.create_suppressor)
+        end
+      end
     end
   end
 
   class Prepare2Phase < CppPhase
-    def initialize(context)
-      super(context, "pr2")
+    def initialize(phase_ctxt)
+      super(phase_ctxt, "pr2")
     end
 
     private
@@ -67,74 +86,76 @@ module Cpp #:nodoc:
   end
 
   class EvalPhase < CppPhase
-    def initialize(context)
-      super(context, "cpp")
+    def initialize(phase_ctxt)
+      super(phase_ctxt, "cpp")
     end
 
     private
-    def do_execute(context, *)
-      pp_context = PreprocessContext.new(context)
-      process_cinit_header(context, pp_context)
-      process_pinit_header(context, pp_context)
-      process_target_source(context, pp_context)
+    def do_execute(phase_ctxt, *)
+      pp_ctxt = PreprocessContext.new(phase_ctxt)
+      process_cinit_header(phase_ctxt, pp_ctxt)
+      process_pinit_header(phase_ctxt, pp_ctxt)
+      process_target_source(phase_ctxt, pp_ctxt)
     end
 
-    def process_cinit_header(context, pp_context)
-      if fpath = Traits.instance.of_compiler.initial_header
-        init_header = Source.new(fpath)
+    def process_cinit_header(phase_ctxt, pp_ctxt)
+      if fpath = traits.of_compiler.initial_header
+        fenc = traits.of_project.file_encoding
+        init_header = Source.new(Pathname.new(fpath), fenc)
       else
         init_header = EmptySource.new
       end
-      syntax_tree = context[:cpp_interpreter].execute(pp_context, init_header)
-      context[:cpp_syntax_tree] = syntax_tree
+      phase_ctxt[:cpp_syntax_tree] =
+        phase_ctxt[:cpp_interpreter].execute(pp_ctxt, init_header)
     end
 
-    def process_pinit_header(context, pp_context)
-      if fpath = Traits.instance.of_project.initial_header
-        init_header = Source.new(fpath)
+    def process_pinit_header(phase_ctxt, pp_ctxt)
+      if fpath = traits.of_project.initial_header
+        fenc = traits.of_project.file_encoding
+        init_header = Source.new(Pathname.new(fpath), fenc)
       else
         init_header = EmptySource.new
       end
-      syntax_tree = context[:cpp_interpreter].execute(pp_context, init_header)
-      context[:cpp_syntax_tree].concat(syntax_tree)
+      phase_ctxt[:cpp_syntax_tree].concat(
+        phase_ctxt[:cpp_interpreter].execute(pp_ctxt, init_header))
     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)
+    def process_target_source(phase_ctxt, pp_ctxt)
+      root_src = phase_ctxt[:sources].first
+      phase_ctxt[:cpp_syntax_tree].concat(
+        phase_ctxt[:cpp_interpreter].execute(pp_ctxt, root_src))
     end
   end
 
   class SubstPhase < CppPhase
-    def initialize(context)
-      super(context, "sub")
+    def initialize(phase_ctxt)
+      super(phase_ctxt, "sub")
     end
 
     private
-    def do_execute(context, *)
-      context[:c_source].substitute_code_blocks
+    def do_execute(phase_ctxt, *)
+      phase_ctxt[:cc1_source].substitute_code_blocks(traits)
     end
   end
 
   class ReviewPhase < CppPhase
-    def initialize(context)
-      super(context, "rv1")
+    def initialize(phase_ctxt)
+      super(phase_ctxt, "rv1")
     end
 
     private
-    def do_execute(context, *)
-      context[:cpp_syntax_tree].accept(context[:cpp_visitor])
+    def do_execute(phase_ctxt, *)
+      phase_ctxt[:cpp_syntax_tree].accept(phase_ctxt[:cpp_visitor])
     end
   end
 
   class ExaminationPhase < CppPhase
-    def initialize(context)
-      super(context, "ex1")
+    def initialize(phase_ctxt)
+      super(phase_ctxt, "ex1")
     end
 
     private
-    def do_execute(context, *)
+    def do_execute(phase_ctxt, *)
       examinations.each { |exam| exam.execute }
     end
   end

data/lib/adlint/cpp/scanner.rb

@@ -1,7 +1,7 @@
 # Scanner 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.
 #
@@ -39,53 +39,50 @@ module Cpp #:nodoc:
     # Scans CPP keyword.
     #
     # === PARAMETER
-    # _content_:: StringContent -- Scanning source.
+    # _cont_:: 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/)
+    def scan_keyword(cont)
+      cont.scan(/defined\b/)
     end
 
     # === DESCRIPTION
     # Scans CPP punctuator.
     #
     # === PARAMETER
-    # _content_:: StringContent -- Scanning source.
+    # _cont_:: 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(/##?/)
+    def scan_punctuator(cont)
+      Language::C.scan_punctuator(cont) or cont.scan(/##?/)
     end
 
     # === DESCRIPTION
     # Scans CPP user header name.
     #
     # === PARAMETER
-    # _content_:: StringContent -- Scanning source.
+    # _cont_:: 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(/"[^"]*"/)
+    def scan_user_header_name(cont)
+      cont.scan(/"[^"]*"/)
     end
 
     # === DESCRIPTION
     # Scans CPP system header name.
     #
     # === PARAMETER
-    # _content_:: StringContent -- Scanning source.
+    # _cont_:: 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(/<[^>]*>/)
+    def scan_system_header_name(cont)
+      cont.scan(/<[^>]*>/)
     end
   end
 

data/lib/adlint/cpp/source.rb

@@ -1,7 +1,7 @@
 # Preprocessed pure C language source.
 #
 # 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.
 #
@@ -29,7 +29,6 @@
 #
 #++
 
-require "adlint/token"
 require "adlint/util"
 require "adlint/cpp/asm"
 require "adlint/cpp/subst"
@@ -52,99 +51,95 @@ module Cpp #:nodoc:
 
     attr_reader :root_fpath
 
-    def add_token(token)
-      @tokens.push(token)
+    def add_token(tok)
+      @tokens.push(tok)
     end
 
     def pp_tokens
-      @tokens.select { |token| token.type == :PP_TOKEN }
+      @tokens.select { |tok| tok.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)
+    def substitute_code_blocks(traits)
+      traits.of_compiler.extension_substitutions.each do |ptn, repl|
+        @tokens = create_extension_substitution(ptn, repl).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)
+      traits.of_compiler.arbitrary_substitutions.each do |ptn, repl|
+        @tokens = create_arbitrary_substitution(ptn, repl).execute(@tokens)
       end
 
-      create_inline_assembly_substitutions(self).each do |substitution|
-        @tokens = substitution.execute(@tokens)
+      create_inline_assembly_substitutions(self).each do |sub|
+        @tokens = sub.execute(@tokens)
       end
 
       self
     end
 
     def to_s
+      @last_fpath     = nil
+      @last_line_no   = 0
+      @last_column_no = 1
+      @last_token     = nil
       @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) }
+      @tokens.each { |tok| print(tok) }
       @io.string
     end
 
     private
-    def create_extension_substitution(pattern, replacement)
-      CodeSubstitution.new(pattern, replacement).tap do |subst|
-        subst.on_substitution += lambda { |matched_tokens|
-          on_language_extension.invoke(matched_tokens)
+    def create_extension_substitution(ptn, repl)
+      CodeSubstitution.new(ptn, repl).tap do |sub|
+        sub.on_substitution += lambda { |matched_toks|
+          on_language_extension.invoke(matched_toks)
         }
       end
     end
 
-    def create_arbitrary_substitution(pattern, replacement)
-      CodeSubstitution.new(pattern, replacement)
+    def create_arbitrary_substitution(ptn, repl)
+      CodeSubstitution.new(ptn, repl)
     end
 
-    def print(token)
-      return if @last_column_no == 1 && token.type == :NEW_LINE
+    def print(tok)
+      return if @last_column_no == 1 && tok.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)
+      if tok.location.fpath == @last_fpath
+        if @last_line_no < tok.location.line_no
+          if (vsp = tok.location.line_no - @last_line_no) > 3
+            insert_line_marker(tok)
           else
-            vspace.times { @io.puts }
+            vsp.times { @io.puts }
           end
         end
-        if (hspace = token.location.appearance_column_no - @last_column_no) > 0
-          @io.print(" " * hspace)
-        elsif need_hspace?(token)
+        if (hsp = tok.location.appearance_column_no - @last_column_no) > 0
+          @io.print(" " * hsp)
+        elsif need_hspace?(tok)
           @io.print(" ")
         end
-        if token.type == :NEW_LINE
+        if tok.type == :NEW_LINE
           @io.puts
-          @last_line_no = token.location.line_no + 1
+          @last_line_no = tok.location.line_no + 1
           @last_column_no = 1
         else
-          @io.print(token.value.to_default_external)
-          @last_line_no = token.location.line_no
+          @io.print(tok.value.to_default_external)
+          @last_line_no = tok.location.line_no
           @last_column_no =
-            token.location.appearance_column_no + token.value.length
+            tok.location.appearance_column_no + tok.value.length
         end
       else
-        insert_line_marker(token)
-        print(token)
+        insert_line_marker(tok)
+        print(tok)
       end
 
-      @last_token = token
+      @last_token = tok
     end
 
-    def need_hspace?(token)
+    def need_hspace?(tok)
       return false unless @last_token
       if keyword_or_identifier?(@last_token.value)
-        !start_with_punctuator?(token.value)
+        !start_with_punctuator?(tok.value)
       else
         !(end_with_punctuator?(@last_token.value) ||
-          start_with_punctuator?(token.value))
+          start_with_punctuator?(tok.value))
       end
     end
 
@@ -160,16 +155,15 @@ module Cpp #:nodoc:
       str =~ /\A[a-z_][a-z_0-9]*\z/i
     end
 
-    def insert_line_marker(token)
+    def insert_line_marker(tok)
       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}\""
+      line_marker = "# #{tok.location.line_no.to_s.to_default_external} " +
+                    "\"#{tok.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_fpath     = tok.location.fpath
+      @last_line_no   = tok.location.line_no
       @last_column_no = 1
     end
   end