ConfigImpl类 参考

Singleton for configuration variables. 更多...

#include <configimpl.h>

ConfigImpl 的协作图:

Public 成员函数
void	writeTemplate (TextStream &t, bool shortIndex, bool updateOnly)
void	compareDoxyfile (TextStream &t)
void	writeXMLDoxyfile (TextStream &t)
void	setHeader (const char *header)
void	convertStrToVal ()
void	emptyValueToDefault ()
void	substituteEnvironmentVars ()
void	init ()
bool	parseString (const QCString &fn, const QCString &str, bool upd=FALSE)
bool	parse (const QCString &fn, bool upd=FALSE)
void	create ()
void	appendStartComment (const QCString &u)
void	appendUserComment (const QCString &u)
QCString	takeStartComment ()
QCString	takeUserComment ()
Getting configuration values.
QCString &	getString (const char *fileName, int num, const char *name) const
StringVector &	getList (const char *fileName, int num, const char *name) const
QCString &	getEnum (const char *fileName, int num, const char *name) const
int &	getInt (const char *fileName, int num, const char *name) const
bool &	getBool (const char *fileName, int num, const char *name) const
ConfigOption *	get (const QCString &name) const
Adding configuration options.
ConfigInfo *	addInfo (const char *name, const char *doc)
ConfigString *	addString (const char *name, const char *doc)
ConfigEnum *	addEnum (const char *name, const char *doc, const char *defVal)
ConfigList *	addList (const char *name, const char *doc)
ConfigInt *	addInt (const char *name, const char *doc, int minVal, int maxVal, int defVal)
ConfigBool *	addBool (const char *name, const char *doc, bool defVal)
ConfigOption *	addObsolete (const char *name, ConfigOption::OptionType orgType)
ConfigOption *	addDisabled (const char *name)

静态 Public 成员函数
static ConfigImpl *	instance ()
static void	deleteInstance ()

Protected 成员函数
	ConfigImpl ()
	~ConfigImpl ()

Private 属性
ConfigOptionList	m_options
ConfigOptionList	m_obsolete
ConfigOptionList	m_disabled
ConfigOptionMap	m_dict
QCString	m_startComment
QCString	m_userComment
bool	m_initialized
QCString	m_header

静态 Private 属性
static ConfigImpl *	m_instance

详细描述

Singleton for configuration variables.

This object holds the global static variables read from a user-supplied configuration file. The static member instance() can be used to get a pointer to the one and only instance.

Set all variables to their default values by calling Config::instance()->init()

在文件 configimpl.h 第 335 行定义.

构造及析构函数说明

ConfigImpl()

ConfigImpl::ConfigImpl ( )

inlineprotected

在文件 configimpl.h 第 588 行定义.

    {
      m_initialized = FALSE;
      create();
    }

引用了 create(), FALSE , 以及 m_initialized.

被这些函数引用 instance().

~ConfigImpl()

ConfigImpl::~ConfigImpl ( )

inlineprotected

在文件 configimpl.h 第 593 行定义.

    {
    }

成员函数说明

addBool()

ConfigBool* ConfigImpl::addBool ( const char *  name, const char *  doc, bool  defVal  )

inline

Adds a new boolean option with name and documentation doc. The boolean has a default value of defVal.

返回

An object representing the option.

在文件 configimpl.h 第 472 行定义.

    {
      ConfigBool *result = new ConfigBool(name,doc,defVal);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.insert(std::make_pair(name,result));
      return result;
    }

引用了 m_dict , 以及 m_options.

addDisabled()

ConfigOption* ConfigImpl::addDisabled ( const char *  name )

inline

Adds an option that has been disabled at compile time.

在文件 configimpl.h 第 490 行定义.

    {
      ConfigDisabled *result = new ConfigDisabled(name);
      m_disabled.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.insert(std::make_pair(name,result));
      return result;
    }

引用了 m_dict , 以及 m_disabled.

addEnum()

ConfigEnum* ConfigImpl::addEnum ( const char *  name, const char *  doc, const char *  defVal  )

inline

Adds a new enumeration option with name and documentation doc and initial value defVal.

返回

An object representing the option.

在文件 configimpl.h 第 431 行定义.

    {
      ConfigEnum *result = new ConfigEnum(name,doc,defVal);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.insert(std::make_pair(name,result));
      return result;
    }

引用了 m_dict , 以及 m_options.

addInfo()

ConfigInfo* ConfigImpl::addInfo ( const char *  name, const char *  doc  )

inline

Starts a new configuration section with name and description doc.

返回

An object representing the option.

在文件 configimpl.h 第 408 行定义.

    {
      ConfigInfo *result = new ConfigInfo(name,doc);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      return result;
    }

引用了 m_options.

addInt()

ConfigInt* ConfigImpl::addInt ( const char *  name, const char *  doc, int  minVal, int  maxVal, int  defVal  )

inline

Adds a new integer option with name and documentation doc. The integer has a range between minVal and maxVal and a default value of defVal.

返回

An object representing the option.

在文件 configimpl.h 第 458 行定义.

    {
      ConfigInt *result = new ConfigInt(name,doc,minVal,maxVal,defVal);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.insert(std::make_pair(name,result));
      return result;
    }

引用了 m_dict , 以及 m_options.

addList()

ConfigList* ConfigImpl::addList ( const char *  name, const char *  doc  )

inline

Adds a new string option with name and documentation doc.

返回

An object representing the option.

在文件 configimpl.h 第 444 行定义.

    {
      ConfigList *result = new ConfigList(name,doc);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.insert(std::make_pair(name,result));
      return result;
    }

引用了 m_dict , 以及 m_options.

addObsolete()

ConfigOption* ConfigImpl::addObsolete ( const char *  name, ConfigOption::OptionType  orgType  )

inline

Adds an option that has become obsolete.

在文件 configimpl.h 第 482 行定义.

    {
      ConfigObsolete *result = new ConfigObsolete(name,orgType);
      m_obsolete.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.insert(std::make_pair(name,result));
      return result;
    }

引用了 m_dict , 以及 m_obsolete.

addString()

ConfigString* ConfigImpl::addString ( const char *  name, const char *  doc  )

inline

Adds a new string option with name and documentation doc.

返回

An object representing the option.

在文件 configimpl.h 第 418 行定义.

    {
      ConfigString *result = new ConfigString(name,doc);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.insert(std::make_pair(name,result));
      return result;
    }

引用了 m_dict , 以及 m_options.

appendStartComment()

void ConfigImpl::appendStartComment ( const QCString &  u )

inline

Append user start comment

在文件 configimpl.h 第 557 行定义.

    {
      m_startComment += u;
    }

引用了 m_startComment.

appendUserComment()

void ConfigImpl::appendUserComment ( const QCString &  u )

inline

Append user comment

在文件 configimpl.h 第 563 行定义.

    {
      m_userComment += u;
    }

引用了 m_userComment.

compareDoxyfile()

void ConfigImpl::compareDoxyfile

(

TextStream &

t

)

Writes a the differences between the current configuration and the template configuration to stream t.

convertStrToVal()

void ConfigImpl::convertStrToVal

(

)

Converts the string values read from the configuration file to real values for non-string type options (like int, and bools)

create()

void ConfigImpl::create

(

)

Called from the constructor, will add doxygen's default options to the configuration object

被这些函数引用 ConfigImpl().

deleteInstance()

static void ConfigImpl::deleteInstance ( )

inlinestatic

Delete the instance

在文件 configimpl.h 第 349 行定义.

    {
      delete m_instance;
      m_instance=0;
    }

引用了 m_instance.

emptyValueToDefault()

void ConfigImpl::emptyValueToDefault

(

)

Sets default value in case value is empty

get()

ConfigOption* ConfigImpl::get ( const QCString &  name ) const

inline

Returns the ConfigOption corresponding with name or 0 if the option is not supported.

在文件 configimpl.h 第 393 行定义.

    {
      auto it = m_dict.find(name.str());
      return it!=m_dict.end() ? it->second : nullptr;
    }

引用了 m_dict , 以及 QCString::str().

getBool()

bool& ConfigImpl::getBool	(	const char *	fileName,
		int	num,
		const char *	name
	)		const

Returns the value of the boolean option with name fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getBool() for this.

getEnum()

QCString& ConfigImpl::getEnum	(	const char *	fileName,
		int	num,
		const char *	name
	)		const

Returns the value of the enum option with name fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getEnum() for this.

getInt()

int& ConfigImpl::getInt	(	const char *	fileName,
		int	num,
		const char *	name
	)		const

Returns the value of the integer option with name fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getInt() for this.

getList()

StringVector& ConfigImpl::getList	(	const char *	fileName,
		int	num,
		const char *	name
	)		const

Returns the value of the list option with name fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getList() for this.

getString()

QCString& ConfigImpl::getString	(	const char *	fileName,
		int	num,
		const char *	name
	)		const

Returns the value of the string option with name fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getString() for this.

init()

void ConfigImpl::init

(

)

Initialize config variables to their default value

instance()

static ConfigImpl* ConfigImpl::instance ( )

inlinestatic

Returns the one and only instance of this class

在文件 configimpl.h 第 343 行定义.

    {
      if (m_instance==0) m_instance = new ConfigImpl;
      return m_instance;
    }

引用了 ConfigImpl() , 以及 m_instance.

parse()

bool ConfigImpl::parse	(	const QCString &	fn,
		bool	upd = FALSE
	)

Parse a configuration file with name fn.

返回

TRUE if successful, FALSE if the file could not be opened or read.

parseString()

bool ConfigImpl::parseString	(	const QCString &	fn,
		const QCString &	str,
		bool	upd = FALSE
	)

Parse a configuration data in string str.

返回

TRUE if successful, or FALSE if the string could not be parsed.

setHeader()

void ConfigImpl::setHeader ( const char *  header )

inline

在文件 configimpl.h 第 515 行定义.

{ m_header = header; }

引用了 m_header.

substituteEnvironmentVars()

void ConfigImpl::substituteEnvironmentVars

(

)

Replaces references to environment variable by the actual value of the environment variable.

takeStartComment()

QCString ConfigImpl::takeStartComment ( )

inline

Take the user start comment and reset it internally

返回

user start comment

在文件 configimpl.h 第 570 行定义.

    {
      QCString result=m_startComment;
      m_startComment.resize(0);
      return substitute(result,"\r","");
    }

引用了 m_startComment, QCString::resize() , 以及 substitute().

takeUserComment()

QCString ConfigImpl::takeUserComment ( )

inline

Take the user comment and reset it internally

返回

user comment

在文件 configimpl.h 第 579 行定义.

    {
      QCString result=m_userComment;
      m_userComment.resize(0);
      return substitute(result,"\r","");
    }

引用了 m_userComment, QCString::resize() , 以及 substitute().

writeTemplate()

void ConfigImpl::writeTemplate	(	TextStream &	t,
		bool	shortIndex,
		bool	updateOnly
	)

Writes a template configuration to stream t. If shortIndex is TRUE the description of each configuration option will be omitted.

writeXMLDoxyfile()

void ConfigImpl::writeXMLDoxyfile

(

TextStream &

t

)

Writes a the used settings of the current configuration as XML format to stream t.

类成员变量说明

m_dict

ConfigOptionMap ConfigImpl::m_dict

private

在文件 configimpl.h 第 601 行定义.

被这些函数引用 addBool(), addDisabled(), addEnum(), addInt(), addList(), addObsolete(), addString() , 以及 get().

m_disabled

ConfigOptionList ConfigImpl::m_disabled

private

在文件 configimpl.h 第 600 行定义.

被这些函数引用 addDisabled().

m_header

QCString ConfigImpl::m_header

private

在文件 configimpl.h 第 606 行定义.

被这些函数引用 setHeader().

m_initialized

bool ConfigImpl::m_initialized

private

在文件 configimpl.h 第 605 行定义.

被这些函数引用 ConfigImpl().

m_instance

ConfigImpl* ConfigImpl::m_instance

staticprivate

在文件 configimpl.h 第 602 行定义.

被这些函数引用 deleteInstance() , 以及 instance().

m_obsolete

ConfigOptionList ConfigImpl::m_obsolete

private

在文件 configimpl.h 第 599 行定义.

被这些函数引用 addObsolete().

m_options

ConfigOptionList ConfigImpl::m_options

private

在文件 configimpl.h 第 598 行定义.

被这些函数引用 addBool(), addEnum(), addInfo(), addInt(), addList() , 以及 addString().

m_startComment

QCString ConfigImpl::m_startComment

private

在文件 configimpl.h 第 603 行定义.

被这些函数引用 appendStartComment() , 以及 takeStartComment().

m_userComment

QCString ConfigImpl::m_userComment

private

在文件 configimpl.h 第 604 行定义.

被这些函数引用 appendUserComment() , 以及 takeUserComment().

---

该类的文档由以下文件生成:

• src/configimpl.h