Source/cmExportInstallFileGenerator.cxx

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