xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/c-lang.h (revision 3117ece4fc4a4ca4489ba793710b60b0d26bab6c)
1 /* C language support definitions for GDB, the GNU debugger.
2 
3    Copyright (C) 1992-2023 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19 
20 
21 #if !defined (C_LANG_H)
22 #define C_LANG_H 1
23 
24 struct ui_file;
25 struct language_arch_info;
26 struct type_print_options;
27 struct parser_state;
28 
29 #include "value.h"
30 #include "macroexp.h"
31 #include "gdbsupport/enum-flags.h"
32 
33 
34 /* The various kinds of C string and character.  Note that these
35    values are chosen so that they may be or'd together in certain
36    ways.  */
37 enum c_string_type_values : unsigned
38   {
39     /* An ordinary string: "value".  */
40     C_STRING = 0,
41     /* A wide string: L"value".  */
42     C_WIDE_STRING = 1,
43     /* A 16-bit Unicode string: u"value".  */
44     C_STRING_16 = 2,
45     /* A 32-bit Unicode string: U"value".  */
46     C_STRING_32 = 3,
47     /* An ordinary char: 'v'.  This can also be or'd with one of the
48        above to form the corresponding CHAR value from a STRING
49        value.  */
50     C_CHAR = 4,
51     /* A wide char: L'v'.  */
52     C_WIDE_CHAR = 5,
53     /* A 16-bit Unicode char: u'v'.  */
54     C_CHAR_16 = 6,
55     /* A 32-bit Unicode char: U'v'.  */
56     C_CHAR_32 = 7
57   };
58 
59 DEF_ENUM_FLAGS_TYPE (enum c_string_type_values, c_string_type);
60 
61 /* Defined in c-exp.y.  */
62 
63 extern int c_parse (struct parser_state *);
64 
65 extern int c_parse_escape (const char **, struct obstack *);
66 
67 /* Defined in c-typeprint.c */
68 
69 /* Print TYPE to STREAM using syntax appropriate for LANGUAGE, a
70    C-like language.  The other parameters are like
71    type_language_defn::print_type's.  */
72 
73 extern void c_print_type (struct type *type,
74 			  const char *varstring,
75 			  struct ui_file *stream,
76 			  int show, int level,
77 			  enum language language,
78 			  const struct type_print_options *flags);
79 
80 extern void c_print_typedef (struct type *,
81 			     struct symbol *,
82 			     struct ui_file *);
83 
84 /* Implement la_value_print_inner for the C family of languages.  */
85 
86 extern void c_value_print_inner (struct value *, struct ui_file *, int,
87 				 const struct value_print_options *);
88 
89 extern void c_value_print (struct value *, struct ui_file *,
90 			   const struct value_print_options *);
91 
92 /* These are in c-lang.c: */
93 
94 extern void c_printchar (int, struct type *, struct ui_file *);
95 
96 extern void c_language_arch_info (struct gdbarch *gdbarch,
97 				  struct language_arch_info *lai);
98 
99 /* These are in c-typeprint.c: */
100 
101 extern void c_type_print_base (struct type *, struct ui_file *,
102 			       int, int, const struct type_print_options *);
103 
104 /* These are in cp-valprint.c */
105 
106 extern void cp_print_class_member (const gdb_byte *, struct type *,
107 				   struct ui_file *, const char *);
108 
109 extern void cp_print_value_fields (struct value *,
110 				   struct ui_file *, int,
111 				   const struct value_print_options *,
112 				   struct type **, int);
113 
114 /* gcc-2.6 or later (when using -fvtable-thunks)
115    emits a unique named type for a vtable entry.
116    Some gdb code depends on that specific name.  */
117 
118 extern const char vtbl_ptr_name[];
119 
120 extern int cp_is_vtbl_ptr_type (struct type *);
121 
122 extern int cp_is_vtbl_member (struct type *);
123 
124 /* Return true if TYPE is a string type.  Unlike DEFAULT_IS_STRING_TYPE_P
125    this will detect arrays of characters not just TYPE_CODE_STRING.  */
126 
127 extern bool c_is_string_type_p (struct type *type);
128 
129 /* These are in c-valprint.c.  */
130 
131 extern int c_textual_element_type (struct type *, char);
132 
133 /* Create a new instance of the C compiler and return it.  This
134    function never returns NULL, but rather throws an exception on
135    failure.  This is suitable for use as the
136    language_defn::get_compile_instance method.  */
137 
138 extern std::unique_ptr<compile_instance> c_get_compile_context ();
139 
140 /* Create a new instance of the C++ compiler and return it.  This
141    function never returns NULL, but rather throws an exception on
142    failure.  This is suitable for use as the
143    language_defn::get_compile_instance method.  */
144 
145 extern std::unique_ptr<compile_instance> cplus_get_compile_context ();
146 
147 /* This takes the user-supplied text and returns a new bit of code to
148    compile.
149 
150    This is used as the compute_program language method; see that
151    for a description of the arguments.  */
152 
153 extern std::string c_compute_program (compile_instance *inst,
154 				      const char *input,
155 				      struct gdbarch *gdbarch,
156 				      const struct block *expr_block,
157 				      CORE_ADDR expr_pc);
158 
159 /* This takes the user-supplied text and returns a new bit of code to compile.
160 
161    This is used as the compute_program language method; see that
162    for a description of the arguments.  */
163 
164 extern std::string cplus_compute_program (compile_instance *inst,
165 					  const char *input,
166 					  struct gdbarch *gdbarch,
167 					  const struct block *expr_block,
168 					  CORE_ADDR expr_pc);
169 
170 /* Return the canonical form of the C symbol NAME.  If NAME is already
171    canonical, return nullptr.  */
172 
173 extern gdb::unique_xmalloc_ptr<char> c_canonicalize_name (const char *name);
174 
175 #endif /* !defined (C_LANG_H) */
176