#include <config.h>

Public Member Functions
QListIterator< ConfigOption >	iterator ()

void	writeTemplate (FTextStream &t, bool shortIndex, bool updateOnly)

void	setHeader (const char *header)

void	convertStrToVal ()

void	substituteEnvironmentVars ()

void	check ()

void	init ()

bool	parseString (const char fn, const char str, bool upd=FALSE)

bool	parse (const char *fn, bool upd=FALSE)

void	create ()

void	appendStartComment (const QCString &u)

void	appendUserComment (const QCString &u)

QCString	takeStartComment ()

QCString	takeUserComment ()

	Config (const fhicl::ParameterSet &pset)

	Config (const fhicl::ParameterSet &pset)

Getting configuration values.
QCString &	getString (const char fileName, int num, const char name) const

QStrList &	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 char *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 *	addDisabled (const char *name)

Static Public Member Functions
static Config *	instance ()

static void	deleteInstance ()

Public Attributes
std::string	fOutputFormat

std::string	fTreeName

std::string	fTrainingBranchObjectName

std::string	fTestOutputDir

std::string	fTrainOutputDir

unsigned int	fNTrainPerTest
	Number of training examples for each test sample, e.g. 4 for 80/20 split. More...

unsigned int	fProgressInterval
	Number of examples in between progress updates (% complete) More...

bool	fErrorIfExists

bool	fSetLog

bool	fCreateIfMissing

bool	fWriteSync

unsigned int	fMaxKeyLength

unsigned int	fWriteBufferSize

std::string	fLabeling

unsigned int	fLabelingMode

bool	fUseGeV

bool	fWriteRegressionHDF5
	Flag to control whether or not we write HDF5 regression features. More...

std::string	fRegressionHDF5NameTrain

std::string	fRegressionHDF5NameTest

float	fMaxEnergyForLabel

unsigned int	fNEvents
	Limit the number of entries in the tree to consider. More...

int	fPlaneLimit
	Limit the number of wires in the output image. More...

int	fTDCLimit
	Limit the number of TDCs in the output image. More...

std::vector< bool >	fReverseViews
	Views to reverse. More...

std::string	fOutputDir

Protected Member Functions
	Config ()

	~Config ()

Private Member Functions
void	checkFileName (const char *)

Private Attributes
QList< ConfigOption > *	m_options

QList< ConfigOption > *	m_obsolete

QList< ConfigOption > *	m_disabled

QDict< ConfigOption > *	m_dict

QCString	m_startComment

QCString	m_userComment

bool	m_initialized

QCString	m_header

Static Private Attributes
static Config *	m_instance = 0

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 291 of file config.h.

Constructor & Destructor Documentation

Config::Config ( )

inlineprotected

Definition at line 543 of file config.h.

     { 
       m_options  = new QList<ConfigOption>;
       m_obsolete = new QList<ConfigOption>;
       m_disabled = new QList<ConfigOption>;
       m_dict     = new QDict<ConfigOption>(257);
       m_options->setAutoDelete(TRUE);
       m_obsolete->setAutoDelete(TRUE);
       m_disabled->setAutoDelete(TRUE);
       m_initialized = FALSE;
       create();
     }

Config::~Config ( )

inlineprotected

Definition at line 555 of file config.h.

     {
       delete m_options;
       delete m_obsolete;
       delete m_disabled;
       delete m_dict;
     }

Config::Config ( const fhicl::ParameterSet & pset )

inline

Definition at line 63 of file cvnCreateDB.cc.

                                        :
     fOutputFormat (pset.get<std::string>("OutputFormat")),
     fTreeName (pset.get<std::string>("TreeName")),
     fTrainingBranchObjectName (pset.get<std::string>("TrainingDataBranchName")),
     fTestOutputDir (pset.get<std::string>("TestOutputDir")),
     fTrainOutputDir (pset.get<std::string>("TrainOutputDir")),
     fNTrainPerTest (pset.get<unsigned int>("NTrainPerTest")),
     fProgressInterval (pset.get<unsigned int>("ProgressInterval")),
     fErrorIfExists (pset.get<bool>("ErrorIfExists")),
     fSetLog (pset.get<bool>("SetLog")),
     fCreateIfMissing (pset.get<bool>("CreateIfMissing")),
     fWriteSync (pset.get<bool>("WriteSync")),
     fMaxKeyLength (pset.get<unsigned int>("MaxKeyLength")),
     fWriteBufferSize (pset.get<unsigned int>("WriteBufferSize")),
     fLabeling (pset.get<std::string>("Labeling")),
     fUseGeV (pset.get<bool>("UseGeV")),
     fWriteRegressionHDF5 (pset.get<bool>("WriteRegressionHDF5")),
     fRegressionHDF5NameTrain (pset.get<std::string>("RegressionHDF5NameTrain")),
     fRegressionHDF5NameTest (pset.get<std::string>("RegressionHDF5NameTest")),
     fMaxEnergyForLabel (pset.get<float>("MaxEnergyForLabel")),
     fNEvents (pset.get<unsigned int>("NEvents")),
     fPlaneLimit (pset.get<unsigned int>("PlaneLimit")),
     fTDCLimit (pset.get<unsigned int>("TDCLimit")),
     fReverseViews(pset.get<std::vector<bool> >("ReverseViews"))
   {
     if(!fLabeling.compare("all"))      fLabelingMode = kAll;
     if(!fLabeling.compare("numu"))     fLabelingMode = kNumu;
     if(!fLabeling.compare("nue"))      fLabelingMode = kNue;
     if(!fLabeling.compare("nc"))       fLabelingMode = kNC;
     if(!fLabeling.compare("energy"))   fLabelingMode = kEnergy;
   };

Config::Config ( const fhicl::ParameterSet & pset )

inline

Definition at line 41 of file cvnCreateZlibImages.cc.

                                        :
     fTreeName (pset.get<std::string>("TreeName")),
     fOutputDir (pset.get<std::string>("OutputDir")),
     fSetLog (pset.get<bool>("SetLog")),
     fNEvents (pset.get<unsigned int>("NEvents")),
     fPlaneLimit (pset.get<unsigned int>("PlaneLimit")),
     fTDCLimit (pset.get<unsigned int>("TDCLimit")),
     fReverseViews(pset.get<std::vector<bool> >("ReverseViews"))
   {
   };

Member Function Documentation

ConfigBool* Config::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 435 of file config.h.

     {
       ConfigBool *result = new ConfigBool(name,doc,defVal);
       m_options->append(result);
       m_dict->insert(name,result);
       return result;
     }

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

inline

Adds an option that has been disabled at compile time.

Definition at line 453 of file config.h.

     {
       ConfigDisabled *option = new ConfigDisabled(name);
       m_dict->insert(name,option);
       m_disabled->append(option);
       return option;
     }

ConfigEnum* Config::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 394 of file config.h.

     {
       ConfigEnum *result = new ConfigEnum(name,doc,defVal);
       m_options->append(result);
       m_dict->insert(name,result);
       return result;
     }

ConfigInfo* Config::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 371 of file config.h.

     {
       ConfigInfo *result = new ConfigInfo(name,doc);
       m_options->append(result);
       return result;
     }

ConfigInt* Config::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 421 of file config.h.

     {
       ConfigInt *result = new ConfigInt(name,doc,minVal,maxVal,defVal);
       m_options->append(result);
       m_dict->insert(name,result);
       return result;
     }

ConfigList* Config::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 407 of file config.h.

     {
       ConfigList *result = new ConfigList(name,doc);
       m_options->append(result);
       m_dict->insert(name,result);
       return result;
     }

ConfigOption* Config::addObsolete ( const char * name )

inline

Adds an option that has become obsolete.

Definition at line 445 of file config.h.

     {
       ConfigObsolete *option = new ConfigObsolete(name);
       m_dict->insert(name,option);
       m_obsolete->append(option);
       return option;
     }

ConfigString* Config::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 381 of file config.h.

     {
       ConfigString *result = new ConfigString(name,doc);
       m_options->append(result);
       m_dict->insert(name,result);
       return result;
     }

void Config::appendStartComment ( const QCString & u )

inline

Append user start comment

Definition at line 512 of file config.h.

     {
       m_startComment += u;
     }

void Config::appendUserComment ( const QCString & u )

inline

Append user comment

Definition at line 518 of file config.h.

     {
       m_userComment += u;
     }

void Config::check ( )

Checks if the values of the variable are correct, adjusts them if needed, and report any errors.

Definition at line 3084 of file config.cpp.

 {
   //if (!projectName.isEmpty())
   //{
   //  projectName[0]=toupper(projectName[0]);
   //}
 
   QCString &warnFormat = Config_getString("WARN_FORMAT");
   if (warnFormat.stripWhiteSpace().isEmpty())
   {
     warnFormat="$file:$line $text";
   }
   else
   {
     if (warnFormat.find("$file")==-1)
     {
       config_warn("warning format does not contain a $file tag!\n");
     }
     if (warnFormat.find("$line")==-1)
     {
       config_warn("warning format does not contain a $line tag!\n");
     }
     if (warnFormat.find("$text")==-1)
     {
       config_warn("warning format foes not contain a $text tag!\n");
     }
   }
 
   QCString &manExtension = Config_getString("MAN_EXTENSION");
   
   // set default man page extension if non is given by the user
   if (manExtension.isEmpty())
   {
     manExtension=".3";
   }
   
   QCString &paperType = Config_getEnum("PAPER_TYPE");
   paperType=paperType.lower().stripWhiteSpace(); 
   if (paperType.isEmpty() || paperType=="a4wide")
   {
     paperType = "a4";
   }
   if (paperType!="a4" && paperType!="letter" && 
       paperType!="legal" && paperType!="executive")
   {
     config_err("Unknown page type specified\n");
     paperType="a4";
   }
   
   QCString &outputLanguage=Config_getEnum("OUTPUT_LANGUAGE");
   outputLanguage=outputLanguage.stripWhiteSpace();
   if (outputLanguage.isEmpty())
   {
     outputLanguage = "English";
   }
 
   QCString &htmlFileExtension=Config_getString("HTML_FILE_EXTENSION");
   htmlFileExtension=htmlFileExtension.stripWhiteSpace();
   if (htmlFileExtension.isEmpty())
   {
     htmlFileExtension = ".html";
   }
   
   // expand the relative stripFromPath values
   QStrList &stripFromPath = Config_getList("STRIP_FROM_PATH");
   char *sfp = stripFromPath.first();
   if (sfp==0) // by default use the current path
   {
     stripFromPath.append(QDir::currentDirPath().utf8()+"/");
   }
   else
   {
     cleanUpPaths(stripFromPath);
   }
 
   // expand the relative stripFromPath values
   QStrList &stripFromIncPath = Config_getList("STRIP_FROM_INC_PATH");
   cleanUpPaths(stripFromIncPath);
   
   // Test to see if HTML header is valid
   QCString &headerFile = Config_getString("HTML_HEADER");
   if (!headerFile.isEmpty())
   {
     QFileInfo fi(headerFile);
     if (!fi.exists())
     {
       config_err("tag HTML_HEADER: header file `%s' "
           "does not exist\n",headerFile.data());
       exit(1);
     }
   }
   // Test to see if HTML footer is valid
   QCString &footerFile = Config_getString("HTML_FOOTER");
   if (!footerFile.isEmpty())
   {
     QFileInfo fi(footerFile);
     if (!fi.exists())
     {
       config_err("tag HTML_FOOTER: footer file `%s' "
           "does not exist\n",footerFile.data());
       exit(1);
     }
   }
 
   // Test to see if MathJax code file is valid
   if (Config_getBool("USE_MATHJAX"))
   {
     QCString &MathJaxCodefile = Config_getString("MATHJAX_CODEFILE");
     if (!MathJaxCodefile.isEmpty())
     {
       QFileInfo fi(MathJaxCodefile);
       if (!fi.exists())
       {
         config_err("tag MATHJAX_CODEFILE file `%s' "
             "does not exist\n",MathJaxCodefile.data());
         exit(1);
       }
     }
     QCString &path = Config_getString("MATHJAX_RELPATH");
     if (!path.isEmpty() && path.at(path.length()-1)!='/')
     {
       path+="/";
     }
 
   }
 
   // Test to see if LaTeX header is valid
   QCString &latexHeaderFile = Config_getString("LATEX_HEADER");
   if (!latexHeaderFile.isEmpty())
   {
     QFileInfo fi(latexHeaderFile);
     if (!fi.exists())
     {
       config_err("tag LATEX_HEADER: header file `%s' "
           "does not exist\n",latexHeaderFile.data());
       exit(1);
     }
   }
   // Test to see if LaTeX footer is valid
   QCString &latexFooterFile = Config_getString("LATEX_FOOTER");
   if (!latexFooterFile.isEmpty())
   {
     QFileInfo fi(latexFooterFile);
     if (!fi.exists())
     {
       config_err("tag LATEX_FOOTER: footer file `%s' "
           "does not exist\n",latexFooterFile.data());
       exit(1);
     }
   }
 
   // check include path
   QStrList &includePath = Config_getList("INCLUDE_PATH");
   char *s=includePath.first();
   while (s)
   {
     QFileInfo fi(s);
     if (!fi.exists()) config_warn("tag INCLUDE_PATH: include path `%s' "
                           "does not exist\n",s);
     s=includePath.next();
   }
 
   // check aliases
   QStrList &aliasList = Config_getList("ALIASES");
   s=aliasList.first();
   while (s)
   {
     QRegExp re1("[a-z_A-Z][a-z_A-Z0-9]*[ \t]*=");         // alias without argument
     QRegExp re2("[a-z_A-Z][a-z_A-Z0-9]*{[0-9]*}[ \t]*="); // alias with argument
     QCString alias=s;
     alias=alias.stripWhiteSpace();
     if (alias.find(re1)!=0 && alias.find(re2)!=0)
     {
       config_err("Illegal alias format `%s'. Use \"name=value\" or \"name(n)=value\", where n is the number of arguments\n",
           alias.data());
     }
     s=aliasList.next();
   }
 
   // check if GENERATE_TREEVIEW and GENERATE_HTMLHELP are both enabled
   if (Config_getBool("GENERATE_TREEVIEW") && Config_getBool("GENERATE_HTMLHELP"))
   {
     config_err("When enabling GENERATE_HTMLHELP the tree view (GENERATE_TREEVIEW) should be disabled. I'll do it for you.\n");
     Config_getBool("GENERATE_TREEVIEW")=FALSE;
   }
   if (Config_getBool("SEARCHENGINE") && Config_getBool("GENERATE_HTMLHELP"))
   {
     config_err("When enabling GENERATE_HTMLHELP the search engine (SEARCHENGINE) should be disabled. I'll do it for you.\n");
     Config_getBool("SEARCHENGINE")=FALSE;
   }
 
   // check if SEPARATE_MEMBER_PAGES and INLINE_GROUPED_CLASSES are both enabled
   if (Config_getBool("SEPARATE_MEMBER_PAGES") && Config_getBool("INLINE_GROUPED_CLASSES"))
   {
     config_err("When enabling INLINE_GROUPED_CLASSES the SEPARATE_MEMBER_PAGES option should be disabled. I'll do it for you.\n");
     Config_getBool("SEPARATE_MEMBER_PAGES")=FALSE;
   }
     
   // check dot image format
   QCString &dotImageFormat=Config_getEnum("DOT_IMAGE_FORMAT");
   dotImageFormat=dotImageFormat.stripWhiteSpace();
   if (dotImageFormat.isEmpty())
   {
     dotImageFormat = "png";
   }
   //else if (dotImageFormat!="gif" && dotImageFormat!="png" && dotImageFormat!="jpg")
   //{
   //  config_err("Invalid value for DOT_IMAGE_FORMAT: `%s'. Using the default.\n",dotImageFormat.data());
   //  dotImageFormat = "png";
   //}
 
   QCString &dotFontName=Config_getString("DOT_FONTNAME");
   if (dotFontName=="FreeSans" || dotFontName=="FreeSans.ttf")
   {
     config_warn("doxygen no longer ships with the FreeSans font.\n"
                "You may want to clear or change DOT_FONTNAME.\n"
                "Otherwise you run the risk that the wrong font is being used for dot generated graphs.\n");
   }
   
   
   // check dot path
   QCString &dotPath = Config_getString("DOT_PATH");
   if (!dotPath.isEmpty())
   {
     QFileInfo fi(dotPath);
     if (fi.exists() && fi.isFile()) // user specified path + exec
     {
       dotPath=fi.dirPath(TRUE).utf8()+"/";
     }
     else
     {
       QFileInfo dp(dotPath+"/dot"+portable_commandExtension());
       if (!dp.exists() || !dp.isFile())
       {
         config_warn("the dot tool could not be found at %s\n",dotPath.data());
         dotPath="";
       }
       else
       {
         dotPath=dp.dirPath(TRUE).utf8()+"/";
       }
     }
 #if defined(_WIN32) // convert slashes
     uint i=0,l=dotPath.length();
     for (i=0;i<l;i++) if (dotPath.at(i)=='/') dotPath.at(i)='\\';
 #endif
   }
   else // make sure the string is empty but not null!
   {
     dotPath="";
   }
 
   // check mscgen path
   QCString &mscgenPath = Config_getString("MSCGEN_PATH");
   if (!mscgenPath.isEmpty())
   {
     QFileInfo dp(mscgenPath+"/mscgen"+portable_commandExtension());
     if (!dp.exists() || !dp.isFile())
     {
       config_warn("the mscgen tool could not be found at %s\n",mscgenPath.data());
       mscgenPath="";
     }
     else
     {
       mscgenPath=dp.dirPath(TRUE).utf8()+"/";
 #if defined(_WIN32) // convert slashes
       uint i=0,l=mscgenPath.length();
       for (i=0;i<l;i++) if (mscgenPath.at(i)=='/') mscgenPath.at(i)='\\';
 #endif
     }
   }
   else // make sure the string is empty but not null!
   {
     mscgenPath="";
   }
 
   // check plantuml path
   QCString &plantumlJarPath = Config_getString("PLANTUML_JAR_PATH");
   if (!plantumlJarPath.isEmpty())
   {
     QFileInfo pu(plantumlJarPath);
     if (pu.exists() && pu.isDir()) // PLANTUML_JAR_PATH is directory
     {
       QFileInfo jar(plantumlJarPath+portable_pathSeparator()+"plantuml.jar");
       if (jar.exists() && jar.isFile())
       {
         plantumlJarPath = jar.dirPath(TRUE).utf8()+portable_pathSeparator();
       }
       else
       {
         config_err("Jar file plantuml.jar not found at location "
                    "specified via PLANTUML_JAR_PATH: '%s'\n",plantumlJarPath.data());
         plantumlJarPath="";
       }
     }
     else if (pu.exists() && pu.isFile() && plantumlJarPath.right(4)==".jar") // PLANTUML_JAR_PATH is file
     {
       plantumlJarPath = pu.dirPath(TRUE).utf8()+portable_pathSeparator();
     }
     else
     {
       config_err("path specified via PLANTUML_JAR_PATH does not exist or not a directory: %s\n",
                  plantumlJarPath.data());
       plantumlJarPath="";
     }
   }
 
   // check dia path
   QCString &diaPath = Config_getString("DIA_PATH");
   if (!diaPath.isEmpty())
   {
     QFileInfo dp(diaPath+"/dia"+portable_commandExtension());
     if (!dp.exists() || !dp.isFile())
     {
       config_warn("dia could not be found at %s\n",diaPath.data());
       diaPath="";
     }
     else
     {
       diaPath=dp.dirPath(TRUE).utf8()+"/";
 #if defined(_WIN32) // convert slashes
       uint i=0,l=diaPath.length();
       for (i=0;i<l;i++) if (diaPath.at(i)=='/') diaPath.at(i)='\\';
 #endif
     }
   }
   else // make sure the string is empty but not null!
   {
     diaPath="";
   }
 
   // check input
   QStrList &inputSources=Config_getList("INPUT");
   if (inputSources.count()==0)
   {
     // use current dir as the default
     inputSources.append(QDir::currentDirPath().utf8());
   }
   else
   {
     s=inputSources.first();
     while (s)
     {
       QFileInfo fi(s);
       if (!fi.exists())
       {
         config_warn("tag INPUT: input source `%s' does not exist\n",s);
       }
       s=inputSources.next();
     }
   }
 
   initFilePattern();
 
   // add default pattern if needed
   QStrList &examplePatternList = Config_getList("EXAMPLE_PATTERNS");
   if (examplePatternList.isEmpty())
   {
     examplePatternList.append("*");
   }
 
   // if no output format is enabled, warn the user
   if (!Config_getBool("GENERATE_HTML")    && 
       !Config_getBool("GENERATE_LATEX")   &&
       !Config_getBool("GENERATE_MAN")     && 
       !Config_getBool("GENERATE_RTF")     &&
       !Config_getBool("GENERATE_XML")     &&
       !Config_getBool("GENERATE_PERLMOD") &&
       !Config_getBool("GENERATE_RTF")     &&
       !Config_getBool("GENERATE_DOCBOOK") &&
       !Config_getBool("GENERATE_AUTOGEN_DEF") &&
       Config_getString("GENERATE_TAGFILE").isEmpty()
      )
   {
     config_warn("No output formats selected! Set at least one of the main GENERATE_* options to YES.\n");
   }
 
   // check HTMLHELP creation requirements
   if (!Config_getBool("GENERATE_HTML") && 
       Config_getBool("GENERATE_HTMLHELP"))
   {
     config_warn("GENERATE_HTMLHELP=YES requires GENERATE_HTML=YES.\n");
   }
 
   // check QHP creation requirements
   if (Config_getBool("GENERATE_QHP"))
   {
     if (Config_getString("QHP_NAMESPACE").isEmpty())
     {
       config_err("GENERATE_QHP=YES requires QHP_NAMESPACE to be set. Using 'org.doxygen.doc' as default!.\n");
       Config_getString("QHP_NAMESPACE")="org.doxygen.doc";
     }
 
     if (Config_getString("QHP_VIRTUAL_FOLDER").isEmpty())
     {
       config_err("GENERATE_QHP=YES requires QHP_VIRTUAL_FOLDER to be set. Using 'doc' as default!\n");
       Config_getString("QHP_VIRTUAL_FOLDER")="doc";
     }
   }
 
   if (Config_getBool("OPTIMIZE_OUTPUT_JAVA") && Config_getBool("INLINE_INFO"))
   {
     // don't show inline info for Java output, since Java has no inline 
     // concept.
     Config_getBool("INLINE_INFO")=FALSE;
   }
 
   int &depth = Config_getInt("MAX_DOT_GRAPH_DEPTH");
   if (depth==0)
   {
     depth=1000;
   }
 
   int &hue = Config_getInt("HTML_COLORSTYLE_HUE");
   if (hue<0)
   {
     hue=0;
   }
   else if (hue>=360)
   {
     hue=hue%360;
   }
 
   int &sat = Config_getInt("HTML_COLORSTYLE_SAT");
   if (sat<0)
   {
     sat=0;
   }
   else if (sat>255)
   {
     sat=255;
   }
   int &gamma = Config_getInt("HTML_COLORSTYLE_GAMMA");
   if (gamma<40)
   {
     gamma=40;
   }
   else if (gamma>240)
   {
     gamma=240;
   }
 
   QCString mathJaxFormat = Config_getEnum("MATHJAX_FORMAT");
   if (!mathJaxFormat.isEmpty() && mathJaxFormat!="HTML-CSS" &&
        mathJaxFormat!="NativeMML" && mathJaxFormat!="SVG")
   {
     config_err("Unsupported value for MATHJAX_FORMAT: Should be one of HTML-CSS, NativeMML, or SVG\n");
     Config_getEnum("MATHJAX_FORMAT")="HTML-CSS";
   }
 
   // add default words if needed
   QStrList &annotationFromBrief = Config_getList("ABBREVIATE_BRIEF");
   if (annotationFromBrief.isEmpty())
   {
     annotationFromBrief.append("The $name class");
     annotationFromBrief.append("The $name widget");
     annotationFromBrief.append("The $name file");
     annotationFromBrief.append("is");
     annotationFromBrief.append("provides");
     annotationFromBrief.append("specifies");
     annotationFromBrief.append("contains");
     annotationFromBrief.append("represents");
     annotationFromBrief.append("a");
     annotationFromBrief.append("an");
     annotationFromBrief.append("the");
   }
 
   // some default settings for vhdl
   if (Config_getBool("OPTIMIZE_OUTPUT_VHDL") && 
       (Config_getBool("INLINE_INHERITED_MEMB") || 
        Config_getBool("INHERIT_DOCS") || 
        !Config_getBool("HIDE_SCOPE_NAMES") ||
        !Config_getBool("EXTRACT_PRIVATE") ||
        !Config_getBool("EXTRACT_PACKAGE")
       )
      )
   {
     bool b1 = Config_getBool("INLINE_INHERITED_MEMB");
     bool b2 = Config_getBool("INHERIT_DOCS");
     bool b3 = Config_getBool("HIDE_SCOPE_NAMES");
     bool b4 = Config_getBool("EXTRACT_PRIVATE");
     bool b5 = Config_getBool("SKIP_FUNCTION_MACROS");
     bool b6 = Config_getBool("EXTRACT_PACKAGE");
     const char *s1,*s2,*s3,*s4,*s5,*s6;
     if (b1)  s1="  INLINE_INHERITED_MEMB  = NO (was YES)\n"; else s1="";
     if (b2)  s2="  INHERIT_DOCS           = NO (was YES)\n"; else s2="";
     if (!b3) s3="  HIDE_SCOPE_NAMES       = YES (was NO)\n"; else s3="";
     if (!b4) s4="  EXTRACT_PRIVATE        = YES (was NO)\n"; else s4="";
     if (b5)  s5="  ENABLE_PREPROCESSING   = NO (was YES)\n"; else s5="";
     if (!b6) s6="  EXTRACT_PACKAGE        = YES (was NO)\n"; else s6="";
 
 
     config_warn("enabling OPTIMIZE_OUTPUT_VHDL assumes the following settings:\n"
                "%s%s%s%s%s%s",s1,s2,s3,s4,s5,s6
               );
 
     Config_getBool("INLINE_INHERITED_MEMB") = FALSE;
     Config_getBool("INHERIT_DOCS")          = FALSE;
     Config_getBool("HIDE_SCOPE_NAMES")      = TRUE;
     Config_getBool("EXTRACT_PRIVATE")       = TRUE;
     Config_getBool("ENABLE_PREPROCESSING")  = FALSE;
     Config_getBool("EXTRACT_PACKAGE")       = TRUE;
   }                               
 
   checkFileName("GENERATE_TAGFILE");
 
 #if 0 // TODO: this breaks test 25; SOURCEBROWSER = NO and SOURCE_TOOLTIPS = YES.
       // So this and other regressions should be analysed and fixed before this can be enabled
   // disable any boolean options that depend on disabled options
   QListIterator<ConfigOption> it = iterator();
   ConfigOption *option;
   for (it.toFirst();(option=it.current());++it)
   {
     QCString depName = option->dependsOn(); // option has a dependency
     if (!depName.isEmpty())
     {
       ConfigOption * dep = Config::instance()->get(depName);
       if (dep->kind()==ConfigOption::O_Bool &&
           Config_getBool(depName)==FALSE) // dependent option is disabled
       {
         if (option->kind()==ConfigOption::O_Bool)
         {
           printf("disabling option %s\n",option->name().data());
           Config_getBool(option->name())=FALSE; // also disable this option
         }
       }
     }
   }
 #endif
 }

void Config::checkFileName ( const char * optionName )

private

Definition at line 3072 of file config.cpp.

 {
   QCString &s = Config_getString(optionName);
   QCString val = s.stripWhiteSpace().lower();
   if ((val=="yes" || val=="true"  || val=="1" || val=="all") ||
       (val=="no"  || val=="false" || val=="0" || val=="none")) 
   {
     config_err("file name expected for option %s, got %s instead. Ignoring...\n",optionName,s.data());
     s=""; // note the use of &s above: this will change the option value!
   }
 }

void Config::convertStrToVal ( )

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

Definition at line 2887 of file config.cpp.

 {
   QListIterator<ConfigOption> it = iterator();
   ConfigOption *option;
   for (;(option=it.current());++it)
   {
     option->convertStrToVal();
   }
 }

void Config::create ( )

Called from the constructor, will add doxygen's default options to the configuration object

Definition at line 3641 of file config.cpp.

 {
   if (m_initialized) return; 
   m_initialized = TRUE;
   addConfigOptions(this);
 }

static void Config::deleteInstance ( )

inlinestatic

Delete the instance

Definition at line 305 of file config.h.

     {
       delete m_instance;
       m_instance=0;
     }

ConfigOption* Config::get ( const char * name ) const

inline

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

Definition at line 357 of file config.h.

     {
       return m_dict->find(name); 
     }

bool & Config::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 892 of file config.cpp.

 {
   ConfigOption *opt = m_dict->find(name);
   if (opt==0) 
   {
     config_err("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
     exit(1);
   }
   else if (opt->kind()!=ConfigOption::O_Bool)
   {
     config_err("%s<%d>: Internal error: Requested option %s not of boolean type!\n",fileName,num,name);
     exit(1);
   }
   return *((ConfigBool *)opt)->valueRef();
 }

QCString & Config::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 860 of file config.cpp.

 {
   ConfigOption *opt = m_dict->find(name);
   if (opt==0) 
   {
     config_err("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
     exit(1);
   }
   else if (opt->kind()!=ConfigOption::O_Enum)
   {
     config_err("%s<%d>: Internal error: Requested option %s not of enum type!\n",fileName,num,name);
     exit(1);
   }
   return *((ConfigEnum *)opt)->valueRef();
 }

int & Config::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 876 of file config.cpp.

 {
   ConfigOption *opt = m_dict->find(name);
   if (opt==0) 
   {
     config_err("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
     exit(1);
   }
   else if (opt->kind()!=ConfigOption::O_Int)
   {
     config_err("%s<%d>: Internal error: Requested option %s not of integer type!\n",fileName,num,name);
     exit(1);
   }
   return *((ConfigInt *)opt)->valueRef();
 }

QStrList & Config::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 844 of file config.cpp.

 {
   ConfigOption *opt = m_dict->find(name);
   if (opt==0) 
   {
     config_err("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
     exit(1);
   }
   else if (opt->kind()!=ConfigOption::O_List)
   {
     config_err("%s<%d>: Internal error: Requested option %s not of list type!\n",fileName,num,name);
     exit(1);
   }
   return *((ConfigList *)opt)->valueRef();
 }

QCString & Config::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 828 of file config.cpp.

 {
   ConfigOption *opt = m_dict->find(name);
   if (opt==0) 
   {
     config_err("%s<%d>: Internal error: Requested unknown option %s!\n",fileName,num,name);
     exit(1);
   }
   else if (opt->kind()!=ConfigOption::O_String)
   {
     config_err("%s<%d>: Internal error: Requested option %s not of string type!\n",fileName,num,name);
     exit(1);
   }
   return *((ConfigString *)opt)->valueRef();
 }

void Config::init ( )

Initialize config variables to their default value

Definition at line 3615 of file config.cpp.

 {
   QListIterator<ConfigOption> it = iterator();
   ConfigOption *option;
   for (;(option=it.current());++it)
   {
     option->init();
   }
 
   // sanity check if all depends relations are valid
   for (it.toFirst();(option=it.current());++it)
   {
     QCString depName = option->dependsOn();
     if (!depName.isEmpty())
     {
       ConfigOption * opt = Config::instance()->get(depName);
       if (opt==0)
       {
         config_warn("Config option '%s' has invalid depends relation on unknown option '%s'\n",
             option->name().data(),depName.data());
         exit(1);
       }
     }
   }
 }

static Config* Config::instance ( )

inlinestatic

Returns the one and only instance of this class

Definition at line 299 of file config.h.

     {
       if (m_instance==0) m_instance = new Config;
       return m_instance;
     }

QListIterator<ConfigOption> Config::iterator ( )

inline

Returns an iterator that can by used to iterate over the configuration options.

Definition at line 314 of file config.h.

     {
       return QListIterator<ConfigOption>(*m_options);
     }

bool Config::parse	(	const char *	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 3726 of file config.cpp.

 {
   int retval;
   encoding = "UTF-8";
   printlex(configYY_flex_debug, TRUE, __FILE__, fn);
   retval =  parseString(fn,configFileToString(fn), update); 
   printlex(configYY_flex_debug, FALSE, __FILE__, fn);
   return retval;
 }

bool Config::parseString	(	const char *	fn,
		const char *	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 3707 of file config.cpp.

 {
   config = Config::instance();
   inputString   = str;
   inputPosition = 0;
   yyFileName    = fn;
   yyLineNr      = 1;
   includeStack.setAutoDelete(TRUE);
   includeStack.clear();
   includeDepth  = 0;
   configYYrestart( configYYin );
   BEGIN( PreStart );
   config_upd = update;
   configYYlex();
   config_upd = FALSE;
   inputString = 0;
   return TRUE;
 }

void Config::setHeader ( const char * header )

inline

Definition at line 468 of file config.h.

468 { m_header = header; }

Config::m_header

QCString m_header

Definition: config.h:573

void Config::substituteEnvironmentVars ( )

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

Definition at line 3027 of file config.cpp.

 {
   QListIterator<ConfigOption> it = iterator();
   ConfigOption *option;
   for (;(option=it.current());++it)
   {
     option->substEnvVars();
   }
 }

QCString Config::takeStartComment ( )

inline

Take the user start comment and reset it internally

Returns: user start comment

Definition at line 525 of file config.h.

     {
       QCString result=m_startComment;
       m_startComment.resize(0);
       return result.replace(QRegExp("\r"),"");
     }

QCString Config::takeUserComment ( )

inline

Take the user comment and reset it internally

Returns: user comment

Definition at line 534 of file config.h.

     {
       QCString result=m_userComment;
       m_userComment.resize(0);
       return result.replace(QRegExp("\r"),"");
     }

void Config::writeTemplate	(	FTextStream &	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 2861 of file config.cpp.

 {
   /* print first lines of user comment that were at the beginning of the file, might have special meaning for editors */
   if (m_startComment)
   {
     t << takeStartComment() << endl; 
   }
   t << "# Doxyfile " << versionString << endl << endl;
   if (!sl)
   {
     t << convertToComment(m_header,"");
   }
   QListIterator<ConfigOption> it = iterator();
   ConfigOption *option;
   for (;(option=it.current());++it)
   {
     option->writeTemplate(t,sl,upd);
   }
   /* print last lines of user comment that were at the end of the file */
   if (m_userComment)
   {
     t << "\n";
     t << takeUserComment();
   }
 }

Member Data Documentation

bool Config::fCreateIfMissing

Definition at line 109 of file cvnCreateDB.cc.

bool Config::fErrorIfExists

Definition at line 107 of file cvnCreateDB.cc.

std::string Config::fLabeling

Definition at line 114 of file cvnCreateDB.cc.

unsigned int Config::fLabelingMode

Definition at line 115 of file cvnCreateDB.cc.

float Config::fMaxEnergyForLabel

Definition at line 123 of file cvnCreateDB.cc.

unsigned int Config::fMaxKeyLength

Definition at line 111 of file cvnCreateDB.cc.

unsigned int Config::fNEvents

Limit the number of entries in the tree to consider.

Flag to control whether or not we write HDF5 regression features Limit the number of entries in the tree to consider

Definition at line 125 of file cvnCreateDB.cc.

unsigned int Config::fNTrainPerTest

Number of training examples for each test sample, e.g. 4 for 80/20 split.

Definition at line 103 of file cvnCreateDB.cc.

std::string Config::fOutputDir

Definition at line 54 of file cvnCreateZlibImages.cc.

std::string Config::fOutputFormat

Definition at line 93 of file cvnCreateDB.cc.

int Config::fPlaneLimit

Limit the number of wires in the output image.

Definition at line 127 of file cvnCreateDB.cc.

unsigned int Config::fProgressInterval

Number of examples in between progress updates (% complete)

Definition at line 105 of file cvnCreateDB.cc.

std::string Config::fRegressionHDF5NameTest

Definition at line 122 of file cvnCreateDB.cc.

std::string Config::fRegressionHDF5NameTrain

Definition at line 121 of file cvnCreateDB.cc.

std::vector< bool > Config::fReverseViews

Views to reverse.

Definition at line 131 of file cvnCreateDB.cc.

bool Config::fSetLog

Number of training examples for each test sample, e.g. 4 for 80/20 split Number of examples in between progress updates (% complete)

Definition at line 108 of file cvnCreateDB.cc.

int Config::fTDCLimit

Limit the number of TDCs in the output image.

Definition at line 129 of file cvnCreateDB.cc.

std::string Config::fTestOutputDir

Definition at line 99 of file cvnCreateDB.cc.

std::string Config::fTrainingBranchObjectName

Definition at line 98 of file cvnCreateDB.cc.

std::string Config::fTrainOutputDir

Definition at line 100 of file cvnCreateDB.cc.

std::string Config::fTreeName

Definition at line 97 of file cvnCreateDB.cc.

bool Config::fUseGeV

Definition at line 117 of file cvnCreateDB.cc.

unsigned int Config::fWriteBufferSize

Definition at line 112 of file cvnCreateDB.cc.

bool Config::fWriteRegressionHDF5

Flag to control whether or not we write HDF5 regression features.

Definition at line 120 of file cvnCreateDB.cc.

bool Config::fWriteSync

Definition at line 110 of file cvnCreateDB.cc.

QDict<ConfigOption>* Config::m_dict

private

Definition at line 568 of file config.h.

QList<ConfigOption>* Config::m_disabled

private

Definition at line 567 of file config.h.

QCString Config::m_header

private

Definition at line 573 of file config.h.

bool Config::m_initialized

private

Definition at line 572 of file config.h.

Config * Config::m_instance = 0

staticprivate

Definition at line 569 of file config.h.

QList<ConfigOption>* Config::m_obsolete

private

Definition at line 566 of file config.h.

QList<ConfigOption>* Config::m_options

private

Definition at line 565 of file config.h.

QCString Config::m_startComment

private

Definition at line 570 of file config.h.

QCString Config::m_userComment

private

Definition at line 571 of file config.h.

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

doxygen-1.8.11/src/config.h
dunereco/dunereco/CVN/levelDB/cvnCreateDB.cc
dunereco/dunereco/CVN/levelDB/cvnCreateZlibImages.cc
doxygen-1.8.11/build/generated_src/config.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation