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.services;
043:
044: import java.util.ArrayList;
045: import java.util.Collection;
046: import java.util.Collections;
047: import java.util.LinkedHashMap;
048: import org.netbeans.modules.cnd.api.model.CsmDeclaration;
049: import org.netbeans.modules.cnd.api.model.CsmFile;
050: import org.netbeans.modules.cnd.api.model.CsmNamespace;
051: import org.netbeans.modules.cnd.api.model.CsmNamespaceAlias;
052: import org.netbeans.modules.cnd.api.model.CsmProject;
053: import org.netbeans.modules.cnd.api.model.CsmUsingDeclaration;
054: import org.netbeans.modules.cnd.api.model.CsmUsingDirective;
055: import org.openide.util.Lookup;
056:
057: /**
058: * entry point to resolve using directives and using declarations
059: * @author Vladimir Voskresensky
060: */
061: public abstract class CsmUsingResolver {
062: /** A dummy resolver that never returns any results.
063: */
064: private static final CsmUsingResolver EMPTY = new Empty();
065:
066: /** default instance */
067: private static CsmUsingResolver defaultResolver;
068:
069: protected CsmUsingResolver() {
070: }
071:
072: /** Static method to obtain the resolver.
073: * @return the resolver
074: */
075: public static synchronized CsmUsingResolver getDefault() {
076: if (defaultResolver != null) {
077: return defaultResolver;
078: }
079: defaultResolver = Lookup.getDefault().lookup(
080: CsmUsingResolver.class);
081: return defaultResolver == null ? EMPTY : defaultResolver;
082: }
083:
084: /**
085: * return all using declarations visible for offsetable element, i.e.
086: * using std::cout;
087: * using std::printf;
088: *
089: * void method(){
090: * }
091: * returns: std::printf() + std::cout
092: *
093: * @return sorted unmodifiable collection of declarations visible for input offsetable element through "using" declarations
094: */
095: public abstract Collection<CsmDeclaration> findUsedDeclarations(
096: CsmFile file, int offset, CsmProject onlyInProject);
097:
098: /**
099: * return all namespace visible for offsetable element, i.e.
100: * using namespace std;
101: * using namespace myNS;
102: *
103: * void method(){
104: * }
105: * returns: global namespace (the container of method()) + myNs + std
106: * @return sorted unmodifiable collection of namespaces visible for input offsetable element
107: */
108: public abstract Collection<CsmNamespace> findVisibleNamespaces(
109: CsmFile file, int offset, CsmProject onlyInProject);
110:
111: /**
112: * return all namespace aliases visible for offsetable element, i.e.
113: * namespace B = A;
114: * namespace D = E;
115: *
116: * void method(){
117: * }
118: * returns: B + D
119: * @return sorted unmodifiable collection of namespace aliases visible for input offsetable element
120: */
121: public abstract Collection<CsmNamespaceAlias> findNamespaceAliases(
122: CsmFile file, int offset, CsmProject onlyInProject);
123:
124: /**
125: * converts collection of using declarations into ordered list of namespaces
126: * each namespace occurs only once according it's first using directive in 'decls' list
127: */
128: public static Collection<CsmNamespace> extractNamespaces(
129: Collection<CsmUsingDirective> decls) {
130: // TODO check the correctness of order
131: LinkedHashMap<String, CsmNamespace> out = new LinkedHashMap<String, CsmNamespace>(
132: decls.size());
133: for (CsmUsingDirective decl : decls) {
134: CsmNamespace ref = decl.getReferencedNamespace();
135: if (ref != null) {
136: String name = decl.getName().toString();
137: // remove previous inclusion
138: out.remove(name);
139: out.put(name, ref);
140: }
141: }
142: return new ArrayList<CsmNamespace>(out.values());
143: }
144:
145: /**
146: * converts collection of using declarations into ordered list of namespaces
147: * each namespace occurs only once according it's first using directive in 'decls' list
148: */
149: public static Collection<CsmDeclaration> extractDeclarations(
150: Collection<CsmUsingDeclaration> decls) {
151: // TODO check the correctness of order
152: LinkedHashMap<String, CsmDeclaration> out = new LinkedHashMap<String, CsmDeclaration>(
153: decls.size());
154: for (CsmUsingDeclaration decl : decls) {
155: CsmDeclaration ref = decl.getReferencedDeclaration();
156: if (ref != null) {
157: String name = decl.getName().toString();
158: // remove previous inclusion
159: out.remove(name);
160: out.put(name, ref);
161: }
162: }
163: return new ArrayList<CsmDeclaration>(out.values());
164: }
165:
166: //
167: // Implementation of the default resolver
168: //
169: private static final class Empty extends CsmUsingResolver {
170: Empty() {
171: }
172:
173: public Collection<CsmDeclaration> findUsedDeclarations(
174: CsmFile file, int offset, CsmProject onlyInProject) {
175: return Collections.<CsmDeclaration> emptyList();
176: }
177:
178: public Collection<CsmNamespace> findVisibleNamespaces(
179: CsmFile file, int offset, CsmProject onlyInProject) {
180: return Collections.<CsmNamespace> emptyList();
181: }
182:
183: public Collection<CsmNamespaceAlias> findNamespaceAliases(
184: CsmFile file, int offset, CsmProject onlyInProject) {
185: return Collections.<CsmNamespaceAlias> emptyList();
186: }
187: }
188: }
|