Source/CPack/cmCPackExternalGenerator.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 <memory>
   6 #include <string>
   7
   8 #include "cm_sys_stat.h"
   9
  10 #include "cmCPackGenerator.h"
  11
  12 class cmGlobalGenerator;
  13 namespace Json {
  14 class Value;
  15 }
  16
  17 /** \class cmCPackExternalGenerator
  18  * \brief A generator for CPack External packaging tools
  19  */
  20 class cmCPackExternalGenerator : public cmCPackGenerator
  21 {
  22 public:
  23   cmCPackTypeMacro(cmCPackExternalGenerator, cmCPackGenerator);
  24
  25   const char* GetOutputExtension() override { return ".json"; }
  26
  27 protected:
  28   int InitializeInternal() override;
  29
  30   int PackageFiles() override;
  31
  32   bool SupportsComponentInstallation() const override;
  33
  34   int InstallProjectViaInstallCommands(
  35     bool setDestDir, const std::string& tempInstallDirectory) override;
  36   int InstallProjectViaInstallScript(
  37     bool setDestDir, const std::string& tempInstallDirectory) override;
  38   int InstallProjectViaInstalledDirectories(
  39     bool setDestDir, const std::string& tempInstallDirectory,
  40     const mode_t* default_dir_mode) override;
  41
  42   int RunPreinstallTarget(const std::string& installProjectName,
  43                           const std::string& installDirectory,
  44                           cmGlobalGenerator* globalGenerator,
  45                           const std::string& buildConfig) override;
  46   int InstallCMakeProject(bool setDestDir, const std::string& installDirectory,
  47                           const std::string& baseTempInstallDirectory,
  48                           const mode_t* default_dir_mode,
  49                           const std::string& component, bool componentInstall,
  50                           const std::string& installSubDirectory,
  51                           const std::string& buildConfig,
  52                           std::string& absoluteDestFiles) override;
  53
  54 private:
  55   bool StagingEnabled() const;
  56
  57   class cmCPackExternalVersionGenerator
  58   {
  59   public:
  60     cmCPackExternalVersionGenerator(cmCPackExternalGenerator* parent);
  61
  62     virtual ~cmCPackExternalVersionGenerator() = default;
  63
  64     virtual int WriteToJSON(Json::Value& root);
  65
  66   protected:
  67     virtual int GetVersionMajor() = 0;
  68     virtual int GetVersionMinor() = 0;
  69
  70     int WriteVersion(Json::Value& root);
  71
  72     cmCPackExternalGenerator* Parent;
  73   };
  74
  75   class cmCPackExternalVersion1Generator
  76     : public cmCPackExternalVersionGenerator
  77   {
  78   public:
  79     using cmCPackExternalVersionGenerator::cmCPackExternalVersionGenerator;
  80
  81   protected:
  82     int GetVersionMajor() override { return 1; }
  83     int GetVersionMinor() override { return 0; }
  84   };
  85
  86   std::unique_ptr<cmCPackExternalVersionGenerator> Generator;
  87 };