Source/cmExportFileGenerator.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmExportFileGenerator.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-07-06 20:25:20 $
   7   Version:   $Revision: 1.9 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmExportFileGenerator_h
  18 #define cmExportFileGenerator_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmExportFileGenerator
  23  * \brief Generate a file exporting targets from a build or install tree.
  24  *
  25  * cmExportFileGenerator is the superclass for
  26  * cmExportBuildFileGenerator and cmExportInstallFileGenerator.  It
  27  * contains common code generation routines for the two kinds of
  28  * export implementations.
  29  */
  30 class cmExportFileGenerator
  31 {
  32 public:
  33   cmExportFileGenerator();
  34   virtual ~cmExportFileGenerator() {}
  35
  36   /** Set the full path to the export file to generate.  */
  37   void SetExportFile(const char* mainFile);
  38
  39   /** Set the namespace in which to place exported target names.  */
  40   void SetNamespace(const char* ns) { this->Namespace = ns; }
  41
  42   /** Add a configuration to be exported.  */
  43   void AddConfiguration(const char* config);
  44
  45   /** Actually generate the export file.  Returns whether there was an
  46       error.  */
  47   bool GenerateImportFile();
  48 protected:
  49
  50   typedef std::map<cmStdString, cmStdString> ImportPropertyMap;
  51
  52   // Generate per-configuration target information to the given output
  53   // stream.
  54   void GenerateImportConfig(std::ostream& os, const char* config);
  55
  56   // Methods to implement export file code generation.
  57   void GenerateImportHeaderCode(std::ostream& os, const char* config = 0);
  58   void GenerateImportFooterCode(std::ostream& os);
  59   void GenerateImportVersionCode(std::ostream& os);
  60   void GenerateImportTargetCode(std::ostream& os, cmTarget* target);
  61   void GenerateImportPropertyCode(std::ostream& os, const char* config,
  62                                   cmTarget* target,
  63                                   ImportPropertyMap const& properties);
  64
  65   // Collect properties with detailed information about targets beyond
  66   // their location on disk.
  67   void SetImportDetailProperties(const char* config,
  68                                  std::string const& suffix, cmTarget* target,
  69                                  ImportPropertyMap& properties);
  70   void SetImportLinkProperty(std::string const& suffix,
  71                              cmTarget* target, const char* propName,
  72                              std::vector<std::string> const& libs,
  73                              ImportPropertyMap& properties);
  74
  75   /** Each subclass knows how to generate its kind of export file.  */
  76   virtual bool GenerateMainFile(std::ostream& os) = 0;
  77
  78   /** Each subclass knows where the target files are located.  */
  79   virtual void GenerateImportTargetsConfig(std::ostream& os,
  80                                            const char* config,
  81                                            std::string const& suffix) = 0;
  82
  83   /** Each subclass knows how to complain about a target that is
  84       missing from an export set.  */
  85   virtual void ComplainAboutMissingTarget(cmTarget* depender,
  86                                           cmTarget* dependee) = 0;
  87
  88   // The namespace in which the exports are placed in the generated file.
  89   std::string Namespace;
  90
  91   // The set of configurations to export.
  92   std::vector<std::string> Configurations;
  93
  94   // The file to generate.
  95   std::string MainImportFile;
  96   std::string FileDir;
  97   std::string FileBase;
  98   std::string FileExt;
  99   bool AppendMode;
 100
 101   // The set of targets included in the export.
 102   std::set<cmTarget*> ExportedTargets;
 103 };
 104
 105 #endif