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.3264
1 files changed, 132 insertions, 132 deletions
diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3
index f0236bfe9..4812464bd 100644
--- a/docs/man/man3/ConfigReader.3
+++ b/docs/man/man3/ConfigReader.3
@@ -93,19 +93,19 @@ Default constructor.
.PP
This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
.PP
-Definition at line 739 of file modules.cpp.
+Definition at line 731 of file modules.cpp.
.PP
References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.
.PP
.nf
-740 {
-741 Config->ClearStack();
-742 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-743 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-744 this->readerror = Config->LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-745 if (!this->readerror)
-746 this->error = CONF_FILE_NOT_FOUND;
-747 }
+732 {
+733 Config->ClearStack();
+734 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+735 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+736 this->readerror = Config->LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+737 if (!this->readerror)
+738 this->error = CONF_FILE_NOT_FOUND;
+739 }
.fi
.PP
.SS "ConfigReader::ConfigReader (\fBstd::string\fP filename)"
@@ -114,19 +114,19 @@ Overloaded constructor.
.PP
This constructor initialises the ConfigReader class to read a user-specified config file
.PP
-Definition at line 759 of file modules.cpp.
+Definition at line 751 of file modules.cpp.
.PP
References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.
.PP
.nf
-760 {
-761 Config->ClearStack();
-762 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-763 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-764 this->readerror = Config->LoadConf(filename.c_str(),this->cache,this->errorlog);
-765 if (!this->readerror)
-766 this->error = CONF_FILE_NOT_FOUND;
-767 };
+752 {
+753 Config->ClearStack();
+754 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+755 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+756 this->readerror = Config->LoadConf(filename.c_str(),this->cache,this->errorlog);
+757 if (!this->readerror)
+758 this->error = CONF_FILE_NOT_FOUND;
+759 };
.fi
.PP
.SS "ConfigReader::~ConfigReader ()"
@@ -135,17 +135,17 @@ Default destructor.
.PP
This method destroys the ConfigReader class.
.PP
-Definition at line 750 of file modules.cpp.
+Definition at line 742 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
-751 {
-752 if (this->cache)
-753 delete this->cache;
-754 if (this->errorlog)
-755 delete this->errorlog;
-756 }
+743 {
+744 if (this->cache)
+745 delete this->cache;
+746 if (this->errorlog)
+747 delete this->errorlog;
+748 }
.fi
.PP
.SH "Member Function Documentation"
@@ -156,41 +156,41 @@ Dumps the list of errors in a config file to an output location.
.PP
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.
.PP
-Definition at line 838 of file modules.cpp.
+Definition at line 830 of file modules.cpp.
.PP
-References errorlog, connection::fd, and userrec::nick.
+References errorlog, connection::fd, userrec::nick, WriteOpers(), and WriteServ().
.PP
.nf
-839 {
-840 if (bail)
-841 {
-842 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
-843 exit(0);
-844 }
-845 else
-846 {
-847 char dataline[1024];
-848 if (user)
-849 {
-850 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
-851 while (!errorlog->eof())
-852 {
-853 errorlog->getline(dataline,1024);
-854 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
-855 }
-856 }
-857 else
-858 {
-859 WriteOpers('There were errors in the configuration file:',user->nick);
-860 while (!errorlog->eof())
-861 {
-862 errorlog->getline(dataline,1024);
-863 WriteOpers(dataline);
-864 }
-865 }
-866 return;
-867 }
-868 }
+831 {
+832 if (bail)
+833 {
+834 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
+835 exit(0);
+836 }
+837 else
+838 {
+839 char dataline[1024];
+840 if (user)
+841 {
+842 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
+843 while (!errorlog->eof())
+844 {
+845 errorlog->getline(dataline,1024);
+846 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
+847 }
+848 }
+849 else
+850 {
+851 WriteOpers('There were errors in the configuration file:',user->nick);
+852 while (!errorlog->eof())
+853 {
+854 errorlog->getline(dataline,1024);
+855 WriteOpers(dataline);
+856 }
+857 }
+858 return;
+859 }
+860 }
.fi
.PP
.SS "int ConfigReader::Enumerate (\fBstd::string\fP tag)"
@@ -199,14 +199,14 @@ Counts the number of times a given tag appears in the config file.
.PP
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.
.PP
-Definition at line 871 of file modules.cpp.
+Definition at line 863 of file modules.cpp.
.PP
References cache, and ServerConfig::EnumConf().
.PP
.nf
-872 {
-873 return Config->EnumConf(cache,tag.c_str());
-874 }
+864 {
+865 return Config->EnumConf(cache,tag.c_str());
+866 }
.fi
.PP
.SS "int ConfigReader::EnumerateValues (\fBstd::string\fP tag, int index)"
@@ -215,14 +215,14 @@ Returns the number of items within a tag.
.PP
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.
.PP
-Definition at line 876 of file modules.cpp.
+Definition at line 868 of file modules.cpp.
.PP
References cache, and ServerConfig::EnumValues().
.PP
.nf
-877 {
-878 return Config->EnumValues(cache, tag.c_str(), index);
-879 }
+869 {
+870 return Config->EnumValues(cache, tag.c_str(), index);
+871 }
.fi
.PP
.SS "long ConfigReader::GetError ()"
@@ -231,16 +231,16 @@ Returns the last error to occur.
.PP
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.
.PP
-Definition at line 831 of file modules.cpp.
+Definition at line 823 of file modules.cpp.
.PP
References error.
.PP
.nf
-832 {
-833 long olderr = this->error;
-834 this->error = 0;
-835 return olderr;
-836 }
+824 {
+825 long olderr = this->error;
+826 this->error = 0;
+827 return olderr;
+828 }
.fi
.PP
.SS "bool ConfigReader::ReadFlag (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
@@ -249,26 +249,26 @@ Retrieves a boolean value from the config file.
.PP
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.
.PP
-Definition at line 785 of file modules.cpp.
+Definition at line 777 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
.PP
.nf
-786 {
-787 char val[MAXBUF];
-788 char t[MAXBUF];
-789 char n[MAXBUF];
-790 strlcpy(t,tag.c_str(),MAXBUF);
-791 strlcpy(n,name.c_str(),MAXBUF);
-792 int res = Config->ReadConf(cache,t,n,index,val);
-793 if (!res)
-794 {
-795 this->error = CONF_VALUE_NOT_FOUND;
-796 return false;
-797 }
-798 std::string s = val;
-799 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
-800 }
+778 {
+779 char val[MAXBUF];
+780 char t[MAXBUF];
+781 char n[MAXBUF];
+782 strlcpy(t,tag.c_str(),MAXBUF);
+783 strlcpy(n,name.c_str(),MAXBUF);
+784 int res = Config->ReadConf(cache,t,n,index,val);
+785 if (!res)
+786 {
+787 this->error = CONF_VALUE_NOT_FOUND;
+788 return false;
+789 }
+790 std::string s = val;
+791 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
+792 }
.fi
.PP
.SS "long ConfigReader::ReadInteger (\fBstd::string\fP tag, \fBstd::string\fP name, int index, bool needs_unsigned)"
@@ -277,38 +277,38 @@ Retrieves an integer value from the config file.
.PP
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_UNSIGNED
.PP
-Definition at line 802 of file modules.cpp.
+Definition at line 794 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
.PP
.nf
-803 {
-804 char val[MAXBUF];
-805 char t[MAXBUF];
-806 char n[MAXBUF];
-807 strlcpy(t,tag.c_str(),MAXBUF);
-808 strlcpy(n,name.c_str(),MAXBUF);
-809 int res = Config->ReadConf(cache,t,n,index,val);
-810 if (!res)
-811 {
-812 this->error = CONF_VALUE_NOT_FOUND;
-813 return 0;
+795 {
+796 char val[MAXBUF];
+797 char t[MAXBUF];
+798 char n[MAXBUF];
+799 strlcpy(t,tag.c_str(),MAXBUF);
+800 strlcpy(n,name.c_str(),MAXBUF);
+801 int res = Config->ReadConf(cache,t,n,index,val);
+802 if (!res)
+803 {
+804 this->error = CONF_VALUE_NOT_FOUND;
+805 return 0;
+806 }
+807 for (unsigned int i = 0; i < strlen(val); i++)
+808 {
+809 if (!isdigit(val[i]))
+810 {
+811 this->error = CONF_NOT_A_NUMBER;
+812 return 0;
+813 }
814 }
-815 for (unsigned int i = 0; i < strlen(val); i++)
+815 if ((needs_unsigned) && (atoi(val)<0))
816 {
-817 if (!isdigit(val[i]))
-818 {
-819 this->error = CONF_NOT_A_NUMBER;
-820 return 0;
-821 }
-822 }
-823 if ((needs_unsigned) && (atoi(val)<0))
-824 {
-825 this->error = CONF_NOT_UNSIGNED;
-826 return 0;
-827 }
-828 return atoi(val);
-829 }
+817 this->error = CONF_NOT_UNSIGNED;
+818 return 0;
+819 }
+820 return atoi(val);
+821 }
.fi
.PP
.SS "\fBstd::string\fP ConfigReader::ReadValue (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
@@ -317,25 +317,25 @@ Retrieves a value from the config file.
.PP
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.
.PP
-Definition at line 769 of file modules.cpp.
+Definition at line 761 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
.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 = Config->ReadConf(cache,t,n,index,val);
-777 if (!res)
-778 {
-779 this->error = CONF_VALUE_NOT_FOUND;
-780 return '';
-781 }
-782 return val;
-783 }
+762 {
+763 char val[MAXBUF];
+764 char t[MAXBUF];
+765 char n[MAXBUF];
+766 strlcpy(t,tag.c_str(),MAXBUF);
+767 strlcpy(n,name.c_str(),MAXBUF);
+768 int res = Config->ReadConf(cache,t,n,index,val);
+769 if (!res)
+770 {
+771 this->error = CONF_VALUE_NOT_FOUND;
+772 return '';
+773 }
+774 return val;
+775 }
.fi
.PP
.SS "bool ConfigReader::Verify ()"
@@ -344,14 +344,14 @@ Returns true if a config file is valid.
.PP
This method is partially implemented and will only return false if the config file does not exist or could not be opened.
.PP
-Definition at line 881 of file modules.cpp.
+Definition at line 873 of file modules.cpp.
.PP
References readerror.
.PP
.nf
-882 {
-883 return this->readerror;
-884 }
+874 {
+875 return this->readerror;
+876 }
.fi
.PP
.SH "Member Data Documentation"
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-19 22:21:43 +0000