--- /dev/null
+/** \file\r
+ * Abstraction of Common tree to provide payload and string representation of node.\r
+ *\r
+ * \todo May not need this in the end\r
+ */\r
+\r
+#ifndef ANTLR3_PARSETREE_H\r
+#define ANTLR3_PARSETREE_H\r
+\r
+// [The "BSD licence"]\r
+// Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC\r
+// http://www.temporal-wave.com\r
+// http://www.linkedin.com/in/jimidle\r
+//\r
+// All rights reserved.\r
+//\r
+// Redistribution and use in source and binary forms, with or without\r
+// modification, are permitted provided that the following conditions\r
+// are met:\r
+// 1. Redistributions of source code must retain the above copyright\r
+// notice, this list of conditions and the following disclaimer.\r
+// 2. Redistributions in binary form must reproduce the above copyright\r
+// notice, this list of conditions and the following disclaimer in the\r
+// documentation and/or other materials provided with the distribution.\r
+// 3. The name of the author may not be used to endorse or promote products\r
+// derived from this software without specific prior written permission.\r
+//\r
+// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR\r
+// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
+// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.\r
+// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,\r
+// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
+// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
+// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
+\r
+#include <antlr3basetree.h>\r
+\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+typedef struct ANTLR3_PARSE_TREE_struct\r
+{\r
+ /** Any interface that implements methods in this interface\r
+ * may need to point back to itself using this pointer to its\r
+ * super structure.\r
+ */\r
+ void * super;\r
+\r
+ /** The payload that the parse tree node passes around\r
+ */\r
+ void * payload;\r
+\r
+ /** An encapsulated BASE TREE strcuture (NOT a pointer)\r
+ * that perfoms a lot of the dirty work of node management\r
+ */\r
+ ANTLR3_BASE_TREE baseTree;\r
+\r
+ /** How to dup this node\r
+ */\r
+ pANTLR3_BASE_TREE (*dupNode) (struct ANTLR3_PARSE_TREE_struct * tree);\r
+\r
+ /** Return the type of this node\r
+ */\r
+ ANTLR3_UINT32 (*getType) (struct ANTLR3_PARSE_TREE_struct * tree);\r
+\r
+ /** Return the string representation of the payload (must be installed\r
+ * when the payload is added and point to a function that knwos how to \r
+ * manifest a pANTLR3_STRING from a node.\r
+ */\r
+ pANTLR3_STRING (*toString) (struct ANTLR3_PARSE_TREE_struct * payload);\r
+\r
+ void (*free) (struct ANTLR3_PARSE_TREE_struct * tree);\r
+\r
+}\r
+ ANTLR3_PARSE_TREE;\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+\r
+#endif\r