Where Online Learning is simpler!

The C and C++ Include Header Files

/usr/include/readline/tilde.h


$ cat -n /usr/include/readline/tilde.h

     1	/* tilde.h: Externally available variables and function in libtilde.a. */
     2	
     3	/* Copyright (C) 1992-2009,2021 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	typedef char *tilde_hook_func_t (char *);
    31	
    32	/* If non-null, this contains the address of a function that the application
    33	   wants called before trying the standard tilde expansions.  The function
    34	   is called with the text sans tilde, and returns a malloc()'ed string
    35	   which is the expansion, or a NULL pointer if the expansion fails. */
    36	extern tilde_hook_func_t *tilde_expansion_preexpansion_hook;
    37	
    38	/* If non-null, this contains the address of a function to call if the
    39	   standard meaning for expanding a tilde fails.  The function is called
    40	   with the text (sans tilde, as in "foo"), and returns a malloc()'ed string
    41	   which is the expansion, or a NULL pointer if there is no expansion. */
    42	extern tilde_hook_func_t *tilde_expansion_failure_hook;
    43	
    44	/* When non-null, this is a NULL terminated array of strings which
    45	   are duplicates for a tilde prefix.  Bash uses this to expand
    46	   `=~' and `:~'. */
    47	extern char **tilde_additional_prefixes;
    48	
    49	/* When non-null, this is a NULL terminated array of strings which match
    50	   the end of a username, instead of just "/".  Bash sets this to
    51	   `:' and `=~'. */
    52	extern char **tilde_additional_suffixes;
    53	
    54	/* Return a new string which is the result of tilde expanding STRING. */
    55	extern char *tilde_expand (const char *);
    56	
    57	/* Do the work of tilde expansion on FILENAME.  FILENAME starts with a
    58	   tilde.  If there is no expansion, call tilde_expansion_failure_hook. */
    59	extern char *tilde_expand_word (const char *);
    60	
    61	/* Find the portion of the string beginning with ~ that should be expanded. */
    62	extern char *tilde_find_word (const char *, int, int *);
    63	
    64	#ifdef __cplusplus
    65	}
    66	#endif
    67	
    68	#endif /* _TILDE_H_ */