From 0f2cf28d39404881b9719330ca86757c51b87bad Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 1 May 2004 19:58:59 +0000 Subject: Added documentation of new ConfigReader methods suggested by Azhrarn for sanity git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@772 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 127 ++++++++++++++++++--------------- 1 file changed, 68 insertions(+), 59 deletions(-) (limited to 'docs/module-doc/modules_8h-source.html') diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html index 6868c47b5..bb6affe99 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -53,10 +53,10 @@ 00045 #include <deque> 00046 #include <sstream> 00047 -00050 typedef std::deque<std::string> file_cache; -00051 typedef file_cache string_list; +00050 typedef std::deque<std::string> file_cache; +00051 typedef file_cache string_list; 00052 -00055 typedef std::deque<userrec*> chanuserlist; +00055 typedef std::deque<userrec*> chanuserlist; 00056 00057 00058 // This #define allows us to call a method in all @@ -83,8 +83,8 @@ 00079 00080 // ********************************************************************************************* 00081 -00082 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams); -00083 extern void server_mode(char **parameters, int pcnt, userrec *user); +00082 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams); +00083 extern void server_mode(char **parameters, int pcnt, userrec *user); 00084 00085 // class Version holds the version information of a Module, returned 00086 // by Module::GetVersion (thanks RD) @@ -147,9 +147,9 @@ 00267 virtual int OnUserPreNick(userrec* user, std::string newnick); 00268 00291 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type); -00297 virtual string_list OnUserSync(userrec* user); +00297 virtual string_list OnUserSync(userrec* user); 00298 -00304 virtual string_list OnChannelSync(chanrec* chan); +00304 virtual string_list OnChannelSync(chanrec* chan); 00305 }; 00306 00307 @@ -207,62 +207,71 @@ 00588 00597 virtual bool IsUlined(std::string server); 00598 -00602 virtual chanuserlist GetUsers(chanrec* chan); +00602 virtual chanuserlist GetUsers(chanrec* chan); 00603 00604 }; 00605 -00612 class ConfigReader : public classbase -00613 { -00614 protected: -00620 std::stringstream *cache; -00623 bool error; -00624 -00625 public: -00630 ConfigReader(); // default constructor reads ircd.conf -00634 ConfigReader(std::string filename); // read a module-specific config -00638 ~ConfigReader(); -00643 std::string ReadValue(std::string tag, std::string name, int index); -00650 int Enumerate(std::string tag); -00655 bool Verify(); -00656 -00662 int EnumerateValues(std::string tag, int index); -00663 }; -00664 -00665 -00666 -00672 class FileReader : public classbase -00673 { -00674 file_cache fc; -00675 public: -00680 FileReader(); -00681 -00687 FileReader(std::string filename); -00688 -00692 ~FileReader(); -00693 -00699 void LoadFile(std::string filename); -00700 -00704 bool Exists(); -00705 -00710 std::string GetLine(int x); -00711 -00717 int FileSize(); -00718 }; +00606 #define CONF_NOT_A_NUMBER 0x000010 +00607 #define CONF_NOT_UNSIGNED 0x000080 +00608 #define CONF_VALUE_NOT_FOUND 0x000100 +00609 #define CONF_FILE_NOT_FOUND 0x000200 +00610 +00617 class ConfigReader : public classbase +00618 { +00619 protected: +00625 std::stringstream *cache; +00628 bool readerror; +00629 long error; +00630 +00631 public: +00636 ConfigReader(); // default constructor reads ircd.conf +00640 ConfigReader(std::string filename); // read a module-specific config +00644 ~ConfigReader(); +00649 std::string ReadValue(std::string tag, std::string name, int index); +00655 bool ReadFlag(std::string tag, std::string name, int index); +00664 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); +00669 long GetError(); +00676 int Enumerate(std::string tag); +00681 bool Verify(); +00682 +00688 int EnumerateValues(std::string tag, int index); +00689 }; +00690 +00691 +00692 +00698 class FileReader : public classbase +00699 { +00700 file_cache fc; +00701 public: +00706 FileReader(); +00707 +00713 FileReader(std::string filename); +00714 +00718 ~FileReader(); 00719 -00720 -00727 class ModuleFactory : public classbase -00728 { -00729 public: -00730 ModuleFactory() { } -00731 virtual ~ModuleFactory() { } -00736 virtual Module * CreateModule() = 0; -00737 }; -00738 -00739 -00740 typedef DLLFactory<ModuleFactory> ircd_module; -00741 -00742 #endif -
Generated on Sat May 1 17:50:07 2004 for InspIRCd by +00725 void LoadFile(std::string filename); +00726 +00730 bool Exists(); +00731 +00736 std::string GetLine(int x); +00737 +00743 int FileSize(); +00744 }; +00745 +00746 +00753 class ModuleFactory : public classbase +00754 { +00755 public: +00756 ModuleFactory() { } +00757 virtual ~ModuleFactory() { } +00762 virtual Module * CreateModule() = 0; +00763 }; +00764 +00765 +00766 typedef DLLFactory<ModuleFactory> ircd_module; +00767 +00768 #endif +
Generated on Sat May 1 20:57:47 2004 for InspIRCd by doxygen1.3-rc3
-- cgit v1.2.3