Annotation of embedaddon/readline/tilde.h, revision 1.1.1.1
1.1 misho 1: /* tilde.h: Externally available variables and function in libtilde.a. */
2:
3: /* Copyright (C) 1992-2009 Free Software Foundation, Inc.
4:
5: This file contains the Readline Library (Readline), a set of
6: routines for providing Emacs style line input to programs that ask
7: for it.
8:
9: Readline is free software: you can redistribute it and/or modify
10: it under the terms of the GNU General Public License as published by
11: the Free Software Foundation, either version 3 of the License, or
12: (at your option) any later version.
13:
14: Readline is distributed in the hope that it will be useful,
15: but WITHOUT ANY WARRANTY; without even the implied warranty of
16: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17: GNU General Public License for more details.
18:
19: You should have received a copy of the GNU General Public License
20: along with Readline. If not, see <http://www.gnu.org/licenses/>.
21: */
22:
23: #if !defined (_TILDE_H_)
24: # define _TILDE_H_
25:
26: #ifdef __cplusplus
27: extern "C" {
28: #endif
29:
30: /* A function can be defined using prototypes and compile on both ANSI C
31: and traditional C compilers with something like this:
32: extern char *func PARAMS((char *, char *, int)); */
33:
34: #if !defined (PARAMS)
35: # if defined (__STDC__) || defined (__GNUC__) || defined (__cplusplus)
36: # define PARAMS(protos) protos
37: # else
38: # define PARAMS(protos) ()
39: # endif
40: #endif
41:
42: typedef char *tilde_hook_func_t PARAMS((char *));
43:
44: /* If non-null, this contains the address of a function that the application
45: wants called before trying the standard tilde expansions. The function
46: is called with the text sans tilde, and returns a malloc()'ed string
47: which is the expansion, or a NULL pointer if the expansion fails. */
48: extern tilde_hook_func_t *tilde_expansion_preexpansion_hook;
49:
50: /* If non-null, this contains the address of a function to call if the
51: standard meaning for expanding a tilde fails. The function is called
52: with the text (sans tilde, as in "foo"), and returns a malloc()'ed string
53: which is the expansion, or a NULL pointer if there is no expansion. */
54: extern tilde_hook_func_t *tilde_expansion_failure_hook;
55:
56: /* When non-null, this is a NULL terminated array of strings which
57: are duplicates for a tilde prefix. Bash uses this to expand
58: `=~' and `:~'. */
59: extern char **tilde_additional_prefixes;
60:
61: /* When non-null, this is a NULL terminated array of strings which match
62: the end of a username, instead of just "/". Bash sets this to
63: `:' and `=~'. */
64: extern char **tilde_additional_suffixes;
65:
66: /* Return a new string which is the result of tilde expanding STRING. */
67: extern char *tilde_expand PARAMS((const char *));
68:
69: /* Do the work of tilde expansion on FILENAME. FILENAME starts with a
70: tilde. If there is no expansion, call tilde_expansion_failure_hook. */
71: extern char *tilde_expand_word PARAMS((const char *));
72:
73: /* Find the portion of the string beginning with ~ that should be expanded. */
74: extern char *tilde_find_word PARAMS((const char *, int, int *));
75:
76: #ifdef __cplusplus
77: }
78: #endif
79:
80: #endif /* _TILDE_H_ */
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>