rlprivate.hh

/* rlprivate.h -- functions and variables global to the readline library,
      but not intended for use by applications. */

/* Copyright (C) 1999-2015 Free Software Foundation, Inc.

   This file is part of the GNU Readline Library (Readline), a library
   for reading lines of text with interactive input and history editing.

   Readline 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 3 of the License, or
   (at your option) any later version.

   Readline 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.

   You should have received a copy of the GNU General Public License
   along with Readline.  If not, see <http://www.gnu.org/licenses/>.
*/

#if !defined(_RL_PRIVATE_H_)
#define _RL_PRIVATE_H_

#include "posixjmp.hh" /* defines procenv_t */
#include "rlconf.hh"   /* for VISIBLE_STATS */
#include "rlmbutil.hh" /* for HANDLE_MULTIBYTE */
#include "rlstdc.hh"

/*************************************************************************
 *									 *
 * Convenience definitions						 *
 *									 *
 *************************************************************************/

#define EMACS_MODE() (rl_editing_mode == emacs_mode)
#define VI_COMMAND_MODE()                                                 \
  (rl_editing_mode == vi_mode && _rl_keymap == vi_movement_keymap)
#define VI_INSERT_MODE()                                                  \
  (rl_editing_mode == vi_mode && _rl_keymap == vi_insertion_keymap)

#define RL_CHECK_SIGNALS()                                                \
  do                                                                      \
  {                                                                       \
    if (_rl_caught_signal)                                                \
      _rl_signal_handler(_rl_caught_signal);                              \
  } while (0)

#define RL_SIG_RECEIVED()      (_rl_caught_signal != 0)
#define RL_SIGINT_RECEIVED()   (_rl_caught_signal == SIGINT)
#define RL_SIGWINCH_RECEIVED() (_rl_caught_signal == SIGWINCH)

#define CUSTOM_REDISPLAY_FUNC() (rl_redisplay_function != rl_redisplay)
#define CUSTOM_INPUT_FUNC()     (rl_getc_function != rl_getc)

/*************************************************************************
 *									 *
 * Global structs undocumented in texinfo manual and not in readline.h   *
 *									 *
 *************************************************************************/
/* search types */
#define RL_SEARCH_ISEARCH 0x01 /* incremental search */
#define RL_SEARCH_NSEARCH 0x02 /* non-incremental search */
#define RL_SEARCH_CSEARCH 0x04 /* intra-line char search */

/* search flags */
#define SF_REVERSE 0x01
#define SF_FOUND   0x02
#define SF_FAILED  0x04
#define SF_CHGKMAP 0x08
#define SF_PATTERN 0x10 /* unused so far */

typedef struct __rl_search_context
{
  int type;
  int sflags;

  char* search_string;
  int   search_string_index;
  int   search_string_size;

  char** lines;
  char*  allocated_line;
  int    hlen;
  int    hindex;

  int   save_point;
  int   save_mark;
  int   save_line;
  int   last_found_line;
  char* prev_line_found;

  UNDO_LIST* save_undo_list;

  Keymap keymap;  /* used when dispatching commands in search string */
  Keymap okeymap; /* original keymap */

  int history_pos;
  int direction;

  int prevc;
  int lastc;
#if defined(HANDLE_MULTIBYTE)
  char mb[MB_LEN_MAX];
  char pmb[MB_LEN_MAX];
#endif

  char* sline;
  int   sline_len;
  int   sline_index;

  char* search_terminators;
} _rl_search_cxt;

/* Callback data for reading numeric arguments */
#define NUM_SAWMINUS  0x01
#define NUM_SAWDIGITS 0x02
#define NUM_READONE   0x04

typedef int _rl_arg_cxt;

/* A context for reading key sequences longer than a single character when
   using the callback interface. */
#define KSEQ_DISPATCHED 0x01
#define KSEQ_SUBSEQ     0x02
#define KSEQ_RECURSIVE  0x04

typedef struct __rl_keyseq_context
{
  int flags;
  int subseq_arg;
  int subseq_retval; /* XXX */
  int okey;

  Keymap dmap;
  Keymap oldmap;

  struct __rl_keyseq_context* ocxt;
  int                         childval;
} _rl_keyseq_cxt;

/* vi-mode commands that use result of motion command to define boundaries
 */
#define VIM_DELETE 0x01
#define VIM_CHANGE 0x02
#define VIM_YANK   0x04

/* various states for vi-mode commands that use motion commands.  reflects
   RL_READLINE_STATE */
#define VMSTATE_READ   0x01
#define VMSTATE_NUMARG 0x02

typedef struct __rl_vimotion_context
{
  int         op;
  int         state;
  int         flags; /* reserved */
  _rl_arg_cxt ncxt;
  int         numeric_arg;
  int         start, end;  /* rl_point, rl_end */
  int         key, motion; /* initial key, motion command */
} _rl_vimotion_cxt;

/* fill in more as needed */
/* `Generic' callback data and functions */
typedef struct __rl_callback_generic_arg
{
  int count;
  int i1, i2;
  /* add here as needed */
} _rl_callback_generic_arg;

typedef int _rl_callback_func_t PARAMS((_rl_callback_generic_arg*));

typedef void _rl_sigcleanup_func_t PARAMS((int, void*));

/*************************************************************************
 *									 *
 * Global functions undocumented in texinfo manual and not in readline.h *
 *									 *
 *************************************************************************/

/*************************************************************************
 *									 *
 * Global variables undocumented in texinfo manual and not in readline.h *
 *									 *
 *************************************************************************/

/* complete.c */
extern int rl_complete_with_tilde_expansion;
#if defined(VISIBLE_STATS)
extern int rl_visible_stats;
#endif /* VISIBLE_STATS */
#if defined(COLOR_SUPPORT)
extern int _rl_colored_stats;
extern int _rl_colored_completion_prefix;
#endif

/* readline.c */
extern int rl_line_buffer_len;
extern int rl_arg_sign;
extern int rl_visible_prompt_length;
extern int rl_byte_oriented;

/* display.c */
extern int rl_display_fixed;

/* parens.c */
extern int rl_blink_matching_paren;

/*************************************************************************
 *									 *
 * Global functions and variables unused and undocumented		 *
 *									 *
 *************************************************************************/

/* kill.c */
extern int rl_set_retained_kills PARAMS((int));

/* terminal.c */
extern void _rl_set_screen_size PARAMS((int, int));

/* undo.c */
extern int _rl_fix_last_undo_of_type PARAMS((int, int, int));

/* util.c */
extern char* _rl_savestring PARAMS((const char*));

/*************************************************************************
 *									 *
 * Functions and variables private to the readline library		 *
 *									 *
 *************************************************************************/

/* NOTE: Functions and variables prefixed with `_rl_' are
   pseudo-global: they are global so they can be shared
   between files in the readline library, but are not intended
   to be visible to readline callers. */

/*************************************************************************
 * Undocumented private functions					 *
 *************************************************************************/

#if defined(READLINE_CALLBACKS)

/* readline.c */
extern void readline_internal_setup     PARAMS((void));
extern char* readline_internal_teardown PARAMS((int));
extern int readline_internal_char       PARAMS((void));

extern _rl_keyseq_cxt* _rl_keyseq_cxt_alloc PARAMS((void));
extern void _rl_keyseq_cxt_dispose          PARAMS((_rl_keyseq_cxt*));
extern void _rl_keyseq_chain_dispose        PARAMS((void));

extern int _rl_dispatch_callback PARAMS((_rl_keyseq_cxt*));

/* callback.c */
extern _rl_callback_generic_arg* _rl_callback_data_alloc PARAMS((int));
extern void _rl_callback_data_dispose PARAMS((_rl_callback_generic_arg*));

#endif /* READLINE_CALLBACKS */

/* bind.c */
extern char* _rl_untranslate_macro_value PARAMS((char*, int));

/* complete.c */
extern void _rl_reset_completion_state PARAMS((void));
extern char _rl_find_completion_word   PARAMS((int*, int*));
extern void _rl_free_match_list        PARAMS((char**));

/* display.c */
extern char* _rl_strip_prompt            PARAMS((char*));
extern void _rl_reset_prompt             PARAMS((void));
extern void _rl_move_cursor_relative     PARAMS((int, const char*));
extern void _rl_move_vert                PARAMS((int));
extern void _rl_save_prompt              PARAMS((void));
extern void _rl_restore_prompt           PARAMS((void));
extern char* _rl_make_prompt_for_search  PARAMS((int));
extern void _rl_erase_at_end_of_line     PARAMS((int));
extern void _rl_clear_to_eol             PARAMS((int));
extern void _rl_clear_screen             PARAMS((void));
extern void _rl_update_final             PARAMS((void));
extern void _rl_redisplay_after_sigwinch PARAMS((void));
extern void _rl_clean_up_for_exit        PARAMS((void));
extern void _rl_erase_entire_line        PARAMS((void));
extern int _rl_current_display_line      PARAMS((void));

/* input.c */
extern int _rl_any_typein             PARAMS((void));
extern int _rl_input_available        PARAMS((void));
extern int _rl_input_queued           PARAMS((int));
extern void _rl_insert_typein         PARAMS((int));
extern int _rl_unget_char             PARAMS((int));
extern int _rl_pushed_input_available PARAMS((void));

/* isearch.c */
extern _rl_search_cxt* _rl_scxt_alloc PARAMS((int, int));
extern void _rl_scxt_dispose          PARAMS((_rl_search_cxt*, int));

extern int _rl_isearch_dispatch PARAMS((_rl_search_cxt*, int));
extern int _rl_isearch_callback PARAMS((_rl_search_cxt*));
extern int _rl_isearch_cleanup  PARAMS((_rl_search_cxt*, int));

extern int _rl_search_getchar PARAMS((_rl_search_cxt*));

/* kill.c */
#define BRACK_PASTE_PREF "\033[200~"
#define BRACK_PASTE_SUFF "\033[201~"

#define BRACK_PASTE_LAST '~'
#define BRACK_PASTE_SLEN 6

#define BRACK_PASTE_INIT "\033[?2004h"
#define BRACK_PASTE_FINI "\033[?2004l\r"

extern char* _rl_bracketed_text PARAMS((size_t*));

/* macro.c */
extern void _rl_with_macro_input     PARAMS((char*));
extern int _rl_peek_macro_key        PARAMS((void));
extern int _rl_next_macro_key        PARAMS((void));
extern int _rl_prev_macro_key        PARAMS((void));
extern void _rl_push_executing_macro PARAMS((void));
extern void _rl_pop_executing_macro  PARAMS((void));
extern void _rl_add_macro_char       PARAMS((int));
extern void _rl_kill_kbd_macro       PARAMS((void));

/* misc.c */
extern int _rl_arg_overflow    PARAMS((void));
extern void _rl_arg_init       PARAMS((void));
extern int _rl_arg_getchar     PARAMS((void));
extern int _rl_arg_callback    PARAMS((_rl_arg_cxt));
extern void _rl_reset_argument PARAMS((void));

extern void _rl_start_using_history    PARAMS((void));
extern int _rl_free_saved_history_line PARAMS((void));
extern void _rl_set_insert_mode        PARAMS((int, int));

extern void _rl_revert_all_lines PARAMS((void));

/* nls.c */
extern char* _rl_init_locale PARAMS((void));
extern int _rl_init_eightbit PARAMS((void));

/* parens.c */
extern void _rl_enable_paren_matching PARAMS((int));

/* readline.c */
extern void _rl_init_line_state       PARAMS((void));
extern void _rl_set_the_line          PARAMS((void));
extern int _rl_dispatch               PARAMS((int, Keymap));
extern int _rl_dispatch_subseq        PARAMS((int, Keymap, int));
extern void _rl_internal_char_cleanup PARAMS((void));

/* rltty.c */
extern int _rl_disable_tty_signals PARAMS((void));
extern int _rl_restore_tty_signals PARAMS((void));

/* search.c */
extern int _rl_nsearch_callback PARAMS((_rl_search_cxt*));
extern int _rl_nsearch_cleanup  PARAMS((_rl_search_cxt*, int));

/* signals.c */
extern void _rl_signal_handler PARAMS((int));

extern void _rl_block_sigint     PARAMS((void));
extern void _rl_release_sigint   PARAMS((void));
extern void _rl_block_sigwinch   PARAMS((void));
extern void _rl_release_sigwinch PARAMS((void));

/* terminal.c */
extern void _rl_get_screen_size          PARAMS((int, int));
extern void _rl_sigwinch_resize_terminal PARAMS((void));
extern int _rl_init_terminal_io          PARAMS((const char*));
#ifdef _MINIX
extern void _rl_output_character_function PARAMS((int));
#else
extern int _rl_output_character_function PARAMS((int));
#endif
extern void _rl_output_some_chars PARAMS((const char*, int));
extern int _rl_backspace          PARAMS((int));
extern void _rl_enable_meta_key   PARAMS((void));
extern void _rl_disable_meta_key  PARAMS((void));
extern void _rl_control_keypad    PARAMS((int));
extern void _rl_set_cursor        PARAMS((int, int));

/* text.c */
extern void _rl_fix_point             PARAMS((int));
extern int _rl_replace_text           PARAMS((const char*, int, int));
extern int _rl_forward_char_internal  PARAMS((int));
extern int _rl_backward_char_internal PARAMS((int));
extern int _rl_insert_char            PARAMS((int, int));
extern int _rl_overwrite_char         PARAMS((int, int));
extern int _rl_overwrite_rubout       PARAMS((int, int));
extern int _rl_rubout_char            PARAMS((int, int));
#if defined(HANDLE_MULTIBYTE)
extern int _rl_char_search_internal PARAMS((int, int, char*, int));
#else
extern int _rl_char_search_internal      PARAMS((int, int, int));
#endif
extern int _rl_set_mark_at_pos PARAMS((int));

/* undo.c */
extern UNDO_LIST* _rl_copy_undo_entry PARAMS((UNDO_LIST*));
extern UNDO_LIST* _rl_copy_undo_list  PARAMS((UNDO_LIST*));
extern void _rl_free_undo_list        PARAMS((UNDO_LIST*));

/* util.c */
#if defined(USE_VARARGS) && defined(PREFER_STDARG)
extern void _rl_ttymsg(const char*, ...)
         __attribute__((__format__(printf, 1, 2)));
extern void _rl_errmsg(const char*, ...)
         __attribute__((__format__(printf, 1, 2)));
extern void _rl_trace(const char*, ...)
         __attribute__((__format__(printf, 1, 2)));
#else
extern void                              _rl_ttymsg();
extern void                              _rl_errmsg();
extern void                              _rl_trace();
#endif
extern void _rl_audit_tty PARAMS((char*));

extern int _rl_tropen PARAMS((void));

extern int _rl_abort_internal       PARAMS((void));
extern int _rl_null_function        PARAMS((int, int));
extern char* _rl_strindex           PARAMS((const char*, const char*));
extern int _rl_qsort_string_compare PARAMS((char**, char**));
extern int(_rl_uppercase_p) PARAMS((int));
extern int(_rl_lowercase_p) PARAMS((int));
extern int(_rl_pure_alphabetic) PARAMS((int));
extern int(_rl_digit_p) PARAMS((int));
extern int(_rl_to_lower) PARAMS((int));
extern int(_rl_to_upper) PARAMS((int));
extern int(_rl_digit_value) PARAMS((int));

/* vi_mode.c */
extern void _rl_vi_initialize_line      PARAMS((void));
extern void _rl_vi_reset_last           PARAMS((void));
extern void _rl_vi_set_last             PARAMS((int, int, int));
extern int _rl_vi_textmod_command       PARAMS((int));
extern int _rl_vi_motion_command        PARAMS((int));
extern void _rl_vi_done_inserting       PARAMS((void));
extern int _rl_vi_domove_callback       PARAMS((_rl_vimotion_cxt*));
extern int _rl_vi_domove_motion_cleanup PARAMS((int, _rl_vimotion_cxt*));

/*************************************************************************
 * Undocumented private variables					 *
 *************************************************************************/

/* bind.c */
extern const char* const _rl_possible_control_prefixes[];
extern const char* const _rl_possible_meta_prefixes[];

/* callback.c */
extern _rl_callback_func_t*      _rl_callback_func;
extern _rl_callback_generic_arg* _rl_callback_data;

/* complete.c */
extern int _rl_complete_show_all;
extern int _rl_complete_show_unmodified;
extern int _rl_complete_mark_directories;
extern int _rl_complete_mark_symlink_dirs;
extern int _rl_completion_prefix_display_length;
extern int _rl_completion_columns;
extern int _rl_print_completions_horizontally;
extern int _rl_completion_case_fold;
extern int _rl_completion_case_map;
extern int _rl_match_hidden_files;
extern int _rl_page_completions;
extern int _rl_skip_completed_text;
extern int _rl_menu_complete_prefix_first;

/* display.c */
extern int _rl_vis_botlin;
extern int _rl_last_c_pos;
extern int _rl_suppress_redisplay;
extern int _rl_want_redisplay;

extern char* _rl_emacs_mode_str;
extern int   _rl_emacs_modestr_len;
extern char* _rl_vi_ins_mode_str;
extern int   _rl_vi_ins_modestr_len;
extern char* _rl_vi_cmd_mode_str;
extern int   _rl_vi_cmd_modestr_len;

/* isearch.c */
extern char* _rl_isearch_terminators;

extern _rl_search_cxt* _rl_iscxt;

/* macro.c */
extern char* _rl_executing_macro;

/* misc.c */
extern int _rl_history_preserve_point;
extern int _rl_history_saved_point;

extern _rl_arg_cxt _rl_argcxt;

/* nls.c */
extern int _rl_utf8locale;

/* readline.c */
extern int             _rl_echoing_p;
extern int             _rl_horizontal_scroll_mode;
extern int             _rl_mark_modified_lines;
extern int             _rl_bell_preference;
extern int             _rl_meta_flag;
extern int             _rl_convert_meta_chars_to_ascii;
extern int             _rl_output_meta_chars;
extern int             _rl_bind_stty_chars;
extern int             _rl_revert_all_at_newline;
extern int             _rl_echo_control_chars;
extern int             _rl_show_mode_in_prompt;
extern int             _rl_enable_bracketed_paste;
extern char*           _rl_comment_begin;
extern unsigned char   _rl_parsing_conditionalized_out;
extern Keymap          _rl_keymap;
extern FILE*           _rl_in_stream;
extern FILE*           _rl_out_stream;
extern int             _rl_last_command_was_kill;
extern int             _rl_eof_char;
extern int             _rl_eof_found;
extern procenv_t       _rl_top_level;
extern _rl_keyseq_cxt* _rl_kscxt;
extern int             _rl_keyseq_timeout;

extern int _rl_executing_keyseq_size;

/* search.c */
extern _rl_search_cxt* _rl_nscxt;

/* signals.c */
extern int _rl_interrupt_immediately;
extern int  _rl_caught_signal;

extern _rl_sigcleanup_func_t* _rl_sigcleanup;
extern void*                  _rl_sigcleanarg;

extern int _rl_echoctl;

extern int _rl_intr_char;
extern int _rl_quit_char;
extern int _rl_susp_char;

/* terminal.c */
extern int   _rl_enable_keypad;
extern int   _rl_enable_meta;
extern char* _rl_term_clreol;
extern char* _rl_term_clrpag;
extern char* _rl_term_clrscroll;
extern char* _rl_term_im;
extern char* _rl_term_ic;
extern char* _rl_term_ei;
extern char* _rl_term_DC;
extern char* _rl_term_up;
extern char* _rl_term_dc;
extern char* _rl_term_cr;
extern char* _rl_term_IC;
extern char* _rl_term_forward_char;
extern int   _rl_screenheight;
extern int   _rl_screenwidth;
extern int   _rl_screenchars;
extern int   _rl_terminal_can_insert;
extern int   _rl_term_autowrap;

/* text.c */
extern int _rl_optimize_typeahead;

/* undo.c */
extern int _rl_doing_an_undo;
extern int _rl_undo_group_level;

/* vi_mode.c */
extern int               _rl_vi_last_command;
extern int               _rl_vi_redoing;
extern _rl_vimotion_cxt* _rl_vimvcxt;

#endif /* _RL_PRIVATE_H_ */