src/common/aliasmanager.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include "common-export.h"
  24
  25 #include <QVariantMap>
  26
  27 #include "bufferinfo.h"
  28 #include "syncableobject.h"
  29
  30 class Network;
  31
  32 class COMMON_EXPORT AliasManager : public SyncableObject
  33 {
  34     Q_OBJECT
  35     SYNCABLE_OBJECT
  36
  37 public:
  38     inline AliasManager(QObject *parent = nullptr) : SyncableObject(parent) { setAllowClientUpdates(true); }
  39     AliasManager &operator=(const AliasManager &other);
  40
  41     struct Alias {
  42         QString name;
  43         QString expansion;
  44         Alias(const QString &name_, const QString &expansion_) : name(name_), expansion(expansion_) {}
  45     };
  46     using AliasList = QList<Alias>;
  47
  48     int indexOf(const QString &name) const;
  49     inline bool contains(const QString &name) const { return indexOf(name) != -1; }
  50     inline bool isEmpty() const { return _aliases.isEmpty(); }
  51     inline int count() const { return _aliases.count(); }
  52     inline void removeAt(int index) { _aliases.removeAt(index); }
  53     inline Alias &operator[](int i) { return _aliases[i]; }
  54     inline const Alias &operator[](int i) const { return _aliases.at(i); }
  55     inline const AliasList &aliases() const { return _aliases; }
  56
  57     static AliasList defaults();
  58
  59     using CommandList = QList<QPair<BufferInfo, QString>>;
  60
  61     CommandList processInput(const BufferInfo &info, const QString &message);
  62
  63 public slots:
  64     virtual QVariantMap initAliases() const;
  65     virtual void initSetAliases(const QVariantMap &aliases);
  66
  67     virtual void addAlias(const QString &name, const QString &expansion);
  68
  69 protected:
  70     void setAliases(const QList<Alias> &aliases) { _aliases = aliases; }
  71     virtual const Network *network(NetworkId) const = 0; // core and client require different access
  72
  73 private:
  74     void processInput(const BufferInfo &info, const QString &message, CommandList &previousCommands);
  75     void expand(const QString &alias, const BufferInfo &bufferInfo, const QString &msg, CommandList &previousCommands);
  76
  77     AliasList _aliases;
  78 };