src/libkeymap/contextP.h - master - niceSOFT/kbd

src/libkeymap/contextP.h
157 строк3 KB
Alexey Gladkov
libkeymap: make kernel-facing code unit-testable
15 мар 2026, 17:43
15 мар 2026, 17:43827cfea
#ifndef LK_CONTEXTP_H
#define LK_CONTEXTP_H

#include <stdint.h>
#include <stdarg.h>
#include <sys/ioctl.h>
#include <kbdfile.h>

/*
 * NLS -- the library has to be independent on main program, so define
 * KBD_TEXTDOMAIN_EXPLICIT before you include nls.h.
 *
 * Now we use kbd.po (=PACKAGE), rather than maintain the texts
 * in the separate libkeymap.po file.
 */
#define LIBKEYMAP_TEXTDOMAIN	PACKAGE
#define KBD_TEXTDOMAIN_EXPLICIT	LIBKEYMAP_TEXTDOMAIN
#include "nls.h"

#include "keymap.h"

/**
 * @brief The first 128 code points of Unicode are the same as ASCII.
 */
#define UNICODE_ASCII_LEN 128

#define UNICODE_MASK 0xf000
#define U(x) ((x) ^ UNICODE_MASK)

/**
 * @brief The maximum number of include levels.
 */
#define MAX_INCLUDE_DEPTH 20

/**
 * @brief Opaque object representing the library context.
 */
struct lk_ops {
	int (*ioctl_fn)(int fd, unsigned long req, uintptr_t arg);
};

struct lk_ctx {
	/**
	 * Parser flags that are set outside the library.
	 */
	lk_flags flags;

	/**
	 * Keywords used in keymap files.
	 */
	lk_keywords keywords;

	/**
	 * Key translation table (keycode to action code).
	 */
	struct lk_array *keymap;

	/**
	 * Function key string entry.
	 */
	struct lk_array *func_table;

	/**
	 * Accent table.
	 */
	struct lk_array *accent_table;

	/**
	 * Context for libkbdfile.
	 */
	struct kbdfile_ctx *kbdfile_ctx;

	/**
	 * User defined logging function.
	 */
	lk_logger_t log_fn;

	struct lk_ops ops;

	/**
	 * The data passed to the @ref log_fn logging function as the first argument.
	 */
	void *log_data;

	/**
	 * Logging priority used by @ref log_fn logging function.
	 */
	int log_priority;

	/**
	 * User defined charset.
	 */
	unsigned short charset;

	/* Fields used by keymap parser */

	struct lk_array *key_constant;
	struct lk_array *key_line;
	int mod;
	struct kbdfile *stack[MAX_INCLUDE_DEPTH];
};

int lk_default_ioctl(int fd, unsigned long req, uintptr_t arg);

static inline int
lk_ioctl_ptr(struct lk_ctx *ctx, int fd, unsigned long req, void *arg)
{
	return ctx->ops.ioctl_fn(fd, req, (uintptr_t)arg);
}

static inline int
lk_ioctl_int(struct lk_ctx *ctx, int fd, unsigned long req, int arg)
{
	return ctx->ops.ioctl_fn(fd, req, (uintptr_t)arg);
}

static inline void
lk_set_ops(struct lk_ctx *ctx, const struct lk_ops *ops)
{
	ctx->ops = *ops;
}

#define lk_log_cond(ctx, level, arg...)                                          \
	do {                                                                     \
		if (ctx->log_priority >= level)                                  \
			lk_log(ctx, level, __FILE__, __LINE__, __func__, ##arg); \
	} while (0)

/**
 * Wrapper to output debug-level messages
 * @param ctx is a keymap library context.
 * @param arg is output message.
 */
#define DBG(ctx, arg...) lk_log_cond(ctx, LOG_DEBUG, ##arg)

/**
 * Wrapper to output informational messages
 * @param ctx is a keymap library context.
 * @param arg is output message.
 */
#define INFO(ctx, arg...) lk_log_cond(ctx, LOG_INFO, ##arg)

/**
 * Wrapper to output warning conditions
 * @param ctx is a keymap library context.
 * @param arg is output message.
 */
#define WARN(ctx, arg...) lk_log_cond(ctx, LOG_WARNING, ##arg)

/**
 * Wrapper to output error conditions
 * @param ctx is a keymap library context.
 * @param arg is output message.
 */
#define ERR(ctx, arg...) lk_log_cond(ctx, LOG_ERR, ##arg)

#endif /* LK_CONTEXTP_H */