Tools/Source/Cpptasks/net/sf/antcontrib/cpptasks/compiler/ProcessorConfiguration.java

   1 /*
   2  *
   3  * Copyright 2002-2004 The Ant-Contrib project
   4  *
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  */
  17 package net.sf.antcontrib.cpptasks.compiler;
  18 import net.sf.antcontrib.cpptasks.ProcessorParam;
  19 /**
  20  * A configuration for a C++ compiler, linker or other processor
  21  *
  22  * @author Curt Arnold
  23  */
  24 public interface ProcessorConfiguration {
  25     /**
  26      * An indication of how much this compiler would like to process this file
  27      *
  28      * @return 0 is no interest to process, 100 is strong interest to process
  29      */
  30     int bid(String filename);
  31     /**
  32      * Returns a string representation of this configuration. Should be
  33      * canonical so that equivalent configurations will have equivalent string
  34      * representations
  35      */
  36     String getIdentifier();
  37     /**
  38      * Output file name (no path components) corresponding to source file
  39      *
  40      * @param inputFile
  41      *            input file
  42      * @return output file name or null if no output file or name not
  43      *         determined by input file
  44      */
  45     String getOutputFileName(String inputFile);
  46     ProcessorParam[] getParams();
  47     /**
  48      * If true, all files using this configuration should be rebuilt and any
  49      * existing output files should be ignored
  50      */
  51     boolean getRebuild();
  52 }