001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.cnd.apt.structure;
043:
044: import antlr.Token;
045:
046: /**
047: * Abstract Preprocessing Tree
048: * LISP-like trees:
049: * ROOT
050: * |
051: * Child1-Child2
052: *
053: * the original idea is antlr.AST approach, but no setters => immutable =>
054: * could be used at the same time by multiple APT Visitors.
055: *
056: * @author Vladimir Voskresensky
057: */
058: public interface APT {
059: public interface Type {
060: public static final int INVALID = 0;
061: public static final int FILE = INVALID + 1;
062: public static final int TOKEN_STREAM = FILE + 1;
063: public static final int INCLUDE = TOKEN_STREAM + 1;
064: public static final int INCLUDE_NEXT = INCLUDE + 1;
065: public static final int DEFINE = INCLUDE_NEXT + 1;
066: public static final int UNDEF = DEFINE + 1;
067: public static final int CONDITION_CONTAINER = UNDEF + 1;
068: public static final int IFDEF = CONDITION_CONTAINER + 1;
069: public static final int IFNDEF = IFDEF + 1;
070: public static final int IF = IFNDEF + 1;
071: public static final int ELIF = IF + 1;
072: public static final int ELSE = ELIF + 1;
073: public static final int ENDIF = ELSE + 1;
074: public static final int PRAGMA = ENDIF + 1;
075: public static final int LINE = PRAGMA + 1;
076: public static final int ERROR = LINE + 1;
077: public static final int PREPROC_UNKNOWN = ERROR + 1; // unrecognized #-directive
078: }
079:
080: /** method called consequently token by token to let APT node to init itself
081: * when initializing is finished APT node returns false (not accepted token)
082: */
083: public boolean accept(Token token);
084:
085: /** Get the associated token */
086: public Token getToken();
087:
088: /** dispose **/
089: public void dispose();
090:
091: // /** Add a (rightmost) child to this node */
092: // public void addChild(APT child);
093:
094: /** Get the first child of this node; null if no children */
095: public APT getFirstChild();
096:
097: /** Get the next sibling in line after this one */
098: public APT getNextSibling();
099:
100: /** Get the token text for this node */
101: public String getText();
102:
103: /** Get the type for this node */
104: public int/*Type*/getType();
105:
106: /** Get start offset of the node's first wrapped token */
107: public int getOffset();
108:
109: /** Get end offset of the node's last wrapped token */
110: public int getEndOffset();
111:
112: // /** Need for error handling */
113: // public int getLine();
114: //
115: // /** Need for error handling */
116: // public int getColumn();
117:
118: // /** Get number of children of this node; if leaf, returns 0 */
119: // public int getNumberOfChildren();
120:
121: /** Set the first child of a node. */
122: public void setFirstChild(APT child);
123:
124: /** Set the next sibling after this one. */
125: public void setNextSibling(APT next);
126: //
127: // /** Set the token text for this node */
128: // public void setText(String text);
129: //
130: // /** Set the type for this node */
131: // public void setType(int/*Type*/ type);
132:
133: // public String toString();
134:
135: // public String toStringList();
136: //
137: // public String toStringTree();
138:
139: }
|