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