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.api.model.xref;
043:
044: import javax.swing.JEditorPane;
045: import org.netbeans.modules.cnd.api.model.CsmFile;
046: import org.netbeans.modules.cnd.api.model.CsmObject;
047: import org.netbeans.modules.cnd.api.model.util.CsmBaseUtilities;
048: import org.netbeans.modules.cnd.modelutil.CsmUtilities;
049: import org.openide.cookies.EditorCookie;
050: import org.openide.nodes.Node;
051: import org.openide.util.Lookup;
052:
053: /**
054: * entry point to search references in files
055: * @author Vladimir Voskresensky
056: */
057: public abstract class CsmReferenceResolver {
058: /** A default resolver that combines all results.
059: */
060: private static final CsmReferenceResolver DEFAULT = new Default();
061:
062: protected CsmReferenceResolver() {
063: }
064:
065: /** Static method to obtain the resolver.
066: * @return the resolver
067: */
068: public static CsmReferenceResolver getDefault() {
069: return DEFAULT;
070: }
071:
072: /**
073: * look for reference on specified position in file
074: * @param file file where to search
075: * @param offset position in file to find reference
076: * @return reference for element on position "offset", null if not found
077: */
078: public abstract CsmReference findReference(CsmFile file, int offset);
079:
080: /**
081: * look for reference on specified position in file
082: * @param file file where to search
083: * @param line line position in file to find reference
084: * @param column column position in file to find reference
085: * @return reference for element on position "offset", null if not found
086: */
087: // public abstract CsmReference findReference(CsmFile file, int line, int column);
088: /**
089: * default implementation of method based on Node
090: */
091: public CsmReference findReference(Node activatedNode) {
092: assert activatedNode != null : "activatedNode must be not null";
093: EditorCookie c = activatedNode.getCookie(EditorCookie.class);
094: if (c != null) {
095: JEditorPane[] panes = CsmUtilities.getOpenedPanesInEQ(c);
096: if (panes != null && panes.length > 0) {
097: int offset = panes[0].getCaret().getDot();
098: CsmFile file = CsmUtilities.getCsmFile(activatedNode,
099: false);
100: if (file != null) {
101: return findReference(file, offset);
102: }
103: }
104: }
105: return null;
106: }
107:
108: /**
109: * returns reference kind
110: * @param ref reference to analyze
111: * @return reference kind
112: */
113: public CsmReferenceKind getReferenceKind(CsmReference ref) {
114: // default implementation
115: CsmObject target = ref.getReferencedObject();
116: assert target != null;
117: CsmObject[] decDef = CsmBaseUtilities.getDefinitionDeclaration(
118: target, true);
119: CsmObject targetDecl = decDef[0];
120: CsmObject targetDef = decDef[1];
121: return getReferenceKind(ref, targetDecl, targetDef);
122: }
123:
124: /**
125: * returns reference kind with known definition and declaration of target
126: * @param ref reference to analyze
127: * @param targetDecl declaration of target object
128: * @param targetDef definition of target object
129: * @return reference kind
130: */
131: public CsmReferenceKind getReferenceKind(CsmReference ref,
132: CsmObject targetDecl, CsmObject targetDef) {
133: // default implementation
134: assert targetDecl != null;
135: CsmObject owner = ref.getOwner();
136: CsmReferenceKind kind = CsmReferenceKind.DIRECT_USAGE;
137: if (owner != null) {
138: if (owner.equals(targetDecl)) {
139: kind = CsmReferenceKind.DECLARATION;
140: } else if (owner.equals(targetDef)) {
141: kind = CsmReferenceKind.DEFINITION;
142: }
143: }
144: return kind;
145: }
146:
147: /**
148: * fast checks reference scope if possible
149: * @param ref
150: * @return scope kind if detected or UNKNOWN
151: */
152: public abstract Scope fastCheckScope(CsmReference ref);
153:
154: public static enum Scope {
155: LOCAL, GLOBAL, UNKNOWN
156: }
157:
158: //
159: // Implementation of the default resolver
160: //
161: private static final class Default extends CsmReferenceResolver {
162: private final Lookup.Result<CsmReferenceResolver> res;
163:
164: Default() {
165: res = Lookup.getDefault().lookupResult(
166: CsmReferenceResolver.class);
167: }
168:
169: public CsmReference findReference(CsmFile file, int offset) {
170: for (CsmReferenceResolver resolver : res.allInstances()) {
171: CsmReference out = resolver.findReference(file, offset);
172: if (out != null) {
173: return out;
174: }
175: }
176: return null;
177: }
178:
179: @Override
180: public CsmReference findReference(Node activatedNode) {
181: for (CsmReferenceResolver resolver : res.allInstances()) {
182: CsmReference out = resolver
183: .findReference(activatedNode);
184: if (out != null) {
185: return out;
186: }
187: }
188: return null;
189: }
190:
191: @Override
192: public Scope fastCheckScope(CsmReference ref) {
193: for (CsmReferenceResolver resolver : res.allInstances()) {
194: Scope scope = resolver.fastCheckScope(ref);
195: if (scope != Scope.UNKNOWN) {
196: return scope;
197: }
198: }
199: return Scope.UNKNOWN;
200: }
201:
202: @Override
203: public CsmReferenceKind getReferenceKind(CsmReference ref) {
204: for (CsmReferenceResolver resolver : res.allInstances()) {
205: CsmReferenceKind kind = resolver.getReferenceKind(ref);
206: if (kind != CsmReferenceKind.UNKNOWN) {
207: return kind;
208: }
209: }
210: return CsmReferenceKind.UNKNOWN;
211: }
212:
213: @Override
214: public CsmReferenceKind getReferenceKind(CsmReference ref,
215: CsmObject targetDecl, CsmObject targetDef) {
216: for (CsmReferenceResolver resolver : res.allInstances()) {
217: CsmReferenceKind kind = resolver.getReferenceKind(ref,
218: targetDecl, targetDef);
219: if (kind != CsmReferenceKind.UNKNOWN) {
220: return kind;
221: }
222: }
223: return CsmReferenceKind.UNKNOWN;
224: }
225: }
226: }
|