Added AbstractExpression and TreeRenderer.

pom.xml

@@ -3,7 +3,7 @@
 
     <groupId>co.icecave</groupId>
     <artifactId>dialekt</artifactId>
-    <version>0.1.0</version>
+    <version>0.2.0</version>
     <packaging>jar</packaging>
 
     <name>Dialekt</name>
@@ -34,6 +34,12 @@
     </properties>
 
     <dependencies>
+        <dependency>
+            <groupId>org.json</groupId>
+            <artifactId>json</artifactId>
+            <version>20140107</version>
+        </dependency>
+
         <dependency>
             <groupId>org.testng</groupId>
             <artifactId>testng</artifactId>

src/main/java/co/icecave/dialekt/ast/AbstractExpression.java

@@ -0,0 +1,44 @@
+package co.icecave.dialekt.ast;
+
+import co.icecave.dialekt.parser.Token;
+
+/**
+ * A base class providing common functionality for expressions.
+ */
+public abstract class AbstractExpression implements ExpressionInterface
+{
+    /**
+     * Fetch the first token from the source that is part of this expression.
+     *
+     * @return The first token from this expression.
+     */
+    public Token firstToken()
+    {
+        return this.firstToken;
+    }
+
+    /**
+     * Fetch the last token from the source that is part of this expression.
+     *
+     * @return The last token from this expression.
+     */
+    public Token lastToken()
+    {
+        return this.lastToken;
+    }
+
+    /**
+     * Set the delimiting tokens for this expression.
+     *
+     * @param firstToken The first token from this expression.
+     * @param lastToken  The last token from this expression.
+     */
+    public void setTokens(Token firstToken, Token lastToken)
+    {
+        this.firstToken = firstToken;
+        this.lastToken = lastToken;
+    }
+
+    private Token firstToken;
+    private Token lastToken;
+}

src/main/java/co/icecave/dialekt/ast/AbstractPolyadicOperator.java → src/main/java/co/icecave/dialekt/ast/AbstractPolyadicExpression.java

@@ -7,12 +7,12 @@
 /**
  * A base class providing common functionality for polyadic operators.
  */
-public abstract class AbstractPolyadicOperator implements ExpressionInterface
+public abstract class AbstractPolyadicExpression extends AbstractExpression
 {
     /**
      * @param child,... One or more children to add to this operator.
      */
-    public AbstractPolyadicOperator(ExpressionInterface... children)
+    public AbstractPolyadicExpression(ExpressionInterface... children)
     {
         this.children = new ArrayList<ExpressionInterface>(
             Arrays.asList(children)

src/main/java/co/icecave/dialekt/ast/EmptyExpression.java

@@ -3,7 +3,7 @@
 /**
  * An AST node that represents the logical OR operator.
  */
-public class EmptyExpression implements ExpressionInterface
+public class EmptyExpression extends AbstractExpression
 {
     /**
      * Pass this node to the appropriate method on the given visitor.

src/main/java/co/icecave/dialekt/ast/ExpressionInterface.java

@@ -1,10 +1,25 @@
 package co.icecave.dialekt.ast;
 
+import co.icecave.dialekt.parser.Token;
+
 /**
  * An AST node that is an expression.
  *
  * Not all nodes in the tree represent an entire (sub-)expression.
  */
 public interface ExpressionInterface extends NodeInterface
 {
+    /**
+     * Fetch the first token from the source that is part of this expression.
+     *
+     * @return The first token from this expression.
+     */
+    public Token firstToken();
+
+    /**
+     * Fetch the last token from the source that is part of this expression.
+     *
+     * @return The last token from this expression.
+     */
+    public Token lastToken();
 }

src/main/java/co/icecave/dialekt/ast/LogicalAnd.java

@@ -3,7 +3,7 @@
 /**
  * An AST node that represents the logical OR operator.
  */
-public class LogicalAnd extends AbstractPolyadicOperator
+public class LogicalAnd extends AbstractPolyadicExpression
 {
     /**
      * @param child,... One or more children to add to this operator.

src/main/java/co/icecave/dialekt/ast/LogicalNot.java

@@ -3,7 +3,7 @@
 /**
  * An AST node that represents the logical NOT operator.
  */
-public class LogicalNot implements ExpressionInterface
+public class LogicalNot extends AbstractExpression
 {
     /**
      * @param child The expression being inverted by the NOT operator.

src/main/java/co/icecave/dialekt/ast/LogicalOr.java

@@ -3,7 +3,7 @@
 /**
  * An AST node that represents the logical OR operator.
  */
-public class LogicalOr extends AbstractPolyadicOperator
+public class LogicalOr extends AbstractPolyadicExpression
 {
     /**
      * @param child,... One or more children to add to this operator.

src/main/java/co/icecave/dialekt/ast/Pattern.java

@@ -6,7 +6,7 @@
 /**
  * An AST node that represents a pattern-match expression.
  */
-public class Pattern implements ExpressionInterface
+public class Pattern extends AbstractExpression
 {
     /**
      * @param child,... One or more children to add to this operator.

src/main/java/co/icecave/dialekt/ast/Tag.java

@@ -3,7 +3,7 @@
 /**
  * An AST node that represents a literal tag expression.
  */
-public class Tag implements ExpressionInterface
+public class Tag extends AbstractExpression
 {
     /**
      * @param name The tag name.

src/main/java/co/icecave/dialekt/parser/Token.java

@@ -0,0 +1,56 @@
+package co.icecave.dialekt.parser;
+
+public class Token
+{
+    // const WILDCARD_CHARACTER = '*';
+
+    // const LOGICAL_AND   = 1;
+    // const LOGICAL_OR    = 2;
+    // const LOGICAL_NOT   = 3;
+    // const STRING        = 4;
+    // const OPEN_BRACKET  = 6;
+    // const CLOSE_BRACKET = 7;
+
+    // public function __construct(
+    //     $type,
+    //     $value,
+    //     $startOffset,
+    //     $endOffset,
+    //     $lineNumber,
+    //     $columnNumber
+    // ) {
+    //     $this->type = $type;
+    //     $this->value = $value;
+    //     $this->startOffset = $startOffset;
+    //     $this->endOffset = $endOffset;
+    //     $this->lineNumber = $lineNumber;
+    //     $this->columnNumber = $columnNumber;
+    // }
+
+    // public static function typeDescription($type)
+    // {
+    //     switch ($type) {
+    //         case self::LOGICAL_AND:
+    //             return 'AND operator';
+    //         case self::LOGICAL_OR:
+    //             return 'OR operator';
+    //         case self::LOGICAL_NOT:
+    //             return 'NOT operator';
+    //         case self::STRING:
+    //             return 'tag';
+    //         case self::OPEN_BRACKET:
+    //             return 'open bracket';
+    //         case self::CLOSE_BRACKET:
+    //             return 'close bracket';
+    //     };
+
+    //     throw new LogicException('Unknown type.');
+    // }
+
+    // public $type;
+    // public $value;
+    // public $startOffset;
+    // public $endOffset;
+    // public $lineNumber;
+    // public $columnNumber;
+}

src/main/java/co/icecave/dialekt/renderer/ExpressionRenderer.java

@@ -17,7 +17,7 @@
 /**
  * Interface for node visitors.
  */
-public class ExpressionRenderer implements VisitorInterface<String>
+public class ExpressionRenderer implements RendererInterface, VisitorInterface<String>
 {
     public ExpressionRenderer()
     {
@@ -47,6 +47,8 @@ public String render(ExpressionInterface expression)
     /**
      * Visit a LogicalAnd node.
      *
+     * @internal
+     *
      * @param node The node to visit.
      */
     public String visit(LogicalAnd node)
@@ -57,6 +59,8 @@ public String visit(LogicalAnd node)
     /**
      * Visit a LogicalOr node.
      *
+     * @internal
+     *
      * @param node The node to visit.
      */
     public String visit(LogicalOr node)
@@ -67,6 +71,8 @@ public String visit(LogicalOr node)
     /**
      * Visit a LogicalNot node.
      *
+     * @internal
+     *
      * @param node The node to visit.
      */
     public String visit(LogicalNot node)
@@ -77,6 +83,8 @@ public String visit(LogicalNot node)
     /**
      * Visit a Tag node.
      *
+     * @internal
+     *
      * @param node The node to visit.
      */
     public String visit(Tag node)
@@ -87,6 +95,8 @@ public String visit(Tag node)
     /**
      * Visit a pattern node.
      *
+     * @internal
+     *
      * @param node The node to visit.
      */
     public String visit(Pattern node)
@@ -103,6 +113,8 @@ public String visit(Pattern node)
     /**
      * Visit a PatternLiteral node.
      *
+     * @internal
+     *
      * @param node The node to visit.
      *
      * @throws RenderException if the literal string contains the wildcard character.
@@ -125,6 +137,8 @@ public String visit(PatternLiteral node)
     /**
      * Visit a PatternWildcard node.
      *
+     * @internal
+     *
      * @param node The node to visit.
      */
     public String visit(PatternWildcard node)
@@ -135,6 +149,8 @@ public String visit(PatternWildcard node)
     /**
      * Visit a EmptyExpression node.
      *
+     * @internal
+     *
      * @param node The node to visit.
      */
     public String visit(EmptyExpression node)

src/main/java/co/icecave/dialekt/renderer/RendererInterface.java

@@ -0,0 +1,15 @@
+package co.icecave.dialekt.renderer;
+
+import co.icecave.dialekt.ast.ExpressionInterface;
+
+public interface RendererInterface
+{
+    /**
+     * Render an expression to a string.
+     *
+     * @param expression The expression to render.
+     *
+     * @return The rendered expression.
+     */
+    public String render(ExpressionInterface expression);
+}