X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fmodule-doc%2FclassConfigReader.html;h=1e81811f5ea4ecfa5ee448e7a58d33bb7cb3b478;hb=654ff4ae2f06704de2beb1050021c8196f693cb5;hp=3519d1aa80b5fc4fdb2a6ae298d3a9c525f72bdb;hpb=52899de0ff2d62ca0542b243c41626010bf62083;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 3519d1aa8..1e81811f5 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 641 of file modules.h.
This constructor initialises the ConfigReader class to read a user-specified config file
-Definition at line 585 of file modules.cpp. +Definition at line 694 of file modules.cpp.
-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
-
00586 { -00587 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -00588 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -00589 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -00590 if (!this->readerror) -00591 this->error = CONF_FILE_NOT_FOUND; -00592 }; +@@ -184,16 +184,16 @@ Default destructor.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 };This method destroys the ConfigReader class.
-Definition at line 576 of file modules.cpp. +Definition at line 685 of file modules.cpp.
-References cache, and errorlog. +References cache, and errorlog.
-
00577 { -00578 if (this->cache) -00579 delete this->cache; -00580 if (this->errorlog) -00581 delete this->errorlog; -00582 } +@@ -237,40 +237,40 @@ Dumps the list of errors in a config file to an output location.00686 { +00687 if (this->cache) +00688 delete this->cache; +00689 if (this->errorlog) +00690 delete this->errorlog; +00691 }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 663 of file modules.cpp. -
-References errorlog, connection::fd, and userrec::nick. -
-
00664 { -00665 if (bail) -00666 { -00667 printf("There were errors in your configuration:\n%s",errorlog->str().c_str()); -00668 exit(0); -00669 } -00670 else -00671 { -00672 char dataline[1024]; -00673 if (user) -00674 { -00675 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick); -00676 while (!errorlog->eof()) -00677 { -00678 errorlog->getline(dataline,1024); -00679 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline); -00680 } -00681 } -00682 else -00683 { -00684 WriteOpers("There were errors in the configuration file:",user->nick); -00685 while (!errorlog->eof()) -00686 { -00687 errorlog->getline(dataline,1024); -00688 WriteOpers(dataline); -00689 } -00690 } -00691 return; -00692 } -00693 } +Definition at line 772 of file modules.cpp. ++References errorlog, connection::fd, and userrec::nick. +
+
@@ -304,13 +304,13 @@ Counts the number of times a given tag appears in the config file.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 }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 696 of file modules.cpp. +Definition at line 805 of file modules.cpp.
-References cache. +References cache.
-
00697 { -00698 return EnumConf(cache,tag.c_str()); -00699 } +@@ -353,13 +353,13 @@ Returns the number of items within a tag.00806 { +00807 return EnumConf(cache,tag.c_str()); +00808 }
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 701 of file modules.cpp. +Definition at line 810 of file modules.cpp.
-References cache. +References cache.
-
00702 { -00703 return EnumValues(cache, tag.c_str(), index); -00704 } +@@ -392,15 +392,15 @@ Returns the last error to occur.00811 { +00812 return EnumValues(cache, tag.c_str(), index); +00813 }
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 656 of file modules.cpp. +Definition at line 765 of file modules.cpp.
-References error. +References error.
-
00657 { -00658 long olderr = this->error; -00659 this->error = 0; -00660 return olderr; -00661 } +@@ -449,25 +449,25 @@ Retrieves a boolean value from the config file.00766 { +00767 long olderr = this->error; +00768 this->error = 0; +00769 return olderr; +00770 }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 610 of file modules.cpp. -
-References cache, CONF_VALUE_NOT_FOUND, and error. -
-
00611 { -00612 char val[MAXBUF]; -00613 char t[MAXBUF]; -00614 char n[MAXBUF]; -00615 strlcpy(t,tag.c_str(),MAXBUF); -00616 strlcpy(n,name.c_str(),MAXBUF); -00617 int res = ReadConf(cache,t,n,index,val); -00618 if (!res) -00619 { -00620 this->error = CONF_VALUE_NOT_FOUND; -00621 return false; -00622 } -00623 std::string s = val; -00624 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1")); -00625 } +Definition at line 719 of file modules.cpp. ++References cache, CONF_VALUE_NOT_FOUND, and error. +
+
@@ -522,37 +522,37 @@ Retrieves an integer value from the config file.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 }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 627 of file modules.cpp. -
-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. -
-
00628 { -00629 char val[MAXBUF]; -00630 char t[MAXBUF]; -00631 char n[MAXBUF]; -00632 strlcpy(t,tag.c_str(),MAXBUF); -00633 strlcpy(n,name.c_str(),MAXBUF); -00634 int res = ReadConf(cache,t,n,index,val); -00635 if (!res) -00636 { -00637 this->error = CONF_VALUE_NOT_FOUND; -00638 return 0; -00639 } -00640 for (int i = 0; i < strlen(val); i++) -00641 { -00642 if (!isdigit(val[i])) -00643 { -00644 this->error = CONF_NOT_A_NUMBER; -00645 return 0; -00646 } -00647 } -00648 if ((needs_unsigned) && (atoi(val)<0)) -00649 { -00650 this->error = CONF_NOT_UNSIGNED; -00651 return 0; -00652 } -00653 return atoi(val); -00654 } +Definition at line 736 of file modules.cpp. ++References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. +
+
@@ -601,24 +601,24 @@ Retrieves a value from the config file.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 }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 594 of file modules.cpp. -
-References cache, CONF_VALUE_NOT_FOUND, and error. -
-
00595 { -00596 char val[MAXBUF]; -00597 char t[MAXBUF]; -00598 char n[MAXBUF]; -00599 strlcpy(t,tag.c_str(),MAXBUF); -00600 strlcpy(n,name.c_str(),MAXBUF); -00601 int res = ReadConf(cache,t,n,index,val); -00602 if (!res) -00603 { -00604 this->error = CONF_VALUE_NOT_FOUND; -00605 return ""; -00606 } -00607 return std::string(val); -00608 } +Definition at line 703 of file modules.cpp. ++References cache, CONF_VALUE_NOT_FOUND, and error. +
+
@@ -651,13 +651,13 @@ Returns true if a config file is valid.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 }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 706 of file modules.cpp. +Definition at line 815 of file modules.cpp.
-References readerror. +References readerror.
-
00707 { -00708 return this->readerror; -00709 } +@@ -685,9 +685,9 @@ The contents of the configuration file This protected member should never be acc00816 { +00817 return this->readerror; +00818 }It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
-Definition at line 649 of file modules.h. +Definition at line 798 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 654 of file modules.h. +Definition at line 803 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 650 of file modules.h. +Definition at line 799 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 653 of file modules.h. +Definition at line 802 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 Fri Mar 25 03:49:31 2005 for InspIRCd by +
Generated on Wed Apr 13 13:07:02 2005 for InspIRCd by1.3.3