GCC Middle and Back End API Reference
opt-suggestions.h
Go to the documentation of this file.
1/* Provide suggestions to handle misspelled options, and implement the
2 --complete option for auto-completing options from a prefix.
3 Copyright (C) 2016-2024 Free Software Foundation, Inc.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21#ifndef GCC_OPT_PROPOSER_H
22#define GCC_OPT_PROPOSER_H
23
24/* Option proposer is class used by driver in order to provide hints
25 for wrong options provided. And it's used by --complete option that's
26 intended to be invoked by BASH in order to provide better option
27 completion support. */
28
30{
31public:
32 /* Default constructor. */
35
36 /* Default destructor. */
38
39 /* Helper function for driver::handle_unrecognized_options.
40
41 Given an unrecognized option BAD_OPT (without the leading dash),
42 locate the closest reasonable matching option (again, without the
43 leading dash), or NULL.
44
45 The returned string is owned by the option_proposer instance. */
46 const char *suggest_option (const char *bad_opt);
47
48 /* Print on stdout a list of valid options that begin with OPTION_PREFIX,
49 one per line, suitable for use by Bash completion.
50
51 Implementation of the "-completion=" option. */
52 void suggest_completion (const char *option_prefix);
53
54 /* Populate RESULTS with valid completions of options that begin
55 with OPTION_PREFIX. */
56 void get_completions (const char *option_prefix, auto_string_vec &results);
57
58private:
59 /* Helper function for option_proposer::suggest_option. Populate
60 m_option_suggestions with candidate strings for misspelled options.
61 The strings will be freed by the option_proposer's dtor.
62 PREFIX is used for bash completion suggestions, otherwise
63 it's set to NULL. */
64 void build_option_suggestions (const char *prefix);
65
66private:
67 /* Cache with all suggestions. */
69};
70
71#endif /* GCC_OPT_PROPOSER_H */
Definition vec.h:1783
Definition opt-suggestions.h:30
const char * suggest_option(const char *bad_opt)
Definition opt-suggestions.cc:37
void get_completions(const char *option_prefix, auto_string_vec &results)
Definition opt-suggestions.cc:54
void build_option_suggestions(const char *prefix)
Definition opt-suggestions.cc:96
option_proposer()
Definition opt-suggestions.h:33
auto_string_vec * m_option_suggestions
Definition opt-suggestions.h:68
~option_proposer()
Definition opt-suggestions.cc:31
void suggest_completion(const char *option_prefix)
Definition opt-suggestions.cc:87
#define NULL
Definition system.h:50