Changed spelling to manifest

[mirror_edk2.git] / Tools / Source / Cpptasks / net / sf / antcontrib / cpptasks / compiler / CompilerConfiguration.java

/*\r
 * \r
 * Copyright 2002-2004 The Ant-Contrib project\r
 *\r
 *  Licensed under the Apache License, Version 2.0 (the "License");\r
 *  you may not use this file except in compliance with the License.\r
 *  You may obtain a copy of the License at\r
 *\r
 *      http://www.apache.org/licenses/LICENSE-2.0\r
 *\r
 *  Unless required by applicable law or agreed to in writing, software\r
 *  distributed under the License is distributed on an "AS IS" BASIS,\r
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
 *  See the License for the specific language governing permissions and\r
 *  limitations under the License.\r
 */\r
package net.sf.antcontrib.cpptasks.compiler;\r
import java.io.File;\r
\r
import net.sf.antcontrib.cpptasks.CCTask;\r
import net.sf.antcontrib.cpptasks.CompilerParam;\r
import net.sf.antcontrib.cpptasks.DependencyInfo;\r
\r
import org.apache.tools.ant.BuildException;\r
/**\r
 * A configuration for a compiler\r
 * \r
 * @author Curt Arnold\r
 */\r
public interface CompilerConfiguration extends ProcessorConfiguration {\r
    void compile(CCTask task, File outputDir, String[] sourceFiles,\r
            boolean relentless, ProgressMonitor monitor) throws BuildException;\r
    /**\r
     * \r
     * This method may be used to get two distinct compiler configurations, one\r
     * for compiling the specified file and producing a precompiled header\r
     * file, and a second for compiling other files using the precompiled\r
     * header file.\r
     * \r
     * The last (preferrably only) include directive in the prototype file will\r
     * be used to mark the boundary between pre-compiled and normally compiled\r
     * headers.\r
     * \r
     * @param prototype\r
     *            A source file (for example, stdafx.cpp) that is used to build\r
     *            the precompiled header file. @returns null if precompiled\r
     *            headers are not supported or a two element array containing\r
     *            the precompiled header generation configuration and the\r
     *            consuming configuration\r
     *  \r
     */\r
    CompilerConfiguration[] createPrecompileConfigurations(File prototype,\r
            String[] nonPrecompiledFiles);\r
    /**\r
     * Returns an digest for the include path for the configuration.\r
     * \r
     * This is used to determine if cached dependency information is invalid\r
     * because the include paths have changed\r
     */\r
    String getIncludePathIdentifier();\r
    public CompilerParam getParam(String name);\r
    boolean isPrecompileGeneration();\r
    DependencyInfo parseIncludes(CCTask task, File baseDir, File source);\r
}\r