From 956328e80741c88cdae6d98b07be4171c98f4e26 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 30 May 2005 05:23:22 +0000 Subject: Added docs for base: BoolSet git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1565 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 279 +++++++++++++++++---------------- 1 file changed, 140 insertions(+), 139 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index afb91f03a..8c0b0a5f1 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -103,17 +103,18 @@ Default constructor.
This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
-Definition at line 819 of file modules.cpp. -
-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. -
-
00820 {
-00821 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00822 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00823 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00824 if (!this->readerror)
-00825 this->error = CONF_FILE_NOT_FOUND;
-00826 }
+Definition at line 821 of file modules.cpp.
+
+References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
+
+
00822 {
+00823 include_stack.clear();
+00824 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00825 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00826 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00827 if (!this->readerror)
+00828 this->error = CONF_FILE_NOT_FOUND;
+00829 }
@@ -147,17 +148,17 @@ Overloaded constructor.
This constructor initialises the ConfigReader class to read a user-specified config file
-Definition at line 838 of file modules.cpp.
+Definition at line 841 of file modules.cpp.
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
-
00839 {
-00840 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00841 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00842 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00843 if (!this->readerror)
-00844 this->error = CONF_FILE_NOT_FOUND;
-00845 };
+00842 {
+00843 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00844 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00845 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00846 if (!this->readerror)
+00847 this->error = CONF_FILE_NOT_FOUND;
+00848 };
@@ -190,16 +191,16 @@ Default destructor.
This method destroys the ConfigReader class.
-Definition at line 829 of file modules.cpp.
+Definition at line 832 of file modules.cpp.
References cache, and errorlog.
-
00830 {
-00831 if (this->cache)
-00832 delete this->cache;
-00833 if (this->errorlog)
-00834 delete this->errorlog;
-00835 }
+00833 {
+00834 if (this->cache)
+00835 delete this->cache;
+00836 if (this->errorlog)
+00837 delete this->errorlog;
+00838 }
@@ -243,40 +244,40 @@ 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 916 of file modules.cpp.
+Definition at line 919 of file modules.cpp.
References errorlog, connection::fd, and userrec::nick.
-
00917 {
-00918 if (bail)
-00919 {
-00920 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00921 exit(0);
-00922 }
-00923 else
-00924 {
-00925 char dataline[1024];
-00926 if (user)
-00927 {
-00928 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00929 while (!errorlog->eof())
-00930 {
-00931 errorlog->getline(dataline,1024);
-00932 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00933 }
-00934 }
-00935 else
-00936 {
-00937 WriteOpers("There were errors in the configuration file:",user->nick);
-00938 while (!errorlog->eof())
-00939 {
-00940 errorlog->getline(dataline,1024);
-00941 WriteOpers(dataline);
-00942 }
-00943 }
-00944 return;
-00945 }
-00946 }
+00920 {
+00921 if (bail)
+00922 {
+00923 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00924 exit(0);
+00925 }
+00926 else
+00927 {
+00928 char dataline[1024];
+00929 if (user)
+00930 {
+00931 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00932 while (!errorlog->eof())
+00933 {
+00934 errorlog->getline(dataline,1024);
+00935 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00936 }
+00937 }
+00938 else
+00939 {
+00940 WriteOpers("There were errors in the configuration file:",user->nick);
+00941 while (!errorlog->eof())
+00942 {
+00943 errorlog->getline(dataline,1024);
+00944 WriteOpers(dataline);
+00945 }
+00946 }
+00947 return;
+00948 }
+00949 }
@@ -310,13 +311,13 @@ 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 949 of file modules.cpp.
+Definition at line 952 of file modules.cpp.
References cache.
-
00950 {
-00951 return EnumConf(cache,tag.c_str());
-00952 }
+00953 {
+00954 return EnumConf(cache,tag.c_str());
+00955 }
@@ -359,13 +360,13 @@ 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 954 of file modules.cpp.
+Definition at line 957 of file modules.cpp.
References cache.
-
00955 {
-00956 return EnumValues(cache, tag.c_str(), index);
-00957 }
+00958 {
+00959 return EnumValues(cache, tag.c_str(), index);
+00960 }
@@ -398,15 +399,15 @@ Returns the last error to occur.
Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0.
-Definition at line 909 of file modules.cpp.
+Definition at line 912 of file modules.cpp.
References error.
-
00910 {
-00911 long olderr = this->error;
-00912 this->error = 0;
-00913 return olderr;
-00914 }
+00913 {
+00914 long olderr = this->error;
+00915 this->error = 0;
+00916 return olderr;
+00917 }
@@ -455,25 +456,25 @@ 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 863 of file modules.cpp.
+Definition at line 866 of file modules.cpp.
References cache, CONF_VALUE_NOT_FOUND, and error.
-
00864 {
-00865 char val[MAXBUF];
-00866 char t[MAXBUF];
-00867 char n[MAXBUF];
-00868 strlcpy(t,tag.c_str(),MAXBUF);
-00869 strlcpy(n,name.c_str(),MAXBUF);
-00870 int res = ReadConf(cache,t,n,index,val);
-00871 if (!res)
-00872 {
-00873 this->error = CONF_VALUE_NOT_FOUND;
-00874 return false;
-00875 }
-00876 std::string s = val;
-00877 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00878 }
+00867 {
+00868 char val[MAXBUF];
+00869 char t[MAXBUF];
+00870 char n[MAXBUF];
+00871 strlcpy(t,tag.c_str(),MAXBUF);
+00872 strlcpy(n,name.c_str(),MAXBUF);
+00873 int res = ReadConf(cache,t,n,index,val);
+00874 if (!res)
+00875 {
+00876 this->error = CONF_VALUE_NOT_FOUND;
+00877 return false;
+00878 }
+00879 std::string s = val;
+00880 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00881 }
@@ -528,37 +529,37 @@ 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 GetError() 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 GetError() will return CONF_NOT_UNSIGNED
-Definition at line 880 of file modules.cpp.
+Definition at line 883 of file modules.cpp.
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
-
00881 {
-00882 char val[MAXBUF];
-00883 char t[MAXBUF];
-00884 char n[MAXBUF];
-00885 strlcpy(t,tag.c_str(),MAXBUF);
-00886 strlcpy(n,name.c_str(),MAXBUF);
-00887 int res = ReadConf(cache,t,n,index,val);
-00888 if (!res)
-00889 {
-00890 this->error = CONF_VALUE_NOT_FOUND;
-00891 return 0;
-00892 }
-00893 for (int i = 0; i < strlen(val); i++)
-00894 {
-00895 if (!isdigit(val[i]))
-00896 {
-00897 this->error = CONF_NOT_A_NUMBER;
-00898 return 0;
-00899 }
-00900 }
-00901 if ((needs_unsigned) && (atoi(val)<0))
-00902 {
-00903 this->error = CONF_NOT_UNSIGNED;
-00904 return 0;
-00905 }
-00906 return atoi(val);
-00907 }
+00884 {
+00885 char val[MAXBUF];
+00886 char t[MAXBUF];
+00887 char n[MAXBUF];
+00888 strlcpy(t,tag.c_str(),MAXBUF);
+00889 strlcpy(n,name.c_str(),MAXBUF);
+00890 int res = ReadConf(cache,t,n,index,val);
+00891 if (!res)
+00892 {
+00893 this->error = CONF_VALUE_NOT_FOUND;
+00894 return 0;
+00895 }
+00896 for (int i = 0; i < strlen(val); i++)
+00897 {
+00898 if (!isdigit(val[i]))
+00899 {
+00900 this->error = CONF_NOT_A_NUMBER;
+00901 return 0;
+00902 }
+00903 }
+00904 if ((needs_unsigned) && (atoi(val)<0))
+00905 {
+00906 this->error = CONF_NOT_UNSIGNED;
+00907 return 0;
+00908 }
+00909 return atoi(val);
+00910 }
@@ -607,24 +608,24 @@ 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 847 of file modules.cpp.
+Definition at line 850 of file modules.cpp.
References cache, CONF_VALUE_NOT_FOUND, and error.
-
00848 {
-00849 char val[MAXBUF];
-00850 char t[MAXBUF];
-00851 char n[MAXBUF];
-00852 strlcpy(t,tag.c_str(),MAXBUF);
-00853 strlcpy(n,name.c_str(),MAXBUF);
-00854 int res = ReadConf(cache,t,n,index,val);
-00855 if (!res)
-00856 {
-00857 this->error = CONF_VALUE_NOT_FOUND;
-00858 return "";
-00859 }
-00860 return val;
-00861 }
+00851 {
+00852 char val[MAXBUF];
+00853 char t[MAXBUF];
+00854 char n[MAXBUF];
+00855 strlcpy(t,tag.c_str(),MAXBUF);
+00856 strlcpy(n,name.c_str(),MAXBUF);
+00857 int res = ReadConf(cache,t,n,index,val);
+00858 if (!res)
+00859 {
+00860 this->error = CONF_VALUE_NOT_FOUND;
+00861 return "";
+00862 }
+00863 return val;
+00864 }
@@ -657,13 +658,13 @@ 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 959 of file modules.cpp.
+Definition at line 962 of file modules.cpp.
References readerror.
-
00960 {
-00961 return this->readerror;
-00962 }
+00963 {
+00964 return this->readerror;
+00965 }
@@ -693,7 +694,7 @@ It will contain a pointer to the configuration file data with unneeded data (suc
Definition at line 1158 of file modules.h.
-Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
+Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
@@ -719,7 +720,7 @@ Referenced by ConfigReader(
Definition at line 1163 of file modules.h.
-Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
+Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
@@ -745,7 +746,7 @@ Referenced by ConfigReader(
Definition at line 1159 of file modules.h.
-Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
+Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
@@ -773,12 +774,12 @@ Used to store errors.
Definition at line 1162 of file modules.h.
-Referenced by ConfigReader(), and Verify().
+Referenced by ConfigReader(), and Verify().
The documentation for this class was generated from the following files:
-
Generated on Wed May 25 22:02:53 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:42 2005 for InspIRCd by
1.3.3
--
cgit v1.3.1-10-gc9f91