1 /* C language support definitions for GDB, the GNU debugger.
2 
3    Copyright (C) 1992-2021 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 extern void c_print_type (struct type *, const char *,
69 			  struct ui_file *, int, int,
70 			  const struct type_print_options *);
71 
72 /* Print a type but allow the precise language to be specified.  */
73 
74 extern void c_print_type (struct type *, const char *,
75 			  struct ui_file *, int, int,
76 			  enum language,
77 			  const struct type_print_options *);
78 
79 extern void c_print_typedef (struct type *,
80 			     struct symbol *,
81 			     struct ui_file *);
82 
83 /* Implement la_value_print_inner for the C family of languages.  */
84 
85 extern void c_value_print_inner (struct value *, struct ui_file *, int,
86 				 const struct value_print_options *);
87 
88 extern void c_value_print (struct value *, struct ui_file *,
89 			   const struct value_print_options *);
90 
91 /* These are in c-lang.c: */
92 
93 extern void c_printchar (int, struct type *, struct ui_file *);
94 
95 extern void c_printstr (struct ui_file * stream,
96 			struct type *elttype,
97 			const gdb_byte *string,
98 			unsigned int length,
99 			const char *user_encoding,
100 			int force_ellipses,
101 			const struct value_print_options *options);
102 
103 extern void c_language_arch_info (struct gdbarch *gdbarch,
104 				  struct language_arch_info *lai);
105 
106 extern void c_emit_char (int c, struct type *type,
107 			 struct ui_file *stream, int quoter);
108 
109 /* These are in c-typeprint.c: */
110 
111 extern void c_type_print_base (struct type *, struct ui_file *,
112 			       int, int, const struct type_print_options *);
113 
114 /* These are in cp-valprint.c */
115 
116 extern void cp_print_class_member (const gdb_byte *, struct type *,
117 				   struct ui_file *, const char *);
118 
119 extern void cp_print_value_fields (struct value *,
120 				   struct ui_file *, int,
121 				   const struct value_print_options *,
122 				   struct type **, int);
123 
124 /* gcc-2.6 or later (when using -fvtable-thunks)
125    emits a unique named type for a vtable entry.
126    Some gdb code depends on that specific name.  */
127 
128 extern const char vtbl_ptr_name[];
129 
130 extern int cp_is_vtbl_ptr_type (struct type *);
131 
132 extern int cp_is_vtbl_member (struct type *);
133 
134 /* Return true if TYPE is a string type.  Unlike DEFAULT_IS_STRING_TYPE_P
135    this will detect arrays of characters not just TYPE_CODE_STRING.  */
136 
137 extern bool c_is_string_type_p (struct type *type);
138 
139 /* These are in c-valprint.c.  */
140 
141 extern int c_textual_element_type (struct type *, char);
142 
143 /* Create a new instance of the C compiler and return it.  This
144    function never returns NULL, but rather throws an exception on
145    failure.  This is suitable for use as the
146    language_defn::get_compile_instance method.  */
147 
148 extern std::unique_ptr<compile_instance> c_get_compile_context ();
149 
150 /* Create a new instance of the C++ compiler and return it.  This
151    function never returns NULL, but rather throws an exception on
152    failure.  This is suitable for use as the
153    language_defn::get_compile_instance method.  */
154 
155 extern std::unique_ptr<compile_instance> cplus_get_compile_context ();
156 
157 /* This takes the user-supplied text and returns a new bit of code to
158    compile.
159 
160    This is used as the compute_program language method; see that
161    for a description of the arguments.  */
162 
163 extern std::string c_compute_program (compile_instance *inst,
164 				      const char *input,
165 				      struct gdbarch *gdbarch,
166 				      const struct block *expr_block,
167 				      CORE_ADDR expr_pc);
168 
169 /* This takes the user-supplied text and returns a new bit of code to compile.
170 
171    This is used as the compute_program language method; see that
172    for a description of the arguments.  */
173 
174 extern std::string cplus_compute_program (compile_instance *inst,
175 					  const char *input,
176 					  struct gdbarch *gdbarch,
177 					  const struct block *expr_block,
178 					  CORE_ADDR expr_pc);
179 
180 #endif /* !defined (C_LANG_H) */
181