qmljsinterpreter.h 18 KB
Newer Older
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
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#ifndef QMLJS_INTERPRETER_H
#define QMLJS_INTERPRETER_H

33
34
#include <qmljs/qmljs_global.h>
#include <qmljs/qmljsmetatypesystem.h>
35
#include <qmljs/parser/qmljsastfwd_p.h>
36
37
38
39
40
41
42

#include <QtCore/QList>
#include <QtCore/QString>
#include <QtCore/QHash>
#include <QtCore/QSet>

namespace QmlJS {
43
44
45

class NameId;

46
47
48
49
50
51
52
53
54
55
56
57
58
59
namespace Interpreter {

////////////////////////////////////////////////////////////////////////////////
// Forward declarations
////////////////////////////////////////////////////////////////////////////////
class Engine;
class Value;
class NullValue;
class UndefinedValue;
class NumberValue;
class BooleanValue;
class StringValue;
class ObjectValue;
class FunctionValue;
Roberto Raggi's avatar
Roberto Raggi committed
60
class Reference;
61

Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
62
63
typedef QList<const Value *> ValueList;

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
////////////////////////////////////////////////////////////////////////////////
// Value visitor
////////////////////////////////////////////////////////////////////////////////
class QMLJS_EXPORT ValueVisitor
{
public:
    ValueVisitor();
    virtual ~ValueVisitor();

    virtual void visit(const NullValue *);
    virtual void visit(const UndefinedValue *);
    virtual void visit(const NumberValue *);
    virtual void visit(const BooleanValue *);
    virtual void visit(const StringValue *);
    virtual void visit(const ObjectValue *);
    virtual void visit(const FunctionValue *);
Roberto Raggi's avatar
Roberto Raggi committed
80
    virtual void visit(const Reference *);
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
};

////////////////////////////////////////////////////////////////////////////////
// QML/JS value
////////////////////////////////////////////////////////////////////////////////
class QMLJS_EXPORT Value
{
    Value(const Value &other);
    void operator = (const Value &other);

public:
    Value();
    virtual ~Value();

    virtual const NullValue *asNullValue() const;
    virtual const UndefinedValue *asUndefinedValue() const;
    virtual const NumberValue *asNumberValue() const;
    virtual const BooleanValue *asBooleanValue() const;
    virtual const StringValue *asStringValue() const;
    virtual const ObjectValue *asObjectValue() const;
    virtual const FunctionValue *asFunctionValue() const;
Roberto Raggi's avatar
Roberto Raggi committed
102
    virtual const Reference *asReference() const;
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

    virtual void accept(ValueVisitor *) const = 0;
};

template <typename _RetTy> _RetTy value_cast(const Value *v);

template <> Q_INLINE_TEMPLATE const NullValue *value_cast(const Value *v)
{
    if (v) return v->asNullValue();
    else   return 0;
}

template <> Q_INLINE_TEMPLATE const UndefinedValue *value_cast(const Value *v)
{
    if (v) return v->asUndefinedValue();
    else   return 0;
}

template <> Q_INLINE_TEMPLATE const NumberValue *value_cast(const Value *v)
{
    if (v) return v->asNumberValue();
    else   return 0;
}

template <> Q_INLINE_TEMPLATE const BooleanValue *value_cast(const Value *v)
{
    if (v) return v->asBooleanValue();
    else   return 0;
}

template <> Q_INLINE_TEMPLATE const StringValue *value_cast(const Value *v)
{
    if (v) return v->asStringValue();
    else   return 0;
}

template <> Q_INLINE_TEMPLATE const ObjectValue *value_cast(const Value *v)
{
    if (v) return v->asObjectValue();
    else   return 0;
}

template <> Q_INLINE_TEMPLATE const FunctionValue *value_cast(const Value *v)
{
    if (v) return v->asFunctionValue();
    else   return 0;
}

Roberto Raggi's avatar
Roberto Raggi committed
151
152
153
154
155
156
template <> Q_INLINE_TEMPLATE const Reference *value_cast(const Value *v)
{
    if (v) return v->asReference();
    else   return 0;
}

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
////////////////////////////////////////////////////////////////////////////////
// Value nodes
////////////////////////////////////////////////////////////////////////////////
class QMLJS_EXPORT NullValue: public Value
{
public:
    virtual const NullValue *asNullValue() const;
    virtual void accept(ValueVisitor *visitor) const;
};

class QMLJS_EXPORT UndefinedValue: public Value
{
public:
    virtual const UndefinedValue *asUndefinedValue() const;
    virtual void accept(ValueVisitor *visitor) const;
};

class QMLJS_EXPORT NumberValue: public Value
{
public:
    virtual const NumberValue *asNumberValue() const;
    virtual void accept(ValueVisitor *visitor) const;
};

class QMLJS_EXPORT BooleanValue: public Value
{
public:
    virtual const BooleanValue *asBooleanValue() const;
    virtual void accept(ValueVisitor *visitor) const;
};

class QMLJS_EXPORT StringValue: public Value
{
public:
    virtual const StringValue *asStringValue() const;
    virtual void accept(ValueVisitor *visitor) const;
};

Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
195
196
197
198
199
200
class QMLJS_EXPORT MemberProcessor
{
    MemberProcessor(const MemberProcessor &other);
    void operator = (const MemberProcessor &other);

public:
201
202
    MemberProcessor();
    virtual ~MemberProcessor();
Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
203
204

    // Returns false to stop the processor.
205
    virtual bool processProperty(const QString &name, const Value *value);
206
    virtual bool processEnumerator(const QString &name, const Value *value);
207
208
    virtual bool processSignal(const QString &name, const Value *value);
    virtual bool processSlot(const QString &name, const Value *value);
209
    virtual bool processGeneratedSlot(const QString &name, const Value *value);
Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
210
211
};

Roberto Raggi's avatar
Roberto Raggi committed
212
213
class QMLJS_EXPORT Context
{
214
215
216
217
218
219
220
221
public:
    typedef QList<const ObjectValue *> ScopeChain;

    enum LookupMode {
        JSLookup,
        QmlLookup
    };

Roberto Raggi's avatar
Roberto Raggi committed
222
223
public:
    Context(Engine *engine);
224
    ~Context();
Roberto Raggi's avatar
Roberto Raggi committed
225
226

    Engine *engine() const;
227
228
229
230
231
232
233
234
235
    ScopeChain scopeChain() const;

    LookupMode lookupMode() const;
    void setLookupMode(LookupMode lookupMode);

    void pushScope(const ObjectValue *object);
    void popScope();

    const Value *lookup(const QString &name) const;
Roberto Raggi's avatar
Roberto Raggi committed
236
237
238
239
240
241
242
243

    const Value *property(const ObjectValue *object, const QString &name) const;
    void setProperty(const ObjectValue *object, const QString &name, const Value *value);

private:
    typedef QHash<QString, const Value *> Properties;

    Engine *_engine;
244
    LookupMode _lookupMode;
Roberto Raggi's avatar
Roberto Raggi committed
245
    QHash<const ObjectValue *, Properties> _properties;
246
    ScopeChain _scopeChain;
Roberto Raggi's avatar
Roberto Raggi committed
247
248
249
250
251
};

class QMLJS_EXPORT Reference: public Value
{
public:
252
    Reference(Engine *engine);
Roberto Raggi's avatar
Roberto Raggi committed
253
254
    virtual ~Reference();

255
256
    Engine *engine() const;
    virtual const Value *value(Context *context) const;
Roberto Raggi's avatar
Roberto Raggi committed
257
258
259
260

    // Value interface
    virtual const Reference *asReference() const;
    virtual void accept(ValueVisitor *) const;
261
262
263

private:
    Engine *_engine;
Roberto Raggi's avatar
Roberto Raggi committed
264
265
};

266
class QMLJS_EXPORT ObjectValue: public Value
267
268
269
{
public:
    ObjectValue(Engine *engine);
Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
270
    virtual ~ObjectValue();
271
272
273
274
275
276
277
278
279

    Engine *engine() const;

    QString className() const;
    void setClassName(const QString &className);

    const ObjectValue *prototype() const;
    void setPrototype(const ObjectValue *prototype);

Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
280
    virtual void processMembers(MemberProcessor *processor) const;
281
282
283
284
285
286
287
288
289
290
291
292

    virtual const Value *property(const QString &name) const;
    virtual void setProperty(const QString &name, const Value *value);
    virtual void removeProperty(const QString &name);

    virtual const Value *lookupMember(const QString &name) const;

    // Value interface
    virtual const ObjectValue *asObjectValue() const;
    virtual void accept(ValueVisitor *visitor) const;

private:
Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
293
    bool checkPrototype(const ObjectValue *prototype, QSet<const ObjectValue *> *processed) const;
294
295
296
297
298
299
300
301

private:
    Engine *_engine;
    const ObjectValue *_prototype;
    QHash<QString, const Value *> _members;
    QString _className;
};

302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
#ifndef NO_DECLARATIVE_BACKEND

class QmlObjectValue: public ObjectValue
{
public:
    QmlObjectValue(const QMetaObject *metaObject, const QString &qmlTypeName, int majorVersion, int minorVersion, Engine *engine);
    virtual ~QmlObjectValue();

    virtual const Value *lookupMember(const QString &name) const;
    virtual void processMembers(MemberProcessor *processor) const;
    const Value *propertyValue(const QMetaProperty &prop) const;

    QString qmlTypeName() const
    { return _qmlTypeName; }

    int majorVersion() const
    { return _majorVersion; }

    int minorVersion() const
    { return _minorVersion; }

Roberto Raggi's avatar
Roberto Raggi committed
323
324
325
protected:
    const Value *findOrCreateSignature(int index, const QMetaMethod &method, QString *methodName) const;

326
327
328
329
330
private:
    const QMetaObject *_metaObject;
    QString _qmlTypeName;
    int _majorVersion;
    int _minorVersion;
Roberto Raggi's avatar
Roberto Raggi committed
331
    mutable QHash<int, const Value *> _metaSignature;
332
333
334
335
};

#endif // !NO_DECLARATIVE_BACKEND

336
class QMLJS_EXPORT Activation
Roberto Raggi's avatar
Roberto Raggi committed
337
338
{
public:
339
    Activation();
Roberto Raggi's avatar
Roberto Raggi committed
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
    virtual ~Activation();

    bool calledAsConstructor() const;
    void setCalledAsConstructor(bool calledAsConstructor);

    bool calledAsFunction() const;
    void setCalledAsFunction(bool calledAsFunction);

    ObjectValue *thisObject() const;
    void setThisObject(ObjectValue *thisObject);

    ValueList arguments() const;
    void setArguments(const ValueList &arguments);

private:
    ObjectValue *_thisObject;
    ValueList _arguments;
    bool _calledAsFunction;
};


361
362
363
364
class QMLJS_EXPORT FunctionValue: public ObjectValue
{
public:
    FunctionValue(Engine *engine);
Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
365
366
367
368
369
370
371
372
373
374
375
    virtual ~FunctionValue();

    // [[construct]]
    const Value *construct(const ValueList &actuals = ValueList()) const;

    // [[call]]
    const Value *call(const ValueList &actuals = ValueList()) const;

    const Value *call(const ObjectValue *thisObject,
                      const ValueList &actuals = ValueList()) const;

376
377
378
379

    virtual const Value *returnValue() const;

    virtual int argumentCount() const;
Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
380
    virtual const Value *argument(int index) const;
381
382
    virtual QString argumentName(int index) const;
    virtual bool isVariadic() const;
383

Roberto Raggi's avatar
Roberto Raggi committed
384
    virtual const Value *invoke(const Activation *activation) const;
385
386
387
388
389
390
391
392
393
394

    // Value interface
    virtual const FunctionValue *asFunctionValue() const;
    virtual void accept(ValueVisitor *visitor) const;
};

class QMLJS_EXPORT Function: public FunctionValue
{
public:
    Function(Engine *engine);
Roberto Raggi's avatar
Roberto Raggi committed
395
    virtual ~Function();
396

397
    void addArgument(const Value *argument);
398
399
400
401
402
403
404
405
406
    void setReturnValue(const Value *returnValue);

    // ObjectValue interface
    virtual const Value *property(const QString &name) const;

    // FunctionValue interface
    virtual const Value *returnValue() const;
    virtual int argumentCount() const;
    virtual const Value *argument(int index) const;
Roberto Raggi's avatar
Roberto Raggi committed
407
    virtual const Value *invoke(const Activation *activation) const;
408
409

private:
Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
410
    ValueList _arguments;
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
    const Value *_returnValue;
};


////////////////////////////////////////////////////////////////////////////////
// typing environment
////////////////////////////////////////////////////////////////////////////////

class ConvertToNumber: protected ValueVisitor // ECMAScript ToInt()
{
public:
    ConvertToNumber(Engine *engine);

    const Value *operator()(const Value *value);

protected:
    const Value *switchResult(const Value *value);

    virtual void visit(const NullValue *);
    virtual void visit(const UndefinedValue *);
    virtual void visit(const NumberValue *);
    virtual void visit(const BooleanValue *);
    virtual void visit(const StringValue *);
    virtual void visit(const ObjectValue *);
    virtual void visit(const FunctionValue *);

private:
    Engine *_engine;
    const Value *_result;
};

class ConvertToString: protected ValueVisitor // ECMAScript ToString
{
public:
    ConvertToString(Engine *engine);

    const Value *operator()(const Value *value);

protected:
    const Value *switchResult(const Value *value);

    virtual void visit(const NullValue *);
    virtual void visit(const UndefinedValue *);
    virtual void visit(const NumberValue *);
    virtual void visit(const BooleanValue *);
    virtual void visit(const StringValue *);
    virtual void visit(const ObjectValue *);
    virtual void visit(const FunctionValue *);

private:
    Engine *_engine;
    const Value *_result;
};

class ConvertToObject: protected ValueVisitor // ECMAScript ToObject
{
public:
    ConvertToObject(Engine *engine);

    const Value *operator()(const Value *value);

protected:
    const Value *switchResult(const Value *value);

    virtual void visit(const NullValue *);
    virtual void visit(const UndefinedValue *);
    virtual void visit(const NumberValue *);
    virtual void visit(const BooleanValue *);
    virtual void visit(const StringValue *);
    virtual void visit(const ObjectValue *);
    virtual void visit(const FunctionValue *);

private:
    Engine *_engine;
    const Value *_result;
};

class TypeId: protected ValueVisitor
{
    QString _result;

public:
    QString operator()(const Value *value);

protected:
    virtual void visit(const NullValue *);
    virtual void visit(const UndefinedValue *);
    virtual void visit(const NumberValue *);
    virtual void visit(const BooleanValue *);
    virtual void visit(const StringValue *);
    virtual void visit(const ObjectValue *object);
    virtual void visit(const FunctionValue *object);
};

class QMLJS_EXPORT Engine
{
    Engine(const Engine &other);
    void operator = (const Engine &other);

public:
    Engine();
    ~Engine();

    const NullValue *nullValue() const;
    const UndefinedValue *undefinedValue() const;
    const NumberValue *numberValue() const;
    const BooleanValue *booleanValue() const;
    const StringValue *stringValue() const;

Roberto Raggi's avatar
Roberto Raggi committed
520
    ObjectValue *newObject(const ObjectValue *prototype);
521
522
    ObjectValue *newObject();
    Function *newFunction();
Roberto Raggi's avatar
Roberto Raggi committed
523
    const Value *newArray(); // ### remove me
524

Roberto Raggi's avatar
Roberto Raggi committed
525
    // QML objects
526
    const ObjectValue *qmlKeysObject();
527
    const Value *defaultValueForBuiltinType(const QString &typeName) const;
528
529
530
#ifndef NO_DECLARATIVE_BACKEND
    QmlObjectValue *newQmlObject(const QString &name, const QString &prefix, int majorVersion, int minorVersion);
#endif
Roberto Raggi's avatar
Roberto Raggi committed
531

532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
    // global object
    ObjectValue *globalObject() const;
    const ObjectValue *mathObject() const;

    // prototypes
    ObjectValue *objectPrototype() const;
    ObjectValue *functionPrototype() const;
    ObjectValue *numberPrototype() const;
    ObjectValue *booleanPrototype() const;
    ObjectValue *stringPrototype() const;
    ObjectValue *arrayPrototype() const;
    ObjectValue *datePrototype() const;
    ObjectValue *regexpPrototype() const;

    // ctors
    const FunctionValue *objectCtor() const;
    const FunctionValue *functionCtor() const;
    const FunctionValue *arrayCtor() const;
    const FunctionValue *stringCtor() const;
    const FunctionValue *booleanCtor() const;
    const FunctionValue *numberCtor() const;
    const FunctionValue *dateCtor() const;
    const FunctionValue *regexpCtor() const;

    // operators
Roberto Raggi's avatar
Roberto Raggi committed
557
    const Value *convertToBoolean(const Value *value);
558
559
560
561
562
    const Value *convertToNumber(const Value *value);
    const Value *convertToString(const Value *value);
    const Value *convertToObject(const Value *value);
    QString typeId(const Value *value);

563
564
565
566
    // typing:
    const MetaTypeSystem &metaTypeSystem() const
    { return _metaTypeSystem; }

567
568
    void registerValue(Value *value); // internal

569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
private:
    void initializePrototypes();

    void addFunction(ObjectValue *object, const QString &name, const Value *result, int argumentCount);
    void addFunction(ObjectValue *object, const QString &name, int argumentCount);

private:
    ObjectValue *_objectPrototype;
    ObjectValue *_functionPrototype;
    ObjectValue *_numberPrototype;
    ObjectValue *_booleanPrototype;
    ObjectValue *_stringPrototype;
    ObjectValue *_arrayPrototype;
    ObjectValue *_datePrototype;
    ObjectValue *_regexpPrototype;

    Function *_objectCtor;
    Function *_functionCtor;
    Function *_arrayCtor;
    Function *_stringCtor;
    Function *_booleanCtor;
    Function *_numberCtor;
    Function *_dateCtor;
    Function *_regexpCtor;

    ObjectValue *_globalObject;
    ObjectValue *_mathObject;
596
#ifndef NO_DECLARATIVE_BACKEND
597
    ObjectValue *_qmlKeysObject;
598
#endif
599
600
601
602
603
604

    NullValue _nullValue;
    UndefinedValue _undefinedValue;
    NumberValue _numberValue;
    BooleanValue _booleanValue;
    StringValue _stringValue;
605
    QList<Value *> _registeredValues;
606
607
608
609
610

    ConvertToNumber _convertToNumber;
    ConvertToString _convertToString;
    ConvertToObject _convertToObject;
    TypeId _typeId;
611
612

    MetaTypeSystem _metaTypeSystem;
613
614
};

615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659

// internal
class QMLJS_EXPORT ASTObjectValue: public ObjectValue
{
    AST::UiQualifiedId *_typeName;
    AST::UiObjectInitializer *_initializer;

public:
    ASTObjectValue(AST::UiQualifiedId *typeName, AST::UiObjectInitializer *initializer, Engine *engine);
    virtual ~ASTObjectValue();

    virtual void processMembers(MemberProcessor *processor) const;
};

class QMLJS_EXPORT ASTVariableReference: public Reference
{
    AST::VariableDeclaration *_ast;

public:
    ASTVariableReference(AST::VariableDeclaration *ast, Engine *engine);
    virtual ~ASTVariableReference();

    virtual const Value *value(Context *context) const;
};

class QMLJS_EXPORT ASTFunctionValue: public FunctionValue
{
    AST::FunctionDeclaration *_ast;
    QList<NameId *> _argumentNames;

public:
    ASTFunctionValue(AST::FunctionDeclaration *ast, Engine *engine);
    virtual ~ASTFunctionValue();

    AST::FunctionDeclaration *ast() const;

    virtual const Value *returnValue() const;
    virtual int argumentCount() const;
    virtual const Value *argument(int) const;
    virtual QString argumentName(int index) const;
    virtual bool isVariadic() const;
};



660
661
662
} } // end of namespace QmlJS::Interpreter

#endif // QMLJS_INTERPRETER_H