blob: 8462259784bb69111e57aad12cad6cbb8c21c229 [file] [log] [blame]
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
See the License for more information.
#ifndef cmCacheManager_h
#define cmCacheManager_h
#include "cmStandardIncludes.h"
#include "cmPropertyMap.h"
#include "cmState.h"
class cmMakefile;
class cmMarkAsAdvancedCommand;
class cmake;
/** \class cmCacheManager
* \brief Control class for cmake's cache
* Load and Save CMake cache files.
class cmCacheManager
cmCacheManager(cmake* cm);
class CacheIterator;
friend class cmCacheManager::CacheIterator;
struct CacheEntry
std::string Value;
cmState::CacheEntryType Type;
cmPropertyMap Properties;
const char* GetProperty(const std::string&) const;
void SetProperty(const std::string& property, const char* value);
void AppendProperty(const std::string& property, const char* value,
bool asString=false);
bool Initialized;
: Value(""),
class CacheIterator
void Begin();
bool Find(const std::string&);
bool IsAtEnd() const;
void Next();
std::string GetName() const {
return this->Position->first; }
const char* GetProperty(const std::string&) const ;
bool GetPropertyAsBool(const std::string&) const ;
bool PropertyExists(const std::string&) const;
void SetProperty(const std::string& property, const char* value);
void AppendProperty(const std::string& property, const char* value,
bool asString=false);
void SetProperty(const std::string& property, bool value);
const char* GetValue() const { return this->GetEntry().Value.c_str(); }
bool GetValueAsBool() const;
void SetValue(const char*);
cmState::CacheEntryType GetType() const
{ return this->GetEntry().Type; }
void SetType(cmState::CacheEntryType ty)
{ this->GetEntry().Type = ty; }
bool Initialized() { return this->GetEntry().Initialized; }
cmCacheManager &Container;
std::map<std::string, CacheEntry>::iterator Position;
CacheIterator(cmCacheManager &cm) : Container(cm) {
CacheIterator(cmCacheManager &cm, const char* key) : Container(cm)
if ( key )
CacheEntry const& GetEntry() const { return this->Position->second; }
CacheEntry& GetEntry() { return this->Position->second; }
///! return an iterator to iterate through the cache map
cmCacheManager::CacheIterator NewIterator()
return CacheIterator(*this);
///! Load a cache for given makefile. Loads from path/CMakeCache.txt.
bool LoadCache(const std::string& path);
bool LoadCache(const std::string& path, bool internal,
std::set<std::string>& excludes,
std::set<std::string>& includes);
///! Save cache for given makefile. Saves to ouput path/CMakeCache.txt
bool SaveCache(const std::string& path) ;
///! Delete the cache given
bool DeleteCache(const std::string& path);
///! Print the cache to a stream
void PrintCache(std::ostream&) const;
///! Get the iterator for an entry with a given key.
cmCacheManager::CacheIterator GetCacheIterator(const char *key=0);
///! Remove an entry from the cache
void RemoveCacheEntry(const std::string& key);
///! Get the number of entries in the cache
int GetSize() {
return static_cast<int>(this->Cache.size()); }
///! Break up a line like VAR:type="value" into var, type and value
static bool ParseEntry(const std::string& entry,
std::string& var,
std::string& value,
cmState::CacheEntryType& type);
///! Get a value from the cache given a key
const char* GetInitializedCacheValue(const std::string& key) const;
const char* GetCacheEntryValue(const std::string& key)
cmCacheManager::CacheIterator it = this->GetCacheIterator(key.c_str());
if (it.IsAtEnd())
return 0;
return it.GetValue();
const char* GetCacheEntryProperty(std::string const& key,
std::string const& propName)
return this->GetCacheIterator(key.c_str()).GetProperty(propName);
cmState::CacheEntryType GetCacheEntryType(std::string const& key)
return this->GetCacheIterator(key.c_str()).GetType();
bool GetCacheEntryPropertyAsBool(std::string const& key,
std::string const& propName)
return this->GetCacheIterator(key.c_str()).GetPropertyAsBool(propName);
void SetCacheEntryProperty(std::string const& key,
std::string const& propName,
std::string const& value)
this->GetCacheIterator(key.c_str()).SetProperty(propName, value.c_str());
void SetCacheEntryBoolProperty(std::string const& key,
std::string const& propName,
bool value)
this->GetCacheIterator(key.c_str()).SetProperty(propName, value);
void SetCacheEntryValue(std::string const& key,
std::string const& value)
void RemoveCacheEntryProperty(std::string const& key,
std::string const& propName)
this->GetCacheIterator(key.c_str()).SetProperty(propName, (void*)0);
void AppendCacheEntryProperty(std::string const& key,
std::string const& propName,
std::string const& value,
bool asString = false)
std::vector<std::string> GetCacheEntryKeys()
std::vector<std::string> definitions;
cmCacheManager::CacheIterator cit = this->GetCacheIterator();
for ( cit.Begin(); !cit.IsAtEnd(); cit.Next() )
return definitions;
/** Get the version of CMake that wrote the cache. */
unsigned int GetCacheMajorVersion() const
{ return this->CacheMajorVersion; }
unsigned int GetCacheMinorVersion() const
{ return this->CacheMinorVersion; }
///! Add an entry into the cache
void AddCacheEntry(const std::string& key, const char* value,
const char* helpString,
cmState::CacheEntryType type);
///! Get a cache entry object for a key
CacheEntry *GetCacheEntry(const std::string& key);
///! Clean out the CMakeFiles directory if no CMakeCache.txt
void CleanCMakeFiles(const std::string& path);
// Cache version info
unsigned int CacheMajorVersion;
unsigned int CacheMinorVersion;
cmake* CMakeInstance;
typedef std::map<std::string, CacheEntry> CacheEntryMap;
static void OutputHelpString(std::ostream& fout,
const std::string& helpString);
static void OutputKey(std::ostream& fout, std::string const& key);
static void OutputValue(std::ostream& fout, std::string const& value);
static const char* PersistentProperties[];
bool ReadPropertyEntry(std::string const& key, CacheEntry& e);
void WritePropertyEntries(std::ostream& os, CacheIterator const& i);
CacheEntryMap Cache;
// Only cmake and cmMakefile should be able to add cache values
// the commands should never use the cmCacheManager directly
friend class cmState; // allow access to add cache values
friend class cmake; // allow access to add cache values