Implement IRCv3 tag parsing and sending

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

diff --git a/src/common/ircencoder.h b/src/common/ircencoder.h
new file mode 100644 (file)
index 0000000..68fc46c
--- /dev/null
+++ b/src/common/ircencoder.h
@@ -0,0 +1,75 @@
+/***************************************************************************
+ *   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 <QByteArray>
+
+#include "irctag.h"
+
+class COMMON_EXPORT IrcEncoder
+{
+public:
+    /**
+     * Writes an IRC message
+     * @param tags Map of IRCv3 message tags
+     * @param prefix Prefix/Source of the message (should be empty)
+     * @param cmd
+     * @param params
+     * @return
+     */
+    static QByteArray writeMessage(const QHash<IrcTagKey, QString>& tags,
+                                   const QByteArray& prefix,
+                                   const QString& cmd,
+                                   const QList<QByteArray>& params);
+private:
+    /**
+     * Encodes a string as IRCv3 message tag value and appends it to the message
+     * @param msg message buffer to append to
+     * @param value unencoded tag value
+     */
+    static void writeTagValue(QByteArray& msg, const QString& value);
+    /**
+     * Writes IRCv3 message tags to the message buffer
+     * @param msg message buffer to append to
+     * @param tags map of IRCv3 message tags
+     */
+    static void writeTags(QByteArray& msg, const QHash<IrcTagKey, QString>& tags);
+    /**
+     * Writes the prefix/source to the message buffer
+     * @param msg message buffer to append to
+     * @param prefix prefix/source
+     */
+    static void writePrefix(QByteArray& msg, const QByteArray& prefix);
+    /**
+     * Writes the command/verb to the message buffer
+     * @param msg message buffer to append to
+     * @param cmd command/verb
+     */
+    static void writeCommand(QByteArray& msg, const QString& cmd);
+    /**
+     * Writes the command parameters/arguments to the message buffer
+     * @param msg message buffer to append to
+     * @param params parameters/arguments
+     */
+    static void writeParams(QByteArray& msg, const QList<QByteArray>& params);
+};