Implement IRCv3 tag parsing and sending

[quassel.git] / src / common / ircdecoder.h

diff --git a/src/common/ircdecoder.h b/src/common/ircdecoder.h
new file mode 100644 (file)
index 0000000..e4515ec
--- /dev/null
+++ b/src/common/ircdecoder.h
@@ -0,0 +1,81 @@
+/***************************************************************************
+ *   Copyright (C) 2005-2019 by the Quassel Project                        *
+ *   devel@quassel-irc.org                                                 *
+ *                                                                         *
+ *   This program 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; either version 2 of the License, or     *
+ *   (at your option) version 3.                                           *
+ *                                                                         *
+ *   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, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
+ ***************************************************************************/
+
+#pragma once
+
+#include "common-export.h"
+
+#include <functional>
+
+#include "irctag.h"
+
+class COMMON_EXPORT IrcDecoder
+{
+public:
+    /**
+     * Parses an IRC message
+     * @param decode Decoder to be used for decoding the message
+     * @param rawMsg Raw Message
+     * @param tags[out] Parsed map of IRCv3 message tags
+     * @param prefix[out] Parsed prefix
+     * @param command[out] Parsed command
+     * @param parameters[out] Parsed list of parameters
+     */
+    static void parseMessage(const std::function<QString(const QByteArray&)>& decode, const QByteArray& raw, QHash<IrcTagKey, QString>& tags, QString& prefix, QString& command, QList<QByteArray>& parameters);
+private:
+    /**
+     * Parses an encoded IRCv3 message tag value
+     * @param value encoded IRCv3 message tag value
+     * @return decoded string
+     */
+    static QString parseTagValue(const QString& value);
+    /**
+     * Parses IRCv3 message tags given a message
+     * @param net Decoder to be used for decoding the message
+     * @param raw Raw Message
+     * @param start Current index into the message, will be advanced automatically
+     * @return Parsed message tags
+     */
+    static QHash<IrcTagKey, QString> parseTags(const std::function<QString(const QByteArray&)>& decode, const QByteArray& raw, int& start);
+    /**
+     * Parses an IRC prefix, if available
+     * @param net Decoder to be used for decoding the message
+     * @param raw Raw Message
+     * @param start Current index into the message, will be advanced automatically
+     * @return Parsed prefix or empty string
+     */
+    static QString parsePrefix(const std::function<QString(const QByteArray&)>& decode, const QByteArray& raw, int& start);
+    /**
+     * Parses an IRC named command or numeric RPL
+     * @param net Decoder to be used for decoding the message
+     * @param raw Raw Message
+     * @param start Current index into the message, will be advanced automatically
+     * @return Parsed command
+     */
+    static QString parseCommand(const std::function<QString(const QByteArray&)>& decode, const QByteArray& raw, int& start);
+    /**
+     * Parses an IRC parameter
+     * @param net Decoder to be used for decoding the message
+     * @param raw Raw Message
+     * @param start Current index into the message, will be advanced automatically
+     * @return Parsed parameter
+     */
+    static QByteArray parseParameter(const QByteArray& raw, int& start);
+};