Widget.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _WIDGET_H
#define _WIDGET_H

#ifdef TARGET_LINUX
#include <stdint.h>
#include <unistd.h>

#include <util.h>
#else
#include "pedigree/native/ipc/Ipc.h"
#include "pedigree/native/types.h"
#endif

#include "pedigree/native/graphics/Graphics.h"

#include <map>
#include <queue>
#include <string>

enum WidgetMessages
{
    RepaintNeeded,
    Reposition,
    MouseMove,
    MouseDown,
    MouseUp,
    KeyDown,
    KeyUp,
    RawKeyDown,
    RawKeyUp,
    Focus,
    NoFocus,
    Terminate,
};

typedef bool (*widgetCallback_t)(WidgetMessages, size_t, const void *);

class Widget
{
  public:
    Widget();
    virtual ~Widget();

    inline uint64_t getHandle() const
    {
        return m_Handle;
    }

    bool construct(
        const char *endpoint, const char *title, widgetCallback_t cb,
        PedigreeGraphics::Rect &dimensions);

    bool setTitle(const std::string &newTitle);

    virtual bool
    render(PedigreeGraphics::Rect &rt, PedigreeGraphics::Rect &dirty) = 0;

    bool redraw(PedigreeGraphics::Rect &rt);

    bool visibility(bool vis);

    void destroy();

    void *getRawFramebuffer()
    {
        return m_SharedFramebuffer ? m_SharedFramebuffer->getBuffer() : 0;
    }

    int getSocket() const
    {
        return m_Socket;
    }

    static void checkForEvents(bool bAsync = false);

  private:
    static void checkForMessage(size_t which, bool bResponse = false);

    static void handleMessage(const char *pMessageBuffer);

    static bool handlePendingMessages();

    widgetCallback_t getCallback() const
    {
        return m_EventCallback;
    }

    bool m_bConstructed;

    PedigreeGraphics::Framebuffer *m_pFramebuffer;

    uint64_t m_Handle;

    widgetCallback_t m_EventCallback;

    int m_Socket;

#ifdef TARGET_LINUX

    SharedBuffer *m_SharedFramebuffer;
#else

    PedigreeIpc::SharedIpcMessage *m_SharedFramebuffer;
#endif

    static std::map<uint64_t, Widget *> s_KnownWidgets;

    static std::queue<char *> s_PendingMessages;

    static size_t s_NumWidgets;
};

#endif