diff options
Diffstat (limited to 'docs/man/man3/ConfigReader.3')
| -rw-r--r-- | docs/man/man3/ConfigReader.3 | 274 |
1 files changed, 137 insertions, 137 deletions
diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index fe2042e0c..23b16d688 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -84,239 +84,239 @@ Allows reading of values from configuration files This class allows a module to 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. .PP -Definition at line 1147 of file modules.h. +Definition at line 1150 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ConfigReader::ConfigReader ()" .PP -Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 870 of file modules.cpp. +Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 799 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -871 { -872 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -873 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -874 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -875 if (!this->readerror) -876 this->error = CONF_FILE_NOT_FOUND; -877 } +800 { +801 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +802 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +803 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +804 if (!this->readerror) +805 this->error = CONF_FILE_NOT_FOUND; +806 } .fi .SS "ConfigReader::ConfigReader (std::string filename)" .PP -Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 889 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 818 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -890 { -891 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -892 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -893 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -894 if (!this->readerror) -895 this->error = CONF_FILE_NOT_FOUND; -896 }; +819 { +820 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +821 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +822 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +823 if (!this->readerror) +824 this->error = CONF_FILE_NOT_FOUND; +825 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 880 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 809 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -881 { -882 if (this->cache) -883 delete this->cache; -884 if (this->errorlog) -885 delete this->errorlog; -886 } +810 { +811 if (this->cache) +812 delete this->cache; +813 if (this->errorlog) +814 delete this->errorlog; +815 } .fi .SH "Member Function Documentation" .PP .SS "void ConfigReader::DumpErrors (bool bail, \fBuserrec\fP * user)" .PP -Dumps the list of errors in a config file to an output location. If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.Definition at line 967 of file modules.cpp. +Dumps the list of errors in a config file to an output location. If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.Definition at line 896 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -968 { -969 if (bail) -970 { -971 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); -972 exit(0); -973 } -974 else -975 { -976 char dataline[1024]; -977 if (user) -978 { -979 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); -980 while (!errorlog->eof()) -981 { -982 errorlog->getline(dataline,1024); -983 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); -984 } -985 } -986 else -987 { -988 WriteOpers('There were errors in the configuration file:',user->nick); -989 while (!errorlog->eof()) -990 { -991 errorlog->getline(dataline,1024); -992 WriteOpers(dataline); -993 } -994 } -995 return; -996 } -997 } +897 { +898 if (bail) +899 { +900 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +901 exit(0); +902 } +903 else +904 { +905 char dataline[1024]; +906 if (user) +907 { +908 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +909 while (!errorlog->eof()) +910 { +911 errorlog->getline(dataline,1024); +912 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +913 } +914 } +915 else +916 { +917 WriteOpers('There were errors in the configuration file:',user->nick); +918 while (!errorlog->eof()) +919 { +920 errorlog->getline(dataline,1024); +921 WriteOpers(dataline); +922 } +923 } +924 return; +925 } +926 } .fi .SS "int ConfigReader::Enumerate (std::string tag)" .PP -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 \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.Definition at line 1000 of file modules.cpp. +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 \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.Definition at line 929 of file modules.cpp. .PP References cache. .PP .nf -1001 { -1002 return EnumConf(cache,tag.c_str()); -1003 } +930 { +931 return EnumConf(cache,tag.c_str()); +932 } .fi .SS "int ConfigReader::EnumerateValues (std::string tag, int index)" .PP -Returns the number of items within a tag. For example if the tag was <test tag='blah' data='foo'> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 1005 of file modules.cpp. +Returns the number of items within a tag. For example if the tag was <test tag='blah' data='foo'> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 934 of file modules.cpp. .PP References cache. .PP .nf -1006 { -1007 return EnumValues(cache, tag.c_str(), index); -1008 } +935 { +936 return EnumValues(cache, tag.c_str(), index); +937 } .fi .SS "long ConfigReader::GetError ()" .PP -Returns the last error to occur. Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.Definition at line 960 of file modules.cpp. +Returns the last error to occur. Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.Definition at line 889 of file modules.cpp. .PP References error. .PP .nf -961 { -962 long olderr = this->error; -963 this->error = 0; -964 return olderr; -965 } +890 { +891 long olderr = this->error; +892 this->error = 0; +893 return olderr; +894 } .fi .SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)" .PP -Retrieves a boolean value from the config file. This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.Definition at line 914 of file modules.cpp. +Retrieves a boolean value from the config file. This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.Definition at line 843 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -915 { -916 char val[MAXBUF]; -917 char t[MAXBUF]; -918 char n[MAXBUF]; -919 strlcpy(t,tag.c_str(),MAXBUF); -920 strlcpy(n,name.c_str(),MAXBUF); -921 int res = ReadConf(cache,t,n,index,val); -922 if (!res) -923 { -924 this->error = CONF_VALUE_NOT_FOUND; -925 return false; -926 } -927 std::string s = val; -928 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -929 } +844 { +845 char val[MAXBUF]; +846 char t[MAXBUF]; +847 char n[MAXBUF]; +848 strlcpy(t,tag.c_str(),MAXBUF); +849 strlcpy(n,name.c_str(),MAXBUF); +850 int res = ReadConf(cache,t,n,index,val); +851 if (!res) +852 { +853 this->error = CONF_VALUE_NOT_FOUND; +854 return false; +855 } +856 std::string s = val; +857 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +858 } .fi .SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)" .PP -Retrieves an integer value from the config file. This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNEDDefinition at line 931 of file modules.cpp. +Retrieves an integer value from the config file. This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNEDDefinition at line 860 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -932 { -933 char val[MAXBUF]; -934 char t[MAXBUF]; -935 char n[MAXBUF]; -936 strlcpy(t,tag.c_str(),MAXBUF); -937 strlcpy(n,name.c_str(),MAXBUF); -938 int res = ReadConf(cache,t,n,index,val); -939 if (!res) -940 { -941 this->error = CONF_VALUE_NOT_FOUND; -942 return 0; -943 } -944 for (int i = 0; i < strlen(val); i++) -945 { -946 if (!isdigit(val[i])) -947 { -948 this->error = CONF_NOT_A_NUMBER; -949 return 0; -950 } -951 } -952 if ((needs_unsigned) && (atoi(val)<0)) -953 { -954 this->error = CONF_NOT_UNSIGNED; -955 return 0; -956 } -957 return atoi(val); -958 } +861 { +862 char val[MAXBUF]; +863 char t[MAXBUF]; +864 char n[MAXBUF]; +865 strlcpy(t,tag.c_str(),MAXBUF); +866 strlcpy(n,name.c_str(),MAXBUF); +867 int res = ReadConf(cache,t,n,index,val); +868 if (!res) +869 { +870 this->error = CONF_VALUE_NOT_FOUND; +871 return 0; +872 } +873 for (int i = 0; i < strlen(val); i++) +874 { +875 if (!isdigit(val[i])) +876 { +877 this->error = CONF_NOT_A_NUMBER; +878 return 0; +879 } +880 } +881 if ((needs_unsigned) && (atoi(val)<0)) +882 { +883 this->error = CONF_NOT_UNSIGNED; +884 return 0; +885 } +886 return atoi(val); +887 } .fi .SS "std::string ConfigReader::ReadValue (std::string tag, std::string name, int index)" .PP -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 898 of file modules.cpp. +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 827 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -899 { -900 char val[MAXBUF]; -901 char t[MAXBUF]; -902 char n[MAXBUF]; -903 strlcpy(t,tag.c_str(),MAXBUF); -904 strlcpy(n,name.c_str(),MAXBUF); -905 int res = ReadConf(cache,t,n,index,val); -906 if (!res) -907 { -908 this->error = CONF_VALUE_NOT_FOUND; -909 return ''; -910 } -911 return val; -912 } +828 { +829 char val[MAXBUF]; +830 char t[MAXBUF]; +831 char n[MAXBUF]; +832 strlcpy(t,tag.c_str(),MAXBUF); +833 strlcpy(n,name.c_str(),MAXBUF); +834 int res = ReadConf(cache,t,n,index,val); +835 if (!res) +836 { +837 this->error = CONF_VALUE_NOT_FOUND; +838 return ''; +839 } +840 return val; +841 } .fi .SS "bool ConfigReader::Verify ()" .PP -Returns true if a config file is valid. This method is partially implemented and will only return false if the config file does not exist or could not be opened.Definition at line 1010 of file modules.cpp. +Returns true if a config file is valid. This method is partially implemented and will only return false if the config file does not exist or could not be opened.Definition at line 939 of file modules.cpp. .PP References readerror. .PP .nf -1011 { -1012 return this->readerror; -1013 } +940 { +941 return this->readerror; +942 } .fi .SH "Member Data Documentation" .PP .SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP" .PP -The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 1155 of file modules.h. +The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 1158 of file modules.h. .PP Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader(). .SS "long \fBConfigReader::error\fP\fC [protected]\fP" .PP -Definition at line 1160 of file modules.h. +Definition at line 1163 of file modules.h. .PP Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue(). .SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP" .PP -Definition at line 1156 of file modules.h. +Definition at line 1159 of file modules.h. .PP Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader(). .SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP" .PP -Used to store errors. Definition at line 1159 of file modules.h. +Used to store errors. Definition at line 1162 of file modules.h. .PP Referenced by ConfigReader(), and Verify(). |