Source/cmExportInstallFileGenerator.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmExportInstallFileGenerator.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2008-02-06 19:20:35 $
   7   Version:   $Revision: 1.8 $
   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 #include "cmExportInstallFileGenerator.h"
  18
  19 #include "cmGeneratedFileStream.h"
  20 #include "cmInstallExportGenerator.h"
  21 #include "cmInstallTargetGenerator.h"
  22
  23 //----------------------------------------------------------------------------
  24 cmExportInstallFileGenerator
  25 ::cmExportInstallFileGenerator(cmInstallExportGenerator* iegen):
  26   InstallExportGenerator(iegen)
  27 {
  28 }
  29
  30 //----------------------------------------------------------------------------
  31 bool cmExportInstallFileGenerator::GenerateMainFile(std::ostream& os)
  32 {
  33   // Create all the imported targets.
  34   for(std::vector<cmTargetExport*>::const_iterator
  35         tei = this->ExportSet->begin();
  36       tei != this->ExportSet->end(); ++tei)
  37     {
  38     cmTargetExport* te = *tei;
  39     if(this->ExportedTargets.insert(te->Target).second)
  40       {
  41       this->GenerateImportTargetCode(os, te->Target);
  42       }
  43     else
  44       {
  45       cmOStringStream e;
  46       e << "INSTALL(EXPORT \"" << this->Name << "\" ...) "
  47         << "includes target \"" << te->Target->GetName()
  48         << "\" more than once in the export set.";
  49       cmSystemTools::Error(e.str().c_str());
  50       return false;
  51       }
  52     }
  53
  54   // Now load per-configuration properties for them.
  55   os << "# Load information for each installed configuration.\n"
  56      << "GET_FILENAME_COMPONENT(_DIR \"${CMAKE_CURRENT_LIST_FILE}\" PATH)\n"
  57      << "FILE(GLOB CONFIG_FILES \"${_DIR}/"
  58      << this->FileBase << "-*" << this->FileExt << "\")\n"
  59      << "FOREACH(f ${CONFIG_FILES})\n"
  60      << "  INCLUDE(${f})\n"
  61      << "ENDFOREACH(f)\n"
  62      << "\n";
  63
  64   // Generate an import file for each configuration.
  65   bool result = true;
  66   for(std::vector<std::string>::const_iterator
  67         ci = this->Configurations.begin();
  68       ci != this->Configurations.end(); ++ci)
  69     {
  70     if(!this->GenerateImportFileConfig(ci->c_str()))
  71       {
  72       result = false;
  73       }
  74     }
  75   return result;
  76 }
  77
  78 //----------------------------------------------------------------------------
  79 bool
  80 cmExportInstallFileGenerator::GenerateImportFileConfig(const char* config)
  81 {
  82   // Skip configurations not enabled for this export.
  83   if(!this->InstallExportGenerator->InstallsForConfig(config))
  84     {
  85     return true;
  86     }
  87
  88   // Construct the name of the file to generate.
  89   std::string fileName = this->FileDir;
  90   fileName += "/";
  91   fileName += this->FileBase;
  92   fileName += "-";
  93   if(config && *config)
  94     {
  95     fileName += cmSystemTools::LowerCase(config);
  96     }
  97   else
  98     {
  99     fileName += "noconfig";
 100     }
 101   fileName += this->FileExt;
 102
 103   // Open the output file to generate it.
 104   cmGeneratedFileStream exportFileStream(fileName.c_str(), true);
 105   if(!exportFileStream)
 106     {
 107     std::string se = cmSystemTools::GetLastSystemError();
 108     cmOStringStream e;
 109     e << "cannot write to file \"" << fileName.c_str()
 110       << "\": " << se;
 111     cmSystemTools::Error(e.str().c_str());
 112     return false;
 113     }
 114   std::ostream& os = exportFileStream;
 115
 116   // Start with the import file header.
 117   this->GenerateImportHeaderCode(os, config);
 118
 119   // Generate the per-config target information.
 120   this->GenerateImportConfig(os, config);
 121
 122   // End with the import file footer.
 123   this->GenerateImportFooterCode(os);
 124
 125   // Record this per-config import file.
 126   this->ConfigImportFiles[config] = fileName;
 127
 128   return true;
 129 }
 130
 131 //----------------------------------------------------------------------------
 132 void
 133 cmExportInstallFileGenerator
 134 ::GenerateImportTargetsConfig(std::ostream& os,
 135                               const char* config, std::string const& suffix)
 136 {
 137   // Add code to compute the installation prefix relative to the
 138   // import file location.
 139   const char* installDest = this->InstallExportGenerator->GetDestination();
 140   if(!cmSystemTools::FileIsFullPath(installDest))
 141     {
 142     std::string dest = installDest;
 143     os << "# Compute the installation prefix relative to this file.\n"
 144        << "GET_FILENAME_COMPONENT(_IMPORT_PREFIX "
 145        << "\"${CMAKE_CURRENT_LIST_FILE}\" PATH)\n";
 146     while(!dest.empty())
 147       {
 148       os <<
 149         "GET_FILENAME_COMPONENT(_IMPORT_PREFIX \"${_IMPORT_PREFIX}\" PATH)\n";
 150       dest = cmSystemTools::GetFilenamePath(dest);
 151       }
 152     os << "\n";
 153
 154     // Import location properties may reference this variable.
 155     this->ImportPrefix = "${_IMPORT_PREFIX}/";
 156     }
 157
 158   // Add each target in the set to the export.
 159   for(std::vector<cmTargetExport*>::const_iterator
 160         tei = this->ExportSet->begin();
 161       tei != this->ExportSet->end(); ++tei)
 162     {
 163     // Collect import properties for this target.
 164     cmTargetExport* te = *tei;
 165     ImportPropertyMap properties;
 166     this->SetImportLocationProperty(config, suffix,
 167                                     te->ArchiveGenerator, properties);
 168     this->SetImportLocationProperty(config, suffix,
 169                                     te->LibraryGenerator, properties);
 170     this->SetImportLocationProperty(config, suffix,
 171                                     te->RuntimeGenerator, properties);
 172     this->SetImportLocationProperty(config, suffix,
 173                                     te->FrameworkGenerator, properties);
 174     this->SetImportLocationProperty(config, suffix,
 175                                     te->BundleGenerator, properties);
 176
 177     // If any file location was set for the target add it to the
 178     // import file.
 179     if(!properties.empty())
 180       {
 181       // Get the rest of the target details.
 182       this->SetImportDetailProperties(config, suffix,
 183                                       te->Target, properties);
 184
 185       // TOOD: PUBLIC_HEADER_LOCATION
 186       // This should wait until the build feature propagation stuff
 187       // is done.  Then this can be a propagated include directory.
 188       // this->GenerateImportProperty(config, te->HeaderGenerator,
 189       //                              properties);
 190
 191       // Generate code in the export file.
 192       this->GenerateImportPropertyCode(os, config, te->Target, properties);
 193       }
 194     }
 195
 196   // Cleanup the import prefix variable.
 197   if(!this->ImportPrefix.empty())
 198     {
 199     os << "# Cleanup temporary variables.\n"
 200        << "SET(_IMPORT_PREFIX)\n"
 201        << "\n";
 202     }
 203 }
 204
 205 //----------------------------------------------------------------------------
 206 void
 207 cmExportInstallFileGenerator
 208 ::SetImportLocationProperty(const char* config, std::string const& suffix,
 209                             cmInstallTargetGenerator* itgen,
 210                             ImportPropertyMap& properties)
 211 {
 212   // Skip rules that do not match this configuration.
 213   if(!(itgen && itgen->InstallsForConfig(config)))
 214     {
 215     return;
 216     }
 217
 218   // Get the target to be installed.
 219   cmTarget* target = itgen->GetTarget();
 220
 221   // Construct the installed location of the target.
 222   std::string dest = itgen->GetDestination();
 223   std::string value;
 224   if(!cmSystemTools::FileIsFullPath(dest.c_str()))
 225     {
 226     // The target is installed relative to the installation prefix.
 227     if(this->ImportPrefix.empty())
 228       {
 229       this->ComplainAboutImportPrefix(itgen);
 230       }
 231     value = this->ImportPrefix;
 232     }
 233   value += dest;
 234   value += "/";
 235
 236   if(itgen->IsImportLibrary())
 237     {
 238     // Construct the property name.
 239     std::string prop = "IMPORTED_IMPLIB";
 240     prop += suffix;
 241
 242     // Append the installed file name.
 243     value += itgen->GetInstallFilename(target, config,
 244                                        cmInstallTargetGenerator::NameImplib);
 245
 246     // Store the property.
 247     properties[prop] = value;
 248     }
 249   else
 250     {
 251     // Construct the property name.
 252     std::string prop = "IMPORTED_LOCATION";
 253     prop += suffix;
 254
 255     // Append the installed file name.
 256     if(target->IsFrameworkOnApple())
 257       {
 258       value += itgen->GetInstallFilename(target, config);
 259       value += ".framework/";
 260       value += itgen->GetInstallFilename(target, config);
 261       }
 262     else if(target->IsAppBundleOnApple())
 263       {
 264       value += itgen->GetInstallFilename(target, config);
 265       value += ".app/Contents/MacOS/";
 266       value += itgen->GetInstallFilename(target, config);
 267       }
 268     else
 269       {
 270       value += itgen->GetInstallFilename(target, config,
 271                                          cmInstallTargetGenerator::NameReal);
 272       }
 273
 274     // Store the property.
 275     properties[prop] = value;
 276     }
 277 }
 278
 279 //----------------------------------------------------------------------------
 280 void
 281 cmExportInstallFileGenerator
 282 ::ComplainAboutImportPrefix(cmInstallTargetGenerator* itgen)
 283 {
 284   const char* installDest = this->InstallExportGenerator->GetDestination();
 285   cmOStringStream e;
 286   e << "INSTALL(EXPORT \"" << this->Name << "\") given absolute "
 287     << "DESTINATION \"" << installDest << "\" but the export "
 288     << "references an installation of target \""
 289     << itgen->GetTarget()->GetName() << "\" which has relative "
 290     << "DESTINATION \"" << itgen->GetDestination() << "\".";
 291   cmSystemTools::Error(e.str().c_str());
 292 }
 293
 294 //----------------------------------------------------------------------------
 295 void
 296 cmExportInstallFileGenerator
 297 ::ComplainAboutMissingTarget(cmTarget* depender, cmTarget* dependee)
 298 {
 299   cmOStringStream e;
 300   e << "INSTALL(EXPORT \"" << this->Name << "\" ...) "
 301     << "includes target \"" << depender->GetName()
 302     << "\" which requires target \"" << dependee->GetName()
 303     << "\" that is not in the export set.";
 304   cmSystemTools::Error(e.str().c_str());
 305 }