An object's structure should reference the global object responsible for its creation
[WebKit-https.git] / Source / WebCore / bridge / qt / qt_instance.cpp
1 /*
2  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
3  *
4  *  This library is free software; you can redistribute it and/or
5  *  modify it under the terms of the GNU Lesser General Public
6  *  License as published by the Free Software Foundation; either
7  *  version 2 of the License, or (at your option) any later version.
8  *
9  *  This library is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  *  Lesser General Public License for more details.
13  *
14  *  You should have received a copy of the GNU Lesser General Public
15  *  License along with this library; if not, write to the Free Software
16  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17  *
18  */
19
20 #include "config.h"
21 #include "qt_instance.h"
22
23 #include "Error.h"
24 #include "JSDOMBinding.h"
25 #include "JSGlobalObject.h"
26 #include "JSLock.h"
27 #include "ObjectPrototype.h"
28 #include "PropertyNameArray.h"
29 #include "qt_class.h"
30 #include "qt_runtime.h"
31 #include "runtime_object.h"
32 #include "runtime/FunctionPrototype.h"
33
34 #include <qdebug.h>
35 #include <qhash.h>
36 #include <qmetaobject.h>
37 #include <qmetatype.h>
38 #include <qwebelement.h>
39
40 namespace JSC {
41 namespace Bindings {
42
43 // Cache QtInstances
44 typedef QMultiHash<void*, QtInstance*> QObjectInstanceMap;
45 static QObjectInstanceMap cachedInstances;
46
47 // Used for implementing '__qt_sender__'.
48 Q_GLOBAL_STATIC(QtInstance::QtSenderStack, senderStack)
49
50 // Derived RuntimeObject
51 class QtRuntimeObject : public RuntimeObject {
52 public:
53     typedef RuntimeObject Base;
54
55     static QtRuntimeObject* create(ExecState* exec, JSGlobalObject* globalObject, PassRefPtr<Instance> instance)
56     {
57         Structure* domStructure = WebCore::deprecatedGetDOMStructure<QtRuntimeObject>(exec);
58         return new (allocateCell<QtRuntimeObject>(*exec->heap())) QtRuntimeObject(exec, globalObject, domStructure, instance);
59     }
60     
61     static const ClassInfo s_info;
62
63     virtual void visitChildren(SlotVisitor& visitor)
64     {
65         RuntimeObject::visitChildren(visitor);
66         QtInstance* instance = static_cast<QtInstance*>(getInternalInstance());
67         if (instance)
68             instance->visitAggregate(visitor);
69     }
70
71     static Structure* createStructure(JSGlobalData& globalData, JSGlobalObject* globalObject, JSValue prototype)
72     {
73         return Structure::create(globalData, globalObject, prototype, TypeInfo(ObjectType,  StructureFlags), AnonymousSlotCount, &s_info);
74     }
75
76 protected:
77     static const unsigned StructureFlags = RuntimeObject::StructureFlags | OverridesVisitChildren;
78
79 private:
80     QtRuntimeObject(ExecState*, JSGlobalObject*, Structure*, PassRefPtr<Instance>);
81 };
82
83 const ClassInfo QtRuntimeObject::s_info = { "QtRuntimeObject", &RuntimeObject::s_info, 0, 0 };
84
85 QtRuntimeObject::QtRuntimeObject(ExecState* exec, JSGlobalObject* globalObject, Structure* structure, PassRefPtr<Instance> instance)
86     : RuntimeObject(exec, globalObject, structure, instance)
87 {
88 }
89
90 // QtInstance
91 QtInstance::QtInstance(QObject* o, PassRefPtr<RootObject> rootObject, QScriptEngine::ValueOwnership ownership)
92     : Instance(rootObject)
93     , m_class(0)
94     , m_object(o)
95     , m_hashkey(o)
96     , m_ownership(ownership)
97 {
98     // This is a good place to register Qt metatypes that are in the QtWebKit module, as this is class will initialize if we have a QObject bridge.
99     qRegisterMetaType<QWebElement>();
100 }
101
102 QtInstance::~QtInstance()
103 {
104     JSLock lock(SilenceAssertionsOnly);
105
106     cachedInstances.remove(m_hashkey);
107
108     // clean up (unprotect from gc) the JSValues we've created
109     m_methods.clear();
110
111     qDeleteAll(m_fields);
112     m_fields.clear();
113
114     if (m_object) {
115         switch (m_ownership) {
116         case QScriptEngine::QtOwnership:
117             break;
118         case QScriptEngine::AutoOwnership:
119             if (m_object->parent())
120                 break;
121             // fall through!
122         case QScriptEngine::ScriptOwnership:
123             delete m_object;
124             break;
125         }
126     }
127 }
128
129 PassRefPtr<QtInstance> QtInstance::getQtInstance(QObject* o, PassRefPtr<RootObject> rootObject, QScriptEngine::ValueOwnership ownership)
130 {
131     JSLock lock(SilenceAssertionsOnly);
132
133     foreach (QtInstance* instance, cachedInstances.values(o))
134         if (instance->rootObject() == rootObject) {
135             // The garbage collector removes instances, but it may happen that the wrapped
136             // QObject dies before the gc kicks in. To handle that case we have to do an additional
137             // check if to see if the instance's wrapped object is still alive. If it isn't, then
138             // we have to create a new wrapper.
139             if (!instance->getObject())
140                 cachedInstances.remove(instance->hashKey());
141             else
142                 return instance;
143         }
144
145     RefPtr<QtInstance> ret = QtInstance::create(o, rootObject, ownership);
146     cachedInstances.insert(o, ret.get());
147
148     return ret.release();
149 }
150
151 bool QtInstance::getOwnPropertySlot(JSObject* object, ExecState* exec, const Identifier& propertyName, PropertySlot& slot)
152 {
153     return object->JSObject::getOwnPropertySlot(exec, propertyName, slot);
154 }
155
156 void QtInstance::put(JSObject* object, ExecState* exec, const Identifier& propertyName, JSValue value, PutPropertySlot& slot)
157 {
158     object->JSObject::put(exec, propertyName, value, slot);
159 }
160
161 void QtInstance::removeCachedMethod(JSObject* method)
162 {
163     for (QHash<QByteArray, WriteBarrier<JSObject> >::Iterator it = m_methods.begin(), end = m_methods.end(); it != end; ++it) {
164         if (it.value().get() == method) {
165             m_methods.erase(it);
166             return;
167         }
168     }
169 }
170
171 QtInstance* QtInstance::getInstance(JSObject* object)
172 {
173     if (!object)
174         return 0;
175     if (!object->inherits(&QtRuntimeObject::s_info))
176         return 0;
177     return static_cast<QtInstance*>(static_cast<RuntimeObject*>(object)->getInternalInstance());
178 }
179
180 Class* QtInstance::getClass() const
181 {
182     if (!m_class) {
183         if (!m_object)
184             return 0;
185         m_class = QtClass::classForObject(m_object);
186     }
187     return m_class;
188 }
189
190 RuntimeObject* QtInstance::newRuntimeObject(ExecState* exec)
191 {
192     JSLock lock(SilenceAssertionsOnly);
193     m_methods.clear();
194     return QtRuntimeObject::create(exec, exec->lexicalGlobalObject(), this);
195 }
196
197 void QtInstance::visitAggregate(SlotVisitor& visitor)
198 {
199     for (QHash<QByteArray, WriteBarrier<JSObject> >::Iterator it = m_methods.begin(), end = m_methods.end(); it != end; ++it)
200         visitor.append(&it.value());
201 }
202
203 void QtInstance::begin()
204 {
205     // Do nothing.
206 }
207
208 void QtInstance::end()
209 {
210     // Do nothing.
211 }
212
213 void QtInstance::getPropertyNames(ExecState* exec, PropertyNameArray& array)
214 {
215     // This is the enumerable properties, so put:
216     // properties
217     // dynamic properties
218     // slots
219     QObject* obj = getObject();
220     if (obj) {
221         const QMetaObject* meta = obj->metaObject();
222
223         int i;
224         for (i = 0; i < meta->propertyCount(); i++) {
225             QMetaProperty prop = meta->property(i);
226             if (prop.isScriptable())
227                 array.add(Identifier(exec, prop.name()));
228         }
229
230 #ifndef QT_NO_PROPERTIES
231         QList<QByteArray> dynProps = obj->dynamicPropertyNames();
232         foreach (const QByteArray& ba, dynProps)
233             array.add(Identifier(exec, ba.constData()));
234 #endif
235
236         const int methodCount = meta->methodCount();
237         for (i = 0; i < methodCount; i++) {
238             QMetaMethod method = meta->method(i);
239             if (method.access() != QMetaMethod::Private)
240                 array.add(Identifier(exec, method.signature()));
241         }
242     }
243 }
244
245 JSValue QtInstance::getMethod(ExecState* exec, const Identifier& propertyName)
246 {
247     if (!getClass())
248         return jsNull();
249     MethodList methodList = m_class->methodsNamed(propertyName, this);
250     return RuntimeMethod::create(exec, exec->lexicalGlobalObject(), WebCore::deprecatedGetDOMStructure<RuntimeMethod>(exec), propertyName, methodList);
251 }
252
253 JSValue QtInstance::invokeMethod(ExecState*, RuntimeMethod*)
254 {
255     // Implemented via fallbackMethod & QtRuntimeMetaMethod::callAsFunction
256     return jsUndefined();
257 }
258
259 JSValue QtInstance::defaultValue(ExecState* exec, PreferredPrimitiveType hint) const
260 {
261     if (hint == PreferString)
262         return stringValue(exec);
263     if (hint == PreferNumber)
264         return numberValue(exec);
265     return valueOf(exec);
266 }
267
268 JSValue QtInstance::stringValue(ExecState* exec) const
269 {
270     QObject* obj = getObject();
271     if (!obj)
272         return jsNull();
273
274     // Hmm.. see if there is a toString defined
275     QByteArray buf;
276     bool useDefault = true;
277     getClass();
278     if (m_class) {
279         // Cheat and don't use the full name resolution
280         int index = obj->metaObject()->indexOfMethod("toString()");
281         if (index >= 0) {
282             QMetaMethod m = obj->metaObject()->method(index);
283             // Check to see how much we can call it
284             if (m.access() != QMetaMethod::Private
285                 && m.methodType() != QMetaMethod::Signal
286                 && m.parameterTypes().isEmpty()) {
287                 const char* retsig = m.typeName();
288                 if (retsig && *retsig) {
289                     QVariant ret(QMetaType::type(retsig), (void*)0);
290                     void * qargs[1];
291                     qargs[0] = ret.data();
292
293                     if (QMetaObject::metacall(obj, QMetaObject::InvokeMetaMethod, index, qargs) < 0) {
294                         if (ret.isValid() && ret.canConvert(QVariant::String)) {
295                             buf = ret.toString().toLatin1().constData(); // ### Latin 1? Ascii?
296                             useDefault = false;
297                         }
298                     }
299                 }
300             }
301         }
302     }
303
304     if (useDefault) {
305         const QMetaObject* meta = obj ? obj->metaObject() : &QObject::staticMetaObject;
306         QString name = obj ? obj->objectName() : QString::fromUtf8("unnamed");
307         QString str = QString::fromUtf8("%0(name = \"%1\")")
308                       .arg(QLatin1String(meta->className())).arg(name);
309
310         buf = str.toLatin1();
311     }
312     return jsString(exec, buf.constData());
313 }
314
315 JSValue QtInstance::numberValue(ExecState*) const
316 {
317     return jsNumber(0);
318 }
319
320 JSValue QtInstance::booleanValue() const
321 {
322     // ECMA 9.2
323     return jsBoolean(getObject());
324 }
325
326 JSValue QtInstance::valueOf(ExecState* exec) const
327 {
328     return stringValue(exec);
329 }
330
331 QtInstance::QtSenderStack* QtInstance::qtSenderStack()
332 {
333     return senderStack();
334 }
335
336 // In qt_runtime.cpp
337 JSValue convertQVariantToValue(ExecState*, PassRefPtr<RootObject> root, const QVariant& variant);
338 QVariant convertValueToQVariant(ExecState*, JSValue, QMetaType::Type hint, int *distance);
339
340 QByteArray QtField::name() const
341 {
342     if (m_type == MetaProperty)
343         return m_property.name();
344     if (m_type == ChildObject && m_childObject)
345         return m_childObject->objectName().toLatin1();
346 #ifndef QT_NO_PROPERTIES
347     if (m_type == DynamicProperty)
348         return m_dynamicProperty;
349 #endif
350     return QByteArray(); // deleted child object
351 }
352
353 JSValue QtField::valueFromInstance(ExecState* exec, const Instance* inst) const
354 {
355     const QtInstance* instance = static_cast<const QtInstance*>(inst);
356     QObject* obj = instance->getObject();
357
358     if (obj) {
359         QVariant val;
360         if (m_type == MetaProperty) {
361             if (m_property.isReadable())
362                 val = m_property.read(obj);
363             else
364                 return jsUndefined();
365         } else if (m_type == ChildObject)
366             val = QVariant::fromValue((QObject*) m_childObject);
367 #ifndef QT_NO_PROPERTIES
368         else if (m_type == DynamicProperty)
369             val = obj->property(m_dynamicProperty);
370 #endif
371         return convertQVariantToValue(exec, inst->rootObject(), val);
372     }
373     QString msg = QString(QLatin1String("cannot access member `%1' of deleted QObject")).arg(QLatin1String(name()));
374     return throwError(exec, createError(exec, msg.toLatin1().constData()));
375 }
376
377 void QtField::setValueToInstance(ExecState* exec, const Instance* inst, JSValue aValue) const
378 {
379     if (m_type == ChildObject) // QtScript doesn't allow setting to a named child
380         return;
381
382     const QtInstance* instance = static_cast<const QtInstance*>(inst);
383     QObject* obj = instance->getObject();
384     if (obj) {
385         QMetaType::Type argtype = QMetaType::Void;
386         if (m_type == MetaProperty)
387             argtype = (QMetaType::Type) QMetaType::type(m_property.typeName());
388
389         // dynamic properties just get any QVariant
390         QVariant val = convertValueToQVariant(exec, aValue, argtype, 0);
391         if (m_type == MetaProperty) {
392             if (m_property.isWritable())
393                 m_property.write(obj, val);
394         }
395 #ifndef QT_NO_PROPERTIES
396         else if (m_type == DynamicProperty)
397             obj->setProperty(m_dynamicProperty.constData(), val);
398 #endif
399     } else {
400         QString msg = QString(QLatin1String("cannot access member `%1' of deleted QObject")).arg(QLatin1String(name()));
401         throwError(exec, createError(exec, msg.toLatin1().constData()));
402     }
403 }
404
405
406 }
407 }