windowSystem.h

/* Copyright (c) 2006-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Daniel Pfeifer <daniel@pfeifer-mail.de>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * 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 EQ_WINDOWSYSTEM_H
#define EQ_WINDOWSYSTEM_H

#include <eq/api.h>
#include <eq/types.h>

namespace eq
{
class WindowSystemIF
{
public:
    virtual ~WindowSystemIF() {}
protected:
    WindowSystemIF() {}
    static uint32_t _setupLists(util::ObjectManager& gl, const void* key,
                                const int num);

    virtual std::string getName() const = 0;

    virtual SystemPipe* createPipe(Pipe* pipe) = 0;

    virtual MessagePump* createMessagePump() = 0;

    virtual SystemWindow* createWindow(Window* window,
                                       const WindowSettings& settings) = 0;

    virtual bool setupFont(util::ObjectManager& gl, const void* key,
                           const std::string& name,
                           const uint32_t size) const = 0;

    virtual void configInit(Node* /*node*/) {}
    virtual void configExit(Node* /*node*/) {}
    virtual bool hasMainThreadEvents() const { return false; }
private:
    friend class WindowSystem;
};

using WindowSystemImpl = std::shared_ptr<WindowSystemIF>;

class WindowSystem
{
public:
    EQ_API explicit WindowSystem(const std::string& name);

    static bool supports(const std::string& type);

    static void configInit(Node* node);
    static void configExit(Node* node);

    EQ_API std::string getName() const;

    EQ_API SystemWindow* createWindow(Window* window,
                                      const WindowSettings& settings);
    EQ_API SystemPipe* createPipe(Pipe* pipe);
    EQ_API MessagePump* createMessagePump();
    EQ_API bool setupFont(util::ObjectManager& gl, const void* key,
                          const std::string& name, const uint32_t size) const;
    EQ_API bool hasMainThreadEvents() const;

    EQ_API bool operator==(const WindowSystem& other) const;
    EQ_API bool operator!=(const WindowSystem& other) const;

    static void add(WindowSystemImpl impl);

    static void clear();

private:
    WindowSystem();
    WindowSystemImpl _impl;
    WindowSystemImpl _chooseImpl(const std::string& name);
};

EQ_API std::ostream& operator<<(std::ostream& os, const WindowSystem&);

EQ_API co::DataOStream& operator<<(co::DataOStream& os, const WindowSystem&);

EQ_API co::DataIStream& operator>>(co::DataIStream& is, WindowSystem& ws);

} // namespace eq

#endif // EQ_WINDOWSYSTEM_H