summaryrefslogtreecommitdiff
path: root/TelepathyQt/protocol-parameter.cpp
blob: e0960d14ba0a5d4e59137aa4eede044eb26d18b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/**
 * This file is part of TelepathyQt
 *
 * @copyright Copyright (C) 2010 Collabora Ltd. <http://www.collabora.co.uk/>
 * @copyright Copyright (C) 2010 Nokia Corporation
 * @license LGPL 2.1
 *
 * 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
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#include <TelepathyQt/ProtocolParameter>

#include "TelepathyQt/debug-internal.h"

#include <TelepathyQt/Utils>

namespace Tp
{

struct TP_QT_NO_EXPORT ProtocolParameter::Private : public QSharedData
{
    Private(const ParamSpec &sp)
        : spec(sp),
          type(variantTypeFromDBusSignature(spec.signature))
    {
        init();
    }

    Private(const QString &name, const QString &dbusSignature,
            ConnMgrParamFlags flags, const QVariant &defaultValue)
        : type(variantTypeFromDBusSignature(dbusSignature))
    {
        spec.name = name;
        spec.flags = flags;
        spec.signature = dbusSignature;
        spec.defaultValue = QDBusVariant(defaultValue);
        init();
    }

    void init()
    {
        if (spec.flags & ConnMgrParamFlagHasDefault) {
            if (spec.defaultValue.variant() == QVariant::Invalid) {
                // flags contains HasDefault but no default value is passed,
                // lets warn and build a default value from signature
                warning() << "Building ProtocolParameter with flags containing ConnMgrParamFlagHasDefault"
                    " and no default value, generating a dummy one from signature";
                spec.defaultValue = QDBusVariant(
                        parseValueWithDBusSignature(QString(), spec.signature));
            }
        } else {
            if (spec.defaultValue.variant() != QVariant::Invalid) {
                // flags does not contain HasDefault but a default value is passed,
                // lets add HasDefault to flags
                debug() << "Building ProtocolParameter with flags not containing ConnMgrParamFlagHasDefault"
                    " and a default value, updating flags to contain ConnMgrParamFlagHasDefault";
                spec.flags |= ConnMgrParamFlagHasDefault;
            }
        }
    }

    ParamSpec spec;
    QVariant::Type type;
};

/**
 * \class ProtocolParameter
 * \ingroup clientcm
 * \headerfile TelepathyQt/protocol-parameter.h <TelepathyQt/ProtocolParameter>
 *
 * \brief The ProtocolParameter class represents a Telepathy protocol parameter.
 */


ProtocolParameter::ProtocolParameter()
{
}

ProtocolParameter::ProtocolParameter(const ParamSpec &spec)
    : mPriv(new Private(spec))
{
}

ProtocolParameter::ProtocolParameter(const QString &name,
                                     const QDBusSignature &dbusSignature,
                                     ConnMgrParamFlags flags,
                                     QVariant defaultValue)
    : mPriv(new Private(name, dbusSignature.signature(), flags, defaultValue))
{
}

ProtocolParameter::ProtocolParameter(const QString &name,
                                     const QString &dbusSignature,
                                     ConnMgrParamFlags flags,
                                     QVariant defaultValue)
    : mPriv(new Private(name, dbusSignature, flags, defaultValue))
{
}

ProtocolParameter::ProtocolParameter(const ProtocolParameter &other)
    : mPriv(other.mPriv)
{
}

ProtocolParameter::~ProtocolParameter()
{
}

ProtocolParameter &ProtocolParameter::operator=(const ProtocolParameter &other)
{
    this->mPriv = other.mPriv;
    return *this;
}

bool ProtocolParameter::operator==(const ProtocolParameter &other) const
{
    if (!isValid() || !other.isValid()) {
        if (!isValid() && !other.isValid()) {
            return true;
        }
        return false;
    }

    return (mPriv->spec.name == other.name());
}

bool ProtocolParameter::operator==(const QString &name) const
{
    if (!isValid()) {
        return false;
    }

    return (mPriv->spec.name == name);
}

bool ProtocolParameter::operator<(const Tp::ProtocolParameter& other) const
{
    return mPriv->spec.name < other.name();
}

QString ProtocolParameter::name() const
{
    if (!isValid()) {
        return QString();
    }

    return mPriv->spec.name;
}

QDBusSignature ProtocolParameter::dbusSignature() const
{
    if (!isValid()) {
        return QDBusSignature();
    }

    return QDBusSignature(mPriv->spec.signature);
}

QVariant::Type ProtocolParameter::type() const
{
    if (!isValid()) {
        return QVariant::Invalid;
    }

    return mPriv->type;
}

QVariant ProtocolParameter::defaultValue() const
{
    if (!isValid()) {
        return QVariant();
    }

    return mPriv->spec.defaultValue.variant();
}

bool ProtocolParameter::isRequired() const
{
    if (!isValid()) {
        return false;
    }

    return mPriv->spec.flags & ConnMgrParamFlagRequired;
}

bool ProtocolParameter::isSecret() const
{
    if (!isValid()) {
        return false;
    }

    return mPriv->spec.flags & ConnMgrParamFlagSecret;
}

bool ProtocolParameter::isRequiredForRegistration() const
{
    if (!isValid()) {
        return false;
    }

    return mPriv->spec.flags & ConnMgrParamFlagRegister;
}

ParamSpec ProtocolParameter::bareParameter() const
{
    if (!isValid()) {
        return ParamSpec();
    }

    return mPriv->spec;
}

uint qHash(const ProtocolParameter& parameter)
{
    return qHash(parameter.name());
}

} // Tp