ConfigEnum Class Reference

Class representing an enum type option. More...

#include <src/configimpl.h>

Inheritance diagram for ConfigEnum:

Collaboration diagram for ConfigEnum:

Public Member Functions
	ConfigEnum (const char *name, const char *doc, const char *defVal)
void	addValue (const char *v)
const std::vector< DString > &	values () const
DString *	valueRef ()
void	substEnvVars () override
void	writeTemplate (TextStream &t, bool sl, bool) override
void	convertStrToVal (Config::CompareMode compareMode) 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
DString	name () const
DString	docs () const
DString	dependsOn () const
void	addDependency (const char *dep)
void	setEncoding (const DString &e)
void	setUserComment (const DString &u)

Private Attributes
std::vector< DString >	m_valueRange
DString	m_value
DString	m_defValue

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 DString &s, bool initSpace=true, bool wasQuoted=false)
void	writeStringList (TextStream &t, const StringVector &l)
Protected Attributes inherited from ConfigOption
DString	m_spaces
DString	m_name
DString	m_doc
DString	m_dependency
DString	m_encoding
DString	m_userComment
OptionType	m_kind

Detailed Description

Class representing an enum type option.

Definition at line 156 of file configimpl.h.

Constructor & Destructor Documentation

ConfigEnum()

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

inline

Definition at line 159 of file configimpl.h.

      : ConfigOption(O_Enum)
    {
      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_Enum.

Referenced by ConfigImpl::addEnum().

Member Function Documentation

addValue()

void ConfigEnum::addValue ( const char * v )

inline

Definition at line 167 of file configimpl.h.

{ m_valueRange.emplace_back(v); }

References m_valueRange.

compareDoxyfile()

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

overridevirtual

Implements ConfigOption.

Definition at line 463 of file configimpl.l.

{
  if (!isDefault()) writeTemplate(t,true,true);
}

References isDefault(), and writeTemplate().

convertStrToVal()

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

overridevirtual

Reimplemented from ConfigOption.

Definition at line 259 of file configimpl.l.

{
  if (m_value.empty())
  {
    m_value = m_defValue;
    return;
  }
  if (compareMode == Config::CompareMode::CompressedNoEnv)
  {
     if (containsEnvVar(m_value)) return;
  }
  DString val = m_value.stripWhiteSpace().lower();
  for (const auto &s : m_valueRange)
  {
    if (s.lower() == val)
    {
       m_value = s;
       return;
    }
  }
 
  ConfigImpl::config_warn("argument '{}' for option {} is not a valid enum value\n"
              "Using the default: {}!\n",m_value,m_name,m_defValue);
  m_value = m_defValue;
}

References Config::CompressedNoEnv, ConfigImpl::config_warn(), containsEnvVar(), DString::empty(), DString::lower(), m_defValue, ConfigOption::m_name, m_value, m_valueRange, and DString::stripWhiteSpace().

init()

void ConfigEnum::init ( )

inlineoverridevirtual

Reimplemented from ConfigOption.

Definition at line 176 of file configimpl.h.

{ m_value = m_defValue; }

References m_defValue, and m_value.

isDefault()

bool ConfigEnum::isDefault ( )

inlineoverridevirtual

Reimplemented from ConfigOption.

Definition at line 177 of file configimpl.h.

{ return m_value == m_defValue; }

References m_defValue, and m_value.

Referenced by compareDoxyfile(), and writeXMLDoxyfile().

substEnvVars()

void ConfigEnum::substEnvVars ( )

overridevirtual

Implements ConfigOption.

Definition at line 1535 of file configimpl.l.

{
  substEnvVarsInString(m_value);
}

References m_value, and substEnvVarsInString().

valueRef()

DString * ConfigEnum::valueRef ( )

inline

Definition at line 169 of file configimpl.h.

{ return &m_value; }

References m_value.

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

values()

const std::vector< DString > & ConfigEnum::values ( ) const

inline

Definition at line 168 of file configimpl.h.

{ return m_valueRange; }

References m_valueRange.

writeTemplate()

void ConfigEnum::writeTemplate ( TextStream & t, bool sl, bool  )

overridevirtual

Implements ConfigOption.

Definition at line 446 of file configimpl.l.

{
  if (!sl)
  {
    t << "\n";
    t << convertToComment(m_doc, m_userComment);
    t << "\n";
  }
  else if (!m_userComment.empty())
  {
    t << convertToComment("", m_userComment);
  }
  t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "=";
  writeStringValue(t,m_value);
  t << "\n";
}

References convertToComment(), DString::empty(), DString::left(), DString::length(), ConfigOption::m_doc, ConfigOption::m_name, ConfigOption::m_spaces, ConfigOption::m_userComment, m_value, ConfigOption::MAX_OPTION_LENGTH, and ConfigOption::writeStringValue().

Referenced by compareDoxyfile().

writeXMLDoxyfile()

void ConfigEnum::writeXMLDoxyfile ( TextStream & t )

overridevirtual

Implements ConfigOption.

Definition at line 468 of file configimpl.l.

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

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

writeXSDDoxyfile()

void ConfigEnum::writeXSDDoxyfile ( TextStream & t )

overridevirtual

Implements ConfigOption.

Definition at line 480 of file configimpl.l.

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

References ConfigOption::m_name.

Member Data Documentation

m_defValue

DString ConfigEnum::m_defValue

private

Definition at line 182 of file configimpl.h.

Referenced by ConfigEnum(), convertStrToVal(), init(), and isDefault().

m_value

DString ConfigEnum::m_value

private

Definition at line 181 of file configimpl.h.

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

m_valueRange

std::vector<DString> ConfigEnum::m_valueRange

private

Definition at line 180 of file configimpl.h.

Referenced by addValue(), convertStrToVal(), and values().

---

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

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