Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ConfigReader Class Reference

Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. More...

#include <modules.h>

Inheritance diagram for ConfigReader:

Inheritance graph
[legend]
Collaboration diagram for ConfigReader:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ConfigReader ()
 Default constructor.

 ConfigReader (std::string filename)
 Overloaded constructor.

 ~ConfigReader ()
 Default destructor.

std::string ReadValue (std::string tag, std::string name, int index)
 Retrieves a value from the config file.

int Enumerate (std::string tag)
 Counts the number of times a given tag appears in the config file.

bool Verify ()
 Returns true if a config file is valid.


Protected Attributes

std::string fname
 The filename of the configuration file, as set by the constructor.

Detailed Description

Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.

It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read.

Definition at line 358 of file modules.h.

Constructor & Destructor Documentation

ConfigReader::ConfigReader (    ) 
 

Default constructor.

This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.

Definition at line 265 of file modules.cpp.

References fname. 

00266 {
00267         fname = CONFIG_FILE;
00268 }

ConfigReader::ConfigReader (  std::string    filename ) 
 

Overloaded constructor.

This constructor initialises the ConfigReader class to read a user-specified config file

Definition at line 276 of file modules.cpp. 

00276 : fname(filename) { };

ConfigReader::~ConfigReader (    ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 271 of file modules.cpp. 

00272 {
00273 }

Member Function Documentation

int ConfigReader::Enumerate (  std::string    tag ) 
 

Counts the number of times a given tag appears in the config file.

This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of ConfigReader::ReadValue to loop through all copies of a multiple instance tag.

Definition at line 286 of file modules.cpp.

References fname. 

00287 {
00288         return EnumConf(fname.c_str(),tag.c_str());
00289 }

std::string ConfigReader::ReadValue (  std::string    tag,
std::string    name,
int    index
) 
 

Retrieves a value from the config file.

This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.

Definition at line 278 of file modules.cpp.

References fname. 

00279 {
00280         char val[MAXBUF];
00281         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
00282         return val;
00283 }

bool ConfigReader::Verify (    ) 
 

Returns true if a config file is valid.

This method is unimplemented and will always return true.

Definition at line 292 of file modules.cpp. 

00293 {
00294         return true;
00295 }

Member Data Documentation

std::string ConfigReader::fname [protected]
 

The filename of the configuration file, as set by the constructor.

Definition at line 363 of file modules.h.

Referenced by ConfigReader(), Enumerate(), and ReadValue().

The documentation for this class was generated from the following files:
Generated on Sun Apr 4 23:02:24 2004 for InspIRCd by doxygen1.3-rc3