Introduce ModeProcessFlags, can be passed to ModeParser::Process() to indicate local...

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

diff --git a/include/protocol.h b/include/protocol.h
index 7f987964f5ce6617715d0f9db1d0a54aff037b61..eedca50ecc228bc0d8574d1fad72190b1fefd09b 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -1,18 +1,24 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __PROTOCOL_H__
-#define __PROTOCOL_H__
+
+#pragma once
 
 #include "hashcomp.h"
 
@@ -44,8 +50,9 @@ class ProtocolInterface
         * @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.
+        * @return True if the message was sent out (target exists)
         */
-       virtual void SendEncapsulatedData(parameterlist &encap) { }
+       virtual bool SendEncapsulatedData(const parameterlist &encap) { return false; }
 
        /** Send metadata for an object to other linked servers.
         * @param target The object to send metadata for.
@@ -61,26 +68,13 @@ class ProtocolInterface
        virtual void SendTopic(Channel* channel, std::string &topic) { }
 
        /** Send mode changes for an object.
-        * @param target The channel name or user to send mode changes for.
-        * @param The mode changes to send.
+        * @param source The source of the mode change
+        * @param usertarget The target user, NULL if the target is a channel
+        * @param chantarget The target channel, NULL if the target is a user
+        * @param modedata The mode changes to send.
+        * @param translate A list of translation types
         */
-       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);
-       }
+       virtual void SendMode(User* source, User* usertarget, Channel* chantarget, const parameterlist& modedata, const std::vector<TranslateType>& translate) { }
 
        /** Send a notice to users with a given snomask.
         * @param snomask The snomask required for the message to be sent.
@@ -126,6 +120,3 @@ class ProtocolInterface
         */
        virtual void GetServerList(ProtoServerList &sl) { }
 };
-
-#endif
-