sequitur 0.1.10 → 0.1.11

data/lib/sequitur/formatter/debug.rb

@@ -1,131 +1,131 @@
-require_relative 'base_formatter'
-
-
-module Sequitur
-  module Formatter
-
-    # A formatter class that can render the notification events
-    # from a grammar visitor
-    # @example
-    #   some_grammar = ... # Points to a DynamicGrammar-like object
-    #   # Output the result to the standard console output
-    #   formatter = Sequitur::Formatter::Debug.new(STDOUT)
-    #   # Render the visit notifications
-    #   formatter.run(some_grammar.visitor)
-    class Debug < BaseFormatter
-      # Current indentation level
-      attr(:indentation)
-
-      # Constructor.
-      # @param anIO [IO] The output stream to which the rendered grammar
-      # is written.
-      def initialize(anIO)
-        super(anIO)
-        @indentation = 0
-      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 _ [DynamicGrammar-like object]
-      def before_grammar(_)
-        output_event(__method__, indentation)
-        indent
-      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]
-      def before_production(_)
-        output_event(__method__, indentation)
-        indent
-      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_event(__method__, indentation)
-        indent
-      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 _ [Object]
-      def before_terminal(_)
-        output_event(__method__, indentation)
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor completed the visit of
-      # a terminal symbol from the rhs of a production
-      # @param _ [Object]
-      def after_terminal(_)
-        output_event(__method__, indentation)
-      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 _ [Production] a production occurring in the rhs
-      def before_non_terminal(_)
-        output_event(__method__, indentation)
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor completed the visit of
-      # a non-terminal symbol from the rhs of a production.
-      # @param _ [Object]
-      def after_non_terminal(_)
-        output_event(__method__, indentation)
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor completed the visit of
-      # the rhs of a production
-      # @param _ [Array]
-      def after_rhs(_)
-        dedent
-        output_event(__method__, indentation)
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor completed the visit
-      # of a production
-      def after_production(_)
-        dedent
-        output_event(__method__, indentation)
-      end
-
-      # Method called by a GrammarVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor completed the visit
-      # of a grammar
-      def after_grammar(_)
-        dedent
-        output_event(__method__, indentation)
-      end
-
-      private
-
-      def indent()
-        @indentation += 1
-      end
-
-      def dedent()
-        @indentation -= 1
-      end
-
-      def output_event(anEvent, indentationLevel)
-        output.puts "#{' ' * 2 * indentationLevel}#{anEvent}"
-      end
-
-    end # class
-  end # module
-end # module
-
-# End of file
+require_relative 'base_formatter'
+
+
+module Sequitur
+  module Formatter
+
+    # A formatter class that can render the notification events
+    # from a grammar visitor
+    # @example
+    #   some_grammar = ... # Points to a DynamicGrammar-like object
+    #   # Output the result to the standard console output
+    #   formatter = Sequitur::Formatter::Debug.new(STDOUT)
+    #   # Render the visit notifications
+    #   formatter.run(some_grammar.visitor)
+    class Debug < BaseFormatter
+      # Current indentation level
+      attr(:indentation)
+
+      # Constructor.
+      # @param anIO [IO] The output stream to which the rendered grammar
+      # is written.
+      def initialize(anIO)
+        super(anIO)
+        @indentation = 0
+      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 _ [DynamicGrammar-like object]
+      def before_grammar(_)
+        output_event(__method__, indentation)
+        indent
+      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]
+      def before_production(_)
+        output_event(__method__, indentation)
+        indent
+      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_event(__method__, indentation)
+        indent
+      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 _ [Object]
+      def before_terminal(_)
+        output_event(__method__, indentation)
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor completed the visit of
+      # a terminal symbol from the rhs of a production
+      # @param _ [Object]
+      def after_terminal(_)
+        output_event(__method__, indentation)
+      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 _ [Production] a production occurring in the rhs
+      def before_non_terminal(_)
+        output_event(__method__, indentation)
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor completed the visit of
+      # a non-terminal symbol from the rhs of a production.
+      # @param _ [Object]
+      def after_non_terminal(_)
+        output_event(__method__, indentation)
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor completed the visit of
+      # the rhs of a production
+      # @param _ [Array]
+      def after_rhs(_)
+        dedent
+        output_event(__method__, indentation)
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor completed the visit
+      # of a production
+      def after_production(_)
+        dedent
+        output_event(__method__, indentation)
+      end
+
+      # Method called by a GrammarVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor completed the visit
+      # of a grammar
+      def after_grammar(_)
+        dedent
+        output_event(__method__, indentation)
+      end
+
+      private
+
+      def indent()
+        @indentation += 1
+      end
+
+      def dedent()
+        @indentation -= 1
+      end
+
+      def output_event(anEvent, indentationLevel)
+        output.puts "#{' ' * 2 * indentationLevel}#{anEvent}"
+      end
+
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/sequitur/grammar_visitor.rb

@@ -1,110 +1,110 @@
-module Sequitur # Module for classes implementing the Sequitur algorithm
-
-# A visitor class dedicated in the visit of Grammar.
-class GrammarVisitor
-  # Link to the grammar to visit
-  attr_reader(:grammar)
-
-  # List of objects that subscribed to the visit event notification.
-  attr_reader(:subscribers)
-
-  # Build a visitor for the given grammar.
-  # @param aGrammar [DynamicGrammar-like] the grammar to visit.
-  def initialize(aGrammar)
-    @grammar = aGrammar
-    @subscribers = []
-  end
-
-  public
-
-  # Add a subscriber for the visit event notification.
-  # @param aSubscriber [Object]
-  def subscribe(aSubscriber)
-    subscribers << aSubscriber
-  end
-
-  # Remove the given object from the subscription list.
-  # The object won't be notified of visit events.
-  # @param aSubscriber [Object]
-  def unsubscribe(aSubscriber)
-    subscribers.delete_if { |entry| entry == aSubscriber }
-  end
-
-  # The signal to start the visit.
-  def start()
-    grammar.accept(self)
-  end
-
-
-  # Visit event. The visitor is about to visit the grammar.
-  # @param aGrammar [DynamicGrammar-like] the grammar to visit.
-  def start_visit_grammar(aGrammar)
-    broadcast(:before_grammar, aGrammar)
-  end
-
-
-  # Visit event. The visitor is about to visit the given production.
-  # @param aProduction [Production] the production to visit.
-  def start_visit_production(aProduction)
-    broadcast(:before_production, aProduction)
-  end
-
-  # Visit event. The visitor is about to visit the given rhs of production.
-  # @param rhs [SymbolSequence] the rhs of a production to visit.
-  def start_visit_rhs(rhs)
-    broadcast(:before_rhs, rhs)
-  end
-
-  # Visit event. The visitor is visiting the
-  # given reference production (= non-terminal symbol).
-  # @param aProdRef [ProductionRef] the production reference to visit.
-  def visit_prod_ref(aProdRef)
-    production = aProdRef.production
-    broadcast(:before_non_terminal, production)
-    broadcast(:after_non_terminal, production)
-  end
-
-  # Visit event. The visitor is visiting the
-  # given terminal symbol.
-  # @param aTerminal [Object] the terminal to visit.
-  def visit_terminal(aTerminal)
-    broadcast(:before_terminal, aTerminal)
-    broadcast(:after_terminal, aTerminal)
-  end
-
-  # Visit event. The visitor has completed its visit of the given rhs.
-  # @param rhs [SymbolSequence] the rhs of a production to visit.
-  def end_visit_rhs(rhs)
-    broadcast(:after_rhs, rhs)
-  end
-
-  # Visit event. The visitor has completed its visit of the given production.
-  # @param aProduction [Production] the production to visit.
-  def end_visit_production(aProduction)
-    broadcast(:after_production, aProduction)
-  end
-
-  # Visit event. The visitor has completed the visit of the grammar.
-  # @param aGrammar [DynamicGrammar-like] the grammar to visit.
-  def end_visit_grammar(aGrammar)
-    broadcast(:after_grammar, aGrammar)
-  end
-
-  private
-
-  # Send a notification to all subscribers.
-  # @param msg [Symbol] event to notify
-  # @param args [Array] arguments of the notification.
-  def broadcast(msg, *args)
-    subscribers.each do |a_subscriber|
-      next unless a_subscriber.respond_to?(msg)
-      a_subscriber.send(msg, *args)
-    end
-  end
-
-
-end # class
-
-end # module
-
-# End of file
+module Sequitur # Module for classes implementing the Sequitur algorithm
+
+# A visitor class dedicated in the visit of Grammar.
+class GrammarVisitor
+  # Link to the grammar to visit
+  attr_reader(:grammar)
+
+  # List of objects that subscribed to the visit event notification.
+  attr_reader(:subscribers)
+
+  # Build a visitor for the given grammar.
+  # @param aGrammar [DynamicGrammar-like] the grammar to visit.
+  def initialize(aGrammar)
+    @grammar = aGrammar
+    @subscribers = []
+  end
+
+  public
+
+  # Add a subscriber for the visit event notification.
+  # @param aSubscriber [Object]
+  def subscribe(aSubscriber)
+    subscribers << aSubscriber
+  end
+
+  # Remove the given object from the subscription list.
+  # The object won't be notified of visit events.
+  # @param aSubscriber [Object]
+  def unsubscribe(aSubscriber)
+    subscribers.delete_if { |entry| entry == aSubscriber }
+  end
+
+  # The signal to start the visit.
+  def start()
+    grammar.accept(self)
+  end
+
+
+  # Visit event. The visitor is about to visit the grammar.
+  # @param aGrammar [DynamicGrammar-like] the grammar to visit.
+  def start_visit_grammar(aGrammar)
+    broadcast(:before_grammar, aGrammar)
+  end
+
+
+  # Visit event. The visitor is about to visit the given production.
+  # @param aProduction [Production] the production to visit.
+  def start_visit_production(aProduction)
+    broadcast(:before_production, aProduction)
+  end
+
+  # Visit event. The visitor is about to visit the given rhs of production.
+  # @param rhs [SymbolSequence] the rhs of a production to visit.
+  def start_visit_rhs(rhs)
+    broadcast(:before_rhs, rhs)
+  end
+
+  # Visit event. The visitor is visiting the
+  # given reference production (= non-terminal symbol).
+  # @param aProdRef [ProductionRef] the production reference to visit.
+  def visit_prod_ref(aProdRef)
+    production = aProdRef.production
+    broadcast(:before_non_terminal, production)
+    broadcast(:after_non_terminal, production)
+  end
+
+  # Visit event. The visitor is visiting the
+  # given terminal symbol.
+  # @param aTerminal [Object] the terminal to visit.
+  def visit_terminal(aTerminal)
+    broadcast(:before_terminal, aTerminal)
+    broadcast(:after_terminal, aTerminal)
+  end
+
+  # Visit event. The visitor has completed its visit of the given rhs.
+  # @param rhs [SymbolSequence] the rhs of a production to visit.
+  def end_visit_rhs(rhs)
+    broadcast(:after_rhs, rhs)
+  end
+
+  # Visit event. The visitor has completed its visit of the given production.
+  # @param aProduction [Production] the production to visit.
+  def end_visit_production(aProduction)
+    broadcast(:after_production, aProduction)
+  end
+
+  # Visit event. The visitor has completed the visit of the grammar.
+  # @param aGrammar [DynamicGrammar-like] the grammar to visit.
+  def end_visit_grammar(aGrammar)
+    broadcast(:after_grammar, aGrammar)
+  end
+
+  private
+
+  # Send a notification to all subscribers.
+  # @param msg [Symbol] event to notify
+  # @param args [Array] arguments of the notification.
+  def broadcast(msg, *args)
+    subscribers.each do |a_subscriber|
+      next unless a_subscriber.respond_to?(msg)
+      a_subscriber.send(msg, *args)
+    end
+  end
+
+
+end # class
+
+end # module
+
+# End of file