docs/module-doc/modules_8cpp-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>modules.cpp Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc2 -->
   7 <center>
   8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
   9 <hr><h1>modules.cpp</h1><a href="modules_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
  10 00002 <span class="comment"></span>
  11 00003 <span class="comment">$Log$
  12 00003 <span class="comment">Revision 1.1  2003/01/23 19:45:58  brain
  13 00003 <span class="comment">Initial revision
  14 00003 <span class="comment">
  15 00003 <span class="comment">Revision 1.9  2003/01/22 20:59:12  brain
  16 00003 <span class="comment">Added FileReader class documentation
  17 00003 <span class="comment"></span>
  18 00004 <span class="comment">Revision 1.7  2003/01/22 20:49:16  brain</span>
  19 00005 <span class="comment">Added FileReader file-caching class</span>
  20 00006 <span class="comment">Changed m_randquote to use FileReader class</span>
  21 00007 <span class="comment"></span>
  22 00008 <span class="comment">Revision 1.6  2003/01/21 20:31:24  brain</span>
  23 00009 <span class="comment">Modified to add documentation</span>
  24 00010 <span class="comment">Added ConfigReader class for modules</span>
  25 00011 <span class="comment"></span>
  26 00012 <span class="comment">Revision 1.5  2003/01/13 22:30:50  brain</span>
  27 00013 <span class="comment">Added Admin class (holds /admin info for modules)</span>
  28 00014 <span class="comment">Added methods to Server class</span>
  29 00015 <span class="comment"></span>
  30 00016 <span class="comment"></span>
  31 00017 <span class="comment">*/</span>
  32 00018
  33 00019
  34 00020
  35 00021 <span class="preprocessor">#include &lt;typeinfo&gt;</span>
  36 00022 <span class="preprocessor">#include &lt;iostream.h&gt;</span>
  37 00023 <span class="preprocessor">#include "globals.h"</span>
  38 00024 <span class="preprocessor">#include "<a class="code" href="modules_8h.html">modules.h</a>"</span>
  39 00025 <span class="preprocessor">#include "inspircd_io.h"</span>
  40 00026
  41 00027 <span class="comment">// version is a simple class for holding a modules version number</span>
  42 00028
  43 <a name="l00029"></a><a class="code" href="classVersion.html#a0">00029</a> <a class="code" href="classVersion.html#a0">Version::Version</a>(<span class="keywordtype">int</span> major, <span class="keywordtype">int</span> minor, <span class="keywordtype">int</span> revision, <span class="keywordtype">int</span> build) : Major(major), Minor(minor), Revision(revision), Build(build) { };
  44 00030
  45 00031 <span class="comment">// admin is a simple class for holding a server's administrative info</span>
  46 00032
  47 <a name="l00033"></a><a class="code" href="classAdmin.html#a0">00033</a> <a class="code" href="classAdmin.html#a0">Admin::Admin</a>(string name, string email, string nick) : Name(name), Email(email), Nick(nick) { };
  48 00034
  49 00035 <span class="comment">//</span>
  50 00036 <span class="comment">// Announce to the world that the Module base</span>
  51 00037 <span class="comment">// class has been created or destroyed</span>
  52 00038 <span class="comment">//</span>
  53 00039
  54 <a name="l00040"></a><a class="code" href="classModule.html#a0">00040</a> <a class="code" href="classModule.html#a0">Module::Module</a>() { }
  55 <a name="l00041"></a><a class="code" href="classModule.html#a1">00041</a> <a class="code" href="classModule.html#a1">Module::~Module</a>() { }
  56 <a name="l00042"></a><a class="code" href="classModule.html#a3">00042</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a3">Module::OnUserConnect</a>(<a class="code" href="classuserrec.html">userrec</a>* user) { }
  57 <a name="l00043"></a><a class="code" href="classModule.html#a4">00043</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a4">Module::OnUserQuit</a>(<a class="code" href="classuserrec.html">userrec</a>* user) { }
  58 <a name="l00044"></a><a class="code" href="classModule.html#a5">00044</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a5">Module::OnUserJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel) { }
  59 <a name="l00045"></a><a class="code" href="classModule.html#a6">00045</a> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a6">Module::OnUserPart</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel) { }
  60 <a name="l00046"></a><a class="code" href="classModule.html#a2">00046</a> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">Module::GetVersion</a>() { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
  61 00047
  62 00048 <span class="comment">// server is a wrapper class that provides methods to all of the C-style</span>
  63 00049 <span class="comment">// exports in the core</span>
  64 00050 <span class="comment">//</span>
  65 00051
  66 <a name="l00052"></a><a class="code" href="classServer.html#a0">00052</a> <a class="code" href="classServer.html#a0">Server::Server</a>()
  67 00053 {
  68 00054 }
  69 00055
  70 <a name="l00056"></a><a class="code" href="classServer.html#a1">00056</a> <a class="code" href="classServer.html#a1">Server::~Server</a>()
  71 00057 {
  72 00058 }
  73 00059
  74 <a name="l00060"></a><a class="code" href="classServer.html#a2">00060</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">Server::SendOpers</a>(string s)
  75 00061 {
  76 00062         WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
  77 00063 }
  78 00064
  79 <a name="l00065"></a><a class="code" href="classServer.html#a3">00065</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Server::Debug</a>(string s)
  80 00066 {
  81 00067         debug(<span class="stringliteral">"%s"</span>,s.c_str());
  82 00068 }
  83 00069
  84 <a name="l00070"></a><a class="code" href="classServer.html#a4">00070</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a4">Server::Send</a>(<span class="keywordtype">int</span> Socket, string s)
  85 00071 {
  86 00072         Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
  87 00073 }
  88 00074
  89 <a name="l00075"></a><a class="code" href="classServer.html#a5">00075</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a5">Server::SendServ</a>(<span class="keywordtype">int</span> Socket, string s)
  90 00076 {
  91 00077         WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
  92 00078 }
  93 00079
  94 <a name="l00080"></a><a class="code" href="classServer.html#a6">00080</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a6">Server::SendFrom</a>(<span class="keywordtype">int</span> Socket, <a class="code" href="classuserrec.html">userrec</a>* User, string s)
  95 00081 {
  96 00082         WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
  97 00083 }
  98 00084
  99 <a name="l00085"></a><a class="code" href="classServer.html#a7">00085</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a7">Server::SendTo</a>(<a class="code" href="classuserrec.html">userrec</a>* Source, <a class="code" href="classuserrec.html">userrec</a>* Dest, string s)
 100 00086 {
 101 00087         WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
 102 00088 }
 103 00089
 104 <a name="l00090"></a><a class="code" href="classServer.html#a8">00090</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a8">Server::SendChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Channel, string s,<span class="keywordtype">bool</span> IncludeSender)
 105 00091 {
 106 00092         <span class="keywordflow">if</span> (IncludeSender)
 107 00093         {
 108 00094                 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
 109 00095         }
 110 00096         <span class="keywordflow">else</span>
 111 00097         {
 112 00098                 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
 113 00099         }
 114 00100 }
 115 00101
 116 <a name="l00102"></a><a class="code" href="classServer.html#a9">00102</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a9">Server::CommonChannels</a>(<a class="code" href="classuserrec.html">userrec</a>* u1, <a class="code" href="classuserrec.html">userrec</a>* u2)
 117 00103 {
 118 00104         <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
 119 00105 }
 120 00106
 121 <a name="l00107"></a><a class="code" href="classServer.html#a10">00107</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a10">Server::SendCommon</a>(<a class="code" href="classuserrec.html">userrec</a>* User, string text,<span class="keywordtype">bool</span> IncludeSender)
 122 00108 {
 123 00109         <span class="keywordflow">if</span> (IncludeSender)
 124 00110         {
 125 00111                 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
 126 00112         }
 127 00113         <span class="keywordflow">else</span>
 128 00114         {
 129 00115                 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
 130 00116         }
 131 00117 }
 132 00118
 133 <a name="l00119"></a><a class="code" href="classServer.html#a11">00119</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a11">Server::SendWallops</a>(<a class="code" href="classuserrec.html">userrec</a>* User, string text)
 134 00120 {
 135 00121         WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
 136 00122 }
 137 00123
 138 <a name="l00124"></a><a class="code" href="classServer.html#a12">00124</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">Server::IsNick</a>(string nick)
 139 00125 {
 140 00126         <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
 141 00127 }
 142 00128
 143 <a name="l00129"></a><a class="code" href="classServer.html#a13">00129</a> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">Server::FindNick</a>(string nick)
 144 00130 {
 145 00131         <span class="keywordflow">return</span> Find(nick);
 146 00132 }
 147 00133
 148 <a name="l00134"></a><a class="code" href="classServer.html#a14">00134</a> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">Server::FindChannel</a>(string channel)
 149 00135 {
 150 00136         <span class="keywordflow">return</span> FindChan(channel.c_str());
 151 00137 }
 152 00138
 153 <a name="l00139"></a><a class="code" href="classServer.html#a15">00139</a> string <a class="code" href="classServer.html#a15">Server::ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan)
 154 00140 {
 155 00141         string mode = cmode(User,Chan);
 156 00142         <span class="keywordflow">return</span> mode;
 157 00143 }
 158 00144
 159 <a name="l00145"></a><a class="code" href="classServer.html#a16">00145</a> string <a class="code" href="classServer.html#a16">Server::GetServerName</a>()
 160 00146 {
 161 00147         <span class="keywordflow">return</span> getservername();
 162 00148 }
 163 00149
 164 <a name="l00150"></a><a class="code" href="classServer.html#a17">00150</a> string <a class="code" href="classServer.html#a17">Server::GetNetworkName</a>()
 165 00151 {
 166 00152         <span class="keywordflow">return</span> getnetworkname();
 167 00153 }
 168 00154
 169 <a name="l00155"></a><a class="code" href="classServer.html#a18">00155</a> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">Server::GetAdmin</a>()
 170 00156 {
 171 00157         <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
 172 00158 }
 173 00159
 174 00160
 175 <a name="l00161"></a><a class="code" href="classConfigReader.html#a0">00161</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>()
 176 00162 {
 177 00163         <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
 178 00164 }
 179 00165
 180 00166
 181 <a name="l00167"></a><a class="code" href="classConfigReader.html#a2">00167</a> <a class="code" href="classConfigReader.html#a2">ConfigReader::~ConfigReader</a>()
 182 00168 {
 183 00169 }
 184 00170
 185 00171
 186 <a name="l00172"></a><a class="code" href="classConfigReader.html#a1">00172</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>(string filename) : fname(filename) { };
 187 00173
 188 <a name="l00174"></a><a class="code" href="classConfigReader.html#a3">00174</a> string <a class="code" href="classConfigReader.html#a3">ConfigReader::ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index)
 189 00175 {
 190 00176         <span class="keywordtype">char</span> val[MAXBUF];
 191 00177         ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
 192 00178         string s = val;
 193 00179         <span class="keywordflow">return</span> s;
 194 00180 }
 195 00181
 196 00182
 197 <a name="l00183"></a><a class="code" href="classConfigReader.html#a4">00183</a> <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">ConfigReader::Enumerate</a>(string tag)
 198 00184 {
 199 00185         <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
 200 00186 }
 201 00187
 202 00188
 203 <a name="l00189"></a><a class="code" href="classConfigReader.html#a5">00189</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">ConfigReader::Verify</a>()
 204 00190 {
 205 00191         <span class="keywordflow">return</span> <span class="keyword">true</span>;
 206 00192 }
 207 00193
 208 00194
 209 <a name="l00195"></a><a class="code" href="classFileReader.html#a1">00195</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>(string filename)
 210 00196 {
 211 00197         <a class="code" href="modules_8h.html#a1">file_cache</a> c;
 212 00198         readfile(c,filename.c_str());
 213 00199         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
 214 00200 }
 215 00201
 216 <a name="l00202"></a><a class="code" href="classFileReader.html#a0">00202</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>()
 217 00203 {
 218 00204 }
 219 00205
 220 <a name="l00206"></a><a class="code" href="classFileReader.html#a3">00206</a> <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">FileReader::LoadFile</a>(string filename)
 221 00207 {
 222 00208         <a class="code" href="modules_8h.html#a1">file_cache</a> c;
 223 00209         readfile(c,filename.c_str());
 224 00210         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
 225 00211 }
 226 00212
 227 <a name="l00213"></a><a class="code" href="classFileReader.html#a2">00213</a> <a class="code" href="classFileReader.html#a2">FileReader::~FileReader</a>()
 228 00214 {
 229 00215 }
 230 00216
 231 <a name="l00217"></a><a class="code" href="classFileReader.html#a4">00217</a> string <a class="code" href="classFileReader.html#a4">FileReader::GetLine</a>(<span class="keywordtype">int</span> x)
 232 00218 {
 233 00219         <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
 234 00220                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
 235 00221         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
 236 00222 }
 237 00223
 238 <a name="l00224"></a><a class="code" href="classFileReader.html#a5">00224</a> <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileReader::FileSize</a>()
 239 00225 {
 240 00226         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
 241 00227 }
 242 00228
 243 00229
 244 </pre></div><hr><address style="align: right;"><small>Generated on Wed Jan 22 20:56:47 2003 for InspIRCd by
 245 <a href="http://www.doxygen.org/index.html">
 246 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 247 width=110 height=53></a>1.3-rc2 </small></address>
 248 </body>
 249 </html>