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.3272
1 files changed, 136 insertions, 136 deletions
diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3
index 09f69c095..d0f0a1d5f 100644
--- a/docs/man/man3/ConfigReader.3
+++ b/docs/man/man3/ConfigReader.3
@@ -84,239 +84,239 @@ 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 891 of file modules.h.
+Definition at line 944 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 717 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 762 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
-718 {
-719 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-720 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-721 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-722 if (!this->readerror)
-723 this->error = CONF_FILE_NOT_FOUND;
-724 }
+763 {
+764 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+765 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+766 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+767 if (!this->readerror)
+768 this->error = CONF_FILE_NOT_FOUND;
+769 }
.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 736 of file modules.cpp.
+Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 781 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
-737 {
-738 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-739 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-740 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-741 if (!this->readerror)
-742 this->error = CONF_FILE_NOT_FOUND;
-743 };
+782 {
+783 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+784 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+785 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+786 if (!this->readerror)
+787 this->error = CONF_FILE_NOT_FOUND;
+788 };
.fi
.SS "ConfigReader::~\fBConfigReader\fP ()"
.PP
-Default destructor. This method destroys the ConfigReader class.Definition at line 727 of file modules.cpp.
+Default destructor. This method destroys the ConfigReader class.Definition at line 772 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
-728 {
-729 if (this->cache)
-730 delete this->cache;
-731 if (this->errorlog)
-732 delete this->errorlog;
-733 }
+773 {
+774 if (this->cache)
+775 delete this->cache;
+776 if (this->errorlog)
+777 delete this->errorlog;
+778 }
.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 814 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 859 of file modules.cpp.
.PP
References errorlog, connection::fd, and userrec::nick.
.PP
.nf
-815 {
-816 if (bail)
-817 {
-818 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
-819 exit(0);
-820 }
-821 else
-822 {
-823 char dataline[1024];
-824 if (user)
-825 {
-826 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
-827 while (!errorlog->eof())
-828 {
-829 errorlog->getline(dataline,1024);
-830 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
-831 }
-832 }
-833 else
-834 {
-835 WriteOpers('There were errors in the configuration file:',user->nick);
-836 while (!errorlog->eof())
-837 {
-838 errorlog->getline(dataline,1024);
-839 WriteOpers(dataline);
-840 }
-841 }
-842 return;
-843 }
-844 }
+860 {
+861 if (bail)
+862 {
+863 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
+864 exit(0);
+865 }
+866 else
+867 {
+868 char dataline[1024];
+869 if (user)
+870 {
+871 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
+872 while (!errorlog->eof())
+873 {
+874 errorlog->getline(dataline,1024);
+875 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
+876 }
+877 }
+878 else
+879 {
+880 WriteOpers('There were errors in the configuration file:',user->nick);
+881 while (!errorlog->eof())
+882 {
+883 errorlog->getline(dataline,1024);
+884 WriteOpers(dataline);
+885 }
+886 }
+887 return;
+888 }
+889 }
.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 847 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 892 of file modules.cpp.
.PP
References cache.
.PP
.nf
-848 {
-849 return EnumConf(cache,tag.c_str());
-850 }
+893 {
+894 return EnumConf(cache,tag.c_str());
+895 }
.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 852 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 897 of file modules.cpp.
.PP
References cache.
.PP
.nf
-853 {
-854 return EnumValues(cache, tag.c_str(), index);
-855 }
+898 {
+899 return EnumValues(cache, tag.c_str(), index);
+900 }
.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 807 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 852 of file modules.cpp.
.PP
References error.
.PP
.nf
-808 {
-809 long olderr = this->error;
-810 this->error = 0;
-811 return olderr;
-812 }
+853 {
+854 long olderr = this->error;
+855 this->error = 0;
+856 return olderr;
+857 }
.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 761 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 806 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-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 = ReadConf(cache,t,n,index,val);
-769 if (!res)
-770 {
-771 this->error = CONF_VALUE_NOT_FOUND;
-772 return false;
-773 }
-774 std::string s = val;
-775 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
-776 }
+807 {
+808 char val[MAXBUF];
+809 char t[MAXBUF];
+810 char n[MAXBUF];
+811 strlcpy(t,tag.c_str(),MAXBUF);
+812 strlcpy(n,name.c_str(),MAXBUF);
+813 int res = ReadConf(cache,t,n,index,val);
+814 if (!res)
+815 {
+816 this->error = CONF_VALUE_NOT_FOUND;
+817 return false;
+818 }
+819 std::string s = val;
+820 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
+821 }
.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 778 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 823 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-779 {
-780 char val[MAXBUF];
-781 char t[MAXBUF];
-782 char n[MAXBUF];
-783 strlcpy(t,tag.c_str(),MAXBUF);
-784 strlcpy(n,name.c_str(),MAXBUF);
-785 int res = ReadConf(cache,t,n,index,val);
-786 if (!res)
-787 {
-788 this->error = CONF_VALUE_NOT_FOUND;
-789 return 0;
-790 }
-791 for (int i = 0; i < strlen(val); i++)
-792 {
-793 if (!isdigit(val[i]))
-794 {
-795 this->error = CONF_NOT_A_NUMBER;
-796 return 0;
-797 }
-798 }
-799 if ((needs_unsigned) && (atoi(val)<0))
-800 {
-801 this->error = CONF_NOT_UNSIGNED;
-802 return 0;
-803 }
-804 return atoi(val);
-805 }
+824 {
+825 char val[MAXBUF];
+826 char t[MAXBUF];
+827 char n[MAXBUF];
+828 strlcpy(t,tag.c_str(),MAXBUF);
+829 strlcpy(n,name.c_str(),MAXBUF);
+830 int res = ReadConf(cache,t,n,index,val);
+831 if (!res)
+832 {
+833 this->error = CONF_VALUE_NOT_FOUND;
+834 return 0;
+835 }
+836 for (int i = 0; i < strlen(val); i++)
+837 {
+838 if (!isdigit(val[i]))
+839 {
+840 this->error = CONF_NOT_A_NUMBER;
+841 return 0;
+842 }
+843 }
+844 if ((needs_unsigned) && (atoi(val)<0))
+845 {
+846 this->error = CONF_NOT_UNSIGNED;
+847 return 0;
+848 }
+849 return atoi(val);
+850 }
.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 745 of file modules.cpp.
+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 790 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-746 {
-747 char val[MAXBUF];
-748 char t[MAXBUF];
-749 char n[MAXBUF];
-750 strlcpy(t,tag.c_str(),MAXBUF);
-751 strlcpy(n,name.c_str(),MAXBUF);
-752 int res = ReadConf(cache,t,n,index,val);
-753 if (!res)
-754 {
-755 this->error = CONF_VALUE_NOT_FOUND;
-756 return '';
-757 }
-758 return std::string(val);
-759 }
+791 {
+792 char val[MAXBUF];
+793 char t[MAXBUF];
+794 char n[MAXBUF];
+795 strlcpy(t,tag.c_str(),MAXBUF);
+796 strlcpy(n,name.c_str(),MAXBUF);
+797 int res = ReadConf(cache,t,n,index,val);
+798 if (!res)
+799 {
+800 this->error = CONF_VALUE_NOT_FOUND;
+801 return '';
+802 }
+803 return std::string(val);
+804 }
.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 857 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 902 of file modules.cpp.
.PP
References readerror.
.PP
.nf
-858 {
-859 return this->readerror;
-860 }
+903 {
+904 return this->readerror;
+905 }
.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 899 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 952 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 904 of file modules.h.
+Definition at line 957 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 900 of file modules.h.
+Definition at line 953 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 903 of file modules.h.
+Used to store errors. Definition at line 956 of file modules.h.
.PP
Referenced by ConfigReader(), and Verify().
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-15 22:58:39 +0000