Fix a bunch of really obvious unnecessary includes.

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

diff --git a/include/protocol.h b/include/protocol.h
index 2b1ffb7536a6f67543b3e41992ab2d6ec241e21f..f69acde0b2b0b6b675844c6cb0121f9485b56413 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -1,8 +1,12 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2018 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2013-2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2018-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
  *
  * 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
@@ -20,12 +24,8 @@
 
 #pragma once
 
-#include "hashcomp.h"
-
 class User;
 
-typedef std::vector<std::string> parameterlist;
-
 class ProtocolServer
 {
  public:
@@ -46,7 +46,7 @@ class CoreExport ProtocolInterface
         public:
                std::string servername;
                std::string parentname;
-               std::string gecos;
+               std::string description;
                unsigned int usercount;
                unsigned int opercount;
                unsigned int latencyms;
@@ -60,23 +60,23 @@ class CoreExport ProtocolInterface
         * See the protocol documentation for the purpose of ENCAP.
         * @param targetmask The target server mask (can contain wildcards)
         * @param cmd The ENCAP subcommand
-        * @param params List of string parameters which are dependant on the subcommand
+        * @param params List of string parameters which are dependent on the subcommand
         * @param source The source of the message (prefix), must be a local user or NULL which means use local server
         * @return Always true if the target mask contains wildcards; otherwise true if the server name was found,
         * and the message was sent, false if it was not found.
         * ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
         */
-       virtual bool SendEncapsulatedData(const std::string& targetmask, const std::string& cmd, const parameterlist& params, User* source = NULL) { return false; }
+       virtual bool SendEncapsulatedData(const std::string& targetmask, const std::string& cmd, const CommandBase::Params& params, User* source = NULL) { return false; }
 
        /** Send an ENCAP message to all servers.
         * See the protocol documentation for the purpose of ENCAP.
         * @param cmd The ENCAP subcommand
-        * @param params List of string parameters which are dependant on the subcommand
+        * @param params List of string parameters which are dependent on the subcommand
         * @param source The source of the message (prefix), must be a local user or a user behind 'omit'
         * or NULL which is equivalent to the local server
         * @param omit If non-NULL the message won't be sent in the direction of this server, useful for forwarding messages
         */
-       virtual void BroadcastEncap(const std::string& cmd, const parameterlist& params, User* source = NULL, User* omit = NULL) { }
+       virtual void BroadcastEncap(const std::string& cmd, const CommandBase::Params& params, User* source = NULL, User* omit = NULL) { }
 
        /** Send metadata for a channel to other linked servers.
         * @param chan The channel to send metadata for
@@ -98,27 +98,15 @@ class CoreExport ProtocolInterface
         */
        virtual void SendMetaData(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) { }
-
        /** 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(char 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 status The status character (e.g. %) required to receive.
         * @param text The message to send.
         * @param type The message type (MSG_PRIVMSG or MSG_NOTICE)
         */
@@ -133,10 +121,10 @@ class CoreExport ProtocolInterface
 
        /** Send a notice to a channel.
         * @param target The channel to message.
-        * @param status The status character (e.g. %) required to recieve.
+        * @param status The status character (e.g. %) required to receive.
         * @param text The message to send.
         */
-       void SendChannelNotice(Channel* target, char status, const std::string &text)
+       DEPRECATED_METHOD(void SendChannelNotice(Channel* target, char status, const std::string& text))
        {
                SendMessage(target, status, text, MSG_NOTICE);
        }
@@ -145,7 +133,7 @@ class CoreExport ProtocolInterface
         * @param target The user to message.
         * @param text The message to send.
         */
-       void SendUserNotice(User* target, const std::string &text)
+       DEPRECATED_METHOD(void SendUserNotice(User* target, const std::string& text))
        {
                SendMessage(target, text, MSG_NOTICE);
        }