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.2  2003/01/23 20:38:00  brain
  13 00003 <span class="comment">Updated documentation scripts
  14 00003 <span class="comment"></span>
  15 00004 <span class="comment">Revision 1.1.1.1  2003/01/23 19:45:58  brain</span>
  16 00005 <span class="comment">InspIRCd second source tree</span>
  17 00006 <span class="comment"></span>
  18 00007 <span class="comment">Revision 1.7  2003/01/22 20:49:16  brain</span>
  19 00008 <span class="comment">Added FileReader file-caching class</span>
  20 00009 <span class="comment">Changed m_randquote to use FileReader class</span>
  21 00010 <span class="comment"></span>
  22 00011 <span class="comment">Revision 1.6  2003/01/21 20:31:24  brain</span>
  23 00012 <span class="comment">Modified to add documentation</span>
  24 00013 <span class="comment">Added ConfigReader class for modules</span>
  25 00014 <span class="comment"></span>
  26 00015 <span class="comment">Revision 1.5  2003/01/13 22:30:50  brain</span>
  27 00016 <span class="comment">Added Admin class (holds /admin info for modules)</span>
  28 00017 <span class="comment">Added methods to Server class</span>
  29 00018 <span class="comment"></span>
  30 00019 <span class="comment"></span>
  31 00020 <span class="comment">*/</span>
  32 00021
  33 00022
  34 00023
  35 00024 <span class="preprocessor">#include &lt;typeinfo&gt;</span>
  36 00025 <span class="preprocessor">#include &lt;iostream.h&gt;</span>
  37 00026 <span class="preprocessor">#include "globals.h"</span>
  38 00027 <span class="preprocessor">#include "<a class="code" href="modules_8h.html">modules.h</a>"</span>
  39 00028 <span class="preprocessor">#include "inspircd_io.h"</span>
  40 00029
  41 00030 <span class="comment">// version is a simple class for holding a modules version number</span>
  42 00031
  43 <a name="l00032"></a><a class="code" href="classVersion.html#a0">00032</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 00033
  45 00034 <span class="comment">// admin is a simple class for holding a server's administrative info</span>
  46 00035
  47 <a name="l00036"></a><a class="code" href="classAdmin.html#a0">00036</a> <a class="code" href="classAdmin.html#a0">Admin::Admin</a>(string name, string email, string nick) : Name(name), Email(email), Nick(nick) { };
  48 00037
  49 00038 <span class="comment">//</span>
  50 00039 <span class="comment">// Announce to the world that the Module base</span>
  51 00040 <span class="comment">// class has been created or destroyed</span>
  52 00041 <span class="comment">//</span>
  53 00042
  54 <a name="l00043"></a><a class="code" href="classModule.html#a0">00043</a> <a class="code" href="classModule.html#a0">Module::Module</a>() { }
  55 <a name="l00044"></a><a class="code" href="classModule.html#a1">00044</a> <a class="code" href="classModule.html#a1">Module::~Module</a>() { }
  56 <a name="l00045"></a><a class="code" href="classModule.html#a3">00045</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="l00046"></a><a class="code" href="classModule.html#a4">00046</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="l00047"></a><a class="code" href="classModule.html#a5">00047</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="l00048"></a><a class="code" href="classModule.html#a6">00048</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="l00049"></a><a class="code" href="classModule.html#a2">00049</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 00050
  62 00051 <span class="comment">// server is a wrapper class that provides methods to all of the C-style</span>
  63 00052 <span class="comment">// exports in the core</span>
  64 00053 <span class="comment">//</span>
  65 00054
  66 <a name="l00055"></a><a class="code" href="classServer.html#a0">00055</a> <a class="code" href="classServer.html#a0">Server::Server</a>()
  67 00056 {
  68 00057 }
  69 00058
  70 <a name="l00059"></a><a class="code" href="classServer.html#a1">00059</a> <a class="code" href="classServer.html#a1">Server::~Server</a>()
  71 00060 {
  72 00061 }
  73 00062
  74 <a name="l00063"></a><a class="code" href="classServer.html#a2">00063</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">Server::SendOpers</a>(string s)
  75 00064 {
  76 00065         WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
  77 00066 }
  78 00067
  79 <a name="l00068"></a><a class="code" href="classServer.html#a3">00068</a> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Server::Debug</a>(string s)
  80 00069 {
  81 00070         debug(<span class="stringliteral">"%s"</span>,s.c_str());
  82 00071 }
  83 00072
  84 <a name="l00073"></a><a class="code" href="classServer.html#a4">00073</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 00074 {
  86 00075         Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
  87 00076 }
  88 00077
  89 <a name="l00078"></a><a class="code" href="classServer.html#a5">00078</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 00079 {
  91 00080         WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
  92 00081 }
  93 00082
  94 <a name="l00083"></a><a class="code" href="classServer.html#a6">00083</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 00084 {
  96 00085         WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
  97 00086 }
  98 00087
  99 <a name="l00088"></a><a class="code" href="classServer.html#a7">00088</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 00089 {
 101 00090         WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
 102 00091 }
 103 00092
 104 <a name="l00093"></a><a class="code" href="classServer.html#a8">00093</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 00094 {
 106 00095         <span class="keywordflow">if</span> (IncludeSender)
 107 00096         {
 108 00097                 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
 109 00098         }
 110 00099         <span class="keywordflow">else</span>
 111 00100         {
 112 00101                 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
 113 00102         }
 114 00103 }
 115 00104
 116 <a name="l00105"></a><a class="code" href="classServer.html#a9">00105</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 00106 {
 118 00107         <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
 119 00108 }
 120 00109
 121 <a name="l00110"></a><a class="code" href="classServer.html#a10">00110</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 00111 {
 123 00112         <span class="keywordflow">if</span> (IncludeSender)
 124 00113         {
 125 00114                 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
 126 00115         }
 127 00116         <span class="keywordflow">else</span>
 128 00117         {
 129 00118                 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
 130 00119         }
 131 00120 }
 132 00121
 133 <a name="l00122"></a><a class="code" href="classServer.html#a11">00122</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 00123 {
 135 00124         WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
 136 00125 }
 137 00126
 138 <a name="l00127"></a><a class="code" href="classServer.html#a12">00127</a> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">Server::IsNick</a>(string nick)
 139 00128 {
 140 00129         <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
 141 00130 }
 142 00131
 143 <a name="l00132"></a><a class="code" href="classServer.html#a13">00132</a> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">Server::FindNick</a>(string nick)
 144 00133 {
 145 00134         <span class="keywordflow">return</span> Find(nick);
 146 00135 }
 147 00136
 148 <a name="l00137"></a><a class="code" href="classServer.html#a14">00137</a> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">Server::FindChannel</a>(string channel)
 149 00138 {
 150 00139         <span class="keywordflow">return</span> FindChan(channel.c_str());
 151 00140 }
 152 00141
 153 <a name="l00142"></a><a class="code" href="classServer.html#a15">00142</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 00143 {
 155 00144         string mode = cmode(User,Chan);
 156 00145         <span class="keywordflow">return</span> mode;
 157 00146 }
 158 00147
 159 <a name="l00148"></a><a class="code" href="classServer.html#a16">00148</a> string <a class="code" href="classServer.html#a16">Server::GetServerName</a>()
 160 00149 {
 161 00150         <span class="keywordflow">return</span> getservername();
 162 00151 }
 163 00152
 164 <a name="l00153"></a><a class="code" href="classServer.html#a17">00153</a> string <a class="code" href="classServer.html#a17">Server::GetNetworkName</a>()
 165 00154 {
 166 00155         <span class="keywordflow">return</span> getnetworkname();
 167 00156 }
 168 00157
 169 <a name="l00158"></a><a class="code" href="classServer.html#a18">00158</a> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">Server::GetAdmin</a>()
 170 00159 {
 171 00160         <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
 172 00161 }
 173 00162
 174 00163
 175 <a name="l00164"></a><a class="code" href="classConfigReader.html#a0">00164</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>()
 176 00165 {
 177 00166         <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
 178 00167 }
 179 00168
 180 00169
 181 <a name="l00170"></a><a class="code" href="classConfigReader.html#a2">00170</a> <a class="code" href="classConfigReader.html#a2">ConfigReader::~ConfigReader</a>()
 182 00171 {
 183 00172 }
 184 00173
 185 00174
 186 <a name="l00175"></a><a class="code" href="classConfigReader.html#a1">00175</a> <a class="code" href="classConfigReader.html#a0">ConfigReader::ConfigReader</a>(string filename) : fname(filename) { };
 187 00176
 188 <a name="l00177"></a><a class="code" href="classConfigReader.html#a3">00177</a> string <a class="code" href="classConfigReader.html#a3">ConfigReader::ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index)
 189 00178 {
 190 00179         <span class="keywordtype">char</span> val[MAXBUF];
 191 00180         ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
 192 00181         string s = val;
 193 00182         <span class="keywordflow">return</span> s;
 194 00183 }
 195 00184
 196 00185
 197 <a name="l00186"></a><a class="code" href="classConfigReader.html#a4">00186</a> <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">ConfigReader::Enumerate</a>(string tag)
 198 00187 {
 199 00188         <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
 200 00189 }
 201 00190
 202 00191
 203 <a name="l00192"></a><a class="code" href="classConfigReader.html#a5">00192</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">ConfigReader::Verify</a>()
 204 00193 {
 205 00194         <span class="keywordflow">return</span> <span class="keyword">true</span>;
 206 00195 }
 207 00196
 208 00197
 209 <a name="l00198"></a><a class="code" href="classFileReader.html#a1">00198</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>(string filename)
 210 00199 {
 211 00200         <a class="code" href="modules_8h.html#a1">file_cache</a> c;
 212 00201         readfile(c,filename.c_str());
 213 00202         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
 214 00203 }
 215 00204
 216 <a name="l00205"></a><a class="code" href="classFileReader.html#a0">00205</a> <a class="code" href="classFileReader.html#a0">FileReader::FileReader</a>()
 217 00206 {
 218 00207 }
 219 00208
 220 <a name="l00209"></a><a class="code" href="classFileReader.html#a3">00209</a> <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">FileReader::LoadFile</a>(string filename)
 221 00210 {
 222 00211         <a class="code" href="modules_8h.html#a1">file_cache</a> c;
 223 00212         readfile(c,filename.c_str());
 224 00213         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
 225 00214 }
 226 00215
 227 <a name="l00216"></a><a class="code" href="classFileReader.html#a2">00216</a> <a class="code" href="classFileReader.html#a2">FileReader::~FileReader</a>()
 228 00217 {
 229 00218 }
 230 00219
 231 <a name="l00220"></a><a class="code" href="classFileReader.html#a4">00220</a> string <a class="code" href="classFileReader.html#a4">FileReader::GetLine</a>(<span class="keywordtype">int</span> x)
 232 00221 {
 233 00222         <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
 234 00223                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
 235 00224         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
 236 00225 }
 237 00226
 238 <a name="l00227"></a><a class="code" href="classFileReader.html#a5">00227</a> <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileReader::FileSize</a>()
 239 00228 {
 240 00229         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
 241 00230 }
 242 00231
 243 00232
 244 </pre></div><hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:57 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>