/*
 * Copyright 1995, 1999, 2000, 2001, 2002, 2004, 2005 by Paul Mattes.
 *  Permission to use, copy, modify, and distribute this software and its
 *  documentation for any purpose and without fee is hereby granted,
 *  provided that the above copyright notice appear in all copies and that
 *  both that copyright notice and this permission notice appear in
 *  supporting documentation.
 *
 * x3270, c3270, s3270 and tcl3270 are distributed in the hope that they will
 * be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the file LICENSE
 * for more details.
 */

/**
 *	@brief Global declarations for kybd.c.
 */

#ifndef KYBDC_H_INCLUDED

	#define KYBDC_H_INCLUDED
	#include <lib3270/keyboard.h>

	/// @brief Element in typeahead queue.
	struct ta
	{
		struct ta *next;

		enum _ta_type
		{
			TA_TYPE_DEFAULT,
			TA_TYPE_KEY_AID,
			TA_TYPE_ACTION,
			TA_TYPE_CURSOR_MOVE,
			TA_TYPE_USER
		} type;

		union
		{
			unsigned char aid_code;
			struct
			{
				void (*fn)(H3270 *, const char *, const char *);
				char *parm[2];
			} def;

			int (*action)(H3270 *);

			struct
			{
				LIB3270_DIRECTION direction;
				unsigned char sel;
				int (*fn)(H3270 *, LIB3270_DIRECTION, unsigned char);
			} move;

		} args;

	};

	#define KL_OERR_MASK		LIB3270_KL_OERR_MASK
	#define KL_OERR_PROTECTED	LIB3270_KL_OERR_PROTECTED
	#define KL_OERR_NUMERIC		LIB3270_KL_OERR_NUMERIC
	#define KL_OERR_OVERFLOW	LIB3270_KL_OERR_OVERFLOW
	#define KL_OERR_DBCS		LIB3270_KL_OERR_DBCS
	#define	KL_NOT_CONNECTED	LIB3270_KL_NOT_CONNECTED
	#define	KL_AWAITING_FIRST	LIB3270_KL_AWAITING_FIRST
	#define	KL_OIA_TWAIT		LIB3270_KL_OIA_TWAIT
	#define	KL_OIA_LOCKED		LIB3270_KL_OIA_LOCKED
	#define	KL_DEFERRED_UNLOCK	LIB3270_KL_DEFERRED_UNLOCK
	#define KL_ENTER_INHIBIT	LIB3270_KL_ENTER_INHIBIT
	#define KL_SCROLLED			LIB3270_KL_SCROLLED
	#define KL_OIA_MINUS		LIB3270_KL_OIA_MINUS

	#define KYBDLOCK_IS_OERR(hSession)	(hSession->kybdlock && !(hSession->kybdlock & ~KL_OERR_MASK))

	/* other functions */
	LIB3270_INTERNAL void add_xk(KeySym key, KeySym assoc);
	LIB3270_INTERNAL void clear_xks(void);
	LIB3270_INTERNAL void do_reset(H3270 *session, Boolean explicit);

	LIB3270_INTERNAL void lib3270_kybdlock_clear(H3270 *hSession, LIB3270_KEYBOARD_LOCK_STATE bits);

	LIB3270_INTERNAL void kybd_inhibit(H3270 *session, Boolean inhibit);
	LIB3270_INTERNAL int  kybd_prime(H3270 *hSession);
	LIB3270_INTERNAL void kybd_scroll_lock(Boolean lock);
	LIB3270_INTERNAL void kybd_connect(H3270 *session, int connected, void *dunno);
	LIB3270_INTERNAL void kybd_in3270(H3270 *session, int in3270, void *dunno);

	LIB3270_INTERNAL int			run_ta(H3270 *hSession);
	LIB3270_INTERNAL struct ta *	new_ta(H3270 *hSession, enum _ta_type type);

	/// @brief Put a lib3270 action on the typeahead queue.
	LIB3270_INTERNAL void			enq_action(H3270 *hSession, int (*fn)(H3270 *));

	/// @brief Put a typeahed action on the typeahead queue.
	LIB3270_INTERNAL void			enq_ta(H3270 *hSession, void (*fn)(H3270 *, const char *, const char *), const char *parm1, const char *parm2);

	/// @brief Lock the keyboard because of an operator error.
	LIB3270_INTERNAL void			operator_error(H3270 *hSession, int error_type);

#endif /* KYBDC_H_INCLUDED */