mirror of
https://github.com/fish-shell/fish-shell
synced 2024-11-11 15:37:24 +00:00
149 lines
5.1 KiB
C
149 lines
5.1 KiB
C
/** \file parse_util.h
|
|
|
|
Various mostly unrelated utility functions related to parsing,
|
|
loading and evaluating fish code.
|
|
*/
|
|
|
|
#ifndef FISH_PARSE_UTIL_H
|
|
#define FISH_PARSE_UTIL_H
|
|
|
|
#include <wchar.h>
|
|
|
|
/**
|
|
Find the beginning and end of the first subshell in the specified string.
|
|
|
|
\param in the string to search for subshells
|
|
\param begin the starting paranthesis of the subshell
|
|
\param end the ending paranthesis of the subshell
|
|
\param flags set this variable to ACCEPT_INCOMPLETE if in tab_completion mode
|
|
\return -1 on syntax error, 0 if no subshells exist and 1 on sucess
|
|
*/
|
|
|
|
int parse_util_locate_cmdsubst( const wchar_t *in,
|
|
wchar_t **begin,
|
|
wchar_t **end,
|
|
int flags );
|
|
|
|
/**
|
|
Find the beginning and end of the command substitution under the
|
|
cursor. If no subshell is found, the entire string is returned. If
|
|
the current command substitution is not ended, i.e. the closing
|
|
parenthesis is missing, then the string from the beginning of the
|
|
substitution to the end of the string is returned.
|
|
|
|
\param buff the string to search for subshells
|
|
\param cursor_pos the position of the cursor
|
|
\param a the start of the searched string
|
|
\param b the end of the searched string
|
|
*/
|
|
void parse_util_cmdsubst_extent( const wchar_t *buff,
|
|
int cursor_pos,
|
|
wchar_t **a,
|
|
wchar_t **b );
|
|
|
|
/**
|
|
Find the beginning and end of the process definition under the cursor
|
|
|
|
\param buff the string to search for subshells
|
|
\param cursor_pos the position of the cursor
|
|
\param a the start of the searched string
|
|
\param b the end of the searched string
|
|
*/
|
|
void parse_util_process_extent( const wchar_t *buff,
|
|
int cursor_pos,
|
|
wchar_t **a,
|
|
wchar_t **b );
|
|
|
|
|
|
/**
|
|
Find the beginning and end of the job definition under the cursor
|
|
|
|
\param buff the string to search for subshells
|
|
\param cursor_pos the position of the cursor
|
|
\param a the start of the searched string
|
|
\param b the end of the searched string
|
|
*/
|
|
void parse_util_job_extent( const wchar_t *buff,
|
|
int cursor_pos,
|
|
wchar_t **a,
|
|
wchar_t **b );
|
|
|
|
/**
|
|
Find the beginning and end of the token under the cursor and the
|
|
toekn before the current token. Any combination of tok_begin,
|
|
tok_end, prev_begin and prev_end may be null.
|
|
|
|
\param buff the string to search for subshells
|
|
\param cursor_pos the position of the cursor
|
|
\param tok_begin the start of the current token
|
|
\param tok_end the end of the current token
|
|
\param prev_begin the start o the token before the current token
|
|
\param prev_end the end of the token before the current token
|
|
*/
|
|
void parse_util_token_extent( const wchar_t *buff,
|
|
int cursor_pos,
|
|
wchar_t **tok_begin,
|
|
wchar_t **tok_end,
|
|
wchar_t **prev_begin,
|
|
wchar_t **prev_end );
|
|
|
|
|
|
/**
|
|
Get the linenumber at the specified character offset
|
|
*/
|
|
int parse_util_lineno( const wchar_t *str, int len );
|
|
|
|
/**
|
|
Autoload the specified file, if it exists in the specified path. Do
|
|
not load it multiple times unless it's timestamp changes or
|
|
parse_util_unload is called.
|
|
|
|
Autoloading one file may unload another.
|
|
|
|
\param cmd the filename to search for. The suffix '.fish' is always added to this name
|
|
\param path_var_name the environment variable giving the search path
|
|
\param on_unload a callback function to run if a suitable file is found, which has not already been run. unload will also be called for old files which are unloaded.
|
|
\param reload wheter to recheck file timestamps on already loaded files
|
|
*/
|
|
int parse_util_load( const wchar_t *cmd,
|
|
const wchar_t *path_var_name,
|
|
void (*on_unload)(const wchar_t *cmd),
|
|
int reload );
|
|
|
|
/**
|
|
Reset the loader for the specified path variable. This will cause
|
|
all information on loaded files in the specified directory to be
|
|
reset.
|
|
|
|
\param path_var_name the environment variable giving the search path
|
|
\param on_unload a callback function which will be called before (re)loading a file, may be used to unload the previous file.
|
|
*/
|
|
void parse_util_load_reset( const wchar_t *path_var_name,
|
|
void (*on_unload)(const wchar_t *cmd) );
|
|
|
|
/**
|
|
Tell the autoloader that the specified file, in the specified path,
|
|
is no longer loaded.
|
|
|
|
\param cmd the filename to search for. The suffix '.fish' is always added to this name
|
|
\param path_var_name the environment variable giving the search path
|
|
\param on_unload a callback function which will be called before (re)loading a file, may be used to unload the previous file.
|
|
\return non-zero if the file was removed, zero if the file had not yet been loaded
|
|
*/
|
|
int parse_util_unload( const wchar_t *cmd,
|
|
const wchar_t *path_var_name,
|
|
void (*on_unload)(const wchar_t *cmd) );
|
|
|
|
/**
|
|
Set the argv environment variable to the specified null-terminated
|
|
array of strings.
|
|
*/
|
|
void parse_util_set_argv( wchar_t **argv );
|
|
|
|
/**
|
|
Make a duplicate of the specified string, unescape wildcard
|
|
characters but not performing any other character transformation.
|
|
*/
|
|
wchar_t *parse_util_unescape_wildcards( const wchar_t *in );
|
|
|
|
#endif
|