Tools/Source/Cpptasks/net/sf/antcontrib/cpptasks/compiler/PrecompilingCompiler.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  * A compiler that can utilize precompilation of header files
  21  *
  22  * @author Curt Arnold
  23  */
  24 public interface PrecompilingCompiler {
  25     /**
  26      *
  27      * This method may be used to get two distinct compiler configurations, one
  28      * for compiling the specified file and producing a precompiled header
  29      * file, and a second for compiling other files using the precompiled
  30      * header file.
  31      *
  32      * The last (preferrably only) include directive in the prototype file will
  33      * be used to mark the boundary between pre-compiled and normally compiled
  34      * headers.
  35      *
  36      * @param config
  37      *            base configuration
  38      * @param prototype
  39      *            A source file (for example, stdafx.cpp) that is used to build
  40      *            the precompiled header file. @returns null if precompiled
  41      *            headers are not supported or a two element array containing
  42      *            the precompiled header generation configuration and the
  43      *            consuming configuration
  44      *
  45      */
  46     CompilerConfiguration[] createPrecompileConfigurations(
  47             CompilerConfiguration config, File prototype,
  48             String[] nonPrecompiledFiles);
  49 }