Spectre 0.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+0.0.1    :: First release, basic functionality up, all tests passing

data/LICENSE

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,20 @@
+
+This is Spectre, a parser framework inspired by Boost.Spirit,
+which can be found at http://spirit.sourceforge.net/.
+
+_______________________________________________________
+
+License: Boost Software License 1.0
+For further information regarding this license, visit:
+http://www.boost.org/LICENSE_1_0.txt
+______________________________________________________
+
+
+Support for Spectre is given at  http://spectre.rubyforge.org/  .
+                                ===============================
+
+If you have questions, problems, want to report bugs or request features, this is the
+place for you.
+
+Have fun with it!
+

data/Rakefile

@@ -0,0 +1,112 @@
+# This is Spectre, a parser framework inspired by Boost.Spirit,
+# which can be found at http://spirit.sourceforge.net/.
+#
+# If you want to find out more or need a tutorial, go to
+# http://spectre.rubyforge.org/
+# You'll find a nice wiki there!
+#
+# Author::      Fabian Streitel (karottenreibe)
+# Copyright::   Copyright (c) 2009 Fabian Streitel
+# License::     Boost Software License 1.0
+#               For further information regarding this license, you can go to
+#               http://www.boost.org/LICENSE_1_0.txt
+#               or read the file LICENSE distributed with this software.
+# Homepage::    http://spectre.rubyforge.org/
+# Git repo::    http://rubyforge.org/scm/?group_id=7618
+#
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+$VERBOSE = nil
+
+GEM_NAME        = 'Spectre'
+GEM_AUTHORS     = ['Fabian Streitel']
+GEM_HOMEPAGE    = 'http://spectre.rubyforge.org/'
+GEM_RUBYFORGE   = 'spectre'
+GEM_SUMMARY     = "This is Spectre, a parser framework inspired by Boost.Spirit."
+GEM_EMAIL       = "karottenreibe @nospam@ gmail.com"
+
+spec = Gem::Specification.new do |s|
+    if ARGV.any? { |arg| arg == 'gem' }
+        puts
+        puts
+        puts "Versioning policy:"
+        puts "1 = implementation details changed"
+        puts "2 = compatible new feature"
+        puts "3 = incompatible changes"
+        puts
+        puts "Last build: " + (Dir['pkg/*'].sort)[-1].to_s
+        print "Enter version number > "
+        ver = STDIN.gets.strip
+        print "Enter changelog > "
+        chl = STDIN.gets
+
+        File.open('CHANGELOG', 'a') do |f|
+            f.write "#{ver.ljust 8} :: #{chl}"
+        end
+    end
+
+    s.platform          =   Gem::Platform::RUBY
+    s.name              =   GEM_NAME
+    s.version           =   ver || "99"
+    s.authors           =   GEM_AUTHORS
+    s.email             =   GEM_EMAIL
+    s.homepage          =   GEM_HOMEPAGE
+    s.rubyforge_project =   GEM_RUBYFORGE
+    s.summary           =   GEM_SUMMARY
+    s.files             =   FileList['lib/**/*.rb', 'test/**/*', '[A-Z]*'].to_a
+    s.require_path      =   "lib"
+    s.test_files        =   FileList['test/**/*.rb']
+    s.has_rdoc          =   true
+    s.extra_rdoc_files  =   ["README", "CHANGELOG", "LICENSE"]
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar = true
+end
+
+task :gem => "pkg/#{GEM_NAME}-#{spec.version}.gem" do
+    puts "generated gem"
+end
+
+Rake::RDocTask.new :real_doc do |rdoc|
+    rdoc.rdoc_files.include "lib/**/*.rb"
+end
+
+task :doc => [:real_doc] do
+    sh 'rm -r rdoc' if File::exists? 'rdoc'
+    sh 'mv html rdoc'
+end
+
+task :clean do
+    sh 'rm -r rdoc'
+    sh 'rm -r pkg'
+end
+
+Rake::TestTask.new :test do |t|
+    t.libs << "test"
+    t.test_files = ['test/tests.rb']
+    t.verbose = true
+end
+
+task :upload => [:rdoc] do
+    sh "rsync -azv --no-perms --no-times rdoc/* karottenreibe@rubyforge.org:/var/www/gforge-projects/#{GEM_RUBYFORGE}/rdoc/"
+    sh "rsync -azv --no-perms --no-times homepage/* karottenreibe@rubyforge.org:/var/www/gforge-projects/#{GEM_RUBYFORGE}/"
+end
+
+task :sftp do
+    sh "sftp karottenreibe@rubyforge.org:/var/www/gforge-projects/#{GEM_RUBYFORGE}/"
+end
+
+task :install => [:package] do
+    sh "sudo gem install pkg/#{GEM_NAME}-#{spec.version}.gem"
+    sh "rm pkg/#{GEM_NAME}-#{spec.version}.gem"
+end
+
+task :default => [:gem, :doc]
+task :all => [:clean, :gem, :doc, :test]
+task :rdoc => [:doc]
+

data/lib/spectre/base.rb

@@ -0,0 +1,44 @@
+# This is Spectre, a parser framework inspired by Boost.Spirit,
+# which can be found at http://spirit.sourceforge.net/.
+#
+# If you want to find out more or need a tutorial, go to
+# http://spectre.rubyforge.org/
+# You'll find a nice wiki there!
+#
+# Author::      Fabian Streitel (karottenreibe)
+# Copyright::   Copyright (c) 2009 Fabian Streitel
+# License::     Boost Software License 1.0
+#               For further information regarding this license, you can go to
+#               http://www.boost.org/LICENSE_1_0.txt
+#               or read the file LICENSE distributed with this software.
+# Homepage::    http://spectre.rubyforge.org/
+# Git repo::    http://rubyforge.org/scm/?group_id=7618
+#
+# Requires the base classes needed for Spectre to work:
+# InputIterator, Node, Parser, Grammar and Closure as well as the default
+# Operators, semantic actions and Directives.
+#
+
+require 'spectre/base/inputiterator'
+require 'spectre/base/node'
+require 'spectre/base/parser'
+require 'spectre/base/grammar'
+require 'spectre/base/closure'
+require 'spectre/base/operators'
+require 'spectre/base/directive'
+
+module Spectre
+
+    class << self
+        ##
+        # Shortcut. Parses the +input+ using +parser+ (Parser or Node) and the InputIterator
+        # class +iter_klass+.
+        # +pre_skip+ will be passed on to +Node#parse+.
+        #
+        def parse input, parser, iter_klass, pre_skip = true
+            parser.to_p.parse iter_klass.new(input), pre_skip
+        end
+    end
+
+end
+

data/lib/spectre/base/closure.rb

@@ -0,0 +1,96 @@
+# This is Spectre, a parser framework inspired by Boost.Spirit,
+# which can be found at http://spirit.sourceforge.net/.
+#
+# If you want to find out more or need a tutorial, go to
+# http://spectre.rubyforge.org/
+# You'll find a nice wiki there!
+#
+# Author::      Fabian Streitel (karottenreibe)
+# Copyright::   Copyright (c) 2009 Fabian Streitel
+# License::     Boost Software License 1.0
+#               For further information regarding this license, you can go to
+#               http://www.boost.org/LICENSE_1_0.txt
+#               or read the file LICENSE distributed with this software.
+# Homepage::    http://spectre.rubyforge.org/
+# Git repo::    http://rubyforge.org/scm/?group_id=7618
+#
+# Keeps the Closure class.
+#
+
+require 'spectre/base/parser'
+require 'spectre/base/grammar'
+
+module Spectre
+
+    ##
+    # Provides a Closure over several semantic actions to allow them to interact with each other
+    # and temporarily store data.
+    # The default Closure is a simple hash, but actually it can be an arbitrary object, as long as
+    # it provides the Hash methods +[]+ and +[]=+ and the attributes +parser+ and +node+.
+    #
+    class Closure < Hash
+
+        ##
+        # The Parser this Closure belongs to.
+        attr_accessor :parser
+
+        ##
+        # The Node this Closure belongs to.
+        attr_accessor :node
+
+        def parent
+            @parser.parent.closure
+        end
+    end
+
+    ##
+    # Retrieves a value from the Closure and uses it as a Parser.
+    # The retrieval is performed at parse time.
+    #
+    class ClosureParser
+        include Parser
+
+        ##
+        # The symbol that identifies the Parser inside the Closure.
+        attr_reader :sym
+
+        ##
+        # +sym+ is the identifier for the value retrieved from the Closure.
+        #
+        def initialize sym
+            @sym = sym
+        end
+
+        def negation; NegatedClosureParser.new @sym; end
+
+        def scan iter
+            raise "symbol #{@sym.inspect} not found in closure #{@node.closure.inspect}" unless
+                @node.closure and @node.closure[@sym]
+            create_match iter, @node.closure[@sym].to_p.parse(iter)
+        end
+
+        def inspect
+            "[closure:#{@sym}]"
+        end
+    end
+
+    ##
+    # Negates the enclosed parser.
+    #
+    class NegatedClosureParser < ClosureParser
+        def scan iter
+            raise "symbol #{@sym.inspect} not found in closure #{@node.closure.inspect}" unless
+                @node.closure and @node.closure[@sym]
+            create_match iter, ( ~( @node.closure[@sym].to_p ) ).parse(iter)
+        end
+
+        def inspect
+            "(~[closure:#{@sym}])"
+        end
+    end
+
+    ##
+    # The ClosureParser shortcut is +closed+.
+    ShortcutsMixin.register_shortcut :closed => ClosureParser
+end
+

data/lib/spectre/base/directive.rb

@@ -0,0 +1,148 @@
+# This is Spectre, a parser framework inspired by Boost.Spirit,
+# which can be found at http://spirit.sourceforge.net/.
+#
+# If you want to find out more or need a tutorial, go to
+# http://spectre.rubyforge.org/
+# You'll find a nice wiki there!
+#
+# Author::      Fabian Streitel (karottenreibe)
+# Copyright::   Copyright (c) 2009 Fabian Streitel
+# License::     Boost Software License 1.0
+#               For further information regarding this license, you can go to
+#               http://www.boost.org/LICENSE_1_0.txt
+#               or read the file LICENSE distributed with this software.
+# Homepage::    http://spectre.rubyforge.org/
+# Git repo::    http://rubyforge.org/scm/?group_id=7618
+#
+# Keeps the Directive class.
+#
+
+require 'spectre/base/parser'
+require 'spectre/base/node'
+
+module Spectre
+
+    ##
+    # Sets options for the Parser and InputIterator.
+    # Imitates the behaviour of a Node.
+    # Subclasses may call the singleton methods +::transformation!+ and +::policy!+ to set the input
+    # transformation and Parser policy hash to use.
+    # These hashes will get merged with the current options.
+    #
+    # The Directive acts like a node in order to apply the parser policy.
+    # It keeps a DirectiveParser, which applies the input transformation.
+    #
+    class Directive < Node
+
+        ##
+        # The skipper to apply to the InputIterator for this Directive - lambda block.
+        attr_reader :iter_skipper
+
+        ##
+        # The transformation to apply to the InputIterator for this Directive - lambda block.
+        attr_reader :iter_transformation
+
+        ##
+        # Whether or not the child parser should do pre-skipping.
+        attr_reader :pre_skip
+
+        class << self
+
+            ##
+            # The skipper to apply to the InputIterator for this subclass - lambda block.
+            attr_reader :skipper
+
+            ##
+            # The transformation to apply to the InputIterator for this subclass - lambda block.
+            attr_reader :transformation
+
+            ##
+            # The options to merge with the Parser options for this subclass.
+            #
+            def policy
+                @policy || {}
+            end
+
+            ##
+            # Sets the skipper on the InputIterator for this subclass to either the +block+
+            # or if no block is given to the first argument given to the method.
+            #
+            def skipper! *args, &block
+                @skipper = block_given? ? block : args[0]
+            end
+
+            ##
+            # Sets the input transformation on the InputIterator for this subclass to either the +block+
+            # or if no block is given to the first argument given to the method.
+            #
+            def transformation! *args, &block
+                @transformation = block_given? ? block : args[0]
+            end
+
+            ##
+            # Sets the Parser policy to use for this subclass.
+            # The provided +hash+ will be merged with any already existing policy hash, thus enabling
+            # you to leave current specifications the way they are by simply not mentioning them.
+            #
+            def policy! hash
+                @policy = hash
+            end
+        end
+
+        ##
+        # Retrieves the options from the subclassclass definition.
+        #
+        def initialize
+            @iter_transformation ||= self.class.transformation
+            @iter_skipper ||= self.class.skipper
+            @pre_skip = true
+            super(DirectiveParser.new self)
+            pol = self.class.policy
+            @policy ? @policy.merge!(pol) : @policy = pol
+        end
+
+        ##
+        # Unlike Nodes, the Directive cannot store semantic actions. Instead this operator is used to
+        # deliver the subnodes for it.
+        # Performs auto-conversion on +node+.
+        #
+        def [] node
+            @left = node.to_p
+            @left.parent = self
+            self
+        end
+
+        ##
+        # Saves the pre_skipping flag as directives pass that on to their children.
+        #
+        def parse iter, pre_skip = true
+            @pre_skip = pre_skip
+            super(iter, pre_skip)
+        end
+    end
+
+    ##
+    # Does the setting and resetting of the input transformation on the InputIterator.
+    #
+    class DirectiveParser
+        include Parser
+
+        def initialize directive
+            @directive = directive
+        end
+
+        def scan iter
+            trans, skip = iter.transformation, iter.skipper
+            iter.transformation = @directive.iter_transformation if @directive.iter_transformation
+            iter.skipper = @directive.iter_skipper if @directive.iter_skipper
+
+            ret = @node.left.parse iter, @directive.pre_skip
+
+            iter.transformation, iter.skipper = trans, skip
+
+            create_match iter, ret
+        end
+    end
+
+end
+