/*
 * Copyright © 2018 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 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: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
 */

#include "wl_keyboard.h"

#include "wayland_utils.h"
#include "wl_surface.h"

#include "mir/executor.h"
#include "mir/client/event.h"
#include "mir/anonymous_shm_file.h"
#include "mir/input/keymap.h"

#include <xkbcommon/xkbcommon.h>

#include <cstring> // memcpy

namespace mf = mir::frontend;

mf::WlKeyboard::WlKeyboard(
    wl_client* client,
    wl_resource* parent,
    uint32_t id,
    mir::input::Keymap const& initial_keymap,
    std::function<void(WlKeyboard*)> const& on_destroy,
    std::function<std::vector<uint32_t>()> const& acquire_current_keyboard_state)
    : Keyboard(client, parent, id),
      keymap{nullptr, &xkb_keymap_unref},
      state{nullptr, &xkb_state_unref},
      context{xkb_context_new(XKB_CONTEXT_NO_FLAGS), &xkb_context_unref},
      on_destroy{on_destroy},
      acquire_current_keyboard_state{acquire_current_keyboard_state}
{
    // TODO: We should really grab the keymap for the focused surface when
    // we receive focus.

    // TODO: Maintain per-device keymaps, and send the appropriate map before
    // sending an event from a keyboard with a different map.

    /* The wayland::Keyboard constructor has already run, creating the keyboard
     * resource. It is thus safe to send a keymap event to it; the client will receive
     * the keyboard object before this event.
     */
    set_keymap(initial_keymap);

    // I don't know where to get "real" rate and delay args. These are better than nothing.
    if (wl_resource_get_version(resource) >= WL_KEYBOARD_REPEAT_INFO_SINCE_VERSION)
        wl_keyboard_send_repeat_info(resource, 30, 200);
}

mf::WlKeyboard::~WlKeyboard()
{
    on_destroy(this);
}

void mf::WlKeyboard::handle_keyboard_event(MirKeyboardEvent const* key_event, WlSurface* /*surface*/)
{
    auto const input_ev = mir_keyboard_event_input_event(key_event);
    auto const ev = mir::client::Event{mir_event_ref(mir_input_event_get_event(input_ev))};
    auto const serial = wl_display_next_serial(wl_client_get_display(client));
    auto const scancode = mir_keyboard_event_scan_code(key_event);
    /*
     * HACK! Maintain our own XKB state, so we can serialise it for
     * wl_keyboard_send_modifiers
     */

    switch (mir_keyboard_event_action(key_event))
    {
        case mir_keyboard_action_up:
            xkb_state_update_key(state.get(), scancode + 8, XKB_KEY_UP);
            wl_keyboard_send_key(resource,
                serial,
                mir_input_event_get_event_time_ms(input_ev),
                mir_keyboard_event_scan_code(key_event),
                WL_KEYBOARD_KEY_STATE_RELEASED);
            break;
        case mir_keyboard_action_down:
            xkb_state_update_key(state.get(), scancode + 8, XKB_KEY_DOWN);
            wl_keyboard_send_key(resource,
                serial,
                mir_input_event_get_event_time_ms(input_ev),
                mir_keyboard_event_scan_code(key_event),
                WL_KEYBOARD_KEY_STATE_PRESSED);
            break;
        default:
            break;
    }
    update_modifier_state();
}

void mf::WlKeyboard::handle_window_event(MirWindowEvent const* event, WlSurface* surface)
{
    if (mir_window_event_get_attribute(event) == mir_window_attrib_focus)
    {
        auto const focussed = mir_window_event_get_attribute_value(event);
        auto const serial = wl_display_next_serial(wl_client_get_display(client));
        if (focussed)
        {
            /*
                * TODO:
                *  *) Send the surface's keymap here.
                */
            auto const keyboard_state = acquire_current_keyboard_state();

            wl_array key_state;
            wl_array_init(&key_state);

            auto* const array_storage = wl_array_add(
                &key_state,
                keyboard_state.size() * sizeof(decltype(keyboard_state)::value_type));
            if (!array_storage)
            {
                wl_resource_post_no_memory(resource);
                BOOST_THROW_EXCEPTION(std::bad_alloc());
            }
            std::memcpy(
                array_storage,
                keyboard_state.data(),
                keyboard_state.size() * sizeof(decltype(keyboard_state)::value_type));

            // Rebuild xkb state
            state = decltype(state)(xkb_state_new(keymap.get()), &xkb_state_unref);
            for (auto scancode : keyboard_state)
            {
                xkb_state_update_key(state.get(), scancode + 8, XKB_KEY_DOWN);
            }
            update_modifier_state();

            wl_keyboard_send_enter(resource, serial, surface->raw_resource(), &key_state);
            wl_array_release(&key_state);
        }
        else
        {
            wl_keyboard_send_leave(resource, serial, surface->raw_resource());
        }
    }
}

void mf::WlKeyboard::handle_keymap_event(MirKeymapEvent const* event, WlSurface* /*surface*/)
{
    char const* buffer;
    size_t length;

    mir_keymap_event_get_keymap_buffer(event, &buffer, &length);

    mir::AnonymousShmFile shm_buffer{length};
    memcpy(shm_buffer.base_ptr(), buffer, length);

    wl_keyboard_send_keymap(
        resource,
        WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,
        shm_buffer.fd(),
        length);

    keymap = decltype(keymap)(xkb_keymap_new_from_buffer(
        context.get(),
        buffer,
        length,
        XKB_KEYMAP_FORMAT_TEXT_V1,
        XKB_KEYMAP_COMPILE_NO_FLAGS),
        &xkb_keymap_unref);

    state = decltype(state)(xkb_state_new(keymap.get()), &xkb_state_unref);
}

void mf::WlKeyboard::set_keymap(mir::input::Keymap const& new_keymap)
{
    xkb_rule_names const names = {
        "evdev",
        new_keymap.model.c_str(),
        new_keymap.layout.c_str(),
        new_keymap.variant.c_str(),
        new_keymap.options.c_str()
    };
    keymap = decltype(keymap){
        xkb_keymap_new_from_names(
            context.get(),
            &names,
            XKB_KEYMAP_COMPILE_NO_FLAGS),
        &xkb_keymap_unref};

    // TODO: We might need to copy across the existing depressed keys?
    state = decltype(state)(xkb_state_new(keymap.get()), &xkb_state_unref);

    std::unique_ptr<char, void(*)(void*)> buffer{xkb_keymap_get_as_string(keymap.get(), XKB_KEYMAP_FORMAT_TEXT_V1), free};
    auto length = strlen(buffer.get());

    mir::AnonymousShmFile shm_buffer{length};
    memcpy(shm_buffer.base_ptr(), buffer.get(), length);

    wl_keyboard_send_keymap(
        resource,
        WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,
        shm_buffer.fd(),
        length);
}

void mf::WlKeyboard::update_modifier_state()
{
    // TODO?
    // assert_on_wayland_event_loop()

    auto new_depressed_mods = xkb_state_serialize_mods(
        state.get(),
        XKB_STATE_MODS_DEPRESSED);
    auto new_latched_mods = xkb_state_serialize_mods(
        state.get(),
        XKB_STATE_MODS_LATCHED);
    auto new_locked_mods = xkb_state_serialize_mods(
        state.get(),
        XKB_STATE_MODS_LOCKED);
    auto new_group = xkb_state_serialize_layout(
        state.get(),
        XKB_STATE_LAYOUT_EFFECTIVE);

    if ((new_depressed_mods != mods_depressed) ||
        (new_latched_mods != mods_latched) ||
        (new_locked_mods != mods_locked) ||
        (new_group != group))
    {
        mods_depressed = new_depressed_mods;
        mods_latched = new_latched_mods;
        mods_locked = new_locked_mods;
        group = new_group;

        wl_keyboard_send_modifiers(
            resource,
            wl_display_get_serial(wl_client_get_display(client)),
            mods_depressed,
            mods_latched,
            mods_locked,
            group);
    }
}

void mf::WlKeyboard::release()
{
    wl_resource_destroy(resource);
}
