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

/* tilde.h: Externally available variables and function in libtilde.a. */

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

   This file contains the Readline Library (the Library), a set of
   routines for providing Emacs style line input to programs that ask
   for it.

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

   The 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,
   59 Temple Place, Suite 330, Boston, MA 02111 USA. */

#if !defined (_TILDE_H_)
#  define _TILDE_H_

#ifdef __cplusplus
extern "C" {
#endif

/* A function can be defined using prototypes and compile on both ANSI C
   and traditional C compilers with something like this:
	extern char *func __P((char *, char *, int)); */

#if !defined (__P)
#  if defined (__STDC__) || defined (__GNUC__) || defined (__cplusplus)
#    define __P(protos) protos
#  else
#    define __P(protos) ()
#  endif
#endif

/* Function pointers can be declared as (Function *)foo. */
#if !defined (_FUNCTION_DEF)
#  define _FUNCTION_DEF
typedef int Function ();
typedef void VFunction ();
typedef char *CPFunction ();
typedef char **CPPFunction ();
#endif /* _FUNCTION_DEF */

/* If non-null, this contains the address of a function that the application
   wants called before trying the standard tilde expansions.  The function
   is called with the text sans tilde, and returns a malloc()'ed string
   which is the expansion, or a NULL pointer if the expansion fails. */
extern CPFunction *tilde_expansion_preexpansion_hook;

/* If non-null, this contains the address of a function to call if the
   standard meaning for expanding a tilde fails.  The function is called
   with the text (sans tilde, as in "foo"), and returns a malloc()'ed string
   which is the expansion, or a NULL pointer if there is no expansion. */
extern CPFunction *tilde_expansion_failure_hook;

/* When non-null, this is a NULL terminated array of strings which
   are duplicates for a tilde prefix.  Bash uses this to expand
   `=~' and `:~'. */
extern char **tilde_additional_prefixes;

/* When non-null, this is a NULL terminated array of strings which match
   the end of a username, instead of just "/".  Bash sets this to
   `:' and `=~'. */
extern char **tilde_additional_suffixes;

/* Return a new string which is the result of tilde expanding STRING. */
extern char *tilde_expand __P((char *));

/* Do the work of tilde expansion on FILENAME.  FILENAME starts with a
   tilde.  If there is no expansion, call tilde_expansion_failure_hook. */
extern char *tilde_expand_word __P((char *));

#ifdef __cplusplus
}
#endif

#endif /* _TILDE_H_ */
Commit	Line	Data
d60d9f65 SS	1	/* tilde.h: Externally available variables and function in libtilde.a. */
	2
	3	/* Copyright (C) 1992 Free Software Foundation, Inc.
	4
	5	This file contains the Readline Library (the Library), a set of
	6	routines for providing Emacs style line input to programs that ask
	7	for it.
	8
	9	The Library is free software; you can redistribute it and/or modify
	10	it under the terms of the GNU General Public License as published by
1b17e766	11	the Free Software Foundation; either version 2, or (at your option)
d60d9f65 SS	12	any later version.
	13
	14	The Library is distributed in the hope that it will be useful, but
	15	WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	General Public License for more details.
	18
	19	The GNU General Public License is often shipped with GNU software, and
	20	is generally kept in a file called COPYING or LICENSE. If you do not
	21	have a copy of the license, write to the Free Software Foundation,
1b17e766	22	59 Temple Place, Suite 330, Boston, MA 02111 USA. */
d60d9f65 SS	23
	24	#if !defined (_TILDE_H_)
	25	# define _TILDE_H_
	26
1b17e766 EZ	27	#ifdef __cplusplus
	28	extern "C" {
	29	#endif
	30
	31	/* A function can be defined using prototypes and compile on both ANSI C
	32	and traditional C compilers with something like this:
	33	extern char func __P((char , char , int)); /
	34
	35	#if !defined (__P)
	36	# if defined (__STDC__) \|\| defined (__GNUC__) \|\| defined (__cplusplus)
	37	# define __P(protos) protos
	38	# else
	39	# define __P(protos) ()
	40	# endif
	41	#endif
	42
d60d9f65 SS	43	/* Function pointers can be declared as (Function )foo. /
	44	#if !defined (_FUNCTION_DEF)
	45	# define _FUNCTION_DEF
	46	typedef int Function ();
	47	typedef void VFunction ();
	48	typedef char *CPFunction ();
	49	typedef char **CPPFunction ();
	50	#endif /* _FUNCTION_DEF */
	51
	52	/* If non-null, this contains the address of a function that the application
	53	wants called before trying the standard tilde expansions. The function
	54	is called with the text sans tilde, and returns a malloc()'ed string
	55	which is the expansion, or a NULL pointer if the expansion fails. */
	56	extern CPFunction *tilde_expansion_preexpansion_hook;
	57
	58	/* If non-null, this contains the address of a function to call if the
	59	standard meaning for expanding a tilde fails. The function is called
	60	with the text (sans tilde, as in "foo"), and returns a malloc()'ed string
	61	which is the expansion, or a NULL pointer if there is no expansion. */
	62	extern CPFunction *tilde_expansion_failure_hook;
	63
	64	/* When non-null, this is a NULL terminated array of strings which
	65	are duplicates for a tilde prefix. Bash uses this to expand
	66	`=~' and `:~'. */
	67	extern char **tilde_additional_prefixes;
	68
	69	/* When non-null, this is a NULL terminated array of strings which match
	70	the end of a username, instead of just "/". Bash sets this to
	71	`:' and `=~'. */
	72	extern char **tilde_additional_suffixes;
	73
	74	/* Return a new string which is the result of tilde expanding STRING. */
1b17e766	75	extern char tilde_expand __P((char ));
d60d9f65 SS	76
	77	/* Do the work of tilde expansion on FILENAME. FILENAME starts with a
	78	tilde. If there is no expansion, call tilde_expansion_failure_hook. */
1b17e766 EZ	79	extern char tilde_expand_word __P((char ));
	80
	81	#ifdef __cplusplus
	82	}
	83	#endif
d60d9f65 SS	84
d60d9f65 SS	85	#endif /* _TILDE_H_ */