adlint 2.6.14 → 3.0.0

data/lib/adlint/traits.rb

@@ -1,7 +1,7 @@
 # AdLint analysis project configuration.
 #
 # 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,7 +30,6 @@
 #++
 
 require "adlint/version"
-require "adlint/exam"
 require "adlint/util"
 
 module AdLint #:nodoc:
@@ -38,30 +37,31 @@ module AdLint #:nodoc:
   # == DESCRIPTION
   # Analysis configuration information.
   class Traits
-    include Singleton
     include Validation
 
-    # === DESCRIPTION
-    # Constructs an empty configuration information.
-    def initialize
-      @exam_packages = nil
-      @project_traits = nil
-      @compiler_traits = nil
-      @linker_traits = nil
-      @message_traits = nil
-    end
+    def initialize(traits_fpath)
+      File.open(traits_fpath, "r:utf-8") do |io|
+        case ary_or_stream = YAML.load_stream(io)
+        when Array
+          # NOTE: YAML.load_stream returns Array in Ruby 1.9.3-preview1.
+          doc = ary_or_stream.first
+        when YAML::Stream
+          doc = ary_or_stream.documents.first
+        end
+        validate_version(doc["version"])
 
-    attr_reader :exam_packages
+        @exam_packages = (doc["exam_packages"] || []).uniq.map { |name|
+          ExaminationPackage.new(name)
+        }.freeze
 
-    def name
-      ""
+        @project_traits  = ProjectTraits.new(doc["project_traits"]).freeze
+        @compiler_traits = CompilerTraits.new(doc["compiler_traits"]).freeze
+        @linker_traits   = LinkerTraits.new(doc["linker_traits"]).freeze
+        @message_traits  = MessageTraits.new(doc["message_traits"]).freeze
+      end
     end
 
-    ensure_exam_packages_presence_of :exam_packages
-    ensure_validity_of :project_traits
-    ensure_validity_of :compiler_traits
-    ensure_validity_of :linker_traits
-    ensure_validity_of :message_traits
+    attr_reader :exam_packages
 
     def of_project
       @project_traits
@@ -79,32 +79,20 @@ module AdLint #:nodoc:
       @message_traits
     end
 
-    def read_from(traits_fpath)
-      File.open(traits_fpath, "r:utf-8") do |io|
-        case array_or_stream = YAML.load_stream(io)
-        when Array
-          # NOTE: YAML.load_stream returns Array in Ruby 1.9.3-preview1.
-          doc = array_or_stream.first
-        when YAML::Stream
-          doc = array_or_stream.documents.first
-        end
-        validate_version(doc["version"])
-
-        @exam_packages = (doc["exam_packages"] || []).uniq.map { |name|
-          ExaminationPackage.new(name)
-        }.freeze
-
-        @project_traits = ProjectTraits.new(doc["project_traits"]).freeze
-        @compiler_traits = CompilerTraits.new(doc["compiler_traits"]).freeze
-        @linker_traits = LinkerTraits.new(doc["linker_traits"]).freeze
-        @message_traits = MessageTraits.new(doc["message_traits"]).freeze
-      end
+    def entity_name
+      ""
     end
 
+    ensure_exam_packages_presence_of :exam_packages
+    ensure_validity_of :project_traits
+    ensure_validity_of :compiler_traits
+    ensure_validity_of :linker_traits
+    ensure_validity_of :message_traits
+
     private
-    def validate_version(version)
-      version == TRAITS_SCHEMA_VERSION or
-        raise "invalid version of the trailts file.\n" +
+    def validate_version(ver)
+      ver == TRAITS_SCHEMA_VERSION or
+        raise "invalid version of the traits file.\n" +
               "regenerate or migrate traits file by new `adlintize' command."
     end
   end
@@ -114,15 +102,16 @@ module AdLint #:nodoc:
     include CompoundPathParser
 
     def initialize(doc)
-      @project_name = doc["project_name"]
-      @project_root = Pathname.new(doc["project_root"])
-      @include_path = parse_compound_path_list(doc["include_path"])
-      @initial_header = doc["initial_header"]
-      @coding_style = CodingStyle.new(doc["coding_style"])
-      @file_encoding = doc["file_encoding"]
+      @project_name      = doc["project_name"]
+      @project_root      = Pathname.new(doc["project_root"])
+      @target_files      = TargetFiles.new(doc["target_files"])
+      @initial_header    = doc["initial_header"]
+      @file_search_paths = parse_compound_path_list(doc["file_search_paths"])
+      @coding_style      = CodingStyle.new(doc["coding_style"])
+      @file_encoding     = doc["file_encoding"]
     end
 
-    def name
+    def entity_name
       "project_traits"
     end
 
@@ -132,12 +121,15 @@ module AdLint #:nodoc:
     attr_reader :project_root
     ensure_dir_presence_of :project_root
 
-    attr_reader :include_path
-    ensure_dirs_presence_of :include_path
+    attr_reader :target_files
+    ensure_validity_of :target_files
 
     attr_reader :initial_header
     ensure_file_presence_of :initial_header, :allow_nil => true
 
+    attr_reader :file_search_paths
+    ensure_dirs_presence_of :file_search_paths
+
     attr_reader :coding_style
     ensure_validity_of :coding_style
 
@@ -145,20 +137,46 @@ module AdLint #:nodoc:
     ensure_with :file_encoding, :message => "is not a valid encoding name.",
                 :validator => Encoding.method(:include_name?)
 
+    class TargetFiles
+      include Validation
+      include CompoundPathParser
+
+      def initialize(doc)
+        @inclusion_paths = parse_compound_path_list(doc["inclusion_paths"])
+        @exclusion_paths = parse_compound_path_list(doc["exclusion_paths"])
+      end
+
+      def entity_name
+        "project_traits:target_files"
+      end
+
+      attr_reader :inclusion_paths
+      ensure_dirs_presence_of :inclusion_paths
+
+      attr_reader :exclusion_paths
+      ensure_dirs_presence_of :exclusion_paths
+
+      def freeze
+        @inclusion_paths.freeze
+        @exclusion_paths.freeze
+        super
+      end
+    end
+
     class CodingStyle
       include Validation
 
-      K_AND_R = "K&R".freeze
-      ALLMAN = "Allman".freeze
-      GNU = "GNU".freeze
+      K_AND_R = "K&R"
+      ALLMAN  = "Allman"
+      GNU     = "GNU"
 
       def initialize(doc)
         @indent_style = doc["indent_style"]
-        @tab_width = doc["tab_width"]
+        @tab_width    = doc["tab_width"]
         @indent_width = doc["indent_width"]
       end
 
-      def name
+      def entity_name
         "project_traits:coding_style"
       end
 
@@ -181,8 +199,8 @@ module AdLint #:nodoc:
 
     def freeze
       @project_name.freeze
-      @include_path.freeze
-      @initial_header.freeze
+      @target_files.freeze
+      @file_search_paths.freeze
       @coding_style.freeze
       @file_encoding.freeze
       super
@@ -196,33 +214,34 @@ module AdLint #:nodoc:
     include CompoundPathParser
 
     def initialize(doc)
-      @standard_type = StandardType.new(doc["standard_type"])
-      @include_path = parse_compound_path_list(doc["include_path"])
-      @initial_header = doc["initial_header"]
-      @arithmetic = Arithmetic.new(doc["arithmetic"])
-      @extension_substitution = doc["extension_substitution"] || {}
-      @arbitrary_substitution = doc["arbitrary_substitution"] || {}
-      @identifier_max = doc["identifier_max"]
+      @initial_header    = doc["initial_header"]
+      @file_search_paths = parse_compound_path_list(doc["file_search_paths"])
+      @standard_types    = StandardTypes.new(doc["standard_types"])
+      @arithmetic        = Arithmetic.new(doc["arithmetic"])
+      @identifier_max    = doc["identifier_max"]
+
+      @extension_substitutions = doc["extension_substitutions"] || {}
+      @arbitrary_substitutions = doc["arbitrary_substitutions"] || {}
     end
 
-    def name
+    def entity_name
       "compiler_traits"
     end
 
     # === VALUE
-    # CompilerTraits::StandardType -- The standard type traits information.
-    attr_reader :standard_type
-    ensure_validity_of :standard_type
+    # String -- The file path of the initial source.
+    attr_reader :initial_header
+    ensure_file_presence_of :initial_header, :allow_nil => true
 
     # === VALUE
     # Array< String > -- System include paths.
-    attr_reader :include_path
-    ensure_dirs_presence_of :include_path
+    attr_reader :file_search_paths
+    ensure_dirs_presence_of :file_search_paths
 
     # === VALUE
-    # String -- The file path of the initial source.
-    attr_reader :initial_header
-    ensure_file_presence_of :initial_header, :allow_nil => true
+    # CompilerTraits::StandardTypes -- The standard type traits information.
+    attr_reader :standard_types
+    ensure_validity_of :standard_types
 
     # === VALUE
     # CompilerTraits::Arithmetic -- The arithmetic traits information.
@@ -230,60 +249,52 @@ module AdLint #:nodoc:
     ensure_validity_of :arithmetic
 
     # === VALUE
-    # Hash<String, String > -- The compiler-extension code substitution
-    # setting.
-    attr_reader :extension_substitution
+    # Integer -- Max length of all symbols identified by the compiler.
+    attr_reader :identifier_max
+    ensure_numericality_of :identifier_max, :only_integer => true, :min => 1
 
     # === VALUE
-    # Hash<String, String > -- The arbitrary code substitution setting.
-    attr_reader :arbitrary_substitution
+    # Hash<String, String > -- The compiler-extension code substitution
+    # settings.
+    attr_reader :extension_substitutions
 
     # === VALUE
-    # Integer -- Max length of all symbols identified by the compiler.
-    attr_reader :identifier_max
-    ensure_numericality_of :identifier_max, :only_integer => true, :min => 1
+    # Hash<String, String > -- The arbitrary code substitution settings.
+    attr_reader :arbitrary_substitutions
 
     # == DESCRIPTION
     # Traits information of standard types.
-    class StandardType
+    class StandardTypes
       include Validation
 
       def initialize(doc)
-        @char_size = doc["char_size"]
-        @char_alignment = doc["char_alignment"]
-
-        @short_size = doc["short_size"]
-        @short_alignment = doc["short_alignment"]
-
-        @int_size = doc["int_size"]
-        @int_alignment = doc["int_alignment"]
-
-        @long_size = doc["long_size"]
-        @long_alignment = doc["long_alignment"]
-
-        @long_long_size = doc["long_long_size"]
-        @long_long_alignment = doc["long_long_alignment"]
-
-        @float_size = doc["float_size"]
-        @float_alignment = doc["float_alignment"]
-
-        @double_size = doc["double_size"]
-        @double_alignment = doc["double_alignment"]
-
-        @long_double_size = doc["long_double_size"]
+        @char_size             = doc["char_size"]
+        @char_alignment        = doc["char_alignment"]
+        @short_size            = doc["short_size"]
+        @short_alignment       = doc["short_alignment"]
+        @int_size              = doc["int_size"]
+        @int_alignment         = doc["int_alignment"]
+        @long_size             = doc["long_size"]
+        @long_alignment        = doc["long_alignment"]
+        @long_long_size        = doc["long_long_size"]
+        @long_long_alignment   = doc["long_long_alignment"]
+        @float_size            = doc["float_size"]
+        @float_alignment       = doc["float_alignment"]
+        @double_size           = doc["double_size"]
+        @double_alignment      = doc["double_alignment"]
+        @long_double_size      = doc["long_double_size"]
         @long_double_alignment = doc["long_double_alignment"]
 
-        @code_ptr_size = doc["code_ptr_size"]
-        @code_ptr_alignment = doc["code_ptr_alignment"]
-
-        @data_ptr_size = doc["data_ptr_size"]
-        @data_ptr_alignment = doc["data_ptr_alignment"]
+        @code_ptr_size         = doc["code_ptr_size"]
+        @code_ptr_alignment    = doc["code_ptr_alignment"]
+        @data_ptr_size         = doc["data_ptr_size"]
+        @data_ptr_alignment    = doc["data_ptr_alignment"]
 
         @char_as_unsigned_char = doc["char_as_unsigned_char"]
       end
 
-      def name
-        "compiler_traits:standard_type"
+      def entity_name
+        "compiler_traits:standard_types"
       end
 
       # === VALUE
@@ -407,7 +418,7 @@ module AdLint #:nodoc:
         super
       end
     end
-    private_constant :StandardType
+    private_constant :StandardTypes
 
     # == DESCRIPTION
     # Traits information of arithmetic process.
@@ -418,7 +429,7 @@ module AdLint #:nodoc:
         @logical_right_shift = doc["logical_right_shift"]
       end
 
-      def name
+      def entity_name
         "compiler_traits:arithmetic"
       end
 
@@ -436,13 +447,12 @@ module AdLint #:nodoc:
     private_constant :Arithmetic
 
     def freeze
-      @standard_type.freeze
-      @include_path.freeze
-      @initial_header.freeze
+      @file_search_paths.freeze
+      @standard_types.freeze
       @arithmetic.freeze
-      @extension_substitution.freeze
-      @arbitrary_substitution.freeze
       @identifier_max.freeze
+      @extension_substitutions.freeze
+      @arbitrary_substitutions.freeze
       super
     end
   end
@@ -453,11 +463,11 @@ module AdLint #:nodoc:
     include Validation
 
     def initialize(doc)
-      @identifier_max = doc["identifier_max"]
+      @identifier_max         = doc["identifier_max"]
       @identifier_ignore_case = doc["identifier_ignore_case"]
     end
 
-    def name
+    def entity_name
       "linker_traits"
     end
 
@@ -484,37 +494,26 @@ module AdLint #:nodoc:
     include CompoundPathParser
 
     def initialize(doc)
-      @language = doc["language"]
-      @message_with_class = doc["message_with_class"]
-      @warn_files_in = parse_compound_path_list(doc["warn_files_in"])
-      @warn_files_not_in = parse_compound_path_list(doc["warn_files_not_in"])
-      @individual_selection = doc["individual_selection"]
-      @exclusion = Exclusion.new(doc["exclusion"])
-      @inclusion = Inclusion.new(doc["inclusion"])
+      @language               = doc["language"]
+      @individual_suppression = doc["individual_suppression"]
+      @exclusion              = Exclusion.new(doc["exclusion"])
+      @inclusion              = Inclusion.new(doc["inclusion"])
+
       @change_list =
-        (doc["change_list"] || []).each_with_object({}) { |(id, content), hash|
-          hash[[content["package"], id.intern]] = content
+        (doc["change_list"] || []).each_with_object({}) { |(name, cont), hash|
+          hash[MessageId.new(cont["package"], name.to_sym)] = cont
         }
     end
 
-    def name
+    def entity_name
       "message_traits"
     end
 
     attr_reader :language
     ensure_inclusion_of :language, :values => %w(ja_JP en_US)
 
-    attr_reader :message_with_class
-    ensure_true_or_false_of :message_with_class
-
-    attr_reader :warn_files_in
-    ensure_dirs_presence_of :warn_files_in
-
-    attr_reader :warn_files_not_in
-    ensure_dirs_presence_of :warn_files_not_in
-
-    attr_reader :individual_selection
-    ensure_true_or_false_of :individual_selection
+    attr_reader :individual_suppression
+    ensure_true_or_false_of :individual_suppression
 
     attr_reader :exclusion
     ensure_validity_of :exclusion
@@ -530,26 +529,25 @@ module AdLint #:nodoc:
       def initialize(doc)
         if doc
           @categories = doc["categories"] || []
-          @severities = Regexp.new(doc["severities"]) || //
-          str_str_hash = doc["messages"] || {}
-          @messages = str_str_hash.map { |id, package|
-            [package, id.intern]
+          @severities = doc["severities"] ? Regexp.new(doc["severities"]) : nil
+          @messages   = (doc["messages"] || {}).map { |msg_name, pkg_name|
+            MessageId.new(pkg_name, msg_name.to_sym)
           }.to_set
         else
           @categories = []
-          @severities = //
-          @messages = Set.new
+          @severities = nil
+          @messages   = Set.new
         end
       end
 
+      def entity_name
+        "message_traits:exclusion"
+      end
+
       attr_reader :categories
       attr_reader :severities
       attr_reader :messages
 
-      def name
-        "message_traits:exclusion"
-      end
-
       def freeze
         @categories.freeze
         @severities.freeze
@@ -564,21 +562,20 @@ module AdLint #:nodoc:
 
       def initialize(doc)
         if doc
-          str_str_hash = doc["messages"] || {}
-          @messages = str_str_hash.map { |id, package|
-            [package, id.intern]
+          @messages = (doc["messages"] || {}).map { |msg_name, pkg_name|
+            MessageId.new(pkg_name, msg_name.to_sym)
           }.to_set
         else
           @messages = Set.new
         end
       end
 
-      attr_reader :messages
-
-      def name
+      def entity_name
         "message_traits:inclusion"
       end
 
+      attr_reader :messages
+
       def freeze
         @messages.freeze
         super
@@ -588,10 +585,7 @@ module AdLint #:nodoc:
 
     def freeze
       @language.freeze
-      @message_with_class.freeze
-      @warn_files_in.freeze
-      @warn_files_not_in.freeze
-      @individual_selection.freeze
+      @individual_suppression.freeze
       @exclusion.freeze
       @inclusion.freeze
       @change_list.freeze
@@ -599,142 +593,164 @@ module AdLint #:nodoc:
     end
   end
 
-  module StandardTypeAccessor
-    def standard_type
-      Traits.instance.of_compiler.standard_type
+  module CodingStyleAccessor
+    # NOTE: Host class must respond to #traits.
+
+    def coding_style
+      traits.of_project.coding_style
+    end
+
+    def indent_style
+      coding_style.indent_style
+    end
+
+    def tab_width
+      coding_style.tab_width
+    end
+
+    def indent_width
+      coding_style.indent_width
+    end
+
+    INDENT_STYLE_K_AND_R = ProjectTraits::CodingStyle::K_AND_R
+    INDENT_STYLE_ALLMAN  = ProjectTraits::CodingStyle::ALLMAN
+    INDENT_STYLE_GNU     = ProjectTraits::CodingStyle::GNU
+  end
+
+  module StandardTypesAccessor
+    # NOTE: Host class must respond to #traits.
+
+    def standard_types
+      traits.of_compiler.standard_types
     end
-    module_function :standard_type
 
     def char_size
-      standard_type.char_size
+      standard_types.char_size
     end
-    module_function :char_size
 
     def char_alignment
-      standard_type.char_alignment
+      standard_types.char_alignment
     end
-    module_function :char_alignment
 
     def short_size
-      standard_type.short_size
+      standard_types.short_size
     end
-    module_function :short_size
 
     def short_alignment
-      standard_type.short_alignment
+      standard_types.short_alignment
     end
-    module_function :short_alignment
 
     def int_size
-      standard_type.int_size
+      standard_types.int_size
     end
-    module_function :int_size
 
     def int_alignment
-      standard_type.int_alignment
+      standard_types.int_alignment
     end
-    module_function :int_alignment
 
     def long_size
-      standard_type.long_size
+      standard_types.long_size
     end
-    module_function :long_size
 
     def long_alignment
-      standard_type.long_alignment
+      standard_types.long_alignment
     end
-    module_function :long_alignment
 
     def long_long_size
-      standard_type.long_long_size
+      standard_types.long_long_size
     end
-    module_function :long_long_size
 
     def long_long_alignment
-      standard_type.long_long_alignment
+      standard_types.long_long_alignment
     end
-    module_function :long_long_alignment
 
     def float_size
-      standard_type.float_size
+      standard_types.float_size
     end
-    module_function :float_size
 
     def float_alignment
-      standard_type.float_alignment
+      standard_types.float_alignment
     end
-    module_function :float_alignment
 
     def double_size
-      standard_type.double_size
+      standard_types.double_size
     end
-    module_function :double_size
 
     def double_alignment
-      standard_type.double_alignment
+      standard_types.double_alignment
     end
-    module_function :double_alignment
 
     def long_double_size
-      standard_type.long_double_size
+      standard_types.long_double_size
     end
-    module_function :long_double_size
 
     def long_double_alignment
-      standard_type.long_double_alignment
+      standard_types.long_double_alignment
     end
-    module_function :long_double_alignment
 
     def code_ptr_size
-      standard_type.code_ptr_size
+      standard_types.code_ptr_size
     end
-    module_function :code_ptr_size
 
     def code_ptr_alignment
-      standard_type.code_ptr_alignment
+      standard_types.code_ptr_alignment
     end
-    module_function :code_ptr_alignment
 
     def data_ptr_size
-      standard_type.data_ptr_size
+      standard_types.data_ptr_size
     end
-    module_function :data_ptr_size
 
     def data_ptr_alignment
-      standard_type.data_ptr_alignment
+      standard_types.data_ptr_alignment
     end
-    module_function :data_ptr_alignment
 
     def char_as_unsigned_char?
-      standard_type.char_as_unsigned_char
+      standard_types.char_as_unsigned_char
     end
-    module_function :char_as_unsigned_char?
   end
 
-  module CodingStyleAccessor
-    def coding_style
-      Traits.instance.of_project.coding_style
+  module ArithmeticAccessor
+    # NOTE: Host class must respond to #traits.
+
+    def arithmetic
+      traits.of_compiler.arithmetic
     end
-    module_function :coding_style
 
-    def indent_style
-      coding_style.indent_style
+    def logical_right_shift?
+      arithmetic.logical_right_shift
     end
-    module_function :indent_style
+  end
 
-    def tab_width
-      coding_style.tab_width
+  module ExclusionAccessor
+    # NOTE: Host class must respond to #traits.
+
+    def exclusion
+      traits.of_message.exclusion
     end
-    module_function :tab_width
 
-    def indent_width
-      coding_style.indent_width
+    def categories
+      exclusion.categories
     end
-    module_function :indent_width
 
-    INDENT_STYLE_K_AND_R = ProjectTraits::CodingStyle::K_AND_R
-    INDENT_STYLE_ALLMAN = ProjectTraits::CodingStyle::ALLMAN
-    INDENT_STYLE_GNU = ProjectTraits::CodingStyle::GNU
+    def severities
+      exclusion.severities
+    end
+
+    def messages
+      exclusion.messages
+    end
+  end
+
+  module InclusionAccessor
+    # NOTE: Host class must respond to #traits.
+
+    def inclusion
+      traits.of_message.inclusion
+    end
+
+    def messages
+      inclusion.messages
+    end
   end
 
 end