summaryrefslogtreecommitdiff
path: root/docs/man/man3/ConfigReader.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/man3/ConfigReader.3')
-rw-r--r--docs/man/man3/ConfigReader.3266
1 files changed, 133 insertions, 133 deletions
diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3
index d5978696b..9075a80a9 100644
--- a/docs/man/man3/ConfigReader.3
+++ b/docs/man/man3/ConfigReader.3
@@ -1,4 +1,4 @@
-.TH "ConfigReader" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*-
+.TH "ConfigReader" 3 "14 Apr 2005" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -84,158 +84,193 @@ 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 790 of file modules.h.
+Definition at line 835 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 675 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 708 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
-676 {
-677 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-678 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-679 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-680 if (!this->readerror)
-681 this->error = CONF_FILE_NOT_FOUND;
-682 }
+709 {
+710 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+711 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+712 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+713 if (!this->readerror)
+714 this->error = CONF_FILE_NOT_FOUND;
+715 }
.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 694 of file modules.cpp.
+Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 727 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
-695 {
-696 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-697 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-698 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-699 if (!this->readerror)
-700 this->error = CONF_FILE_NOT_FOUND;
-701 };
+728 {
+729 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+730 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+731 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+732 if (!this->readerror)
+733 this->error = CONF_FILE_NOT_FOUND;
+734 };
.fi
.SS "ConfigReader::~\fBConfigReader\fP ()"
.PP
-Default destructor. This method destroys the ConfigReader class.Definition at line 685 of file modules.cpp.
+Default destructor. This method destroys the ConfigReader class.Definition at line 718 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
-686 {
-687 if (this->cache)
-688 delete this->cache;
-689 if (this->errorlog)
-690 delete this->errorlog;
-691 }
+719 {
+720 if (this->cache)
+721 delete this->cache;
+722 if (this->errorlog)
+723 delete this->errorlog;
+724 }
.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 772 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 805 of file modules.cpp.
.PP
References errorlog, connection::fd, and userrec::nick.
.PP
.nf
-773 {
-774 if (bail)
-775 {
-776 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
-777 exit(0);
-778 }
-779 else
-780 {
-781 char dataline[1024];
-782 if (user)
-783 {
-784 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
-785 while (!errorlog->eof())
-786 {
-787 errorlog->getline(dataline,1024);
-788 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
-789 }
-790 }
-791 else
-792 {
-793 WriteOpers('There were errors in the configuration file:',user->nick);
-794 while (!errorlog->eof())
-795 {
-796 errorlog->getline(dataline,1024);
-797 WriteOpers(dataline);
-798 }
-799 }
-800 return;
-801 }
-802 }
+806 {
+807 if (bail)
+808 {
+809 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
+810 exit(0);
+811 }
+812 else
+813 {
+814 char dataline[1024];
+815 if (user)
+816 {
+817 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
+818 while (!errorlog->eof())
+819 {
+820 errorlog->getline(dataline,1024);
+821 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
+822 }
+823 }
+824 else
+825 {
+826 WriteOpers('There were errors in the configuration file:',user->nick);
+827 while (!errorlog->eof())
+828 {
+829 errorlog->getline(dataline,1024);
+830 WriteOpers(dataline);
+831 }
+832 }
+833 return;
+834 }
+835 }
.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 805 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 838 of file modules.cpp.
.PP
References cache.
.PP
.nf
-806 {
-807 return EnumConf(cache,tag.c_str());
-808 }
+839 {
+840 return EnumConf(cache,tag.c_str());
+841 }
.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 810 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 843 of file modules.cpp.
.PP
References cache.
.PP
.nf
-811 {
-812 return EnumValues(cache, tag.c_str(), index);
-813 }
+844 {
+845 return EnumValues(cache, tag.c_str(), index);
+846 }
.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 765 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 798 of file modules.cpp.
.PP
References error.
.PP
.nf
-766 {
-767 long olderr = this->error;
-768 this->error = 0;
-769 return olderr;
-770 }
+799 {
+800 long olderr = this->error;
+801 this->error = 0;
+802 return olderr;
+803 }
.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 719 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 752 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-720 {
-721 char val[MAXBUF];
-722 char t[MAXBUF];
-723 char n[MAXBUF];
-724 strlcpy(t,tag.c_str(),MAXBUF);
-725 strlcpy(n,name.c_str(),MAXBUF);
-726 int res = ReadConf(cache,t,n,index,val);
-727 if (!res)
-728 {
-729 this->error = CONF_VALUE_NOT_FOUND;
-730 return false;
-731 }
-732 std::string s = val;
-733 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
-734 }
+753 {
+754 char val[MAXBUF];
+755 char t[MAXBUF];
+756 char n[MAXBUF];
+757 strlcpy(t,tag.c_str(),MAXBUF);
+758 strlcpy(n,name.c_str(),MAXBUF);
+759 int res = ReadConf(cache,t,n,index,val);
+760 if (!res)
+761 {
+762 this->error = CONF_VALUE_NOT_FOUND;
+763 return false;
+764 }
+765 std::string s = val;
+766 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
+767 }
.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 736 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 769 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
+770 {
+771 char val[MAXBUF];
+772 char t[MAXBUF];
+773 char n[MAXBUF];
+774 strlcpy(t,tag.c_str(),MAXBUF);
+775 strlcpy(n,name.c_str(),MAXBUF);
+776 int res = ReadConf(cache,t,n,index,val);
+777 if (!res)
+778 {
+779 this->error = CONF_VALUE_NOT_FOUND;
+780 return 0;
+781 }
+782 for (int i = 0; i < strlen(val); i++)
+783 {
+784 if (!isdigit(val[i]))
+785 {
+786 this->error = CONF_NOT_A_NUMBER;
+787 return 0;
+788 }
+789 }
+790 if ((needs_unsigned) && (atoi(val)<0))
+791 {
+792 this->error = CONF_NOT_UNSIGNED;
+793 return 0;
+794 }
+795 return atoi(val);
+796 }
+.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 736 of file modules.cpp.
+.PP
+References cache, CONF_VALUE_NOT_FOUND, and error.
+.PP
+.nf
737 {
738 char val[MAXBUF];
739 char t[MAXBUF];
@@ -246,77 +281,42 @@ References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, an
744 if (!res)
745 {
746 this->error = CONF_VALUE_NOT_FOUND;
-747 return 0;
+747 return '';
748 }
-749 for (int i = 0; i < strlen(val); i++)
-750 {
-751 if (!isdigit(val[i]))
-752 {
-753 this->error = CONF_NOT_A_NUMBER;
-754 return 0;
-755 }
-756 }
-757 if ((needs_unsigned) && (atoi(val)<0))
-758 {
-759 this->error = CONF_NOT_UNSIGNED;
-760 return 0;
-761 }
-762 return atoi(val);
-763 }
-.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 703 of file modules.cpp.
-.PP
-References cache, CONF_VALUE_NOT_FOUND, and error.
-.PP
-.nf
-704 {
-705 char val[MAXBUF];
-706 char t[MAXBUF];
-707 char n[MAXBUF];
-708 strlcpy(t,tag.c_str(),MAXBUF);
-709 strlcpy(n,name.c_str(),MAXBUF);
-710 int res = ReadConf(cache,t,n,index,val);
-711 if (!res)
-712 {
-713 this->error = CONF_VALUE_NOT_FOUND;
-714 return '';
-715 }
-716 return std::string(val);
-717 }
+749 return std::string(val);
+750 }
.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 815 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 848 of file modules.cpp.
.PP
References readerror.
.PP
.nf
-816 {
-817 return this->readerror;
-818 }
+849 {
+850 return this->readerror;
+851 }
.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 798 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 843 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 803 of file modules.h.
+Definition at line 848 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 799 of file modules.h.
+Definition at line 844 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 802 of file modules.h.
+Used to store errors. Definition at line 847 of file modules.h.
.PP
Referenced by ConfigReader(), and Verify().
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-25 17:28:39 +0000