001/*
002 * Copyright 2006 - 2013
003 *     Stefan Balev     <stefan.balev@graphstream-project.org>
004 *     Julien Baudry    <julien.baudry@graphstream-project.org>
005 *     Antoine Dutot    <antoine.dutot@graphstream-project.org>
006 *     Yoann Pigné      <yoann.pigne@graphstream-project.org>
007 *     Guilhelm Savin   <guilhelm.savin@graphstream-project.org>
008 * 
009 * This file is part of GraphStream <http://graphstream-project.org>.
010 * 
011 * GraphStream is a library whose purpose is to handle static or dynamic
012 * graph, create them from scratch, file or any source and display them.
013 * 
014 * This program is free software distributed under the terms of two licenses, the
015 * CeCILL-C license that fits European law, and the GNU Lesser General Public
016 * License. You can  use, modify and/ or redistribute the software under the terms
017 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
018 * URL <http://www.cecill.info> or under the terms of the GNU LGPL as published by
019 * the Free Software Foundation, either version 3 of the License, or (at your
020 * option) any later version.
021 * 
022 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
023 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
024 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
025 * 
026 * You should have received a copy of the GNU Lesser General Public License
027 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
028 * 
029 * The fact that you are presently reading this means that you have had
030 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
031 */
032package org.graphstream.util.parser;
033
034/**
035 * Describes the input token stream.
036 */
037
038public class Token implements java.io.Serializable {
039
040        /**
041         * The version identifier for this Serializable class. Increment only if the
042         * <i>serialized</i> form of the class changes.
043         */
044        private static final long serialVersionUID = 1L;
045
046        /**
047         * An integer that describes the kind of this token. This numbering system
048         * is determined by JavaCCParser, and a table of these numbers is stored in
049         * the file ...Constants.java.
050         */
051        public int kind;
052
053        /** The line number of the first character of this Token. */
054        public int beginLine;
055        /** The column number of the first character of this Token. */
056        public int beginColumn;
057        /** The line number of the last character of this Token. */
058        public int endLine;
059        /** The column number of the last character of this Token. */
060        public int endColumn;
061
062        /**
063         * The string image of the token.
064         */
065        public String image;
066
067        /**
068         * A reference to the next regular (non-special) token from the input
069         * stream. If this is the last token from the input stream, or if the token
070         * manager has not read tokens beyond this one, this field is set to null.
071         * This is true only if this token is also a regular token. Otherwise, see
072         * below for a description of the contents of this field.
073         */
074        public Token next;
075
076        /**
077         * This field is used to access special tokens that occur prior to this
078         * token, but after the immediately preceding regular (non-special) token.
079         * If there are no such special tokens, this field is set to null. When
080         * there are more than one such special token, this field refers to the last
081         * of these special tokens, which in turn refers to the next previous
082         * special token through its specialToken field, and so on until the first
083         * special token (whose specialToken field is null). The next fields of
084         * special tokens refer to other special tokens that immediately follow it
085         * (without an intervening regular token). If there is no such token, this
086         * field is null.
087         */
088        public Token specialToken;
089
090        /**
091         * An optional attribute value of the Token. Tokens which are not used as
092         * syntactic sugar will often contain meaningful values that will be used
093         * later on by the compiler or interpreter. This attribute value is often
094         * different from the image. Any subclass of Token that actually wants to
095         * return a non-null value can override this method as appropriate.
096         */
097        public Object getValue() {
098                return null;
099        }
100
101        /**
102         * No-argument constructor
103         */
104        public Token() {
105        }
106
107        /**
108         * Constructs a new token for the specified Image.
109         */
110        public Token(int kind) {
111                this(kind, null);
112        }
113
114        /**
115         * Constructs a new token for the specified Image and Kind.
116         */
117        public Token(int kind, String image) {
118                this.kind = kind;
119                this.image = image;
120        }
121
122        /**
123         * Returns the image.
124         */
125        public String toString() {
126                return image;
127        }
128
129        /**
130         * Returns a new Token object, by default. However, if you want, you can
131         * create and return subclass objects based on the value of ofKind. Simply
132         * add the cases to the switch for all those special cases. For example, if
133         * you have a subclass of Token called IDToken that you want to create if
134         * ofKind is ID, simply add something like :
135         * 
136         * case MyParserConstants.ID : return new IDToken(ofKind, image);
137         * 
138         * to the following switch statement. Then you can cast matchedToken
139         * variable to the appropriate type and use sit in your lexical actions.
140         */
141        public static Token newToken(int ofKind, String image) {
142                switch (ofKind) {
143                default:
144                        return new Token(ofKind, image);
145                }
146        }
147
148        public static Token newToken(int ofKind) {
149                return newToken(ofKind, null);
150        }
151
152}
153/*
154 * JavaCC - OriginalChecksum=0c00a7ff8fbeeb2312a89d5c1c4252da (do not edit this
155 * line)
156 */