KoGenericRegistry.h 3.86 KB
Newer Older
Boudewijn Rempt's avatar
Boudewijn Rempt committed
1 2 3 4 5 6 7
/* This file is part of the KDE project
 *  Copyright (c) 2004 Cyrille Berger <cberger@cberger.net>
 *  Copyright (c) 2006 Boudewijn Rempt <boud@valdyas.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
Boudewijn Rempt's avatar
Boudewijn Rempt committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef _KO_GENERIC_REGISTRY_H_
#define _KO_GENERIC_REGISTRY_H_

24 25 26
#include <QList>
#include <QString>
#include <QHash>
Boudewijn Rempt's avatar
Boudewijn Rempt committed
27 28 29 30

/**
 * Base class for registry objects.
 *
31 32
 * Registered objects are owned by the registry.
 *
Boudewijn Rempt's avatar
Boudewijn Rempt committed
33 34
 * Items are mapped by QString as a unique Id.
 *
luz paz's avatar
luz paz committed
35
 * Example of use:
Boudewijn Rempt's avatar
Boudewijn Rempt committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
 * @code
 * class KoMyClassRegistry : public KoGenericRegistry<MyClass*> {
 * public:
 *   static KoMyClassRegistry * instance();
 * private:
 *  static KoMyClassRegistry* s_instance;
 * };
 *
 * KoMyClassRegistry *KoMyClassRegistry::s_instance = 0;
 * KoMyClassRegistry * KoMyClassRegistry::instance()
 * {
 *    if(s_instance == 0)
 *    {
 *      s_instance = new KoMyClassRegistry;
 *    }
 *    return s_instance;
 * }
 *
 * @endcode
 */
template<typename T>
class KoGenericRegistry
{
public:
    KoGenericRegistry() { }
61 62 63 64
    virtual ~KoGenericRegistry()
    {
        m_hash.clear();
    }
Boudewijn Rempt's avatar
Boudewijn Rempt committed
65 66 67

public:
    /**
68 69 70 71
     * Add an object to the registry. If it is a QObject, make sure it isn't in the
     * QObject ownership hierarchy, since the registry itself is responsbile for
     * deleting it.
     *
Boudewijn Rempt's avatar
Boudewijn Rempt committed
72 73
     * @param item the item to add (NOTE: T must have an QString id() const   function)
     */
74 75 76
    void add(T item)
    {
        Q_ASSERT(item);
77
        QString id = item->id();
78
        if (m_hash.contains(id)) {
79 80 81 82
            m_doubleEntries << value(id);
            remove(id);
        }
        m_hash.insert(id, item);
Boudewijn Rempt's avatar
Boudewijn Rempt committed
83 84 85 86 87 88 89
    }

    /**
     * add an object to the registry
     * @param id the id of the object
     * @param item the item to add
     */
90 91 92 93
    void add(const QString &id, T item)
    {
        Q_ASSERT(item);
        if (m_hash.contains(id)) {
94 95 96
            m_doubleEntries << value(id);
            remove(id);
        }
Boudewijn Rempt's avatar
Boudewijn Rempt committed
97 98 99 100 101 102
        m_hash.insert(id, item);
    }

    /**
     * This function removes an item from the registry
     */
103 104
    void remove(const QString &id)
    {
Boudewijn Rempt's avatar
Boudewijn Rempt committed
105 106 107 108 109 110 111 112 113
        m_hash.remove(id);
    }

    /**
     * Retrieve the object from the registry based on the unique
     * identifier string.
     *
     * @param id the id
     */
114 115
    T get(const QString &id) const
    {
Boudewijn Rempt's avatar
Boudewijn Rempt committed
116 117 118 119 120 121 122 123
        return value(id);
    }

    /**
     * @return if there is an object stored in the registry identified
     * by the id.
     * @param id the unique identifier string
     */
124 125
    bool contains(const QString &id) const
    {
Boudewijn Rempt's avatar
Boudewijn Rempt committed
126 127 128 129 130 131 132
        return m_hash.contains(id);
    }

    /**
     * Retrieve the object from the registry based on the unique identifier string
     * @param id the id
     */
133 134
    const T value(const QString &id) const
    {
Boudewijn Rempt's avatar
Boudewijn Rempt committed
135 136 137 138 139 140
        return m_hash.value(id);
    }

    /**
     * @return a list of all keys
     */
141 142
    QList<QString> keys() const
    {
Boudewijn Rempt's avatar
Boudewijn Rempt committed
143 144 145
        return m_hash.keys();
    }

146 147
    int count() const
    {
Boudewijn Rempt's avatar
Boudewijn Rempt committed
148 149 150
        return m_hash.count();
    }

151 152
    QList<T> values() const
    {
Boudewijn Rempt's avatar
Boudewijn Rempt committed
153 154 155
        return m_hash.values();
    }

156 157
    QList<T> doubleEntries() const
    {
158 159 160
        return m_doubleEntries;
    }

Boudewijn Rempt's avatar
Boudewijn Rempt committed
161
private:
162 163 164 165 166

    QList<T> m_doubleEntries;

private:

Boudewijn Rempt's avatar
Boudewijn Rempt committed
167 168 169 170
    QHash<QString, T> m_hash;
};

#endif