1#ifndef HELP_H
2#define HELP_H
3
4struct string_list;
5
6struct cmdnames {
7 int alloc;
8 int cnt;
9 struct cmdname {
10 size_t len; /* also used for similarity index in help.c */
11 char name[FLEX_ARRAY];
12 } **names;
13};
14
15static inline void mput_char(char c, unsigned int num)
16{
17 while(num--)
18 putchar(c);
19}
20
21extern void list_common_cmds_help(void);
22extern void list_all_cmds_help(void);
23
24extern void list_all_main_cmds(struct string_list *list);
25extern void list_all_other_cmds(struct string_list *list);
26extern void list_cmds_by_category(struct string_list *list,
27 const char *category);
28extern const char *help_unknown_cmd(const char *cmd);
29extern void load_command_list(const char *prefix,
30 struct cmdnames *main_cmds,
31 struct cmdnames *other_cmds);
32extern void add_cmdname(struct cmdnames *cmds, const char *name, int len);
33/* Here we require that excludes is a sorted list. */
34extern void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes);
35extern int is_in_cmdlist(struct cmdnames *cmds, const char *name);
36extern void list_commands(unsigned int colopts, struct cmdnames *main_cmds, struct cmdnames *other_cmds);
37
38/*
39 * call this to die(), when it is suspected that the user mistyped a
40 * ref to the command, to give suggested "correct" refs.
41 */
42extern void help_unknown_ref(const char *ref, const char *cmd, const char *error);
43#endif /* HELP_H */