keep h8300 tests
[deliverable/binutils-gdb.git] / gdb / value.h
CommitLineData
bd5635a1 1/* Definitions for values of C expressions, for GDB.
6d34c236 2 Copyright 1986, 1987, 1989, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
bd5635a1
RP
3
4This file is part of GDB.
5
e17960fb 6This program is free software; you can redistribute it and/or modify
bd5635a1 7it under the terms of the GNU General Public License as published by
e17960fb
JG
8the Free Software Foundation; either version 2 of the License, or
9(at your option) any later version.
bd5635a1 10
e17960fb 11This program is distributed in the hope that it will be useful,
bd5635a1
RP
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
e17960fb
JG
17along with this program; if not, write to the Free Software
18Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
bd5635a1
RP
19
20#if !defined (VALUE_H)
21#define VALUE_H 1
01be6913 22
bd5635a1
RP
23/*
24 * The structure which defines the type of a value. It should never
25 * be possible for a program lval value to survive over a call to the inferior
26 * (ie to be put into the history list or an internal variable).
27 */
28enum lval_type {
29 /* Not an lval. */
30 not_lval,
31 /* In memory. Could be a saved register. */
32 lval_memory,
33 /* In a register. */
34 lval_register,
35 /* In a gdb internal variable. */
36 lval_internalvar,
37 /* Part of a gdb internal variable (structure field). */
38 lval_internalvar_component,
39 /* In a register series in a frame not the current one, which may have been
40 partially saved or saved in different places (otherwise would be
41 lval_register or lval_memory). */
e17960fb 42 lval_reg_frame_relative
bd5635a1
RP
43};
44
45struct value
46 {
47 /* Type of value; either not an lval, or one of the various
48 different possible kinds of lval. */
49 enum lval_type lval;
30974778
JK
50 /* Is it modifiable? Only relevant if lval != not_lval. */
51 int modifiable;
bd5635a1
RP
52 /* Location of value (if lval). */
53 union
54 {
55 /* Address in inferior or byte of registers structure. */
56 CORE_ADDR address;
35fcebce 57 /* Pointer to internal variable. */
bd5635a1
RP
58 struct internalvar *internalvar;
59 /* Number of register. Only used with
60 lval_reg_frame_relative. */
61 int regnum;
62 } location;
63 /* Describes offset of a value within lval a structure in bytes. */
64 int offset;
65 /* Only used for bitfields; number of bits contained in them. */
66 int bitsize;
35fcebce
PB
67 /* Only used for bitfields; position of start of field.
68 For BITS_BIG_ENDIAN=0 targets, it is the position of the LSB.
69 For BITS_BIG_ENDIAN=1 targets, it is the position of the MSB. */
bd5635a1
RP
70 int bitpos;
71 /* Frame value is relative to. In practice, this address is only
72 used if the value is stored in several registers in other than
73 the current frame, and these registers have not all been saved
74 at the same place in memory. This will be described in the
75 lval enum above as "lval_reg_frame_relative". */
76 CORE_ADDR frame_addr;
77 /* Type of the value. */
78 struct type *type;
79 /* Values are stored in a chain, so that they can be deleted
80 easily over calls to the inferior. Values assigned to internal
81 variables or put into the value history are taken off this
82 list. */
83 struct value *next;
ff87df19
JK
84
85 /* ??? When is this used? */
86 union {
87 CORE_ADDR memaddr;
88 char *myaddr;
89 } substring_addr;
90
bd5635a1
RP
91 /* If an lval is forced to repeat, a new value is created with
92 these fields set. The new value is not an lval. */
93 short repeated;
94 short repetitions;
95 /* Register number if the value is from a register. Is not kept
96 if you take a field of a structure that is stored in a
97 register. Shouldn't it be? */
98 short regno;
99 /* If zero, contents of this value are in the contents field.
100 If nonzero, contents are in inferior memory at address
101 in the location.address field plus the offset field
102 (and the lval field should be lval_memory). */
103 char lazy;
104 /* If nonzero, this is the value of a variable which does not
105 actually exist in the program. */
106 char optimized_out;
107 /* Actual contents of the value. For use of this value; setting
108 it uses the stuff above. Not valid if lazy is nonzero.
109 Target byte-order. We force it to be aligned properly for any
110 possible value. */
111 union {
112 long contents[1];
113 double force_double_align;
30974778 114 LONGEST force_longlong_align;
ff87df19 115 char *literal_data;
bd5635a1
RP
116 } aligner;
117
118 };
119
82a2edfb 120typedef struct value *value_ptr;
bd5635a1
RP
121
122#define VALUE_TYPE(val) (val)->type
123#define VALUE_LAZY(val) (val)->lazy
124/* VALUE_CONTENTS and VALUE_CONTENTS_RAW both return the address of
125 the gdb buffer used to hold a copy of the contents of the lval.
126 VALUE_CONTENTS is used when the contents of the buffer are needed --
127 it uses value_fetch_lazy() to load the buffer from the process being
128 debugged if it hasn't already been loaded. VALUE_CONTENTS_RAW is
129 used when data is being stored into the buffer, or when it is
130 certain that the contents of the buffer are valid. */
131#define VALUE_CONTENTS_RAW(val) ((char *) (val)->aligner.contents)
132#define VALUE_CONTENTS(val) ((void)(VALUE_LAZY(val) && value_fetch_lazy(val)),\
133 VALUE_CONTENTS_RAW(val))
82a2edfb 134extern int value_fetch_lazy PARAMS ((value_ptr val));
01be6913 135
bd5635a1
RP
136#define VALUE_LVAL(val) (val)->lval
137#define VALUE_ADDRESS(val) (val)->location.address
138#define VALUE_INTERNALVAR(val) (val)->location.internalvar
139#define VALUE_FRAME_REGNUM(val) ((val)->location.regnum)
140#define VALUE_FRAME(val) ((val)->frame_addr)
141#define VALUE_OFFSET(val) (val)->offset
142#define VALUE_BITSIZE(val) (val)->bitsize
143#define VALUE_BITPOS(val) (val)->bitpos
144#define VALUE_NEXT(val) (val)->next
145#define VALUE_REPEATED(val) (val)->repeated
146#define VALUE_REPETITIONS(val) (val)->repetitions
147#define VALUE_REGNO(val) (val)->regno
148#define VALUE_OPTIMIZED_OUT(val) ((val)->optimized_out)
149
a91a6192
SS
150/* This is probably not the right thing to do for in-gdb arrays. FIXME */
151/* Overload the contents field to store literal data for
152 arrays. */
153
ff87df19 154#define VALUE_LITERAL_DATA(val) ((val)->aligner.literal_data)
a91a6192 155
ff87df19 156/* Pointer to
a91a6192
SS
157 the base substring, for F77 string substring operators.
158 We use this ONLY when doing operations of the form
159
160 FOO= 'hello'
161 FOO(2:4) = 'foo'
162
ff87df19 163 In the above case VALUE_SUBSTRING_* would point to
a91a6192
SS
164 FOO(2) in the original FOO string.
165
166 Depending on whether the base object is allocated in the
ff87df19
JK
167 inferior or the superior process, use VALUE_SUBSTRING_MYADDR or
168 VALUE_SUBSTRING_MEMADDR. */
a91a6192 169
ff87df19
JK
170#define VALUE_SUBSTRING_MEMADDR(val) (val)->substring_addr.memaddr
171#define VALUE_SUBSTRING_MYADDR(val) (val)->substring_addr.myaddr
a91a6192 172
bd5635a1
RP
173/* Convert a REF to the object referenced. */
174
175#define COERCE_REF(arg) \
e17960fb 176{ if (TYPE_CODE (VALUE_TYPE (arg)) == TYPE_CODE_REF) \
bd5635a1
RP
177 arg = value_at_lazy (TYPE_TARGET_TYPE (VALUE_TYPE (arg)), \
178 unpack_long (VALUE_TYPE (arg), \
179 VALUE_CONTENTS (arg)));}
180
181/* If ARG is an array, convert it to a pointer.
182 If ARG is an enum, convert it to an integer.
183 If ARG is a function, convert it to a function pointer.
184
185 References are dereferenced. */
186
187#define COERCE_ARRAY(arg) \
188{ COERCE_REF(arg); \
189 if (VALUE_REPEATED (arg) \
190 || TYPE_CODE (VALUE_TYPE (arg)) == TYPE_CODE_ARRAY) \
191 arg = value_coerce_array (arg); \
192 if (TYPE_CODE (VALUE_TYPE (arg)) == TYPE_CODE_FUNC) \
193 arg = value_coerce_function (arg); \
194 if (TYPE_CODE (VALUE_TYPE (arg)) == TYPE_CODE_ENUM) \
195 arg = value_cast (builtin_type_unsigned_int, arg); \
196}
197
198/* If ARG is an enum, convert it to an integer. */
199
200#define COERCE_ENUM(arg) \
5573d7d4 201{ COERCE_REF (arg); \
bd5635a1
RP
202 if (TYPE_CODE (VALUE_TYPE (arg)) == TYPE_CODE_ENUM) \
203 arg = value_cast (builtin_type_unsigned_int, arg); \
204}
205
206/* Internal variables (variables for convenience of use of debugger)
207 are recorded as a chain of these structures. */
208
209struct internalvar
210{
211 struct internalvar *next;
212 char *name;
82a2edfb 213 value_ptr value;
bd5635a1 214};
01be6913 215
35fcebce
PB
216/* Pointer to member function. Depends on compiler implementation. */
217
218#define METHOD_PTR_IS_VIRTUAL(ADDR) ((ADDR) & 0x80000000)
219#define METHOD_PTR_FROM_VOFFSET(OFFSET) (0x80000000 + (OFFSET))
220#define METHOD_PTR_TO_VOFFSET(ADDR) (~0x80000000 & (ADDR))
221
bd5635a1
RP
222\f
223#include "symtab.h"
01be6913
PB
224#include "gdbtypes.h"
225#include "expression.h"
226
e17960fb 227#ifdef __STDC__
01be6913 228struct frame_info;
c7da3ed3 229struct fn_field;
e17960fb 230#endif
01be6913
PB
231
232extern void
30974778 233print_address_demangle PARAMS ((CORE_ADDR, GDB_FILE *, int));
01be6913 234
82a2edfb 235extern LONGEST value_as_long PARAMS ((value_ptr val));
01be6913 236
82a2edfb 237extern double value_as_double PARAMS ((value_ptr val));
01be6913 238
82a2edfb 239extern CORE_ADDR value_as_pointer PARAMS ((value_ptr val));
01be6913 240
82a2edfb 241extern LONGEST unpack_long PARAMS ((struct type *type, char *valaddr));
01be6913 242
82a2edfb
JK
243extern double unpack_double PARAMS ((struct type *type, char *valaddr,
244 int *invp));
01be6913 245
5573d7d4 246extern CORE_ADDR unpack_pointer PARAMS ((struct type *type, char *valaddr));
01be6913 247
5573d7d4
JK
248extern LONGEST unpack_field_as_long PARAMS ((struct type *type, char *valaddr,
249 int fieldno));
01be6913 250
82a2edfb 251extern value_ptr value_from_longest PARAMS ((struct type *type, LONGEST num));
01be6913 252
82a2edfb 253extern value_ptr value_from_double PARAMS ((struct type *type, double num));
01be6913 254
82a2edfb 255extern value_ptr value_at PARAMS ((struct type *type, CORE_ADDR addr));
01be6913 256
82a2edfb 257extern value_ptr value_at_lazy PARAMS ((struct type *type, CORE_ADDR addr));
01be6913 258
82a2edfb 259extern value_ptr value_from_register PARAMS ((struct type *type, int regnum,
5573d7d4 260 struct frame_info * frame));
01be6913 261
82a2edfb
JK
262extern value_ptr value_of_variable PARAMS ((struct symbol *var,
263 struct block *b));
01be6913 264
82a2edfb 265extern value_ptr value_of_register PARAMS ((int regnum));
01be6913 266
30974778
JK
267extern int symbol_read_needs_frame PARAMS ((struct symbol *));
268
82a2edfb
JK
269extern value_ptr read_var_value PARAMS ((struct symbol *var,
270 struct frame_info *frame));
01be6913 271
82a2edfb 272extern value_ptr locate_var_value PARAMS ((struct symbol *var,
5573d7d4 273 struct frame_info *frame));
01be6913 274
82a2edfb 275extern value_ptr allocate_value PARAMS ((struct type *type));
01be6913 276
82a2edfb 277extern value_ptr allocate_repeat_value PARAMS ((struct type *type, int count));
01be6913 278
82a2edfb 279extern value_ptr value_mark PARAMS ((void));
01be6913 280
82a2edfb 281extern void value_free_to_mark PARAMS ((value_ptr mark));
01be6913 282
82a2edfb 283extern value_ptr value_string PARAMS ((char *ptr, int len));
6d34c236 284extern value_ptr value_bitstring PARAMS ((char *ptr, int len));
01be6913 285
82a2edfb
JK
286extern value_ptr value_array PARAMS ((int lowbound, int highbound,
287 value_ptr *elemvec));
7efb57c3 288
82a2edfb 289extern value_ptr value_concat PARAMS ((value_ptr arg1, value_ptr arg2));
7efb57c3 290
82a2edfb
JK
291extern value_ptr value_binop PARAMS ((value_ptr arg1, value_ptr arg2,
292 enum exp_opcode op));
01be6913 293
82a2edfb 294extern value_ptr value_add PARAMS ((value_ptr arg1, value_ptr arg2));
01be6913 295
82a2edfb 296extern value_ptr value_sub PARAMS ((value_ptr arg1, value_ptr arg2));
01be6913 297
82a2edfb 298extern value_ptr value_coerce_array PARAMS ((value_ptr arg1));
01be6913 299
82a2edfb 300extern value_ptr value_coerce_function PARAMS ((value_ptr arg1));
01be6913 301
82a2edfb 302extern value_ptr value_ind PARAMS ((value_ptr arg1));
01be6913 303
82a2edfb 304extern value_ptr value_addr PARAMS ((value_ptr arg1));
01be6913 305
82a2edfb 306extern value_ptr value_assign PARAMS ((value_ptr toval, value_ptr fromval));
01be6913 307
82a2edfb 308extern value_ptr value_neg PARAMS ((value_ptr arg1));
01be6913 309
82a2edfb 310extern value_ptr value_complement PARAMS ((value_ptr arg1));
01be6913 311
999dd04b 312extern value_ptr value_struct_elt PARAMS ((value_ptr *argp, value_ptr *args,
82a2edfb
JK
313 char *name,
314 int *static_memfuncp, char *err));
01be6913 315
82a2edfb
JK
316extern value_ptr value_struct_elt_for_reference PARAMS ((struct type *domain,
317 int offset,
318 struct type *curtype,
319 char *name,
320 struct type *intype));
01be6913 321
82a2edfb 322extern value_ptr value_field PARAMS ((value_ptr arg1, int fieldno));
01be6913 323
82a2edfb
JK
324extern value_ptr value_primitive_field PARAMS ((value_ptr arg1, int offset,
325 int fieldno,
326 struct type *arg_type));
01be6913 327
82a2edfb 328extern value_ptr value_cast PARAMS ((struct type *type, value_ptr arg2));
01be6913 329
82a2edfb 330extern value_ptr value_zero PARAMS ((struct type *type, enum lval_type lv));
01be6913 331
82a2edfb 332extern value_ptr value_repeat PARAMS ((value_ptr arg1, int count));
01be6913 333
82a2edfb 334extern value_ptr value_subscript PARAMS ((value_ptr array, value_ptr idx));
01be6913 335
82a2edfb
JK
336extern value_ptr value_from_vtable_info PARAMS ((value_ptr arg,
337 struct type *type));
01be6913 338
82a2edfb
JK
339extern value_ptr value_being_returned PARAMS ((struct type *valtype,
340 char retbuf[REGISTER_BYTES],
341 int struct_return));
01be6913 342
82a2edfb 343extern value_ptr value_in PARAMS ((value_ptr element, value_ptr set));
30974778
JK
344
345extern int value_bit_index PARAMS ((struct type *type, char *addr, int index));
346
82a2edfb
JK
347extern int using_struct_return PARAMS ((value_ptr function, CORE_ADDR funcaddr,
348 struct type *value_type, int gcc_p));
01be6913 349
82a2edfb 350extern void set_return_value PARAMS ((value_ptr val));
01be6913 351
82a2edfb 352extern value_ptr evaluate_expression PARAMS ((struct expression *exp));
01be6913 353
82a2edfb 354extern value_ptr evaluate_type PARAMS ((struct expression *exp));
01be6913 355
82a2edfb 356extern value_ptr parse_and_eval PARAMS ((char *exp));
01be6913 357
82a2edfb 358extern value_ptr parse_to_comma_and_eval PARAMS ((char **expp));
01be6913 359
82a2edfb 360extern struct type *parse_and_eval_type PARAMS ((char *p, int length));
01be6913 361
82a2edfb 362extern CORE_ADDR parse_and_eval_address PARAMS ((char *exp));
01be6913 363
82a2edfb 364extern CORE_ADDR parse_and_eval_address_1 PARAMS ((char **expptr));
01be6913 365
82a2edfb 366extern value_ptr access_value_history PARAMS ((int num));
01be6913 367
82a2edfb 368extern value_ptr value_of_internalvar PARAMS ((struct internalvar *var));
01be6913 369
82a2edfb 370extern void set_internalvar PARAMS ((struct internalvar *var, value_ptr val));
01be6913 371
82a2edfb
JK
372extern void set_internalvar_component PARAMS ((struct internalvar *var,
373 int offset,
374 int bitpos, int bitsize,
375 value_ptr newvalue));
01be6913 376
82a2edfb 377extern struct internalvar *lookup_internalvar PARAMS ((char *name));
01be6913 378
82a2edfb 379extern int value_equal PARAMS ((value_ptr arg1, value_ptr arg2));
01be6913 380
82a2edfb 381extern int value_less PARAMS ((value_ptr arg1, value_ptr arg2));
01be6913 382
82a2edfb 383extern int value_logical_not PARAMS ((value_ptr arg1));
bd5635a1
RP
384
385/* C++ */
01be6913 386
82a2edfb 387extern value_ptr value_of_this PARAMS ((int complain));
01be6913 388
82a2edfb
JK
389extern value_ptr value_x_binop PARAMS ((value_ptr arg1, value_ptr arg2,
390 enum exp_opcode op,
391 enum exp_opcode otherop));
01be6913 392
82a2edfb 393extern value_ptr value_x_unop PARAMS ((value_ptr arg1, enum exp_opcode op));
01be6913 394
82a2edfb
JK
395extern value_ptr value_fn_field PARAMS ((value_ptr *arg1p, struct fn_field *f,
396 int j,
397 struct type* type, int offset));
01be6913 398
82a2edfb
JK
399extern value_ptr value_virtual_fn_field PARAMS ((value_ptr *arg1p,
400 struct fn_field *f, int j,
401 struct type *type,
402 int offset));
01be6913 403
82a2edfb
JK
404extern int binop_user_defined_p PARAMS ((enum exp_opcode op,
405 value_ptr arg1, value_ptr arg2));
01be6913 406
82a2edfb 407extern int unop_user_defined_p PARAMS ((enum exp_opcode op, value_ptr arg1));
01be6913 408
82a2edfb
JK
409extern int destructor_name_p PARAMS ((const char *name,
410 const struct type *type));
bd5635a1 411
35fcebce 412#define value_free(val) free ((PTR)val)
01be6913 413
82a2edfb 414extern void free_all_values PARAMS ((void));
01be6913 415
82a2edfb 416extern void release_value PARAMS ((value_ptr val));
01be6913 417
82a2edfb 418extern int record_latest_value PARAMS ((value_ptr val));
01be6913 419
82a2edfb 420extern void registers_changed PARAMS ((void));
01be6913 421
82a2edfb 422extern void read_register_bytes PARAMS ((int regbyte, char *myaddr, int len));
01be6913 423
82a2edfb 424extern void write_register_bytes PARAMS ((int regbyte, char *myaddr, int len));
01be6913
PB
425
426extern void
427read_register_gen PARAMS ((int regno, char *myaddr));
428
429extern CORE_ADDR
430read_register PARAMS ((int regno));
431
432extern void
30974778 433write_register PARAMS ((int regno, LONGEST val));
01be6913
PB
434
435extern void
436supply_register PARAMS ((int regno, char *val));
437
01be6913
PB
438extern void
439get_saved_register PARAMS ((char *raw_buffer, int *optimized,
440 CORE_ADDR *addrp, struct frame_info *frame,
441 int regnum, enum lval_type *lval));
442
443extern void
5573d7d4 444modify_field PARAMS ((char *addr, LONGEST fieldval, int bitpos, int bitsize));
01be6913
PB
445
446extern void
30974778 447type_print PARAMS ((struct type *type, char *varstring, GDB_FILE *stream,
01be6913
PB
448 int show));
449
82a2edfb
JK
450extern char *baseclass_addr PARAMS ((struct type *type, int index,
451 char *valaddr,
452 value_ptr *valuep, int *errp));
01be6913 453
7efb57c3 454extern void
30974778
JK
455print_longest PARAMS ((GDB_FILE *stream, int format, int use_local,
456 LONGEST val));
7efb57c3 457
01be6913 458extern void
30974778 459print_floating PARAMS ((char *valaddr, struct type *type, GDB_FILE *stream));
01be6913 460
82a2edfb
JK
461extern int value_print PARAMS ((value_ptr val, GDB_FILE *stream, int format,
462 enum val_prettyprint pretty));
01be6913 463
a91a6192
SS
464extern void
465value_print_array_elements PARAMS ((value_ptr val, GDB_FILE* stream,
466 int format, enum val_prettyprint pretty));
467
999dd04b
JL
468extern value_ptr
469value_release_to_mark PARAMS ((value_ptr mark));
470
01be6913
PB
471extern int
472val_print PARAMS ((struct type *type, char *valaddr, CORE_ADDR address,
30974778 473 GDB_FILE *stream, int format, int deref_ref,
01be6913
PB
474 int recurse, enum val_prettyprint pretty));
475
c7da3ed3 476extern int
30974778 477val_print_string PARAMS ((CORE_ADDR addr, unsigned int len, GDB_FILE *stream));
c7da3ed3 478
01be6913
PB
479extern void
480print_variable_value PARAMS ((struct symbol *var, struct frame_info *frame,
30974778 481 GDB_FILE *stream));
01be6913 482
82a2edfb 483extern value_ptr value_arg_coerce PARAMS ((value_ptr));
01be6913 484
82a2edfb 485extern int check_field PARAMS ((value_ptr, const char *));
01be6913
PB
486
487extern void
6d34c236 488c_typedef_print PARAMS ((struct type *type, struct symbol *news, GDB_FILE *stream));
01be6913
PB
489
490extern char *
491internalvar_name PARAMS ((struct internalvar *var));
492
493extern void
494clear_value_history PARAMS ((void));
495
496extern void
497clear_internalvars PARAMS ((void));
498
499/* From values.c */
500
82a2edfb 501extern value_ptr value_copy PARAMS ((value_ptr));
01be6913 502
82a2edfb 503extern int baseclass_offset PARAMS ((struct type *, int, value_ptr, int));
c7da3ed3 504
01be6913 505/* From valops.c */
bd5635a1 506
82a2edfb 507extern value_ptr call_function_by_hand PARAMS ((value_ptr, int, value_ptr *));
e17960fb 508
a91a6192
SS
509extern value_ptr f77_value_literal_complex PARAMS ((value_ptr, value_ptr, int));
510
511extern value_ptr f77_value_literal_string PARAMS ((int, int, value_ptr *));
512
513extern value_ptr f77_value_substring PARAMS ((value_ptr, int, int));
514
01be6913 515#endif /* !defined (VALUE_H) */
This page took 0.327815 seconds and 4 git commands to generate.