* NEWS: Mention pointer to member improvements.
[deliverable/binutils-gdb.git] / gdb / value.h
CommitLineData
c906108c 1/* Definitions for values of C expressions, for GDB.
dea7f9ba 2
197e01b6 3 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994,
0d5de010
DJ
4 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 2006
338d7c5c 6 Free Software Foundation, Inc.
c906108c 7
c5aa993b 8 This file is part of GDB.
c906108c 9
c5aa993b
JM
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
c906108c 14
c5aa993b
JM
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
c906108c 19
c5aa993b
JM
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
197e01b6
EZ
22 Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 Boston, MA 02110-1301, USA. */
c906108c
SS
24
25#if !defined (VALUE_H)
26#define VALUE_H 1
27
dea7f9ba 28#include "doublest.h"
1df6926e 29#include "frame.h" /* For struct frame_id. */
dea7f9ba
MK
30
31struct block;
da3331ec 32struct expression;
dea7f9ba 33struct regcache;
da3331ec
AC
34struct symbol;
35struct type;
dea7f9ba 36struct ui_file;
d16aafd8 37
dea7f9ba
MK
38/* The structure which defines the type of a value. It should never
39 be possible for a program lval value to survive over a call to the
40 inferior (i.e. to be put into the history list or an internal
41 variable). */
c906108c 42
91294c83 43struct value;
c906108c 44
17cf0ecd
AC
45/* Values are stored in a chain, so that they can be deleted easily
46 over calls to the inferior. Values assigned to internal variables
47 or put into the value history are taken off this list. */
91294c83 48
17cf0ecd
AC
49struct value *value_next (struct value *);
50
91294c83
AC
51/* Type of the value. */
52
df407dfe 53extern struct type *value_type (struct value *);
91294c83 54
04624583
AC
55/* This is being used to change the type of an existing value, that
56 code should instead be creating a new value with the changed type
57 (but possibly shared content). */
91294c83 58
04624583
AC
59extern void deprecated_set_value_type (struct value *value,
60 struct type *type);
91294c83
AC
61
62/* Only used for bitfields; number of bits contained in them. */
63
df407dfe 64extern int value_bitsize (struct value *);
9bbda503 65extern void set_value_bitsize (struct value *, int bit);
91294c83
AC
66
67/* Only used for bitfields; position of start of field. For
68 BITS_BIG_ENDIAN=0 targets, it is the position of the LSB. For
69 BITS_BIG_ENDIAN=1 targets, it is the position of the MSB. */
70
df407dfe 71extern int value_bitpos (struct value *);
9bbda503 72extern void set_value_bitpos (struct value *, int bit);
f5cf64a7 73
91294c83
AC
74/* Describes offset of a value within lval of a structure in bytes.
75 If lval == lval_memory, this is an offset to the address. If lval
76 == lval_register, this is a further offset from location.address
77 within the registers structure. Note also the member
78 embedded_offset below. */
79
df407dfe 80extern int value_offset (struct value *);
f5cf64a7 81extern void set_value_offset (struct value *, int offset);
df407dfe 82
88e3b34b
AC
83/* The comment from "struct value" reads: ``Is it modifiable? Only
84 relevant if lval != not_lval.''. Shouldn't the value instead be
85 not_lval and be done with it? */
91294c83 86
88e3b34b
AC
87extern int deprecated_value_modifiable (struct value *value);
88extern void deprecated_set_value_modifiable (struct value *value,
89 int modifiable);
90
91294c83
AC
91/* If a value represents a C++ object, then the `type' field gives the
92 object's compile-time type. If the object actually belongs to some
93 class derived from `type', perhaps with other base classes and
94 additional members, then `type' is just a subobject of the real
95 thing, and the full object is probably larger than `type' would
96 suggest.
97
98 If `type' is a dynamic class (i.e. one with a vtable), then GDB can
99 actually determine the object's run-time type by looking at the
100 run-time type information in the vtable. When this information is
101 available, we may elect to read in the entire object, for several
102 reasons:
103
104 - When printing the value, the user would probably rather see the
105 full object, not just the limited portion apparent from the
106 compile-time type.
107
108 - If `type' has virtual base classes, then even printing `type'
109 alone may require reaching outside the `type' portion of the
110 object to wherever the virtual base class has been stored.
111
112 When we store the entire object, `enclosing_type' is the run-time
113 type -- the complete object -- and `embedded_offset' is the offset
114 of `type' within that larger type, in bytes. The value_contents()
115 macro takes `embedded_offset' into account, so most GDB code
116 continues to see the `type' portion of the value, just as the
117 inferior would.
118
119 If `type' is a pointer to an object, then `enclosing_type' is a
120 pointer to the object's run-time type, and `pointed_to_offset' is
121 the offset in bytes from the full object to the pointed-to object
122 -- that is, the value `embedded_offset' would have if we followed
123 the pointer and fetched the complete object. (I don't really see
124 the point. Why not just determine the run-time type when you
125 indirect, and avoid the special case? The contents don't matter
126 until you indirect anyway.)
127
128 If we're not doing anything fancy, `enclosing_type' is equal to
129 `type', and `embedded_offset' is zero, so everything works
130 normally. */
131
4754a64e 132extern struct type *value_enclosing_type (struct value *);
91294c83
AC
133extern struct value *value_change_enclosing_type (struct value *val,
134 struct type *new_type);
135extern int value_pointed_to_offset (struct value *value);
136extern void set_value_pointed_to_offset (struct value *value, int val);
137extern int value_embedded_offset (struct value *value);
138extern void set_value_embedded_offset (struct value *value, int val);
139
140/* If zero, contents of this value are in the contents field. If
141 nonzero, contents are in inferior memory at address in the
142 location.address field plus the offset field (and the lval field
143 should be lval_memory).
144
145 WARNING: This field is used by the code which handles watchpoints
146 (see breakpoint.c) to decide whether a particular value can be
147 watched by hardware watchpoints. If the lazy flag is set for some
148 member of a value chain, it is assumed that this member of the
149 chain doesn't need to be watched as part of watching the value
150 itself. This is how GDB avoids watching the entire struct or array
151 when the user wants to watch a single struct member or array
152 element. If you ever change the way lazy flag is set and reset, be
153 sure to consider this use as well! */
154
d69fe07e 155extern int value_lazy (struct value *);
dfa52d88 156extern void set_value_lazy (struct value *value, int val);
dea7f9ba 157
0fd88904
AC
158/* value_contents() and value_contents_raw() both return the address
159 of the gdb buffer used to hold a copy of the contents of the lval.
160 value_contents() is used when the contents of the buffer are needed
dea7f9ba 161 -- it uses value_fetch_lazy() to load the buffer from the process
0fd88904
AC
162 being debugged if it hasn't already been loaded
163 (value_contents_writeable() is used when a writeable but fetched
164 buffer is required).. value_contents_raw() is used when data is
165 being stored into the buffer, or when it is certain that the
166 contents of the buffer are valid.
dea7f9ba 167
c906108c
SS
168 Note: The contents pointer is adjusted by the offset required to
169 get to the real subobject, if the value happens to represent
dea7f9ba 170 something embedded in a larger run-time object. */
c906108c 171
fc1a4b47 172extern gdb_byte *value_contents_raw (struct value *);
91294c83
AC
173
174/* Actual contents of the value. For use of this value; setting it
175 uses the stuff above. Not valid if lazy is nonzero. Target
176 byte-order. We force it to be aligned properly for any possible
177 value. Note that a value therefore extends beyond what is
178 declared here. */
179
fc1a4b47
AC
180extern const gdb_byte *value_contents (struct value *);
181extern gdb_byte *value_contents_writeable (struct value *);
c906108c
SS
182
183/* The ALL variants of the above two macros do not adjust the returned
dea7f9ba 184 pointer by the embedded_offset value. */
c5aa993b 185
fc1a4b47
AC
186extern gdb_byte *value_contents_all_raw (struct value *);
187extern const gdb_byte *value_contents_all (struct value *);
c5aa993b 188
f23631e4 189extern int value_fetch_lazy (struct value *val);
a6c442d8 190extern int value_contents_equal (struct value *val1, struct value *val2);
c906108c 191
91294c83
AC
192/* If nonzero, this is the value of a variable which does not actually
193 exist in the program. */
feb13ab0
AC
194extern int value_optimized_out (struct value *value);
195extern void set_value_optimized_out (struct value *value, int val);
c906108c 196
13bb5560
AC
197/* While the following fields are per- VALUE .CONTENT .PIECE (i.e., a
198 single value might have multiple LVALs), this hacked interface is
199 limited to just the first PIECE. Expect further change. */
91294c83
AC
200/* Type of value; either not an lval, or one of the various different
201 possible kinds of lval. */
13bb5560
AC
202extern enum lval_type *deprecated_value_lval_hack (struct value *);
203#define VALUE_LVAL(val) (*deprecated_value_lval_hack (val))
91294c83
AC
204
205/* If lval == lval_memory, this is the address in the inferior. If
206 lval == lval_register, this is the byte offset into the registers
207 structure. */
13bb5560
AC
208extern CORE_ADDR *deprecated_value_address_hack (struct value *);
209#define VALUE_ADDRESS(val) (*deprecated_value_address_hack (val))
91294c83
AC
210
211/* Pointer to internal variable. */
13bb5560
AC
212extern struct internalvar **deprecated_value_internalvar_hack (struct value *);
213#define VALUE_INTERNALVAR(val) (*deprecated_value_internalvar_hack (val))
91294c83
AC
214
215/* Frame register value is relative to. This will be described in the
216 lval enum above as "lval_register". */
13bb5560
AC
217extern struct frame_id *deprecated_value_frame_id_hack (struct value *);
218#define VALUE_FRAME_ID(val) (*deprecated_value_frame_id_hack (val))
91294c83
AC
219
220/* Register number if the value is from a register. */
13bb5560
AC
221extern short *deprecated_value_regnum_hack (struct value *);
222#define VALUE_REGNUM(val) (*deprecated_value_regnum_hack (val))
223
dea7f9ba 224/* Convert a REF to the object referenced. */
c906108c 225
994b9211 226extern struct value *coerce_ref (struct value *value);
c906108c
SS
227
228/* If ARG is an array, convert it to a pointer.
229 If ARG is an enum, convert it to an integer.
230 If ARG is a function, convert it to a function pointer.
231
232 References are dereferenced. */
233
994b9211
AC
234extern struct value *coerce_array (struct value *value);
235extern struct value *coerce_number (struct value *value);
c906108c 236
c906108c
SS
237/* If ARG is an enum, convert it to an integer. */
238
994b9211 239extern struct value *coerce_enum (struct value *value);
c906108c
SS
240
241/* Internal variables (variables for convenience of use of debugger)
242 are recorded as a chain of these structures. */
243
244struct internalvar
dea7f9ba
MK
245{
246 struct internalvar *next;
247 char *name;
248 struct value *value;
d3c139e9 249 int endian;
dea7f9ba 250};
c906108c 251
c906108c 252\f
c5aa993b 253
c906108c
SS
254#include "symtab.h"
255#include "gdbtypes.h"
256#include "expression.h"
257
c906108c
SS
258struct frame_info;
259struct fn_field;
c906108c 260
d9fcf2fb 261extern void print_address_demangle (CORE_ADDR, struct ui_file *, int);
c906108c 262
f23631e4 263extern LONGEST value_as_long (struct value *val);
f23631e4 264extern DOUBLEST value_as_double (struct value *val);
f23631e4 265extern CORE_ADDR value_as_address (struct value *val);
c906108c 266
fc1a4b47
AC
267extern LONGEST unpack_long (struct type *type, const gdb_byte *valaddr);
268extern DOUBLEST unpack_double (struct type *type, const gdb_byte *valaddr,
66140c26 269 int *invp);
fc1a4b47 270extern CORE_ADDR unpack_pointer (struct type *type, const gdb_byte *valaddr);
8929e59d 271extern LONGEST unpack_field_as_long (struct type *type,
fc1a4b47 272 const gdb_byte *valaddr,
a14ed312 273 int fieldno);
c906108c 274
f23631e4 275extern struct value *value_from_longest (struct type *type, LONGEST num);
f23631e4 276extern struct value *value_from_pointer (struct type *type, CORE_ADDR addr);
f23631e4 277extern struct value *value_from_double (struct type *type, DOUBLEST num);
f23631e4 278extern struct value *value_from_string (char *string);
0f71a2f6 279
00a4c844
AC
280extern struct value *value_at (struct type *type, CORE_ADDR addr);
281extern struct value *value_at_lazy (struct type *type, CORE_ADDR addr);
c906108c 282
f23631e4
AC
283extern struct value *value_from_register (struct type *type, int regnum,
284 struct frame_info *frame);
c906108c 285
0b2b0195
UW
286extern CORE_ADDR address_from_register (struct type *type, int regnum,
287 struct frame_info *frame);
288
f23631e4 289extern struct value *value_of_variable (struct symbol *var, struct block *b);
c906108c 290
89f5065b 291extern struct value *value_of_register (int regnum, struct frame_info *frame);
c906108c 292
a14ed312 293extern int symbol_read_needs_frame (struct symbol *);
c906108c 294
f23631e4
AC
295extern struct value *read_var_value (struct symbol *var,
296 struct frame_info *frame);
c906108c 297
f23631e4
AC
298extern struct value *locate_var_value (struct symbol *var,
299 struct frame_info *frame);
c906108c 300
f23631e4 301extern struct value *allocate_value (struct type *type);
c906108c 302
f23631e4 303extern struct value *allocate_repeat_value (struct type *type, int count);
c906108c 304
f23631e4 305extern struct value *value_mark (void);
c906108c 306
f23631e4 307extern void value_free_to_mark (struct value *mark);
c906108c 308
f23631e4
AC
309extern struct value *value_string (char *ptr, int len);
310extern struct value *value_bitstring (char *ptr, int len);
c906108c 311
f23631e4 312extern struct value *value_array (int lowbound, int highbound,
89f5065b 313 struct value **elemvec);
c906108c 314
f23631e4 315extern struct value *value_concat (struct value *arg1, struct value *arg2);
c906108c 316
f23631e4
AC
317extern struct value *value_binop (struct value *arg1, struct value *arg2,
318 enum exp_opcode op);
c906108c 319
f23631e4 320extern struct value *value_add (struct value *arg1, struct value *arg2);
c906108c 321
f23631e4 322extern struct value *value_sub (struct value *arg1, struct value *arg2);
c906108c 323
f23631e4 324extern struct value *value_coerce_array (struct value *arg1);
c906108c 325
f23631e4 326extern struct value *value_coerce_function (struct value *arg1);
c906108c 327
f23631e4 328extern struct value *value_ind (struct value *arg1);
c906108c 329
f23631e4 330extern struct value *value_addr (struct value *arg1);
c906108c 331
fb933624
DJ
332extern struct value *value_ref (struct value *arg1);
333
89f5065b
AC
334extern struct value *value_assign (struct value *toval,
335 struct value *fromval);
c906108c 336
36e9969c
NS
337extern struct value *value_pos (struct value *arg1);
338
f23631e4 339extern struct value *value_neg (struct value *arg1);
c906108c 340
f23631e4 341extern struct value *value_complement (struct value *arg1);
c906108c 342
f23631e4
AC
343extern struct value *value_struct_elt (struct value **argp,
344 struct value **args,
345 char *name, int *static_memfuncp,
346 char *err);
c906108c 347
79c2c32d 348extern struct value *value_aggregate_elt (struct type *curtype,
0d5de010
DJ
349 char *name,
350 int want_address,
351 enum noside noside);
c906108c 352
f23631e4 353extern struct value *value_static_field (struct type *type, int fieldno);
c906108c 354
f23631e4 355extern struct fn_field *value_find_oload_method_list (struct value **, char *,
4a1970e4 356 int, int *,
a14ed312 357 struct type **, int *);
7a292a7a 358
a14ed312
KB
359extern int find_overload_match (struct type **arg_types, int nargs,
360 char *name, int method, int lax,
7f8c9282 361 struct value **objp, struct symbol *fsym,
f23631e4 362 struct value **valp, struct symbol **symp,
a14ed312 363 int *staticp);
c906108c 364
f23631e4 365extern struct value *value_field (struct value *arg1, int fieldno);
c906108c 366
f23631e4
AC
367extern struct value *value_primitive_field (struct value *arg1, int offset,
368 int fieldno,
369 struct type *arg_type);
c906108c 370
c906108c 371
f23631e4
AC
372extern struct type *value_rtti_target_type (struct value *, int *, int *,
373 int *);
c906108c 374
f23631e4
AC
375extern struct value *value_full_object (struct value *, struct type *, int,
376 int, int);
c906108c 377
fb933624
DJ
378extern struct value *value_cast_pointers (struct type *, struct value *);
379
f23631e4 380extern struct value *value_cast (struct type *type, struct value *arg2);
c906108c 381
f23631e4 382extern struct value *value_zero (struct type *type, enum lval_type lv);
c906108c 383
f23631e4 384extern struct value *value_repeat (struct value *arg1, int count);
c906108c 385
f23631e4 386extern struct value *value_subscript (struct value *array, struct value *idx);
c906108c 387
5fe830e4
AC
388extern struct value *register_value_being_returned (struct type *valtype,
389 struct regcache *retbuf);
c906108c 390
f23631e4 391extern struct value *value_in (struct value *element, struct value *set);
c906108c 392
fc1a4b47 393extern int value_bit_index (struct type *type, const gdb_byte *addr,
c84141d6 394 int index);
c906108c 395
48436ce6 396extern int using_struct_return (struct type *value_type, int gcc_p);
c906108c 397
f23631e4 398extern struct value *evaluate_expression (struct expression *exp);
c906108c 399
f23631e4 400extern struct value *evaluate_type (struct expression *exp);
c906108c 401
f23631e4
AC
402extern struct value *evaluate_subexp_with_coercion (struct expression *,
403 int *, enum noside);
c906108c 404
f23631e4 405extern struct value *parse_and_eval (char *exp);
c906108c 406
f23631e4 407extern struct value *parse_to_comma_and_eval (char **expp);
c906108c 408
a14ed312 409extern struct type *parse_and_eval_type (char *p, int length);
c906108c 410
a14ed312 411extern CORE_ADDR parse_and_eval_address (char *exp);
c906108c 412
a14ed312 413extern CORE_ADDR parse_and_eval_address_1 (char **expptr);
c906108c 414
bb518678
DT
415extern LONGEST parse_and_eval_long (char *exp);
416
f23631e4 417extern struct value *access_value_history (int num);
c906108c 418
f23631e4 419extern struct value *value_of_internalvar (struct internalvar *var);
c906108c 420
f23631e4 421extern void set_internalvar (struct internalvar *var, struct value *val);
c906108c 422
a14ed312
KB
423extern void set_internalvar_component (struct internalvar *var,
424 int offset,
425 int bitpos, int bitsize,
f23631e4 426 struct value *newvalue);
c906108c 427
a14ed312 428extern struct internalvar *lookup_internalvar (char *name);
c906108c 429
f23631e4 430extern int value_equal (struct value *arg1, struct value *arg2);
c906108c 431
f23631e4 432extern int value_less (struct value *arg1, struct value *arg2);
c906108c 433
f23631e4 434extern int value_logical_not (struct value *arg1);
c906108c
SS
435
436/* C++ */
437
f23631e4 438extern struct value *value_of_this (int complain);
c906108c 439
f23631e4
AC
440extern struct value *value_x_binop (struct value *arg1, struct value *arg2,
441 enum exp_opcode op,
442 enum exp_opcode otherop,
443 enum noside noside);
c906108c 444
f23631e4
AC
445extern struct value *value_x_unop (struct value *arg1, enum exp_opcode op,
446 enum noside noside);
c906108c 447
89f5065b 448extern struct value *value_fn_field (struct value **arg1p, struct fn_field *f,
f23631e4 449 int j, struct type *type, int offset);
c906108c 450
f23631e4
AC
451extern int binop_user_defined_p (enum exp_opcode op, struct value *arg1,
452 struct value *arg2);
c906108c 453
f23631e4 454extern int unop_user_defined_p (enum exp_opcode op, struct value *arg1);
c906108c 455
a14ed312 456extern int destructor_name_p (const char *name, const struct type *type);
c906108c 457
338d7c5c 458#define value_free(val) xfree (val)
c906108c 459
a14ed312 460extern void free_all_values (void);
c906108c 461
f23631e4 462extern void release_value (struct value *val);
c906108c 463
f23631e4 464extern int record_latest_value (struct value *val);
c906108c 465
fc1a4b47 466extern void modify_field (gdb_byte *addr, LONGEST fieldval, int bitpos,
570b8f7c 467 int bitsize);
c906108c 468
89f5065b
AC
469extern void type_print (struct type *type, char *varstring,
470 struct ui_file *stream, int show);
c906108c 471
fc1a4b47
AC
472extern gdb_byte *baseclass_addr (struct type *type, int index,
473 gdb_byte *valaddr,
8929e59d 474 struct value **valuep, int *errp);
c906108c 475
89f5065b 476extern void print_longest (struct ui_file *stream, int format,
d9fcf2fb 477 int use_local, LONGEST val);
c906108c 478
fc1a4b47 479extern void print_floating (const gdb_byte *valaddr, struct type *type,
89f5065b 480 struct ui_file *stream);
c906108c 481
f23631e4 482extern int value_print (struct value *val, struct ui_file *stream, int format,
d9fcf2fb 483 enum val_prettyprint pretty);
c906108c 484
f23631e4
AC
485extern void value_print_array_elements (struct value *val,
486 struct ui_file *stream, int format,
d9fcf2fb 487 enum val_prettyprint pretty);
c906108c 488
f23631e4 489extern struct value *value_release_to_mark (struct value *mark);
c906108c 490
fc1a4b47 491extern int val_print (struct type *type, const gdb_byte *valaddr,
d9fcf2fb 492 int embedded_offset, CORE_ADDR address,
89f5065b 493 struct ui_file *stream, int format,
d9fcf2fb
JM
494 int deref_ref, int recurse,
495 enum val_prettyprint pretty);
c906108c 496
806048c6
DJ
497extern int common_val_print (struct value *val,
498 struct ui_file *stream, int format,
499 int deref_ref, int recurse,
500 enum val_prettyprint pretty);
501
89f5065b
AC
502extern int val_print_string (CORE_ADDR addr, int len, int width,
503 struct ui_file *stream);
c906108c 504
89f5065b
AC
505extern void print_variable_value (struct symbol *var,
506 struct frame_info *frame,
d9fcf2fb 507 struct ui_file *stream);
c906108c 508
c68a6671 509extern int check_field (struct value *, const char *);
c906108c 510
89f5065b
AC
511extern void typedef_print (struct type *type, struct symbol *news,
512 struct ui_file *stream);
c906108c 513
a14ed312 514extern char *internalvar_name (struct internalvar *var);
c906108c 515
ae5a43e0 516extern void preserve_values (struct objfile *);
c906108c
SS
517
518/* From values.c */
519
f23631e4 520extern struct value *value_copy (struct value *);
c906108c 521
c906108c
SS
522/* From valops.c */
523
f23631e4 524extern struct value *varying_to_slice (struct value *);
c906108c 525
f23631e4 526extern struct value *value_slice (struct value *, int, int);
c906108c 527
f23631e4
AC
528extern struct value *value_literal_complex (struct value *, struct value *,
529 struct type *);
c906108c 530
c84141d6 531extern void find_rt_vbase_offset (struct type *, struct type *,
fc1a4b47 532 const gdb_byte *, int, int *, int *);
c906108c 533
3bada2a2 534extern struct value *find_function_in_inferior (const char *);
c906108c 535
f23631e4 536extern struct value *value_allocate_space_in_inferior (int);
c906108c 537
d069f99d
AF
538extern struct value *value_of_local (const char *name, int complain);
539
c5aa993b 540#endif /* !defined (VALUE_H) */
This page took 0.669983 seconds and 4 git commands to generate.