gdb/c-lang.h

   1 /* C language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 1992-2020 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 "parser-defs.h"
  32 #include "gdbsupport/enum-flags.h"
  33
  34
  35 /* The various kinds of C string and character.  Note that these
  36    values are chosen so that they may be or'd together in certain
  37    ways.  */
  38 enum c_string_type_values : unsigned
  39   {
  40     /* An ordinary string: "value".  */
  41     C_STRING = 0,
  42     /* A wide string: L"value".  */
  43     C_WIDE_STRING = 1,
  44     /* A 16-bit Unicode string: u"value".  */
  45     C_STRING_16 = 2,
  46     /* A 32-bit Unicode string: U"value".  */
  47     C_STRING_32 = 3,
  48     /* An ordinary char: 'v'.  This can also be or'd with one of the
  49        above to form the corresponding CHAR value from a STRING
  50        value.  */
  51     C_CHAR = 4,
  52     /* A wide char: L'v'.  */
  53     C_WIDE_CHAR = 5,
  54     /* A 16-bit Unicode char: u'v'.  */
  55     C_CHAR_16 = 6,
  56     /* A 32-bit Unicode char: U'v'.  */
  57     C_CHAR_32 = 7
  58   };
  59
  60 DEF_ENUM_FLAGS_TYPE (enum c_string_type_values, c_string_type);
  61
  62 /* Defined in c-exp.y.  */
  63
  64 extern int c_parse (struct parser_state *);
  65
  66 extern int c_parse_escape (const char **, struct obstack *);
  67
  68 /* Defined in c-typeprint.c */
  69 extern void c_print_type (struct type *, const char *,
  70                           struct ui_file *, int, int,
  71                           const struct type_print_options *);
  72
  73 /* Print a type but allow the precise language to be specified.  */
  74
  75 extern void c_print_type (struct type *, const char *,
  76                           struct ui_file *, int, int,
  77                           enum language,
  78                           const struct type_print_options *);
  79
  80 extern void c_print_typedef (struct type *,
  81                              struct symbol *,
  82                              struct ui_file *);
  83
  84 extern void c_val_print (struct type *,
  85                          int, CORE_ADDR,
  86                          struct ui_file *, int,
  87                          struct value *,
  88                          const struct value_print_options *);
  89
  90 extern void c_value_print (struct value *, struct ui_file *,
  91                            const struct value_print_options *);
  92
  93 /* These are in c-lang.c: */
  94
  95 extern struct value *evaluate_subexp_c (struct type *expect_type,
  96                                         struct expression *exp,
  97                                         int *pos,
  98                                         enum noside noside);
  99
 100 extern void c_printchar (int, struct type *, struct ui_file *);
 101
 102 extern void c_printstr (struct ui_file * stream,
 103                         struct type *elttype,
 104                         const gdb_byte *string,
 105                         unsigned int length,
 106                         const char *user_encoding,
 107                         int force_ellipses,
 108                         const struct value_print_options *options);
 109
 110 extern void c_language_arch_info (struct gdbarch *gdbarch,
 111                                   struct language_arch_info *lai);
 112
 113 extern const struct exp_descriptor exp_descriptor_c;
 114
 115 extern void c_emit_char (int c, struct type *type,
 116                          struct ui_file *stream, int quoter);
 117
 118 extern const struct op_print c_op_print_tab[];
 119
 120 extern gdb::unique_xmalloc_ptr<char> c_watch_location_expression
 121      (struct type *type, CORE_ADDR addr);
 122
 123 /* These are in c-typeprint.c: */
 124
 125 extern void c_type_print_base (struct type *, struct ui_file *,
 126                                int, int, const struct type_print_options *);
 127
 128 /* These are in cp-valprint.c */
 129
 130 extern void cp_print_class_member (const gdb_byte *, struct type *,
 131                                    struct ui_file *, const char *);
 132
 133 extern void cp_print_value_fields (struct type *, struct type *,
 134                                    LONGEST, CORE_ADDR,
 135                                    struct ui_file *, int,
 136                                    struct value *,
 137                                    const struct value_print_options *,
 138                                    struct type **, int);
 139
 140 extern void cp_print_value_fields_rtti (struct type *,
 141                                         const gdb_byte *, LONGEST, CORE_ADDR,
 142                                         struct ui_file *, int,
 143                                         struct value *,
 144                                         const struct value_print_options *,
 145                                         struct type **, int);
 146
 147 /* gcc-2.6 or later (when using -fvtable-thunks)
 148    emits a unique named type for a vtable entry.
 149    Some gdb code depends on that specific name.  */
 150
 151 extern const char vtbl_ptr_name[];
 152
 153 extern int cp_is_vtbl_ptr_type (struct type *);
 154
 155 extern int cp_is_vtbl_member (struct type *);
 156
 157 /* Return true if TYPE is a string type.  Unlike DEFAULT_IS_STRING_TYPE_P
 158    this will detect arrays of characters not just TYPE_CODE_STRING.  */
 159
 160 extern bool c_is_string_type_p (struct type *type);
 161
 162 /* These are in c-valprint.c.  */
 163
 164 extern int c_textual_element_type (struct type *, char);
 165
 166 /* Create a new instance of the C compiler and return it.  The new
 167    compiler is owned by the caller and must be freed using the destroy
 168    method.  This function never returns NULL, but rather throws an
 169    exception on failure.  This is suitable for use as the
 170    la_get_compile_instance language method.  */
 171
 172 extern compile_instance *c_get_compile_context (void);
 173
 174 /* Create a new instance of the C++ compiler and return it.  The new
 175    compiler is owned by the caller and must be freed using the destroy
 176    method.  This function never returns NULL, but rather throws an
 177    exception on failure.  This is suitable for use as the
 178    la_get_compile_instance language method.  */
 179
 180 extern compile_instance *cplus_get_compile_context ();
 181
 182 /* This takes the user-supplied text and returns a new bit of code to
 183    compile.
 184
 185    This is used as the la_compute_program language method; see that
 186    for a description of the arguments.  */
 187
 188 extern std::string c_compute_program (compile_instance *inst,
 189                                       const char *input,
 190                                       struct gdbarch *gdbarch,
 191                                       const struct block *expr_block,
 192                                       CORE_ADDR expr_pc);
 193
 194 /* This takes the user-supplied text and returns a new bit of code to compile.
 195
 196    This is used as the la_compute_program language method; see that
 197    for a description of the arguments.  */
 198
 199 extern std::string cplus_compute_program (compile_instance *inst,
 200                                           const char *input,
 201                                           struct gdbarch *gdbarch,
 202                                           const struct block *expr_block,
 203                                           CORE_ADDR expr_pc);
 204
 205 #endif /* !defined (C_LANG_H) */