From 3f4b15c2cfe51a654b5167273f5a95b29e757cf1 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 14 Apr 2005 21:13:24 +0000 Subject: New documentation on today's new methods etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1096 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 1e81811f5..0b29b92b3 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 790 of file modules.h.
This constructor initialises the ConfigReader class to read a user-specified config file
-Definition at line 694 of file modules.cpp. +Definition at line 727 of file modules.cpp.
-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
-
00695 {
-00696 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00697 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00698 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00699 if (!this->readerror)
-00700 this->error = CONF_FILE_NOT_FOUND;
-00701 };
+00728 {
+00729 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00730 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00731 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00732 if (!this->readerror)
+00733 this->error = CONF_FILE_NOT_FOUND;
+00734 };
@@ -184,16 +184,16 @@ Default destructor.
This method destroys the ConfigReader class.
-Definition at line 685 of file modules.cpp.
+Definition at line 718 of file modules.cpp.
-References cache, and errorlog.
+References cache, and errorlog.
-
00686 {
-00687 if (this->cache)
-00688 delete this->cache;
-00689 if (this->errorlog)
-00690 delete this->errorlog;
-00691 }
+00719 {
+00720 if (this->cache)
+00721 delete this->cache;
+00722 if (this->errorlog)
+00723 delete this->errorlog;
+00724 }
@@ -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 772 of file modules.cpp.
-
-References errorlog, connection::fd, and userrec::nick.
-
-
00773 {
-00774 if (bail)
-00775 {
-00776 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00777 exit(0);
-00778 }
-00779 else
-00780 {
-00781 char dataline[1024];
-00782 if (user)
-00783 {
-00784 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00785 while (!errorlog->eof())
-00786 {
-00787 errorlog->getline(dataline,1024);
-00788 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00789 }
-00790 }
-00791 else
-00792 {
-00793 WriteOpers("There were errors in the configuration file:",user->nick);
-00794 while (!errorlog->eof())
-00795 {
-00796 errorlog->getline(dataline,1024);
-00797 WriteOpers(dataline);
-00798 }
-00799 }
-00800 return;
-00801 }
-00802 }
+Definition at line 805 of file modules.cpp.
+
+References errorlog, connection::fd, and userrec::nick.
+
+
00806 {
+00807 if (bail)
+00808 {
+00809 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00810 exit(0);
+00811 }
+00812 else
+00813 {
+00814 char dataline[1024];
+00815 if (user)
+00816 {
+00817 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00818 while (!errorlog->eof())
+00819 {
+00820 errorlog->getline(dataline,1024);
+00821 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00822 }
+00823 }
+00824 else
+00825 {
+00826 WriteOpers("There were errors in the configuration file:",user->nick);
+00827 while (!errorlog->eof())
+00828 {
+00829 errorlog->getline(dataline,1024);
+00830 WriteOpers(dataline);
+00831 }
+00832 }
+00833 return;
+00834 }
+00835 }
@@ -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 805 of file modules.cpp.
+Definition at line 838 of file modules.cpp.
-References cache.
+References cache.
-
00806 {
-00807 return EnumConf(cache,tag.c_str());
-00808 }
+00839 {
+00840 return EnumConf(cache,tag.c_str());
+00841 }
@@ -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 810 of file modules.cpp.
+Definition at line 843 of file modules.cpp.
-References cache.
+References cache.
-
00811 {
-00812 return EnumValues(cache, tag.c_str(), index);
-00813 }
+00844 {
+00845 return EnumValues(cache, tag.c_str(), index);
+00846 }
@@ -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 765 of file modules.cpp.
+Definition at line 798 of file modules.cpp.
-References error.
+References error.
-
00766 {
-00767 long olderr = this->error;
-00768 this->error = 0;
-00769 return olderr;
-00770 }
+00799 {
+00800 long olderr = this->error;
+00801 this->error = 0;
+00802 return olderr;
+00803 }
@@ -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 719 of file modules.cpp.
-
-References cache, CONF_VALUE_NOT_FOUND, and error.
-
-
00720 {
-00721 char val[MAXBUF];
-00722 char t[MAXBUF];
-00723 char n[MAXBUF];
-00724 strlcpy(t,tag.c_str(),MAXBUF);
-00725 strlcpy(n,name.c_str(),MAXBUF);
-00726 int res = ReadConf(cache,t,n,index,val);
-00727 if (!res)
-00728 {
-00729 this->error = CONF_VALUE_NOT_FOUND;
-00730 return false;
-00731 }
-00732 std::string s = val;
-00733 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00734 }
+Definition at line 752 of file modules.cpp.
+
+References cache, CONF_VALUE_NOT_FOUND, and error.
+
+
00753 {
+00754 char val[MAXBUF];
+00755 char t[MAXBUF];
+00756 char n[MAXBUF];
+00757 strlcpy(t,tag.c_str(),MAXBUF);
+00758 strlcpy(n,name.c_str(),MAXBUF);
+00759 int res = ReadConf(cache,t,n,index,val);
+00760 if (!res)
+00761 {
+00762 this->error = CONF_VALUE_NOT_FOUND;
+00763 return false;
+00764 }
+00765 std::string s = val;
+00766 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00767 }
@@ -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 736 of file modules.cpp.
-
-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
-
-
00737 {
-00738 char val[MAXBUF];
-00739 char t[MAXBUF];
-00740 char n[MAXBUF];
-00741 strlcpy(t,tag.c_str(),MAXBUF);
-00742 strlcpy(n,name.c_str(),MAXBUF);
-00743 int res = ReadConf(cache,t,n,index,val);
-00744 if (!res)
-00745 {
-00746 this->error = CONF_VALUE_NOT_FOUND;
-00747 return 0;
-00748 }
-00749 for (int i = 0; i < strlen(val); i++)
-00750 {
-00751 if (!isdigit(val[i]))
-00752 {
-00753 this->error = CONF_NOT_A_NUMBER;
-00754 return 0;
-00755 }
-00756 }
-00757 if ((needs_unsigned) && (atoi(val)<0))
-00758 {
-00759 this->error = CONF_NOT_UNSIGNED;
-00760 return 0;
-00761 }
-00762 return atoi(val);
-00763 }
+Definition at line 769 of file modules.cpp.
+
+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
+
+
00770 {
+00771 char val[MAXBUF];
+00772 char t[MAXBUF];
+00773 char n[MAXBUF];
+00774 strlcpy(t,tag.c_str(),MAXBUF);
+00775 strlcpy(n,name.c_str(),MAXBUF);
+00776 int res = ReadConf(cache,t,n,index,val);
+00777 if (!res)
+00778 {
+00779 this->error = CONF_VALUE_NOT_FOUND;
+00780 return 0;
+00781 }
+00782 for (int i = 0; i < strlen(val); i++)
+00783 {
+00784 if (!isdigit(val[i]))
+00785 {
+00786 this->error = CONF_NOT_A_NUMBER;
+00787 return 0;
+00788 }
+00789 }
+00790 if ((needs_unsigned) && (atoi(val)<0))
+00791 {
+00792 this->error = CONF_NOT_UNSIGNED;
+00793 return 0;
+00794 }
+00795 return atoi(val);
+00796 }
@@ -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 703 of file modules.cpp.
-
-References cache, CONF_VALUE_NOT_FOUND, and error.
-
-
00704 {
-00705 char val[MAXBUF];
-00706 char t[MAXBUF];
-00707 char n[MAXBUF];
-00708 strlcpy(t,tag.c_str(),MAXBUF);
-00709 strlcpy(n,name.c_str(),MAXBUF);
-00710 int res = ReadConf(cache,t,n,index,val);
-00711 if (!res)
-00712 {
-00713 this->error = CONF_VALUE_NOT_FOUND;
-00714 return "";
-00715 }
-00716 return std::string(val);
-00717 }
+Definition at line 736 of file modules.cpp.
+
+References cache, CONF_VALUE_NOT_FOUND, and error.
+
+
00737 {
+00738 char val[MAXBUF];
+00739 char t[MAXBUF];
+00740 char n[MAXBUF];
+00741 strlcpy(t,tag.c_str(),MAXBUF);
+00742 strlcpy(n,name.c_str(),MAXBUF);
+00743 int res = ReadConf(cache,t,n,index,val);
+00744 if (!res)
+00745 {
+00746 this->error = CONF_VALUE_NOT_FOUND;
+00747 return "";
+00748 }
+00749 return std::string(val);
+00750 }
@@ -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 815 of file modules.cpp.
+Definition at line 848 of file modules.cpp.
-References readerror.
+References readerror.
-
00816 {
-00817 return this->readerror;
-00818 }
+00849 {
+00850 return this->readerror;
+00851 }
@@ -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 798 of file modules.h.
+Definition at line 843 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 803 of file modules.h.
+Definition at line 848 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 799 of file modules.h.
+Definition at line 844 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 802 of file modules.h.
+Definition at line 847 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 13 13:07:02 2005 for InspIRCd by
+
Generated on Thu Apr 14 21:12:08 2005 for InspIRCd by
1.3.3
--
cgit v1.3.1-10-gc9f91