[deliverable/binutils-gdb.git] / readline / keymaps.h

/* keymaps.h -- Manipulation of readline keymaps. */

/* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.

   This file is part of the GNU Readline Library, a library for
   reading lines of text with interactive input and history editing.

   The GNU Readline 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 1, or
   (at your option) any later version.

   The GNU Readline Library 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.

   The GNU General Public License is often shipped with GNU software, and
   is generally kept in a file called COPYING or LICENSE.  If you do not
   have a copy of the license, write to the Free Software Foundation,
   675 Mass Ave, Cambridge, MA 02139, USA. */

#ifndef _KEYMAPS_H_
#define _KEYMAPS_H_

#include <readline/chardefs.h>

#ifndef __FUNCTION_DEF
typedef int Function ();
#define __FUNCTION_DEF
#endif

/* A keymap contains one entry for each key in the ASCII set.
   Each entry consists of a type and a pointer.
   POINTER is the address of a function to run, or the
   address of a keymap to indirect through.
   TYPE says which kind of thing POINTER is. */
typedef struct _keymap_entry {
  char type;
  Function *function;
} KEYMAP_ENTRY;

/* This must be large enough to hold bindings for all of the characters
   in a desired character set (e.g, 128 for ASCII, 256 for ISO Latin-x,
   and so on). */
#define KEYMAP_SIZE 256

/* I wanted to make the above structure contain a union of:
   union { Function *function; struct _keymap_entry *keymap; } value;
   but this made it impossible for me to create a static array.
   Maybe I need C lessons. */

typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE];
typedef KEYMAP_ENTRY *Keymap;

/* The values that TYPE can have in a keymap entry. */
#define ISFUNC 0
#define ISKMAP 1
#define ISMACR 2

extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, emacs_meta_keymap, emacs_ctlx_keymap;
extern KEYMAP_ENTRY_ARRAY vi_insertion_keymap, vi_movement_keymap;

/* Return a new, empty keymap.
   Free it with free() when you are done. */
Keymap rl_make_bare_keymap ();

/* Return a new keymap which is a copy of MAP. */
Keymap rl_copy_keymap ();

/* Return a new keymap with the printing characters bound to rl_insert,
   the lowercase Meta characters bound to run their equivalents, and
   the Meta digits bound to produce numeric arguments. */
Keymap rl_make_keymap ();

/* Return the keymap corresponding to a given name.  Names look like
   `emacs' or `emacs-meta' or `vi-insert'. */
Keymap rl_get_keymap_by_name ();

/* Return the current keymap. */
Keymap rl_get_keymap ();

/* Set the current keymap to MAP. */
void rl_set_keymap ();

#endif /* _KEYMAPS_H_ */
Commit	Line	Data
bd5635a1 RP	1	/* keymaps.h -- Manipulation of readline keymaps. */
bd5635a1 RP	2
5e98bbab PB	3	/* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
	4
	5	This file is part of the GNU Readline Library, a library for
	6	reading lines of text with interactive input and history editing.
	7
	8	The GNU Readline Library is free software; you can redistribute it
	9	and/or modify it under the terms of the GNU General Public License
	10	as published by the Free Software Foundation; either version 1, or
	11	(at your option) any later version.
	12
	13	The GNU Readline Library is distributed in the hope that it will be
	14	useful, but WITHOUT ANY WARRANTY; without even the implied warranty
	15	of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
	17
	18	The GNU General Public License is often shipped with GNU software, and
	19	is generally kept in a file called COPYING or LICENSE. If you do not
	20	have a copy of the license, write to the Free Software Foundation,
	21	675 Mass Ave, Cambridge, MA 02139, USA. */
	22
bd5635a1 RP	23	#ifndef _KEYMAPS_H_
	24	#define _KEYMAPS_H_
	25
	26	#include <readline/chardefs.h>
	27
	28	#ifndef __FUNCTION_DEF
	29	typedef int Function ();
	30	#define __FUNCTION_DEF
	31	#endif
	32
	33	/* A keymap contains one entry for each key in the ASCII set.
	34	Each entry consists of a type and a pointer.
	35	POINTER is the address of a function to run, or the
	36	address of a keymap to indirect through.
	37	TYPE says which kind of thing POINTER is. */
	38	typedef struct _keymap_entry {
	39	char type;
	40	Function *function;
	41	} KEYMAP_ENTRY;
	42
5e98bbab PB	43	/* This must be large enough to hold bindings for all of the characters
	44	in a desired character set (e.g, 128 for ASCII, 256 for ISO Latin-x,
	45	and so on). */
	46	#define KEYMAP_SIZE 256
	47
bd5635a1 RP	48	/* I wanted to make the above structure contain a union of:
	49	union { Function function; struct _keymap_entry keymap; } value;
	50	but this made it impossible for me to create a static array.
	51	Maybe I need C lessons. */
	52
5e98bbab	53	typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE];
bd5635a1 RP	54	typedef KEYMAP_ENTRY *Keymap;
	55
	56	/* The values that TYPE can have in a keymap entry. */
	57	#define ISFUNC 0
	58	#define ISKMAP 1
	59	#define ISMACR 2
	60
	61	extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, emacs_meta_keymap, emacs_ctlx_keymap;
	62	extern KEYMAP_ENTRY_ARRAY vi_insertion_keymap, vi_movement_keymap;
	63
	64	/* Return a new, empty keymap.
	65	Free it with free() when you are done. */
	66	Keymap rl_make_bare_keymap ();
	67
	68	/* Return a new keymap which is a copy of MAP. */
	69	Keymap rl_copy_keymap ();
	70
	71	/* Return a new keymap with the printing characters bound to rl_insert,
	72	the lowercase Meta characters bound to run their equivalents, and
	73	the Meta digits bound to produce numeric arguments. */
	74	Keymap rl_make_keymap ();
	75
5e98bbab PB	76	/* Return the keymap corresponding to a given name. Names look like
	77	`emacs' or `emacs-meta' or `vi-insert'. */
	78	Keymap rl_get_keymap_by_name ();
bd5635a1	79
5e98bbab PB	80	/* Return the current keymap. */
5e98bbab PB	81	Keymap rl_get_keymap ();
bd5635a1	82
5e98bbab PB	83	/* Set the current keymap to MAP. */
	84	void rl_set_keymap ();
	85
	86	#endif /* _KEYMAPS_H_ */