rockit 0.7.1 → 0.7.2

data/rakefile

@@ -20,8 +20,9 @@ TODO_FILE = "TODO"
 RAKE_FILE = "rakefile"
 CHANGELOG = "Changelog"
 
+CLEAN.include("rockit_paper.pdf")
 
-task :default => :ptest
+task :default => [:ptest, :patest]
 
 
 #############################################################################
@@ -102,14 +103,15 @@ BaseFileToIncludeGlobs = [
     "README", "TODO", "BUGS", "LICENSE", "VERSION",
     "rakefile", "Manifest",
     "lib/packrat/**/*",
-    "lib/rockit/prettyprint/**/*",
-    "lib/rockit/tree/**/*",
-    "lib/util/**/*",
+    "doc/rockit_paper.pdf",
+    #"lib/rockit/prettyprint/**/*",
+    #"lib/rockit/tree/**/*",
+    #"lib/util/**/*",
 ]
 
 TestFilesToIncludeGlobs = [
-    "tests/acceptance/**/*", 
-    "tests/unit/**/*",
+    "tests/acceptance/packrat/**/*", 
+    "tests/unit/packrat/**/*",
 ]
 
 PkgFileGlobs = BaseFileToIncludeGlobs + TestFilesToIncludeGlobs
@@ -164,6 +166,17 @@ task :changelog do
   end
 end
 
+#############################################################################
+# Doc related
+#############################################################################
+task :gen_paper do
+  Dir.chdir("doc/rockit_paper") do
+    system "rake"
+    File.cp "rockit_paper.pdf", ".."
+    system "rake clobber"
+  end
+end
+
 #############################################################################
 # Rubyforge related
 #############################################################################
@@ -186,13 +199,18 @@ def delete_package(packageName)
 end
 
 # We use a temporary package name for now, should be PROJECT later...
-PACKAGE_NAME = "1799"  # if of the test package in rockit group
+#PACKAGE_NAME = "1801"  # if of the test package in rockit group
+PACKAGE_NAME = "368"  # Name of rockit package
+
+task :pack => [:gen_paper, :package]
 
 desc "Create package and release to rubyforge"
-task :rubyforge_release => [:package] do
+task :rubyforge_release => [:pack] do
+  puts "Logging in to rubyforge"
   system "rubyforge login"
+
   release_name = "#{PROJECT}-#{Version()}"
-  files_to_release = FileList["pkg/#{release_name}.*"]
+  files_to_release = FileList["pkg/#{release_name}.gem"]
   files_to_release.each do |file|
     puts "Releasing #{file} to Rubyforge"
     release_file(file, release_name, PACKAGE_NAME)

data/tests/acceptance/packrat/java/atest_java.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), "java")
+
+# We test the grammar in several logical "chunks" below with one TestCase 
+# for each logical chunk.
+
+class ATestJavaType < Test::Unit::TestCase
+  def assert_parse(exp, str, startSymbol)
+    res = Java::Parser.parse_string(str, startSymbol)
+    assert_equal(exp, res)
+  end
+
+  include Java::Grammar::ASTs
+
+  def test_01_resulttype_void
+    assert_parse([:ResultType, "void"], "void", :ResultType)
+    assert_parse([:ResultType, Type[[:TypeName, "byte"], nil]], 
+                 "byte", :ResultType)
+    assert_parse([:ResultType, Type[[:TypeName, "byte"], ["[]"]]], 
+                 "byte[]", :ResultType)
+    assert_parse([:ResultType, Type[[:TypeName, "short"], ["[]", "[]"]]], 
+                 "short[][]", :ResultType)
+  end
+
+  def test_02_symbols
+    # Note! We should make each grammar be its own class so that constants
+    # are defined within that scope!
+    JavaSymbols.each do |name, symbol_str|
+      assert_parse(symbol_str, symbol_str, :Symbol)
+    end
+  end
+
+  def test_03
+  end
+end
+

data/tests/acceptance/packrat/java/java.rb

@@ -0,0 +1,136 @@
+#############################################################################
+# Grammar for the programming language Java.
+# Author: Robert Feldt
+#
+# The grammar is based on the Java grammar from xtc which is accompanied by
+# the following license:
+#
+# xtc - The eXTensible Compiler
+# Copyright (C) 2004-2005 Robert Grimm, New York University
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+#############################################################################
+
+require 'packrat/grammar'
+
+module Java; end
+
+Java::Grammar = Packrat::Grammar.new do
+  start_symbol :CompilationUnit
+
+  ##########################
+  # Java type names
+  ##########################
+
+  rule( :ResultType,
+        ["void"],
+        [:Type]
+        )
+
+  prod :Type, [:TypeName, maybe(plus(:Dimension)), 
+               ast(:Type, :type_name => :type, 1 => :dimensions)]
+
+  BasicTypes = ["byte", "short", "char", "int", "long", "float", "double",
+                "boolean"]
+
+  rule( :TypeName,
+        [any(*BasicTypes)],
+        [:QualifiedIdentifier]
+        )
+
+  prod :Dimension, ["[]", lift(0)]
+
+  ##########################
+  # Java symbols
+  ##########################
+  
+  # Note, we do not use a Hash since we cannot guarantee what order the
+  # values will then be listed in => the shorter symbol strings might
+  # preceded the longer once and lead to too short matches ("!" match before
+  # "!=" when input is "!=" for example).
+  JavaSymbols = [
+    [:TripleGreaterEqual,  ">>>="],
+    [:GreaterGreaterEqual, ">>="],
+    [:LessLessEqual,       "<<="],
+    [:TripleGreater,       ">>>"],
+    [:GreaterGreater,      ">>"],
+    [:LessLess,            "<<"],
+    [:PlusEqual,           "+="],
+    [:MinusEqual,          "-="],
+    [:StarEqual,           "*="],
+    [:SlashEqual,          "/="],
+    [:PercentEqual,        "%="],
+    [:AmpersandEqual,      "&="],
+    [:CaretEqual,          "^="],
+    [:BarEqual,            "|="],
+    [:PlusPlus,            "++"],
+    [:MinusMinus,          "--"],
+    [:AmpersandAmpersand,  "&&"],
+    [:BarBar,              "||"],
+    [:LessEqual,           "<="],
+    [:GreaterEqual,        ">="],
+    [:EqualEqual,          "=="],
+    [:BangEqual,           "!="],
+    [:Semicolon,           ";"],
+    [:Colon,               ":"],
+    [:Comma,               "],"],
+    [:Period,              "."],
+    [:OpenBrace,           "{"],
+    [:CloseBrace,          "}"],
+    [:OpenParenthesis,     "("],
+    [:CloseParenthesis,    ")"],
+    [:OpenBracket,         "["],
+    [:CloseBracket,        "]"],
+    [:Bang,                "!"],
+    [:Tilde,               "~"],
+    [:Plus,                "+"],
+    [:Minus,               "-"],
+    [:Star,                "*"],
+    [:Slash,               "/"],
+    [:Percent,             "%"],
+    [:Less,                "<"],
+    [:Greater,             ">"],
+    [:Equal,               "="],
+    [:Ampersand,           "&"],
+    [:Caret,               "^"],
+    [:Bar,                 "|"],
+    [:Question,            "?"],
+    ]
+
+  SymbolCharacters = any(*JavaSymbols.map {|p| p.last})
+
+  prod :Symbol, [SymbolCharacters, :Spacing, lift(0)]
+
+  # Transient
+  rule( :Spacing, 
+        [:Space], 
+        #[:TraditionalComment], 
+        #[:EndOfLineComment], 
+        #[:LineTerminator], 
+        #[:EndOfFile]
+        [eos()]
+        )
+
+  prod :Space, [/ |\t|\f/]
+  #prod :TraditionalComment, [
+  #transient void Space              = ' ' / '\t' / '\f' ;
+  #transient void TraditionalComment = "/*" ( '*' !'/' / !'*' _ )* "*/" ;
+  #transient void EndOfLineComment   = "//" ( ![\n\r] _ )* LineTerminator ;
+  #transient void LineTerminator     = '\r' '\n' / '\r' / '\n' ;
+  #transient void EndOfFile          = !_ ;
+end
+
+Java::Parser = Java::Grammar.interpreting_parser

data/tests/acceptance/packrat/java/t.rb

@@ -0,0 +1,10 @@
+$DEBUG = true
+$: << "../../../../lib"
+require 'java'
+
+#str = "FOR A := 1 TO 3 S:= S + A PRINT S NEXT"
+str = "!="
+pa = Java::Grammar.interpreting_parser(Packrat::ErrorLoggingInterpretingParser)
+res = pa.parse_string(str, :Symbol)
+p res
+

data/tests/acceptance/packrat/java/todo

@@ -0,0 +1,10 @@
+Finished porting
+----------------
+JavaType
+JavaSymbol
+
+Left to do
+----------
+JavaIdentifier
+JavaConstant
+JavaCore

data/tests/acceptance/packrat/java/xtc.lang.java/Java.rats

@@ -0,0 +1,446 @@
+/*
+ * xtc - The eXTensible Compiler
+ * Copyright (C) 2004-2005 Robert Grimm
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ */
+
+/**
+ * Java grammar.
+ *
+ * @author Robert Grimm
+ * @version $Revision: 1.5 $
+ */
+module xtc.lang.Java;
+
+import xtc.lang.JavaIdentifier(xtc.lang.JavaSymbol, xtc.util.Spacing);
+instantiate xtc.util.Symbol(xtc.util.Spacing);
+import xtc.lang.JavaSymbol(xtc.util.Symbol);
+import xtc.util.Spacing;
+
+option withLocation, constant, parser(xtc.lang.JavaPackratParser);
+
+// ---------------------------------------------------------- Compilation Unit
+
+public transient void CompilationUnit =
+  Spacing
+  ( "package":Word QualifiedIdentifier ";":Symbol )?
+  ImportDeclaration*
+  Declaration*
+  '\u001a'?
+  EndOfFile
+  ;
+
+transient void ImportDeclaration =
+  "import":Word QualifiedIdentifier
+  ( ".":Symbol "*":Symbol )?
+  ";":Symbol
+  ;
+
+// ---------------------------------------------------------- Declarations
+
+void Modifier =
+    "public":Word
+  / "protected":Word
+  / "private":Word
+  / "static":Word
+  / "abstract":Word
+  / "final":Word
+  / "native":Word
+  / "synchronized":Word
+  / "transient":Word
+  / "volatile":Word
+  / "strictfp":Word
+  ;
+
+transient void FormalParameter =
+  ("final":Word)? Type Identifier Dimensions
+  ;
+
+void FormalParameters =
+    "(":Symbol FormalParameter ( ",":Symbol FormalParameter )* ")":Symbol
+  / "(":Symbol ")":Symbol
+  ;
+
+transient void Declarator =
+  Identifier Dimensions ( "=":Symbol VariableInitializer )?
+  ;
+
+void Declarators =
+  Declarator ( ",":Symbol Declarator )*
+  ;
+
+transient void ClassBody =
+  "{":Symbol Declaration* "}":Symbol
+  ;
+
+transient void Declaration =
+
+    // Field declaration.
+
+    Modifier* Type Declarators ";":Symbol
+
+    // Method declaration.
+
+  / Modifier*
+    ResultType Identifier FormalParameters Dimensions OptionalThrowsClause
+    ( Block / ";":Symbol )
+
+    // Constructor declaration.
+
+  / Modifier* Identifier FormalParameters OptionalThrowsClause Block
+
+    // Class declaration.
+
+  / Modifier* "class":Word Identifier
+    ( "extends":Word Type )?
+    ( "implements":Word Type ( ",":Symbol Type )* )?
+    ClassBody
+
+    // Interface declaration.
+
+  / Modifier* "interface":Word Identifier
+    ( "extends":Word Type ( ",":Symbol Type )* )?
+    ClassBody
+
+    // Initialization block.
+
+  / ( "static":Word / /* Empty */ )
+    Block
+  ;
+
+void OptionalThrowsClause =
+  "throws":Word QualifiedIdentifier ( ",":Symbol QualifiedIdentifier )*
+  / /* Empty */
+  ;
+
+// ---------------------------------------------------------- Statements
+
+void Block =
+  "{":Symbol BlockStatement* "}":Symbol
+  ;
+
+transient void BlockStatement =
+    Declaration
+  / Statement
+  ;
+
+transient void Statement =
+    Block
+  / "if":Word ParExpression Statement ( "else":Word Statement )?
+  / "for":Word "(":Symbol
+      ForInit ";":Symbol
+      Expression? ";":Symbol
+      ExpressionList? ")":Symbol Statement
+  / "while":Word ParExpression Statement
+  / "do":Word Statement "while":Word ParExpression ";":Symbol
+  / "try":Word Block CatchClause* "finally":Word Block
+  / "try":Word Block CatchClause+
+  / "switch":Word ParExpression "{":Symbol SwitchGroup* "}":Symbol
+  / "synchronized":Word ParExpression Block
+  / "return":Word Expression? ";":Symbol
+  / "throw":Word Expression ";":Symbol
+  / "break":Word Identifier? ";":Symbol
+  / "continue":Word Identifier? ";":Symbol
+  / Identifier ":":Symbol Statement
+  / Expression ";":Symbol
+  / ";":Symbol
+  ;
+
+transient void ParExpression =
+  "(":Symbol Expression ")":Symbol
+  ;
+
+void ForInit =
+    ("final":Word)? Type Declarators
+  / ExpressionList
+  / /* Empty */
+  ;
+
+void CatchClause =
+  "catch":Word "(":Symbol FormalParameter ")":Symbol Block
+  ;
+
+void SwitchGroup =
+    "case":Word Expression ":":Symbol BlockStatement*
+  / "default":Word ":":Symbol BlockStatement*
+  ;
+
+// ---------------------------------------------------------- Expressions
+
+transient void ExpressionList =
+  Expression ( ",":Symbol Expression )*
+  ;
+
+void Expression =
+    <Assignment> ConditionalExpression AssignmentOperator Expression
+  / <Base>       ConditionalExpression
+  ;
+
+void AssignmentOperator =
+    "=":Symbol
+  / "+=":Symbol
+  / "-=":Symbol
+  / "*=":Symbol
+  / "/=":Symbol
+  / "&=":Symbol
+  / "|=":Symbol
+  / "^=":Symbol
+  / "%=":Symbol
+  / "<<=":Symbol
+  / ">>=":Symbol
+  / ">>>=":Symbol
+  ;
+
+void ConditionalExpression =
+    <Conditional> ConditionalOrExpression "?":Symbol Expression 
+                                          ":":Symbol ConditionalExpression
+  / <Base> ConditionalOrExpression
+  ;
+
+void ConditionalOrExpression =
+    <Or>   ConditionalOrExpression "||":Symbol ConditionalAndExpression
+  / <Base> ConditionalAndExpression
+  ;
+
+transient void ConditionalAndExpression =
+    <And>  ConditionalAndExpression "&&":Symbol InclusiveOrExpression
+  / <Base> InclusiveOrExpression
+  ;
+
+transient void InclusiveOrExpression =
+    <Or>   InclusiveOrExpression "|":Symbol ExclusiveOrExpression
+  / <Base> ExclusiveOrExpression
+  ;
+
+transient void ExclusiveOrExpression =
+    <Xor>  ExclusiveOrExpression "^":Symbol AndExpression
+  / <Base> AndExpression
+  ;
+
+transient void AndExpression =
+    <And>  AndExpression "&":Symbol EqualityExpression
+  / <Base> EqualityExpression
+  ;
+
+transient void EqualityExpression =
+    <Equal>    EqualityExpression "==":Symbol InstanceOfExpression
+  / <NotEqual> EqualityExpression "!=":Symbol InstanceOfExpression
+  / <Base>     InstanceOfExpression
+  ;
+
+transient void InstanceOfExpression =
+    RelationalExpression "instanceof":Word Type
+  / RelationalExpression
+  ;
+
+void RelationalExpression =
+    <Less>       RelationalExpression "<":Symbol ShiftExpression
+  / <Greater>    RelationalExpression ">":Symbol ShiftExpression
+  / <LessEqual>  RelationalExpression "<=":Symbol ShiftExpression
+  / <GreatEqual> RelationalExpression ">=":Symbol ShiftExpression
+  / <Base>       ShiftExpression
+  ;
+
+transient void ShiftExpression =
+    <SignedLeft>    ShiftExpression "<<":Symbol AdditiveExpression
+  / <SignedRigth>   ShiftExpression ">>":Symbol AdditiveExpression
+  / <UnsignedRight> ShiftExpression ">>>":Symbol AdditiveExpression
+  / <Base>          AdditiveExpression
+  ;
+
+transient void AdditiveExpression =
+    <Plus>  AdditiveExpression "+":Symbol MultiplicativeExpression
+  / <Minus> AdditiveExpression "-":Symbol MultiplicativeExpression
+  / <Base>  MultiplicativeExpression
+  ;
+
+transient void MultiplicativeExpression =
+    <Times>  MultiplicativeExpression "*":Symbol UnaryExpression
+  / <Over>   MultiplicativeExpression "/":Symbol UnaryExpression
+  / <Modulo> MultiplicativeExpression "%":Symbol UnaryExpression
+  / <Base>   UnaryExpression
+  ;
+
+transient void UnaryExpression =
+    <Plus>      "+":Symbol UnaryExpression
+  / <Minus>     "-":Symbol UnaryExpression
+  / <Increment> "++":Symbol UnaryExpression
+  / <Decrement> "--":Symbol UnaryExpression
+  / <Base>      UnaryExpressionNotPlusMinus
+  ;
+
+transient void UnaryExpressionNotPlusMinus =
+    <BitwiseNot> "~":Symbol UnaryExpression
+  / <LogicalNot> "!":Symbol UnaryExpression
+  / <BasicCast>  "(":Symbol BasicType Dimensions ")":Symbol UnaryExpression
+  / <Cast>       "(":Symbol Type ")":Symbol UnaryExpressionNotPlusMinus
+  / <Base>       PostfixExpression
+  ;
+
+void PostfixExpression =
+  PrimaryExpression PostfixExpressionTail*
+  ;
+
+void PostfixExpressionTail =
+    "[":Symbol Expression? "]":Symbol
+  / Arguments
+  / ".":Symbol PrimaryExpression
+  / ".":Symbol "class":Word
+  / "++":Symbol
+  / "--":Symbol
+  ;
+
+transient void PrimaryExpression =
+    Literal
+  / Identifier
+  / "(":Symbol Expression ")":Symbol
+  / "this":Word
+  / "super":Word
+  / "new":Word QualifiedIdentifier Arguments ClassBody?
+  / "new":Word TypeName DimensionExpression+ Dimensions
+  / "new":Word TypeName Dimensions ArrayInitializer
+  / "void":Word ".":Symbol "class":Word
+  ;
+
+transient void DimensionExpression =
+  "[":Symbol Expression "]":Symbol
+  ;
+
+transient void Arguments =
+    "(":Symbol ExpressionList ")":Symbol
+  / "(":Symbol ")":Symbol
+  ;
+
+transient void ArrayInitializer =
+    "{":Symbol
+      ( VariableInitializer ",":Symbol )*
+    "}":Symbol
+  / "{":Symbol
+      VariableInitializer
+      ( ",":Symbol VariableInitializer )*
+    "}":Symbol
+  ;
+
+void VariableInitializer =
+    ArrayInitializer
+  / Expression
+  ;
+
+// ---------------------------------------------------------- Types
+
+void ResultType =
+    "void":Word
+  / Type
+  ;
+
+void Type =
+  TypeName Dimensions
+  ;
+
+void TypeName =
+    BasicType
+  / QualifiedIdentifier
+  ;
+
+void BasicType =
+    "byte":Word
+  / "short":Word
+  / "char":Word
+  / "int":Word
+  / "long":Word
+  / "float":Word
+  / "double":Word
+  / "boolean":Word
+  ;
+
+void Dimensions =
+  ( "[":Symbol "]":Symbol )*
+  ;
+
+// ---------------------------------------------------------- Literals
+
+String Literal =
+    FloatingPointLiteral Spacing
+  / IntegerLiteral Spacing
+  / CharacterLiteral Spacing
+  / StringLiteral Spacing
+  / BooleanLiteral
+  / NullLiteral
+  ;
+
+// ----- Integer literals
+
+String IntegerLiteral =
+    HexNumeral     IntegerTypeSuffix? 
+  / OctalNumeral   IntegerTypeSuffix?
+  / DecimalNumeral IntegerTypeSuffix?
+  ;
+
+transient String DecimalNumeral    = '0' / NonZeroDigit Digit* ;
+transient String NonZeroDigit      = [1-9] ;
+transient String Digit             = [0-9] ;
+
+transient String HexNumeral        = '0' [xX] HexDigit+ ;
+transient String HexDigit          = [0-9a-fA-F] ;
+
+transient String OctalNumeral      = '0' OctalDigit+ ;
+transient String OctalDigit        = [0-7] ;
+
+transient String IntegerTypeSuffix = [lL] ;
+
+// ----- Floating point literals
+
+String FloatingPointLiteral =
+    Digit+ '.' Digit* Exponent? FloatTypeSuffix?
+  /        '.' Digit+ Exponent? FloatTypeSuffix?
+  / Digit+            Exponent  FloatTypeSuffix?
+  / Digit+            Exponent? FloatTypeSuffix
+  ;
+
+transient String Exponent        = [eE] [+\-]? Digit+ ;
+transient String FloatTypeSuffix = [fFdD] ;
+
+// ----- Character and string literals
+
+String CharacterLiteral = ['] ( EscapeSequence / !['\\] _ )  ['] ;
+String StringLiteral    = ["] ( EscapeSequence / !["\\] _ )* ["] ;
+
+transient String EscapeSequence =
+  '\\' [btnfr"'\\] / UnicodeEscape / OctalEscape ;
+
+transient String OctalEscape    =
+  '\\' [0-3] OctalDigit OctalDigit
+  / '\\' OctalDigit OctalDigit
+  / '\\' OctalDigit
+  ;
+
+transient String UnicodeEscape  =
+  '\\' 'u' HexDigit HexDigit HexDigit HexDigit ;
+
+// ----- Boolean literals
+
+String BooleanLiteral =
+    "true":Word
+  / "false":Word
+  ;
+
+// ----- Null literals
+
+String NullLiteral =
+  "null":Word
+  ;
+
+// ============================================================================