Source/cmInstallExportGenerator.h

   1 /* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   2    file Copyright.txt or https://cmake.org/licensing for details.  */
   3 #pragma once
   4
   5 #include "cmConfigure.h" // IWYU pragma: keep
   6
   7 #include <iosfwd>
   8 #include <memory>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "cmInstallGenerator.h"
  13
  14 class cmExportInstallFileGenerator;
  15 class cmExportSet;
  16 class cmListFileBacktrace;
  17 class cmLocalGenerator;
  18
  19 /** \class cmInstallExportGenerator
  20  * \brief Support class for generating rules for creating export files.
  21  */
  22 class cmInstallExportGenerator : public cmInstallGenerator
  23 {
  24 public:
  25   cmInstallExportGenerator(cmExportSet* exportSet, std::string destination,
  26                            std::string filePermissions,
  27                            std::vector<std::string> const& configurations,
  28                            std::string component, MessageLevel message,
  29                            bool excludeFromAll, std::string filename,
  30                            std::string targetNamespace,
  31                            std::string cxxModulesDirectory,
  32                            cmListFileBacktrace backtrace);
  33   cmInstallExportGenerator(const cmInstallExportGenerator&) = delete;
  34   ~cmInstallExportGenerator() override;
  35
  36   cmInstallExportGenerator& operator=(const cmInstallExportGenerator&) =
  37     delete;
  38
  39   virtual char const* InstallSubcommand() const = 0;
  40
  41   cmExportSet* GetExportSet() { return this->ExportSet; }
  42
  43   bool Compute(cmLocalGenerator* lg) override;
  44
  45   cmLocalGenerator* GetLocalGenerator() const { return this->LocalGenerator; }
  46
  47   const std::string& GetNamespace() const { return this->Namespace; }
  48
  49   std::string const& GetMainImportFile() const { return this->MainImportFile; }
  50
  51   std::string const& GetDestination() const { return this->Destination; }
  52   std::string GetDestinationFile() const;
  53   std::string GetFileName() const { return this->FileName; }
  54   std::string GetTempDir() const;
  55   std::string GetCxxModuleDirectory() const
  56   {
  57     return this->CxxModulesDirectory;
  58   }
  59
  60 protected:
  61   void GenerateScript(std::ostream& os) override;
  62   void GenerateScriptConfigs(std::ostream& os, Indent indent) override;
  63   void GenerateScriptActions(std::ostream& os, Indent indent) override;
  64   std::string TempDirCalculate() const;
  65   void ComputeTempDir();
  66
  67   cmExportSet* const ExportSet;
  68   std::string const FilePermissions;
  69   std::string const FileName;
  70   std::string const Namespace;
  71   std::string const CxxModulesDirectory;
  72   cmLocalGenerator* LocalGenerator = nullptr;
  73
  74   std::string TempDir;
  75   std::string MainImportFile;
  76   std::unique_ptr<cmExportInstallFileGenerator> EFGen;
  77 };