wayland_extensions.h

Go to the documentation of this file.

/*
 * Copyright © 2018-2019 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 or 3 as
 * published by the Free Software Foundation.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Alan Griffiths <alan@octopull.co.uk>
 */

#ifndef MIRAL_WAYLAND_EXTENSIONS_H
#define MIRAL_WAYLAND_EXTENSIONS_H

#include "application.h"

#include <functional>
#include <memory>
#include <string>

struct wl_display;
struct wl_client;
struct wl_resource;

namespace mir { class Server; }

namespace miral
{
class Window;

class WaylandExtensions
{
public:
    WaylandExtensions();

    explicit WaylandExtensions(std::string const& default_value);

    void operator()(mir::Server& server) const;

    auto supported_extensions() const -> std::string;

    static auto recommended_extensions() -> std::string;

    ~WaylandExtensions();
    WaylandExtensions(WaylandExtensions const&);
    auto operator=(WaylandExtensions const&) -> WaylandExtensions&;

    class Context
    {
    public:
        virtual auto display() const -> wl_display* = 0;
        virtual void run_on_wayland_mainloop(std::function<void()>&& work) const = 0;

    protected:
        Context() = default;
        virtual ~Context() = default;
        Context(Context const&) = delete;
        Context& operator=(Context const&) = delete;
    };

    struct Builder
    {
        std::string name;

        std::function<std::shared_ptr<void>(Context const* context)> build;
    };

    using Filter = std::function<bool(Application const& app, char const* protocol)>;

    void set_filter(Filter const& extension_filter);

    void add_extension(Builder const& builder);

    void add_extension_disabled_by_default(Builder const& builder);

private:
    struct Self;
    std::shared_ptr<Self> self;
};

auto application_for(wl_client* client) -> Application;

auto application_for(wl_resource* resource) -> Application;

auto window_for(wl_resource* surface) -> Window;
}

#endif //MIRAL_WAYLAND_EXTENSIONS_H