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
|
/*
* This file is part of the KDE libraries
* Copyright (C) 2008 Harri Porten (porten@kde.org)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef KJSPROTOTYPE_H
#define KJSPROTOTYPE_H
#include "kjsapi_export.h"
#include "kjscontext.h"
class KJSInterpreter;
class KJSArguments;
class KJSGlobalObject;
class KJSPrototypeHandle;
/**
* A class representing a JavaScript prototype object.
*
* @short Prototype object.
*/
class KJSAPI_EXPORT KJSPrototype
{
public:
/**
* Constructs a prototype object with its own prototype property
* set to the Object prototype.
*/
KJSPrototype();
/**
* Destructs this prototype object.
*/
~KJSPrototype();
/**
* Add a read-only numerical property to this object.
*/
void defineConstant(const QString& name, double value);
/**
* Add a read-only string property to this object.
*
* @overload
*/
void defineConstant(const QString& name, const QString& value);
/**
* Add a read-only object property to this object.
*
* @overload
*/
void defineConstant(const QString& name, const KJSObject& value);
/**
* Function signature for a property getter function. Describes
* one of the defineProperty() argument types.
*/
typedef KJSObject (*PropertyGetter)(KJSContext* context, void* object);
/**
* Function signature for a property setter function. Describes
* one of the defineProperty() argument types.
*/
typedef void (*PropertySetter)(KJSContext* context, void* object,
KJSObject value);
/**
* Defines a property of this prototype with C++ callback
* functions for getting and setting the property value. If the
* setter is set to 0 then the property is treated as read-only.
*/
void defineProperty(KJSContext* ctx,
const QString& name,
PropertyGetter getter,
PropertySetter setter = 0);
/**
* Signature for function call callback function. The
* defineFunction() function parameter accepts a reference to a
* function of this type as a parameter.
*/
typedef KJSObject (*FunctionCall)(KJSContext* context, void* object,
const KJSArguments& arguments);
/**
* Define a function. The specified C++ callback function will
* be called upon invocation.
*/
void defineFunction(KJSContext* ctx,
const QString& name, FunctionCall callback);
#if 0
/**
* Define a finalization function.
*
*/
void defineFinalization(FinalizeFunction callback);
#endif
/**
* Construct an object with this prototype and the specified
* internal value. The value pointer will be passed as the object
* parameter to the callbacks defined via defineProperty() and
* defineFunction().
*
* @todo Provide a better type than void*
*/
KJSObject constructObject(KJSContext* ctx, void *internalValue = 0);
/**
* Similar to constructObject() but specialized on the
* construction of global objects.
*/
KJSGlobalObject constructGlobalObject(void *internalValue = 0);
private:
KJSPrototype(const KJSPrototype&); // undefined
KJSPrototype& operator=(const KJSPrototype&); // undefined
KJSPrototypeHandle* hnd;
};
#endif
|
