The ConfigOption Class Reference

Abstract base class for any configuration option. More...

Declaration

class ConfigOption { ... }

Included Headers

#include <src/configimpl.h>

Derived Classes

class	ConfigBool
	Class representing a Boolean type option. More...
class	ConfigDisabled
	Section marker for compile time optional options. More...
class	ConfigEnum
	Class representing an enum type option. More...
class	ConfigInfo
	Section marker for grouping the configuration options. More...
class	ConfigInt
	Class representing an integer type option. More...
class	ConfigList
	Class representing a list type option. More...
class	ConfigObsolete
	Section marker for obsolete options. More...
class	ConfigString
	Class representing a string type option. More...

Enumerations Index

enum	OptionType { ... }
anonymous enum	{ ... }

Friends Index

class	ConfigImpl

Public Constructors Index

	ConfigOption (OptionType t)

Public Member Functions Index

OptionType	kind () const
QCString	name () const
QCString	docs () const
QCString	dependsOn () const
void	addDependency (const char *dep)
void	setEncoding (const QCString &e)
void	setUserComment (const QCString &u)

Protected Member Functions Index

void	writeTemplate (TextStream &t, bool sl, bool upd)=0
void	compareDoxyfile (TextStream &t, Config::CompareMode compareMode)=0
void	writeXMLDoxyfile (TextStream &t)=0
void	writeXSDDoxyfile (TextStream &t)=0
void	convertStrToVal (Config::CompareMode)
void	emptyValueToDefault ()
void	substEnvVars ()=0
void	init ()
bool	isDefault ()
void	writeBoolValue (TextStream &t, bool v, bool initSpace=true)
void	writeIntValue (TextStream &t, int i, bool initSpace=true)
void	writeStringValue (TextStream &t, const QCString &s, bool initSpace=true, bool wasQuoted=false)
void	writeStringList (TextStream &t, const StringVector &l)

Protected Member Attributes Index

QCString	m_spaces
QCString	m_name
QCString	m_doc
QCString	m_dependency
QCString	m_encoding
QCString	m_userComment
OptionType	m_kind

Description

Abstract base class for any configuration option.

Definition at line 38 of file configimpl.h.

Enumerations

anonymous enum

anonymous enum

Enumeration values

MAX_OPTION_LENGTH

(= 23)

Definition at line 57 of file configimpl.h.

58 {

59 /*! Maximum length of an option in the config file. Used for

60 * alignment purposes.

61 */

62 MAX_OPTION_LENGTH = 23

63 };

OptionType

enum ConfigOption::OptionType

Enumeration values

O_Info	A section header
O_List	A list of items
O_Enum	A fixed set of items
O_String	A single item
O_Int	An integer value
O_Bool	A boolean value
O_Obsolete	An obsolete option
O_Disabled	Disabled compile time option

The type of option

Definition at line 46 of file configimpl.h.

47 {

48 O_Info, //!< A section header

49 O_List, //!< A list of items

50 O_Enum, //!< A fixed set of items

51 O_String, //!< A single item

52 O_Int, //!< An integer value

53 O_Bool, //!< A boolean value

54 O_Obsolete, //!< An obsolete option

55 O_Disabled //!< Disabled compile time option

56 };

Friends

ConfigImpl

friend class ConfigImpl

Definition at line 40 of file configimpl.h.

40 friend class ConfigImpl;

References ConfigImpl and ConfigOption.

Referenced by ConfigImpl.

Public Constructors

ConfigOption()

ConfigOption::ConfigOption (OptionType t)

inline

Definition at line 64 of file configimpl.h.

64 ConfigOption(OptionType t) : m_kind(t)

65 {

66 m_spaces.fill(' ',40);

67 }

References m_kind and m_spaces.

Referenced by ConfigBool::ConfigBool, ConfigDisabled::ConfigDisabled, ConfigEnum::ConfigEnum, ConfigImpl, ConfigInfo::ConfigInfo, ConfigInt::ConfigInt, ConfigList::ConfigList, ConfigObsolete::ConfigObsolete and ConfigString::ConfigString.

Public Member Functions

addDependency()

void ConfigOption::addDependency (const char * dep)

inline

Definition at line 75 of file configimpl.h.

75 void addDependency(const char *dep) { m_dependency = dep; }

Reference m_dependency.

dependsOn()

QCString ConfigOption::dependsOn ()

inline

Definition at line 74 of file configimpl.h.

74 QCString dependsOn() const { return m_dependency; }

Reference m_dependency.

Referenced by Config::checkAndCorrect and ConfigImpl::init.

docs()

QCString ConfigOption::docs ()

inline

Definition at line 72 of file configimpl.h.

72 QCString docs() const { return m_doc; }

Reference m_doc.

kind()

OptionType ConfigOption::kind ()

inline

returns the kind of option this is.

Definition at line 70 of file configimpl.h.

70 OptionType kind() const { return m_kind; }

Reference m_kind.

Referenced by Config::checkAndCorrect, DocPara::handleDoxyConfig and Config::updateObsolete.

name()

QCString ConfigOption::name ()

inline

Definition at line 71 of file configimpl.h.

71 QCString name() const { return m_name; }

Reference m_name.

Referenced by Config::checkAndCorrect, ConfigBool::ConfigBool, ConfigDisabled::ConfigDisabled, ConfigEnum::ConfigEnum, ConfigInfo::ConfigInfo, ConfigInt::ConfigInt, ConfigList::ConfigList, ConfigObsolete::ConfigObsolete, ConfigString::ConfigString and ConfigImpl::init.

setEncoding()

void ConfigOption::setEncoding (const QCString & e)

inline

Definition at line 76 of file configimpl.h.

76 void setEncoding(const QCString &e) { m_encoding = e; }

Reference m_encoding.

setUserComment()

void ConfigOption::setUserComment (const QCString & u)

inline

Definition at line 77 of file configimpl.h.

77 void setUserComment(const QCString &u) { m_userComment += u; }

Reference m_userComment.

Protected Member Functions

compareDoxyfile()

virtual void ConfigOption::compareDoxyfile (TextStream & t, Config::CompareMode compareMode)

protected

Definition at line 81 of file configimpl.h.

Referenced by ConfigImpl::compareDoxyfile.

convertStrToVal()

virtual void ConfigOption::convertStrToVal (Config::CompareMode)

inline protected virtual

Definition at line 84 of file configimpl.h.

84 virtual void convertStrToVal(Config::CompareMode) {}

Referenced by ConfigImpl::convertStrToVal.

emptyValueToDefault()

virtual void ConfigOption::emptyValueToDefault ()

inline protected virtual

Definition at line 85 of file configimpl.h.

85 virtual void emptyValueToDefault() {}

Referenced by ConfigImpl::emptyValueToDefault.

init()

virtual void ConfigOption::init ()

inline protected virtual

Definition at line 87 of file configimpl.h.

87 virtual void init() {}

Referenced by ConfigImpl::init.

isDefault()

virtual bool ConfigOption::isDefault ()

inline protected virtual

Definition at line 88 of file configimpl.h.

88 virtual bool isDefault() { return true; }

substEnvVars()

virtual void ConfigOption::substEnvVars ()

protected

Definition at line 86 of file configimpl.h.

Referenced by ConfigImpl::substituteEnvironmentVars.

writeBoolValue()

void ConfigOption::writeBoolValue (TextStream & t, bool v, bool initSpace=true)

protected

Declaration at line 90 of file configimpl.h, definition at line 127 of file configimpl.l.

127void ConfigOption::writeBoolValue(TextStream &t,bool v,bool initSpace)

128{

129 if (initSpace) t << " ";

130 if (v) t << "YES"; else t << "NO";

131}

Referenced by ConfigBool::writeTemplate and ConfigBool::writeXMLDoxyfile.

writeIntValue()

void ConfigOption::writeIntValue (TextStream & t, int i, bool initSpace=true)

protected

Declaration at line 91 of file configimpl.h, definition at line 133 of file configimpl.l.

133void ConfigOption::writeIntValue(TextStream &t,int i,bool initSpace)

134{

135 if (initSpace) t << " ";

136 t << i;

137}

Referenced by ConfigInt::writeTemplate and ConfigInt::writeXMLDoxyfile.

writeStringList()

void ConfigOption::writeStringList (TextStream & t, const StringVector & l)

protected

Declaration at line 93 of file configimpl.h, definition at line 171 of file configimpl.l.

171void ConfigOption::writeStringList(TextStream &t,const StringVector &l)

172{

173 bool first=TRUE;

174 for (const auto &p : l)

175 {

176 if (!first) t << " \\\n";

177 QCString s=p.c_str();

178 if (!first)

179 t << " ";

180 bool wasQuoted = ((s.at(0)=='"') && (s.at(s.length()-1)=='"'));

181 if (wasQuoted)

182 {

183 s = s.mid(1,s.length()-2);

184 }

185 writeStringValue(t,s,true,wasQuoted);

186 first=FALSE;

187 }

188}

References QCString::at, FALSE, QCString::length, QCString::mid, TRUE and writeStringValue.

Referenced by ConfigList::writeTemplate.

writeStringValue()

void ConfigOption::writeStringValue (TextStream & t, const QCString & s, bool initSpace=true, bool wasQuoted=false)

protected

Declaration at line 92 of file configimpl.h, definition at line 139 of file configimpl.l.

139void ConfigOption::writeStringValue(TextStream &t,const QCString &s,bool initSpace, bool wasQuoted)

140{

141 char c = 0;

142 bool needsEscaping=wasQuoted;

143 // convert the string back to it original g_encoding

144 QCString se = configStringRecode(s,"UTF-8",m_encoding);

145 if (se.isEmpty()) return;

146 const char *p=se.data();

147 if (p)

148 {

149 if (initSpace) t << " ";

150 while ((c=*p++)!=0 && !needsEscaping)

151 needsEscaping = (c==' ' || c== ',' || c=='\n' || c=='\t' || c=='"' || c=='#');

152 if (needsEscaping)

153 {

154 t << "\"";

155 p=se.data();

156 while (*p)

157 {

158 if (*p==' ' && *(p+1)=='\0') break; // skip inserted space at the end

159 if (*p=='"') t << "\\"; // escape quotes

160 t << *p++;

161 }

162 t << "\"";

163 }

164 else

165 {

166 t << se;

167 }

168 }

169}

References configStringRecode, QCString::data, QCString::isEmpty and m_encoding.

Referenced by writeStringList, ConfigBool::writeTemplate, ConfigEnum::writeTemplate, ConfigInt::writeTemplate, ConfigString::writeTemplate, ConfigEnum::writeXMLDoxyfile, ConfigList::writeXMLDoxyfile and ConfigString::writeXMLDoxyfile.

writeTemplate()

virtual void ConfigOption::writeTemplate (TextStream & t, bool sl, bool upd)

protected

Definition at line 80 of file configimpl.h.

Referenced by ConfigImpl::writeTemplate.

writeXMLDoxyfile()

virtual void ConfigOption::writeXMLDoxyfile (TextStream & t)

protected

Definition at line 82 of file configimpl.h.

Referenced by ConfigImpl::writeXMLDoxyfile.

writeXSDDoxyfile()

virtual void ConfigOption::writeXSDDoxyfile (TextStream & t)

protected

Definition at line 83 of file configimpl.h.

Referenced by ConfigImpl::writeXSDDoxyfile.

Protected Member Attributes

m_dependency

QCString ConfigOption::m_dependency

protected

Definition at line 98 of file configimpl.h.

98 QCString m_dependency;

Referenced by addDependency and dependsOn.

m_doc

QCString ConfigOption::m_doc

protected

Definition at line 97 of file configimpl.h.

97 QCString m_doc;

Referenced by ConfigBool::ConfigBool, ConfigEnum::ConfigEnum, ConfigInfo::ConfigInfo, ConfigInt::ConfigInt, ConfigList::ConfigList, ConfigString::ConfigString, docs, ConfigBool::writeTemplate, ConfigEnum::writeTemplate, ConfigInfo::writeTemplate, ConfigInt::writeTemplate, ConfigList::writeTemplate and ConfigString::writeTemplate.

m_encoding

QCString ConfigOption::m_encoding

protected

Definition at line 99 of file configimpl.h.

99 QCString m_encoding;

Referenced by setEncoding and writeStringValue.

m_kind

OptionType ConfigOption::m_kind

protected

Definition at line 101 of file configimpl.h.

101 OptionType m_kind;

Referenced by ConfigOption and kind.

m_name

QCString ConfigOption::m_name

protected

Definition at line 96 of file configimpl.h.

96 QCString m_name;

Referenced by ConfigBool::ConfigBool, ConfigDisabled::ConfigDisabled, ConfigEnum::ConfigEnum, ConfigInfo::ConfigInfo, ConfigInt::ConfigInt, ConfigList::ConfigList, ConfigObsolete::ConfigObsolete, ConfigString::ConfigString, ConfigBool::convertStrToVal, ConfigEnum::convertStrToVal, ConfigInt::convertStrToVal, name, ConfigBool::writeTemplate, ConfigEnum::writeTemplate, ConfigInt::writeTemplate, ConfigList::writeTemplate, ConfigString::writeTemplate, ConfigBool::writeXMLDoxyfile, ConfigEnum::writeXMLDoxyfile, ConfigInt::writeXMLDoxyfile, ConfigList::writeXMLDoxyfile, ConfigString::writeXMLDoxyfile, ConfigBool::writeXSDDoxyfile, ConfigDisabled::writeXSDDoxyfile, ConfigEnum::writeXSDDoxyfile, ConfigInt::writeXSDDoxyfile, ConfigList::writeXSDDoxyfile and ConfigString::writeXSDDoxyfile.

m_spaces

QCString ConfigOption::m_spaces

protected

Definition at line 95 of file configimpl.h.

95 QCString m_spaces;

Referenced by ConfigOption, ConfigBool::writeTemplate, ConfigEnum::writeTemplate, ConfigInt::writeTemplate, ConfigList::writeTemplate and ConfigString::writeTemplate.

m_userComment

QCString ConfigOption::m_userComment

protected

Definition at line 100 of file configimpl.h.

100 QCString m_userComment;

Referenced by ConfigImpl::compareDoxyfile, setUserComment, ConfigBool::writeTemplate, ConfigEnum::writeTemplate, ConfigInt::writeTemplate, ConfigList::writeTemplate and ConfigString::writeTemplate.

---

The documentation for this class was generated from the following files:

• configimpl.h
• configimpl.l

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.