rley 0.3.04 → 0.3.05

data/lib/rley/gfg/grm_flow_graph.rb

@@ -11,17 +11,17 @@ module Rley # This module is used as a namespace
   module GFG # This module is used as a namespace
     # TODO: add definition
     class GrmFlowGraph
-        # The set of all vertices in the graph
-        attr_reader :vertices
+      # The set of all vertices in the graph
+      attr_reader :vertices
 
-        # The vertex marked as start node of the graph
-        attr_reader :start_vertex
+      # The vertex marked as start node of the graph
+      attr_reader :start_vertex
 
-        # A Hash with pairs of the form: non-terminal symbol => start node
-        attr_reader :start_vertex_for
+      # A Hash with pairs of the form: non-terminal symbol => start node
+      attr_reader :start_vertex_for
 
-        # A Hash with pairs of the form: non-terminal symbol => end node
-        attr_reader :end_vertex_for
+      # A Hash with pairs of the form: non-terminal symbol => end node
+      attr_reader :end_vertex_for
 
       def initialize(theDottedItems)
         @vertices = []
@@ -30,15 +30,16 @@ module Rley # This module is used as a namespace
 
         build_graph(theDottedItems)
       end
-      
+
       # Return the vertex with given vertex label.
       def find_vertex(aVertexLabel)
         vertices.find { |a_vertex| a_vertex.label == aVertexLabel }
       end
 
-private
+      private
+
       def add_vertex(aVertex)
-        fail StandardError, 'GFG vertex cannot be nil' if aVertex.nil?
+        raise StandardError, 'GFG vertex cannot be nil' if aVertex.nil?
 
         # TODO: make setting of start vertex more robust
         @start_vertex = aVertex if vertices.empty?
@@ -48,19 +49,16 @@ private
       def build_graph(theDottedItems)
         build_all_starts_ends(theDottedItems)
 
-        curr_production = nil
+        curr_prod = nil
         theDottedItems.each_with_index do |d_item, index_item|
-          if curr_production.nil? || curr_production != d_item.production
-            # Another production found...
-            curr_production = d_item.production
-            lhs = curr_production.lhs
-            # build_start_end_for(lhs) #Build start/end vertex per non-terminal
-            if curr_production.empty?
-              add_single_item(d_item)
-            else
-              # Add vertices and edges for dotted items of production
-              augment_graph(theDottedItems, index_item)
-            end
+          next unless curr_prod.nil? || curr_prod != d_item.production
+          # Another production found...
+          curr_prod = d_item.production
+          if curr_prod.empty?
+            add_single_item(d_item)
+          else
+            # Add vertices and edges for dotted items of production
+            augment_graph(theDottedItems, index_item)
           end
         end
       end
@@ -77,15 +75,15 @@ private
       #   add a start vertex labelled .N
       #   add an end vertex labelled N.
       def build_start_end_for(aNonTerminal)
-        unless start_vertex_for.include?(aNonTerminal)
-          new_start_vertex = StartVertex.new(aNonTerminal)
-          start_vertex_for[aNonTerminal] = new_start_vertex
-          add_vertex(new_start_vertex)
-
-          new_end_vertex = EndVertex.new(aNonTerminal)
-          end_vertex_for[aNonTerminal] = new_end_vertex
-          add_vertex(new_end_vertex)
-        end
+        return if start_vertex_for.include?(aNonTerminal)
+
+        new_start_vertex = StartVertex.new(aNonTerminal)
+        start_vertex_for[aNonTerminal] = new_start_vertex
+        add_vertex(new_start_vertex)
+
+        new_end_vertex = EndVertex.new(aNonTerminal)
+        end_vertex_for[aNonTerminal] = new_end_vertex
+        add_vertex(new_end_vertex)
       end
 
 
@@ -99,7 +97,8 @@ private
       # Add vertices and edges for dotted items derived from same production
       # production of the form: N => α[1] ... α[n] (non-empty rhs):
       # # Rule 3
-      # create n+1 nodes labelled:  N => . α[1] ... α[n], N => α[1] . ... α[n], ..., N => α[1] ... α[n] .
+      # create n+1 nodes labelled:
+      #   N => . α[1] ... α[n], N => α[1] . ... α[n], ..., N => α[1] ... α[n] .
       # add an epsilon entry edge: .N -> N => . α[1] ... α[n]
       # add an epsilon exit edge: N => α[1] ... α[n] . -> N.
       # For each symbol in rhs:
@@ -110,14 +109,15 @@ private
       #     Rule 5
       #     add a call edge: N => α[1] .A  α[n] -> .A
       #     add a return edge: A. -> N => α[1] A.  α[n]
-      #     add a shortcut edge: ( N => α[1] .A  α[n] ) -> ( N => α[1] A.  α[n] )
+      #     add a shortcut edge:
+      # ( N => α[1] .A  α[n] ) -> ( N => α[1] A.  α[n] )
       def augment_graph(theDottedItems, firstItemPos)
         production = theDottedItems[firstItemPos].production
         max_index = production.rhs.size + 1
         prev_vertex = nil
-        
+
         (0...max_index).each do |index|
-          current_item = theDottedItems[firstItemPos+index]
+          current_item = theDottedItems[firstItemPos + index]
           new_vertex = ItemVertex.new(current_item)
           add_vertex(new_vertex)
           build_exit_edge(new_vertex) if current_item.reduce_item? # At end?
@@ -134,7 +134,7 @@ private
               build_call_return_edges(vertices[-2], new_vertex)
             end
           end
-          
+
           prev_symbol = current_item.prev_symbol
           if prev_symbol && prev_symbol.kind_of?(Syntax::NonTerminal)
             build_shortcut_edge(prev_vertex, new_vertex)
@@ -181,7 +181,7 @@ private
         # Create an edge end vertex -> return vertex
         ReturnEdge.new(end_vertex, return_vertex)
       end
-      
+
       def build_shortcut_edge(fromVertex, toVertex)
         ShortcutEdge.new(fromVertex, toVertex)
       end
@@ -189,4 +189,4 @@ private
   end # module
 end # module
 
-# End of file
+# End of file

data/lib/rley/gfg/item_vertex.rb

@@ -10,39 +10,39 @@ module Rley # This module is used as a namespace
     # Responsibilities (in addition to inherited ones):
     # - Know its related non-terminal symbol
     class ItemVertex < Vertex
-        # Link to the dotted item object
-        attr_reader :dotted_item
+      # Link to the dotted item object
+      attr_reader :dotted_item
 
-        # Optional link to a "shortcut" edge.
-        # Applicable only if the dotted expects a non-terminal symbol.
-        attr_reader :shortcut
+      # Optional link to a "shortcut" edge.
+      # Applicable only if the dotted expects a non-terminal symbol.
+      attr_reader :shortcut
 
       def initialize(aDottedItem)
         super()
         @dotted_item = aDottedItem
       end
-      
+
       # Set the "shortcut" edge.
       def shortcut=(aShortcut)
         unless aShortcut.kind_of?(ShortcutEdge)
-          fail StandardError, 'Invalid shortcut argument'
+          raise StandardError, 'Invalid shortcut argument'
         end
 =begin
         unless next_symbol && next_symbol.kind_of?(Syntax::NonTerminal)
-          fail StandardError, 'Invalid shortcut usage'
+          raise StandardError, 'Invalid shortcut usage'
         end
-        
+
         shortcut_d_item = aShortcut.successor.dotted_item
         unless (dotted_item.production == shortcut_d_item.production) &&
           (dotted_item.position == shortcut_d_item.prev_position)
-          fail StandardError, 'Shortcut refers to wrong vertex'
+          raise StandardError, 'Shortcut refers to wrong vertex'
         end
-=end        
+=end
         @shortcut = aShortcut
       end
 
       def label()
-        return "#{dotted_item}"
+        return dotted_item.to_s
       end
 
       # Returns true if the dotted item has a dot at the end of the production.
@@ -53,20 +53,19 @@ module Rley # This module is used as a namespace
       # Return the symbol before the dot else nil.
       def prev_symbol()
         return dotted_item.prev_symbol
-      end      
-      
+      end
+
       # Return the symbol after the dot else nil.
       def next_symbol()
         return dotted_item.next_symbol
       end
-      
+
       # Return the non-terminal symbol at the left-hand side of the production
       def lhs()
         return dotted_item.lhs
       end
-
     end # class
   end # module
 end # module
 
-# End of file
+# End of file

data/lib/rley/gfg/non_terminal_vertex.rb

@@ -8,23 +8,22 @@ module Rley # This module is used as a namespace
     # Responsibilities (in addition to inherited ones):
     # - Know its related non-terminal symbol
     class NonTerminalVertex < Vertex
-        attr_reader :non_terminal
+      attr_reader :non_terminal
       
       def initialize(aNonTerminal)
         super()
         @non_terminal = aNonTerminal
       end
       
-protected
+      protected
 
       # Validation method for adding an outgoing edge to the vertex.
       # A start vertex may accept an indegree and outdegree greater than one
       def check_add_edge(anEdge)
         return anEdge
       end      
-
     end # class
   end # module
 end # module
 
-# End of file
+# End of file

data/lib/rley/gfg/return_edge.rb

@@ -1,31 +1,32 @@
-require_relative 'edge'
-
-module Rley # This module is used as a namespace
-  module GFG # This module is used as a namespace
-    # Specialization of an edge in a grammar flow graph
-    # that has a end vertex (X.) as its head
-    # and an item vertex as its tail
-    
-    # Responsibilities:
-    # - To know the successor vertex (tail)
-    class ReturnEdge < Edge
-      attr_reader(:key)
-    
-      # Pre-condition: thePredecessor is an EndVertex
-      # Pre-condition: theSuccessor is an ItemVertex
-      def initialize(thePredecessor, theSuccessor)
-        super(thePredecessor, theSuccessor)
-        do_set_key(thePredecessor, theSuccessor)
-      end
-      
-private
-      def do_set_key(thePredecessor, theSuccessor)
-        tail_d_item = theSuccessor.dotted_item
-        @key = "RET_#{tail_d_item.production.object_id}_#{tail_d_item.prev_position}"
-      end
-
-    end # class
-  end # module
-end # module
-
-# End of file
+require_relative 'edge'
+
+module Rley # This module is used as a namespace
+  module GFG # This module is used as a namespace
+    # Specialization of an edge in a grammar flow graph
+    # that has a end vertex (X.) as its head
+    # and an item vertex as its tail
+
+    # Responsibilities:
+    # - To know the successor vertex (tail)
+    class ReturnEdge < Edge
+      attr_reader(:key)
+
+      # Pre-condition: thePredecessor is an EndVertex
+      # Pre-condition: theSuccessor is an ItemVertex
+      def initialize(thePredecessor, theSuccessor)
+        super(thePredecessor, theSuccessor)
+        do_set_key(thePredecessor, theSuccessor)
+      end
+
+      private
+
+      def do_set_key(_thePredecessor, theSuccessor)
+        tail_d_item = theSuccessor.dotted_item
+        prefix = "RET_#{tail_d_item.production.object_id}_"
+        @key = prefix + tail_d_item.prev_position.to_s
+      end
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/rley/gfg/scan_edge.rb

@@ -1,26 +1,25 @@
-require_relative 'edge'
-
-module Rley # This module is used as a namespace
-  module GFG # This module is used as a namespace
-    # Specialization of an edge in a grammar flow graph
-    # that is taken as a consequence of a scan rule.
-    # Responsibilities:
-    # - To know the successor vertex
-    class ScanEdge < Edge
-      # The terminal symbol expected from the input stream
-      attr_reader :terminal
-      
-      def initialize(thePredecessor, theSuccessor, aTerminal)
-        super(thePredecessor, theSuccessor)
-        @terminal = aTerminal
-      end
-      
-      def to_s()
-        " -#{terminal}-> #{successor.label}"
-      end
-
-    end # class
-  end # module
-end # module
-
-# End of file
+require_relative 'edge'
+
+module Rley # This module is used as a namespace
+  module GFG # This module is used as a namespace
+    # Specialization of an edge in a grammar flow graph
+    # that is taken as a consequence of a scan rule.
+    # Responsibilities:
+    # - To know the successor vertex
+    class ScanEdge < Edge
+      # The terminal symbol expected from the input stream
+      attr_reader :terminal
+
+      def initialize(thePredecessor, theSuccessor, aTerminal)
+        super(thePredecessor, theSuccessor)
+        @terminal = aTerminal
+      end
+
+      def to_s()
+        " -#{terminal}-> #{successor.label}"
+      end
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/rley/gfg/shortcut_edge.rb

@@ -1,26 +1,25 @@
-require_relative 'edge'
-
-module Rley # This module is used as a namespace
-  module GFG # This module is used as a namespace
-    # Abstract class. Represents an edge in a grammar flow graph
-    # Responsibilities:
-    # - To know the successor vertex
-    class ShortcutEdge < Edge
-      # The terminal symbol expected from the input stream
-      attr_reader :nonterminal
-      
-      def initialize(thePredecessor, theSuccessor)
-        @successor = theSuccessor
-        @nonterminal = thePredecessor.next_symbol
-        thePredecessor.shortcut = self
-      end
-      
-      def to_s()
-        " -#{nonterminal}-> #{successor.label}"
-      end
-
-    end # class
-  end # module
-end # module
-
-# End of file
+require_relative 'edge'
+
+module Rley # This module is used as a namespace
+  module GFG # This module is used as a namespace
+    # Abstract class. Represents an edge in a grammar flow graph
+    # Responsibilities:
+    # - To know the successor vertex
+    class ShortcutEdge < Edge
+      # The terminal symbol expected from the input stream
+      attr_reader :nonterminal
+
+      def initialize(thePredecessor, theSuccessor)
+        @successor = theSuccessor
+        @nonterminal = thePredecessor.next_symbol
+        thePredecessor.shortcut = self
+      end
+
+      def to_s()
+        " -#{nonterminal}-> #{successor.label}"
+      end
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/rley/gfg/start_vertex.rb

@@ -8,7 +8,6 @@ module Rley # This module is used as a namespace
     # Responsibilities (in addition to inherited ones):
     # - Know its related non-terminal symbol
     class StartVertex < NonTerminalVertex
-      
       def initialize(aNonTerminal)
         super(aNonTerminal)
       end
@@ -16,7 +15,6 @@ module Rley # This module is used as a namespace
       def label()
         return ".#{non_terminal}"
       end       
-
     end # class
   end # module
 end # module

data/lib/rley/gfg/vertex.rb

@@ -18,31 +18,31 @@ module Rley # This module is used as a namespace
         edges << arrow
       end
       
-      # Returns true iff the vertex corresponds to an dotted item that has its dot 
-      # at the end of a production (i.e. is a reduced item).
+      # Returns true iff the vertex corresponds to an dotted item that has
+      # its dot at the end of a production (i.e. is a reduced item).
       def complete?()
-        return false  # Default implementation
+        return false # Default implementation
       end
       
       # Return the symbol before the dot else nil.
       def prev_symbol()
-        return nil  # Default implementation
+        return nil # Default implementation
       end      
       
       # Return the symbol after the dot else nil.
       def next_symbol()
-        return nil  # Default implementation
+        return nil # Default implementation
       end
       
-protected
+      protected
+
       # Validation method for adding an outgoing edge to the vertex.
       # Vertices will accept an indegree and outdegree of at most one
       # unless this method is overridden in subclasses
       def check_add_edge(anEdge)
-        fail StandardError, 'At most one edge accepted' unless edges.empty?
+        raise StandardError, 'At most one edge accepted' unless edges.empty?
         return anEdge
       end
-
     end # class
   end # module
 end # module