Source/cmPropertyDefinitionMap.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmPropertyDefinitionMap.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2009-03-10 15:10:42 $
   7   Version:   $Revision: 1.6 $
   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 #include "cmPropertyDefinitionMap.h"
  18 #include "cmSystemTools.h"
  19 #include "cmDocumentationSection.h"
  20
  21 void cmPropertyDefinitionMap
  22 ::DefineProperty(const char *name, cmProperty::ScopeType scope,
  23                  const char *ShortDescription,
  24                  const char *FullDescription,
  25                  const char *DocumentationSection,
  26                  bool chain)
  27 {
  28   if (!name)
  29     {
  30     return;
  31     }
  32
  33   cmPropertyDefinitionMap::iterator it = this->find(name);
  34   cmPropertyDefinition *prop;
  35   if (it == this->end())
  36     {
  37     prop = &(*this)[name];
  38     prop->DefineProperty(name,scope,ShortDescription, FullDescription,
  39                          DocumentationSection, chain);
  40     }
  41 }
  42
  43 void cmPropertyDefinitionMap
  44 ::GetPropertiesDocumentation(std::map<std::string,
  45                              cmDocumentationSection *>& v) const
  46 {
  47   for(cmPropertyDefinitionMap::const_iterator j = this->begin();
  48       j != this->end(); ++j)
  49     {
  50     // add a section if needed
  51     std::string secName = j->second.GetDocumentationSection();
  52     // if a section was not specified then use the scope
  53     if (!secName.size())
  54       {
  55       switch (j->second.GetScope())
  56         {
  57         case cmProperty::GLOBAL:
  58           secName = "Properties of Global Scope";
  59           break;
  60         case cmProperty::TARGET:
  61           secName = "Properties on Targets";
  62           break;
  63         case cmProperty::SOURCE_FILE:
  64           secName = "Properties on Source Files";
  65           break;
  66         case cmProperty::DIRECTORY:
  67           secName = "Properties on Directories";
  68           break;
  69         case cmProperty::TEST:
  70           secName = "Properties on Tests";
  71           break;
  72         case cmProperty::CACHE:
  73           secName = "Properties on Cache Entries";
  74           break;
  75         case cmProperty::VARIABLE:
  76           secName = "Variables";
  77           break;
  78         case cmProperty::CACHED_VARIABLE:
  79           secName = "Cached Variables";
  80           break;
  81         default:
  82           secName = "Properties of Unknown Scope";
  83           break;
  84         }
  85       }
  86     if (!v[secName])
  87       {
  88       v[secName] = new
  89         cmDocumentationSection(secName.c_str(),
  90                                cmSystemTools::UpperCase(secName).c_str());
  91       }
  92     cmDocumentationEntry e = j->second.GetDocumentation();
  93     if (e.Brief.size() || e.Full.size())
  94       {
  95       v[secName]->Append(e);
  96       }
  97     }
  98 }
  99
 100 bool cmPropertyDefinitionMap::IsPropertyDefined(const char *name)
 101 {
 102   if (!name)
 103     {
 104     return false;
 105     }
 106
 107   cmPropertyDefinitionMap::iterator it = this->find(name);
 108   if (it == this->end())
 109     {
 110     return false;
 111     }
 112
 113   return true;
 114 }
 115
 116 bool cmPropertyDefinitionMap::IsPropertyChained(const char *name)
 117 {
 118   if (!name)
 119     {
 120     return false;
 121     }
 122
 123   cmPropertyDefinitionMap::iterator it = this->find(name);
 124   if (it == this->end())
 125     {
 126     return false;
 127     }
 128
 129   return it->second.IsChained();
 130 }