d1ea9832d2209384250cec65f20bc31a87b84489
[WebKit-https.git] / WebCore / khtml / ecma / kjs_proxy.cpp
1 // -*- c-basic-offset: 2 -*-
2 /*
3  *  This file is part of the KDE libraries
4  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
5  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
6  *
7  *  This library is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU Lesser General Public
9  *  License as published by the Free Software Foundation; either
10  *  version 2 of the License, or (at your option) any later version.
11  *
12  *  This library is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  Lesser General Public License for more details.
16  *
17  *  You should have received a copy of the GNU Lesser General Public
18  *  License along with this library; if not, write to the Free Software
19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 #include "kjs_proxy.h"
23
24 #include "kjs_window.h"
25 #include "kjs_events.h"
26 #include <khtml_part.h>
27 #include <kprotocolmanager.h>
28 #include <kdebug.h>
29 #include <kjs/collector.h>
30
31 using namespace KJS;
32
33 extern "C" {
34   KJSProxy *kjs_html_init(KHTMLPart *khtmlpart);
35 }
36
37 class KJSProxyImpl : public KJSProxy {
38 public:
39   KJSProxyImpl(KHTMLPart *part);
40   virtual ~KJSProxyImpl();
41   virtual QVariant evaluate(QString filename, int baseLine, const QString&str, const DOM::Node &n);
42   virtual void clear();
43   virtual DOM::EventListener *createHTMLEventHandler(QString sourceUrl, QString code);
44   virtual void finishedWithEvent(const DOM::Event &event);
45   virtual KJS::ScriptInterpreter *interpreter();
46
47   virtual void setDebugEnabled(bool enabled);
48   virtual bool paused() const;
49   virtual void setSourceFile(QString url, QString code);
50   virtual void appendSourceFile(QString url, QString code);
51
52   void initScript();
53
54 private:
55   KJS::ScriptInterpreter* m_script;
56   bool m_debugEnabled;
57 #ifndef NDEBUG
58   static int s_count;
59 #endif
60 };
61
62 #ifndef NDEBUG
63 int KJSProxyImpl::s_count = 0;
64 #endif
65
66 KJSProxyImpl::KJSProxyImpl(KHTMLPart *part)
67 {
68   m_script = 0;
69   m_part = part;
70   m_debugEnabled = false;
71 #ifndef NDEBUG
72   s_count++;
73 #endif
74 }
75
76 KJSProxyImpl::~KJSProxyImpl()
77 {
78   //kdDebug() << "KJSProxyImpl::~KJSProxyImpl deleting interpreter " << m_script << endl;
79   delete m_script;
80 #ifndef NDEBUG
81   s_count--;
82   // If it was the last interpreter, we should have nothing left
83 #ifdef KJS_DEBUG_MEM
84   if ( s_count == 0 )
85     Interpreter::finalCheck();
86 #endif
87 #endif
88 }
89
90 QVariant KJSProxyImpl::evaluate(QString filename, int baseLine,
91                                 const QString&str, const DOM::Node &n) {
92   // evaluate code. Returns the JS return value or an invalid QVariant
93   // if there was none, an error occured or the type couldn't be converted.
94
95   initScript();
96   // inlineCode is true for <a href="javascript:doSomething()">
97   // and false for <script>doSomething()</script>. Check if it has the
98   // expected value in all cases.
99   // See smart window.open policy for where this is used.
100   bool inlineCode = filename.isNull();
101   //kdDebug(6070) << "KJSProxyImpl::evaluate inlineCode=" << inlineCode << endl;
102
103 #ifdef KJS_DEBUGGER
104   // ###    KJSDebugWin::instance()->attach(m_script);
105   if (inlineCode)
106     filename = "(unknown file)";
107   if (KJSDebugWin::instance())
108     KJSDebugWin::instance()->setNextSourceInfo(filename,baseLine);
109   //    KJSDebugWin::instance()->setMode(KJS::Debugger::Step);
110 #else
111   Q_UNUSED(baseLine);
112 #endif
113
114   m_script->setInlineCode(inlineCode);
115   KJS::Value thisNode = n.isNull() ? Window::retrieve( m_part ) : getDOMNode(m_script->globalExec(),n);
116
117   UString code( str );
118   Completion comp = m_script->evaluate(filename, baseLine, code, thisNode);
119   bool success = ( comp.complType() == Normal ) || ( comp.complType() == ReturnValue );  
120 #ifdef KJS_DEBUGGER
121     //    KJSDebugWin::instance()->setCode(QString::null);
122 #endif
123
124   // let's try to convert the return value
125   if (success && !comp.value().isNull())
126     return ValueToVariant( m_script->globalExec(), comp.value());
127   else
128   {
129     if ( comp.complType() == Throw )
130     {
131         KJS::Interpreter::lock();
132         UString errorMessage = comp.value().toString(m_script->globalExec());
133         int lineNumber =  comp.value().toObject(m_script->globalExec()).get(m_script->globalExec(), "line").toInt32(m_script->globalExec());
134         UString sourceURL = comp.value().toObject(m_script->globalExec()).get(m_script->globalExec(), "sourceURL").toString(m_script->globalExec());
135         KJS::Interpreter::unlock();
136
137 #if APPLE_CHANGES
138         KWQ(m_part)->addMessageToConsole(errorMessage.qstring(), lineNumber, sourceURL.qstring());
139 #else
140         kdWarning(6070) << "Script threw exception: " << errorMessage.qstring() << endl;
141 #endif
142     }
143     return QVariant();
144   }
145 }
146
147 void KJSProxyImpl::clear() {
148   // clear resources allocated by the interpreter, and make it ready to be used by another page
149   // We have to keep it, so that the Window object for the part remains the same.
150   // (we used to delete and re-create it, previously)
151   if (m_script) {
152 #ifdef KJS_DEBUGGER
153     KJSDebugWin *debugWin = KJSDebugWin::instance();
154     if (debugWin && debugWin->currentScript() == m_script) {
155         debugWin->setMode(KJSDebugWin::Stop);
156 //        debugWin->leaveSession();
157     }
158 #endif
159     Window *win = Window::retrieveWindow(m_part);
160     if (win)
161         win->clear( m_script->globalExec() );
162   }
163 }
164
165 DOM::EventListener *KJSProxyImpl::createHTMLEventHandler(QString sourceUrl, QString code)
166 {
167 #ifdef KJS_DEBUGGER
168   if (KJSDebugWin::instance())
169     KJSDebugWin::instance()->setNextSourceInfo(sourceUrl,m_handlerLineno);
170 #else
171   Q_UNUSED(sourceUrl);
172 #endif
173
174   initScript();
175   return KJS::Window::retrieveWindow(m_part)->getJSLazyEventListener(code,true,m_handlerLineno);
176 }
177
178 void KJSProxyImpl::finishedWithEvent(const DOM::Event &event)
179 {
180   // This is called when the DOM implementation has finished with a particular event. This
181   // is the case in sitations where an event has been created just for temporary usage,
182   // e.g. an image load or mouse move. Once the event has been dispatched, it is forgotten
183   // by the DOM implementation and so does not need to be cached still by the interpreter
184   m_script->forgetDOMObject(event.handle());
185 }
186
187 KJS::ScriptInterpreter *KJSProxyImpl::interpreter()
188 {
189   if (!m_script)
190     initScript();
191   m_part->keepAlive();
192   return m_script;
193 }
194
195 void KJSProxyImpl::setDebugEnabled(bool enabled)
196 {
197 #ifdef KJS_DEBUGGER
198   m_debugEnabled = enabled;
199   if (m_script)
200       m_script->setDebuggingEnabled(enabled);
201   // NOTE: this is consistent across all KJSProxyImpl instances, as we only
202   // ever have 1 debug window
203   if (!enabled && KJSDebugWin::instance()) {
204     KJSDebugWin::destroyInstance();
205   }
206   else if (enabled && !KJSDebugWin::instance()) {
207     KJSDebugWin::createInstance();
208     initScript();
209     KJSDebugWin::instance()->attach(m_script);
210   }
211 #else
212   Q_UNUSED(enabled);
213 #endif
214 }
215
216 bool KJSProxyImpl::paused() const
217 {
218 #ifdef KJS_DEBUGGER
219   if (KJSDebugWin::instance())
220     return KJSDebugWin::instance()->inSession();
221 #endif
222   return false;
223 }
224
225 void KJSProxyImpl::setSourceFile(QString url, QString code)
226 {
227 #ifdef KJS_DEBUGGER
228   if (KJSDebugWin::instance())
229     KJSDebugWin::instance()->setSourceFile(url,code);
230 #else
231   Q_UNUSED(url);
232   Q_UNUSED(code);
233 #endif
234
235 }
236
237 void KJSProxyImpl::appendSourceFile(QString url, QString code)
238 {
239 #ifdef KJS_DEBUGGER
240   if (KJSDebugWin::instance())
241     KJSDebugWin::instance()->appendSourceFile(url,code);
242 #else
243   Q_UNUSED(url);
244   Q_UNUSED(code);
245 #endif
246 }
247
248 // Implementation of the debug() function
249 class TestFunctionImp : public ObjectImp {
250 public:
251   TestFunctionImp() : ObjectImp() {}
252   virtual bool implementsCall() const { return true; }
253   virtual Value call(ExecState *exec, Object &thisObj, const List &args);
254 };
255
256 Value TestFunctionImp::call(ExecState *exec, Object &/*thisObj*/, const List &args)
257 {
258   fprintf(stderr,"--> %s\n",args[0].toString(exec).ascii());
259   return Undefined();
260 }
261
262 void KJSProxyImpl::initScript()
263 {
264   if (m_script)
265     return;
266
267   // Build the global object - which is a Window instance
268   KJS::Interpreter::lock();
269   Object globalObject( new Window(m_part) );
270   KJS::Interpreter::unlock();
271
272   // Create a KJS interpreter for this part
273   m_script = new KJS::ScriptInterpreter(globalObject, m_part);
274
275 #ifdef KJS_DEBUGGER
276   m_script->setDebuggingEnabled(m_debugEnabled);
277 #endif
278   //m_script->enableDebug();
279   KJS::Interpreter::lock();
280   globalObject.put(m_script->globalExec(),
281                    "debug", Value(new TestFunctionImp()), Internal);
282   KJS::Interpreter::unlock();
283
284 #if APPLE_CHANGES
285   QString userAgent = KWQ(m_part)->userAgent();
286 #else
287   QString userAgent = KProtocolManager::userAgentForHost(m_part->url().host());
288 #endif
289   if (userAgent.find(QString::fromLatin1("Microsoft")) >= 0 ||
290       userAgent.find(QString::fromLatin1("MSIE")) >= 0)
291     m_script->setCompatMode(Interpreter::IECompat);
292   else
293     // If we find "Mozilla" but not "(compatible, ...)" we are a real Netscape
294     if (userAgent.find(QString::fromLatin1("Mozilla")) >= 0 &&
295         userAgent.find(QString::fromLatin1("compatible")) == -1)
296       m_script->setCompatMode(Interpreter::NetscapeCompat);
297 }
298
299 // Helper method, so that all classes which need jScript() don't need to be added
300 // as friend to KHTMLPart
301 KJSProxy * KJSProxy::proxy( KHTMLPart *part )
302 {
303     return part->jScript();
304 }
305
306 // initialize HTML module
307 KJSProxy *kjs_html_init(KHTMLPart *khtmlpart)
308 {
309   return new KJSProxyImpl(khtmlpart);
310 }