~ubuntu-branches/ubuntu/trusty/kvirc/trusty-proposed

« back to all changes in this revision

Viewing changes to src/kvirc/kvs/KviKvsParameterProcessor.cpp

  • Committer: Bazaar Package Importer
  • Author(s): Kai Wasserbäch, Kai Wasserbäch, Raúl Sánchez Siles
  • Date: 2011-02-12 10:40:21 UTC
  • mfrom: (14.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110212104021-5mh4f75jlku20mnt
The combined "Twisted Experiment" and "Nocturnal Raid" release.

[ Kai Wasserbäch ]
* Synced to upstream's SVN revision 5467.
* debian/rules:
  - Added .PHONY line.
  - Resurrect -DMANUAL_REVISION, got lost somewhere and we build SVN
    revisions again.
  - Replace "-DWITH_NO_EMBEDDED_CODE=YES" with "-DWANT_CRYPTOPP=YES".
  - Change the remaining -DWITH/-DWITHOUT to the new -DWANT syntax.
* debian/control:
  - Removed DMUA, I'm a DD now.
  - Changed my e-mail address.
  - Removed unneeded relationships (no upgrades over two releases are
    supported).
  - Fix Suggests for kvirc-dbg.
  - kvirc-data: Make the "Suggests: kvirc" a Recommends, doesn't make much
    sense to install the -data package without the program.
* debian/source/local-options: Added with "unapply-patches".
* debian/kvirc.lintian-overrides: Updated to work for 4.1.1.
* debian/patches/21_make_shared-mime-info_B-D_superfluous.patch: Updated.
* debian/kvirc-data.install: Added .notifyrc.

[ Raúl Sánchez Siles ]
* Stating the right version where kvirc-data break and replace should happen.
* Fixing link to license file.
* Added French and Portuguese man pages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
//=============================================================================
 
2
//
 
3
//   File : KviKvsParameterProcessor.cpp
 
4
//   Creation date : Sun 17 Apr 2005 16:47:09 by Szymon Stefanek
 
5
//
 
6
//   This file is part of the KVIrc IRC client distribution
 
7
//   Copyright (C) 2005-2010 Szymon Stefanek <pragma at kvirc dot net>
 
8
//
 
9
//   This program is FREE software. You can redistribute it and/or
 
10
//   modify it under the terms of the GNU General Public License
 
11
//   as published by the Free Software Foundation; either version 2
 
12
//   of the License, or (at your opinion) any later version.
 
13
//
 
14
//   This program is distributed in the HOPE that it will be USEFUL,
 
15
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
17
//   See the GNU General Public License for more details.
 
18
//
 
19
//   You should have received a copy of the GNU General Public License
 
20
//   along with this program. If not, write to the Free Software Foundation,
 
21
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
22
//
 
23
//=============================================================================
 
24
 
 
25
#include "KviKvsParameterProcessor.h"
 
26
#include "KviKvsVariantList.h"
 
27
#include "KviKvsRunTimeContext.h"
 
28
#include "KviKvsVariantList.h"
 
29
#include "KviKvsArray.h"
 
30
#include "KviKvsArrayCast.h"
 
31
#include "KviKvsHash.h"
 
32
#include "KviKvsObject.h"
 
33
#include "KviQString.h"
 
34
#include "KviLocale.h"
 
35
#include "KviPointerList.h"
 
36
 
 
37
#include <QStringList>
 
38
 
 
39
namespace KviKvsParameterProcessor
 
40
{
 
41
        void setDefaultValue(KviKvsParameterProcessor::ParameterFormat * pFmtArray)
 
42
        {
 
43
                switch(pFmtArray->uType)
 
44
                {
 
45
                        case KVS_PT_STRING:
 
46
                        case KVS_PT_NONEMPTYSTRING:
 
47
                                *((QString *)(pFmtArray->pContainer)) = QString();
 
48
                        break;
 
49
                        case KVS_PT_INT:
 
50
                                *((kvs_int_t *)(pFmtArray->pContainer)) = 0;
 
51
                        break;
 
52
                        case KVS_PT_UINT:
 
53
                                *((kvs_uint_t *)(pFmtArray->pContainer)) = 0;
 
54
                        break;
 
55
                        case KVS_PT_DOUBLE:
 
56
                                *((kvs_real_t *)(pFmtArray->pContainer)) = 0.0;
 
57
                        break;
 
58
                        case KVS_PT_BOOL:
 
59
                                *((bool *)(pFmtArray->pContainer)) = false;
 
60
                        break;
 
61
                        case KVS_PT_HASH:
 
62
                                *((KviKvsHash **)(pFmtArray->pContainer)) = 0;
 
63
                        break;
 
64
                        case KVS_PT_ARRAY:
 
65
                                *((KviKvsArray **)(pFmtArray->pContainer)) = 0;
 
66
                        break;
 
67
                        case KVS_PT_ARRAYCAST:
 
68
                                ((KviKvsArrayCast *)(pFmtArray->pContainer))->clear();
 
69
                        break;
 
70
                        case KVS_PT_VARIANT:
 
71
                                *((KviKvsVariant **)(pFmtArray->pContainer)) = 0;
 
72
                        break;
 
73
                        case KVS_PT_CSTRING:
 
74
                        case KVS_PT_NONEMPTYCSTRING:
 
75
                                *((QByteArray *)(pFmtArray->pContainer)) = 0;
 
76
                        break;
 
77
                        case KVS_PT_STRINGLIST:
 
78
                                ((QStringList *)(pFmtArray->pContainer))->clear();
 
79
                        break;
 
80
                        case KVS_PT_VARIANTLIST:
 
81
                                ((KviKvsVariantList *)(pFmtArray->pContainer))->clear();
 
82
                                ((KviKvsVariantList *)(pFmtArray->pContainer))->setAutoDelete(false);
 
83
                        break;
 
84
                        case KVS_PT_HOBJECT:
 
85
                                *((kvs_hobject_t *)(pFmtArray->pContainer)) = (kvs_hobject_t)0;
 
86
                        break;
 
87
                        case KVS_PT_IGNORE:
 
88
                                // ignore :)
 
89
                        break;
 
90
                        default:
 
91
                                qDebug("Internal error in KviKvsParameterProcessor::setDefaultValue(): unknown parameter type %d",pFmtArray->uType);
 
92
                        break;
 
93
                }
 
94
        }
 
95
 
 
96
        bool handleParameterTypeError(KviKvsRunTimeContext * pContext,KviKvsParameterProcessor::ParameterFormat * pFmtArray,KviKvsVariant * v,const char * szExpectedType)
 
97
        {
 
98
                if(pFmtArray->uFlags & KVS_PF_OPTIONAL)
 
99
                {
 
100
                        if(v->isEmpty())
 
101
                        {
 
102
                                setDefaultValue(pFmtArray);
 
103
                                return true; // empty optional
 
104
                        }
 
105
                }
 
106
 
 
107
                QString szError = QString(__tr2qs_ctx("Invalid data type for parameter \"%1\"","kvs")).arg(pFmtArray->szName);
 
108
                szError += ": ";
 
109
 
 
110
                if(v->isString())
 
111
                {
 
112
                        QString tmp = v->string();
 
113
                        if(tmp.isEmpty())
 
114
                        {
 
115
                                KviQString::appendFormatted(szError,__tr2qs_ctx("found empty string where type '%s' was expected","kvs"),&tmp,szExpectedType);
 
116
                        } else {
 
117
                                if(tmp.length() > 15)
 
118
                                {
 
119
                                        tmp.truncate(15);
 
120
                                        tmp.append("...");
 
121
                                }
 
122
                                KviQString::appendFormatted(szError,__tr2qs_ctx("found string value \"%Q\" where type '%s' was expected","kvs"),&tmp,szExpectedType);
 
123
                        }
 
124
                } else {
 
125
                        QString tmp;
 
126
                        v->getTypeName(tmp);
 
127
                        KviQString::appendFormatted(szError,__tr2qs_ctx("found type %Q where type '%s' was expected","kvs"),&tmp,szExpectedType);
 
128
                }
 
129
                pContext->error(szError);
 
130
                return false;
 
131
        }
 
132
 
 
133
        bool process(KviKvsVariantList * pVariantList,KviKvsRunTimeContext * pContext,KviKvsParameterProcessor::ParameterFormat * pFmtArray)
 
134
        {
 
135
                KviKvsVariant * v = pVariantList->first();
 
136
 
 
137
                while(pFmtArray->szName)
 
138
                {
 
139
                        if(!v)
 
140
                        {
 
141
                                // parameter not present
 
142
                                // it MUST be optional
 
143
                                if(!(pFmtArray->uFlags & KVS_PF_OPTIONAL))
 
144
                                {
 
145
                                        // bad luck
 
146
                                        QString szError = QString(__tr2qs_ctx("Missing non-optional parameter \"%1\"","kvs")).arg(pFmtArray->szName);
 
147
                                        pContext->error(szError);
 
148
                                        return false;
 
149
                                }
 
150
                                // ok, missing but optional (all the following are implicitly optional too)
 
151
                                // set to default values
 
152
                                do {
 
153
                                        setDefaultValue(pFmtArray);
 
154
                                        pFmtArray++;
 
155
                                } while(pFmtArray->szName);
 
156
                                return true;
 
157
                        }
 
158
                        // here we do only "light" casts: hard ones must be done explicitly by the user
 
159
                        switch(pFmtArray->uType)
 
160
                        {
 
161
                                case KVS_PT_STRING:
 
162
                                        v->asString(*((QString *)(pFmtArray->pContainer)));
 
163
                                        if(pFmtArray->uFlags & KVS_PF_APPENDREMAINING)
 
164
                                        {
 
165
                                                v = pVariantList->next();
 
166
                                                while(v)
 
167
                                                {
 
168
                                                        *((QString *)(pFmtArray->pContainer)) += QChar(' ');
 
169
                                                        v->appendAsString(*((QString *)(pFmtArray->pContainer)));
 
170
                                                        v = pVariantList->next();
 
171
                                                }
 
172
                                                return true;
 
173
                                        }
 
174
                                break;
 
175
                                case KVS_PT_STRINGLIST:
 
176
                                {
 
177
                                        ((QStringList *)(pFmtArray->pContainer))->clear();
 
178
                                        QString pSz;
 
179
                                        v->asString(pSz);
 
180
                                        ((QStringList *)(pFmtArray->pContainer))->append(pSz);
 
181
                                        v = pVariantList->next();
 
182
                                        while(v)
 
183
                                        {
 
184
                                                v->asString(pSz);
 
185
                                                ((QStringList *)(pFmtArray->pContainer))->append(pSz);
 
186
                                                v = pVariantList->next();
 
187
                                        }
 
188
                                        return true;
 
189
                                }
 
190
                                break;
 
191
                                case KVS_PT_VARIANTLIST:
 
192
                                {
 
193
                                        ((KviKvsVariantList *)(pFmtArray->pContainer))->clear();
 
194
                                        ((KviKvsVariantList *)(pFmtArray->pContainer))->setAutoDelete(false);
 
195
                                        ((KviKvsVariantList *)(pFmtArray->pContainer))->append(v);
 
196
                                        v = pVariantList->next();
 
197
                                        while(v)
 
198
                                        {
 
199
                                                ((KviKvsVariantList *)(pFmtArray->pContainer))->append(v);
 
200
                                                v = pVariantList->next();
 
201
                                        }
 
202
                                        return true;
 
203
                                }
 
204
                                break;
 
205
                                case KVS_PT_NONEMPTYSTRING:
 
206
                                {
 
207
                                        v->asString(*((QString *)(pFmtArray->pContainer)));
 
208
                                        bool bDoReturn = false;
 
209
                                        if(pFmtArray->uFlags & KVS_PF_APPENDREMAINING)
 
210
                                        {
 
211
                                                v = pVariantList->next();
 
212
                                                while(v)
 
213
                                                {
 
214
                                                        *((QString *)(pFmtArray->pContainer)) += QChar(' ');
 
215
                                                        v->appendAsString(*((QString *)(pFmtArray->pContainer)));
 
216
                                                        v = pVariantList->next();
 
217
                                                }
 
218
                                                bDoReturn = true;
 
219
                                        }
 
220
                                        if(((QString *)(pFmtArray->pContainer))->isEmpty())
 
221
                                        {
 
222
                                                QString szError = QString(__tr2qs_ctx("Invalid data type for parameter \"%1\": found empty string while a non empty one was expected","kvs")).arg(pFmtArray->szName);
 
223
                                                pContext->error(szError);
 
224
                                                return false;
 
225
                                        }
 
226
                                        if(bDoReturn)return true;
 
227
                                }
 
228
                                break;
 
229
                                case KVS_PT_CSTRING:
 
230
                                {
 
231
                                        QString tmp;
 
232
                                        v->asString(tmp);
 
233
                                        if(pFmtArray->uFlags & KVS_PF_APPENDREMAINING)
 
234
                                        {
 
235
                                                v = pVariantList->next();
 
236
                                                while(v)
 
237
                                                {
 
238
                                                        *((QByteArray *)(pFmtArray->pContainer)) += ' ';
 
239
                                                        v->appendAsString(tmp);
 
240
                                                        v = pVariantList->next();
 
241
                                                }
 
242
                                                *((QByteArray *)(pFmtArray->pContainer)) = tmp.toUtf8();
 
243
                                                return true;
 
244
                                        }
 
245
                                        *((QByteArray *)(pFmtArray->pContainer)) = tmp.toUtf8();
 
246
                                }
 
247
                                break;
 
248
                                case KVS_PT_NONEMPTYCSTRING:
 
249
                                {
 
250
                                        QString tmp;
 
251
                                        v->asString(tmp);
 
252
                                        bool bDoReturn = false;
 
253
                                        if(pFmtArray->uFlags & KVS_PF_APPENDREMAINING)
 
254
                                        {
 
255
                                                v = pVariantList->next();
 
256
                                                while(v)
 
257
                                                {
 
258
                                                        *((QByteArray *)(pFmtArray->pContainer)) += ' ';
 
259
                                                        v->appendAsString(tmp);
 
260
                                                        v = pVariantList->next();
 
261
                                                }
 
262
                                                *((QByteArray *)(pFmtArray->pContainer)) = tmp.toUtf8();
 
263
                                                bDoReturn = true;
 
264
                                        }
 
265
                                        *((QByteArray *)(pFmtArray->pContainer)) = tmp.toUtf8();
 
266
                                        if(((QByteArray *)(pFmtArray->pContainer))->isEmpty())
 
267
                                        {
 
268
                                                QString szError = QString(__tr2qs_ctx("Invalid data type for parameter \"%1\": found empty string while a non empty one was expected","kvs")).arg(pFmtArray->szName);
 
269
                                                pContext->error(szError);
 
270
                                                return false;
 
271
                                        }
 
272
                                        if(bDoReturn)return true;
 
273
                                }
 
274
                                break;
 
275
                                case KVS_PT_INT:
 
276
                                        if(!v->asInteger(*((kvs_int_t *)(pFmtArray->pContainer))))
 
277
                                        {
 
278
                                                if(!handleParameterTypeError(pContext,pFmtArray,v,"integer"))
 
279
                                                        return false;
 
280
                                        }
 
281
                                break;
 
282
                                case KVS_PT_UINT:
 
283
                                {
 
284
                                        kvs_int_t iTmp;
 
285
                                        if(!v->asInteger(iTmp))
 
286
                                        {
 
287
                                                if(!handleParameterTypeError(pContext,pFmtArray,v,"unsigned integer"))
 
288
                                                        return false;
 
289
                                        }
 
290
                                        if(iTmp < 0)
 
291
                                        {
 
292
                                                QString szError = QString(__tr2qs_ctx("Invalid data type for parameter \"%1\": found signed integer \"%2\" where type 'unsigned integer' was expected","kvs")).arg(pFmtArray->szName).arg(iTmp);
 
293
                                                pContext->error(szError);
 
294
                                                return false;
 
295
                                        }
 
296
                                        *((kvs_uint_t *)(pFmtArray->pContainer)) = (kvs_uint_t)iTmp;
 
297
                                }
 
298
                                break;
 
299
                                case KVS_PT_DOUBLE:
 
300
                                        if(!v->asReal(*((kvs_real_t *)(pFmtArray->pContainer))))
 
301
                                        {
 
302
                                                if(!handleParameterTypeError(pContext,pFmtArray,v,"real"))
 
303
                                                        return false;
 
304
                                        }
 
305
                                break;
 
306
                                case KVS_PT_HASH:
 
307
                                        if(!v->isHash())
 
308
                                        {
 
309
                                                if(!handleParameterTypeError(pContext,pFmtArray,v,"hash"))
 
310
                                                        return false;
 
311
                                        } else {
 
312
                                                *((KviKvsHash **)(pFmtArray->pContainer)) = v->hash();
 
313
                                        }
 
314
                                break;
 
315
                                case KVS_PT_ARRAYCAST:
 
316
                                        v->castToArray((KviKvsArrayCast *)(pFmtArray->pContainer));
 
317
                                break;
 
318
                                case KVS_PT_ARRAY:
 
319
                                        if(!v->isArray())
 
320
                                        {
 
321
                                                if(!handleParameterTypeError(pContext,pFmtArray,v,"array"))
 
322
                                                        return false;
 
323
                                        } else {
 
324
                                                *((KviKvsArray **)(pFmtArray->pContainer)) = v->array();
 
325
                                        }
 
326
                                break;
 
327
                                case KVS_PT_BOOL:
 
328
                                        // this never fails: anything is converted to a boolean
 
329
                                        *((bool *)(pFmtArray->pContainer)) = v->asBoolean();
 
330
                                break;
 
331
                                case KVS_PT_VARIANT:
 
332
                                        *((KviKvsVariant **)(pFmtArray->pContainer)) = v;
 
333
                                break;
 
334
                                case KVS_PT_HOBJECT:
 
335
                                        if(!v->asHObject(*((kvs_hobject_t *)(pFmtArray->pContainer))))
 
336
                                        {
 
337
                                                if(!handleParameterTypeError(pContext,pFmtArray,v,"hobject"))
 
338
                                                        return false;
 
339
                                        }
 
340
                                break;
 
341
                                case KVS_PT_IGNORE:
 
342
                                        // ignore
 
343
                                break;
 
344
                                default:
 
345
                                        qDebug("Internal error in KviKvsParameterProcessor::processAsParameters(): unknown parameter type %d",pFmtArray->uType);
 
346
                                        return false;
 
347
                                break;
 
348
                        }
 
349
                        pFmtArray++;
 
350
                        v = pVariantList->next();
 
351
                }
 
352
                return true;
 
353
        }
 
354
 
 
355
};