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