ConfigBool Class Reference

Class representing a Boolean type option. More...

#include <src/configimpl.h>

Inheritance diagram for ConfigBool:

Collaboration diagram for ConfigBool:

Public Member Functions
	ConfigBool (const char *name, const char *doc, bool defVal)
QCString *	valueStringRef ()
bool *	valueRef ()
void	convertStrToVal (Config::CompareMode compareMode) override
void	substEnvVars () override
void	setValueString (const QCString &v)
void	writeTemplate (TextStream &t, bool sl, bool upd) override
void	compareDoxyfile (TextStream &t, Config::CompareMode compareMode) override
void	writeXMLDoxyfile (TextStream &t) override
void	writeXSDDoxyfile (TextStream &t) override
void	init () override
bool	isDefault () override
Public Member Functions inherited from ConfigOption
	ConfigOption (OptionType t)
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)

Private Attributes
bool	m_value
bool	m_defValue
QCString	m_valueString

Additional Inherited Members
Public Types inherited from ConfigOption
enum	OptionType {   O_Info , O_List , O_Enum , O_String ,   O_Int , O_Bool , O_Obsolete , O_Disabled }
enum	{ MAX_OPTION_LENGTH = 23 }
Protected Member Functions inherited from ConfigOption
virtual void	emptyValueToDefault ()
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 Attributes inherited from ConfigOption
QCString	m_spaces
QCString	m_name
QCString	m_doc
QCString	m_dependency
QCString	m_encoding
QCString	m_userComment
OptionType	m_kind

Detailed Description

Class representing a Boolean type option.

Definition at line 254 of file configimpl.h.

Constructor & Destructor Documentation

ConfigBool()

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

inline

Definition at line 257 of file configimpl.h.

      : ConfigOption(O_Bool)
    {
      m_name = name;
      m_doc = doc;
      m_value = defVal;
      m_defValue = defVal;
    }

References ConfigOption::ConfigOption(), m_defValue, ConfigOption::m_doc, ConfigOption::m_name, m_value, ConfigOption::name(), and ConfigOption::O_Bool.

Member Function Documentation

compareDoxyfile()

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

overridevirtual

Implements ConfigOption.

Definition at line 597 of file configimpl.l.

{
  if (!isDefault() || ((compareMode == Config::CompareMode::CompressedNoEnv) && containsEnvVar(m_valueString))) writeTemplate(t,TRUE,TRUE);
}

References Config::CompressedNoEnv, containsEnvVar(), isDefault(), m_valueString, TRUE, and writeTemplate().

convertStrToVal()

void ConfigBool::convertStrToVal ( Config::CompareMode compareMode )

overridevirtual

Reimplemented from ConfigOption.

Definition at line 237 of file configimpl.l.

{
  if (!m_valueString.stripWhiteSpace().isEmpty())
  {
    if (compareMode == Config::CompareMode::CompressedNoEnv)
    {
       if (containsEnvVar(m_valueString)) return;
    }
    bool isValid=false;
    bool b = convertStringToBool(m_valueString,isValid);
    if (isValid)
    {
      m_value=b;
    }
    else
    {
      ConfigImpl::config_warn("argument '{}' for option {} is not a valid boolean value\n"
          "Using the default: {}!\n",m_valueString,m_name,m_value?"YES":"NO");
    }
  }
}

References Config::CompressedNoEnv, ConfigImpl::config_warn(), containsEnvVar(), convertStringToBool(), ConfigOption::m_name, m_value, and m_valueString.

init()

void ConfigBool::init ( )

inlineoverridevirtual

Reimplemented from ConfigOption.

Definition at line 274 of file configimpl.h.

{ m_value = m_defValue; }

References m_defValue, and m_value.

isDefault()

bool ConfigBool::isDefault ( )

inlineoverridevirtual

Reimplemented from ConfigOption.

Definition at line 275 of file configimpl.h.

{ return m_value == m_defValue; }

References m_defValue, and m_value.

Referenced by compareDoxyfile(), and writeXMLDoxyfile().

setValueString()

void ConfigBool::setValueString ( const QCString & v )

inline

Definition at line 269 of file configimpl.h.

{ m_valueString = v; }

References m_valueString.

substEnvVars()

void ConfigBool::substEnvVars ( )

overridevirtual

Implements ConfigOption.

Definition at line 1516 of file configimpl.l.

{
  substEnvVarsInString(m_valueString);
}

References m_valueString, and substEnvVarsInString().

valueRef()

bool * ConfigBool::valueRef ( )

inline

Definition at line 266 of file configimpl.h.

{ return &m_value; }

References m_value.

valueStringRef()

QCString * ConfigBool::valueStringRef ( )

inline

Definition at line 265 of file configimpl.h.

{ return &m_valueString; }

References m_valueString.

Referenced by DocPara::handleDoxyConfig(), and Config::updateObsolete().

writeTemplate()

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

overridevirtual

Implements ConfigOption.

Definition at line 572 of file configimpl.l.

{
  if (!sl)
  {
    t << "\n";
    t << convertToComment(m_doc, m_userComment);
    t << "\n";
  }
  else if (!m_userComment.isEmpty())
  {
    t << convertToComment("", m_userComment);
  }
  QCString spaces = m_spaces.left(MAX_OPTION_LENGTH-m_name.length());
  t << m_name << spaces << "=";
  if (upd && !m_valueString.isEmpty())
  {
    writeStringValue(t,m_valueString);
  }
  else
  {
    writeBoolValue(t,m_value);
  }
  t << "\n";
}

References convertToComment(), ConfigOption::m_doc, ConfigOption::m_name, ConfigOption::m_spaces, ConfigOption::m_userComment, m_value, m_valueString, ConfigOption::MAX_OPTION_LENGTH, ConfigOption::writeBoolValue(), and ConfigOption::writeStringValue().

Referenced by compareDoxyfile().

writeXMLDoxyfile()

void ConfigBool::writeXMLDoxyfile ( TextStream & t )

overridevirtual

Implements ConfigOption.

Definition at line 602 of file configimpl.l.

{
  t << "  <option  id='" << m_name << "'";
  t << " default='" << (isDefault() ? "yes" : "no") << "'";
  t << " type='bool'";
  t << ">";
  t << "<value>";
  writeBoolValue(t,m_value,false);
  t << "</value>";
  t << "</option>\n";
}

References isDefault(), ConfigOption::m_name, m_value, and ConfigOption::writeBoolValue().

writeXSDDoxyfile()

void ConfigBool::writeXSDDoxyfile ( TextStream & t )

overridevirtual

Implements ConfigOption.

Definition at line 614 of file configimpl.l.

{
  t << "      <xsd:enumeration value=\"" << m_name << "\"/>\n";
}

References ConfigOption::m_name.

Member Data Documentation

m_defValue

bool ConfigBool::m_defValue

private

Definition at line 278 of file configimpl.h.

Referenced by ConfigBool(), init(), and isDefault().

m_value

bool ConfigBool::m_value

private

Definition at line 277 of file configimpl.h.

Referenced by ConfigBool(), convertStrToVal(), init(), isDefault(), valueRef(), writeTemplate(), and writeXMLDoxyfile().

m_valueString

QCString ConfigBool::m_valueString

private

Definition at line 279 of file configimpl.h.

Referenced by compareDoxyfile(), convertStrToVal(), setValueString(), substEnvVars(), valueStringRef(), and writeTemplate().

---

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

• src/configimpl.h
• src/configimpl.l