Fix Qt build
[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 // Derived RuntimeObject
48 class QtRuntimeObject : public RuntimeObject {
49 public:
50     QtRuntimeObject(ExecState*, JSGlobalObject*, PassRefPtr<Instance>);
51
52     static const ClassInfo s_info;
53
54     virtual void markChildren(MarkStack& markStack)
55     {
56         RuntimeObject::markChildren(markStack);
57         QtInstance* instance = static_cast<QtInstance*>(getInternalInstance());
58         if (instance)
59             instance->markAggregate(markStack);
60     }
61
62     static Structure* createStructure(JSGlobalData& globalData, JSValue prototype)
63     {
64         return Structure::create(globalData, prototype, TypeInfo(ObjectType,  StructureFlags), AnonymousSlotCount, &s_info);
65     }
66
67 protected:
68     static const unsigned StructureFlags = RuntimeObject::StructureFlags | OverridesMarkChildren;
69 };
70
71 const ClassInfo QtRuntimeObject::s_info = { "QtRuntimeObject", &RuntimeObject::s_info, 0, 0 };
72
73 QtRuntimeObject::QtRuntimeObject(ExecState* exec, JSGlobalObject* globalObject, PassRefPtr<Instance> instance)
74     : RuntimeObject(exec, globalObject, WebCore::deprecatedGetDOMStructure<QtRuntimeObject>(exec), instance)
75 {
76 }
77
78 // QtInstance
79 QtInstance::QtInstance(QObject* o, PassRefPtr<RootObject> rootObject, QScriptEngine::ValueOwnership ownership)
80     : Instance(rootObject)
81     , m_class(0)
82     , m_object(o)
83     , m_hashkey(o)
84     , m_ownership(ownership)
85 {
86     // 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.
87     qRegisterMetaType<QWebElement>();
88 }
89
90 QtInstance::~QtInstance()
91 {
92     JSLock lock(SilenceAssertionsOnly);
93
94     cachedInstances.remove(m_hashkey);
95
96     // clean up (unprotect from gc) the JSValues we've created
97     m_methods.clear();
98
99     qDeleteAll(m_fields);
100     m_fields.clear();
101
102     if (m_object) {
103         switch (m_ownership) {
104         case QScriptEngine::QtOwnership:
105             break;
106         case QScriptEngine::AutoOwnership:
107             if (m_object->parent())
108                 break;
109             // fall through!
110         case QScriptEngine::ScriptOwnership:
111             delete m_object;
112             break;
113         }
114     }
115 }
116
117 PassRefPtr<QtInstance> QtInstance::getQtInstance(QObject* o, PassRefPtr<RootObject> rootObject, QScriptEngine::ValueOwnership ownership)
118 {
119     JSLock lock(SilenceAssertionsOnly);
120
121     foreach (QtInstance* instance, cachedInstances.values(o))
122         if (instance->rootObject() == rootObject) {
123             // The garbage collector removes instances, but it may happen that the wrapped
124             // QObject dies before the gc kicks in. To handle that case we have to do an additional
125             // check if to see if the instance's wrapped object is still alive. If it isn't, then
126             // we have to create a new wrapper.
127             if (!instance->getObject())
128                 cachedInstances.remove(instance->hashKey());
129             else
130                 return instance;
131         }
132
133     RefPtr<QtInstance> ret = QtInstance::create(o, rootObject, ownership);
134     cachedInstances.insert(o, ret.get());
135
136     return ret.release();
137 }
138
139 bool QtInstance::getOwnPropertySlot(JSObject* object, ExecState* exec, const Identifier& propertyName, PropertySlot& slot)
140 {
141     return object->JSObject::getOwnPropertySlot(exec, propertyName, slot);
142 }
143
144 void QtInstance::put(JSObject* object, ExecState* exec, const Identifier& propertyName, JSValue value, PutPropertySlot& slot)
145 {
146     object->JSObject::put(exec, propertyName, value, slot);
147 }
148
149 void QtInstance::removeCachedMethod(JSObject* method)
150 {
151     if (m_defaultMethod.get() == method)
152         m_defaultMethod.clear();
153
154     for (QHash<QByteArray, Strong<JSObject> >::Iterator it = m_methods.begin(),
155         end = m_methods.end(); it != end; ++it)
156         if (it.value().get() == method) {
157             m_methods.erase(it);
158             return;
159         }
160 }
161
162 QtInstance* QtInstance::getInstance(JSObject* object)
163 {
164     if (!object)
165         return 0;
166     if (!object->inherits(&QtRuntimeObject::s_info))
167         return 0;
168     return static_cast<QtInstance*>(static_cast<RuntimeObject*>(object)->getInternalInstance());
169 }
170
171 Class* QtInstance::getClass() const
172 {
173     if (!m_class) {
174         if (!m_object)
175             return 0;
176         m_class = QtClass::classForObject(m_object);
177     }
178     return m_class;
179 }
180
181 RuntimeObject* QtInstance::newRuntimeObject(ExecState* exec)
182 {
183     JSLock lock(SilenceAssertionsOnly);
184     m_methods.clear();
185     return new (exec) QtRuntimeObject(exec, exec->lexicalGlobalObject(), this);
186 }
187
188 void QtInstance::markAggregate(MarkStack& markStack)
189 {
190     if (m_defaultMethod)
191         markStack.append(&m_defaultMethod);
192 }
193
194 void QtInstance::begin()
195 {
196     // Do nothing.
197 }
198
199 void QtInstance::end()
200 {
201     // Do nothing.
202 }
203
204 void QtInstance::getPropertyNames(ExecState* exec, PropertyNameArray& array)
205 {
206     // This is the enumerable properties, so put:
207     // properties
208     // dynamic properties
209     // slots
210     QObject* obj = getObject();
211     if (obj) {
212         const QMetaObject* meta = obj->metaObject();
213
214         int i;
215         for (i = 0; i < meta->propertyCount(); i++) {
216             QMetaProperty prop = meta->property(i);
217             if (prop.isScriptable())
218                 array.add(Identifier(exec, prop.name()));
219         }
220
221 #ifndef QT_NO_PROPERTIES
222         QList<QByteArray> dynProps = obj->dynamicPropertyNames();
223         foreach (const QByteArray& ba, dynProps)
224             array.add(Identifier(exec, ba.constData()));
225 #endif
226
227         const int methodCount = meta->methodCount();
228         for (i = 0; i < methodCount; i++) {
229             QMetaMethod method = meta->method(i);
230             if (method.access() != QMetaMethod::Private)
231                 array.add(Identifier(exec, method.signature()));
232         }
233     }
234 }
235
236 JSValue QtInstance::getMethod(ExecState* exec, const Identifier& propertyName)
237 {
238     if (!getClass())
239         return jsNull();
240     MethodList methodList = m_class->methodsNamed(propertyName, this);
241     return new (exec) RuntimeMethod(exec, exec->lexicalGlobalObject(), WebCore::deprecatedGetDOMStructure<RuntimeMethod>(exec), propertyName, methodList);
242 }
243
244 JSValue QtInstance::invokeMethod(ExecState*, RuntimeMethod*)
245 {
246     // Implemented via fallbackMethod & QtRuntimeMetaMethod::callAsFunction
247     return jsUndefined();
248 }
249
250 JSValue QtInstance::defaultValue(ExecState* exec, PreferredPrimitiveType hint) const
251 {
252     if (hint == PreferString)
253         return stringValue(exec);
254     if (hint == PreferNumber)
255         return numberValue(exec);
256     return valueOf(exec);
257 }
258
259 JSValue QtInstance::stringValue(ExecState* exec) const
260 {
261     QObject* obj = getObject();
262     if (!obj)
263         return jsNull();
264
265     // Hmm.. see if there is a toString defined
266     QByteArray buf;
267     bool useDefault = true;
268     getClass();
269     if (m_class) {
270         // Cheat and don't use the full name resolution
271         int index = obj->metaObject()->indexOfMethod("toString()");
272         if (index >= 0) {
273             QMetaMethod m = obj->metaObject()->method(index);
274             // Check to see how much we can call it
275             if (m.access() != QMetaMethod::Private
276                 && m.methodType() != QMetaMethod::Signal
277                 && m.parameterTypes().isEmpty()) {
278                 const char* retsig = m.typeName();
279                 if (retsig && *retsig) {
280                     QVariant ret(QMetaType::type(retsig), (void*)0);
281                     void * qargs[1];
282                     qargs[0] = ret.data();
283
284                     if (QMetaObject::metacall(obj, QMetaObject::InvokeMetaMethod, index, qargs) < 0) {
285                         if (ret.isValid() && ret.canConvert(QVariant::String)) {
286                             buf = ret.toString().toLatin1().constData(); // ### Latin 1? Ascii?
287                             useDefault = false;
288                         }
289                     }
290                 }
291             }
292         }
293     }
294
295     if (useDefault) {
296         const QMetaObject* meta = obj ? obj->metaObject() : &QObject::staticMetaObject;
297         QString name = obj ? obj->objectName() : QString::fromUtf8("unnamed");
298         QString str = QString::fromUtf8("%0(name = \"%1\")")
299                       .arg(QLatin1String(meta->className())).arg(name);
300
301         buf = str.toLatin1();
302     }
303     return jsString(exec, buf.constData());
304 }
305
306 JSValue QtInstance::numberValue(ExecState*) const
307 {
308     return jsNumber(0);
309 }
310
311 JSValue QtInstance::booleanValue() const
312 {
313     // ECMA 9.2
314     return jsBoolean(getObject());
315 }
316
317 JSValue QtInstance::valueOf(ExecState* exec) const
318 {
319     return stringValue(exec);
320 }
321
322 // In qt_runtime.cpp
323 JSValue convertQVariantToValue(ExecState*, PassRefPtr<RootObject> root, const QVariant& variant);
324 QVariant convertValueToQVariant(ExecState*, JSValue, QMetaType::Type hint, int *distance);
325
326 QByteArray QtField::name() const
327 {
328     if (m_type == MetaProperty)
329         return m_property.name();
330     if (m_type == ChildObject && m_childObject)
331         return m_childObject->objectName().toLatin1();
332 #ifndef QT_NO_PROPERTIES
333     if (m_type == DynamicProperty)
334         return m_dynamicProperty;
335 #endif
336     return QByteArray(); // deleted child object
337 }
338
339 JSValue QtField::valueFromInstance(ExecState* exec, const Instance* inst) const
340 {
341     const QtInstance* instance = static_cast<const QtInstance*>(inst);
342     QObject* obj = instance->getObject();
343
344     if (obj) {
345         QVariant val;
346         if (m_type == MetaProperty) {
347             if (m_property.isReadable())
348                 val = m_property.read(obj);
349             else
350                 return jsUndefined();
351         } else if (m_type == ChildObject)
352             val = QVariant::fromValue((QObject*) m_childObject);
353 #ifndef QT_NO_PROPERTIES
354         else if (m_type == DynamicProperty)
355             val = obj->property(m_dynamicProperty);
356 #endif
357         return convertQVariantToValue(exec, inst->rootObject(), val);
358     }
359     QString msg = QString(QLatin1String("cannot access member `%1' of deleted QObject")).arg(QLatin1String(name()));
360     return throwError(exec, createError(exec, msg.toLatin1().constData()));
361 }
362
363 void QtField::setValueToInstance(ExecState* exec, const Instance* inst, JSValue aValue) const
364 {
365     if (m_type == ChildObject) // QtScript doesn't allow setting to a named child
366         return;
367
368     const QtInstance* instance = static_cast<const QtInstance*>(inst);
369     QObject* obj = instance->getObject();
370     if (obj) {
371         QMetaType::Type argtype = QMetaType::Void;
372         if (m_type == MetaProperty)
373             argtype = (QMetaType::Type) QMetaType::type(m_property.typeName());
374
375         // dynamic properties just get any QVariant
376         QVariant val = convertValueToQVariant(exec, aValue, argtype, 0);
377         if (m_type == MetaProperty) {
378             if (m_property.isWritable())
379                 m_property.write(obj, val);
380         }
381 #ifndef QT_NO_PROPERTIES
382         else if (m_type == DynamicProperty)
383             obj->setProperty(m_dynamicProperty.constData(), val);
384 #endif
385     } else {
386         QString msg = QString(QLatin1String("cannot access member `%1' of deleted QObject")).arg(QLatin1String(name()));
387         throwError(exec, createError(exec, msg.toLatin1().constData()));
388     }
389 }
390
391
392 }
393 }