/*
 * Saitek X52 Pro MFD & LED driver - Profile (button-to-keyboard mapping)
 *
 * Copyright (C) 2021 Nirenjan Krishnan (nirenjan@nirenjan.org)
 *
 * SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0
 */

#ifndef X52D_PROFILE_H
#define X52D_PROFILE_H

#include "libx52io.h"

/**
 * @file x52d_profile.h
 * @brief Profile loading and application: map joystick buttons to keyboard events
 */

#if defined(HAVE_EVDEV)

/**
 * @brief Initialize the profile module and load the active profile.
 *
 * Reads Profiles.Directory and Profiles.Profile from config, loads
 * the profile file, and resolves ShiftButton from the [Profile] section. If loading
 * fails, the profile is empty (no mappings).
 */
void x52d_profile_init(void);

/**
 * @brief Shut down the profile module and free resources.
 */
void x52d_profile_exit(void);

/**
 * @brief Return the profile display name from the loaded profile file.
 *
 * The name is set in the profile file with [Profile] Name = ...
 * @return The profile name, or NULL if none set or no profile loaded.
 *         Valid until x52d_profile_exit() or next x52d_profile_init().
 */
const char *x52d_profile_get_name(void);

/**
 * @brief Apply profile mappings to button state changes.
 *
 * Compares @a report with @a prev and emits keyboard events for any
 * button that has a mapping in the current (mode, shift) layer.
 * Single-key mappings: key down on press, key up on release.
 * Macro mappings: sequence of key down/up on button down only (queued
 * and emitted by a worker thread with a short delay between events).
 *
 * @param report Current joystick report.
 * @param prev   Previous report (for edge detection).
 */
void x52d_profile_apply(const libx52io_report *report,
                       const libx52io_report *prev);

/**
 * @brief Block until all queued macro key events have been emitted.
 *
 * Useful for tests or before switching profile so macros finish playing.
 */
void x52d_profile_macro_wait_drained(void);

/**
 * @brief Return the optional display name for the action bound to a button.
 *
 * Uses the same (mode, shift) layer and fallback as x52d_profile_apply().
 * The name is set in the profile with e.g. "key KEY_A name Yaw Left".
 *
 * @param report Current joystick report (for mode and shift).
 * @param btn    Button index.
 * @return The action name, or NULL if no mapping or no name set.
 *         Valid until x52d_profile_exit() or next x52d_profile_init().
 */
const char *x52d_profile_get_action_name(const libx52io_report *report,
                                         libx52io_button btn);

#else

static inline void x52d_profile_init(void) { (void)0; }
static inline void x52d_profile_exit(void) { (void)0; }
static inline const char *x52d_profile_get_name(void) { return NULL; }
static inline void x52d_profile_apply(const libx52io_report *report,
                                     const libx52io_report *prev) {
    (void)report;
    (void)prev;
}
static inline void x52d_profile_macro_wait_drained(void) { (void)0; }
static inline const char *x52d_profile_get_action_name(const libx52io_report *report,
                                                       libx52io_button btn) {
    (void)report;
    (void)btn;
    return NULL;
}

#endif /* HAVE_EVDEV */

#endif /* !defined X52D_PROFILE_H */