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.spi.lexer;
043:
044: import org.netbeans.api.lexer.InputAttributes;
045: import org.netbeans.api.lexer.LanguagePath;
046: import org.netbeans.api.lexer.Token;
047: import org.netbeans.api.lexer.TokenId;
048:
049: /**
050: * Lexer restart info contains all the necessary information for restarting
051: * of a lexer mainly the lexer input, state and token factory.
052: *
053: * <p>
054: * When lexing embedded sections if {@link LanguageEmbedding#joinSections()}
055: * returns true then the {@link #state()} will return state after
056: * the last token of a corresponding previous section (with the same language path).
057: * </p>
058: *
059: * @author Miloslav Metelka
060: */
061:
062: public final class LexerRestartInfo<T extends TokenId> {
063:
064: private final LexerInput input;
065:
066: private final TokenFactory<T> tokenFactory;
067:
068: private final Object state;
069:
070: private final LanguagePath languagePath;
071:
072: private final InputAttributes inputAttributes;
073:
074: LexerRestartInfo(LexerInput input, TokenFactory<T> tokenFactory,
075: Object state, LanguagePath languagePath,
076: InputAttributes inputAttributes) {
077: this .input = input;
078: this .tokenFactory = tokenFactory;
079: this .state = state;
080: this .languagePath = languagePath;
081: this .inputAttributes = inputAttributes;
082: }
083:
084: /**
085: * Get lexer input from which the lexer should read characters.
086: */
087: public LexerInput input() {
088: return input;
089: }
090:
091: /**
092: * Get token factory through which the lexer should produce tokens.
093: */
094: public TokenFactory<T> tokenFactory() {
095: return tokenFactory;
096: }
097:
098: /**
099: * Get state from which the lexer should start lexing.
100: */
101: public Object state() {
102: return state;
103: }
104:
105: /**
106: * Get language path at which the lexer operates.
107: */
108: public LanguagePath languagePath() {
109: return languagePath;
110: }
111:
112: /**
113: * Get supplementary information about particular input source
114: * or null if there are no extra attributes.
115: */
116: public InputAttributes inputAttributes() {
117: return inputAttributes;
118: }
119:
120: /**
121: * Get value of an attribute or null if the attribute is not set
122: * or if there are no attributes at all.
123: */
124: public Object getAttributeValue(Object key) {
125: return (inputAttributes != null) ? inputAttributes.getValue(
126: languagePath, key) : null;
127: }
128:
129: }
|