← Back to branch summary

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

« back to all changes in this revision

Viewing changes to src/kvirc/kvs/KviKvsScript.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:
src/kvirc/kvs/KviKvsScript.cpp
 
1
//=============================================================================
 
2
//
 
3
//   File : KviKvsScript.cpp
 
4
//   Creation date : Thu 25 Sep 2003 05.12 CEST by Szymon Stefanek
 
5
//
 
6
//   This file is part of the KVIrc irc client distribution
 
7
//   Copyright (C) 2003-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 "kvi_out.h"
 
26
#include "KviKvsScript.h"
 
27
#include "KviKvsParser.h"
 
28
#include "KviKvsReport.h"
 
29
#include "KviKvsRunTimeContext.h"
 
30
#include "KviKvsTreeNodeInstruction.h"
 
31
#include "KviKvsVariantList.h"
 
32
#include "KviKvsKernel.h"
 
33
#include "KviLocale.h"
 
34
#include "KviWindow.h"
 
35
#include "KviApplication.h"
 
36
 
 
37
//#warning "THERE IS SOME MESS WITH m_szBuffer and m_pBuffer : with some script copying we may get errors with negative char indexes!"
 
38
 
 
39
KviKvsScript::KviKvsScript(const QString & szName, const QString & szBuffer, ScriptType eType)
 
40
{
 
41
        m_pData = new KviKvsScriptData;
 
42
        m_pData->m_uRefs = 1;
 
43
        m_pData->m_szName = szName;
 
44
        m_pData->m_eType = eType;
 
45
        m_pData->m_szBuffer = szBuffer;
 
46
        if(m_pData->m_szBuffer.isNull())
 
47
                m_pData->m_szBuffer = "";
 
48
 
 
49
        m_pData->m_pBuffer = m_pData->m_szBuffer.constData(); // never 0
 
50
        m_pData->m_uLock = 0;
 
51
        m_pData->m_pTree = 0;
 
52
}
 
53
 
 
54
KviKvsScript::KviKvsScript(const QString & szName, const QString & szBuffer, KviKvsTreeNodeInstruction * pPreparsedTree, ScriptType eType)
 
55
{
 
56
        m_pData = new KviKvsScriptData;
 
57
        m_pData->m_uRefs = 1;
 
58
        m_pData->m_szName = szName;
 
59
        m_pData->m_szBuffer = szBuffer;
 
60
        m_pData->m_eType = eType;
 
61
        if(m_pData->m_szBuffer.isNull())
 
62
                m_pData->m_szBuffer = "";
 
63
 
 
64
        m_pData->m_pBuffer = m_pData->m_szBuffer.constData(); // never 0
 
65
        m_pData->m_uLock = 0;
 
66
        m_pData->m_pTree = pPreparsedTree;
 
67
}
 
68
 
 
69
KviKvsScript::KviKvsScript(const KviKvsScript & src)
 
70
{
 
71
        m_pData = src.m_pData;
 
72
        m_pData->m_uRefs++;
 
73
}
 
74
 
 
75
KviKvsScript::~KviKvsScript()
 
76
{
 
77
        if(m_pData->m_uRefs < 2)
 
78
        {
 
79
                if(m_pData->m_uLock)qDebug("WARNING: Destroying a locked KviKvsScript");
 
80
                if(m_pData->m_pTree)delete m_pData->m_pTree;
 
81
                delete m_pData;
 
82
        } else {
 
83
                m_pData->m_uRefs--;
 
84
        }
 
85
}
 
86
 
 
87
void KviKvsScript::setName(const QString & szName)
 
88
{
 
89
        if(m_pData->m_uRefs > 1)
 
90
                detach();
 
91
        m_pData->m_szName = szName;
 
92
}
 
93
 
 
94
const QString & KviKvsScript::name() const
 
95
{
 
96
        return m_pData->m_szName;
 
97
}
 
98
 
 
99
const QString & KviKvsScript::code() const
 
100
{
 
101
        return m_pData->m_szBuffer;
 
102
}
 
103
 
 
104
bool KviKvsScript::locked() const
 
105
{
 
106
        return m_pData->m_uLock > 0;
 
107
}
 
108
 
 
109
void KviKvsScript::dump(const char * prefix)
 
110
{
 
111
        if(m_pData->m_pTree)
 
112
                m_pData->m_pTree->dump(prefix);
 
113
        else qDebug("%s KviKvsScript : no tree to dump",prefix);
 
114
}
 
115
 
 
116
void KviKvsScript::detach()
 
117
{
 
118
        if(m_pData->m_uRefs <= 1)
 
119
                return;
 
120
 
 
121
        m_pData->m_uRefs--;
 
122
        KviKvsScriptData * d = new KviKvsScriptData;
 
123
        d->m_uRefs = 1;
 
124
        d->m_eType = m_pData->m_eType;
 
125
        d->m_szBuffer = m_pData->m_szBuffer;
 
126
        if(d->m_szBuffer.isNull())
 
127
                d->m_szBuffer = "";
 
128
 
 
129
        d->m_szBuffer.resize(d->m_szBuffer.length());
 
130
        d->m_pBuffer = d->m_szBuffer.constData(); // never 0
 
131
        d->m_uLock = 0;
 
132
        d->m_pTree = 0;
 
133
        m_pData = d;
 
134
}
 
135
 
 
136
const QChar * KviKvsScript::buffer() const
 
137
{
 
138
        return m_pData->m_pBuffer;
 
139
}
 
140
 
 
141
int KviKvsScript::run(const QString & szCode, KviWindow * pWindow, KviKvsVariantList * pParams, KviKvsVariant * pRetVal)
 
142
{
 
143
        // static helper
 
144
        KviKvsScript s("kvirc::corecall(run)",szCode);
 
145
        return s.run(pWindow,pParams,pRetVal,PreserveParams);
 
146
}
 
147
 
 
148
int KviKvsScript::evaluate(const QString & szCode, KviWindow * pWindow, KviKvsVariantList * pParams, KviKvsVariant * pRetVal)
 
149
{
 
150
        // static helper
 
151
        KviKvsScript s("kvirc::corecall(evalutate)",szCode,Parameter);
 
152
        return s.run(pWindow,pParams,pRetVal,PreserveParams);
 
153
}
 
154
 
 
155
int KviKvsScript::evaluateAsString(const QString & szCode, KviWindow * pWindow, KviKvsVariantList * pParams, QString & szRetVal)
 
156
{
 
157
        // static helper
 
158
        KviKvsVariant ret;
 
159
        KviKvsScript s("kvirc::corecall(evalutate)",szCode,Parameter);
 
160
        int iRet = s.run(pWindow,pParams,&ret,PreserveParams);
 
161
        ret.asString(szRetVal);
 
162
        return iRet;
 
163
}
 
164
 
 
165
int KviKvsScript::run(KviWindow * pWnd, KviKvsVariantList * pParams, QString & szRetVal, int iRunFlags, KviKvsExtendedRunTimeData * pExtData)
 
166
{
 
167
        KviKvsVariant retVal;
 
168
        int iRet = run(pWnd,pParams,&retVal,iRunFlags,pExtData);
 
169
        retVal.asString(szRetVal);
 
170
        return iRet;
 
171
}
 
172
 
 
173
//static long int g_iTreeCacheHits = 0;
 
174
//static long int g_iTreeCacheMisses = 0;
 
175
 
 
176
int KviKvsScript::run(KviWindow * pWnd, KviKvsVariantList * pParams, KviKvsVariant * pRetVal, int iRunFlags, KviKvsExtendedRunTimeData * pExtData)
 
177
{
 
178
        if(!m_pData->m_pTree)
 
179
        {
 
180
                //g_iTreeCacheMisses++;
 
181
                //qDebug("CREATING TREE FOR SCRIPT %s",name().latin1());
 
182
                //qDebug("TREE CACHE STATS: HITS=%d, MISSES=%d",g_iTreeCacheHits,g_iTreeCacheMisses);
 
183
                if(!parse(pWnd,iRunFlags))
 
184
                {
 
185
                        if(pParams && !(iRunFlags & PreserveParams))
 
186
                                delete pParams;
 
187
                        return Error;
 
188
                }
 
189
        } else {
 
190
                //g_iTreeCacheHits++;
 
191
                //qDebug("USING A CACHED TREE FOR SCRIPT %s",name().latin1());
 
192
                //qDebug("TREE CACHE STATS: HITS=%d, MISSES=%d",g_iTreeCacheHits,g_iTreeCacheMisses);
 
193
        }
 
194
 
 
195
        return execute(pWnd,pParams,pRetVal,iRunFlags,pExtData);
 
196
}
 
197
 
 
198
int KviKvsScript::run(KviKvsRunTimeContext * pContext, int iRunFlags)
 
199
{
 
200
        if(!m_pData->m_pTree)
 
201
        {
 
202
                //g_iTreeCacheMisses++;
 
203
                //qDebug("CREATING TREE FOR SCRIPT %s",name().latin1());
 
204
                //qDebug("TREE CACHE STATS: HITS=%d, MISSES=%d",g_iTreeCacheHits,g_iTreeCacheMisses);
 
205
                if(!parse(pContext->window(),iRunFlags))
 
206
                        return Error;
 
207
        } else {
 
208
                //g_iTreeCacheHits++;
 
209
                //qDebug("USING A CACHED TREE FOR SCRIPT %s",name().latin1());
 
210
                //qDebug("TREE CACHE STATS: HITS=%d, MISSES=%d",g_iTreeCacheHits,g_iTreeCacheMisses);
 
211
        }
 
212
 
 
213
        int iRet;
 
214
 
 
215
        if(iRunFlags & Quiet)
 
216
        {
 
217
                bool bMustReEnable = !(pContext->reportingDisabled());
 
218
                pContext->disableReporting();
 
219
                iRet = executeInternal(pContext);
 
220
                if(bMustReEnable)pContext->enableReporting();
 
221
        } else {
 
222
                iRet = executeInternal(pContext);
 
223
        }
 
224
 
 
225
        return iRet;
 
226
}
 
227
 
 
228
bool KviKvsScript::parse(KviWindow * pOutput, int iRunFlags)
 
229
{
 
230
        if(m_pData->m_pTree)
 
231
        {
 
232
                // there is already a tree
 
233
                // if we have more than one ref, detach!
 
234
                if(m_pData->m_uRefs > 1)
 
235
                {
 
236
                        // mmmh.. more than one ref! .. detach
 
237
                        detach();
 
238
                } else {
 
239
                        // only a single ref: we're the owner of the tree
 
240
                        if(m_pData->m_uLock)
 
241
                        {
 
242
                                // ops... someone is locked in THIS script object
 
243
                                qDebug("WARNING: Trying to reparse a locked KviKvsScript!");
 
244
                                return false;
 
245
                        }
 
246
                        if(m_pData->m_pTree)
 
247
                                delete m_pData->m_pTree;
 
248
 
 
249
                        m_pData->m_pTree = 0;
 
250
                }
 
251
        } // else there is no tree at all, nobody can be locked inside
 
252
 
 
253
        KviKvsParser p(this,(iRunFlags & Quiet) ? 0 : pOutput);
 
254
        // parse never blocks
 
255
 
 
256
        int iFlags = iRunFlags & AssumeLocals ? KviKvsParser::AssumeLocals : 0;
 
257
        if(iRunFlags & Pedantic)iFlags |= KviKvsParser::Pedantic;
 
258
 
 
259
        switch(m_pData->m_eType)
 
260
        {
 
261
                case Expression:
 
262
                        m_pData->m_pTree = p.parseAsExpression(m_pData->m_pBuffer,iFlags);
 
263
                break;
 
264
                case Parameter:
 
265
                        m_pData->m_pTree = p.parseAsParameter(m_pData->m_pBuffer,iFlags);
 
266
                break;
 
267
                case InstructionList:
 
268
                default:
 
269
                        m_pData->m_pTree = p.parse(m_pData->m_pBuffer,iFlags);
 
270
                break;
 
271
        }
 
272
 
 
273
        //qDebug("\n\nDUMPING SCRIPT");
 
274
        //dump("");
 
275
        //qDebug("END OF SCRIPT DUMP\n\n");
 
276
 
 
277
        return !p.error();
 
278
}
 
279
 
 
280
int KviKvsScript::executeInternal(KviKvsRunTimeContext * pContext)
 
281
{
 
282
        // lock this script
 
283
        m_pData->m_uLock++;
 
284
 
 
285
        int iRunStatus = Success;
 
286
 
 
287
        if(!m_pData->m_pTree->execute(pContext))
 
288
        {
 
289
                if(pContext->error())iRunStatus = Error;
 
290
                else {
 
291
                        // else just a halt, return or sth like that
 
292
                        if(pContext->haltCalled())
 
293
                                iRunStatus |= HaltEncountered;
 
294
                }
 
295
        }
 
296
 
 
297
        // we can't block any longer: unlock
 
298
        m_pData->m_uLock--;
 
299
 
 
300
        return iRunStatus;
 
301
}
 
302
 
 
303
int KviKvsScript::execute(KviWindow * pWnd, KviKvsVariantList * pParams, KviKvsVariant * pRetVal, int iRunFlags, KviKvsExtendedRunTimeData * pExtData)
 
304
{
 
305
        bool bDeleteParams = !(iRunFlags & PreserveParams);
 
306
 
 
307
        // do we have a parsed tree ?
 
308
        if(!m_pData->m_pTree)
 
309
        {
 
310
                if(pParams && bDeleteParams)
 
311
                        delete pParams;
 
312
 
 
313
                // this is intended for developers only
 
314
                pWnd->outputNoFmt(KVI_OUT_PARSERERROR,"[developer error]: you must successfully call KviKvsScript::parse() before KviKvsScript::execute()");
 
315
                return Error;
 
316
        }
 
317
 
 
318
        // do we need to pass dummy params ?
 
319
        if(!pParams)
 
320
        {
 
321
                pParams = KviKvsKernel::instance()->emptyParameterList();
 
322
                bDeleteParams = false;
 
323
        }
 
324
 
 
325
        bool bDeleteRetVal = false;
 
326
 
 
327
        if(!pRetVal)
 
328
        {
 
329
                pRetVal = new KviKvsVariant();
 
330
                bDeleteRetVal = true;
 
331
        }
 
332
 
 
333
        KviKvsRunTimeContext ctx(this,pWnd,pParams,pRetVal,pExtData);
 
334
 
 
335
        if(iRunFlags & Quiet)
 
336
                ctx.disableReporting();
 
337
 
 
338
        int iRunStatus = executeInternal(&ctx);
 
339
 
 
340
        // don't forget to delete the params
 
341
        if(bDeleteParams)
 
342
                delete pParams;
 
343
        if(bDeleteRetVal)
 
344
                delete pRetVal;
 
345
        pParams = 0;
 
346
        pRetVal = 0;
 
347
        return iRunStatus;
 
348
}