Singleton for configuration variables. More...

#include <src/configimpl.h>

Collaboration diagram for ConfigImpl:

Public Member Functions
	ConfigImpl ()
void	writeTemplate (TextStream &t, bool shortIndex, bool updateOnly)
void	compareDoxyfile (TextStream &t, Config::CompareMode compareMode)
void	writeXMLDoxyfile (TextStream &t)
void	writeXSDDoxyfile (TextStream &t)
void	setHeader (const char *header)
void	convertStrToVal (Config::CompareMode compareMode)
void	emptyValueToDefault ()
void	substituteEnvironmentVars ()
void	init ()
bool	parseString (const QCString &fn, const QCString &str, bool upd=FALSE)
bool	parse (const QCString &fn, bool upd=FALSE)
void	appendStartComment (const QCString &u)
void	appendUserComment (const QCString &u)
void	appendStoreRepl (const QCString &u)
QCString	takeStartComment ()
QCString	takeUserComment ()
QCString	takeStoreRepl ()
Getting configuration values.
QCString &	getString (const char fileName, int num, const char name) const
StringVector &	getList (const char fileName, int num, const char name) const
QCString &	getEnum (const char fileName, int num, const char name) const
int &	getInt (const char fileName, int num, const char name) const
bool &	getBool (const char fileName, int num, const char name) const
ConfigOption *	get (const QCString &name) const
Adding configuration options.
ConfigInfo *	addInfo (const char name, const char doc)
ConfigString *	addString (const char name, const char doc)
ConfigEnum *	addEnum (const char name, const char doc, const char *defVal)
ConfigList *	addList (const char name, const char doc)
ConfigInt *	addInt (const char name, const char doc, int minVal, int maxVal, int defVal)
ConfigBool *	addBool (const char name, const char doc, bool defVal)
ConfigOption *	addObsolete (const char *name, ConfigOption::OptionType orgType)
ConfigOption *	addDisabled (const char *name)

Static Public Member Functions
static ConfigImpl *	instance ()
static void	deleteInstance ()
static void	config_err_ (fmt::string_view fmt, fmt::format_args args)
static void	config_term_ (fmt::string_view fmt, fmt::format_args args)
static void	config_warn_ (fmt::string_view fmt, fmt::format_args args)
template<typename ... Args>
static void	config_err (fmt::format_string< Args... > fmt, Args &&... args)
template<typename ... Args>
static void	config_term (fmt::format_string< Args... > fmt, Args &&... args)
template<typename ... Args>
static void	config_warn (fmt::format_string< Args... > fmt, Args &&... args)

Private Attributes
ConfigOptionList	m_options
ConfigOptionList	m_obsolete
ConfigOptionList	m_disabled
ConfigOptionMap	m_dict
QCString	m_startComment
QCString	m_userComment
QCString	m_storeRepl
QCString	m_header

Static Private Attributes
static std::unique_ptr< ConfigImpl >	m_instance

Detailed Description

Singleton for configuration variables.

This object holds the global static variables read from a user-supplied configuration file. The static member instance() can be used to get a pointer to the one and only instance.

Set all variables to their default values by calling Config::instance()->init()

Definition at line 342 of file configimpl.h.

Constructor & Destructor Documentation

◆ ConfigImpl()

ConfigImpl::ConfigImpl ( )

Definition at line 1568 of file configimpl.l.

{
  addConfigOptions(this);
}

References addConfigOptions().

Referenced by instance().

Member Function Documentation

◆ addBool()

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

inline

Adds a new boolean option with name and documentation doc. The boolean has a default value of defVal.

Returns: An object representing the option.

Definition at line 479 of file configimpl.h.

    {
      ConfigBool *result = new ConfigBool(name,doc,defVal);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.emplace(name,result);
      return result;
    }

References m_dict, and m_options.

◆ addDisabled()

ConfigOption * ConfigImpl::addDisabled ( const char * name )

inline

Adds an option that has been disabled at compile time.

Definition at line 499 of file configimpl.h.

    {
      ConfigDisabled *result = new ConfigDisabled(name);
      m_disabled.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.emplace(name,result);
      return result;
    }

References m_dict, and m_disabled.

◆ addEnum()

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

inline

Adds a new enumeration option with name and documentation doc and initial value defVal.

Returns: An object representing the option.

Definition at line 438 of file configimpl.h.

    {
      ConfigEnum *result = new ConfigEnum(name,doc,defVal);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.emplace(name,result);
      return result;
    }

References m_dict, and m_options.

◆ addInfo()

ConfigInfo * ConfigImpl::addInfo	(	const char *	name,
		const char *	doc )

inline

Starts a new configuration section with name and description doc.

Returns: An object representing the option.

Definition at line 415 of file configimpl.h.

    {
      ConfigInfo *result = new ConfigInfo(name,doc);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      return result;
    }

References m_options.

◆ addInt()

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

inline

Adds a new integer option with name and documentation doc. The integer has a range between minVal and maxVal and a default value of defVal.

Returns: An object representing the option.

Definition at line 465 of file configimpl.h.

    {
      ConfigInt *result = new ConfigInt(name,doc,minVal,maxVal,defVal);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.emplace(name,result);
      return result;
    }

References m_dict, and m_options.

◆ addList()

ConfigList * ConfigImpl::addList	(	const char *	name,
		const char *	doc )

inline

Adds a new string option with name and documentation doc.

Returns: An object representing the option.

Definition at line 451 of file configimpl.h.

    {
      ConfigList *result = new ConfigList(name,doc);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.emplace(name,result);
      return result;
    }

References m_dict, and m_options.

◆ addObsolete()

ConfigOption * ConfigImpl::addObsolete	(	const char *	name,
		ConfigOption::OptionType	orgType )

inline

Adds an option that has become obsolete.

Definition at line 490 of file configimpl.h.

    {
      ConfigObsolete *result = new ConfigObsolete(name,orgType);
      m_obsolete.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.emplace(name,result);
      return result;
    }

References m_dict, and m_obsolete.

◆ addString()

ConfigString * ConfigImpl::addString	(	const char *	name,
		const char *	doc )

inline

Adds a new string option with name and documentation doc.

Returns: An object representing the option.

Definition at line 425 of file configimpl.h.

    {
      ConfigString *result = new ConfigString(name,doc);
      m_options.push_back(std::unique_ptr<ConfigOption>(result));
      m_dict.emplace(name,result);
      return result;
    }

References m_dict, and m_options.

◆ appendStartComment()

void ConfigImpl::appendStartComment ( const QCString & u )

inline

Append user start comment

Definition at line 566 of file configimpl.h.

    {
      m_startComment += u;
    }

References m_startComment.

◆ appendStoreRepl()

void ConfigImpl::appendStoreRepl ( const QCString & u )

inline

Append replacement string

Definition at line 578 of file configimpl.h.

    {
      m_storeRepl += u;
    }

References m_storeRepl.

◆ appendUserComment()

void ConfigImpl::appendUserComment ( const QCString & u )

inline

Append user comment

Definition at line 572 of file configimpl.h.

    {
      m_userComment += u;
    }

References m_userComment.

◆ compareDoxyfile()

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

Writes a the differences between the current configuration and the template configuration to stream t.

Definition at line 1338 of file configimpl.l.

{
  t << "# Difference with default Doxyfile " << getFullVersion();
  t << "\n";
  for (const auto &option : m_options)
  {
    option->m_userComment = "";
    option->compareDoxyfile(t,compareMode);
  }
  if (!m_storeRepl.isEmpty())
  {
    t << "\n";
    t << takeStoreRepl() << "\n";
  }
}

References ConfigOption::compareDoxyfile(), m_options, m_storeRepl, ConfigOption::m_userComment, and takeStoreRepl().

Referenced by Config::compareDoxyfile().

◆ config_err()

template<typename ... Args>

void ConfigImpl::config_err	(	fmt::format_string< Args... >	fmt,
		Args &&...	args )

inlinestatic

Definition at line 615 of file configimpl.h.

    {
      config_err_(fmt,fmt::make_format_args(args...));
    }

References config_err_().

Referenced by tryPath().

◆ config_err_()

void ConfigImpl::config_err_	(	fmt::string_view	fmt,
		fmt::format_args	args )

static

Definition at line 59 of file configimpl.l.

{
  fmt::print(stderr,"{}{}",error_str,fmt::vformat(fmt,args));
}

References error_str.

Referenced by config_err().

◆ config_term()

template<typename ... Args>

void ConfigImpl::config_term	(	fmt::format_string< Args... >	fmt,
		Args &&...	args )

inlinestatic

Definition at line 621 of file configimpl.h.

    {
      config_term_(fmt,fmt::make_format_args(args...));
    }

References config_term_().

Referenced by Config::checkAndCorrect(), configFileToString(), configStringRecode(), getBool(), getEnum(), getInt(), getList(), getString(), init(), and readIncludeFile().

◆ config_term_()

void ConfigImpl::config_term_	(	fmt::string_view	fmt,
		fmt::format_args	args )

static

Definition at line 64 of file configimpl.l.

{
  fmt::print(stderr,"{}{}",error_str,fmt::vformat(fmt,args));
  fmt::print(stderr,"{}\n", "Exiting...");
  exit(1);
}

References error_str.

Referenced by config_term().

◆ config_warn()

template<typename ... Args>

void ConfigImpl::config_warn	(	fmt::format_string< Args... >	fmt,
		Args &&...	args )

inlinestatic

Definition at line 627 of file configimpl.h.

    {
      config_warn_(fmt,fmt::make_format_args(args...));
    }

References config_warn_().

Referenced by ConfigBool::convertStrToVal(), ConfigEnum::convertStrToVal(), ConfigInt::convertStrToVal(), processList(), processString(), and setTranslator().

◆ config_warn_()

void ConfigImpl::config_warn_	(	fmt::string_view	fmt,
		fmt::format_args	args )

static

Definition at line 71 of file configimpl.l.

{
  fmt::print(stderr,"{}{}",warning_str,fmt::vformat(fmt,args));
}

References warning_str.

Referenced by config_warn().

◆ convertStrToVal()

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

Converts the string values read from the configuration file to real values for non-string type options (like int, and bools)

Definition at line 1377 of file configimpl.l.

{
  for (const auto &option : m_options)
  {
    option->convertStrToVal(compareMode);
  }
}

References ConfigOption::convertStrToVal(), and m_options.

◆ deleteInstance()

void ConfigImpl::deleteInstance ( )

inlinestatic

Delete the instance

Definition at line 357 of file configimpl.h.

    {
      m_instance.reset();
    }

References m_instance.

Referenced by Config::deinit().

◆ emptyValueToDefault()

void ConfigImpl::emptyValueToDefault ( )

Sets default value in case value is empty

Definition at line 1384 of file configimpl.l.

{
  for (const auto &option : m_options)
  {
    option->emptyValueToDefault();
  }
}

References ConfigOption::emptyValueToDefault(), and m_options.

◆ get()

ConfigOption * ConfigImpl::get ( const QCString & name ) const

inline

Returns the ConfigOption corresponding with name or 0 if the option is not supported.

Definition at line 400 of file configimpl.h.

    {
      auto it = m_dict.find(name.str());
      return it!=m_dict.end() ? it->second : nullptr;
    }

References m_dict, and QCString::str().

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

◆ getBool()

bool & ConfigImpl::getBool	(	const char *	fileName,
		int	num,
		const char *	name ) const

Returns the value of the boolean option with name name. The arguments num and fileName are for debugging purposes only. There is a convenience function Config_getBool() for this.

Definition at line 341 of file configimpl.l.

{
  auto it = m_dict.find(name);
  if (it==m_dict.end())
  {
    config_term("{}<{}>: Internal error: Requested unknown option {}!\n",fileName,num,name);
  }
  else if (it->second->kind()!=ConfigOption::O_Bool)
  {
    config_term("{}<{}>: Internal error: Requested option {} not of boolean type!\n",fileName,num,name);
  }
  return *(dynamic_cast<ConfigBool *>(it->second))->valueRef();
}

References config_term(), m_dict, and ConfigOption::O_Bool.

◆ getEnum()

QCString & ConfigImpl::getEnum	(	const char *	fileName,
		int	num,
		const char *	name ) const

Returns the value of the enum option with name name. The arguments num and fileName are for debugging purposes only. There is a convenience function Config_getEnum() for this.

Definition at line 313 of file configimpl.l.

{
  auto it = m_dict.find(name);
  if (it==m_dict.end())
  {
    config_term("{}<{}>: Internal error: Requested unknown option {}!\n",fileName,num,name);
  }
  else if (it->second->kind()!=ConfigOption::O_Enum)
  {
    config_term("{}<{}>: Internal error: Requested option {} not of enum type!\n",fileName,num,name);
  }
  return *(dynamic_cast<ConfigEnum *>(it->second))->valueRef();
}

References config_term(), m_dict, and ConfigOption::O_Enum.

◆ getInt()

int & ConfigImpl::getInt	(	const char *	fileName,
		int	num,
		const char *	name ) const

Returns the value of the integer option with name name. The arguments num and fileName are for debugging purposes only. There is a convenience function Config_getInt() for this.

Definition at line 327 of file configimpl.l.

{
  auto it = m_dict.find(name);
  if (it==m_dict.end())
  {
    config_term("{}<{}>: Internal error: Requested unknown option {}!\n",fileName,num,name);
  }
  else if (it->second->kind()!=ConfigOption::O_Int)
  {
    config_term("{}<{}>: Internal error: Requested option {} not of integer type!\n",fileName,num,name);
  }
  return *(dynamic_cast<ConfigInt *>(it->second))->valueRef();
}

References config_term(), m_dict, and ConfigOption::O_Int.

◆ getList()

StringVector & ConfigImpl::getList	(	const char *	fileName,
		int	num,
		const char *	name ) const

Returns the value of the list option with name name. The arguments num and fileName are for debugging purposes only. There is a convenience function Config_getList() for this.

Definition at line 299 of file configimpl.l.

{
  auto it = m_dict.find(name);
  if (it==m_dict.end())
  {
    config_term("{}<{}>: Internal error: Requested unknown option {}!\n",fileName,num,name);
  }
  else if (it->second->kind()!=ConfigOption::O_List)
  {
    config_term("{}<{}>: Internal error: Requested option {} not of list type!\n",fileName,num,name);
  }
  return *(dynamic_cast<ConfigList *>(it->second))->valueRef();
}

References config_term(), m_dict, and ConfigOption::O_List.

◆ getString()

QCString & ConfigImpl::getString	(	const char *	fileName,
		int	num,
		const char *	name ) const

Returns the value of the string option with name name. The arguments num and fileName are for debugging purposes only. There is a convenience function Config_getString() for this.

Definition at line 285 of file configimpl.l.

{
  auto it = m_dict.find(name);
  if (it==m_dict.end())
  {
    config_term("{}<{}>: Internal error: Requested unknown option {}!\n",fileName,num,name);
  }
  else if (it->second->kind()!=ConfigOption::O_String)
  {
    config_term("{}<{}>: Internal error: Requested option {} not of string type!\n",fileName,num,name);
  }
  return *(dynamic_cast<ConfigString *>(it->second))->valueRef();
}

References config_term(), m_dict, and ConfigOption::O_String.

◆ init()

void ConfigImpl::init ( )

Initialize config variables to their default value

Definition at line 1545 of file configimpl.l.

{
  for (const auto &option : m_options)
  {
    option->init();
  }
 
  // sanity check if all depends relations are valid
  for (const auto &option : m_options)
  {
    QCString depName = option->dependsOn();
    if (!depName.isEmpty())
    {
      ConfigOption * opt = ConfigImpl::instance()->get(depName);
      if (opt==0)
      {
        config_term("Config option '{}' has invalid depends relation on unknown option '{}'\n",
            option->name(),depName);
      }
    }
  }
}

References config_term(), ConfigOption::dependsOn(), get(), ConfigOption::init(), instance(), QCString::isEmpty(), m_options, and ConfigOption::name().

Referenced by Config::init().

◆ instance()

ConfigImpl * ConfigImpl::instance ( )

inlinestatic

Returns the one and only instance of this class

Definition at line 351 of file configimpl.h.

    {
      if (!m_instance) m_instance = std::make_unique<ConfigImpl>();
      return m_instance.get();
    }

References ConfigImpl(), and m_instance.

Referenced by Config::compareDoxyfile(), Config::deinit(), DocPara::handleDoxyConfig(), Config::init(), init(), Config::parse(), parseString(), Config::postProcess(), Config::updateObsolete(), Config::writeTemplate(), Config::writeXMLDoxyfile(), and Config::writeXSDDoxyfile().

◆ parse()

bool ConfigImpl::parse	(	const QCString &	fn,
		bool	upd = FALSE )

Parse a configuration file with name fn.

Returns: TRUE if successful, FALSE if the file could not be opened or read.

Definition at line 1624 of file configimpl.l.

{
  g_encoding = "UTF-8";
  DebugLex debugLex(Debug::Lex_configimpl, __FILE__, qPrint(fn));
  bool retval =  parseString(fn,configFileToString(fn), update);
  return retval;
}

References configFileToString(), g_encoding, Debug::Lex_configimpl, parseString(), and qPrint().

Referenced by Config::parse().

◆ parseString()

bool ConfigImpl::parseString	(	const QCString &	fn,
		const QCString &	str,
		bool	upd = FALSE )

Parse a configuration data in string str.

Returns: TRUE if successful, or FALSE if the string could not be parsed.

Definition at line 1604 of file configimpl.l.

{
#ifdef FLEX_DEBUG
  configimplYYset_debug(Debug::isFlagSet(Debug::Lex_configimpl)?1:0);
#endif
  g_config = ConfigImpl::instance();
  g_inputString   = str.data();
  g_inputPosition = 0;
  g_yyFileName    = fn;
  g_yyLineNr      = 1;
  g_includeStack.clear();
  configimplYYrestart( configimplYYin );
  BEGIN( Start );
  g_configUpdate = update;
  configimplYYlex();
  g_configUpdate = FALSE;
  g_inputString = 0;
  return TRUE;
}

References QCString::data(), FALSE, g_config, g_configUpdate, g_includeStack, g_inputPosition, g_inputString, g_yyFileName, g_yyLineNr, instance(), Debug::isFlagSet(), Debug::Lex_configimpl, and TRUE.

Referenced by parse().

◆ setHeader()

void ConfigImpl::setHeader ( const char * header )

inline

Definition at line 529 of file configimpl.h.

529{ m_header = header; }

ConfigImpl::m_header

QCString m_header

Definition configimpl.h:641

References m_header.

◆ substituteEnvironmentVars()

void ConfigImpl::substituteEnvironmentVars ( )

Replaces references to environment variable by the actual value of the environment variable.

Definition at line 1537 of file configimpl.l.

{
  for (const auto &option : m_options)
  {
    option->substEnvVars();
  }
}

References m_options, and ConfigOption::substEnvVars().

◆ takeStartComment()

QCString ConfigImpl::takeStartComment ( )

inline

Take the user start comment and reset it internally

Returns: user start comment

Definition at line 585 of file configimpl.h.

    {
      QCString result=m_startComment;
      m_startComment.clear();
      return substitute(result,"\r","");
    }

References m_startComment, and substitute().

Referenced by writeTemplate().

◆ takeStoreRepl()

QCString ConfigImpl::takeStoreRepl ( )

inline

Take the replacement string

Returns: the replacement string

Definition at line 603 of file configimpl.h.

    {
      QCString result=m_storeRepl;
      m_storeRepl.clear();
      return substitute(result,"\r","");
    }

References m_storeRepl, and substitute().

Referenced by compareDoxyfile().

◆ takeUserComment()

QCString ConfigImpl::takeUserComment ( )

inline

Take the user comment and reset it internally

Returns: user comment

Definition at line 594 of file configimpl.h.

    {
      QCString result=m_userComment;
      m_userComment.clear();
      return substitute(result,"\r","");
    }

References m_userComment, and substitute().

Referenced by writeTemplate().

◆ writeTemplate()

void ConfigImpl::writeTemplate	(	TextStream &	t,
		bool	shortIndex,
		bool	updateOnly )

Writes a template configuration to stream t. If shortIndex is TRUE the description of each configuration option will be omitted.

Definition at line 1314 of file configimpl.l.

{
  /* print first lines of user comment that were at the beginning of the file, might have special meaning for editors */
  if (!m_startComment.isEmpty())
  {
    t << takeStartComment() << "\n";
  }
  t << "# Doxyfile " << getDoxygenVersion() << "\n\n";
  if (!sl)
  {
    t << convertToComment(m_header,"");
  }
  for (const auto &option : m_options)
  {
    option->writeTemplate(t,sl,upd);
  }
  /* print last lines of user comment that were at the end of the file */
  if (!m_userComment.isEmpty())
  {
    t << "\n";
    t << takeUserComment();
  }
}

References convertToComment(), m_header, m_options, m_startComment, m_userComment, takeStartComment(), takeUserComment(), and ConfigOption::writeTemplate().

Referenced by Config::writeTemplate().

◆ writeXMLDoxyfile()

void ConfigImpl::writeXMLDoxyfile ( TextStream & t )

Writes a the used settings of the current configuration as XML format to stream t.

Definition at line 1354 of file configimpl.l.

{
  t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
  t << "<doxyfile xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"doxyfile.xsd\" version=\"" << getDoxygenVersion() << "\" xml:lang=\"" <<  theTranslator->trISOLang() << "\">\n";
  for (const auto &option : m_options)
  {
    option->writeXMLDoxyfile(t);
  }
  t << "</doxyfile>\n";
}

References m_options, theTranslator, and ConfigOption::writeXMLDoxyfile().

Referenced by Config::writeXMLDoxyfile().

◆ writeXSDDoxyfile()

void ConfigImpl::writeXSDDoxyfile ( TextStream & t )

Writes all possible setting ids to an XSD file for validation through the stream t.

Definition at line 1365 of file configimpl.l.

{
  for (const auto &option : m_options)
  {
    option->writeXSDDoxyfile(t);
  }
  for (const auto &option : m_disabled)
  {
    option->writeXSDDoxyfile(t);
  }
}

References m_disabled, m_options, and ConfigOption::writeXSDDoxyfile().

Referenced by Config::writeXSDDoxyfile().

Member Data Documentation

◆ m_dict

ConfigOptionMap ConfigImpl::m_dict

private

Definition at line 636 of file configimpl.h.

Referenced by addBool(), addDisabled(), addEnum(), addInt(), addList(), addObsolete(), addString(), get(), getBool(), getEnum(), getInt(), getList(), and getString().

◆ m_disabled

ConfigOptionList ConfigImpl::m_disabled

private

Definition at line 635 of file configimpl.h.

Referenced by addDisabled(), and writeXSDDoxyfile().

◆ m_header

QCString ConfigImpl::m_header

private

Definition at line 641 of file configimpl.h.

Referenced by setHeader(), and writeTemplate().

◆ m_instance

std::unique_ptr< ConfigImpl > ConfigImpl::m_instance

staticprivate

Definition at line 637 of file configimpl.h.

Referenced by deleteInstance(), and instance().

◆ m_obsolete

ConfigOptionList ConfigImpl::m_obsolete

private

Definition at line 634 of file configimpl.h.

Referenced by addObsolete().

◆ m_options

ConfigOptionList ConfigImpl::m_options

private

Definition at line 633 of file configimpl.h.

Referenced by addBool(), addEnum(), addInfo(), addInt(), addList(), addString(), compareDoxyfile(), convertStrToVal(), emptyValueToDefault(), init(), substituteEnvironmentVars(), writeTemplate(), writeXMLDoxyfile(), and writeXSDDoxyfile().

◆ m_startComment

QCString ConfigImpl::m_startComment

private

Definition at line 638 of file configimpl.h.

Referenced by appendStartComment(), takeStartComment(), and writeTemplate().

◆ m_storeRepl

QCString ConfigImpl::m_storeRepl

private

Definition at line 640 of file configimpl.h.

Referenced by appendStoreRepl(), compareDoxyfile(), and takeStoreRepl().

◆ m_userComment

QCString ConfigImpl::m_userComment

private

Definition at line 639 of file configimpl.h.

Referenced by appendUserComment(), takeUserComment(), and writeTemplate().

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

src/configimpl.h
src/configimpl.l

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConfigImpl()

Member Function Documentation

◆ addBool()

◆ addDisabled()

◆ addEnum()

◆ addInfo()

◆ addInt()

◆ addList()

◆ addObsolete()

◆ addString()

◆ appendStartComment()

◆ appendStoreRepl()

◆ appendUserComment()

◆ compareDoxyfile()

◆ config_err()

◆ config_err_()

◆ config_term()

◆ config_term_()

◆ config_warn()

◆ config_warn_()

◆ convertStrToVal()

◆ deleteInstance()

◆ emptyValueToDefault()

◆ get()

◆ getBool()

◆ getEnum()

◆ getInt()

◆ getList()

◆ getString()

◆ init()

◆ instance()

◆ parse()

◆ parseString()

◆ setHeader()

◆ substituteEnvironmentVars()

◆ takeStartComment()

◆ takeStoreRepl()

◆ takeUserComment()

◆ writeTemplate()

◆ writeXMLDoxyfile()

◆ writeXSDDoxyfile()

Member Data Documentation

◆ m_dict

◆ m_disabled

◆ m_header

◆ m_instance

◆ m_obsolete

◆ m_options

◆ m_startComment

◆ m_storeRepl

◆ m_userComment