Source/cmInstalledFile.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 <map>
   8 #include <memory>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "cmGeneratorExpression.h"
  13
  14 class cmMakefile;
  15
  16 /** \class cmInstalledFile
  17  * \brief Represents a file intended for installation.
  18  *
  19  * cmInstalledFile represents a file intended for installation.
  20  */
  21 class cmInstalledFile
  22 {
  23 public:
  24   using CompiledGeneratorExpressionPtrType =
  25     std::unique_ptr<cmCompiledGeneratorExpression>;
  26
  27   using ExpressionVectorType = std::vector<CompiledGeneratorExpressionPtrType>;
  28
  29   struct Property
  30   {
  31     Property();
  32     ~Property();
  33
  34     Property(const Property&) = delete;
  35     Property& operator=(const Property&) = delete;
  36
  37     ExpressionVectorType ValueExpressions;
  38   };
  39
  40   using PropertyMapType = std::map<std::string, Property>;
  41
  42   cmInstalledFile();
  43
  44   ~cmInstalledFile();
  45
  46   cmInstalledFile(const cmInstalledFile&) = delete;
  47   cmInstalledFile& operator=(const cmInstalledFile&) = delete;
  48
  49   void RemoveProperty(const std::string& prop);
  50
  51   void SetProperty(cmMakefile const* mf, const std::string& prop,
  52                    const std::string& value);
  53
  54   void AppendProperty(cmMakefile const* mf, const std::string& prop,
  55                       const std::string& value, bool asString = false);
  56
  57   bool HasProperty(const std::string& prop) const;
  58
  59   bool GetProperty(const std::string& prop, std::string& value) const;
  60
  61   bool GetPropertyAsBool(const std::string& prop) const;
  62
  63   std::vector<std::string> GetPropertyAsList(const std::string& prop) const;
  64
  65   void SetName(cmMakefile* mf, const std::string& name);
  66
  67   std::string const& GetName() const;
  68
  69   cmCompiledGeneratorExpression const& GetNameExpression() const;
  70
  71   PropertyMapType const& GetProperties() const { return this->Properties; }
  72
  73 private:
  74   std::string Name;
  75   CompiledGeneratorExpressionPtrType NameExpression;
  76   PropertyMapType Properties;
  77 };