Restructuring for better separation of Tool packages.

[mirror_edk2.git] / Tools / Java / Source / Cpptasks / net / sf / antcontrib / cpptasks / compiler / ProcessorConfiguration.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 net.sf.antcontrib.cpptasks.ProcessorParam;\r
/**\r
 * A configuration for a C++ compiler, linker or other processor\r
 * \r
 * @author Curt Arnold\r
 */\r
public interface ProcessorConfiguration {\r
    /**\r
     * An indication of how much this compiler would like to process this file\r
     * \r
     * @return 0 is no interest to process, 100 is strong interest to process\r
     */\r
    int bid(String filename);\r
    /**\r
     * Returns a string representation of this configuration. Should be\r
     * canonical so that equivalent configurations will have equivalent string\r
     * representations\r
     */\r
    String getIdentifier();\r
    /**\r
     * Output file name (no path components) corresponding to source file\r
     * \r
     * @param inputFile\r
     *            input file\r
     * @return output file name or null if no output file or name not\r
     *         determined by input file\r
     */\r
    String getOutputFileName(String inputFile);\r
    ProcessorParam[] getParams();\r
    /**\r
     * If true, all files using this configuration should be rebuilt and any\r
     * existing output files should be ignored\r
     */\r
    boolean getRebuild();\r
}\r