Doxygen
Loading...
Searching...
No Matches
ConfigImpl Class Reference

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.
QCStringgetString (const char *fileName, int num, const char *name) const
 
StringVectorgetList (const char *fileName, int num, const char *name) const
 
QCStringgetEnum (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
 
ConfigOptionget (const QCString &name) const
 
Adding configuration options.
ConfigInfoaddInfo (const char *name, const char *doc)
 
ConfigStringaddString (const char *name, const char *doc)
 
ConfigEnumaddEnum (const char *name, const char *doc, const char *defVal)
 
ConfigListaddList (const char *name, const char *doc)
 
ConfigIntaddInt (const char *name, const char *doc, int minVal, int maxVal, int defVal)
 
ConfigBooladdBool (const char *name, const char *doc, bool defVal)
 
ConfigOptionaddObsolete (const char *name, ConfigOption::OptionType orgType)
 
ConfigOptionaddDisabled (const char *name)
 

Static Public Member Functions

static ConfigImplinstance ()
 
static void deleteInstance ()
 
static void config_err (const char *fmt,...)
 
static void config_term (const char *fmt,...)
 
static void config_warn (const char *fmt,...)
 

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< ConfigImplm_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 341 of file configimpl.h.

Constructor & Destructor Documentation

◆ ConfigImpl()

ConfigImpl::ConfigImpl ( )

Definition at line 1572 of file configimpl.l.

1573{
1574 addConfigOptions(this);
1575}
void addConfigOptions(ConfigImpl *cfg)

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

481 {
482 ConfigBool *result = new ConfigBool(name,doc,defVal);
483 m_options.push_back(std::unique_ptr<ConfigOption>(result));
484 m_dict.emplace(name,result);
485 return result;
486 }
ConfigOptionList m_options
Definition configimpl.h:614
ConfigOptionMap m_dict
Definition configimpl.h:617

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

499 {
500 ConfigDisabled *result = new ConfigDisabled(name);
501 m_disabled.push_back(std::unique_ptr<ConfigOption>(result));
502 m_dict.emplace(name,result);
503 return result;
504 }
ConfigOptionList m_disabled
Definition configimpl.h:616

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

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

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

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

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

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

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

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

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

490 {
491 ConfigObsolete *result = new ConfigObsolete(name,orgType);
492 m_obsolete.push_back(std::unique_ptr<ConfigOption>(result));
493 m_dict.emplace(name,result);
494 return result;
495 }
ConfigOptionList m_obsolete
Definition configimpl.h:615

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

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

References m_dict, and m_options.

◆ appendStartComment()

void ConfigImpl::appendStartComment ( const QCString & u)
inline

Append user start comment

Definition at line 565 of file configimpl.h.

566 {
567 m_startComment += u;
568 }
QCString m_startComment
Definition configimpl.h:619

References m_startComment.

◆ appendStoreRepl()

void ConfigImpl::appendStoreRepl ( const QCString & u)
inline

Append replacement string

Definition at line 577 of file configimpl.h.

578 {
579 m_storeRepl += u;
580 }
QCString m_storeRepl
Definition configimpl.h:621

References m_storeRepl.

◆ appendUserComment()

void ConfigImpl::appendUserComment ( const QCString & u)
inline

Append user comment

Definition at line 571 of file configimpl.h.

572 {
573 m_userComment += u;
574 }
QCString m_userComment
Definition configimpl.h:620

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 1343 of file configimpl.l.

1344{
1345 t << "# Difference with default Doxyfile " << getFullVersion();
1346 t << "\n";
1347 for (const auto &option : m_options)
1348 {
1349 option->m_userComment = "";
1350 option->compareDoxyfile(t,compareMode);
1351 }
1352 if (!m_storeRepl.isEmpty())
1353 {
1354 t << "\n";
1355 t << takeStoreRepl() << "\n";
1356 }
1357}
QCString takeStoreRepl()
Definition configimpl.h:602

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

Referenced by Config::compareDoxyfile().

◆ config_err()

void ConfigImpl::config_err ( const char * fmt,
... )
static

Definition at line 60 of file configimpl.l.

61{
62 va_list args;
63 va_start(args, fmt);
64 vfprintf(stderr, qPrint(QCString(error_str) + fmt), args);
65 va_end(args);
66}
static const char * error_str
Definition configimpl.l:58
const char * qPrint(const char *s)
Definition qcstring.h:672

References error_str, and qPrint().

Referenced by tryPath().

◆ config_term()

void ConfigImpl::config_term ( const char * fmt,
... )
static

Definition at line 68 of file configimpl.l.

69{
70 va_list args;
71 va_start(args, fmt);
72 vfprintf(stderr, qPrint(QCString(error_str) + fmt), args);
73 va_end(args);
74 fprintf(stderr, "%s\n", "Exiting...");
75 exit(1);
76}

References error_str, and qPrint().

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

◆ config_warn()

void ConfigImpl::config_warn ( const char * fmt,
... )
static

Definition at line 78 of file configimpl.l.

79{
80 va_list args;
81 va_start(args, fmt);
82 vfprintf(stderr, qPrint(QCString(warning_str) + fmt), args);
83 va_end(args);
84}
static const char * warning_str
Definition configimpl.l:57

References qPrint(), and warning_str.

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

◆ 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 1382 of file configimpl.l.

1383{
1384 for (const auto &option : m_options)
1385 {
1386 option->convertStrToVal(compareMode);
1387 }
1388}

References ConfigOption::convertStrToVal(), and m_options.

◆ deleteInstance()

static void ConfigImpl::deleteInstance ( )
inlinestatic

Delete the instance

Definition at line 356 of file configimpl.h.

357 {
358 m_instance.reset();
359 }
static std::unique_ptr< ConfigImpl > m_instance
Definition configimpl.h:618

References m_instance.

Referenced by Config::deinit().

◆ emptyValueToDefault()

void ConfigImpl::emptyValueToDefault ( )

Sets default value in case value is empty

Definition at line 1389 of file configimpl.l.

1390{
1391 for (const auto &option : m_options)
1392 {
1393 option->emptyValueToDefault();
1394 }
1395}

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

400 {
401 auto it = m_dict.find(name.str());
402 return it!=m_dict.end() ? it->second : nullptr;
403 }
const std::string & str() const
Definition qcstring.h:537

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 fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getBool() for this.

Definition at line 351 of file configimpl.l.

352{
353 auto it = m_dict.find(name);
354 if (it==m_dict.end())
355 {
356 config_term("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
357 }
358 else if (it->second->kind()!=ConfigOption::O_Bool)
359 {
360 config_term("%s<%d>: Internal error: Requested option %s not of boolean type!\n",fileName,num,name);
361 }
362 return *(dynamic_cast<ConfigBool *>(it->second))->valueRef();
363}
static void config_term(const char *fmt,...)
Definition configimpl.l:68
@ O_Bool
A boolean value.
Definition configimpl.h:52

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 fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getEnum() for this.

Definition at line 323 of file configimpl.l.

324{
325 auto it = m_dict.find(name);
326 if (it==m_dict.end())
327 {
328 config_term("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
329 }
330 else if (it->second->kind()!=ConfigOption::O_Enum)
331 {
332 config_term("%s<%d>: Internal error: Requested option %s not of enum type!\n",fileName,num,name);
333 }
334 return *(dynamic_cast<ConfigEnum *>(it->second))->valueRef();
335}
@ O_Enum
A fixed set of items.
Definition configimpl.h:49

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 fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getInt() for this.

Definition at line 337 of file configimpl.l.

338{
339 auto it = m_dict.find(name);
340 if (it==m_dict.end())
341 {
342 config_term("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
343 }
344 else if (it->second->kind()!=ConfigOption::O_Int)
345 {
346 config_term("%s<%d>: Internal error: Requested option %s not of integer type!\n",fileName,num,name);
347 }
348 return *(dynamic_cast<ConfigInt *>(it->second))->valueRef();
349}
@ O_Int
An integer value.
Definition configimpl.h:51

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 fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getList() for this.

Definition at line 309 of file configimpl.l.

310{
311 auto it = m_dict.find(name);
312 if (it==m_dict.end())
313 {
314 config_term("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
315 }
316 else if (it->second->kind()!=ConfigOption::O_List)
317 {
318 config_term("%s<%d>: Internal error: Requested option %s not of list type!\n",fileName,num,name);
319 }
320 return *(dynamic_cast<ConfigList *>(it->second))->valueRef();
321}
@ O_List
A list of items.
Definition configimpl.h:48

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 fileName. The arguments num and name are for debugging purposes only. There is a convenience function Config_getString() for this.

Definition at line 295 of file configimpl.l.

296{
297 auto it = m_dict.find(name);
298 if (it==m_dict.end())
299 {
300 config_term("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
301 }
302 else if (it->second->kind()!=ConfigOption::O_String)
303 {
304 config_term("%s<%d>: Internal error: Requested option %s not of string type!\n",fileName,num,name);
305 }
306 return *(dynamic_cast<ConfigString *>(it->second))->valueRef();
307}
@ O_String
A single item.
Definition configimpl.h:50

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

◆ init()

void ConfigImpl::init ( )

Initialize config variables to their default value

Definition at line 1549 of file configimpl.l.

1550{
1551 for (const auto &option : m_options)
1552 {
1553 option->init();
1554 }
1555
1556 // sanity check if all depends relations are valid
1557 for (const auto &option : m_options)
1558 {
1559 QCString depName = option->dependsOn();
1560 if (!depName.isEmpty())
1561 {
1562 ConfigOption * opt = ConfigImpl::instance()->get(depName);
1563 if (opt==0)
1564 {
1565 config_term("Config option '%s' has invalid depends relation on unknown option '%s'\n",
1566 qPrint(option->name()),qPrint(depName));
1567 }
1568 }
1569 }
1570}
static ConfigImpl * instance()
Definition configimpl.h:350
ConfigOption * get(const QCString &name) const
Definition configimpl.h:399
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:150

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

Referenced by Config::init().

◆ instance()

static ConfigImpl * ConfigImpl::instance ( )
inlinestatic

Returns the one and only instance of this class

Definition at line 350 of file configimpl.h.

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

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 1628 of file configimpl.l.

1629{
1630 g_encoding = "UTF-8";
1631 DebugLex debugLex(Debug::Lex_configimpl, __FILE__, qPrint(fn));
1632 bool retval = parseString(fn,configFileToString(fn), update);
1633 return retval;
1634}
bool parseString(const QCString &fn, const QCString &str, bool upd=FALSE)
@ Lex_configimpl
Definition debug.h:54
static QCString g_encoding
Definition configimpl.l:662
static QCString configFileToString(const QCString &name)

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 1608 of file configimpl.l.

1609{
1610#ifdef FLEX_DEBUG
1611 configimplYYset_debug(Debug::isFlagSet(Debug::Lex_configimpl)?1:0);
1612#endif
1614 g_inputString = str.data();
1615 g_inputPosition = 0;
1616 g_yyFileName = fn;
1617 g_yyLineNr = 1;
1619 configimplYYrestart( configimplYYin );
1620 BEGIN( Start );
1621 g_configUpdate = update;
1622 configimplYYlex();
1624 g_inputString = 0;
1625 return TRUE;
1626}
static bool isFlagSet(const DebugMask mask)
Definition debug.cpp:135
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition qcstring.h:159
void clear()
Definition qcstring.h:169
static const char * g_inputString
Definition configimpl.l:651
static std::vector< std::unique_ptr< ConfigFileState > > g_includeStack
Definition configimpl.l:660
static int g_inputPosition
Definition configimpl.l:652
static bool g_configUpdate
Definition configimpl.l:661
static ConfigImpl * g_config
Definition configimpl.l:663
static int g_yyLineNr
Definition configimpl.l:653
static QCString g_yyFileName
Definition configimpl.l:654
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34

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

528{ m_header = header; }
QCString m_header
Definition configimpl.h:622

References m_header.

◆ substituteEnvironmentVars()

void ConfigImpl::substituteEnvironmentVars ( )

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

Definition at line 1541 of file configimpl.l.

1542{
1543 for (const auto &option : m_options)
1544 {
1545 option->substEnvVars();
1546 }
1547}

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

585 {
586 QCString result=m_startComment;
587 m_startComment.clear();
588 return substitute(result,"\r","");
589 }
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition qcstring.cpp:477

References m_startComment, and substitute().

Referenced by writeTemplate().

◆ takeStoreRepl()

QCString ConfigImpl::takeStoreRepl ( )
inline

Take the replacement string

Returns
the replacement string

Definition at line 602 of file configimpl.h.

603 {
604 QCString result=m_storeRepl;
605 m_storeRepl.clear();
606 return substitute(result,"\r","");
607 }

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

594 {
595 QCString result=m_userComment;
596 m_userComment.clear();
597 return substitute(result,"\r","");
598 }

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 1319 of file configimpl.l.

1320{
1321 /* print first lines of user comment that were at the beginning of the file, might have special meaning for editors */
1322 if (!m_startComment.isEmpty())
1323 {
1324 t << takeStartComment() << "\n";
1325 }
1326 t << "# Doxyfile " << getDoxygenVersion() << "\n\n";
1327 if (!sl)
1328 {
1329 t << convertToComment(m_header,"");
1330 }
1331 for (const auto &option : m_options)
1332 {
1333 option->writeTemplate(t,sl,upd);
1334 }
1335 /* print last lines of user comment that were at the end of the file */
1336 if (!m_userComment.isEmpty())
1337 {
1338 t << "\n";
1339 t << takeUserComment();
1340 }
1341}
QCString takeStartComment()
Definition configimpl.h:584
QCString takeUserComment()
Definition configimpl.h:593
static QCString convertToComment(const QCString &s, const QCString &u)
Definition configimpl.l:98

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 1359 of file configimpl.l.

1360{
1361 t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
1362 t << "<doxyfile xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"doxyfile.xsd\" version=\"" << getDoxygenVersion() << "\" xml:lang=\"" << theTranslator->trISOLang() << "\">\n";
1363 for (const auto &option : m_options)
1364 {
1365 option->writeXMLDoxyfile(t);
1366 }
1367 t << "</doxyfile>\n";
1368}
virtual QCString trISOLang()=0
Translator * theTranslator
Definition language.cpp:71

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 1370 of file configimpl.l.

1371{
1372 for (const auto &option : m_options)
1373 {
1374 option->writeXSDDoxyfile(t);
1375 }
1376 for (const auto &option : m_disabled)
1377 {
1378 option->writeXSDDoxyfile(t);
1379 }
1380}

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

Referenced by Config::writeXSDDoxyfile().

Member Data Documentation

◆ m_dict

ConfigOptionMap ConfigImpl::m_dict
private

◆ m_disabled

ConfigOptionList ConfigImpl::m_disabled
private

Definition at line 616 of file configimpl.h.

Referenced by addDisabled(), and writeXSDDoxyfile().

◆ m_header

QCString ConfigImpl::m_header
private

Definition at line 622 of file configimpl.h.

Referenced by setHeader(), and writeTemplate().

◆ m_instance

std::unique_ptr< ConfigImpl > ConfigImpl::m_instance
staticprivate

Definition at line 618 of file configimpl.h.

Referenced by deleteInstance(), and instance().

◆ m_obsolete

ConfigOptionList ConfigImpl::m_obsolete
private

Definition at line 615 of file configimpl.h.

Referenced by addObsolete().

◆ m_options

◆ m_startComment

QCString ConfigImpl::m_startComment
private

Definition at line 619 of file configimpl.h.

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

◆ m_storeRepl

QCString ConfigImpl::m_storeRepl
private

Definition at line 621 of file configimpl.h.

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

◆ m_userComment

QCString ConfigImpl::m_userComment
private

Definition at line 620 of file configimpl.h.

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


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