source: mainline/uspace/lib/input/include/io/kbd_event.h

/*
 * Copyright (c) 2024 Jiri Svoboda
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup libinput
 * @{
 */
/** @file
 */

#ifndef _LIBINPUT_IO_KBD_EVENT_H_
#define _LIBINPUT_IO_KBD_EVENT_H_

#include <inttypes.h>
#include <io/keycode.h>
#include <types/common.h>

typedef enum {
        KEY_PRESS,
        KEY_RELEASE
} kbd_event_type_t;

/** Console event structure. */
typedef struct {
        /** Keyboard device ID */
        sysarg_t kbd_id;

        /** Press or release event. */
        kbd_event_type_t type;

        /** Keycode of the key that was pressed or released. */
        keycode_t key;

        /** Bitmask of modifiers held. */
        keymod_t mods;

        /** The character that was generated or '\0' for none. */
        char32_t c;
} kbd_event_t;

#endif

/** @}
 */