contrib/texinfo/info/variables.h

   1 /* variables.h -- Description of user visible variables in Info.
   2    $Id: variables.h,v 1.9 2008/03/04 09:45:27 gray Exp $
   3
   4    This file is part of GNU Info, a program for reading online documentation
   5    stored in Info format.
   6
   7    Copyright (C) 1993, 1997, 2004, 2007 Free Software Foundation, Inc.
   8
   9    This program 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    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
  21
  22    Written by Brian Fox (bfox@ai.mit.edu). */
  23
  24 #ifndef INFO_VARIABLES_H
  25 #define INFO_VARIABLES_H
  26
  27 /* A variable (in the Info sense) is an integer value with a user-visible
  28    name.  You may supply an array of strings to complete over when the
  29    variable is set; in that case, the variable is set to the index of the
  30    string that the user chose.  If you supply a null list, the user can
  31    set the variable to a numeric value. */
  32
  33 /* Structure describing a user visible variable. */
  34 typedef struct {
  35   char *name;                   /* Polite name. */
  36   char *doc;                    /* Documentation string. */
  37   int *value;                   /* Address of value. */
  38   char **choices;               /* Array of strings or NULL if numeric only. */
  39 } VARIABLE_ALIST;
  40
  41 /* Read the name of an Info variable in the echo area and return the
  42    address of a VARIABLE_ALIST member.  A return value of NULL indicates
  43    that no variable could be read. */
  44 extern VARIABLE_ALIST *read_variable_name (const char *prompt, WINDOW *window);
  45
  46 /* Make an array of REFERENCE which actually contains the names of the
  47    variables available in Info. */
  48 extern REFERENCE **make_variable_completions_array (void);
  49
  50 /* Set the value of an info variable. */
  51 extern void set_variable (WINDOW *window, int count, unsigned char key);
  52 extern void describe_variable (WINDOW *window, int count, unsigned char key);
  53
  54 /* The list of user-visible variables. */
  55 extern int auto_footnotes_p;
  56 extern int auto_tiling_p;
  57 extern int terminal_use_visible_bell_p;
  58 extern int info_error_rings_bell_p;
  59 extern int gc_compressed_files;
  60 extern int show_index_match;
  61 extern int info_scroll_behaviour;
  62 extern int window_scroll_step;
  63 extern int cursor_movement_scrolls_p;
  64 extern int ISO_Latin_p;
  65 extern int scroll_last_node;
  66
  67 #endif /* not INFO_VARIABLES_H */