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

#include <src/configimpl.h>

Inheritance diagram for ConfigOption:

Collaboration diagram for ConfigOption:

Public Types
enum	OptionType { O_Info , O_List , O_Enum , O_String , O_Int , O_Bool , O_Obsolete , O_Disabled }

enum	{ MAX_OPTION_LENGTH = 23 }

Public Member Functions
	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)

Protected Member Functions
virtual void	writeTemplate (TextStream &t, bool sl, bool upd)=0

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

virtual void	writeXMLDoxyfile (TextStream &t)=0

virtual void	writeXSDDoxyfile (TextStream &t)=0

virtual void	convertStrToVal (Config::CompareMode)

virtual void	emptyValueToDefault ()

virtual void	substEnvVars ()=0

virtual void	init ()

virtual 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 Attributes
QCString	m_spaces

QCString	m_name

QCString	m_doc

QCString	m_dependency

QCString	m_encoding

QCString	m_userComment

OptionType	m_kind

Friends
class	ConfigImpl

Detailed Description

Abstract base class for any configuration option.

Definition at line 37 of file configimpl.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
MAX_OPTION_LENGTH	Maximum length of an option in the config file. Used for alignment purposes.

Definition at line 56 of file configimpl.h.

    {
     /*! Maximum length of an option in the config file. Used for
      *  alignment purposes.
      */
      MAX_OPTION_LENGTH = 23
    };

◆ OptionType

enum ConfigOption::OptionType

The type of option

Enumerator
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.

Definition at line 45 of file configimpl.h.

    {
      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
    };

Constructor & Destructor Documentation

◆ ConfigOption()

ConfigOption::ConfigOption ( OptionType t )

inline

Definition at line 63 of file configimpl.h.

                               : m_kind(t)
    {
      m_spaces.fill(' ',40);
    }

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().

Member Function Documentation

◆ addDependency()

void ConfigOption::addDependency ( const char * dep )

inline

Definition at line 74 of file configimpl.h.

74{ m_dependency = dep; }

ConfigOption::m_dependency

QCString m_dependency

Definition configimpl.h:97

References m_dependency.

◆ compareDoxyfile()

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

protectedpure virtual

Implemented in ConfigBool, ConfigDisabled, ConfigEnum, ConfigInfo, ConfigInt, ConfigList, ConfigObsolete, and ConfigString.

Referenced by ConfigImpl::compareDoxyfile().

◆ convertStrToVal()

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

inlineprotectedvirtual

Reimplemented in ConfigBool, ConfigEnum, and ConfigInt.

Definition at line 83 of file configimpl.h.

83{}

Referenced by ConfigImpl::convertStrToVal().

◆ dependsOn()

QCString ConfigOption::dependsOn ( ) const

inline

Definition at line 73 of file configimpl.h.

73{ return m_dependency; }

References m_dependency.

Referenced by Config::checkAndCorrect(), and ConfigImpl::init().

◆ docs()

QCString ConfigOption::docs ( ) const

inline

Definition at line 71 of file configimpl.h.

71{ return m_doc; }

ConfigOption::m_doc

QCString m_doc

Definition configimpl.h:96

References m_doc.

◆ emptyValueToDefault()

virtual void ConfigOption::emptyValueToDefault ( )

inlineprotectedvirtual

Reimplemented in ConfigList, and ConfigString.

Definition at line 84 of file configimpl.h.

84{}

Referenced by ConfigImpl::emptyValueToDefault().

◆ init()

virtual void ConfigOption::init ( )

inlineprotectedvirtual

Reimplemented in ConfigBool, ConfigEnum, ConfigInt, ConfigList, and ConfigString.

Definition at line 86 of file configimpl.h.

86{}

Referenced by ConfigImpl::init().

◆ isDefault()

virtual bool ConfigOption::isDefault ( )

inlineprotectedvirtual

Reimplemented in ConfigBool, ConfigEnum, ConfigInt, ConfigList, and ConfigString.

Definition at line 87 of file configimpl.h.

87{ return true; }

◆ kind()

OptionType ConfigOption::kind ( ) const

inline

returns the kind of option this is.

Definition at line 69 of file configimpl.h.

69{ return m_kind; }

References m_kind.

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

◆ name()

QCString ConfigOption::name ( ) const

inline

Definition at line 70 of file configimpl.h.

70{ return m_name; }

ConfigOption::m_name

QCString m_name

Definition configimpl.h:95

References 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 75 of file configimpl.h.

75{ m_encoding = e; }

ConfigOption::m_encoding

QCString m_encoding

Definition configimpl.h:98

References m_encoding.

◆ setUserComment()

void ConfigOption::setUserComment ( const QCString & u )

inline

Definition at line 76 of file configimpl.h.

76{ m_userComment += u; }

ConfigOption::m_userComment

QCString m_userComment

Definition configimpl.h:99

References m_userComment.

◆ substEnvVars()

virtual void ConfigOption::substEnvVars ( )

protectedpure virtual

Implemented in ConfigBool, ConfigDisabled, ConfigEnum, ConfigInfo, ConfigInt, ConfigList, ConfigObsolete, and ConfigString.

Referenced by ConfigImpl::substituteEnvironmentVars().

◆ writeBoolValue()

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

protected

Definition at line 137 of file configimpl.l.

{
  if (initSpace) t << " ";
  if (v) t << "YES"; else t << "NO";
}

Referenced by ConfigBool::writeTemplate(), and ConfigBool::writeXMLDoxyfile().

◆ writeIntValue()

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

protected

Definition at line 143 of file configimpl.l.

{
  if (initSpace) t << " ";
  t << i;
}

Referenced by ConfigInt::writeTemplate(), and ConfigInt::writeXMLDoxyfile().

◆ writeStringList()

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

protected

Definition at line 181 of file configimpl.l.

{
  bool first=TRUE;
  for (const auto &p : l)
  {
    if (!first) t << " \\\n";
    QCString s=p.c_str();
    if (!first)
      t << "                        ";
    bool wasQuoted = ((s.at(0)=='"') && (s.at(s.length()-1)=='"'));
    if (wasQuoted)
    {
      s = s.mid(1,s.length()-2);
    }
    writeStringValue(t,s,true,wasQuoted);
    first=FALSE;
  }
}

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

Definition at line 149 of file configimpl.l.

{
  char c = 0;
  bool needsEscaping=wasQuoted;
  // convert the string back to it original g_encoding
  QCString se = configStringRecode(s,"UTF-8",m_encoding);
  if (se.isEmpty()) return;
  const char *p=se.data();
  if (p)
  {
    if (initSpace) t << " ";
    while ((c=*p++)!=0 && !needsEscaping)
      needsEscaping = (c==' ' || c== ',' || c=='\n' || c=='\t' || c=='"' || c=='#');
    if (needsEscaping)
    {
      t << "\"";
      p=se.data();
      while (*p)
      {
        if (*p==' ' && *(p+1)=='\0') break; // skip inserted space at the end
        if (*p=='"') t << "\\"; // escape quotes
        t << *p++;
      }
      t << "\"";
    }
    else
    {
      t << se;
    }
  }
}