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 /* 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 struct value *evaluate_subexp_c (struct type *expect_type,
  95                                         struct expression *exp,
  96                                         int *pos,
  97                                         enum noside noside);
  98
  99 extern void c_printchar (int, struct type *, struct ui_file *);
 100
 101 extern void c_printstr (struct ui_file * stream,
 102                         struct type *elttype,
 103                         const gdb_byte *string,
 104                         unsigned int length,
 105                         const char *user_encoding,
 106                         int force_ellipses,
 107                         const struct value_print_options *options);
 108
 109 extern void c_language_arch_info (struct gdbarch *gdbarch,
 110                                   struct language_arch_info *lai);
 111
 112 extern const struct exp_descriptor exp_descriptor_c;
 113
 114 extern void c_emit_char (int c, struct type *type,
 115                          struct ui_file *stream, int quoter);
 116
 117 extern const struct op_print c_op_print_tab[];
 118
 119 extern gdb::unique_xmalloc_ptr<char> c_watch_location_expression
 120      (struct type *type, CORE_ADDR addr);
 121
 122 /* These are in c-typeprint.c: */
 123
 124 extern void c_type_print_base (struct type *, struct ui_file *,
 125                                int, int, const struct type_print_options *);
 126
 127 /* These are in cp-valprint.c */
 128
 129 extern void cp_print_class_member (const gdb_byte *, struct type *,
 130                                    struct ui_file *, const char *);
 131
 132 extern void cp_print_value_fields (struct value *,
 133                                    struct ui_file *, int,
 134                                    const struct value_print_options *,
 135                                    struct type **, int);
 136
 137 /* gcc-2.6 or later (when using -fvtable-thunks)
 138    emits a unique named type for a vtable entry.
 139    Some gdb code depends on that specific name.  */
 140
 141 extern const char vtbl_ptr_name[];
 142
 143 extern int cp_is_vtbl_ptr_type (struct type *);
 144
 145 extern int cp_is_vtbl_member (struct type *);
 146
 147 /* Return true if TYPE is a string type.  Unlike DEFAULT_IS_STRING_TYPE_P
 148    this will detect arrays of characters not just TYPE_CODE_STRING.  */
 149
 150 extern bool c_is_string_type_p (struct type *type);
 151
 152 /* These are in c-valprint.c.  */
 153
 154 extern int c_textual_element_type (struct type *, char);
 155
 156 /* Create a new instance of the C compiler and return it.  The new
 157    compiler is owned by the caller and must be freed using the destroy
 158    method.  This function never returns NULL, but rather throws an
 159    exception on failure.  This is suitable for use as the
 160    language_defn::get_compile_instance method.  */
 161
 162 extern compile_instance *c_get_compile_context (void);
 163
 164 /* Create a new instance of the C++ compiler and return it.  The new
 165    compiler is owned by the caller and must be freed using the destroy
 166    method.  This function never returns NULL, but rather throws an
 167    exception on failure.  This is suitable for use as the
 168    language_defn::get_compile_instance method.  */
 169
 170 extern compile_instance *cplus_get_compile_context ();
 171
 172 /* This takes the user-supplied text and returns a new bit of code to
 173    compile.
 174
 175    This is used as the la_compute_program language method; see that
 176    for a description of the arguments.  */
 177
 178 extern std::string c_compute_program (compile_instance *inst,
 179                                       const char *input,
 180                                       struct gdbarch *gdbarch,
 181                                       const struct block *expr_block,
 182                                       CORE_ADDR expr_pc);
 183
 184 /* This takes the user-supplied text and returns a new bit of code to compile.
 185
 186    This is used as the la_compute_program language method; see that
 187    for a description of the arguments.  */
 188
 189 extern std::string cplus_compute_program (compile_instance *inst,
 190                                           const char *input,
 191                                           struct gdbarch *gdbarch,
 192                                           const struct block *expr_block,
 193                                           CORE_ADDR expr_pc);
 194
 195 #endif /* !defined (C_LANG_H) */