antlr3basetree.h

antlr最新版本V3源代码

/** \file
 * Definition of the ANTLR3 base tree.
 */

#ifndef	_ANTLR3_BASE_TREE_H
#define	_ANTLR3_BASE_TREE_H

#include    <antlr3defs.h>
#include    <antlr3collections.h>
#include    <antlr3string.h>

/** A generic tree implementation with no payload.  You must subclass to
 *  actually have any user data.  ANTLR v3 uses a list of children approach
 *  instead of the child-sibling approach in v2.  A flat tree (a list) is
 *  an empty node whose children represent the list.  An empty, but
 *  non-null node is called "nil".
 */
typedef	struct ANTLR3_BASE_TREE_struct
{

    /** Implementors of this interface sometimes require a pointer to theirselves.
     */
    void    *	    super;

    /** Generic void pointer allows the grammar programmer to attach any structure they
     *  like to a tree node, in many cases saving the need to create their own tree
     *  and tree adaptors. ANTLR does not use this poituner, but will copy it for you and so on.
     */
    void    *	    u;

    /** The list of all the children that belong to this node. They are not part of the node
     *  as they belong to the common tree node that implements this.
     */
    pANTLR3_VECTOR  children;

    /** This is used to store teh current child index position while descending
     *  and ascending trees as the tree walk progresses.
     */
    ANTLR3_UINT64   savedIndex;

    /** A string factory to produce strings for toString etc
     */
    pANTLR3_STRING_FACTORY strFactory;

    void	    (*addChild)		(struct ANTLR3_BASE_TREE_struct * tree, void * child);

    void	    (*addChildren)	(struct ANTLR3_BASE_TREE_struct * tree, pANTLR3_LIST kids);

    void    	    (*createChildrenList)
					(struct ANTLR3_BASE_TREE_struct * tree);

    void    *	    (*deleteChild)	(struct ANTLR3_BASE_TREE_struct * tree, ANTLR3_UINT64 i);

    void    *	    (*dupNode)		(struct ANTLR3_BASE_TREE_struct * dupNode);

    void    *	    (*dupTree)		(struct ANTLR3_BASE_TREE_struct * tree);

    ANTLR3_UINT32   (*getCharPositionInLine)
					(struct ANTLR3_BASE_TREE_struct * tree);

    void    *	    (*getChild)		(struct ANTLR3_BASE_TREE_struct * tree, ANTLR3_UINT64 i);

    ANTLR3_UINT64   (*getChildCount)	(struct ANTLR3_BASE_TREE_struct * tree);

    ANTLR3_UINT32   (*getType)		(struct ANTLR3_BASE_TREE_struct * tree);

    void    *	    (*getFirstChildWithType)
					(struct ANTLR3_BASE_TREE_struct * tree, ANTLR3_UINT32 type);

    ANTLR3_UINT64   (*getLine)		(struct ANTLR3_BASE_TREE_struct * tree);

    pANTLR3_STRING  (*getText)		(struct ANTLR3_BASE_TREE_struct * tree);

    ANTLR3_BOOLEAN  (*isNil)		(struct ANTLR3_BASE_TREE_struct * tree);

    void	    (*setChild)		(struct ANTLR3_BASE_TREE_struct * tree, ANTLR3_UINT64 i, void * child);

    pANTLR3_STRING  (*toStringTree)	(struct ANTLR3_BASE_TREE_struct * tree);

    pANTLR3_STRING  (*toString)		(struct ANTLR3_BASE_TREE_struct * tree);

    void    	    (*free)		(struct ANTLR3_BASE_TREE_struct * tree);

}
    ANTLR3_BASE_TREE;

#endif