filehandleproperties.h 4.24 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/**
 * Copyright (C) 2004 Scott Wheeler <wheeler@kde.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) any later
 * version.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 */
16 17 18 19

#ifndef FILEHANDLEPROPERTIES_H
#define FILEHANDLEPROPERTIES_H

20
#include <QMap>
21
#include <QStringList>
22 23 24

/*
 * These ugly macros make possible a property registration system that makes it
25
 * easy to add properties to the FileHandle that can be accessed via the DBus
26 27 28 29 30 31 32 33 34 35 36
 * interface.
 *
 * Properties should actually be added to the filehandle.cpp file.  This file
 * is just here to separate out some of the macro-related ugliness.
 */

#define AddProperty(name, method)                                                   \
    namespace FileHandleProperties                                                  \
    {                                                                               \
        struct name##Property : public Property                                     \
        {                                                                           \
37
            virtual QString value(const FileHandle &f) const override final         \
38
            {                                                                       \
39
                return f.method;                                                    \
40 41 42 43 44 45 46 47 48 49 50 51
            }                                                                       \
            static const int dummy;                                                 \
        };                                                                          \
        static name##Property name##Instance;                                       \
        const int name##Property::dummy = addToPropertyMap(#name, &name##Instance); \
    }

#define AddNumberProperty(name, method)                                             \
    namespace FileHandleProperties                                                  \
    {                                                                               \
        struct name##Property : public Property                                     \
        {                                                                           \
52
            virtual QString value(const FileHandle &f) const override final         \
53
            {                                                                       \
54
                return QString::number(f.method);                                   \
55 56 57 58 59 60 61 62 63 64 65
            }                                                                       \
            static const int dummy;                                                 \
        };                                                                          \
        static name##Property name##Instance;                                       \
        const int name##Property::dummy = addToPropertyMap(#name, &name##Instance); \
    }

namespace FileHandleProperties
{
    struct Property
    {
Laurent Montel's avatar
Laurent Montel committed
66
        virtual ~Property() {}
67 68
        virtual QString value(const FileHandle &) const
        {
69
            return QString();
70 71 72
        }
    };

Laurent Montel's avatar
Laurent Montel committed
73
    static QMap<QByteArray, const Property *> propertyMap;
74

Laurent Montel's avatar
Laurent Montel committed
75
    static int addToPropertyMap(const QByteArray &name, Property *property)
76 77 78 79 80
    {
        propertyMap[name] = property;
        return 0;
    }

Laurent Montel's avatar
Laurent Montel committed
81
    static QString property(const FileHandle &file, const QByteArray &key)
82
    {
83
        return propertyMap.contains(key) ? propertyMap[key]->value(file) : QString();
84 85 86 87 88 89 90
    }

    static QStringList properties()
    {
        static QStringList l;

        if(l.isEmpty()) {
Laurent Montel's avatar
Laurent Montel committed
91 92
            QMap<QByteArray, const Property *>::ConstIterator it = propertyMap.constBegin();
            for(; it != propertyMap.constEnd(); ++it)
93 94 95 96 97 98 99
                l.append(QString(it.key()));
        }
        return l;
    }
}

#endif
100 101

// vim: set et sw=4 tw=0 sta: