sequitur 0.1.10 → 0.1.11

data/lib/sequitur/dynamic_grammar.rb

@@ -1,106 +1,106 @@
-require_relative 'production'
-require_relative 'grammar_visitor'
-
-module Sequitur # Module for classes implementing the Sequitur algorithm
-
-# A dynamic grammar is a context-free grammar that can be built incrementally.
-#   Formally, a grammar has:
-#   One start production
-#   Zero or more other productions
-#   Each production has a rhs that is a sequence of grammar symbols.
-#   Grammar symbols are categorized into
-#   -terminal symbols (i.e. String, Ruby Symbol,...)
-#   -non-terminal symbols (i.e. ProductionRef) 
-class DynamicGrammar
-  # Link to the start production.
-  attr_reader(:start)
-
-  # The set of production rules of the grammar
-  attr_reader(:productions)
-
-  # nodoc Trace the execution of the algorithm.
-  attr(:trace)
-
-
-  # Constructor.
-  # Build a grammar with one empty rule as start/start rule.
-  def initialize()
-    @start = Production.new
-    @productions = [ start ]
-    @trace = false
-  end
-
-  public
-
-  # Emit a text representation of the grammar.
-  # Each production rule is emitted per line.
-  # @return [String]
-  def to_string()
-    rule_text = productions.map(&:to_string).join("\n")
-    return rule_text
-  end
-
-
-  # Add a given production to the grammar.
-  # @param aProduction [Production]
-  def add_production(aProduction)
-    # TODO: remove output
-    puts "Adding #{aProduction.object_id}" if trace
-    puts aProduction.to_string if trace
-    productions << aProduction
-  end
-
-
-  # Remove a production with given index from the grammar
-  # @param anIndex [Fixnum]
-  # @return [Production] the production removed from the grammar.
-  def remove_production(anIndex)
-    puts "Before production removal #{productions[anIndex].object_id}" if trace
-    puts to_string if trace
-    prod = productions.delete_at(anIndex)
-    # TODO: remove output
-    puts('Removed: ' + prod.to_string) if trace
-    prod.clear_rhs
-
-    return prod
-  end
-
-
-  # Add the given token to the grammar.
-  #   Append the token to the rhs of the start/start rule.
-  # @param aToken [Object] input token to add
-  def add_token(aToken)
-    append_symbol_to(start, aToken)
-  end
-
-  # Part of the 'visitee' role in the Visitor design pattern.
-  #   A visitee is expected to accept the visit from a visitor object
-  # @param aVisitor [GrammarVisitor] the visitor object
-  def accept(aVisitor)
-    aVisitor.start_visit_grammar(self)
-    
-    # Let's proceed with the visit of productions
-    productions.each { |prod| prod.accept(aVisitor) }
-    
-    aVisitor.end_visit_grammar(self)
-  end
-
-  # Factory method. Returns a visitor for this grammar.
-  # @return [GrammarVisitor]
-  def visitor()
-    return GrammarVisitor.new(self)
-  end
-
-  protected
-  
-  # Append a given symbol to the rhs of passed production.
-  # @param aProduction [Production]
-  # @param aSymbol [Object]
-  def append_symbol_to(aProduction, aSymbol)
-    aProduction.append_symbol(aSymbol)
-  end
-end # class
-
-end # module
-
-# End of file
+require_relative 'production'
+require_relative 'grammar_visitor'
+
+module Sequitur # Module for classes implementing the Sequitur algorithm
+
+# A dynamic grammar is a context-free grammar that can be built incrementally.
+#   Formally, a grammar has:
+#   One start production
+#   Zero or more other productions
+#   Each production has a rhs that is a sequence of grammar symbols.
+#   Grammar symbols are categorized into
+#   -terminal symbols (i.e. String, Ruby Symbol,...)
+#   -non-terminal symbols (i.e. ProductionRef)
+class DynamicGrammar
+  # Link to the start production.
+  attr_reader(:start)
+
+  # The set of production rules of the grammar
+  attr_reader(:productions)
+
+  # nodoc Trace the execution of the algorithm.
+  attr(:trace)
+
+
+  # Constructor.
+  # Build a grammar with one empty rule as start/start rule.
+  def initialize()
+    @start = Production.new
+    @productions = [ start ]
+    @trace = false
+  end
+
+  public
+
+  # Emit a text representation of the grammar.
+  # Each production rule is emitted per line.
+  # @return [String]
+  def to_string()
+    rule_text = productions.map(&:to_string).join("\n")
+    return rule_text
+  end
+
+
+  # Add a given production to the grammar.
+  # @param aProduction [Production]
+  def add_production(aProduction)
+    # TODO: remove output
+    puts "Adding #{aProduction.object_id}" if trace
+    puts aProduction.to_string if trace
+    productions << aProduction
+  end
+
+
+  # Remove a production with given index from the grammar
+  # @param anIndex [Fixnum]
+  # @return [Production] the production removed from the grammar.
+  def remove_production(anIndex)
+    puts "Before production removal #{productions[anIndex].object_id}" if trace
+    puts to_string if trace
+    prod = productions.delete_at(anIndex)
+    # TODO: remove output
+    puts('Removed: ' + prod.to_string) if trace
+    prod.clear_rhs
+
+    return prod
+  end
+
+
+  # Add the given token to the grammar.
+  #   Append the token to the rhs of the start/start rule.
+  # @param aToken [Object] input token to add
+  def add_token(aToken)
+    append_symbol_to(start, aToken)
+  end
+
+  # Part of the 'visitee' role in the Visitor design pattern.
+  #   A visitee is expected to accept the visit from a visitor object
+  # @param aVisitor [GrammarVisitor] the visitor object
+  def accept(aVisitor)
+    aVisitor.start_visit_grammar(self)
+
+    # Let's proceed with the visit of productions
+    productions.each { |prod| prod.accept(aVisitor) }
+
+    aVisitor.end_visit_grammar(self)
+  end
+
+  # Factory method. Returns a visitor for this grammar.
+  # @return [GrammarVisitor]
+  def visitor()
+    return GrammarVisitor.new(self)
+  end
+
+  protected
+
+  # Append a given symbol to the rhs of passed production.
+  # @param aProduction [Production]
+  # @param aSymbol [Object]
+  def append_symbol_to(aProduction, aSymbol)
+    aProduction.append_symbol(aSymbol)
+  end
+end # class
+
+end # module
+
+# End of file

data/lib/sequitur/formatter/base_formatter.rb

@@ -1,39 +1,39 @@
-module Sequitur
-
-  # Namespace dedicated to grammar formatters.
-  module Formatter
-  
-    # Superclass for grammar formatters.
-    class BaseFormatter
-      # The IO output stream in which the formatter's result will be sent.
-      attr(:output)
-
-      # Constructor.
-      # @param anIO [IO] an output IO where the formatter's result will 
-      # be placed.
-      def initialize(anIO)
-        @output = anIO
-      end
-
-      public
-      
-      # Given a grammar or a grammar visitor, perform the visit
-      # and render the visit events in the output stream.
-      # @param aGrmOrVisitor [DynamicGrammar or GrammarVisitor]
-      def render(aGrmOrVisitor)
-        if aGrmOrVisitor.kind_of?(GrammarVisitor)
-          a_visitor = aGrmOrVisitor
-        else
-          a_visitor = aGrmOrVisitor.visitor
-        end
-        
-        a_visitor.subscribe(self)
-        a_visitor.start
-        a_visitor.unsubscribe(self)
-      end
-    
-    end # class
-  end # module
-end # module
-
-# End of file
+module Sequitur
+
+  # Namespace dedicated to grammar formatters.
+  module Formatter
+
+    # Superclass for grammar formatters.
+    class BaseFormatter
+      # The IO output stream in which the formatter's result will be sent.
+      attr(:output)
+
+      # Constructor.
+      # @param anIO [IO] an output IO where the formatter's result will
+      # be placed.
+      def initialize(anIO)
+        @output = anIO
+      end
+
+      public
+
+      # Given a grammar or a grammar visitor, perform the visit
+      # and render the visit events in the output stream.
+      # @param aGrmOrVisitor [DynamicGrammar or GrammarVisitor]
+      def render(aGrmOrVisitor)
+        if aGrmOrVisitor.kind_of?(GrammarVisitor)
+          a_visitor = aGrmOrVisitor
+        else
+          a_visitor = aGrmOrVisitor.visitor
+        end
+
+        a_visitor.subscribe(self)
+        a_visitor.start
+        a_visitor.unsubscribe(self)
+      end
+
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/sequitur/formatter/base_text.rb

@@ -1,95 +1,95 @@
-require_relative 'base_formatter'
-
-module Sequitur
-  module Formatter
-
-    # A formatter class that can render a dynamic grammar in plain text.
-    # @example
-    #   some_grammar = ... # Points to a DynamicGrammar-like object
-    #   # Output the result to the standard console output
-    #   formatter = Sequitur::Formatter::BaseText.new(STDOUT)
-    #   # Render the grammar (through a visitor)
-    #   formatter.run(some_grammar.visitor)
-    class BaseText < BaseFormatter
-
-      # Constructor.
-      # @param anIO [IO] The output stream to which the rendered grammar
-      # is written.
-      def initialize(anIO)
-        super(anIO)
-        @prod_lookup = {}
-      end
-
-      public
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor is about to visit a grammar
-      # @param aGrammar [DynamicGrammar-like object]
-      def before_grammar(aGrammar)
-        aGrammar.productions.each_with_index do |a_prod, index|
-          prod_lookup[a_prod] = index
-        end
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor is about to visit 
-      # a production
-      # @param aProduction [aProduction]
-      def before_production(aProduction)
-        p_name = prod_name(aProduction)
-        output.print p_name
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor is about to visit 
-      # the rhs of a production
-      # @param _ [Array]
-      def before_rhs(_)
-        output.print ' :'
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor is about to visit 
-      # a terminal symbol from the rhs of a production
-      # @param aSymbol [Object]
-      def before_terminal(aSymbol)
-        output.print " #{aSymbol}"
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor is about to visit 
-      # a non-terminal (= an allusion to a production) in the rhs of a 
-      # production
-      # @param aProduction [Production] a production occurring in the rhs
-      def before_non_terminal(aProduction)
-        p_name = prod_name(aProduction)
-        output.print " #{p_name}"
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor complete the visit 
-      # of a production
-      def after_production(_)
-        output.print ".\n"
-      end
-
-      private
-      
-      # Read accessor of the production lookup
-      def prod_lookup()
-        return @prod_lookup
-      end
-
-      # Generate a name of a given production.
-      # @param aProduction [Production] 
-      def prod_name(aProduction)
-        prod_index = prod_lookup[aProduction]
-        name = (prod_index == 0) ? 'start' : "P#{prod_index}"
-        return name
-      end
-
-    end # class
-  end # module
-end # module
-
-# End of file
+require_relative 'base_formatter'
+
+module Sequitur
+  module Formatter
+
+    # A formatter class that can render a dynamic grammar in plain text.
+    # @example
+    #   some_grammar = ... # Points to a DynamicGrammar-like object
+    #   # Output the result to the standard console output
+    #   formatter = Sequitur::Formatter::BaseText.new(STDOUT)
+    #   # Render the grammar (through a visitor)
+    #   formatter.run(some_grammar.visitor)
+    class BaseText < BaseFormatter
+
+      # Constructor.
+      # @param anIO [IO] The output stream to which the rendered grammar
+      # is written.
+      def initialize(anIO)
+        super(anIO)
+        @prod_lookup = {}
+      end
+
+      public
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor is about to visit a grammar
+      # @param aGrammar [DynamicGrammar-like object]
+      def before_grammar(aGrammar)
+        aGrammar.productions.each_with_index do |a_prod, index|
+          prod_lookup[a_prod] = index
+        end
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor is about to visit
+      # a production
+      # @param aProduction [aProduction]
+      def before_production(aProduction)
+        p_name = prod_name(aProduction)
+        output.print p_name
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor is about to visit
+      # the rhs of a production
+      # @param _ [Array]
+      def before_rhs(_)
+        output.print ' :'
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor is about to visit
+      # a terminal symbol from the rhs of a production
+      # @param aSymbol [Object]
+      def before_terminal(aSymbol)
+        output.print " #{aSymbol}"
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor is about to visit
+      # a non-terminal (= an allusion to a production) in the rhs of a
+      # production
+      # @param aProduction [Production] a production occurring in the rhs
+      def before_non_terminal(aProduction)
+        p_name = prod_name(aProduction)
+        output.print " #{p_name}"
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor complete the visit
+      # of a production
+      def after_production(_)
+        output.print ".\n"
+      end
+
+      private
+
+      # Read accessor of the production lookup
+      def prod_lookup()
+        return @prod_lookup
+      end
+
+      # Generate a name of a given production.
+      # @param aProduction [Production]
+      def prod_name(aProduction)
+        prod_index = prod_lookup[aProduction]
+        name = (prod_index == 0) ? 'start' : "P#{prod_index}"
+        return name
+      end
+
+    end # class
+  end # module
+end # module
+
+# End of file