contrib/texinfo/info/session.h

   1 /* session.h -- Functions found in session.c.
   2    $Id: session.h,v 1.10 2001/11/16 23:17:15 karl Exp $
   3
   4    Copyright (C) 1993, 98, 99, 2001 Free Software Foundation, Inc.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2, or (at your option)
   9    any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20    Written by Brian Fox (bfox@ai.mit.edu). */
  21
  22 #ifndef SESSION_H
  23 #define SESSION_H
  24
  25 #include "info.h"
  26 #include "dribble.h"
  27
  28 /* All commands that can be invoked from within info_session () receive
  29    arguments in the same way.  This simple define declares the header
  30    of a function named NAME, with associated documentation DOC.  The
  31    documentation string is groveled out of the source files by the
  32    utility program `makedoc', which is also responsible for making
  33    the documentation/function-pointer maps. */
  34 #define DECLARE_INFO_COMMAND(name, doc) \
  35 void name (window, count, key) WINDOW *window; int count; unsigned char key;
  36
  37 /* Variables found in session.h. */
  38 extern VFunction *info_last_executed_command;
  39
  40 /* Variable controlling the garbage collection of files briefly visited
  41    during searches.  Such files are normally gc'ed, unless they were
  42    compressed to begin with.  If this variable is non-zero, it says
  43    to gc even those file buffer contents which had to be uncompressed. */
  44 extern int gc_compressed_files;
  45
  46 /* When non-zero, tiling takes place automatically when info_split_window
  47    is called. */
  48 extern int auto_tiling_p;
  49
  50 /* Variable controlling the behaviour of default scrolling when you are
  51    already at the bottom of a node. */
  52 extern int info_scroll_behaviour;
  53 extern char *info_scroll_choices[];
  54
  55 /* Values for info_scroll_behaviour. */
  56 #define IS_Continuous 0 /* Try to get first menu item, or failing that, the
  57                            "Next:" pointer, or failing that, the "Up:" and
  58                            "Next:" of the up. */
  59 #define IS_NextOnly   1 /* Try to get "Next:" menu item. */
  60 #define IS_PageOnly   2 /* Simply give up at the bottom of a node. */
  61
  62 /* Utility functions found in session.c */
  63 extern void info_dispatch_on_key ();
  64 extern unsigned char info_get_input_char (), info_get_another_input_char ();
  65 extern unsigned char info_input_pending_p ();
  66 extern void remember_window_and_node (), set_remembered_pagetop_and_point ();
  67 extern void set_window_pagetop (), info_set_node_of_window ();
  68 extern void initialize_keyseq (), add_char_to_keyseq ();
  69 extern void info_gather_typeahead ();
  70 extern FILE_BUFFER *file_buffer_of_window ();
  71 extern long info_search_in_node (), info_target_search_node ();
  72 extern void info_select_reference ();
  73 extern int info_any_buffered_input_p ();
  74 extern void print_node ();
  75 extern void dump_node_to_file (), dump_nodes_to_file ();
  76 extern char *program_name_from_file_name ();
  77
  78 /* Do the physical deletion of WINDOW, and forget this window and
  79    associated nodes. */
  80 extern void info_delete_window_internal ();
  81
  82 /* Tell Info that input is coming from the file FILENAME. */
  83 extern void info_set_input_from_file ();
  84
  85 #define return_if_control_g(val) \
  86   do { \
  87     info_gather_typeahead (); \
  88     if (info_input_pending_p () == Control ('g')) \
  89       return (val); \
  90   } while (0)
  91
  92 /* The names of the functions that run an info session. */
  93
  94 /* Starting an info session. */
  95 extern void begin_multiple_window_info_session (), begin_info_session ();
  96 extern void begin_info_session_with_error (), info_session ();
  97 extern void info_read_and_dispatch ();
  98
  99 /* Moving the point within a node. */
 100 extern void info_next_line (), info_prev_line ();
 101 extern void info_end_of_line (), info_beginning_of_line ();
 102 extern void info_forward_char (), info_backward_char ();
 103 extern void info_forward_word (), info_backward_word ();
 104 extern void info_beginning_of_node (), info_end_of_node ();
 105 extern void info_move_to_prev_xref (), info_move_to_next_xref ();
 106
 107 /* Scrolling text within a window. */
 108 extern void info_scroll_forward (), info_scroll_backward ();
 109 extern void info_redraw_display (), info_toggle_wrap ();
 110 extern void info_move_to_window_line ();
 111 extern void info_up_line (), info_down_line ();
 112 extern void info_scroll_half_screen_down (), info_scroll_half_screen_up ();
 113
 114 /* Manipulating multiple windows. */
 115 extern void info_split_window (), info_delete_window ();
 116 extern void info_keep_one_window (), info_grow_window ();
 117 extern void info_scroll_other_window (), info_tile_windows ();
 118 extern void info_next_window (), info_prev_window ();
 119
 120 /* Selecting nodes. */
 121 extern void info_next_node (), info_prev_node (), info_up_node ();
 122 extern void info_last_node (), info_first_node (), info_history_node ();
 123 extern void info_goto_node (), info_top_node (), info_dir_node ();
 124 extern void info_global_next_node (), info_global_prev_node ();
 125 extern void info_kill_node (), info_view_file ();
 126 extern void info_menu_sequence ();
 127 extern NODE *info_follow_menus (/* initial_node, menus, errstr, errarg */);
 128
 129 /* Selecting cross references. */
 130 extern void info_menu_digit (), info_menu_item (), info_xref_item ();
 131 extern void info_find_menu (), info_select_reference_this_line ();
 132
 133 /* Hacking numeric arguments. */
 134 extern int info_explicit_arg, info_numeric_arg, info_numeric_arg_sign;
 135
 136 extern void info_add_digit_to_numeric_arg (), info_universal_argument ();
 137 extern void info_initialize_numeric_arg (), info_numeric_arg_digit_loop ();
 138
 139 /* Searching commands. */
 140 extern void info_search (), isearch_forward (), isearch_backward ();
 141 extern void info_search_case_sensitively (), info_search_backward ();
 142 extern void info_search_next (), info_search_previous ();
 143
 144 /* Dumping and printing nodes. */
 145 extern void info_print_node ();
 146
 147 /* Miscellaneous commands. */
 148 extern void info_abort_key (), info_quit (), info_do_lowercase_version ();
 149
 150 #endif /* not SESSION_H */