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.Collections;
045: import java.util.List;
046: import org.netbeans.modules.cnd.api.model.CsmFile;
047: import org.netbeans.modules.cnd.api.model.CsmOffsetable;
048: import org.netbeans.modules.cnd.api.model.xref.CsmReference;
049: import org.openide.util.Lookup;
050:
051: /**
052: * query to obtain information associated with CsmFile object
053: *
054: * @author Vladimir Voskresensky
055: */
056: public abstract class CsmFileInfoQuery {
057: /** A dummy resolver that never returns any results.
058: */
059: private static final CsmFileInfoQuery EMPTY = new Empty();
060:
061: /** default instance */
062: private static CsmFileInfoQuery defaultResolver;
063:
064: protected CsmFileInfoQuery() {
065: }
066:
067: /** Static method to obtain the resolver.
068: * @return the resolver
069: */
070: public static synchronized CsmFileInfoQuery getDefault() {
071: if (defaultResolver != null) {
072: return defaultResolver;
073: }
074: defaultResolver = Lookup.getDefault().lookup(
075: CsmFileInfoQuery.class);
076: return defaultResolver == null ? EMPTY : defaultResolver;
077: }
078:
079: /**
080: * @return list of system include paths used to parse file
081: */
082: public abstract List<String> getSystemIncludePaths(CsmFile file);
083:
084: /**
085: * @return list of user include paths used to parse file
086: */
087: public abstract List<String> getUserIncludePaths(CsmFile file);
088:
089: /**
090: * @return list of code blocks which are excluded from compilation
091: * due to current set of preprocessor directives
092: */
093: public abstract List<CsmOffsetable> getUnusedCodeBlocks(CsmFile file);
094:
095: /**
096: * @return list of macro's usages in the file
097: */
098: public abstract List<CsmReference> getMacroUsages(CsmFile file);
099:
100: //
101: // Implementation of the default query
102: //
103: private static final class Empty extends CsmFileInfoQuery {
104: Empty() {
105: }
106:
107: public List<String> getSystemIncludePaths(CsmFile file) {
108: return Collections.<String> emptyList();
109: }
110:
111: public List<String> getUserIncludePaths(CsmFile file) {
112: return Collections.<String> emptyList();
113: }
114:
115: public List<CsmOffsetable> getUnusedCodeBlocks(CsmFile file) {
116: return Collections.<CsmOffsetable> emptyList();
117: }
118:
119: public List<CsmReference> getMacroUsages(CsmFile file) {
120: return Collections.<CsmReference> emptyList();
121: }
122: }
123: }
|