[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_

#if defined (READLINE_LIBRARY)
#  include "chardefs.h"
#else
#  include <readline/chardefs.h>
#endif

#if !defined (_FUNCTION_DEF)
#  define _FUNCTION_DEF
typedef int Function ();
typedef void VFunction ();
typedef char *CPFunction ();
typedef char **CPPFunction ();
#endif

/* A keymap contains one entry for each key in the ASCII set.
   Each entry consists of a type and a pointer.
   FUNCTION is the address of a function to run, or the
   address of a keymap to indirect through.
   TYPE says which kind of thing FUNCTION 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. */
extern Keymap rl_make_bare_keymap ();

/* Return a new keymap which is a copy of MAP. */
extern 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. */
extern Keymap rl_make_keymap ();

extern void rl_discard_keymap ();

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

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

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

#endif /* _KEYMAPS_H_ */
Commit	Line	Data
d60d9f65 SS	1	/* keymaps.h -- Manipulation of readline keymaps. */
	2
	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
	23	#ifndef _KEYMAPS_H_
	24	#define _KEYMAPS_H_
	25
	26	#if defined (READLINE_LIBRARY)
	27	# include "chardefs.h"
	28	#else
	29	# include <readline/chardefs.h>
	30	#endif
	31
	32	#if !defined (_FUNCTION_DEF)
	33	# define _FUNCTION_DEF
	34	typedef int Function ();
	35	typedef void VFunction ();
	36	typedef char *CPFunction ();
	37	typedef char **CPPFunction ();
	38	#endif
	39
	40	/* A keymap contains one entry for each key in the ASCII set.
	41	Each entry consists of a type and a pointer.
	42	FUNCTION is the address of a function to run, or the
	43	address of a keymap to indirect through.
	44	TYPE says which kind of thing FUNCTION is. */
	45	typedef struct _keymap_entry {
	46	char type;
	47	Function *function;
	48	} KEYMAP_ENTRY;
	49
	50	/* This must be large enough to hold bindings for all of the characters
	51	in a desired character set (e.g, 128 for ASCII, 256 for ISO Latin-x,
	52	and so on). */
	53	#define KEYMAP_SIZE 256
	54
	55	/* I wanted to make the above structure contain a union of:
	56	union { Function function; struct _keymap_entry keymap; } value;
	57	but this made it impossible for me to create a static array.
	58	Maybe I need C lessons. */
	59
	60	typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE];
	61	typedef KEYMAP_ENTRY *Keymap;
	62
	63	/* The values that TYPE can have in a keymap entry. */
	64	#define ISFUNC 0
65	#define ISKMAP 1
66	#define ISMACR 2
67
68	extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, emacs_meta_keymap, emacs_ctlx_keymap;
69	extern KEYMAP_ENTRY_ARRAY vi_insertion_keymap, vi_movement_keymap;
70
71	/* Return a new, empty keymap.
72	Free it with free() when you are done. */
73	extern Keymap rl_make_bare_keymap ();
74
75	/* Return a new keymap which is a copy of MAP. */
76	extern Keymap rl_copy_keymap ();
77
78	/* Return a new keymap with the printing characters bound to rl_insert,
79	the lowercase Meta characters bound to run their equivalents, and
80	the Meta digits bound to produce numeric arguments. */
81	extern Keymap rl_make_keymap ();
82
83	extern void rl_discard_keymap ();
84
85	/* Return the keymap corresponding to a given name. Names look like
86	`emacs' or `emacs-meta' or `vi-insert'. */
87	extern Keymap rl_get_keymap_by_name ();
88
89	/* Return the current keymap. */
90	extern Keymap rl_get_keymap ();
91
92	/* Set the current keymap to MAP. */
93	extern void rl_set_keymap ();
94
95	#endif /* _KEYMAPS_H_ */