ConfigInt Class Reference

Class representing an integer type option. More...

#include <src/configimpl.h>

Inheritance diagram for ConfigInt:

Collaboration diagram for ConfigInt:

Public Member Functions
	ConfigInt (const char *name, const char *doc, int minVal, int maxVal, int defVal)
DString *	valueStringRef ()
int *	valueRef ()
int	minVal () const
int	maxVal () const
void	convertStrToVal (Config::CompareMode compareMode) override
void	substEnvVars () override
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
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
int	m_value
int	m_defValue
int	m_minVal
int	m_maxVal
DString	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 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 integer type option.

Definition at line 215 of file configimpl.h.

Constructor & Destructor Documentation

ConfigInt()

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

inline

Definition at line 218 of file configimpl.h.

      : ConfigOption(O_Int)
    {
      m_name = name;
      m_doc = doc;
      m_value = defVal;
      m_defValue = defVal;
      m_minVal = minVal;
      m_maxVal = maxVal;
    }

References ConfigOption::ConfigOption(), m_defValue, ConfigOption::m_doc, m_maxVal, m_minVal, ConfigOption::m_name, m_value, maxVal(), minVal(), ConfigOption::name(), and ConfigOption::O_Int.

Referenced by ConfigImpl::addInt().

Member Function Documentation

compareDoxyfile()

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

overridevirtual

Implements ConfigOption.

Definition at line 550 of file configimpl.l.

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

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

convertStrToVal()

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

overridevirtual

Reimplemented from ConfigOption.

Definition at line 195 of file configimpl.l.

{
  if (!m_valueString.empty())
  {
    if (compareMode == Config::CompareMode::CompressedNoEnv)
    {
       if (containsEnvVar(m_valueString)) return;
    }
    bool ok = false;
    int val = m_valueString.toInt(&ok);
    if (!ok || val<m_minVal || val>m_maxVal)
    {
      ConfigImpl::config_warn("argument '{}' for option {} is not a valid number in the range [{}..{}]!\n"
                "Using the default: {}!\n",m_valueString,m_name,m_minVal,m_maxVal,m_value);
    }
    else
    {
      m_value=val;
    }
  }
}

References Config::CompressedNoEnv, ConfigImpl::config_warn(), containsEnvVar(), DString::empty(), m_maxVal, m_minVal, ConfigOption::m_name, m_value, m_valueString, and DString::toInt().

init()

void ConfigInt::init ( )

inlineoverridevirtual

Reimplemented from ConfigOption.

Definition at line 238 of file configimpl.h.

{ m_value = m_defValue; }

References m_defValue, and m_value.

isDefault()

bool ConfigInt::isDefault ( )

inlineoverridevirtual

Reimplemented from ConfigOption.

Definition at line 239 of file configimpl.h.

{ return m_value == m_defValue; }

References m_defValue, and m_value.

Referenced by compareDoxyfile(), and writeXMLDoxyfile().

maxVal()

int ConfigInt::maxVal ( ) const

inline

Definition at line 231 of file configimpl.h.

{ return m_maxVal; }

References m_maxVal.

Referenced by ConfigInt().

minVal()

int ConfigInt::minVal ( ) const

inline

Definition at line 230 of file configimpl.h.

{ return m_minVal; }

References m_minVal.

Referenced by ConfigInt().

substEnvVars()

void ConfigInt::substEnvVars ( )

overridevirtual

Implements ConfigOption.

Definition at line 1530 of file configimpl.l.

{
  substEnvVarsInString(m_valueString);
}

References m_valueString, and substEnvVarsInString().

valueRef()

int * ConfigInt::valueRef ( )

inline

Definition at line 229 of file configimpl.h.

{ return &m_value; }

References m_value.

valueStringRef()

DString * ConfigInt::valueStringRef ( )

inline

Definition at line 228 of file configimpl.h.

{ return &m_valueString; }

References m_valueString.

Referenced by DocPara::handleDoxyConfig().

writeTemplate()

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

overridevirtual

Implements ConfigOption.

Definition at line 526 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()) << "=";
  if (upd && !m_valueString.empty())
  {
    writeStringValue(t,m_valueString);
  }
  else
  {
    writeIntValue(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, m_valueString, ConfigOption::MAX_OPTION_LENGTH, ConfigOption::writeIntValue(), and ConfigOption::writeStringValue().

Referenced by compareDoxyfile().

writeXMLDoxyfile()

void ConfigInt::writeXMLDoxyfile ( TextStream & t )

overridevirtual

Implements ConfigOption.

Definition at line 555 of file configimpl.l.

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

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

writeXSDDoxyfile()

void ConfigInt::writeXSDDoxyfile ( TextStream & t )

overridevirtual

Implements ConfigOption.

Definition at line 567 of file configimpl.l.

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

References ConfigOption::m_name.

Member Data Documentation

m_defValue

int ConfigInt::m_defValue

private

Definition at line 242 of file configimpl.h.

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

m_maxVal

int ConfigInt::m_maxVal

private

Definition at line 244 of file configimpl.h.

Referenced by ConfigInt(), convertStrToVal(), and maxVal().

m_minVal

int ConfigInt::m_minVal

private

Definition at line 243 of file configimpl.h.

Referenced by ConfigInt(), convertStrToVal(), and minVal().

m_value

int ConfigInt::m_value

private

Definition at line 241 of file configimpl.h.

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

m_valueString

DString ConfigInt::m_valueString

private

Definition at line 245 of file configimpl.h.

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

---

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

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