src/common/aliasmanager.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2022 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 <utility>
  26
  27 #include <QVariantMap>
  28
  29 #include "bufferinfo.h"
  30 #include "syncableobject.h"
  31
  32 class Network;
  33
  34 class COMMON_EXPORT AliasManager : public SyncableObject
  35 {
  36     Q_OBJECT
  37     SYNCABLE_OBJECT
  38
  39 public:
  40     inline AliasManager(QObject* parent = nullptr)
  41         : SyncableObject(parent)
  42     {
  43         setAllowClientUpdates(true);
  44     }
  45
  46     struct Alias
  47     {
  48         QString name;
  49         QString expansion;
  50         Alias(QString name_, QString expansion_)
  51             : name(std::move(name_))
  52             , expansion(std::move(expansion_))
  53         {}
  54     };
  55     using AliasList = QList<Alias>;
  56
  57     int indexOf(const QString& name) const;
  58     inline bool contains(const QString& name) const { return indexOf(name) != -1; }
  59     inline bool isEmpty() const { return _aliases.isEmpty(); }
  60     inline int count() const { return _aliases.count(); }
  61     inline void removeAt(int index) { _aliases.removeAt(index); }
  62     inline Alias& operator[](int i) { return _aliases[i]; }
  63     inline const Alias& operator[](int i) const { return _aliases.at(i); }
  64     inline const AliasList& aliases() const { return _aliases; }
  65
  66     static AliasList defaults();
  67
  68     using CommandList = QList<QPair<BufferInfo, QString>>;
  69
  70     CommandList processInput(const BufferInfo& info, const QString& message);
  71
  72 public slots:
  73     virtual QVariantMap initAliases() const;
  74     virtual void initSetAliases(const QVariantMap& aliases);
  75
  76     virtual void addAlias(const QString& name, const QString& expansion);
  77
  78 protected:
  79     void setAliases(const QList<Alias>& aliases) { _aliases = aliases; }
  80     virtual const Network* network(NetworkId) const = 0;  // core and client require different access
  81
  82 private:
  83     void processInput(const BufferInfo& info, const QString& message, CommandList& previousCommands);
  84     void expand(const QString& alias, const BufferInfo& bufferInfo, const QString& msg, CommandList& previousCommands);
  85
  86     AliasList _aliases;
  87 };