/*
 * Copyright © 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/>.
 */

#ifndef MIR_INPUT_VIRTUAL_INPUT_DEVICE_H_
#define MIR_INPUT_VIRTUAL_INPUT_DEVICE_H_

#include <mir/input/input_device.h>
#include <mir/input/input_device_info.h>
#include <mir/synchronised.h>

#include <functional>
#include <optional>

namespace mir
{
namespace input
{

/// A source of input events not backed by a physical device
class VirtualInputDevice : public InputDevice
{
public:
    VirtualInputDevice(std::string const& name, DeviceCapabilities capabilities);
    void if_started_then(std::function<void(InputSink*, EventBuilder*)> const& fn);

private:
    void start(InputSink* sink, EventBuilder* builder) override;
    void stop() override;
    auto get_device_info() -> InputDeviceInfo override { return info; }
    auto get_pointer_settings() const -> std::optional<PointerSettings> override;
    void apply_settings(PointerSettings const&) override {};
    auto get_touchpad_settings() const -> std::optional<TouchpadSettings> override;
    void apply_settings(TouchpadSettings const&) override {};
    auto get_touchscreen_settings() const -> std::optional<TouchscreenSettings> override;
    void apply_settings(TouchscreenSettings const&) override {};

    InputDeviceInfo const info;

    struct State
    {
        InputSink* sink;
        EventBuilder* builder;
    };

    Synchronised<std::optional<State>> state;
};

}
}

#endif // MIR_INPUT_VIRTUAL_INPUT_DEVICE_H_
