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 #include "cmScriptGenerator.h"
  14
  15 class cmExportInstallFileGenerator;
  16 class cmExportSet;
  17 class cmListFileBacktrace;
  18 class cmLocalGenerator;
  19
  20 /** \class cmInstallExportGenerator
  21  * \brief Generate rules for creating an export files.
  22  */
  23 class cmInstallExportGenerator : public cmInstallGenerator
  24 {
  25 public:
  26   cmInstallExportGenerator(cmExportSet* exportSet, std::string const& dest,
  27                            std::string file_permissions,
  28                            const std::vector<std::string>& configurations,
  29                            std::string const& component, MessageLevel message,
  30                            bool exclude_from_all, std::string filename,
  31                            std::string name_space,
  32                            std::string cxx_modules_directory, bool exportOld,
  33                            bool android, cmListFileBacktrace backtrace);
  34   cmInstallExportGenerator(const cmInstallExportGenerator&) = delete;
  35   ~cmInstallExportGenerator() override;
  36
  37   cmInstallExportGenerator& operator=(const cmInstallExportGenerator&) =
  38     delete;
  39
  40   cmExportSet* GetExportSet() { return this->ExportSet; }
  41
  42   bool Compute(cmLocalGenerator* lg) override;
  43
  44   cmLocalGenerator* GetLocalGenerator() const { return this->LocalGenerator; }
  45
  46   const std::string& GetNamespace() const { return this->Namespace; }
  47
  48   std::string const& GetMainImportFile() const { return this->MainImportFile; }
  49
  50   std::string const& GetDestination() const { return this->Destination; }
  51   std::string GetDestinationFile() const;
  52   std::string GetFileName() const { return this->FileName; }
  53   std::string GetTempDir() const;
  54   std::string GetCxxModuleDirectory() const
  55   {
  56     return this->CxxModulesDirectory;
  57   }
  58
  59 protected:
  60   void GenerateScript(std::ostream& os) override;
  61   void GenerateScriptConfigs(std::ostream& os, Indent indent) override;
  62   void GenerateScriptActions(std::ostream& os, Indent indent) override;
  63   void GenerateImportFile(cmExportSet const* exportSet);
  64   void GenerateImportFile(const char* config, cmExportSet const* exportSet);
  65   std::string TempDirCalculate() const;
  66   void ComputeTempDir();
  67
  68   cmExportSet* const ExportSet;
  69   std::string const FilePermissions;
  70   std::string const FileName;
  71   std::string const Namespace;
  72   std::string const CxxModulesDirectory;
  73   bool const ExportOld;
  74   cmLocalGenerator* LocalGenerator = nullptr;
  75
  76   std::string TempDir;
  77   std::string MainImportFile;
  78   std::unique_ptr<cmExportInstallFileGenerator> EFGen;
  79 };