ridl 2.5.6 → 2.8.1

data/lib/ridl/scanner.rb

@@ -8,7 +8,6 @@
 # included with this program.
 #
 # Copyright (c) Remedy IT Expertise BV
-# Chamber of commerce Rotterdam nr.276339, The Netherlands
 #--------------------------------------------------------------------
 require 'racc/parser'
 require 'delegate'
@@ -44,7 +43,9 @@ module IDL
 
     class In
       def initialize(src, name = '', line = 0, column = 1)
-        @src, @fwd, @bwd = src, src.getc, nil
+        @src = src
+        @fwd = src.getc     # look ahead character
+        @bwd = nil          # look back character
         @pos = Position.new(name, line, column)
         @mark = nil
       end
@@ -72,14 +73,14 @@ module IDL
             @pos.line += 1
             @pos.column = 1
           end
-              else
+        else
           @pos.column += 1
         end
 
         if false
           if not @bwd.nil? or cur.nil? or @fwd.nil?
           printf("%c(%02x), %c(%02x), %c(%02x) @(l:%d,c:%d)\n",
-                @bwd,@bwd,cur,cur,@fwd,@fwd, @pos.line, @pos.column)
+                @bwd, @bwd, cur, cur, @fwd, @fwd, @pos.line, @pos.column)
           end
         end
         @bwd = cur
@@ -97,46 +98,24 @@ module IDL
       end
       alias skipc getc
 
-      def _include?(ch, *chars)
-        chars.each { |v|
-          return true if case v
-            when Array
-              _include?(ch, *v)
-            when Enumerable
-              v.include? ch
-            when Fixnum
-              v == ch
-            when String
-              v == ch
-            else
-              false
-            end
-        }
-        false
-      end
-
       def skipwhile(*chars, &block)
-        if block.nil?
-          block = Proc.new { |ch| _include?(ch, *chars) }
-        end
-
-        until (ch = lookc).nil?
-          break unless block.call(ch)
-          skipc
+        if block
+          until (ch = lookc).nil?
+            return ch unless block.call(ch)
+            skipc
+          end
         end
-        ch
+        nil
       end
 
       def skipuntil(*chars, &block)
-        if block.nil?
-          block = Proc.new { |ch| _include?(ch, *chars) }
-        end
-
-        until (ch = lookc).nil?
-          break if block.call(ch)
-          skipc
+        if block
+          until (ch = lookc).nil?
+            return ch if block.call(ch)
+            skipc
+          end
         end
-        ch
+        nil
       end
 
       def mark(*ini)
@@ -159,6 +138,10 @@ module IDL
         @mark = nil
         ret
       end
+
+      def close
+        @src.close # close input source
+      end
     end ## of class In
 
     class StrIStream
@@ -249,7 +232,7 @@ module IDL
       when File
         i = src
         nm = src.path
-      when IO
+      when IO, StringIO
         i = src
         nm = '<io>'
       else
@@ -261,7 +244,7 @@ module IDL
     end
     def find_include(fname, all = true)
       if File.file?(fname) && File.readable?(fname)
-        fname
+        File.expand_path(fname)
       else
         # search transient include paths if allowed (quoted includes)
         fp = if all then
@@ -298,7 +281,7 @@ module IDL
         end
         @stack << [:include, @prefix, @ifdef, @in, @ifskip]
         # record file dir as new searchpath
-        @xincludepaths << (File.dirname(fpath)+'/')
+        @xincludepaths << (File.dirname(fpath) + '/')
         @prefix = nil
         @ifdef = Array.new
         @in = In.new(File.open(fpath, 'r'), fpath)
@@ -316,13 +299,16 @@ module IDL
       @expansions.include?(define)
     end
     def more_source?
-      @stack.size>0
+      @stack.size > 0
     end
     def in_expansion?
       more_source? and @stack.last[0] == :define
     end
     def leave_source
-      if @stack.size>0
+      # make sure to close the input source
+      @in.close
+      # check if we have any previous source still stacked up
+      if @stack.size > 0
         if @stack.last[0] == :include
           @xincludepaths.pop # remove directory of finished include
           @directiver.leave_include
@@ -338,7 +324,7 @@ module IDL
       @ifdef.empty? || @ifdef.last
     end
     def positions
-      @stack.reverse.inject(@in.nil? ? [] : [@in.position]) {|pos_arr,(_, _, _,in_, _)| pos_arr << in_.position }
+      @stack.reverse.inject(@in.nil? ? [] : [@in.position]) {|pos_arr, (_, _, _, in_, _)| pos_arr << in_.position }
     end
     def parse_error(msg, ex = nil)
       e = IDL::ParseError.new(msg, positions)
@@ -347,7 +333,8 @@ module IDL
     end
 
     LFCR = [ (?\n), (?\r) ]
-    WHITESPACE = [ (?\ ), (?\t) ].concat(LFCR)
+    SPACES = [ (?\ ), (?\t) ]
+    WHITESPACE = SPACES + LFCR
 
     ANNOTATION = ?@
     ANNOTATION_STR = '@'
@@ -361,9 +348,16 @@ module IDL
 
     SHIFTCHARS = [ ?<, ?> ]
 
-    HEXCHARS = [(?0..?9).to_a, (?a..?f).to_a, (?A..?F).to_a].flatten
+    DIGITS = (?0..?9).to_a
+    ALPHA_LC = (?a..?z).to_a
+    ALPHA_UC = (?A..?Z).to_a
+    OCTALS = (?0..?7).to_a
+    HEXCHARS = DIGITS + (?a..?f).to_a + (?A..?F).to_a
+    SIGNS = [?-, ?+]
+    DOT = ?.
 
-    IDCHARS = [?_ , (?a..?z).to_a, (?A..?Z).to_a].flatten
+    IDCHARS = [?_ ] + ALPHA_LC + ALPHA_UC
+    FULL_IDCHARS = IDCHARS + DIGITS
 
     ESCTBL = CharRegistry.new({
       :n => ?\n, :t => ?\t, :v => ?\v, :b => ?\b,
@@ -376,7 +370,7 @@ module IDL
       long manages mirrorport module multiple native Object octet oneway out port porttype primarykey private provides
       public publishes raises readonly setraises sequence short string struct supports switch TRUE truncatable typedef
       typeid typename typeprefix unsigned union uses ValueBase valuetype void wchar wstring
-    ).inject(TokenRegistry.new) { |h,a| h[a.downcase.to_sym] = a; h }
+    ).inject(TokenRegistry.new) { |h, a| h[a.downcase.to_sym] = a; h }
 
     LITERALS = [
       :integer_literal,
@@ -432,8 +426,9 @@ module IDL
       annotation_body = nil
       # next token should be '(' in case of normal/single value annotation
       # or anything else in case of marker annotation
-      token = next_token
-      if token.first == '('
+      skip_spaces # skip till next non-space or eol
+      if peek_next == '('
+        token = next_token # parse '('
         begin
           # identifier or value (in case of single value annotation) expected
           token = next_token
@@ -454,9 +449,9 @@ module IDL
             end
           end
         end until token.first == ')'
-#        token = next_token # need to get next token
-        token = nil
+        token = next_token_before_eol
       else
+        token = next_token_before_eol
         # marker annotation or symbolic value; leave body nil
       end
       [token, annotation_body]
@@ -495,13 +490,18 @@ module IDL
       token
     end
 
+    def peek_next
+      @in.lookc
+    end
+
+    def skip_spaces
+      @in.skipwhile {|c| SPACES.include?(c) }
+    end
+
     def next_identifier(first = nil)
       @in.mark(first)
-      while TRUE
-        case @in.lookc
-        when nil
-          break
-        when ?0..?9, ?a..?z, ?A..?Z, ?_
+      while true
+        if FULL_IDCHARS.include?(@in.lookc)
           @in.skipc
         else
           break
@@ -512,18 +512,13 @@ module IDL
       s2 = s0.dup               # (to be) unescaped id
 
       # simple check
-      escape = false
       if s2.length == 0
         parse_error 'identifier expected!'
       else
-        case s2[0]
-        when ?a..?z, ?A..?Z
-        when ?_   ## if starts with CORBA IDL escape => remove
-          escape = true
-          s2.slice!(0)
-        else
-          parse_error "identifier must begin with alphabet character: #{s2}"
+        if s2[0] == ?_
+          s2.slice!(0) ## if starts with CORBA IDL escape => remove
         end
+        parse_error "identifier must begin with alphabet character: #{s2}" unless ALPHA_LC.include?(s2[0]) || ALPHA_UC.include?(s2[0])
       end
 
       # preprocessor check
@@ -540,9 +535,8 @@ module IDL
           [ :identifier, Identifier.new(s2, s2, s0) ]
         end
       elsif (a = KEYWORDS.assoc(s1)).nil?
-        # check for language mapping keyword except when
-        # - this is an IDL escaped ('_' prefix) identifier
-        [ :identifier, Identifier.new(s2, escape ? s2 : chk_identifier(s2), s0) ]
+        # check for language mapping keyword
+        [ :identifier, Identifier.new(s2, chk_identifier(s2), s0) ]
       elsif s0 == a[1]
         [ a[1], nil ]
       else
@@ -657,26 +651,26 @@ module IDL
     end
 
     def skipfloat_or_fixed
-      if @in.lookc == ?.
+      if @in.lookc == DOT
         @in.skipc
-        @in.skipwhile(?0..?9)
+        @in.skipwhile {|c| DIGITS.include?(c) }
       end
       if [?e, ?E].include? @in.lookc
         @in.skipc
-        @in.skipc if [?+, ?-].include? @in.lookc
-        @in.skipwhile(?0..?9)
+        @in.skipc if SIGNS.include? @in.lookc
+        @in.skipwhile {|c| DIGITS.include?(c) }
         return :floating_pt_literal
       elsif [?d, ?D].include? @in.lookc
         @in.skipc
-        @in.skipc if [?+, ?-].include? @in.lookc
-        @in.skipwhile(?0..?9)
+        @in.skipc if SIGNS.include? @in.lookc
+        @in.skipwhile {|c| DIGITS.include?(c) }
         return :fixed_pt_literal
       end
       :floating_pt_literal
     end
 
     def skipline
-      while TRUE
+      while true
         s = @in.gets
         until s.chomp!.nil?; end
         break unless s[s.length - 1] == ?\\
@@ -685,13 +679,13 @@ module IDL
 
     def getline
       s = ''
-      while TRUE
+      while true
         ch = @in.lookc
         break if ch.nil?
         case
         when (ch == ?\") #"
           s << @in.getc # opening quote
-          while TRUE
+          while true
             if @in.lookc == ?\\
               # escape sequence
               s << @in.getc
@@ -766,7 +760,7 @@ module IDL
 
     def resolve_define(id, stack = [])
       return id if %w(true false).include?(id)
-      IDL.log(3,"*** RIDL - resolve_define(#{id})")
+      IDL.log(3, "*** RIDL - resolve_define(#{id})")
       if @defined.has_key?(id)
         define_ = @defined[id]
         stack << id
@@ -779,7 +773,7 @@ module IDL
     end
 
     def eval_directive(s)
-      IDL.log(2,"** RIDL - eval_directive(#{s})")
+      IDL.log(3, "** RIDL - eval_directive(#{s})")
       rc = eval(s)
       case rc
       when FalseClass, TrueClass
@@ -792,10 +786,10 @@ module IDL
     end
 
     def parse_directive
-      @in.skipwhile(?\ , ?\t)
+      @in.skipwhile {|c| SPACES.include?(c) }
       s = getline
       /^(\w*)\s*/ === s
-      s1,s2 = $1, $' #'
+      s1, s2 = $1, $' #'
 
       if /(else|endif|elif)/ === s1
 
@@ -828,7 +822,7 @@ module IDL
             else
               while s2 =~ /(^|[\W])defined\s*\(\s*(\w+)\s*\)/
                  def_id = $2
-                 s2.gsub!(/(^|[\W])(defined\s*\(\s*\w+\s*\))/, '\1'+"#{@defined.has_key?(def_id).to_s}")
+                 s2.gsub!(/(^|[\W])(defined\s*\(\s*\w+\s*\))/, '\1' + "#{@defined.has_key?(def_id).to_s}")
               end
               s2.gsub!(/(^|[\W])([A-Za-z_][\w]*)/) do |_| "#{$1}#{resolve_define($2)}" end
               begin
@@ -860,10 +854,10 @@ module IDL
           if do_parse?
             # match 'defined(Foo)' or 'defined Foo'
             while s2 =~ /(^|[\W])defined(\s*\(\s*(\w+)\s*\)|\s+(\w+))/
-              IDL.log(2,"** RIDL - parse_directive : resolving 'defined(#{$3 || $4})'")
+              IDL.log(3, "** RIDL - parse_directive : resolving 'defined(#{$3 || $4})'")
               def_id = $3 || $4
               # resolve 'defined' expression to 'true' or 'false' according to actual macro definition
-              s2.gsub!(/(^|[\W])(defined\s*[\s\(]\s*#{def_id}(\s*\))?)/, '\1'+"#{@defined.has_key?(def_id).to_s}")
+              s2.gsub!(/(^|[\W])(defined\s*[\s\(]\s*#{def_id}(\s*\))?)/, '\1' + "#{@defined.has_key?(def_id).to_s}")
             end
             # match and resolve any macro variables listed in conditional expression
             s2.gsub!(/(^|[\W])([A-Za-z_][\w]*)/) do |_| "#{$1}#{resolve_define($2)}" end
@@ -903,11 +897,11 @@ module IDL
           @defined.delete(s2)
 
         when 'include'
-          if s2[0,1] == '"' || s2[0,1] == '<'
-            quoted_inc = (s2[0,1] == '"')
-            if s2.size>2
+          if s2[0, 1] == '"' || s2[0, 1] == '<'
+            quoted_inc = (s2[0, 1] == '"')
+            if s2.size > 2
               s2.strip!
-              s2 = s2.slice(1..(s2.size-2))
+              s2 = s2.slice(1..(s2.size - 2))
             else
               s2 = ''
             end
@@ -936,25 +930,30 @@ module IDL
       end
     end
 
+    def next_token_before_eol
+      @in.skipwhile {|c| SPACES.include?(c)}
+      LFCR.include?(@in.lookc) ? nil : next_token
+    end
+
     def next_token
       sign = nil
       str = '' #initialize empty string
-      while TRUE
+      while true
         ch = @in.getc
         if ch.nil?
-          if @ifdef.size>0 and !in_expansion?
+          if @ifdef.size > 0 and !in_expansion?
             parse_error 'mismatched #if/#endif'
           end
           if more_source?
             leave_source
             next
           else
-            return [FALSE, nil]
+            return [false, nil]
           end
         end
 
         if WHITESPACE.include? ch
-          @in.skipwhile( WHITESPACE )
+          @in.skipwhile {|c| WHITESPACE.include?(c) }
           next
         end
 
@@ -1017,7 +1016,7 @@ module IDL
             ret = []
             chs = ''
             @in.skipc # skip 'L'
-            while TRUE
+            while true
               _nxtc = @in.lookc
               if _nxtc == ?\\
                 @in.skipc
@@ -1067,7 +1066,7 @@ module IDL
                 # return token returned by parse_annotation or parse next token recursively
                 return parse_annotation(true) || next_token
               else
-                @in.skipuntil(?\n, ?\r)
+                @in.skipuntil {|c| LFCR.include?(c) }
               end
             end
             str = '' # reset
@@ -1077,9 +1076,9 @@ module IDL
             return %w(/ /)
           end
 
-        when ch == ?+ || ch == ?-
+        when SIGNS.include?(ch)
           _nxtc = @in.lookc
-          if (?0..?9).include? _nxtc
+          if DIGITS.include? _nxtc
             sign = ch
             str = '' # reset
             next
@@ -1089,7 +1088,7 @@ module IDL
 
         when (?1..?9).include?(ch)
           @in.mark(sign, ch)
-          @in.skipwhile(?0..?9)
+          @in.skipwhile {|c| DIGITS.include?(c) }
           num_type = ([?., ?e, ?E, ?d, ?D].include?(@in.lookc)) ? skipfloat_or_fixed : :integer_literal
 
           r = @in.getregion
@@ -1102,10 +1101,10 @@ module IDL
             return [:integer_literal, r.to_i]
           end
 
-        when ch == ?. #
+        when ch == DOT #
           @in.mark(ch)
-          @in.skipwhile(?0..?9)
-          num_type = (?. != @in.lookc) ? skipfloat_or_fixed : nil
+          @in.skipwhile {|c| DIGITS.include?(c) }
+          num_type = (DOT != @in.lookc) ? skipfloat_or_fixed : nil
           s = @in.getregion
           if s == '.'
             parse_error 'token consisting of single dot (.) is invalid.'
@@ -1128,11 +1127,11 @@ module IDL
             s = @in.getregion
             return [:integer_literal, s.hex]
           else
-            dec = FALSE
-            @in.skipwhile(?0..?7)
+            dec = false
+            @in.skipwhile {|c| OCTALS.include?(c) }
             if (?8..?9).include? @in.lookc
               dec = TRUE
-              @in.skipwhile(?0..?9)
+              @in.skipwhile {|c| DIGITS.include?(c) }
             end
 
             num_type = ([?., ?e, ?E, ?d, ?D].include?(@in.lookc)) ? skipfloat_or_fixed : :integer_literal
@@ -1170,7 +1169,7 @@ module IDL
 
         when ch == ?\" #" #double quote, for a string literal.
           ret = ''
-          while TRUE
+          while true
             _nxtc = @in.lookc
             if _nxtc == ?\\
               @in.skipc