xref: /netbsd-src/external/gpl2/texinfo/dist/info/variables.h (revision 29619d2afe564e54d657b83e5a3ae89584f83720)
1*29619d2aSchristos /*	$NetBSD: variables.h,v 1.1.1.1 2016/01/14 00:11:29 christos Exp $	*/
2*29619d2aSchristos 
3*29619d2aSchristos /* variables.h -- Description of user visible variables in Info.
4*29619d2aSchristos    Id: variables.h,v 1.3 2004/04/11 17:56:46 karl Exp
5*29619d2aSchristos 
6*29619d2aSchristos    This file is part of GNU Info, a program for reading online documentation
7*29619d2aSchristos    stored in Info format.
8*29619d2aSchristos 
9*29619d2aSchristos    Copyright (C) 1993, 1997, 2004 Free Software Foundation, Inc.
10*29619d2aSchristos 
11*29619d2aSchristos    This program is free software; you can redistribute it and/or modify
12*29619d2aSchristos    it under the terms of the GNU General Public License as published by
13*29619d2aSchristos    the Free Software Foundation; either version 2, or (at your option)
14*29619d2aSchristos    any later version.
15*29619d2aSchristos 
16*29619d2aSchristos    This program is distributed in the hope that it will be useful,
17*29619d2aSchristos    but WITHOUT ANY WARRANTY; without even the implied warranty of
18*29619d2aSchristos    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19*29619d2aSchristos    GNU General Public License for more details.
20*29619d2aSchristos 
21*29619d2aSchristos    You should have received a copy of the GNU General Public License
22*29619d2aSchristos    along with this program; if not, write to the Free Software
23*29619d2aSchristos    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24*29619d2aSchristos 
25*29619d2aSchristos    Written by Brian Fox (bfox@ai.mit.edu). */
26*29619d2aSchristos 
27*29619d2aSchristos #ifndef INFO_VARIABLES_H
28*29619d2aSchristos #define INFO_VARIABLES_H
29*29619d2aSchristos 
30*29619d2aSchristos /* A variable (in the Info sense) is an integer value with a user-visible
31*29619d2aSchristos    name.  You may supply an array of strings to complete over when the
32*29619d2aSchristos    variable is set; in that case, the variable is set to the index of the
33*29619d2aSchristos    string that the user chose.  If you supply a null list, the user can
34*29619d2aSchristos    set the variable to a numeric value. */
35*29619d2aSchristos 
36*29619d2aSchristos /* Structure describing a user visible variable. */
37*29619d2aSchristos typedef struct {
38*29619d2aSchristos   char *name;                   /* Polite name. */
39*29619d2aSchristos   char *doc;                    /* Documentation string. */
40*29619d2aSchristos   int *value;                   /* Address of value. */
41*29619d2aSchristos   char **choices;               /* Array of strings or NULL if numeric only. */
42*29619d2aSchristos } VARIABLE_ALIST;
43*29619d2aSchristos 
44*29619d2aSchristos /* Read the name of an Info variable in the echo area and return the
45*29619d2aSchristos    address of a VARIABLE_ALIST member.  A return value of NULL indicates
46*29619d2aSchristos    that no variable could be read. */
47*29619d2aSchristos extern VARIABLE_ALIST *read_variable_name (char *prompt, WINDOW *window);
48*29619d2aSchristos 
49*29619d2aSchristos /* Make an array of REFERENCE which actually contains the names of the
50*29619d2aSchristos    variables available in Info. */
51*29619d2aSchristos extern REFERENCE **make_variable_completions_array (void);
52*29619d2aSchristos 
53*29619d2aSchristos /* Set the value of an info variable. */
54*29619d2aSchristos extern void set_variable (WINDOW *window, int count, unsigned char key);
55*29619d2aSchristos extern void describe_variable (WINDOW *window, int count, unsigned char key);
56*29619d2aSchristos 
57*29619d2aSchristos /* The list of user-visible variables. */
58*29619d2aSchristos extern int auto_footnotes_p;
59*29619d2aSchristos extern int auto_tiling_p;
60*29619d2aSchristos extern int terminal_use_visible_bell_p;
61*29619d2aSchristos extern int info_error_rings_bell_p;
62*29619d2aSchristos extern int gc_compressed_files;
63*29619d2aSchristos extern int show_index_match;
64*29619d2aSchristos extern int info_scroll_behaviour;
65*29619d2aSchristos extern int window_scroll_step;
66*29619d2aSchristos extern int ISO_Latin_p;
67*29619d2aSchristos 
68*29619d2aSchristos #endif /* not INFO_VARIABLES_H */
69