adlint 1.0.0

data/lib/adlint/lexer.rb

@@ -0,0 +1,293 @@
+# Lexical analyzer base 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"
+require "adlint/source"
+require "adlint/traits"
+require "adlint/error"
+require "adlint/util"
+
+module AdLint #:nodoc:
+
+  # == DESCRIPTION
+  # Token queue to interface to the parser.
+  class TokenQueue < Array
+    # === DESCRIPTION
+    # Constructs an empty token queue or a solid token queue from specified
+    # token array.
+    #
+    # === PARAMETER
+    # _token_array_:: TokenArray -- Array of tokens.
+    def initialize(token_array = nil)
+      if token_array
+        super
+      else
+        super()
+      end
+    end
+
+    def expect(token_type)
+      token = self.first
+      token && token.type == token_type ? true : false
+    end
+  end
+
+  # == DESCRIPTION
+  # Object represents the whole content of something.
+  class Content
+    def location
+      subclass_responsibility
+    end
+
+    def empty?
+      subclass_responsibility
+    end
+  end
+
+  # == DESCRIPTION
+  # Object represents the whole content of the string.
+  class StringContent < Content
+    include CodingStyleAccessor
+    extend Memoizable
+
+    # === DESCRIPTION
+    # Constructs the content object of the string.
+    #
+    # === PARAMETER
+    # _str_:: String -- Target string.
+    # _fpath_:: Pathname -- File path name contains the target string.
+    # _line_no_:: Integer -- Initial line-no of the target string.
+    def initialize(str, fpath = nil, line_no = 1, column_no = 1)
+      @scanner = StringScanner.new(str)
+      @fpath = fpath
+      @line_no = line_no
+      @column_no = column_no
+      @appearance_column_no = column_no
+    end
+
+    def location
+      Location.new(@fpath, @line_no, @column_no, @appearance_column_no)
+    end
+    memoize :location
+
+    # === DESCRIPTION
+    # Scans a token.
+    #
+    # === PARAMETER
+    # _regexp_:: Regexp -- Token pattern.
+    #
+    # === RETURN VALUE
+    # String -- Token string or nil.
+    def scan(regexp)
+      token = @scanner.scan(regexp)
+      if token
+        update_location(token)
+        token
+      else
+        nil
+      end
+    end
+
+    def check(regexp)
+      @scanner.check(regexp)
+    end
+
+    # === DESCRIPTION
+    # Skips a content.
+    #
+    # === PARAMETER
+    # _length_:: Integer -- Skipping content length.
+    #
+    # === RETURN VALUE
+    # String -- Eaten string.
+    def eat!(length = 1)
+      scan(/.{#{length}}/m)
+    end
+
+    # === DESCRIPTION
+    # Checks whether this content is currently empty or not.
+    #
+    # === RETURN VALUE
+    # Boolean -- Returns true if already empty.
+    def empty?
+      @scanner.eos?
+    end
+
+    private
+    def update_location(token)
+      if (nl_count = token.count("\n")) > 0
+        @line_no += nl_count
+        last_line = token[token.rindex("\n")..-1]
+        @column_no = last_line.length
+        @appearance_column_no = last_line.gsub(/\t/, " " * tab_width).length
+      else
+        @column_no += token.length
+        @appearance_column_no += token.gsub(/\t/, " " * tab_width).length
+      end
+      forget_location_memo
+    end
+  end
+
+  # == DESCRIPTION
+  # Object represents the whole content of the source file.
+  class SourceContent < StringContent
+    # === DESCRIPTION
+    # Constructs the content object of the source file.
+    #
+    # === PARAMETER
+    # _source_:: Source -- Target source object.
+    def initialize(source)
+      super(source.open { |io| io.read }, source.fpath)
+    end
+  end
+
+  class TokensContent < Content
+    def initialize(token_array)
+      @token_array = token_array
+    end
+
+    def location
+      empty? ? nil : @token_array.first.location
+    end
+
+    def empty?
+      @token_array.empty?
+    end
+
+    def next_token
+      empty? ? nil : @token_array.shift
+    end
+  end
+
+  # == DESCRIPTION
+  # Generic lexical analysis context.
+  class LexerContext
+    # === DESCRIPTION
+    # Constructs a lexical analysis context object.
+    #
+    # === PARAMETER
+    # _content_:: SourceContent | StringContent -- Target content.
+    def initialize(content)
+      @content = content
+    end
+
+    # === VALUE
+    # SourceContent | StringContent -- The target content of this context.
+    attr_reader :content
+
+    # === DESCRIPTION
+    # Reads the current location of the target content.
+    #
+    # === RETURN VALUE
+    # Location -- Current location.
+    def location
+      @content.location
+    end
+  end
+
+  # == DESCRIPTION
+  # Base class of the lexical analyzer of the string.
+  class StringLexer
+    # === DESCRIPTION
+    # Constructs a lexical analyzer of the string.
+    #
+    # === PARAMETER
+    # _str_:: String -- Target string.
+    def initialize(str)
+      @str = str
+    end
+
+    # === DESCRIPTION
+    # Executes the lexical analysis.
+    #
+    # === RETURN VALUE
+    # TokenArray -- Scanned tokens.
+    def execute
+      context = create_context(@str)
+      tokenize(context)
+    rescue Error
+      raise
+    rescue => ex
+      if context
+        raise InternalError.new(ex, context.location)
+      else
+        raise InternalError.new(ex, nil)
+      end
+    end
+
+    private
+    # === DESCRIPTION
+    # Creates the context object.
+    #
+    # Subclasses must implement this method.
+    #
+    # === PARAMETER
+    # _str_:: String -- Target string object.
+    def create_context(str)
+      subclass_responsibility
+    end
+
+    # === DESCRIPTION
+    # Tokenize the target content.
+    #
+    # Subclasses must implement this method.
+    #
+    # === PARAMETER
+    # _context_:: LexerContext -- Lexical analysis context.
+    def tokenize(context)
+      subclass_responsibility
+    end
+  end
+
+  class TokensRelexer
+    def initialize(token_array)
+      @context = create_context(token_array)
+    end
+
+    def next_token
+      tokenize(@context)
+    rescue Error
+      raise
+    rescue => ex
+      raise InternalError.new(ex, @context.location)
+    end
+
+    private
+    def create_context(token_array)
+      subclass_responsibility
+    end
+
+    def tokenize(context)
+      subclass_responsibility
+    end
+  end
+
+end

data/lib/adlint/message.rb

@@ -0,0 +1,368 @@
+# Base classes of the warning and the error messages.
+#
+# 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/traits"
+require "adlint/token"
+require "adlint/error"
+require "adlint/version"
+
+module AdLint #:nodoc:
+
+  # == DESCRIPTION
+  # Base class of all messages.
+  class Message
+    # === DESCRIPTION
+    # Creates a fatal error message from exception object.
+    #
+    # === PARAMETER
+    # _exception_:: Exception -- Cause exception.
+    def self.from_exception(exception)
+      FatalErrorMessage.new(exception)
+    end
+
+    # === DESCRIPTION
+    # Constructs a message.
+    #
+    # === PARAMETER
+    # _id_:: Symbol -- Message ID symbol.
+    # _location_:: Location -- Location where the message detected.
+    # _parts_:: Array< Object > -- Message formatting parts.
+    def initialize(id, location, *parts)
+      @id, @location = id, location
+      @parts = parts
+      validate_id(@id, @location)
+    end
+
+    attr_reader :id
+
+    # === DESCRIPTION
+    # Reads the type of this message.
+    #
+    # Subclasses must implement this method.
+    #
+    # === RETURN VALUE
+    # Symbol -- Message type symbol.
+    def type
+      subclass_responsibility
+    end
+
+    # === DESCRIPTION
+    # Reads the type string of this message.
+    #
+    # Subclasses must implement this method.
+    #
+    # === RETURN VALUE
+    # String -- Message type string.
+    def type_str
+      subclass_responsibility
+    end
+
+    # === DESCRIPTION
+    # Converts this message into an array of message elements.
+    #
+    # === RETURN VALUE
+    # Array< Object > -- Array of message elements.
+    def to_a
+      if templ = MessageCatalog.instance[@id]
+        begin
+          mesg = templ.to_default_external %
+            @parts.map { |obj| obj.to_s.to_default_external }
+          [type.to_s, @location.fpath, @location.line_no, @location.column_no,
+            @id, mesg]
+        rescue
+          raise InvalidMessageFormatError.new(@id, @location)
+        end
+      else
+        raise InvalidMessageIdError.new(@id, @location)
+      end
+    end
+
+    # === DESCRIPTION
+    # Converts this message into a string for human readable output.
+    #
+    # === RETURN VALUE
+    # String -- String representation of this message.
+    def to_s
+      @location.to_s.to_default_external +
+        ":#{type_str.to_default_external}:%5$s:%6$s".to_default_external %
+          to_a.map { |obj| obj.to_s.to_default_external }
+    end
+
+    def to_csv
+      to_a.map { |obj| obj ? obj.to_s.to_default_external : nil }.to_csv
+    end
+
+    def eql?(rhs)
+      @id == rhs.id && @location == rhs.location && @parts == rhs.parts
+    end
+
+    def hash
+      [@id, @location, @parts].hash
+    end
+
+    protected
+    attr_reader :location
+    attr_reader :parts
+
+    private
+    # === DESCRIPTION
+    # Validates the message ID.
+    #
+    # === PARAMETER
+    # _id_:: String -- Message ID string.
+    # _location_:: Location -- Location where the message detected.
+    #
+    # === RETURN VALUE
+    # None.
+    def validate_id(id, location)
+      MessageCatalog.instance[id] or
+        raise InvalidMessageIdError.new(id, location)
+      nil
+    end
+  end
+
+  # == DESCRIPTION
+  # Syntactical error message.
+  class ErrorMessage < Message
+    # === DESCRIPTION
+    # Reads the type of this message.
+    #
+    # === RETURN VALUE
+    # Symbol -- Message type symbol.
+    def type
+      :E
+    end
+
+    # === DESCRIPTION
+    # Reads the type string of this message.
+    #
+    # === RETURN VALUE
+    # String -- Message type string.
+    def type_str
+      "error"
+    end
+  end
+
+  # == DESCRIPTION
+  # AdLint specific internal fatal error message.
+  class FatalErrorMessage < Message
+    # === DESCRIPTION
+    # Constructs a AdLint specific internal fatal error message.
+    #
+    # === PARAMETER
+    # _exception_:: Exception -- Cause exception.
+    def initialize(exception)
+      super(exception.id,
+            exception.location ? exception.location : Location.new,
+            *exception.parts)
+      @exception = exception
+    end
+
+    # === DESCRIPTION
+    # Reads the type of this message.
+    #
+    # === RETURN VALUE
+    # Symbol -- Message type symbol.
+    def type
+      :X
+    end
+
+    # === DESCRIPTION
+    # Reads the type string of this message.
+    #
+    # === RETURN VALUE
+    # String -- Message type string.
+    def type_str
+      "fatal error"
+    end
+  end
+
+  # == DESCRIPTION
+  # Semantical warning message.
+  class WarningMessage < Message
+    # === DESCRIPTION
+    # Reads the type of this message.
+    #
+    # === RETURN VALUE
+    # Symbol -- Message type symbol.
+    def type
+      :W
+    end
+
+    # === DESCRIPTION
+    # Reads the type string of this message.
+    #
+    # === RETURN VALUE
+    # String -- Message type string.
+    def type_str
+      "warning"
+    end
+  end
+
+  # == DESCRIPTION
+  # Message complements other messages.
+  class ContextMessage < Message
+    # === DESCRIPTION
+    # Reads the type of this message.
+    #
+    # === RETURN VALUE
+    # Symbol -- Message type symbol.
+    def type
+      :C
+    end
+
+    # === DESCRIPTION
+    # Reads the type string of this message.
+    #
+    # === RETURN VALUE
+    # String -- Message type string.
+    def type_str
+      "context"
+    end
+  end
+
+  # == DESCRIPTION
+  # Message catalog entry.
+  class MessageTemplate < String; end
+
+  # == DESCRIPTION
+  # Message catalog.
+  class MessageCatalog < Hash
+    include Singleton
+
+    DEFAULT_DNAME = Pathname.new("mesg.d")
+    private_constant :DEFAULT_DNAME
+
+    DEFAULT_FNAME = Pathname.new("messages.yml")
+    private_constant :DEFAULT_FNAME
+
+    def load(fpath = nil)
+      unless fpath
+        mesg_dpath = DEFAULT_DNAME.expand_path($etcdir)
+        lang_dpath = Pathname.new(Traits.instance.of_message.language)
+        fpath = mesg_dpath.join(lang_dpath).join(DEFAULT_FNAME)
+      end
+      File.open(fpath, "r:utf-8") { |io| read_from(io) }
+    end
+
+    # === DESCRIPTION
+    # Loads message templates from the message definition file.
+    #
+    # === PARAMETER
+    # _io_:: IO -- I/O object for the message definition file.
+    #
+    # === RETURN VALUE
+    # MessageCatalog -- Self.
+    def read_from(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
+      version = doc["version"]
+      validate_version(version)
+      if message_definition = doc["message_definition"]
+        message_definition.each do |id, text|
+          if changed = Traits.instance.of_message.change_list[id.intern]
+            self[id.intern] = MessageTemplate.new(changed)
+          else
+            self[id.intern] = MessageTemplate.new(text)
+          end
+        end
+      else
+        raise "invalid form of the message definition file."
+      end
+      self
+    end
+
+    private
+    # === DESCRIPTION
+    # Validates the version of the message definition file.
+    #
+    # === RETURN VALUE
+    # None.
+    def validate_version(version)
+      version =~ SCHEMA_VERSION_RE or
+        raise "invalid version of the message definition file."
+      nil
+    end
+  end
+
+  # == DESCRIPTION
+  # Base of message detection classes.
+  class MessageDetection
+    # === DESCRIPTION
+    # Constructs a message detecting object.
+    #
+    # === PARAMETER
+    # _context_:: PhaseContext -- Analysis context.
+    def initialize(context)
+      @context = context
+    end
+
+    # === DESCRIPTION
+    # Executes a message detecting.
+    def execute
+      do_prepare(@context)
+      do_execute(@context)
+    end
+
+    private
+    # === DESCRIPTION
+    # Initializes a message.
+    #
+    # Subclasses must implement this method.
+    def do_prepare(context)
+      subclass_responsibility
+    end
+
+    # === DESCRIPTION
+    # Detects a message.
+    #
+    # Subclasses must implement this method.
+    def do_execute(context)
+      subclass_responsibility
+    end
+
+    def report
+      @context.report
+    end
+  end
+
+  class PassiveMessageDetection < MessageDetection
+    private
+    def do_prepare(context) end
+    def do_execute(context) end
+  end
+
+end