root/trunk/Implementations/Ivy/IvyWrapper.h

/*
 * Copyright (C) 2007 EDF.  All rights reserved.
 * Copyright (C) 2007 Julien Chaffraix <julien.chaffraix@gmail.com>. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of EDF nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY EDF AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL EDF OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef IvyWrapper_h
#define IvyWrapper_h

#include "config.h"

#include <map>

#include "IvyWrapMsgCb.h"
#include "IvyWrapAppCb.h"

namespace KJS {
    class IvyRequest;
}

/**
 * @brief Abstraction layer over Ivy
 *
 * This class handles all calls from the javascript interpreter and calls appropriate functions (mainly Ivy C++ ones).
 * The method names are inspired from Ivy ones.
 * @see Ivycpp.h for the library used
 */
class IvyWrapper: public Shared<IvyWrapper> {

public:

    /**
     * Ivy status internal values
     */
    enum IvyStatus {
        UNINITIALISED = 0,
        INITIALISED,
        READY,
        RUNNING
    };

    IvyWrapper(Frame *);
    ~IvyWrapper();

    void IvyInit();
    void IvyInit(KJS::UString, KJS::UString);

    void IvyStart();
    void IvyStart(KJS::UString);

    void IvyRun(KJS::ExecState*);

    void IvyStop();

    void IvyMsgSend(KJS::ExecState*, KJS::UString message);

    /**
     * @brief Add message listeners
     *
     * The callback is handled by an IvyWrapMsgCallback for each pair (regExp, scripCb)
     * @see class IvyWrapMsgCallback
     * @param regExp : regular expression to match
     * @param scriptCb : Javascrip method to callback
     * @return Javascript boolean :
     *  - true if the listener was added
     *  - false otherwise
     */
    KJS::JSValue* IvyMsgBind(KJS::ExecState*, KJS::UString regExp, KJS::JSValue* scriptCb);
    /**
     * @brief Remove a message listener
     * @param regExp : same as in IvyBindMsg
     * @param scriptCb : same as in IvyBindMsg
     * @return a Javascript boolean :
     * - true if a listener was removed
     * - false if it was not
     */
    KJS::JSValue* IvyMsgUnbind(KJS::ExecState*, KJS::UString regExp, KJS::JSValue* scriptCb);

    /**
     * @brief Sets the connection / disconnection listeners
     * If callBack is null, then it removes the previous registered callback function
     *
     * The callback is handled by an IvyWrapAppCb instance
     * @see class IvyWrapAppCb
     * @param callBack : Javascript callback method
     */
    void IvySetConnectListener(KJS::ExecState*, KJS::JSValue* callBack);
    void IvySetDisconnectListener(KJS::ExecState*, KJS::JSValue* callBack);

    /**
     * @brief Unbind all message listeners
     */
    void IvyMsgUnbindAll();

    /**
     * @brief Convert internal state to Javascript string
     */
    KJS::JSValue* IvyGetStatus();

protected:

    /**
     * @brief Ivy mainLoop start
     *
     * This method is just to have the necessary signature for pthread_create
     */
    static void* __mainStart(void* unused);

    /*
     * Internal comparision function for the map 
     */
    struct compareKJS {
        bool operator()(const KJS::UString& s1, const KJS::UString& s2) {
            return (s1 < s2);
        }
    };

    WebCore::Frame* m_frame;
    KJS::IvyRequest* m_ivyReq;
    Ivy* m_ivy;
    RefPtr<IvyWrapAppCb> m_wrapAppCb;
    pthread_t m_ivyThread;

    IvyStatus m_status;

    std::map <KJS::UString, RefPtr<IvyWrapMsgCb>, compareKJS>* m_msgListeners;
};

#endif // IvyWrapper_h