Source/cmData.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmData.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006-03-16 14:33:23 $
   7   Version:   $Revision: 1.4 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  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 #ifndef cmData_h
  18 #define cmData_h
  19
  20 #include "cmStandardIncludes.h"
  21
  22 /** \class cmData
  23  * \brief Hold extra data on a cmMakefile instance for a command.
  24  *
  25  * When CMake commands need to store extra information in a cmMakefile
  26  * instance, but the information is not needed by the makefile generators,
  27  * it can be held in a subclass of cmData.  The cmMakefile class has a map
  28  * from std::string to cmData*.  On its destruction, it destroys all the
  29  * extra data through the virtual destructor of cmData.
  30  */
  31 class cmData
  32 {
  33 public:
  34   cmData(const char* name): Name(name) {}
  35   virtual ~cmData() {}
  36
  37   const std::string& GetName() const
  38     { return this->Name; }
  39 protected:
  40   std::string Name;
  41 };
  42
  43 #endif