qulogic/libgnt

Fix arrow keys
fix-arrow-keys
2019-02-20, Petteri Pitkänen
7ac801527b0b
Fix arrow keys

The key-tree expects that for arrow keys the terminal transmits codes that
are defined in the terminfo database, but these codes are transmitted only
in application mode. To make the arrow key handling portable across
terminals, and to prevent the need for manually translating these codes, put
the terminal into application mode by calling ncurses keypad().

Fixes #12676.
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef GNT_BINDABLE_H
#define GNT_BINDABLE_H
/**
* SECTION:gntbindable
* @section_id: libgnt-gntbindable
* @short_description: <filename>gntbindable.h</filename>
* @title: Bindable
*/
#include <stdio.h>
#include <glib.h>
#include <glib-object.h>
#define GNT_TYPE_BINDABLE (gnt_bindable_get_type())
#define GNT_BINDABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_BINDABLE, GntBindable))
#define GNT_BINDABLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_BINDABLE, GntBindableClass))
#define GNT_IS_BINDABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_BINDABLE))
#define GNT_IS_BINDABLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_BINDABLE))
#define GNT_BINDABLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_BINDABLE, GntBindableClass))
#define GNTDEBUG
typedef struct _GntBindable GntBindable;
typedef struct _GntBindableClass GntBindableClass;
struct _GntBindable
{
GObject inherit;
};
struct _GntBindableClass
{
GObjectClass parent;
GHashTable *remaps; /* Key remaps */
GHashTable *actions; /* name -> Action */
GHashTable *bindings; /* key -> ActionParam */
GntBindable * help_window;
/*< private >*/
void (*gnt_reserved2)(void);
void (*gnt_reserved3)(void);
void (*gnt_reserved4)(void);
};
G_BEGIN_DECLS
GType gnt_bindable_get_type(void);
/******************/
/* Key Remaps */
/******************/
const char * gnt_bindable_remap_keys(GntBindable *bindable, const char *text);
/******************/
/* Bindable Actions */
/******************/
typedef gboolean (*GntBindableActionCallback) (GntBindable *bindable, GList *params);
typedef gboolean (*GntBindableActionCallbackNoParam)(GntBindable *bindable);
typedef struct _GntBindableAction GntBindableAction;
typedef struct _GntBindableActionParam GntBindableActionParam;
struct _GntBindableAction
{
char *name; /* The name of the action */
union {
GntBindableActionCallback action;
GntBindableActionCallbackNoParam action_noparam;
} u;
};
struct _GntBindableActionParam
{
GntBindableAction *action;
GList *list;
};
/*GntBindableAction *gnt_bindable_action_parse(const char *name);*/
/**
* gnt_bindable_action_free:
* @action: The bindable action.
*
* Free a bindable action.
*/
void gnt_bindable_action_free(GntBindableAction *action);
/**
* gnt_bindable_action_param_free:
* @param: The GntBindableActionParam to free.
*
* Free a GntBindableActionParam.
*/
void gnt_bindable_action_param_free(GntBindableActionParam *param);
/**
* gnt_bindable_class_register_action:
* @klass: The class the binding is for.
* @name: The name of the binding.
* @callback: (scope call): The callback for the binding.
* @trigger: The default trigger for the binding, or %NULL, followed by a
* %NULL-terminated list of default parameters.
*
* Register a bindable action for a class.
*/
void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...);
/**
* gnt_bindable_register_binding:
* @klass: The class the binding is for.
* @name: The name of the binding.
* @trigger: A new trigger for the binding, followed by a %NULL-terminated list of parameters for the callback.
*
* Register a key-binding to an existing action.
*/
void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...);
/**
* gnt_bindable_perform_action_key:
* @bindable: The bindable object.
* @keys: The key to trigger the action.
*
* Perform an action from a keybinding.
*
* Returns: %TRUE if the action was performed successfully, %FALSE otherwise.
*/
gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys);
/**
* gnt_bindable_check_key:
* @bindable: The bindable object.
* @keys: The key to check for.
*
* Discover if a key is bound.
*
* Returns: %TRUE if the the key has an action associated with it.
*/
gboolean gnt_bindable_check_key(GntBindable *bindable, const char *keys);
/**
* gnt_bindable_perform_action_named:
* @bindable: The bindable object.
* @name: The action to perform, followed by a %NULL-terminated list of parameters.
*
* Perform an action on a bindable object.
*
* Returns: %TRUE if the action was performed successfully, %FALSE otherwise.
*/
gboolean gnt_bindable_perform_action_named(GntBindable *bindable, const char *name, ...) G_GNUC_NULL_TERMINATED;
/**
* gnt_bindable_bindings_view:
* @bind: The object to list the bindings for.
*
* Returns a GntTree populated with "key" -> "binding" for the widget.
*
* Returns: (transfer full): The GntTree.
*/
GntBindable * gnt_bindable_bindings_view(GntBindable *bind);
/**
* gnt_bindable_build_help_window:
* @bindable: The object to list the bindings for.
*
* Builds a window that list the key bindings for a GntBindable object.
* From this window a user can select a listing to rebind a new key for the given action.
*
* Returns: %TRUE
*/
gboolean gnt_bindable_build_help_window(GntBindable *bindable);
G_END_DECLS
#endif /* GNT_BINDABLE_H */