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.3267
1 files changed, 134 insertions, 133 deletions
diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3
index 3d7241239..6e9a3bfed 100644
--- a/docs/man/man3/ConfigReader.3
+++ b/docs/man/man3/ConfigReader.3
@@ -1,4 +1,4 @@
-.TH "ConfigReader" 3 "25 May 2005" "InspIRCd" \" -*- nroff -*-
+.TH "ConfigReader" 3 "30 May 2005" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -89,213 +89,214 @@ Definition at line 1150 of file modules.h.
.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 819 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 821 of file modules.cpp.
.PP
-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
+References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
.PP
.nf
-820 {
-821 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-822 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-823 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-824 if (!this->readerror)
-825 this->error = CONF_FILE_NOT_FOUND;
-826 }
+822 {
+823 include_stack.clear();
+824 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+825 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+826 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+827 if (!this->readerror)
+828 this->error = CONF_FILE_NOT_FOUND;
+829 }
.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 838 of file modules.cpp.
+Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 841 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
-839 {
-840 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-841 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-842 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-843 if (!this->readerror)
-844 this->error = CONF_FILE_NOT_FOUND;
-845 };
+842 {
+843 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+844 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+845 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+846 if (!this->readerror)
+847 this->error = CONF_FILE_NOT_FOUND;
+848 };
.fi
.SS "ConfigReader::~\fBConfigReader\fP ()"
.PP
-Default destructor. This method destroys the ConfigReader class.Definition at line 829 of file modules.cpp.
+Default destructor. This method destroys the ConfigReader class.Definition at line 832 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
-830 {
-831 if (this->cache)
-832 delete this->cache;
-833 if (this->errorlog)
-834 delete this->errorlog;
-835 }
+833 {
+834 if (this->cache)
+835 delete this->cache;
+836 if (this->errorlog)
+837 delete this->errorlog;
+838 }
.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 916 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 919 of file modules.cpp.
.PP
References errorlog, connection::fd, and userrec::nick.
.PP
.nf
-917 {
-918 if (bail)
-919 {
-920 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
-921 exit(0);
-922 }
-923 else
-924 {
-925 char dataline[1024];
-926 if (user)
-927 {
-928 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
-929 while (!errorlog->eof())
-930 {
-931 errorlog->getline(dataline,1024);
-932 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
-933 }
-934 }
-935 else
-936 {
-937 WriteOpers('There were errors in the configuration file:',user->nick);
-938 while (!errorlog->eof())
-939 {
-940 errorlog->getline(dataline,1024);
-941 WriteOpers(dataline);
-942 }
-943 }
-944 return;
-945 }
-946 }
+920 {
+921 if (bail)
+922 {
+923 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
+924 exit(0);
+925 }
+926 else
+927 {
+928 char dataline[1024];
+929 if (user)
+930 {
+931 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
+932 while (!errorlog->eof())
+933 {
+934 errorlog->getline(dataline,1024);
+935 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
+936 }
+937 }
+938 else
+939 {
+940 WriteOpers('There were errors in the configuration file:',user->nick);
+941 while (!errorlog->eof())
+942 {
+943 errorlog->getline(dataline,1024);
+944 WriteOpers(dataline);
+945 }
+946 }
+947 return;
+948 }
+949 }
.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 949 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 952 of file modules.cpp.
.PP
References cache.
.PP
.nf
-950 {
-951 return EnumConf(cache,tag.c_str());
-952 }
+953 {
+954 return EnumConf(cache,tag.c_str());
+955 }
.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 954 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 957 of file modules.cpp.
.PP
References cache.
.PP
.nf
-955 {
-956 return EnumValues(cache, tag.c_str(), index);
-957 }
+958 {
+959 return EnumValues(cache, tag.c_str(), index);
+960 }
.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 909 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 912 of file modules.cpp.
.PP
References error.
.PP
.nf
-910 {
-911 long olderr = this->error;
-912 this->error = 0;
-913 return olderr;
-914 }
+913 {
+914 long olderr = this->error;
+915 this->error = 0;
+916 return olderr;
+917 }
.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 863 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 866 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-864 {
-865 char val[MAXBUF];
-866 char t[MAXBUF];
-867 char n[MAXBUF];
-868 strlcpy(t,tag.c_str(),MAXBUF);
-869 strlcpy(n,name.c_str(),MAXBUF);
-870 int res = ReadConf(cache,t,n,index,val);
-871 if (!res)
-872 {
-873 this->error = CONF_VALUE_NOT_FOUND;
-874 return false;
-875 }
-876 std::string s = val;
-877 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
-878 }
+867 {
+868 char val[MAXBUF];
+869 char t[MAXBUF];
+870 char n[MAXBUF];
+871 strlcpy(t,tag.c_str(),MAXBUF);
+872 strlcpy(n,name.c_str(),MAXBUF);
+873 int res = ReadConf(cache,t,n,index,val);
+874 if (!res)
+875 {
+876 this->error = CONF_VALUE_NOT_FOUND;
+877 return false;
+878 }
+879 std::string s = val;
+880 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
+881 }
.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 880 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 883 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-881 {
-882 char val[MAXBUF];
-883 char t[MAXBUF];
-884 char n[MAXBUF];
-885 strlcpy(t,tag.c_str(),MAXBUF);
-886 strlcpy(n,name.c_str(),MAXBUF);
-887 int res = ReadConf(cache,t,n,index,val);
-888 if (!res)
-889 {
-890 this->error = CONF_VALUE_NOT_FOUND;
-891 return 0;
-892 }
-893 for (int i = 0; i < strlen(val); i++)
-894 {
-895 if (!isdigit(val[i]))
-896 {
-897 this->error = CONF_NOT_A_NUMBER;
-898 return 0;
-899 }
-900 }
-901 if ((needs_unsigned) && (atoi(val)<0))
-902 {
-903 this->error = CONF_NOT_UNSIGNED;
-904 return 0;
-905 }
-906 return atoi(val);
-907 }
+884 {
+885 char val[MAXBUF];
+886 char t[MAXBUF];
+887 char n[MAXBUF];
+888 strlcpy(t,tag.c_str(),MAXBUF);
+889 strlcpy(n,name.c_str(),MAXBUF);
+890 int res = ReadConf(cache,t,n,index,val);
+891 if (!res)
+892 {
+893 this->error = CONF_VALUE_NOT_FOUND;
+894 return 0;
+895 }
+896 for (int i = 0; i < strlen(val); i++)
+897 {
+898 if (!isdigit(val[i]))
+899 {
+900 this->error = CONF_NOT_A_NUMBER;
+901 return 0;
+902 }
+903 }
+904 if ((needs_unsigned) && (atoi(val)<0))
+905 {
+906 this->error = CONF_NOT_UNSIGNED;
+907 return 0;
+908 }
+909 return atoi(val);
+910 }
.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 847 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 850 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-848 {
-849 char val[MAXBUF];
-850 char t[MAXBUF];
-851 char n[MAXBUF];
-852 strlcpy(t,tag.c_str(),MAXBUF);
-853 strlcpy(n,name.c_str(),MAXBUF);
-854 int res = ReadConf(cache,t,n,index,val);
-855 if (!res)
-856 {
-857 this->error = CONF_VALUE_NOT_FOUND;
-858 return '';
-859 }
-860 return val;
-861 }
+851 {
+852 char val[MAXBUF];
+853 char t[MAXBUF];
+854 char n[MAXBUF];
+855 strlcpy(t,tag.c_str(),MAXBUF);
+856 strlcpy(n,name.c_str(),MAXBUF);
+857 int res = ReadConf(cache,t,n,index,val);
+858 if (!res)
+859 {
+860 this->error = CONF_VALUE_NOT_FOUND;
+861 return '';
+862 }
+863 return val;
+864 }
.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 959 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 962 of file modules.cpp.
.PP
References readerror.
.PP
.nf
-960 {
-961 return this->readerror;
-962 }
+963 {
+964 return this->readerror;
+965 }
.fi
.SH "Member Data Documentation"
.PP
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-16 05:00:11 +0000