CMake/Source/cmCacheManager.h

135 lines
4.3 KiB
C
Raw Normal View History

/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
2002-01-21 23:30:43 +03:00
Copyright (c) 2002 Insight Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
2002-01-21 23:30:43 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmCacheManager_h
#define cmCacheManager_h
#include "cmStandardIncludes.h"
class cmMakefile;
/** \class cmCacheManager
* \brief Control class for cmake's cache
*
* Load and Save CMake cache files.
*
*/
class cmCacheManager
{
public:
2001-05-16 23:15:21 +04:00
enum CacheEntryType{ BOOL=0, PATH, FILEPATH, STRING, INTERNAL,STATIC };
2001-04-26 22:53:44 +04:00
struct CacheEntry
{
std::string m_Value;
2001-04-26 22:53:44 +04:00
std::string m_HelpString;
CacheEntryType m_Type;
};
2002-08-21 19:57:12 +04:00
class CacheIterator
{
public:
2002-08-24 00:13:34 +04:00
void Begin();
bool IsAtEnd();
void Next();
2002-08-21 19:57:12 +04:00
const char *GetName() {
return position->first.c_str(); }
CacheEntry const &GetEntry() {
return position->second; }
cmCacheManager const &m_Container;
std::map<cmStdString, CacheEntry>::const_iterator position;
CacheIterator(cmCacheManager const &foo) : m_Container(foo) {
this->Begin();
}
};
friend class cmCacheManager::CacheIterator;
///! return an iterator to iterate through the cache map
cmCacheManager::CacheIterator NewIterator()
{
return CacheIterator(*this);
}
typedef std::map<cmStdString, CacheEntry> CacheEntryMap;
/**
* Types for the cache entries. These are useful as
* hints for a cache editor program. Path should bring
* up a file chooser, BOOL a check box, and STRING a
* text entry box, FILEPATH is a full path to a file which
* can be different than just a path input
*/
static CacheEntryType StringToType(const char*);
///! Singleton pattern get instance of the cmCacheManager.
2002-08-24 00:13:34 +04:00
static cmCacheManager* GetInstance();
static void DeleteInstance();
2001-04-24 20:40:37 +04:00
///! Load a cache for given makefile. Loads from ouput home.
2002-08-24 00:13:34 +04:00
bool LoadCache(cmMakefile*);
///! Load a cache for given makefile. Loads from path/CMakeCache.txt.
2002-08-24 00:13:34 +04:00
bool LoadCache(const char* path);
bool LoadCache(const char* path, bool internal);
bool LoadCache(const char* path, bool internal,
2001-08-16 19:41:44 +04:00
std::set<std::string>& excludes,
std::set<std::string>& includes);
///! Save cache for given makefile. Saves to ouput home CMakeCache.txt.
2002-08-24 00:13:34 +04:00
bool SaveCache(cmMakefile*) ;
///! Save cache for given makefile. Saves to ouput path/CMakeCache.txt
2002-08-24 00:13:34 +04:00
bool SaveCache(const char* path) ;
///! Print the cache to a stream
void PrintCache(std::ostream&) const;
///! Get a cache entry object for a key
2002-08-24 00:13:34 +04:00
CacheEntry *GetCacheEntry(const char *key);
2002-08-24 00:13:34 +04:00
bool IsAdvanced(const char* key);
///! Remove an entry from the cache
2002-08-24 00:13:34 +04:00
void RemoveCacheEntry(const char* key);
2002-08-21 19:57:12 +04:00
///! Get the number of entries in the cache
2002-08-24 00:13:34 +04:00
int GetSize() {
2002-08-23 23:13:49 +04:00
return static_cast<int>(m_Cache.size()); }
///! Break up a line like VAR:type="value" into var, type and value
static bool ParseEntry(const char* entry,
std::string& var,
std::string& value,
CacheEntryType& type);
protected:
///! Add an entry into the cache
void AddCacheEntry(const char* key, const char* value,
const char* helpString, CacheEntryType type);
///! Add a BOOL entry into the cache
void AddCacheEntry(const char* key, bool, const char* helpString);
2001-04-25 00:49:12 +04:00
///! Get a value from the cache given a key
2001-04-25 00:49:12 +04:00
const char* GetCacheValue(const char* key) const;
private:
2001-04-26 22:53:44 +04:00
static void OutputHelpString(std::ofstream& fout,
const std::string& helpString);
static cmCacheManager* s_Instance;
CacheEntryMap m_Cache;
// Only cmake and cmMakefile should be able to add cache values
// the commands should never use the cmCacheManager directly
friend class cmMakefile; // allow access to add cache values
friend class cmake; // allow access to add cache values
friend class cmakewizard; // allow access to add cache values
};
#endif