---

modules.h

Go to the documentation of this file.

/*

$Log$
Revision 1.2  2003/01/23 20:38:00  brain
Updated documentation scripts

Revision 1.1.1.1  2003/01/23 19:45:58  brain
InspIRCd second source tree

Revision 1.12  2003/01/22 20:59:10  brain
Added FileReader class documentation

Revision 1.11  2003/01/22 20:49:16  brain
Added FileReader file-caching class
Changed m_randquote to use FileReader class

Revision 1.10  2003/01/22 00:57:27  brain
Changes to documentation

Revision 1.9  2003/01/22 00:44:26  brain
Added documentation comments

Revision 1.8  2003/01/21 20:31:24  brain
Modified to add documentation
Added ConfigReader class for modules

Revision 1.7  2003/01/15 22:47:44  brain
Changed user and channel structs to classes (finally)

Revision 1.6  2003/01/13 22:30:50  brain
Added Admin class (holds /admin info for modules)
Added methods to Server class


*/


#ifndef __PLUGIN_H
#define __PLUGIN_H

#include "dynamic.h"
#include <string>
#include <deque>

typedef deque<string> file_cache;


// This #define allows us to call a method in all
// loaded modules in a readable simple way, e.g.:
// 'FOREACH_MOD OnConnect(user);'

#define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->

// class Version holds the version information of a Module, returned
// by Module::GetVersion (thanks RD)

class Version
{
 public:
         const int Major, Minor, Revision, Build;
         Version(int major, int minor, int revision, int build);
};


class Admin
{
 public:
         const string Name, Email, Nick;
         Admin(string name,string email,string nick);
};

class Module
{
 public:
        Module();
        virtual ~Module();
        virtual Version GetVersion();
        virtual void OnUserConnect(userrec* user);
        virtual void OnUserQuit(userrec* user);
        virtual void OnUserJoin(userrec* user, chanrec* channel);
        virtual void OnUserPart(userrec* user, chanrec* channel);
};


class Server
{
 public:
        Server();
        virtual ~Server();

        virtual void SendOpers(string s);
        virtual void Debug(string s);
        virtual void Send(int Socket, string s);
        virtual void SendServ(int Socket, string s);
        virtual void SendFrom(int Socket, userrec* User, string s);
        virtual void SendTo(userrec* Source, userrec* Dest, string s);
        virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
        virtual bool CommonChannels(userrec* u1, userrec* u2);
        virtual void SendCommon(userrec* User, string text,bool IncludeSender);
        virtual void SendWallops(userrec* User, string text);

        virtual bool IsNick(string nick);
        virtual userrec* FindNick(string nick);
        virtual chanrec* FindChannel(string channel);
        virtual string ChanMode(userrec* User, chanrec* Chan);
        virtual string GetServerName();
        virtual string GetNetworkName();
        virtual Admin GetAdmin();
         
};

class ConfigReader
{
  protected:
        string fname;
  public:
        ConfigReader();                 // default constructor reads ircd.conf
        ConfigReader(string filename);  // read a module-specific config
        ~ConfigReader();
        string ReadValue(string tag, string name, int index);
        int Enumerate(string tag);
        bool Verify();
};



class FileReader
{
 file_cache fc;
 public:
         FileReader();
         FileReader(string filename);
         ~FileReader();
         void LoadFile(string filename);
         string GetLine(int x);
         int FileSize();
};


class ModuleFactory
{
 public:
        ModuleFactory() { }
        virtual ~ModuleFactory() { }
        virtual Module * CreateModule() = 0;
};

#endif

---