01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.gsf.api;
43:
44: import java.util.Collection;
45: import org.netbeans.modules.gsf.api.annotations.CheckForNull;
46: import org.netbeans.modules.gsf.api.annotations.NonNull;
47: import org.netbeans.api.lexer.Language;
48: import org.openide.filesystems.FileObject;
49:
50: /**
51: * Lexical information for a given language.
52: *
53: * @author <a href="mailto:tor.norbye@sun.com">Tor Norbye</a>
54: */
55: public interface GsfLanguage {
56: /**
57: * <p>Return the prefix used for line comments in this language, or null if this language
58: * does not have a line comment. As an example, a Java scanner would return <code>//</code>,
59: * a Ruby scanner would return <code>#</code>, a Visual Basic scanner would return <code>'</code>, etc.
60: * </p>
61: */
62: @CheckForNull
63: String getLineCommentPrefix();
64:
65: /**
66: * <p>Return true iff the given character is considered to be an identifier character. This
67: * is used for example when the user double clicks in the editor to select a "word" or identifier
68: * by checking to the left and to the right of the caret position and selecting until a character
69: * is not considered an identifier char by the scanner.
70: * </p>
71: * <p>
72: * For a language like Java, just return Character.isJavaIdentifierPart(). For something like
73: * Ruby, we also want to include "@" and "$" such that double clicking on a global variable
74: * for example will include the global prefix "$".
75: */
76: boolean isIdentifierChar(char c);
77:
78: /**
79: * <p>Return the Lexer Language associated with this scanner
80: *</p>
81: */
82: @NonNull
83: Language getLexerLanguage();
84:
85: /**
86: * Return a set of file object folders for core libraries for this language that should be added
87: * to the indexing and querying paths.
88: */
89: Collection<FileObject> getCoreLibraries();
90: }
|