adlint 2.6.14 → 3.0.0

data/lib/adlint/code.rb

@@ -1,7 +1,7 @@
 # Code structure information.
 #
 # 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.
 #
@@ -34,15 +34,8 @@ module AdLint #:nodoc:
   # == DESCRIPTION
   # Base class of code structure information.
   class CodeStructure
-    # === DESCRIPTION
-    # Converts this code structure information into array representation.
-    #
-    # Subclasses must implement this method.
-    #
-    # === RETURN VALUE
-    # Array< Object > -- Array representation.
-    def to_a
-      subclass_responsibility
+    def print_as_csv(io)
+      io.puts(to_csv)
     end
 
     # === DESCRIPTION
@@ -55,6 +48,18 @@ module AdLint #:nodoc:
       to_a.map { |obj| obj.to_s.to_default_external }.join(delim)
     end
 
+    private
+    # === DESCRIPTION
+    # Converts this code structure information into array representation.
+    #
+    # Subclasses must implement this method.
+    #
+    # === RETURN VALUE
+    # Array< Object > -- Array representation.
+    def to_a
+      subclass_responsibility
+    end
+
     def to_csv
       to_a.map { |obj| obj ? obj.to_s.to_default_external : nil }.to_csv
     end
@@ -67,25 +72,25 @@ module AdLint #:nodoc:
     # Constructs the type declaration information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the declaration appears.
-    # _typedcl_type_:: String -- Type string of the type declaration.
+    # _loc_:: Location -- Location where the declaration appears.
+    # _dcl_type_:: String -- Type string of the type declaration.
     # _type_name_:: String -- Type name.
     # _type_rep_:: String -- Type representation.
-    def initialize(location, typedcl_type, type_name, type_rep)
-      @location = location
-      @typedcl_type = typedcl_type
+    def initialize(loc, dcl_type, type_name, type_rep)
+      @loc       = loc
+      @dcl_type  = dcl_type
       @type_name = type_name
-      @type_rep = type_rep
+      @type_rep  = type_rep
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DCL", @location.fpath, @location.line_no, @location.column_no, "T",
-        @typedcl_type, @type_name, @type_rep]
+      ["DCL", *@loc.to_a, "T", @dcl_type, @type_name, @type_rep]
     end
   end
 
@@ -96,23 +101,23 @@ module AdLint #:nodoc:
     # Constructs the global variable declaration information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the declaration appears.
-    # _variable_name_:: String -- Global variable name.
+    # _loc_:: Location -- Location where the declaration appears.
+    # _var_name_:: String -- Global variable name.
     # _type_rep_:: String -- Type of the global variable.
-    def initialize(location, variable_name, type_rep)
-      @location = location
-      @variable_name = variable_name
+    def initialize(loc, var_name, type_rep)
+      @loc      = loc
+      @var_name = var_name
       @type_rep = type_rep
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DCL", @location.fpath, @location.line_no, @location.column_no, "V",
-        @variable_name, @type_rep]
+      ["DCL", *@loc.to_a, "V", @var_name, @type_rep]
     end
   end
 
@@ -123,27 +128,27 @@ module AdLint #:nodoc:
     # Constructs the function declaration information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the declaration appears.
-    # _function_linkage_type_:: String -- Functionn linkage type string.
-    # _function_scope_type_:: String -- Declaration scope type string.
-    # _function_identifier_:: String -- Function identifier.
-    def initialize(location, function_linkage_type, function_scope_type,
-                   function_identifier)
-      @location = location
-      @function_linkage_type = function_linkage_type
-      @function_scope_type = function_scope_type
-      @function_identifier = function_identifier
-    end
-
+    # _loc_:: Location -- Location where the declaration appears.
+    # _linkage_:: String -- Function linkage type string.
+    # _scope_type_:: String -- Declaration scope type string.
+    # _dcl_type_:: String -- Declaration type string.
+    # _fun_id_:: FunctionId -- Identifier of the function.
+    def initialize(loc, linkage, scope_type, dcl_type, fun_id)
+      @loc        = loc
+      @linkage    = linkage
+      @scope_type = scope_type
+      @dcl_type   = dcl_type
+      @fun_id     = fun_id
+    end
+
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DCL", @location.fpath, @location.line_no, @location.column_no, "F",
-        @function_linkage_type, @function_scope_type,
-        @function_identifier.name, @function_identifier.signature]
+      ["DCL", *@loc.to_a, "F", @linkage, @scope_type, @dcl_type, *@fun_id.to_a]
     end
   end
 
@@ -154,31 +159,30 @@ module AdLint #:nodoc:
     # Constructs the variable definition information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the definition appears.
-    # _var_linkage_type_:: String -- Variable linkage type string.
-    # _var_scope_type_:: String -- Variable scope type string.
-    # _storage_class_type_:: String -- Variable storage class type.
-    # _variable_name_:: String -- Variable name.
+    # _loc_:: Location -- Location where the definition appears.
+    # _linkage_:: String -- Variable linkage type string.
+    # _scope_type_:: String -- Variable scope type string.
+    # _sc_type_:: String -- Variable storage class type.
+    # _var_name_:: String -- Variable name.
     # _type_rep_:: String -- Variable type representation string.
-    def initialize(location, var_linkage_type, var_scope_type,
-                   storage_class_type, variable_name, type_rep)
-      @location = location
-      @var_linkage_type = var_linkage_type
-      @var_scope_type = var_scope_type
-      @storage_class_type = storage_class_type
-      @variable_name = variable_name
-      @type_rep = type_rep
+    def initialize(loc, linkage, scope_type, sc_type, var_name, type_rep)
+      @loc        = loc
+      @linkage    = linkage
+      @scope_type = scope_type
+      @sc_type    = sc_type
+      @var_name   = var_name
+      @type_rep   = type_rep
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DEF", @location.fpath, @location.line_no, @location.column_no, "V",
-        @var_linkage_type, @var_scope_type, @storage_class_type,
-        @variable_name, @type_rep]
+      ["DEF", *@loc.to_a, "V", @linkage, @scope_type, @sc_type, @var_name,
+        @type_rep]
     end
   end
 
@@ -189,29 +193,27 @@ module AdLint #:nodoc:
     # Constructs the function definition information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the definition appears.
-    # _function_linkage_type_:: String -- Function linkage type string.
-    # _function_scope_type_:: String -- Definition scope type string.
-    # _function_identifier_:: String -- Function identifier.
+    # _loc_:: Location -- Location where the definition appears.
+    # _linkage_:: String -- Function linkage type string.
+    # _scope_type_:: String -- Definition scope type string.
+    # _fun_id_:: FunctionId -- Function identifier.
     # _lines_:: Integer -- Physical lines.
-    def initialize(location, function_linkage_type, function_scope_type,
-                   function_identifier, lines)
-      @location = location
-      @function_linkage_type = function_linkage_type
-      @function_scope_type = function_scope_type
-      @function_identifier = function_identifier
-      @lines = lines
+    def initialize(loc, linkage, scope_type, fun_id, lines)
+      @loc        = loc
+      @linkage    = linkage
+      @scope_type = scope_type
+      @fun_id     = fun_id
+      @lines      = lines
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DEF", @location.fpath, @location.line_no, @location.column_no, "F",
-        @function_linkage_type, @function_scope_type,
-        @function_identifier.name, @function_identifier.signature, @lines]
+      ["DEF", *@loc.to_a, "F", @linkage, @scope_type, *@fun_id.to_a, @lines]
     end
   end
 
@@ -222,23 +224,23 @@ module AdLint #:nodoc:
     # Constructs the macro definition information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the definition appears.
+    # _loc_:: Location -- Location where the definition appears.
     # _macro_name_:: String -- Macro name.
     # _macro_type_:: String -- Macro type string.
-    def initialize(location, macro_name, macro_type)
-      @location = location
+    def initialize(loc, macro_name, macro_type)
+      @loc        = loc
       @macro_name = macro_name
       @macro_type = macro_type
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DEF", @location.fpath, @location.line_no, @location.column_no, "M",
-        @macro_name, @macro_type]
+      ["DEF", *@loc.to_a, "M", @macro_name, @macro_type]
     end
   end
 
@@ -249,21 +251,21 @@ module AdLint #:nodoc:
     # Constructs the label definition information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the definition appears.
+    # _loc_:: Location -- Location where the definition appears.
     # _label_name_:: String -- Label name.
-    def initialize(location, label_name)
-      @location = location
+    def initialize(loc, label_name)
+      @loc        = loc
       @label_name = label_name
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DEF", @location.fpath, @location.line_no, @location.column_no, "L",
-        @label_name]
+      ["DEF", *@loc.to_a, "L", @label_name]
     end
   end
 
@@ -274,23 +276,23 @@ module AdLint #:nodoc:
     # Constructs the initialization information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the variable appears.
-    # _variable_name_:: String -- Initialized variable name.
-    # _initializer_rep_:: String -- Initializer representation.
-    def initialize(location, variable_name, initializer_rep)
-      @location = location
-      @variable_name = variable_name
-      @initializer_rep = initializer_rep
+    # _loc_:: Location -- Location where the variable appears.
+    # _var_name_:: String -- Initialized variable name.
+    # _init_rep_:: String -- Initializer representation.
+    def initialize(loc, var_name, init_rep)
+      @loc      = loc
+      @var_name = var_name
+      @init_rep = init_rep
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["INI", @location.fpath, @location.line_no, @location.column_no,
-        @variable_name, @initializer_rep]
+      ["INI", *@loc.to_a, @var_name, @init_rep]
     end
   end
 
@@ -301,23 +303,23 @@ module AdLint #:nodoc:
     # Constructs the assignment information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the variable appears.
-    # _variable_name_:: String -- Assigned variable name.
-    # _assignment_rep_:: String -- Assignment expression representation.
-    def initialize(location, variable_name, assignment_rep)
-      @location = location
-      @variable_name = variable_name
-      @assignment_rep = assignment_rep
+    # _loc_:: Location -- Location where the variable appears.
+    # _var_name_:: String -- Assigned variable name.
+    # _assign_rep_:: String -- Assignment expression representation.
+    def initialize(loc, var_name, assign_rep)
+      @loc        = loc
+      @var_name   = var_name
+      @assign_rep = assign_rep
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["ASN", @location.fpath, @location.line_no, @location.column_no,
-        @variable_name, @assignment_rep]
+      ["ASN", *@loc.to_a, @var_name, @assign_rep]
     end
   end
 
@@ -328,21 +330,21 @@ module AdLint #:nodoc:
     # Constructs the header include information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the directive appears.
-    # _included_fpath_:: Pathname -- Path name of the included file.
-    def initialize(location, included_fpath)
-      @location = location
-      @included_fpath = included_fpath
+    # _loc_:: Location -- Location where the directive appears.
+    # _fpath_:: Pathname -- Path name of the included file.
+    def initialize(loc, fpath)
+      @loc   = loc
+      @fpath = fpath
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DEP", @location.fpath, @location.line_no, @location.column_no, "I",
-        @included_fpath]
+      ["DEP", *@loc.to_a, "I", @fpath]
     end
   end
 
@@ -353,24 +355,23 @@ module AdLint #:nodoc:
     # Constructs the function call informatin.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the function call appears.
-    # _caller_function_:: FunctionIdentifier -- Calling function identifier.
-    # _callee_function_:: FunctionIdentifier -- Called function identifier.
-    def initialize(location, caller_function, callee_function)
-      @location = location
-      @caller_function = caller_function
-      @callee_function = callee_function
+    # _loc_:: Location -- Location where the function call appears.
+    # _caller_fun_:: FunctionId -- Calling function identifier.
+    # _callee_fun_:: FunctionId -- Called function identifier.
+    def initialize(loc, caller_fun, callee_fun)
+      @loc        = loc
+      @caller_fun = caller_fun
+      @callee_fun = callee_fun
     end
 
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DEP", @location.fpath, @location.line_no, @location.column_no, "C",
-        @caller_function.name, @caller_function.signature,
-        @callee_function.name, @callee_function.signature]
+      ["DEP", *@loc.to_a, "C", *@caller_fun.to_a, *@callee_fun.to_a]
     end
   end
 
@@ -381,27 +382,25 @@ module AdLint #:nodoc:
     # Constructs the cross reference information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the cross-ref appears.
-    # _accessor_function_:: FunctionIdentifier -- Accessing function
-    #                       identifier.
-    # _access_type_:: String -- Access type string.
-    # _accessee_variable_:: String -- Accessed variable name.
-    def initialize(location, accessor_function, access_type, accessee_variable)
-      @location = location
-      @accessor_function = accessor_function
-      @access_type = access_type
-      @accessee_variable = accessee_variable
-    end
-
+    # _loc_:: Location -- Location where the cross-ref appears.
+    # _referrer_:: FunctionId -- Accessing function identifier.
+    # _ref_type_:: String -- Referencing type string.
+    # _var_name_:: String -- Accessed variable name.
+    def initialize(loc, referrer, ref_type, var_name)
+      @loc      = loc
+      @referrer = referrer
+      @ref_type = ref_type
+      @var_name = var_name
+    end
+
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DEP", @location.fpath, @location.line_no, @location.column_no, "X",
-        "V", @accessor_function.name, @accessor_function.signature,
-        @access_type, @accessee_variable]
+      ["DEP", *@loc.to_a, "X", "V", *@referrer.to_a, @ref_type, @var_name]
     end
   end
 
@@ -410,67 +409,67 @@ module AdLint #:nodoc:
     # Constructs the cross reference information.
     #
     # === PARAMETER
-    # _location_:: Location -- Location where the cross-ref appears.
-    # _accessor_function_:: FunctionIdentifier -- Accessing function
-    #                       identifier.
-    # _access_type_:: String -- Access type string.
-    # _accessee_function_:: FunctionIdentifier -- Accessed function identifier.
-    def initialize(location, accessor_function, access_type, accessee_function)
-      @location = location
-      @accessor_function = accessor_function
-      @access_type = access_type
-      @accessee_function = accessee_function
-    end
-
+    # _loc_:: Location -- Location where the cross-ref appears.
+    # _referrer_:: FunctionId -- Accessing function identifier.
+    # _ref_type_:: String -- Referencing type string.
+    # _fun_:: FunctionId -- Accessed function identifier.
+    def initialize(loc, referrer, ref_type, fun)
+      @loc      = loc
+      @referrer = referrer
+      @ref_type = ref_type
+      @fun      = fun
+    end
+
+    private
     # === DESCRIPTION
     # Converts this code structure information into array representation.
     #
     # === RETURN VALUE
     # Array< Object > -- Array representation.
     def to_a
-      ["DEP", @location.fpath, @location.line_no, @location.column_no, "X",
-        "F", @accessor_function.name, @accessor_function.signature,
-        @access_type, @accessee_function.name, @accessee_function.signature]
+      ["DEP", *@loc.to_a, "X", "F", *@referrer.to_a, @ref_type, *@fun.to_a]
     end
   end
 
   class Literal < CodeStructure
-    def initialize(location, literal_type, literal_prefix, literal_suffix,
-                   literal_value)
-      @location = location
-      @literal_type = literal_type
-      @literal_prefix = literal_prefix
-      @literal_suffix = literal_suffix
-      @literal_value = literal_value
+    def initialize(loc, lit_type, prefix, suffix, value)
+      @loc      = loc
+      @lit_type = lit_type
+      @prefix   = prefix
+      @suffix   = suffix
+      @value    = value
     end
 
+    private
     def to_a
-      ["LIT", @location.fpath, @location.line_no, @location.column_no,
-        @literal_type, @literal_prefix, @literal_suffix, @literal_value]
+      ["LIT", *@loc.to_a, @lit_type, @prefix, @suffix, @value]
     end
   end
 
   class PPDirective < CodeStructure
-    def initialize(location, pp_directive, pp_tokens)
-      @location = location
-      @pp_directive = pp_directive
+    def initialize(loc, pp_dire, pp_tokens)
+      @loc       = loc
+      @pp_dire   = pp_dire
       @pp_tokens = pp_tokens
     end
 
+    private
     def to_a
-      ["PRE", @location.fpath, @location.line_no, @location.column_no,
-        @pp_directive, @pp_tokens]
+      ["PRE", *@loc.to_a, @pp_dire, @pp_tokens]
     end
   end
 
-  class FunctionIdentifier
-    def initialize(name, signature)
-      @name = name
-      @signature = signature
+  class FunctionId
+    def initialize(name, sig)
+      @name, @signature = name, sig
     end
 
     attr_reader :name
     attr_reader :signature
+
+    def to_a
+      [@name, @signature]
+    end
   end
 
 end