contrib/texinfo-4/info/session.h

   1 /* session.h -- Functions found in session.c.
   2    $Id: session.h,v 1.3 2004/04/11 17:56:46 karl Exp $
   3
   4    Copyright (C) 1993, 1998, 1999, 2001, 2002, 2004 Free Software
   5    Foundation, Inc.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2, or (at your option)
  10    any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20
  21    Written by Brian Fox (bfox@ai.mit.edu). */
  22
  23 #ifndef SESSION_H
  24 #define SESSION_H
  25
  26 #include "info.h"
  27 #include "dribble.h"
  28
  29 /* All commands that can be invoked from within info_session () receive
  30    arguments in the same way.  This simple define declares the header
  31    of a function named NAME, with associated documentation DOC.  The
  32    documentation string is groveled out of the source files by the
  33    utility program `makedoc', which is also responsible for making
  34    the documentation/function-pointer maps. */
  35 #define DECLARE_INFO_COMMAND(name, doc) \
  36 void name (WINDOW *window, int count, unsigned char key)
  37
  38 /* Variables found in session.h. */
  39 extern VFunction *info_last_executed_command;
  40
  41 /* Variable controlling the garbage collection of files briefly visited
  42    during searches.  Such files are normally gc'ed, unless they were
  43    compressed to begin with.  If this variable is non-zero, it says
  44    to gc even those file buffer contents which had to be uncompressed. */
  45 extern int gc_compressed_files;
  46
  47 /* When non-zero, tiling takes place automatically when info_split_window
  48    is called. */
  49 extern int auto_tiling_p;
  50
  51 /* Variable controlling the behaviour of default scrolling when you are
  52    already at the bottom of a node. */
  53 extern int info_scroll_behaviour;
  54 extern char *info_scroll_choices[];
  55
  56 /* Values for info_scroll_behaviour. */
  57 #define IS_Continuous 0 /* Try to get first menu item, or failing that, the
  58                            "Next:" pointer, or failing that, the "Up:" and
  59                            "Next:" of the up. */
  60 #define IS_NextOnly   1 /* Try to get "Next:" menu item. */
  61 #define IS_PageOnly   2 /* Simply give up at the bottom of a node. */
  62
  63 /* Utility functions found in session.c */
  64 extern void info_dispatch_on_key (unsigned char key, Keymap map);
  65 extern unsigned char info_get_input_char (void);
  66 extern unsigned char info_get_another_input_char (void);
  67 extern unsigned char info_input_pending_p (void);
  68 extern void remember_window_and_node (WINDOW *window, NODE *node);
  69 extern void set_remembered_pagetop_and_point (WINDOW *window);
  70 extern void set_window_pagetop (WINDOW *window, int desired_top);
  71 extern void info_set_node_of_window (int remember, WINDOW *window,
  72     NODE *node);
  73 extern void initialize_keyseq (void);
  74 extern void add_char_to_keyseq (char character);
  75 extern void info_gather_typeahead (void);
  76 extern FILE_BUFFER *file_buffer_of_window (WINDOW *window);
  77 extern long info_search_in_node (char *string, NODE *node,
  78     long int start, WINDOW *window, int dir, int case_sensitive);
  79 extern long info_target_search_node (NODE *node, char *string,
  80     long int start);
  81 extern void info_select_reference (WINDOW *window, REFERENCE *entry);
  82 extern int info_any_buffered_input_p (void);
  83 extern void print_node (NODE *node);
  84 extern void dump_node_to_file (NODE *node, char *filename,
  85     int dump_subnodes);
  86 extern void dump_nodes_to_file (char *filename, char **nodenames,
  87     char *output_filename, int dump_subnodes);
  88 extern char *program_name_from_file_name (char *file_name);
  89
  90 /* Do the physical deletion of WINDOW, and forget this window and
  91    associated nodes. */
  92 extern void info_delete_window_internal (WINDOW *window);
  93
  94 /* Tell Info that input is coming from the file FILENAME. */
  95 extern void info_set_input_from_file (char *filename);
  96
  97 #define return_if_control_g(val) \
  98   do { \
  99     info_gather_typeahead (); \
 100     if (info_input_pending_p () == Control ('g')) \
 101       return (val); \
 102   } while (0)
 103
 104 /* The names of the functions that run an info session. */
 105
 106 /* Starting an info session. */
 107 extern void begin_multiple_window_info_session (char *filename,
 108     char **nodenames);
 109 extern void begin_info_session (NODE *initial_node);
 110 extern void begin_info_session_with_error (NODE *initial_node,
 111     char *format, void *arg1, void *arg2);
 112 extern void info_session (void);
 113 extern void initialize_info_session (NODE *node, int clear_screen);
 114 extern void info_read_and_dispatch (void);
 115 extern void info_intuit_options_node (WINDOW *window,
 116     NODE *initial_node, char *program);
 117
 118 /* Moving the point within a node. */
 119 extern void info_next_line (WINDOW *window, int count, unsigned char key);
 120 extern void info_prev_line (WINDOW *window, int count, unsigned char key);
 121 extern void info_end_of_line (WINDOW *window, int count, unsigned char key);
 122 extern void info_beginning_of_line (WINDOW *window, int count, unsigned char key);
 123 extern void info_forward_char (WINDOW *window, int count, unsigned char key);
 124 extern void info_backward_char (WINDOW *window, int count, unsigned char key);
 125 extern void info_forward_word (WINDOW *window, int count, unsigned char key);
 126 extern void info_backward_word (WINDOW *window, int count, unsigned char key);
 127 extern void info_beginning_of_node (WINDOW *window, int count, unsigned char key);
 128 extern void info_end_of_node (WINDOW *window, int count, unsigned char key);
 129 extern void info_move_to_prev_xref (WINDOW *window, int count, unsigned char key);
 130 extern void info_move_to_next_xref (WINDOW *window, int count, unsigned char key);
 131
 132 /* Scrolling text within a window. */
 133 extern void info_scroll_forward (WINDOW *window, int count, unsigned char key);
 134 extern void info_scroll_backward (WINDOW *window, int count, unsigned char key);
 135 extern void info_redraw_display (WINDOW *window, int count, unsigned char key);
 136 extern void info_toggle_wrap (WINDOW *window, int count, unsigned char key);
 137 extern void info_move_to_window_line (WINDOW *window, int count,
 138     unsigned char key);
 139 extern void info_up_line (WINDOW *window, int count, unsigned char key);
 140 extern void info_down_line (WINDOW *window, int count, unsigned char key);
 141 extern void info_scroll_half_screen_down (WINDOW *window, int count,
 142     unsigned char key);
 143 extern void info_scroll_half_screen_up (WINDOW *window, int count,
 144     unsigned char key);
 145 extern void info_scroll_forward_set_window (WINDOW *window, int count,
 146     unsigned char key);
 147 extern void info_scroll_forward_page_only (WINDOW *window, int count,
 148     unsigned char key);
 149 extern void info_scroll_forward_page_only_set_window (WINDOW *window, int count,
 150     unsigned char key);
 151 extern void info_scroll_backward_set_window (WINDOW *window, int count,
 152     unsigned char key);
 153 extern void info_scroll_backward_page_only (WINDOW *window, int count,
 154     unsigned char key);
 155 extern void info_scroll_backward_page_only_set_window (WINDOW *window, int count,
 156     unsigned char key);
 157 extern void info_scroll_other_window_backward (WINDOW *window, int count,
 158     unsigned char key);
 159
 160 /* Manipulating multiple windows. */
 161 extern void info_split_window (WINDOW *window, int count, unsigned char key);
 162 extern void info_delete_window (WINDOW *window, int count, unsigned char key);
 163 extern void info_keep_one_window (WINDOW *window, int count, unsigned char key);
 164 extern void info_grow_window (WINDOW *window, int count, unsigned char key);
 165 extern void info_scroll_other_window (WINDOW *window, int count,
 166     unsigned char key);
 167 extern void info_tile_windows (WINDOW *window, int count, unsigned char key);
 168 extern void info_next_window (WINDOW *window, int count, unsigned char key);
 169 extern void info_prev_window (WINDOW *window, int count, unsigned char key);
 170
 171 /* Selecting nodes. */
 172 extern void info_next_node (WINDOW *window, int count, unsigned char key);
 173 extern void info_prev_node (WINDOW *window, int count, unsigned char key);
 174 extern void info_up_node (WINDOW *window, int count, unsigned char key);
 175 extern void info_last_node (WINDOW *window, int count, unsigned char key);
 176 extern void info_first_node (WINDOW *window, int count, unsigned char key);
 177 extern void info_history_node (WINDOW *window, int count, unsigned char key);
 178 extern void info_goto_node (WINDOW *window, int count, unsigned char key);
 179 extern void info_goto_invocation_node (WINDOW *window, int count,
 180     unsigned char key);
 181 extern void info_top_node (WINDOW *window, int count, unsigned char key);
 182 extern void info_dir_node (WINDOW *window, int count, unsigned char key);
 183 extern void info_global_next_node (WINDOW *window, int count, unsigned char key);
 184 extern void info_global_prev_node (WINDOW *window, int count, unsigned char key);
 185 extern void info_kill_node (WINDOW *window, int count, unsigned char key);
 186 extern void info_view_file (WINDOW *window, int count, unsigned char key);
 187 extern void info_menu_sequence (WINDOW *window, int count, unsigned char key);
 188 extern NODE *info_follow_menus (NODE *initial_node, char **menus,
 189     const char **errstr, char **errarg1, char **errarg2);
 190 extern void info_man (WINDOW *window, int count, unsigned char key);
 191 extern void list_visited_nodes (WINDOW *window, int count, unsigned char key);
 192 extern void select_visited_node (WINDOW *window, int count, unsigned char key);
 193
 194 /* Selecting cross references. */
 195 extern void info_menu_digit (WINDOW *window, int count, unsigned char key);
 196 extern void info_menu_item (WINDOW *window, int count, unsigned char key);
 197 extern void info_xref_item (WINDOW *window, int count, unsigned char key);
 198 extern void info_find_menu (WINDOW *window, int count, unsigned char key);
 199 extern void info_select_reference_this_line (WINDOW *window, int count,
 200     unsigned char key);
 201 extern void info_last_menu_item (WINDOW *window, int count, unsigned char key);
 202 extern void info_visit_menu (WINDOW *window, int count, unsigned char key);
 203
 204 /* Hacking numeric arguments. */
 205 extern int info_explicit_arg, info_numeric_arg, info_numeric_arg_sign;
 206
 207 extern void info_add_digit_to_numeric_arg (WINDOW *window, int count,
 208     unsigned char key);
 209 extern void info_universal_argument (WINDOW *window, int count,
 210     unsigned char key);
 211 extern void info_initialize_numeric_arg (void);
 212 extern void info_numeric_arg_digit_loop (WINDOW *window, int count,
 213     unsigned char key);
 214
 215 /* Searching commands. */
 216 extern void info_search (WINDOW *window, int count, unsigned char key);
 217 extern void isearch_forward (WINDOW *window, int count, unsigned char key);
 218 extern void isearch_backward (WINDOW *window, int count, unsigned char key);
 219 extern void info_search_case_sensitively (WINDOW *window, int count,
 220     unsigned char key);
 221 extern void info_search_backward (WINDOW *window, int count, unsigned char key);
 222 extern void info_search_next (WINDOW *window, int count, unsigned char key);
 223 extern void info_search_previous (WINDOW *window, int count, unsigned char key);
 224
 225 /* Dumping and printing nodes. */
 226 extern void info_print_node (WINDOW *window, int count, unsigned char key);
 227
 228 /* Footnotes.  */
 229 extern void info_show_footnotes (WINDOW *window, int count, unsigned char key);
 230
 231 /* Miscellaneous commands. */
 232 extern void info_abort_key (WINDOW *window, int count, unsigned char key);
 233 extern void info_quit (WINDOW *window, int count, unsigned char key);
 234 extern void info_do_lowercase_version (WINDOW *window, int count,
 235     unsigned char key);
 236
 237 #endif /* not SESSION_H */