Tools/Source/Cpptasks/net/sf/antcontrib/cpptasks/compiler/CompilerConfiguration.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 java.io.File;
  19
  20 import net.sf.antcontrib.cpptasks.CCTask;
  21 import net.sf.antcontrib.cpptasks.CompilerParam;
  22 import net.sf.antcontrib.cpptasks.DependencyInfo;
  23
  24 import org.apache.tools.ant.BuildException;
  25 /**
  26  * A configuration for a compiler
  27  *
  28  * @author Curt Arnold
  29  */
  30 public interface CompilerConfiguration extends ProcessorConfiguration {
  31     void compile(CCTask task, File outputDir, String[] sourceFiles,
  32             boolean relentless, ProgressMonitor monitor) throws BuildException;
  33     /**
  34      *
  35      * This method may be used to get two distinct compiler configurations, one
  36      * for compiling the specified file and producing a precompiled header
  37      * file, and a second for compiling other files using the precompiled
  38      * header file.
  39      *
  40      * The last (preferrably only) include directive in the prototype file will
  41      * be used to mark the boundary between pre-compiled and normally compiled
  42      * headers.
  43      *
  44      * @param prototype
  45      *            A source file (for example, stdafx.cpp) that is used to build
  46      *            the precompiled header file. @returns null if precompiled
  47      *            headers are not supported or a two element array containing
  48      *            the precompiled header generation configuration and the
  49      *            consuming configuration
  50      *
  51      */
  52     CompilerConfiguration[] createPrecompileConfigurations(File prototype,
  53             String[] nonPrecompiledFiles);
  54     /**
  55      * Returns an digest for the include path for the configuration.
  56      *
  57      * This is used to determine if cached dependency information is invalid
  58      * because the include paths have changed
  59      */
  60     String getIncludePathIdentifier();
  61     public CompilerParam getParam(String name);
  62     boolean isPrecompileGeneration();
  63     DependencyInfo parseIncludes(CCTask task, File baseDir, File source);
  64 }