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.completion.cplusplus.hyperlink;
043:
044: import javax.swing.text.JTextComponent;
045: import org.netbeans.editor.BaseDocument;
046: import org.netbeans.modules.cnd.api.model.CsmFile;
047: import org.netbeans.modules.cnd.api.model.CsmInclude;
048: import org.netbeans.modules.cnd.api.model.CsmOffsetable;
049: import org.netbeans.modules.cnd.completion.cplusplus.utils.Token;
050: import org.netbeans.modules.cnd.completion.impl.xref.ReferencesSupport;
051: import org.netbeans.modules.cnd.editor.cplusplus.CCTokenContext;
052: import org.netbeans.modules.cnd.modelutil.CsmUtilities;
053:
054: /**
055: * Implementation of the hyperlink provider for java language.
056: * <br>
057: * The hyperlinks are constructed for #include directives.
058: * <br>
059: * The click action corresponds to performing the open file action.
060: *
061: * @author Vladimir Voskresensky
062: */
063: public class CsmIncludeHyperlinkProvider extends
064: CsmAbstractHyperlinkProvider {
065: private static final boolean NEED_TO_TRACE_UNRESOLVED_INCLUDE = getBoolean(
066: "cnd.modelimpl.trace.failed.include", false);
067:
068: /** Creates a new instance of CsmIncludeHyperlinkProvider */
069: public CsmIncludeHyperlinkProvider() {
070: }
071:
072: protected boolean isValidToken(Token token) {
073: return isSupportedToken(token);
074: }
075:
076: public static boolean isSupportedToken(Token token) {
077: if ((token != null)
078: && ((token.getTokenID() == CCTokenContext.SYS_INCLUDE)
079: || (token.getTokenID() == CCTokenContext.USR_INCLUDE)
080: || (token.getTokenID() == CCTokenContext.CPPINCLUDE) || (token
081: .getTokenID() == CCTokenContext.CPPINCLUDE_NEXT))) {
082: return true;
083: } else {
084: return false;
085: }
086: }
087:
088: protected void performAction(final BaseDocument originalDoc,
089: final JTextComponent target, final int offset) {
090: goToInclude(originalDoc, target, offset);
091: }
092:
093: public boolean goToInclude(BaseDocument doc, JTextComponent target,
094: int offset) {
095: if (!preJump(doc, target, offset, "opening-include-element")) { //NOI18N
096: return false;
097: }
098: CsmOffsetable item = findTargetObject(doc, offset);
099: return postJump(item, "goto_source_source_not_found",
100: "cannot-open-include-element"); //NOI18N
101: }
102:
103: /*package*/CsmOffsetable findTargetObject(final BaseDocument doc,
104: final int offset) {
105: CsmInclude incl = findInclude(doc, offset);
106: CsmOffsetable item = incl == null ? null : new IncludeTarget(
107: incl);
108: if (incl != null && NEED_TO_TRACE_UNRESOLVED_INCLUDE
109: && incl.getIncludeFile() == null) {
110: System.setProperty("cnd.modelimpl.trace.trace_now", "yes"); //NOI18N
111: try {
112: incl.getIncludeFile();
113: } finally {
114: System.setProperty("cnd.modelimpl.trace.trace_now",
115: "no"); //NOI18N
116: }
117: }
118: return item;
119: }
120:
121: private CsmInclude findInclude(BaseDocument doc, int offset) {
122: CsmFile csmFile = CsmUtilities.getCsmFile(doc, true);
123: if (csmFile != null) {
124: return ReferencesSupport.findInclude(csmFile, offset);
125: }
126: return null;
127: }
128:
129: private static boolean getBoolean(String name, boolean result) {
130: String text = System.getProperty(name);
131: if (text != null) {
132: result = Boolean.parseBoolean(text);
133: }
134: return result;
135: }
136:
137: private static final class IncludeTarget implements CsmOffsetable {
138: private CsmInclude include;
139:
140: public IncludeTarget(CsmInclude include) {
141: this .include = include;
142: }
143:
144: public CsmFile getContainingFile() {
145: return include.getIncludeFile();
146: }
147:
148: public int getStartOffset() {
149: // start of the file
150: return DUMMY_POSITION.getOffset();
151: }
152:
153: public int getEndOffset() {
154: // DUMMY of the file
155: return DUMMY_POSITION.getOffset();
156: }
157:
158: public CsmOffsetable.Position getStartPosition() {
159: return DUMMY_POSITION;
160: }
161:
162: public CsmOffsetable.Position getEndPosition() {
163: return DUMMY_POSITION;
164: }
165:
166: public String getText() {
167: return include.getIncludeName().toString();
168: }
169:
170: }
171:
172: private static final CsmOffsetable.Position DUMMY_POSITION = new CsmOffsetable.Position() {
173: public int getOffset() {
174: return -1;
175: }
176:
177: public int getLine() {
178: return -1;
179: }
180:
181: public int getColumn() {
182: return -1;
183: }
184: };
185: }
|