/*

 *  Copyright (C) 1999 Harri Porten (porten@kde.org)

 *  Copyright (C) 2001 Peter Kelly (pmk@post.com)

 *  Copyright (C) 2008 Apple Inc. All rights reserved.

 *  Copyright (C) 2008 Eric Seidel <eric@webkit.org>

 *

 *  This library is free software; you can redistribute it and/or

 *  modify it under the terms of the GNU Lesser 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

 *  Lesser General Public License for more details.

 *

 *  You should have received a copy of the GNU Lesser General Public

 *  License along with this library; if not, write to the Free Software

 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

 */

#ifndef ScriptController_h

#define ScriptController_h

#include "JSDOMWindowShell.h"

#include "ScriptControllerBase.h"

#include "ScriptInstance.h"

#include <runtime/Protect.h>

#include <wtf/RefPtr.h>

#if PLATFORM(MAC)

#include <wtf/RetainPtr.h>

#ifdef __OBJC__

@class WebScriptObject;

#else

class WebScriptObject;

#endif

#endif

struct NPObject;

namespace JSC {

    class JSGlobalObject;

    namespace Bindings {

        class RootObject;

    }

}

namespace WebCore {

class Event;

class EventListener;

class HTMLPlugInElement;

class Frame;

class Node;

class ScriptSourceCode;

class ScriptValue;

class String;

class Widget;

class XSSAuditor;

typedef HashMap<void*, RefPtr<JSC::Bindings::RootObject> > RootObjectMap;

class ScriptController {

    friend class ScriptCachedFrameData;

    typedef WTF::HashMap< RefPtr<DOMWrapperWorld>, JSC::ProtectedPtr<JSDOMWindowShell> > ShellMap;

public:

    ScriptController(Frame*);

    ~ScriptController();

    static PassRefPtr<DOMWrapperWorld> createWorld();

    JSDOMWindowShell* createWindowShell(DOMWrapperWorld*);

    void destroyWindowShell(DOMWrapperWorld*);

    JSDOMWindowShell* windowShell(DOMWrapperWorld* world)

    {

        ShellMap::iterator iter = m_windowShells.find(world);

        return (iter != m_windowShells.end()) ? iter->second.get() : initScript(world);

    }

    JSDOMWindowShell* existingWindowShell(DOMWrapperWorld* world) const

    {

        ShellMap::const_iterator iter = m_windowShells.find(world);

        return (iter != m_windowShells.end()) ? iter->second.get() : 0;

    }

    JSDOMWindow* globalObject(DOMWrapperWorld* world)

    {

        return windowShell(world)->window();

    }

    static void getAllWorlds(Vector<DOMWrapperWorld*>&);

    ScriptValue executeScript(const ScriptSourceCode&, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);

    ScriptValue executeScript(const String& script, bool forceUserGesture = false, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);

    ScriptValue executeScriptInWorld(DOMWrapperWorld* world, const String& script, bool forceUserGesture = false, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);

    // Returns true if argument is a JavaScript URL.

    bool executeIfJavaScriptURL(const KURL&, bool userGesture = false, ShouldReplaceDocumentIfJavaScriptURL shouldReplaceDocumentIfJavaScriptURL = ReplaceDocumentIfJavaScriptURL);

    // This function must be called from the main thread. It is safe to call it repeatedly.

    // Darwin is an exception to this rule: it is OK to call this function from any thread, even reentrantly.

    static void initializeThreading();

    ScriptValue evaluate(const ScriptSourceCode&, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);

    ScriptValue evaluateInWorld(const ScriptSourceCode&, DOMWrapperWorld*, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);

    int eventHandlerLineNumber() const;

    void setProcessingTimerCallback(bool b) { m_processingTimerCallback = b; }

    bool processingUserGesture(DOMWrapperWorld*) const;

    bool anyPageIsProcessingUserGesture() const;

    static bool canAccessFromCurrentOrigin(Frame*);

    bool canExecuteScripts(ReasonForCallingCanExecuteScripts);

    // Debugger can be 0 to detach any existing Debugger.

    void attachDebugger(JSC::Debugger*); // Attaches/detaches in all worlds/window shells.

    void attachDebugger(JSDOMWindowShell*, JSC::Debugger*);

    void setPaused(bool b) { m_paused = b; }

    bool isPaused() const { return m_paused; }

    void setAllowPopupsFromPlugin(bool allowPopupsFromPlugin) { m_allowPopupsFromPlugin = allowPopupsFromPlugin; }

    bool allowPopupsFromPlugin() const { return m_allowPopupsFromPlugin; }

    const String* sourceURL() const { return m_sourceURL; } // 0 if we are not evaluating any script

    void clearWindowShell(bool goingIntoPageCache = false);

    void updateDocument();

    void namedItemAdded(HTMLDocument*, const AtomicString&) { }

    void namedItemRemoved(HTMLDocument*, const AtomicString&) { }

    // Notifies the ScriptController that the securityOrigin of the current

    // document was modified.  For example, this method is called when

    // document.domain is set.  This method is *not* called when a new document

    // is attached to a frame because updateDocument() is called instead.

    void updateSecurityOrigin();

    void clearScriptObjects();

    void cleanupScriptObjectsForPlugin(void*);

    void updatePlatformScriptObjects();

    PassScriptInstance createScriptInstanceForWidget(Widget*);

    JSC::Bindings::RootObject* bindingRootObject();

    JSC::Bindings::RootObject* cacheableBindingRootObject();

    PassRefPtr<JSC::Bindings::RootObject> createRootObject(void* nativeHandle);

#if ENABLE(INSPECTOR)

    static void setCaptureCallStackForUncaughtExceptions(bool);

#endif

#if PLATFORM(MAC)

#if ENABLE(JAVA_BRIDGE)

    static void initJavaJSBindings();

#endif

    WebScriptObject* windowScriptObject();

#endif

    JSC::JSObject* jsObjectForPluginElement(HTMLPlugInElement*);

#if ENABLE(NETSCAPE_PLUGIN_API)

    NPObject* createScriptObjectForPluginElement(HTMLPlugInElement*);

    NPObject* windowScriptNPObject();

#endif

    XSSAuditor* xssAuditor() { return m_XSSAuditor.get(); }

private:

    JSDOMWindowShell* initScript(DOMWrapperWorld* world);

    void disconnectPlatformScriptObjects();

    bool isJavaScriptAnchorNavigation() const;

    ShellMap m_windowShells;

    Frame* m_frame;

    const String* m_sourceURL;

    bool m_inExecuteScript;

    bool m_processingTimerCallback;

    bool m_paused;

    bool m_allowPopupsFromPlugin;

    // The root object used for objects bound outside the context of a plugin, such

    // as NPAPI plugins. The plugins using these objects prevent a page from being cached so they

    // are safe to invalidate() when WebKit navigates away from the page that contains them.

    RefPtr<JSC::Bindings::RootObject> m_bindingRootObject;

    // Unlike m_bindingRootObject these objects are used in pages that are cached, so they are not invalidate()'d.

    // This ensures they are still available when the page is restored.

    RefPtr<JSC::Bindings::RootObject> m_cacheableBindingRootObject;

    RootObjectMap m_rootObjects;

#if ENABLE(NETSCAPE_PLUGIN_API)

    NPObject* m_windowScriptNPObject;

#endif

#if PLATFORM(MAC)

    RetainPtr<WebScriptObject> m_windowScriptObject;

#endif

    // The XSSAuditor associated with this ScriptController.

    OwnPtr<XSSAuditor> m_XSSAuditor;

};

} // namespace WebCore

#endif // ScriptController_h