135 lines
4.4 KiB
C++
135 lines
4.4 KiB
C++
/*=========================================================================
|
|
|
|
Program: Insight Segmentation & Registration Toolkit
|
|
Module: $RCSfile$
|
|
Language: C++
|
|
Date: $Date$
|
|
Version: $Revision$
|
|
|
|
Copyright (c) 2002 Insight Consortium. All rights reserved.
|
|
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
|
|
|
|
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:
|
|
enum CacheEntryType{ BOOL=0, PATH, FILEPATH, STRING, INTERNAL,STATIC };
|
|
struct CacheEntry
|
|
{
|
|
std::string m_Value;
|
|
std::string m_HelpString;
|
|
CacheEntryType m_Type;
|
|
};
|
|
class CacheIterator
|
|
{
|
|
public:
|
|
CM_EXPORT void Begin();
|
|
CM_EXPORT bool IsAtEnd();
|
|
CM_EXPORT void Next();
|
|
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.
|
|
CM_EXPORT static cmCacheManager* GetInstance();
|
|
CM_EXPORT static void DeleteInstance();
|
|
|
|
///! Load a cache for given makefile. Loads from ouput home.
|
|
CM_EXPORT bool LoadCache(cmMakefile*);
|
|
///! Load a cache for given makefile. Loads from path/CMakeCache.txt.
|
|
CM_EXPORT bool LoadCache(const char* path);
|
|
CM_EXPORT bool LoadCache(const char* path, bool internal);
|
|
CM_EXPORT bool LoadCache(const char* path, bool internal,
|
|
std::set<std::string>& excludes,
|
|
std::set<std::string>& includes);
|
|
|
|
///! Save cache for given makefile. Saves to ouput home CMakeCache.txt.
|
|
CM_EXPORT bool SaveCache(cmMakefile*) ;
|
|
///! Save cache for given makefile. Saves to ouput path/CMakeCache.txt
|
|
CM_EXPORT bool SaveCache(const char* path) ;
|
|
|
|
///! Print the cache to a stream
|
|
void PrintCache(std::ostream&) const;
|
|
|
|
///! Get a cache entry object for a key
|
|
CM_EXPORT CacheEntry *GetCacheEntry(const char *key);
|
|
|
|
CM_EXPORT bool IsAdvanced(const char* key);
|
|
|
|
///! Remove an entry from the cache
|
|
CM_EXPORT void RemoveCacheEntry(const char* key);
|
|
|
|
///! Get the number of entries in the cache
|
|
CM_EXPORT int GetSize() {
|
|
return 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);
|
|
|
|
///! Get a value from the cache given a key
|
|
const char* GetCacheValue(const char* key) const;
|
|
|
|
private:
|
|
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
|