CMakeLua/Source/CPack/cmCPackComponentGroup.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCPackComponentGroup.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-07-09 20:30:53 $
   7   Version:   $Revision: 1.4 $
   8
   9   Copyright (c) 2002 Kitware, Inc. 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
  18 #ifndef cmCPackComponentGroup_h
  19 #define cmCPackComponentGroup_h
  20
  21 #include "cmStandardIncludes.h"
  22
  23 class cmCPackComponentGroup;
  24
  25 /** \class cmCPackInstallationType
  26  * \brief A certain type of installation, which encompasses a
  27  * set of components.
  28  */
  29 class cmCPackInstallationType
  30 {
  31 public:
  32   /// The name of the installation type (used to reference this
  33   /// installation type).
  34   std::string Name;
  35
  36   /// The name of the installation type as displayed to the user.
  37   std::string DisplayName;
  38
  39   /// The index number of the installation type. This is an arbitrary
  40   /// numbering from 1 to the number of installation types.
  41   unsigned Index;
  42 };
  43
  44 /** \class cmCPackComponent
  45  * \brief A single component to be installed by CPack.
  46  */
  47 class cmCPackComponent
  48 {
  49 public:
  50  cmCPackComponent() : Group(0), TotalSize(0) { }
  51
  52   /// The name of the component (used to reference the component).
  53   std::string Name;
  54
  55   /// The name of the component as displayed to the user.
  56   std::string DisplayName;
  57
  58   /// The component group that contains this component (if any).
  59   cmCPackComponentGroup *Group;
  60
  61   /// Whether this component group must always be installed.
  62   bool IsRequired : 1;
  63
  64   /// Whether this component group is hidden. A hidden component group
  65   /// is always installed. However, it may still be shown to the user.
  66   bool IsHidden : 1;
  67
  68   /// Whether this component defaults to "disabled".
  69   bool IsDisabledByDefault : 1;
  70
  71   /// Whether this component should be downloaded on-the-fly. If false,
  72   /// the component will be a part of the installation package.
  73   bool IsDownloaded : 1;
  74
  75   /// A description of this component.
  76   std::string Description;
  77
  78   /// The installation types that this component is a part of.
  79   std::vector<cmCPackInstallationType *> InstallationTypes;
  80
  81   /// If IsDownloaded is true, the name of the archive file that
  82   /// contains the files that are part of this component.
  83   std::string ArchiveFile;
  84
  85   /// The components that this component depends on.
  86   std::vector<cmCPackComponent *> Dependencies;
  87
  88   /// The components that depend on this component.
  89   std::vector<cmCPackComponent *> ReverseDependencies;
  90
  91   /// The list of installed files that are part of this component.
  92   std::vector<std::string> Files;
  93
  94   /// The list of installed directories that are part of this component.
  95   std::vector<std::string> Directories;
  96
  97   /// Get the total installed size of all of the files in this
  98   /// component, in bytes. installDir is the directory into which the
  99   /// component was installed.
 100   unsigned long GetInstalledSize(const char* installDir) const;
 101
 102   /// Identical to GetInstalledSize, but returns the result in
 103   /// kilobytes.
 104   unsigned long GetInstalledSizeInKbytes(const char* installDir) const;
 105
 106  private:
 107   mutable unsigned long TotalSize;
 108 };
 109
 110 /** \class cmCPackComponentGroup
 111  * \brief A component group to be installed by CPack.
 112  */
 113 class cmCPackComponentGroup
 114 {
 115 public:
 116  cmCPackComponentGroup() : ParentGroup(0) { }
 117
 118   /// The name of the group (used to reference the group).
 119   std::string Name;
 120
 121   /// The name of the component as displayed to the user.
 122   std::string DisplayName;
 123
 124   /// The description of this component group.
 125   std::string Description;
 126
 127   /// Whether the name of the component will be shown in bold.
 128   bool IsBold : 1;
 129
 130   /// Whether the section should be expanded by default
 131   bool IsExpandedByDefault : 1;
 132
 133   /// The components within this group.
 134   std::vector<cmCPackComponent*> Components;
 135
 136   /// The parent group of this component group (if any).
 137   cmCPackComponentGroup *ParentGroup;
 138
 139   /// The subgroups of this group.
 140   std::vector<cmCPackComponentGroup*> Subgroups;
 141 };
 142
 143 #endif