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: package org.netbeans.modules.cnd.api.project;
042:
043: import java.io.File;
044: import java.util.List;
045:
046: public interface NativeProject {
047: /**
048: * Returns project object,
049: * i.e. Netbeans project object
050: * org.netbeans.api.project.Project
051: */
052: public Object getProject();
053:
054: /**
055: * Returns file path to project root
056: * @return file path to project root
057: */
058: public String getProjectRoot();
059:
060: /**
061: * Returns file paths to source roots
062: * @return file paths to source roots
063: */
064: public List<String> getSourceRoots();
065:
066: /**
067: * Returns the display name of the project
068: * @return display name of the project
069: */
070: public String getProjectDisplayName();
071:
072: // /**
073: // * Returns a list of all source files in the project.
074: // * @return a list of all source files in the project. A source
075: // * file is a file directly compiled by the project.
076: // */
077: // public List<NativeFileItem> getAllSourceFiles();
078: //
079: // /**
080: // * Returns a list of all header files in the project.
081: // * @return a list of all header files in the project. A header
082: // * file is a file with the suffix .h.
083: // */
084: // public List<NativeFileItem> getAllHeaderFiles();
085:
086: /**
087: * Returns a list of all files in the project.
088: * @return a list of all files in the project.
089: */
090: public List<NativeFileItem> getAllFiles();
091:
092: /**
093: * Adds a listener to changes when items are added to or removed from the project.
094: * @param listener a listener to add
095: */
096: public void addProjectItemsListener(
097: NativeProjectItemsListener listener);
098:
099: /**
100: * Removes a listner.
101: * @param listener a listener to remove
102: */
103: public void removeProjectItemsListener(
104: NativeProjectItemsListener listener);
105:
106: /**
107: * Finds a file item in the project.
108: * @param file the file item to find
109: * @return the file item if found. Othervise it returns null.
110: */
111: public NativeFileItem findFileItem(File file);
112:
113: /**
114: * Returns a list <String> of compiler defined include paths used when parsing 'orpan' source files.
115: * @return a list <String> of compiler defined include paths.
116: * A path is always an absolute path.
117: * Include paths are not prefixed with the compiler include path option (usually -I).
118: */
119: public List<String> getSystemIncludePaths();
120:
121: /**
122: * Returns a list <String> of user defined include paths used when parsing 'orpan' source files.
123: * @return a list <String> of user defined include paths.
124: * A path is always an absolute path.
125: * Include paths are not prefixed with the compiler include path option (usually -I).
126: */
127: public List<String> getUserIncludePaths();
128:
129: /**
130: * Returns a list <String> of compiler defined macro definitions used when parsing 'orpan' source files.
131: * @return a list <String> of compiler defined macro definitions.
132: * Macro definitions are not prefixed with the compiler option (usually -D).
133: */
134: public List<String> getSystemMacroDefinitions();
135:
136: /**
137: * Returns a list <String> of user defined macro definitions used when parsing 'orpan' source files.
138: * @return a list <String> of user defined macro definitions.
139: * Macro definitions are not prefixed with the compiler option (usually -D).
140: */
141: public List<String> getUserMacroDefinitions();
142:
143: /**
144: * Returns a list <NativeProject> of libriries.
145: * @return a list <NativeProject> of libriries.
146: */
147: public List<NativeProject> getDependences();
148: }
|