Fixing a bug where the unread messages backlog requester wouldn't
[quassel.git] / src / common / aliasmanager.h
1 /***************************************************************************
2  *   Copyright (C) 2005-09 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
19  ***************************************************************************/
20
21 #ifndef ALIASMANAGER_H
22 #define ALIASMANAGER_H
23
24 #include <QVariantMap>
25
26 #include "bufferinfo.h"
27 #include "syncableobject.h"
28
29 class Network;
30
31 class AliasManager : public SyncableObject {
32   Q_OBJECT
33
34 public:
35   inline AliasManager(QObject *parent = 0) : SyncableObject(parent) { setAllowClientUpdates(true); }
36   AliasManager &operator=(const AliasManager &other);
37
38   struct Alias {
39     QString name;
40     QString expansion;
41     Alias(const QString &name_, const QString &expansion_) : name(name_), expansion(expansion_) {}
42   };
43   typedef QList<Alias> AliasList ;
44
45   int indexOf(const QString &name) const;
46   inline bool contains(const QString &name) const { return indexOf(name) != -1; }
47   inline bool isEmpty() const { return _aliases.isEmpty(); }
48   inline int count() const { return _aliases.count(); }
49   inline void removeAt(int index) { _aliases.removeAt(index); }
50   inline Alias &operator[](int i) { return _aliases[i]; }
51   inline const Alias &operator[](int i) const { return _aliases.at(i); }
52   inline const AliasList &aliases() const { return _aliases; }
53
54   static AliasList defaults();
55
56   typedef QList<QPair<BufferInfo, QString> > CommandList;
57
58   CommandList processInput(const BufferInfo &info, const QString &message);
59
60 public slots:
61   virtual QVariantMap initAliases() const;
62   virtual void initSetAliases(const QVariantMap &aliases);
63
64   virtual void addAlias(const QString &name, const QString &expansion);
65
66 protected:
67   void setAliases(const QList<Alias> &aliases) { _aliases = aliases; }
68   virtual const Network *network(NetworkId) const = 0; // core and client require different access
69
70 signals:
71   void aliasAdded(const QString &name, const QString &expansion);
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
79 };
80
81 #endif //ALIASMANAGER_H