From 5a2675d174e661c55843b3795afe2d688e7197f9 Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 26 Apr 2005 17:15:49 +0000 Subject: New documentation! git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1199 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 320 ++++++++++++++++----------------- 1 file changed, 160 insertions(+), 160 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 5a037b4de..7b302eed2 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -67,7 +67,7 @@ It may either be instantiated with one parameter or none. Constructing the class
-Definition at line 1072 of file modules.h.
This constructor initialises the ConfigReader class to read a user-specified config file
-Definition at line 852 of file modules.cpp. +Definition at line 854 of file modules.cpp.
-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
-
00853 {
-00854 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00855 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00856 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00857 if (!this->readerror)
-00858 this->error = CONF_FILE_NOT_FOUND;
-00859 };
+00855 {
+00856 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00857 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00858 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00859 if (!this->readerror)
+00860 this->error = CONF_FILE_NOT_FOUND;
+00861 };
@@ -184,16 +184,16 @@ Default destructor.
This method destroys the ConfigReader class.
-Definition at line 843 of file modules.cpp.
+Definition at line 845 of file modules.cpp.
-References cache, and errorlog.
+References cache, and errorlog.
-
00844 {
-00845 if (this->cache)
-00846 delete this->cache;
-00847 if (this->errorlog)
-00848 delete this->errorlog;
-00849 }
+00846 {
+00847 if (this->cache)
+00848 delete this->cache;
+00849 if (this->errorlog)
+00850 delete this->errorlog;
+00851 }
@@ -237,40 +237,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 930 of file modules.cpp.
-
-References errorlog, connection::fd, and userrec::nick.
-
-
00931 {
-00932 if (bail)
-00933 {
-00934 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00935 exit(0);
-00936 }
-00937 else
-00938 {
-00939 char dataline[1024];
-00940 if (user)
-00941 {
-00942 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00943 while (!errorlog->eof())
-00944 {
-00945 errorlog->getline(dataline,1024);
-00946 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00947 }
-00948 }
-00949 else
-00950 {
-00951 WriteOpers("There were errors in the configuration file:",user->nick);
-00952 while (!errorlog->eof())
-00953 {
-00954 errorlog->getline(dataline,1024);
-00955 WriteOpers(dataline);
-00956 }
-00957 }
-00958 return;
-00959 }
-00960 }
+Definition at line 932 of file modules.cpp.
+
+References errorlog, connection::fd, and userrec::nick.
+
+
00933 {
+00934 if (bail)
+00935 {
+00936 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00937 exit(0);
+00938 }
+00939 else
+00940 {
+00941 char dataline[1024];
+00942 if (user)
+00943 {
+00944 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00945 while (!errorlog->eof())
+00946 {
+00947 errorlog->getline(dataline,1024);
+00948 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00949 }
+00950 }
+00951 else
+00952 {
+00953 WriteOpers("There were errors in the configuration file:",user->nick);
+00954 while (!errorlog->eof())
+00955 {
+00956 errorlog->getline(dataline,1024);
+00957 WriteOpers(dataline);
+00958 }
+00959 }
+00960 return;
+00961 }
+00962 }
@@ -304,13 +304,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 963 of file modules.cpp.
+Definition at line 965 of file modules.cpp.
-References cache.
+References cache.
-
00964 {
-00965 return EnumConf(cache,tag.c_str());
-00966 }
+00966 {
+00967 return EnumConf(cache,tag.c_str());
+00968 }
@@ -353,13 +353,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 968 of file modules.cpp.
+Definition at line 970 of file modules.cpp.
-References cache.
+References cache.
-
00969 {
-00970 return EnumValues(cache, tag.c_str(), index);
-00971 }
+00971 {
+00972 return EnumValues(cache, tag.c_str(), index);
+00973 }
@@ -392,15 +392,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 923 of file modules.cpp.
+Definition at line 925 of file modules.cpp.
-References error.
+References error.
-
00924 {
-00925 long olderr = this->error;
-00926 this->error = 0;
-00927 return olderr;
-00928 }
+00926 {
+00927 long olderr = this->error;
+00928 this->error = 0;
+00929 return olderr;
+00930 }
@@ -449,25 +449,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 877 of file modules.cpp.
-
-References cache, CONF_VALUE_NOT_FOUND, and error.
-
-
00878 {
-00879 char val[MAXBUF];
-00880 char t[MAXBUF];
-00881 char n[MAXBUF];
-00882 strlcpy(t,tag.c_str(),MAXBUF);
-00883 strlcpy(n,name.c_str(),MAXBUF);
-00884 int res = ReadConf(cache,t,n,index,val);
-00885 if (!res)
-00886 {
-00887 this->error = CONF_VALUE_NOT_FOUND;
-00888 return false;
-00889 }
-00890 std::string s = val;
-00891 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00892 }
+Definition at line 879 of file modules.cpp.
+
+References cache, CONF_VALUE_NOT_FOUND, and error.
+
+
00880 {
+00881 char val[MAXBUF];
+00882 char t[MAXBUF];
+00883 char n[MAXBUF];
+00884 strlcpy(t,tag.c_str(),MAXBUF);
+00885 strlcpy(n,name.c_str(),MAXBUF);
+00886 int res = ReadConf(cache,t,n,index,val);
+00887 if (!res)
+00888 {
+00889 this->error = CONF_VALUE_NOT_FOUND;
+00890 return false;
+00891 }
+00892 std::string s = val;
+00893 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00894 }
@@ -522,37 +522,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 894 of file modules.cpp.
-
-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
-
-
00895 {
-00896 char val[MAXBUF];
-00897 char t[MAXBUF];
-00898 char n[MAXBUF];
-00899 strlcpy(t,tag.c_str(),MAXBUF);
-00900 strlcpy(n,name.c_str(),MAXBUF);
-00901 int res = ReadConf(cache,t,n,index,val);
-00902 if (!res)
-00903 {
-00904 this->error = CONF_VALUE_NOT_FOUND;
-00905 return 0;
-00906 }
-00907 for (int i = 0; i < strlen(val); i++)
-00908 {
-00909 if (!isdigit(val[i]))
-00910 {
-00911 this->error = CONF_NOT_A_NUMBER;
-00912 return 0;
-00913 }
-00914 }
-00915 if ((needs_unsigned) && (atoi(val)<0))
-00916 {
-00917 this->error = CONF_NOT_UNSIGNED;
-00918 return 0;
-00919 }
-00920 return atoi(val);
-00921 }
+Definition at line 896 of file modules.cpp.
+
+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
+
+
00897 {
+00898 char val[MAXBUF];
+00899 char t[MAXBUF];
+00900 char n[MAXBUF];
+00901 strlcpy(t,tag.c_str(),MAXBUF);
+00902 strlcpy(n,name.c_str(),MAXBUF);
+00903 int res = ReadConf(cache,t,n,index,val);
+00904 if (!res)
+00905 {
+00906 this->error = CONF_VALUE_NOT_FOUND;
+00907 return 0;
+00908 }
+00909 for (int i = 0; i < strlen(val); i++)
+00910 {
+00911 if (!isdigit(val[i]))
+00912 {
+00913 this->error = CONF_NOT_A_NUMBER;
+00914 return 0;
+00915 }
+00916 }
+00917 if ((needs_unsigned) && (atoi(val)<0))
+00918 {
+00919 this->error = CONF_NOT_UNSIGNED;
+00920 return 0;
+00921 }
+00922 return atoi(val);
+00923 }
@@ -601,24 +601,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 861 of file modules.cpp.
-
-References cache, CONF_VALUE_NOT_FOUND, and error.
-
-
00862 {
-00863 char val[MAXBUF];
-00864 char t[MAXBUF];
-00865 char n[MAXBUF];
-00866 strlcpy(t,tag.c_str(),MAXBUF);
-00867 strlcpy(n,name.c_str(),MAXBUF);
-00868 int res = ReadConf(cache,t,n,index,val);
-00869 if (!res)
-00870 {
-00871 this->error = CONF_VALUE_NOT_FOUND;
-00872 return "";
-00873 }
-00874 return std::string(val);
-00875 }
+Definition at line 863 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 "";
+00875 }
+00876 return std::string(val);
+00877 }
@@ -651,13 +651,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 973 of file modules.cpp.
+Definition at line 975 of file modules.cpp.
-References readerror.
+References readerror.
-
00974 {
-00975 return this->readerror;
-00976 }
+00976 {
+00977 return this->readerror;
+00978 }
@@ -685,9 +685,9 @@ The contents of the configuration file This protected member should never be acc
It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
-Definition at line 1080 of file modules.h.
+Definition at line 1105 of file modules.h.
-Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
+Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
@@ -711,9 +711,9 @@ Referenced by ConfigReader(
-Definition at line 1085 of file modules.h.
+Definition at line 1110 of file modules.h.
-Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
+Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
@@ -737,9 +737,9 @@ Referenced by ConfigReader(
-Definition at line 1081 of file modules.h.
+Definition at line 1106 of file modules.h.
-Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
+Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
@@ -765,14 +765,14 @@ Used to store errors.
-Definition at line 1084 of file modules.h.
+Definition at line 1109 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 Apr 20 15:47:01 2005 for InspIRCd by
+
Generated on Tue Apr 26 17:11:47 2005 for InspIRCd by
1.3.3
--
cgit v1.3.1-10-gc9f91