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