1 /* indices.h -- Functions defined in indices.c.
2
3 Copyright 1993-2023 Free Software Foundation, Inc.
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 Originally written by Brian Fox. */
19
20 #ifndef INFO_INDICES_H
21 #define INFO_INDICES_H
22
23 /* User-visible variable controls the output of info-index-next. */
24 extern int show_index_match;
25
26 /* For every menu item in DIR, search the indices of that file for STRING. */
27 REFERENCE **apropos_in_all_indices (char *search_string, int inform);
28
29 /* User visible functions declared in indices.c. */
30 void info_index_search (WINDOW *window, int count);
31 void info_index_apropos (WINDOW *window, int count);
32 REFERENCE *next_index_match (FILE_BUFFER *fb, char *string,
33 int offset, int dir,
34 int *found_offset, int *match_offset);
35 void report_index_match (int i, int match_offset);
36 REFERENCE *look_in_indices (FILE_BUFFER *fb, char *string, int sloppy);
37 NODE *create_virtual_index (FILE_BUFFER *file_buffer, char *index_search);
38
39 #define APROPOS_NONE \
40 N_("No available info files have '%s' in their indices")
41
42 #endif /* not INFO_INDICES_H */