gdb/c-lang.h

   1 /* C language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 1992-2024 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 struct compile_instance;
  29
  30 #include "compile/compile.h"
  31 #include "value.h"
  32 #include "macroexp.h"
  33 #include "gdbsupport/enum-flags.h"
  34
  35
  36 /* The various kinds of C string and character.  Note that these
  37    values are chosen so that they may be or'd together in certain
  38    ways.  */
  39 enum c_string_type_values : unsigned
  40   {
  41     /* An ordinary string: "value".  */
  42     C_STRING = 0,
  43     /* A wide string: L"value".  */
  44     C_WIDE_STRING = 1,
  45     /* A 16-bit Unicode string: u"value".  */
  46     C_STRING_16 = 2,
  47     /* A 32-bit Unicode string: U"value".  */
  48     C_STRING_32 = 3,
  49     /* An ordinary char: 'v'.  This can also be or'd with one of the
  50        above to form the corresponding CHAR value from a STRING
  51        value.  */
  52     C_CHAR = 4,
  53     /* A wide char: L'v'.  */
  54     C_WIDE_CHAR = 5,
  55     /* A 16-bit Unicode char: u'v'.  */
  56     C_CHAR_16 = 6,
  57     /* A 32-bit Unicode char: U'v'.  */
  58     C_CHAR_32 = 7
  59   };
  60
  61 DEF_ENUM_FLAGS_TYPE (enum c_string_type_values, c_string_type);
  62
  63 /* Defined in c-exp.y.  */
  64
  65 extern int c_parse (struct parser_state *);
  66
  67 extern int c_parse_escape (const char **, struct obstack *);
  68
  69 /* Defined in c-typeprint.c */
  70
  71 /* Print TYPE to STREAM using syntax appropriate for LANGUAGE, a
  72    C-like language.  The other parameters are like
  73    type_language_defn::print_type's.  */
  74
  75 extern void c_print_type (struct type *type,
  76                           const char *varstring,
  77                           struct ui_file *stream,
  78                           int show, int level,
  79                           enum language language,
  80                           const struct type_print_options *flags);
  81
  82 extern void c_print_typedef (struct type *,
  83                              struct symbol *,
  84                              struct ui_file *);
  85
  86 /* Implement la_value_print_inner for the C family of languages.  */
  87
  88 extern void c_value_print_inner (struct value *, struct ui_file *, int,
  89                                  const struct value_print_options *);
  90
  91 extern void c_value_print (struct value *, struct ui_file *,
  92                            const struct value_print_options *);
  93
  94 /* These are in c-lang.c: */
  95
  96 extern void c_printchar (int, struct type *, struct ui_file *);
  97
  98 extern void c_language_arch_info (struct gdbarch *gdbarch,
  99                                   struct language_arch_info *lai);
 100
 101 /* These are in c-typeprint.c: */
 102
 103 extern void c_type_print_base (struct type *, struct ui_file *,
 104                                int, int, const struct type_print_options *);
 105
 106 /* These are in cp-valprint.c */
 107
 108 extern void cp_print_class_member (const gdb_byte *, struct type *,
 109                                    struct ui_file *, const char *);
 110
 111 extern void cp_print_value_fields (struct value *,
 112                                    struct ui_file *, int,
 113                                    const struct value_print_options *,
 114                                    struct type **, int);
 115
 116 /* gcc-2.6 or later (when using -fvtable-thunks)
 117    emits a unique named type for a vtable entry.
 118    Some gdb code depends on that specific name.  */
 119
 120 extern const char vtbl_ptr_name[];
 121
 122 extern int cp_is_vtbl_ptr_type (struct type *);
 123
 124 extern int cp_is_vtbl_member (struct type *);
 125
 126 /* Return true if TYPE is a string type.  Unlike DEFAULT_IS_STRING_TYPE_P
 127    this will detect arrays of characters not just TYPE_CODE_STRING.  */
 128
 129 extern bool c_is_string_type_p (struct type *type);
 130
 131 /* These are in c-valprint.c.  */
 132
 133 extern int c_textual_element_type (struct type *, char);
 134
 135 /* Create a new instance of the C compiler and return it.  This
 136    function never returns NULL, but rather throws an exception on
 137    failure.  This is suitable for use as the
 138    language_defn::get_compile_instance method.  */
 139
 140 extern std::unique_ptr<compile_instance> c_get_compile_context ();
 141
 142 /* Create a new instance of the C++ compiler and return it.  This
 143    function never returns NULL, but rather throws an exception on
 144    failure.  This is suitable for use as the
 145    language_defn::get_compile_instance method.  */
 146
 147 extern std::unique_ptr<compile_instance> cplus_get_compile_context ();
 148
 149 /* This takes the user-supplied text and returns a new bit of code to
 150    compile.
 151
 152    This is used as the compute_program language method; see that
 153    for a description of the arguments.  */
 154
 155 extern std::string c_compute_program (compile_instance *inst,
 156                                       const char *input,
 157                                       struct gdbarch *gdbarch,
 158                                       const struct block *expr_block,
 159                                       CORE_ADDR expr_pc);
 160
 161 /* This takes the user-supplied text and returns a new bit of code to compile.
 162
 163    This is used as the compute_program language method; see that
 164    for a description of the arguments.  */
 165
 166 extern std::string cplus_compute_program (compile_instance *inst,
 167                                           const char *input,
 168                                           struct gdbarch *gdbarch,
 169                                           const struct block *expr_block,
 170                                           CORE_ADDR expr_pc);
 171
 172 /* Return the canonical form of the C symbol NAME.  If NAME is already
 173    canonical, return nullptr.  */
 174
 175 extern gdb::unique_xmalloc_ptr<char> c_canonicalize_name (const char *name);
 176
 177 #endif /* !defined (C_LANG_H) */