constify some cli-utils stuff
[external/binutils.git] / gdb / value.h
1 /* Definitions for values of C expressions, for GDB.
2
3    Copyright (C) 1986-2014 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 #if !defined (VALUE_H)
21 #define VALUE_H 1
22
23 #include "doublest.h"
24 #include "frame.h"              /* For struct frame_id.  */
25
26 struct block;
27 struct expression;
28 struct regcache;
29 struct symbol;
30 struct type;
31 struct ui_file;
32 struct language_defn;
33 struct value_print_options;
34 struct xmethod_worker;
35
36 /* The structure which defines the type of a value.  It should never
37    be possible for a program lval value to survive over a call to the
38    inferior (i.e. to be put into the history list or an internal
39    variable).  */
40
41 struct value;
42
43 /* Values are stored in a chain, so that they can be deleted easily
44    over calls to the inferior.  Values assigned to internal variables,
45    put into the value history or exposed to Python are taken off this
46    list.  */
47
48 struct value *value_next (struct value *);
49
50 /* Type of the value.  */
51
52 extern struct type *value_type (const struct value *);
53
54 /* This is being used to change the type of an existing value, that
55    code should instead be creating a new value with the changed type
56    (but possibly shared content).  */
57
58 extern void deprecated_set_value_type (struct value *value,
59                                        struct type *type);
60
61 /* Only used for bitfields; number of bits contained in them.  */
62
63 extern int value_bitsize (const struct value *);
64 extern void set_value_bitsize (struct value *, int bit);
65
66 /* Only used for bitfields; position of start of field.  For
67    gdbarch_bits_big_endian=0 targets, it is the position of the LSB.  For
68    gdbarch_bits_big_endian=1 targets, it is the position of the MSB.  */
69
70 extern int value_bitpos (const struct value *);
71 extern void set_value_bitpos (struct value *, int bit);
72
73 /* Only used for bitfields; the containing value.  This allows a
74    single read from the target when displaying multiple
75    bitfields.  */
76
77 struct value *value_parent (struct value *);
78 extern void set_value_parent (struct value *value, struct value *parent);
79
80 /* Describes offset of a value within lval of a structure in bytes.
81    If lval == lval_memory, this is an offset to the address.  If lval
82    == lval_register, this is a further offset from location.address
83    within the registers structure.  Note also the member
84    embedded_offset below.  */
85
86 extern int value_offset (const struct value *);
87 extern void set_value_offset (struct value *, int offset);
88
89 /* The comment from "struct value" reads: ``Is it modifiable?  Only
90    relevant if lval != not_lval.''.  Shouldn't the value instead be
91    not_lval and be done with it?  */
92
93 extern int deprecated_value_modifiable (struct value *value);
94
95 /* If a value represents a C++ object, then the `type' field gives the
96    object's compile-time type.  If the object actually belongs to some
97    class derived from `type', perhaps with other base classes and
98    additional members, then `type' is just a subobject of the real
99    thing, and the full object is probably larger than `type' would
100    suggest.
101
102    If `type' is a dynamic class (i.e. one with a vtable), then GDB can
103    actually determine the object's run-time type by looking at the
104    run-time type information in the vtable.  When this information is
105    available, we may elect to read in the entire object, for several
106    reasons:
107
108    - When printing the value, the user would probably rather see the
109      full object, not just the limited portion apparent from the
110      compile-time type.
111
112    - If `type' has virtual base classes, then even printing `type'
113      alone may require reaching outside the `type' portion of the
114      object to wherever the virtual base class has been stored.
115
116    When we store the entire object, `enclosing_type' is the run-time
117    type -- the complete object -- and `embedded_offset' is the offset
118    of `type' within that larger type, in bytes.  The value_contents()
119    macro takes `embedded_offset' into account, so most GDB code
120    continues to see the `type' portion of the value, just as the
121    inferior would.
122
123    If `type' is a pointer to an object, then `enclosing_type' is a
124    pointer to the object's run-time type, and `pointed_to_offset' is
125    the offset in bytes from the full object to the pointed-to object
126    -- that is, the value `embedded_offset' would have if we followed
127    the pointer and fetched the complete object.  (I don't really see
128    the point.  Why not just determine the run-time type when you
129    indirect, and avoid the special case?  The contents don't matter
130    until you indirect anyway.)
131
132    If we're not doing anything fancy, `enclosing_type' is equal to
133    `type', and `embedded_offset' is zero, so everything works
134    normally.  */
135
136 extern struct type *value_enclosing_type (struct value *);
137 extern void set_value_enclosing_type (struct value *val,
138                                       struct type *new_type);
139
140 /* Returns value_type or value_enclosing_type depending on
141    value_print_options.objectprint.
142
143    If RESOLVE_SIMPLE_TYPES is 0 the enclosing type will be resolved
144    only for pointers and references, else it will be returned
145    for all the types (e.g. structures).  This option is useful
146    to prevent retrieving enclosing type for the base classes fields.
147
148    REAL_TYPE_FOUND is used to inform whether the real type was found
149    (or just static type was used).  The NULL may be passed if it is not
150    necessary. */
151
152 extern struct type *value_actual_type (struct value *value,
153                                        int resolve_simple_types,
154                                        int *real_type_found);
155
156 extern int value_pointed_to_offset (struct value *value);
157 extern void set_value_pointed_to_offset (struct value *value, int val);
158 extern int value_embedded_offset (struct value *value);
159 extern void set_value_embedded_offset (struct value *value, int val);
160
161 /* For lval_computed values, this structure holds functions used to
162    retrieve and set the value (or portions of the value).
163
164    For each function, 'V' is the 'this' pointer: an lval_funcs
165    function F may always assume that the V it receives is an
166    lval_computed value, and has F in the appropriate slot of its
167    lval_funcs structure.  */
168
169 struct lval_funcs
170 {
171   /* Fill in VALUE's contents.  This is used to "un-lazy" values.  If
172      a problem arises in obtaining VALUE's bits, this function should
173      call 'error'.  If it is NULL value_fetch_lazy on "un-lazy"
174      non-optimized-out value is an internal error.  */
175   void (*read) (struct value *v);
176
177   /* Handle an assignment TOVAL = FROMVAL by writing the value of
178      FROMVAL to TOVAL's location.  The contents of TOVAL have not yet
179      been updated.  If a problem arises in doing so, this function
180      should call 'error'.  If it is NULL such TOVAL assignment is an error as
181      TOVAL is not considered as an lvalue.  */
182   void (*write) (struct value *toval, struct value *fromval);
183
184   /* Check the validity of some bits in VALUE.  This should return 1
185      if all the bits starting at OFFSET and extending for LENGTH bits
186      are valid, or 0 if any bit is invalid.  */
187   int (*check_validity) (const struct value *value, int offset, int length);
188
189   /* Return 1 if any bit in VALUE is valid, 0 if they are all invalid.  */
190   int (*check_any_valid) (const struct value *value);
191
192   /* If non-NULL, this is used to implement pointer indirection for
193      this value.  This method may return NULL, in which case value_ind
194      will fall back to ordinary indirection.  */
195   struct value *(*indirect) (struct value *value);
196
197   /* If non-NULL, this is used to implement reference resolving for
198      this value.  This method may return NULL, in which case coerce_ref
199      will fall back to ordinary references resolving.  */
200   struct value *(*coerce_ref) (const struct value *value);
201
202   /* If non-NULL, this is used to determine whether the indicated bits
203      of VALUE are a synthetic pointer.  */
204   int (*check_synthetic_pointer) (const struct value *value,
205                                   int offset, int length);
206
207   /* Return a duplicate of VALUE's closure, for use in a new value.
208      This may simply return the same closure, if VALUE's is
209      reference-counted or statically allocated.
210
211      This may be NULL, in which case VALUE's closure is re-used in the
212      new value.  */
213   void *(*copy_closure) (const struct value *v);
214
215   /* Drop VALUE's reference to its closure.  Maybe this frees the
216      closure; maybe this decrements a reference count; maybe the
217      closure is statically allocated and this does nothing.
218
219      This may be NULL, in which case no action is taken to free
220      VALUE's closure.  */
221   void (*free_closure) (struct value *v);
222 };
223
224 /* Create a computed lvalue, with type TYPE, function pointers FUNCS,
225    and closure CLOSURE.  */
226
227 extern struct value *allocate_computed_value (struct type *type,
228                                               const struct lval_funcs *funcs,
229                                               void *closure);
230
231 /* Helper function to check the validity of some bits of a value.
232
233    If TYPE represents some aggregate type (e.g., a structure), return 1.
234    
235    Otherwise, any of the bytes starting at OFFSET and extending for
236    TYPE_LENGTH(TYPE) bytes are invalid, print a message to STREAM and
237    return 0.  The checking is done using FUNCS.
238    
239    Otherwise, return 1.  */
240
241 extern int valprint_check_validity (struct ui_file *stream, struct type *type,
242                                     int embedded_offset,
243                                     const struct value *val);
244
245 extern struct value *allocate_optimized_out_value (struct type *type);
246
247 /* If VALUE is lval_computed, return its lval_funcs structure.  */
248
249 extern const struct lval_funcs *value_computed_funcs (const struct value *);
250
251 /* If VALUE is lval_computed, return its closure.  The meaning of the
252    returned value depends on the functions VALUE uses.  */
253
254 extern void *value_computed_closure (const struct value *value);
255
256 /* If zero, contents of this value are in the contents field.  If
257    nonzero, contents are in inferior.  If the lval field is lval_memory,
258    the contents are in inferior memory at location.address plus offset.
259    The lval field may also be lval_register.
260
261    WARNING: This field is used by the code which handles watchpoints
262    (see breakpoint.c) to decide whether a particular value can be
263    watched by hardware watchpoints.  If the lazy flag is set for some
264    member of a value chain, it is assumed that this member of the
265    chain doesn't need to be watched as part of watching the value
266    itself.  This is how GDB avoids watching the entire struct or array
267    when the user wants to watch a single struct member or array
268    element.  If you ever change the way lazy flag is set and reset, be
269    sure to consider this use as well!  */
270
271 extern int value_lazy (struct value *);
272 extern void set_value_lazy (struct value *value, int val);
273
274 extern int value_stack (struct value *);
275 extern void set_value_stack (struct value *value, int val);
276
277 /* Throw an error complaining that the value has been optimized
278    out.  */
279
280 extern void error_value_optimized_out (void);
281
282 /* value_contents() and value_contents_raw() both return the address
283    of the gdb buffer used to hold a copy of the contents of the lval.
284    value_contents() is used when the contents of the buffer are needed
285    -- it uses value_fetch_lazy() to load the buffer from the process
286    being debugged if it hasn't already been loaded
287    (value_contents_writeable() is used when a writeable but fetched
288    buffer is required)..  value_contents_raw() is used when data is
289    being stored into the buffer, or when it is certain that the
290    contents of the buffer are valid.
291
292    Note: The contents pointer is adjusted by the offset required to
293    get to the real subobject, if the value happens to represent
294    something embedded in a larger run-time object.  */
295
296 extern gdb_byte *value_contents_raw (struct value *);
297
298 /* Actual contents of the value.  For use of this value; setting it
299    uses the stuff above.  Not valid if lazy is nonzero.  Target
300    byte-order.  We force it to be aligned properly for any possible
301    value.  Note that a value therefore extends beyond what is
302    declared here.  */
303
304 extern const gdb_byte *value_contents (struct value *);
305 extern gdb_byte *value_contents_writeable (struct value *);
306
307 /* The ALL variants of the above two macros do not adjust the returned
308    pointer by the embedded_offset value.  */
309
310 extern gdb_byte *value_contents_all_raw (struct value *);
311 extern const gdb_byte *value_contents_all (struct value *);
312
313 /* Like value_contents_all, but does not require that the returned
314    bits be valid.  This should only be used in situations where you
315    plan to check the validity manually.  */
316 extern const gdb_byte *value_contents_for_printing (struct value *value);
317
318 /* Like value_contents_for_printing, but accepts a constant value
319    pointer.  Unlike value_contents_for_printing however, the pointed
320    value must _not_ be lazy.  */
321 extern const gdb_byte *
322   value_contents_for_printing_const (const struct value *value);
323
324 extern int value_fetch_lazy (struct value *val);
325
326 /* If nonzero, this is the value of a variable which does not actually
327    exist in the program, at least partially.  If the value is lazy,
328    this may fetch it now.  */
329 extern int value_optimized_out (struct value *value);
330 extern void set_value_optimized_out (struct value *value, int val);
331
332 /* Like value_optimized_out, but don't fetch the value even if it is
333    lazy.  Mainly useful for constructing other values using VALUE as
334    template.  */
335 extern int value_optimized_out_const (const struct value *value);
336
337 /* Like value_optimized_out, but return false if any bit in the object
338    is valid.  */
339 extern int value_entirely_optimized_out (const struct value *value);
340
341 /* Set or return field indicating whether a variable is initialized or
342    not, based on debugging information supplied by the compiler.
343    1 = initialized; 0 = uninitialized.  */
344 extern int value_initialized (struct value *);
345 extern void set_value_initialized (struct value *, int);
346
347 /* Set COMPONENT's location as appropriate for a component of WHOLE
348    --- regardless of what kind of lvalue WHOLE is.  */
349 extern void set_value_component_location (struct value *component,
350                                           const struct value *whole);
351
352 /* While the following fields are per- VALUE .CONTENT .PIECE (i.e., a
353    single value might have multiple LVALs), this hacked interface is
354    limited to just the first PIECE.  Expect further change.  */
355 /* Type of value; either not an lval, or one of the various different
356    possible kinds of lval.  */
357 extern enum lval_type *deprecated_value_lval_hack (struct value *);
358 #define VALUE_LVAL(val) (*deprecated_value_lval_hack (val))
359
360 /* Like VALUE_LVAL, except the parameter can be const.  */
361 extern enum lval_type value_lval_const (const struct value *value);
362
363 /* If lval == lval_memory, return the address in the inferior.  If
364    lval == lval_register, return the byte offset into the registers
365    structure.  Otherwise, return 0.  The returned address
366    includes the offset, if any.  */
367 extern CORE_ADDR value_address (const struct value *);
368
369 /* Like value_address, except the result does not include value's
370    offset.  */
371 extern CORE_ADDR value_raw_address (struct value *);
372
373 /* Set the address of a value.  */
374 extern void set_value_address (struct value *, CORE_ADDR);
375
376 /* Pointer to internal variable.  */
377 extern struct internalvar **deprecated_value_internalvar_hack (struct value *);
378 #define VALUE_INTERNALVAR(val) (*deprecated_value_internalvar_hack (val))
379
380 /* Frame register value is relative to.  This will be described in the
381    lval enum above as "lval_register".  */
382 extern struct frame_id *deprecated_value_frame_id_hack (struct value *);
383 #define VALUE_FRAME_ID(val) (*deprecated_value_frame_id_hack (val))
384
385 /* Register number if the value is from a register.  */
386 extern short *deprecated_value_regnum_hack (struct value *);
387 #define VALUE_REGNUM(val) (*deprecated_value_regnum_hack (val))
388
389 /* Return value after lval_funcs->coerce_ref (after check_typedef).  Return
390    NULL if lval_funcs->coerce_ref is not applicable for whatever reason.  */
391
392 extern struct value *coerce_ref_if_computed (const struct value *arg);
393
394 /* Setup a new value type and enclosing value type for dereferenced value VALUE.
395    ENC_TYPE is the new enclosing type that should be set.  ORIGINAL_TYPE and
396    ORIGINAL_VAL are the type and value of the original reference or pointer.
397
398    Note, that VALUE is modified by this function.
399
400    It is a common implementation for coerce_ref and value_ind.  */
401
402 extern struct value * readjust_indirect_value_type (struct value *value,
403                                                     struct type *enc_type,
404                                                     struct type *original_type,
405                                                     struct value *original_val);
406
407 /* Convert a REF to the object referenced.  */
408
409 extern struct value *coerce_ref (struct value *value);
410
411 /* If ARG is an array, convert it to a pointer.
412    If ARG is a function, convert it to a function pointer.
413
414    References are dereferenced.  */
415
416 extern struct value *coerce_array (struct value *value);
417
418 /* Given a value, determine whether the bits starting at OFFSET and
419    extending for LENGTH bits are valid.  This returns nonzero if all
420    bits in the given range are valid, zero if any bit is invalid.  */
421
422 extern int value_bits_valid (const struct value *value,
423                              int offset, int length);
424
425 /* Given a value, determine whether the bits starting at OFFSET and
426    extending for LENGTH bits are a synthetic pointer.  */
427
428 extern int value_bits_synthetic_pointer (const struct value *value,
429                                          int offset, int length);
430
431 /* Given a value, determine whether the contents bytes starting at
432    OFFSET and extending for LENGTH bytes are available.  This returns
433    nonzero if all bytes in the given range are available, zero if any
434    byte is unavailable.  */
435
436 extern int value_bytes_available (const struct value *value,
437                                   int offset, int length);
438
439 /* Given a value, determine whether the contents bits starting at
440    OFFSET and extending for LENGTH bits are available.  This returns
441    nonzero if all bits in the given range are available, zero if any
442    bit is unavailable.  */
443
444 extern int value_bits_available (const struct value *value,
445                                  int offset, int length);
446
447 /* Like value_bytes_available, but return false if any byte in the
448    whole object is unavailable.  */
449 extern int value_entirely_available (struct value *value);
450
451 /* Like value_entirely_available, but return false if any byte in the
452    whole object is available.  */
453 extern int value_entirely_unavailable (struct value *value);
454
455 /* Mark VALUE's content bytes starting at OFFSET and extending for
456    LENGTH bytes as unavailable.  */
457
458 extern void mark_value_bytes_unavailable (struct value *value,
459                                           int offset, int length);
460
461 /* Mark VALUE's content bits starting at OFFSET and extending for
462    LENGTH bits as unavailable.  */
463
464 extern void mark_value_bits_unavailable (struct value *value,
465                                          int offset, int length);
466
467 /* Compare LENGTH bytes of VAL1's contents starting at OFFSET1 with
468    LENGTH bytes of VAL2's contents starting at OFFSET2.
469
470    Note that "contents" refers to the whole value's contents
471    (value_contents_all), without any embedded offset adjustment.  For
472    example, to compare a complete object value with itself, including
473    its enclosing type chunk, you'd do:
474
475      int len = TYPE_LENGTH (check_typedef (value_enclosing_type (val)));
476      value_available_contents (val, 0, val, 0, len);
477
478    Returns true iff the set of available contents match.  Unavailable
479    contents compare equal with unavailable contents, and different
480    with any available byte.  For example, if 'x's represent an
481    unavailable byte, and 'V' and 'Z' represent different available
482    bytes, in a value with length 16:
483
484    offset:   0   4   8   12  16
485    contents: xxxxVVVVxxxxVVZZ
486
487    then:
488
489    value_available_contents_eq(val, 0, val, 8, 6) => 1
490    value_available_contents_eq(val, 0, val, 4, 4) => 1
491    value_available_contents_eq(val, 0, val, 8, 8) => 0
492    value_available_contents_eq(val, 4, val, 12, 2) => 1
493    value_available_contents_eq(val, 4, val, 12, 4) => 0
494    value_available_contents_eq(val, 3, val, 4, 4) => 0
495
496    We only know whether a value chunk is available if we've tried to
497    read it.  As this routine is used by printing routines, which may
498    be printing values in the value history, long after the inferior is
499    gone, it works with const values.  Therefore, this routine must not
500    be called with lazy values.  */
501
502 extern int value_available_contents_eq (const struct value *val1, int offset1,
503                                         const struct value *val2, int offset2,
504                                         int length);
505
506 /* Read LENGTH bytes of memory starting at MEMADDR into BUFFER, which
507    is (or will be copied to) VAL's contents buffer offset by
508    EMBEDDED_OFFSET (that is, to &VAL->contents[EMBEDDED_OFFSET]).
509    Marks value contents ranges as unavailable if the corresponding
510    memory is likewise unavailable.  STACK indicates whether the memory
511    is known to be stack memory.  */
512
513 extern void read_value_memory (struct value *val, int embedded_offset,
514                                int stack, CORE_ADDR memaddr,
515                                gdb_byte *buffer, size_t length);
516
517 /* Cast SCALAR_VALUE to the element type of VECTOR_TYPE, then replicate
518    into each element of a new vector value with VECTOR_TYPE.  */
519
520 struct value *value_vector_widen (struct value *scalar_value,
521                                   struct type *vector_type);
522
523 \f
524
525 #include "symtab.h"
526 #include "gdbtypes.h"
527 #include "expression.h"
528
529 struct frame_info;
530 struct fn_field;
531
532 extern int print_address_demangle (const struct value_print_options *,
533                                    struct gdbarch *, CORE_ADDR,
534                                    struct ui_file *, int);
535
536 extern LONGEST value_as_long (struct value *val);
537 extern DOUBLEST value_as_double (struct value *val);
538 extern CORE_ADDR value_as_address (struct value *val);
539
540 extern LONGEST unpack_long (struct type *type, const gdb_byte *valaddr);
541 extern DOUBLEST unpack_double (struct type *type, const gdb_byte *valaddr,
542                                int *invp);
543 extern CORE_ADDR unpack_pointer (struct type *type, const gdb_byte *valaddr);
544
545 extern int unpack_value_bits_as_long (struct type *field_type,
546                                       const gdb_byte *valaddr,
547                                       int embedded_offset, int bitpos,
548                                       int bitsize,
549                                       const struct value *original_value,
550                                       LONGEST *result);
551
552 extern LONGEST unpack_field_as_long (struct type *type,
553                                      const gdb_byte *valaddr,
554                                      int fieldno);
555 extern int unpack_value_field_as_long (struct type *type, const gdb_byte *valaddr,
556                                 int embedded_offset, int fieldno,
557                                 const struct value *val, LONGEST *result);
558
559 extern struct value *value_field_bitfield (struct type *type, int fieldno,
560                                            const gdb_byte *valaddr,
561                                            int embedded_offset,
562                                            const struct value *val);
563
564 extern void pack_long (gdb_byte *buf, struct type *type, LONGEST num);
565
566 extern struct value *value_from_longest (struct type *type, LONGEST num);
567 extern struct value *value_from_ulongest (struct type *type, ULONGEST num);
568 extern struct value *value_from_pointer (struct type *type, CORE_ADDR addr);
569 extern struct value *value_from_double (struct type *type, DOUBLEST num);
570 extern struct value *value_from_decfloat (struct type *type,
571                                           const gdb_byte *decbytes);
572 extern struct value *value_from_history_ref (const char *, const char **);
573
574 extern struct value *value_at (struct type *type, CORE_ADDR addr);
575 extern struct value *value_at_lazy (struct type *type, CORE_ADDR addr);
576
577 extern struct value *value_from_contents_and_address_unresolved
578      (struct type *, const gdb_byte *, CORE_ADDR);
579 extern struct value *value_from_contents_and_address (struct type *,
580                                                       const gdb_byte *,
581                                                       CORE_ADDR);
582 extern struct value *value_from_contents (struct type *, const gdb_byte *);
583
584 extern struct value *default_value_from_register (struct gdbarch *gdbarch,
585                                                   struct type *type,
586                                                   int regnum,
587                                                   struct frame_id frame_id);
588
589 extern void read_frame_register_value (struct value *value,
590                                        struct frame_info *frame);
591
592 extern struct value *value_from_register (struct type *type, int regnum,
593                                           struct frame_info *frame);
594
595 extern CORE_ADDR address_from_register (int regnum,
596                                         struct frame_info *frame);
597
598 extern struct value *value_of_variable (struct symbol *var,
599                                         const struct block *b);
600
601 extern struct value *address_of_variable (struct symbol *var,
602                                           const struct block *b);
603
604 extern struct value *value_of_register (int regnum, struct frame_info *frame);
605
606 struct value *value_of_register_lazy (struct frame_info *frame, int regnum);
607
608 extern int symbol_read_needs_frame (struct symbol *);
609
610 extern struct value *read_var_value (struct symbol *var,
611                                      struct frame_info *frame);
612
613 extern struct value *default_read_var_value (struct symbol *var,
614                                              struct frame_info *frame);
615
616 extern struct value *allocate_value (struct type *type);
617 extern struct value *allocate_value_lazy (struct type *type);
618 extern void value_contents_copy (struct value *dst, int dst_offset,
619                                  struct value *src, int src_offset,
620                                  int length);
621 extern void value_contents_copy_raw (struct value *dst, int dst_offset,
622                                      struct value *src, int src_offset,
623                                      int length);
624
625 extern struct value *allocate_repeat_value (struct type *type, int count);
626
627 extern struct value *value_mark (void);
628
629 extern void value_free_to_mark (struct value *mark);
630
631 extern struct value *value_cstring (char *ptr, ssize_t len,
632                                     struct type *char_type);
633 extern struct value *value_string (char *ptr, ssize_t len,
634                                    struct type *char_type);
635
636 extern struct value *value_array (int lowbound, int highbound,
637                                   struct value **elemvec);
638
639 extern struct value *value_concat (struct value *arg1, struct value *arg2);
640
641 extern struct value *value_binop (struct value *arg1, struct value *arg2,
642                                   enum exp_opcode op);
643
644 extern struct value *value_ptradd (struct value *arg1, LONGEST arg2);
645
646 extern LONGEST value_ptrdiff (struct value *arg1, struct value *arg2);
647
648 extern int value_must_coerce_to_target (struct value *arg1);
649
650 extern struct value *value_coerce_to_target (struct value *arg1);
651
652 extern struct value *value_coerce_array (struct value *arg1);
653
654 extern struct value *value_coerce_function (struct value *arg1);
655
656 extern struct value *value_ind (struct value *arg1);
657
658 extern struct value *value_addr (struct value *arg1);
659
660 extern struct value *value_ref (struct value *arg1);
661
662 extern struct value *value_assign (struct value *toval,
663                                    struct value *fromval);
664
665 extern struct value *value_pos (struct value *arg1);
666
667 extern struct value *value_neg (struct value *arg1);
668
669 extern struct value *value_complement (struct value *arg1);
670
671 extern struct value *value_struct_elt (struct value **argp,
672                                        struct value **args,
673                                        const char *name, int *static_memfuncp,
674                                        const char *err);
675
676 extern struct value *value_struct_elt_bitpos (struct value **argp,
677                                               int bitpos,
678                                               struct type *field_type,
679                                               const char *err);
680
681 extern struct value *value_aggregate_elt (struct type *curtype,
682                                           const char *name,
683                                           struct type *expect_type,
684                                           int want_address,
685                                           enum noside noside);
686
687 extern struct value *value_static_field (struct type *type, int fieldno);
688
689 enum oload_search_type { NON_METHOD, METHOD, BOTH };
690
691 extern int find_overload_match (struct value **args, int nargs,
692                                 const char *name,
693                                 enum oload_search_type method,
694                                 struct value **objp, struct symbol *fsym,
695                                 struct value **valp, struct symbol **symp,
696                                 int *staticp, const int no_adl);
697
698 extern struct value *value_field (struct value *arg1, int fieldno);
699
700 extern struct value *value_primitive_field (struct value *arg1, int offset,
701                                             int fieldno,
702                                             struct type *arg_type);
703
704
705 extern struct type *value_rtti_indirect_type (struct value *, int *, int *,
706                                               int *);
707
708 extern struct value *value_full_object (struct value *, struct type *, int,
709                                         int, int);
710
711 extern struct value *value_cast_pointers (struct type *, struct value *, int);
712
713 extern struct value *value_cast (struct type *type, struct value *arg2);
714
715 extern struct value *value_reinterpret_cast (struct type *type,
716                                              struct value *arg);
717
718 extern struct value *value_dynamic_cast (struct type *type, struct value *arg);
719
720 extern struct value *value_zero (struct type *type, enum lval_type lv);
721
722 extern struct value *value_one (struct type *type);
723
724 extern struct value *value_repeat (struct value *arg1, int count);
725
726 extern struct value *value_subscript (struct value *array, LONGEST index);
727
728 extern struct value *value_bitstring_subscript (struct type *type,
729                                                 struct value *bitstring,
730                                                 LONGEST index);
731
732 extern struct value *register_value_being_returned (struct type *valtype,
733                                                     struct regcache *retbuf);
734
735 extern int value_in (struct value *element, struct value *set);
736
737 extern int value_bit_index (struct type *type, const gdb_byte *addr,
738                             int index);
739
740 extern enum return_value_convention
741 struct_return_convention (struct gdbarch *gdbarch, struct value *function,
742                           struct type *value_type);
743
744 extern int using_struct_return (struct gdbarch *gdbarch,
745                                 struct value *function,
746                                 struct type *value_type);
747
748 extern struct value *evaluate_expression (struct expression *exp);
749
750 extern struct value *evaluate_type (struct expression *exp);
751
752 extern struct value *evaluate_subexp (struct type *expect_type,
753                                       struct expression *exp,
754                                       int *pos, enum noside noside);
755
756 extern struct value *evaluate_subexpression_type (struct expression *exp,
757                                                   int subexp);
758
759 extern void fetch_subexp_value (struct expression *exp, int *pc,
760                                 struct value **valp, struct value **resultp,
761                                 struct value **val_chain,
762                                 int preserve_errors);
763
764 extern char *extract_field_op (struct expression *exp, int *subexp);
765
766 extern struct value *evaluate_subexp_with_coercion (struct expression *,
767                                                     int *, enum noside);
768
769 extern struct value *parse_and_eval (const char *exp);
770
771 extern struct value *parse_to_comma_and_eval (const char **expp);
772
773 extern struct type *parse_and_eval_type (char *p, int length);
774
775 extern CORE_ADDR parse_and_eval_address (const char *exp);
776
777 extern LONGEST parse_and_eval_long (const char *exp);
778
779 extern void unop_promote (const struct language_defn *language,
780                           struct gdbarch *gdbarch,
781                           struct value **arg1);
782
783 extern void binop_promote (const struct language_defn *language,
784                            struct gdbarch *gdbarch,
785                            struct value **arg1, struct value **arg2);
786
787 extern struct value *access_value_history (int num);
788
789 extern struct value *value_of_internalvar (struct gdbarch *gdbarch,
790                                            struct internalvar *var);
791
792 extern int get_internalvar_integer (struct internalvar *var, LONGEST *l);
793
794 extern void set_internalvar (struct internalvar *var, struct value *val);
795
796 extern void set_internalvar_integer (struct internalvar *var, LONGEST l);
797
798 extern void set_internalvar_string (struct internalvar *var,
799                                     const char *string);
800
801 extern void clear_internalvar (struct internalvar *var);
802
803 extern void set_internalvar_component (struct internalvar *var,
804                                        int offset,
805                                        int bitpos, int bitsize,
806                                        struct value *newvalue);
807
808 extern struct internalvar *lookup_only_internalvar (const char *name);
809
810 extern struct internalvar *create_internalvar (const char *name);
811
812 extern VEC (char_ptr) *complete_internalvar (const char *name);
813
814 /* An internalvar can be dynamically computed by supplying a vector of
815    function pointers to perform various operations.  */
816
817 struct internalvar_funcs
818 {
819   /* Compute the value of the variable.  The DATA argument passed to
820      the function is the same argument that was passed to
821      `create_internalvar_type_lazy'.  */
822
823   struct value *(*make_value) (struct gdbarch *arch,
824                                struct internalvar *var,
825                                void *data);
826
827   /* Update the agent expression EXPR with bytecode to compute the
828      value.  VALUE is the agent value we are updating.  The DATA
829      argument passed to this function is the same argument that was
830      passed to `create_internalvar_type_lazy'.  If this pointer is
831      NULL, then the internalvar cannot be compiled to an agent
832      expression.  */
833
834   void (*compile_to_ax) (struct internalvar *var,
835                          struct agent_expr *expr,
836                          struct axs_value *value,
837                          void *data);
838
839   /* If non-NULL, this is called to destroy DATA.  The DATA argument
840      passed to this function is the same argument that was passed to
841      `create_internalvar_type_lazy'.  */
842
843   void (*destroy) (void *data);
844 };
845
846 extern struct internalvar *create_internalvar_type_lazy (const char *name,
847                                 const struct internalvar_funcs *funcs,
848                                 void *data);
849
850 /* Compile an internal variable to an agent expression.  VAR is the
851    variable to compile; EXPR and VALUE are the agent expression we are
852    updating.  This will return 0 if there is no known way to compile
853    VAR, and 1 if VAR was successfully compiled.  It may also throw an
854    exception on error.  */
855
856 extern int compile_internalvar_to_ax (struct internalvar *var,
857                                       struct agent_expr *expr,
858                                       struct axs_value *value);
859
860 extern struct internalvar *lookup_internalvar (const char *name);
861
862 extern int value_equal (struct value *arg1, struct value *arg2);
863
864 extern int value_equal_contents (struct value *arg1, struct value *arg2);
865
866 extern int value_less (struct value *arg1, struct value *arg2);
867
868 extern int value_logical_not (struct value *arg1);
869
870 /* C++ */
871
872 extern struct value *value_of_this (const struct language_defn *lang);
873
874 extern struct value *value_of_this_silent (const struct language_defn *lang);
875
876 extern struct value *value_x_binop (struct value *arg1, struct value *arg2,
877                                     enum exp_opcode op,
878                                     enum exp_opcode otherop,
879                                     enum noside noside);
880
881 extern struct value *value_x_unop (struct value *arg1, enum exp_opcode op,
882                                    enum noside noside);
883
884 extern struct value *value_fn_field (struct value **arg1p, struct fn_field *f,
885                                      int j, struct type *type, int offset);
886
887 extern int binop_types_user_defined_p (enum exp_opcode op,
888                                        struct type *type1,
889                                        struct type *type2);
890
891 extern int binop_user_defined_p (enum exp_opcode op, struct value *arg1,
892                                  struct value *arg2);
893
894 extern int unop_user_defined_p (enum exp_opcode op, struct value *arg1);
895
896 extern int destructor_name_p (const char *name, struct type *type);
897
898 extern void value_incref (struct value *val);
899
900 extern void value_free (struct value *val);
901
902 extern void free_all_values (void);
903
904 extern void free_value_chain (struct value *v);
905
906 extern void release_value (struct value *val);
907
908 extern void release_value_or_incref (struct value *val);
909
910 extern int record_latest_value (struct value *val);
911
912 extern void modify_field (struct type *type, gdb_byte *addr,
913                           LONGEST fieldval, int bitpos, int bitsize);
914
915 extern void type_print (struct type *type, const char *varstring,
916                         struct ui_file *stream, int show);
917
918 extern char *type_to_string (struct type *type);
919
920 extern gdb_byte *baseclass_addr (struct type *type, int index,
921                                  gdb_byte *valaddr,
922                                  struct value **valuep, int *errp);
923
924 extern void print_longest (struct ui_file *stream, int format,
925                            int use_local, LONGEST val);
926
927 extern void print_floating (const gdb_byte *valaddr, struct type *type,
928                             struct ui_file *stream);
929
930 extern void print_decimal_floating (const gdb_byte *valaddr, struct type *type,
931                                     struct ui_file *stream);
932
933 extern void value_print (struct value *val, struct ui_file *stream,
934                          const struct value_print_options *options);
935
936 extern void value_print_array_elements (struct value *val,
937                                         struct ui_file *stream, int format,
938                                         enum val_prettyformat pretty);
939
940 extern struct value *value_release_to_mark (struct value *mark);
941
942 extern void val_print (struct type *type, const gdb_byte *valaddr,
943                        int embedded_offset, CORE_ADDR address,
944                        struct ui_file *stream, int recurse,
945                        const struct value *val,
946                        const struct value_print_options *options,
947                        const struct language_defn *language);
948
949 extern void common_val_print (struct value *val,
950                               struct ui_file *stream, int recurse,
951                               const struct value_print_options *options,
952                               const struct language_defn *language);
953
954 extern int val_print_string (struct type *elttype, const char *encoding,
955                              CORE_ADDR addr, int len,
956                              struct ui_file *stream,
957                              const struct value_print_options *options);
958
959 extern void print_variable_and_value (const char *name,
960                                       struct symbol *var,
961                                       struct frame_info *frame,
962                                       struct ui_file *stream,
963                                       int indent);
964
965 extern void typedef_print (struct type *type, struct symbol *news,
966                            struct ui_file *stream);
967
968 extern char *internalvar_name (struct internalvar *var);
969
970 extern void preserve_values (struct objfile *);
971
972 /* From values.c */
973
974 extern struct value *value_copy (struct value *);
975
976 extern struct value *value_non_lval (struct value *);
977
978 extern void preserve_one_value (struct value *, struct objfile *, htab_t);
979
980 /* From valops.c */
981
982 extern struct value *varying_to_slice (struct value *);
983
984 extern struct value *value_slice (struct value *, int, int);
985
986 extern struct value *value_literal_complex (struct value *, struct value *,
987                                             struct type *);
988
989 extern struct value *find_function_in_inferior (const char *,
990                                                 struct objfile **);
991
992 extern struct value *value_allocate_space_in_inferior (int);
993
994 extern struct value *value_subscripted_rvalue (struct value *array,
995                                                LONGEST index, int lowerbound);
996
997 /* User function handler.  */
998
999 typedef struct value *(*internal_function_fn) (struct gdbarch *gdbarch,
1000                                                const struct language_defn *language,
1001                                                void *cookie,
1002                                                int argc,
1003                                                struct value **argv);
1004
1005 void add_internal_function (const char *name, const char *doc,
1006                             internal_function_fn handler,
1007                             void *cookie);
1008
1009 struct value *call_internal_function (struct gdbarch *gdbarch,
1010                                       const struct language_defn *language,
1011                                       struct value *function,
1012                                       int argc, struct value **argv);
1013
1014 char *value_internal_function_name (struct value *);
1015
1016 extern struct value *value_of_xmethod (struct xmethod_worker *);
1017
1018 struct value *call_xmethod (struct value *function,
1019                             int argc, struct value **argv);
1020
1021 #endif /* !defined (VALUE_H) */