Remove more classbase

[user/henk/code/inspircd.git] / include / protocol.h

diff --git a/include/protocol.h b/include/protocol.h
index 21e6b53965b8b2fe4449efdcae0bce6ac6299eca..ed53c3cbbd2bca6efe1ab8b9e9b779f3dccfa6f3 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
@@ -14,26 +14,123 @@
 #ifndef __PROTOCOL_H__
 #define __PROTOCOL_H__
 
-class InspIRCd;
+#include "hashcomp.h"
 
-typedef std::deque<std::string> parameterlist;
+class User;
 
-class ProtocolInterface : public Extensible
+typedef std::vector<std::string> parameterlist;
+
+class ProtoServer
 {
- protected:
-       InspIRCd* ServerInstance;
  public:
-       ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
+       std::string servername;
+       std::string parentname;
+       std::string gecos;
+       unsigned int usercount;
+       unsigned int opercount;
+       unsigned int latencyms;
+};
+
+typedef std::list<ProtoServer> ProtoServerList;
+
+class ProtocolInterface
+{
+ public:
+       ProtocolInterface() { }
        virtual ~ProtocolInterface() { }
 
+       /** Send an ENCAP message to one or more linked servers.
+        * See the protocol documentation for the purpose of ENCAP.
+        * @param encap This is a list of string parameters, the first of which must be a server ID or glob matching servernames.
+        * The second must be a subcommand. All subsequent parameters are dependant on the subcommand.
+        * ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
+        */
        virtual void SendEncapsulatedData(parameterlist &encap) { }
-       virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { }
+
+       /** Send metadata for an object to other linked servers.
+        * @param target The object to send metadata for.
+        * @param key The 'key' of the data, e.g. "swhois" for swhois desc on a user
+        * @param data The string representation of the data
+        */
+       virtual void SendMetaData(Extensible* target, const std::string &key, const std::string &data) { }
+
+       /** Send a topic change for a channel
+        * @param channel The channel to change the topic for.
+        * @param topic The new topic to use for the channel.
+        */
        virtual void SendTopic(Channel* channel, std::string &topic) { }
-       virtual void SendMode(const std::string &target, parameterlist &modedata) { }
-       virtual void SendOperNotice(const std::string &text) { }
+
+       /** Send mode changes for an object.
+        * @param target The channel name or user to send mode changes for.
+        * @param The mode changes to send.
+        */
+       virtual void SendMode(const std::string &target, const parameterlist &modedata, const std::vector<TranslateType> &translate) { }
+
+       /** Convenience function, string wrapper around the above.
+         */
+       virtual void SendModeStr(const std::string &target, const std::string &modeline)
+       {
+               irc::spacesepstream x(modeline);
+               parameterlist n;
+               std::vector<TranslateType> types;
+               std::string v;
+               while (x.GetToken(v))
+               {
+                       n.push_back(v);
+                       types.push_back(TR_TEXT);
+               }
+               SendMode(target, n, types);
+       }
+
+       /** Send a notice to users with a given mode(s).
+        * @param modes The modes required for the message to be sent.
+        * @param text The message to send.
+        */
        virtual void SendModeNotice(const std::string &modes, const std::string &text) { }
+
+       /** Send a notice to users with a given snomask.
+        * @param snomask The snomask required for the message to be sent.
+        * @param text The message to send.
+        */
        virtual void SendSNONotice(const std::string &snomask, const std::string &text) { }
+
+       /** Send raw data to a remote client.
+        * @param target The user to push data to.
+        * @param rawline The raw IRC protocol line to deliver (":me NOTICE you :foo", whatever).
+        */
        virtual void PushToClient(User* target, const std::string &rawline) { }
+
+       /** Send a message to a channel.
+        * @param target The channel to message.
+        * @param status The status character (e.g. %) required to recieve.
+        * @param text The message to send.
+        */
+       virtual void SendChannelPrivmsg(Channel* target, char status, const std::string &text) { }
+
+       /** Send a notice to a channel.
+        * @param target The channel to message.
+        * @param status The status character (e.g. %) required to recieve.
+        * @param text The message to send.
+        */
+       virtual void SendChannelNotice(Channel* target, char status, const std::string &text) { }
+
+       /** Send a message to a user.
+        * @param target The user to message.
+        * @param text The message to send.
+        */
+       virtual void SendUserPrivmsg(User* target, const std::string &text) { }
+
+       /** Send a notice to a user.
+        * @param target The user to message.
+        * @param text The message to send.
+        */
+       virtual void SendUserNotice(User* target, const std::string &text) { }
+
+       /** Fill a list of servers and information about them.
+        * @param sl The list of servers to fill.
+        * XXX: document me properly, this is shit.
+        */
+       virtual void GetServerList(ProtoServerList &sl) { }
 };
 
 #endif