Extension Language API
[deliverable/binutils-gdb.git] / gdb / python / py-value.c
CommitLineData
7843261b
TJB
1/* Python interface to values.
2
ecd75fc8 3 Copyright (C) 2008-2014 Free Software Foundation, Inc.
7843261b
TJB
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#include "defs.h"
08c637de 21#include "gdb_assert.h"
7843261b
TJB
22#include "charset.h"
23#include "value.h"
24#include "exceptions.h"
25#include "language.h"
26#include "dfp.h"
79a45b7d 27#include "valprint.h"
5374244e 28#include "infcall.h"
f9ffd4bb 29#include "expression.h"
03f17ccf 30#include "cp-abi.h"
49a8461d 31#include "python.h"
7843261b 32
7843261b
TJB
33#include "python-internal.h"
34
35/* Even though Python scalar types directly map to host types, we use
b021a221 36 target types here to remain consistent with the values system in
7843261b
TJB
37 GDB (which uses target arithmetic). */
38
39/* Python's integer type corresponds to C's long type. */
d452c4bc 40#define builtin_type_pyint builtin_type (python_gdbarch)->builtin_long
7843261b
TJB
41
42/* Python's float type corresponds to C's double type. */
d452c4bc 43#define builtin_type_pyfloat builtin_type (python_gdbarch)->builtin_double
7843261b
TJB
44
45/* Python's long type corresponds to C's long long type. */
d452c4bc 46#define builtin_type_pylong builtin_type (python_gdbarch)->builtin_long_long
7843261b 47
595939de
PM
48/* Python's long type corresponds to C's long long type. Unsigned version. */
49#define builtin_type_upylong builtin_type \
50 (python_gdbarch)->builtin_unsigned_long_long
51
7843261b 52#define builtin_type_pybool \
d452c4bc 53 language_bool_type (python_language, python_gdbarch)
7843261b 54
3b7538c0 55#define builtin_type_pychar \
d452c4bc 56 language_string_char_type (python_language, python_gdbarch)
3b7538c0 57
4e7a5ef5 58typedef struct value_object {
7843261b 59 PyObject_HEAD
4e7a5ef5
TT
60 struct value_object *next;
61 struct value_object *prev;
7843261b 62 struct value *value;
c0c6f777 63 PyObject *address;
2c74e833 64 PyObject *type;
03f17ccf 65 PyObject *dynamic_type;
7843261b
TJB
66} value_object;
67
4e7a5ef5
TT
68/* List of all values which are currently exposed to Python. It is
69 maintained so that when an objfile is discarded, preserve_values
70 can copy the values' types if needed. */
71/* This variable is unnecessarily initialized to NULL in order to
72 work around a linker bug on MacOS. */
73static value_object *values_in_python = NULL;
74
7843261b
TJB
75/* Called by the Python interpreter when deallocating a value object. */
76static void
77valpy_dealloc (PyObject *obj)
78{
79 value_object *self = (value_object *) obj;
80
4e7a5ef5
TT
81 /* Remove SELF from the global list. */
82 if (self->prev)
83 self->prev->next = self->next;
84 else
85 {
86 gdb_assert (values_in_python == self);
87 values_in_python = self->next;
88 }
89 if (self->next)
90 self->next->prev = self->prev;
7843261b 91
77316f4c 92 value_free (self->value);
c0c6f777
TJB
93
94 if (self->address)
95 /* Use braces to appease gcc warning. *sigh* */
96 {
97 Py_DECREF (self->address);
98 }
99
2c74e833
TT
100 if (self->type)
101 {
102 Py_DECREF (self->type);
103 }
104
03f17ccf
TT
105 Py_XDECREF (self->dynamic_type);
106
9a27f2c6 107 Py_TYPE (self)->tp_free (self);
7843261b
TJB
108}
109
4e7a5ef5
TT
110/* Helper to push a Value object on the global list. */
111static void
112note_value (value_object *value_obj)
113{
114 value_obj->next = values_in_python;
115 if (value_obj->next)
116 value_obj->next->prev = value_obj;
117 value_obj->prev = NULL;
118 values_in_python = value_obj;
119}
120
8dc78533
JK
121/* Called when a new gdb.Value object needs to be allocated. Returns NULL on
122 error, with a python exception set. */
7843261b
TJB
123static PyObject *
124valpy_new (PyTypeObject *subtype, PyObject *args, PyObject *keywords)
125{
126 struct value *value = NULL; /* Initialize to appease gcc warning. */
127 value_object *value_obj;
7843261b
TJB
128
129 if (PyTuple_Size (args) != 1)
130 {
131 PyErr_SetString (PyExc_TypeError, _("Value object creation takes only "
132 "1 argument"));
133 return NULL;
134 }
135
136 value_obj = (value_object *) subtype->tp_alloc (subtype, 1);
137 if (value_obj == NULL)
138 {
139 PyErr_SetString (PyExc_MemoryError, _("Could not allocate memory to "
140 "create Value object."));
141 return NULL;
142 }
143
08c637de
TJB
144 value = convert_value_from_python (PyTuple_GetItem (args, 0));
145 if (value == NULL)
7843261b
TJB
146 {
147 subtype->tp_free (value_obj);
08c637de 148 return NULL;
7843261b
TJB
149 }
150
151 value_obj->value = value;
e848a8a5 152 release_value_or_incref (value);
c0c6f777 153 value_obj->address = NULL;
2c74e833 154 value_obj->type = NULL;
03f17ccf 155 value_obj->dynamic_type = NULL;
4e7a5ef5 156 note_value (value_obj);
7843261b
TJB
157
158 return (PyObject *) value_obj;
159}
160
4e7a5ef5
TT
161/* Iterate over all the Value objects, calling preserve_one_value on
162 each. */
163void
6dddc817
DE
164gdbpy_preserve_values (const struct extension_language_defn *extlang,
165 struct objfile *objfile, htab_t copied_types)
4e7a5ef5
TT
166{
167 value_object *iter;
168
169 for (iter = values_in_python; iter; iter = iter->next)
170 preserve_one_value (iter->value, objfile, copied_types);
171}
172
7843261b
TJB
173/* Given a value of a pointer type, apply the C unary * operator to it. */
174static PyObject *
175valpy_dereference (PyObject *self, PyObject *args)
176{
7843261b 177 volatile struct gdb_exception except;
888fe1e1 178 PyObject *result = NULL;
7843261b
TJB
179
180 TRY_CATCH (except, RETURN_MASK_ALL)
181 {
888fe1e1
TT
182 struct value *res_val;
183 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
184
7843261b 185 res_val = value_ind (((value_object *) self)->value);
888fe1e1
TT
186 result = value_to_value_object (res_val);
187 do_cleanups (cleanup);
7843261b
TJB
188 }
189 GDB_PY_HANDLE_EXCEPTION (except);
190
888fe1e1 191 return result;
7843261b
TJB
192}
193
7b282c5a
SCR
194/* Given a value of a pointer type or a reference type, return the value
195 referenced. The difference between this function and valpy_dereference is
196 that the latter applies * unary operator to a value, which need not always
197 result in the value referenced. For example, for a value which is a reference
198 to an 'int' pointer ('int *'), valpy_dereference will result in a value of
199 type 'int' while valpy_referenced_value will result in a value of type
200 'int *'. */
201
202static PyObject *
203valpy_referenced_value (PyObject *self, PyObject *args)
204{
205 volatile struct gdb_exception except;
206 PyObject *result = NULL;
207
208 TRY_CATCH (except, RETURN_MASK_ALL)
209 {
210 struct value *self_val, *res_val;
211 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
212
213 self_val = ((value_object *) self)->value;
214 switch (TYPE_CODE (check_typedef (value_type (self_val))))
215 {
216 case TYPE_CODE_PTR:
217 res_val = value_ind (self_val);
218 break;
219 case TYPE_CODE_REF:
220 res_val = coerce_ref (self_val);
221 break;
222 default:
223 error(_("Trying to get the referenced value from a value which is "
224 "neither a pointer nor a reference."));
225 }
226
227 result = value_to_value_object (res_val);
228 do_cleanups (cleanup);
229 }
230 GDB_PY_HANDLE_EXCEPTION (except);
231
232 return result;
233}
234
08c637de
TJB
235/* Return "&value". */
236static PyObject *
c0c6f777 237valpy_get_address (PyObject *self, void *closure)
08c637de 238{
c0c6f777 239 value_object *val_obj = (value_object *) self;
08c637de
TJB
240 volatile struct gdb_exception except;
241
c0c6f777 242 if (!val_obj->address)
08c637de 243 {
c0c6f777
TJB
244 TRY_CATCH (except, RETURN_MASK_ALL)
245 {
888fe1e1
TT
246 struct value *res_val;
247 struct cleanup *cleanup
248 = make_cleanup_value_free_to_mark (value_mark ());
249
c0c6f777 250 res_val = value_addr (val_obj->value);
888fe1e1
TT
251 val_obj->address = value_to_value_object (res_val);
252 do_cleanups (cleanup);
c0c6f777
TJB
253 }
254 if (except.reason < 0)
255 {
256 val_obj->address = Py_None;
257 Py_INCREF (Py_None);
258 }
08c637de 259 }
08c637de 260
3fcaed38 261 Py_XINCREF (val_obj->address);
c0c6f777
TJB
262
263 return val_obj->address;
08c637de
TJB
264}
265
2c74e833
TT
266/* Return type of the value. */
267static PyObject *
268valpy_get_type (PyObject *self, void *closure)
269{
270 value_object *obj = (value_object *) self;
d59b6f6c 271
2c74e833
TT
272 if (!obj->type)
273 {
274 obj->type = type_to_type_object (value_type (obj->value));
275 if (!obj->type)
03f17ccf 276 return NULL;
2c74e833
TT
277 }
278 Py_INCREF (obj->type);
279 return obj->type;
280}
281
03f17ccf
TT
282/* Return dynamic type of the value. */
283
284static PyObject *
285valpy_get_dynamic_type (PyObject *self, void *closure)
286{
287 value_object *obj = (value_object *) self;
288 volatile struct gdb_exception except;
289 struct type *type = NULL;
290
291 if (obj->dynamic_type != NULL)
292 {
293 Py_INCREF (obj->dynamic_type);
294 return obj->dynamic_type;
295 }
296
297 TRY_CATCH (except, RETURN_MASK_ALL)
298 {
299 struct value *val = obj->value;
888fe1e1 300 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
03f17ccf
TT
301
302 type = value_type (val);
303 CHECK_TYPEDEF (type);
304
305 if (((TYPE_CODE (type) == TYPE_CODE_PTR)
306 || (TYPE_CODE (type) == TYPE_CODE_REF))
307 && (TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_CLASS))
308 {
309 struct value *target;
310 int was_pointer = TYPE_CODE (type) == TYPE_CODE_PTR;
311
312 target = value_ind (val);
313 type = value_rtti_type (target, NULL, NULL, NULL);
314
315 if (type)
316 {
317 if (was_pointer)
318 type = lookup_pointer_type (type);
319 else
320 type = lookup_reference_type (type);
321 }
322 }
323 else if (TYPE_CODE (type) == TYPE_CODE_CLASS)
324 type = value_rtti_type (val, NULL, NULL, NULL);
325 else
326 {
327 /* Re-use object's static type. */
328 type = NULL;
329 }
888fe1e1
TT
330
331 do_cleanups (cleanup);
03f17ccf
TT
332 }
333 GDB_PY_HANDLE_EXCEPTION (except);
334
335 if (type == NULL)
97b77b39 336 obj->dynamic_type = valpy_get_type (self, NULL);
03f17ccf
TT
337 else
338 obj->dynamic_type = type_to_type_object (type);
339
97b77b39 340 Py_XINCREF (obj->dynamic_type);
03f17ccf
TT
341 return obj->dynamic_type;
342}
343
be759fcf
PM
344/* Implementation of gdb.Value.lazy_string ([encoding] [, length]) ->
345 string. Return a PyObject representing a lazy_string_object type.
346 A lazy string is a pointer to a string with an optional encoding and
347 length. If ENCODING is not given, encoding is set to None. If an
348 ENCODING is provided the encoding parameter is set to ENCODING, but
349 the string is not encoded. If LENGTH is provided then the length
350 parameter is set to LENGTH, otherwise length will be set to -1 (first
351 null of appropriate with). */
352static PyObject *
353valpy_lazy_string (PyObject *self, PyObject *args, PyObject *kw)
354{
74aedc46 355 gdb_py_longest length = -1;
be759fcf
PM
356 struct value *value = ((value_object *) self)->value;
357 const char *user_encoding = NULL;
358 static char *keywords[] = { "encoding", "length", NULL };
888fe1e1 359 PyObject *str_obj = NULL;
f287c1f3 360 volatile struct gdb_exception except;
be759fcf 361
74aedc46 362 if (!PyArg_ParseTupleAndKeywords (args, kw, "|s" GDB_PY_LL_ARG, keywords,
be759fcf
PM
363 &user_encoding, &length))
364 return NULL;
365
f287c1f3
PM
366 TRY_CATCH (except, RETURN_MASK_ALL)
367 {
888fe1e1
TT
368 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
369
f287c1f3
PM
370 if (TYPE_CODE (value_type (value)) == TYPE_CODE_PTR)
371 value = value_ind (value);
888fe1e1
TT
372
373 str_obj = gdbpy_create_lazy_string_object (value_address (value), length,
374 user_encoding,
375 value_type (value));
376
377 do_cleanups (cleanup);
f287c1f3
PM
378 }
379 GDB_PY_HANDLE_EXCEPTION (except);
be759fcf 380
888fe1e1 381 return str_obj;
be759fcf
PM
382}
383
fbb8f299
PM
384/* Implementation of gdb.Value.string ([encoding] [, errors]
385 [, length]) -> string. Return Unicode string with value contents.
386 If ENCODING is not given, the string is assumed to be encoded in
387 the target's charset. If LENGTH is provided, only fetch string to
388 the length provided. */
389
b6cb8e7d 390static PyObject *
cc924cad 391valpy_string (PyObject *self, PyObject *args, PyObject *kw)
b6cb8e7d 392{
f92adf3c 393 int length = -1;
b6cb8e7d
TJB
394 gdb_byte *buffer;
395 struct value *value = ((value_object *) self)->value;
396 volatile struct gdb_exception except;
397 PyObject *unicode;
398 const char *encoding = NULL;
399 const char *errors = NULL;
400 const char *user_encoding = NULL;
401 const char *la_encoding = NULL;
96c07c5b 402 struct type *char_type;
31158f0e 403 static char *keywords[] = { "encoding", "errors", "length", NULL };
b6cb8e7d 404
fbb8f299
PM
405 if (!PyArg_ParseTupleAndKeywords (args, kw, "|ssi", keywords,
406 &user_encoding, &errors, &length))
b6cb8e7d
TJB
407 return NULL;
408
409 TRY_CATCH (except, RETURN_MASK_ALL)
410 {
96c07c5b 411 LA_GET_STRING (value, &buffer, &length, &char_type, &la_encoding);
b6cb8e7d
TJB
412 }
413 GDB_PY_HANDLE_EXCEPTION (except);
414
415 encoding = (user_encoding && *user_encoding) ? user_encoding : la_encoding;
89f6d837
PA
416 unicode = PyUnicode_Decode ((const char *) buffer,
417 length * TYPE_LENGTH (char_type),
96c07c5b 418 encoding, errors);
b6cb8e7d
TJB
419 xfree (buffer);
420
421 return unicode;
422}
423
f9ffd4bb
TT
424/* A helper function that implements the various cast operators. */
425
2c74e833 426static PyObject *
f9ffd4bb 427valpy_do_cast (PyObject *self, PyObject *args, enum exp_opcode op)
2c74e833 428{
888fe1e1 429 PyObject *type_obj, *result = NULL;
2c74e833 430 struct type *type;
2c74e833
TT
431 volatile struct gdb_exception except;
432
433 if (! PyArg_ParseTuple (args, "O", &type_obj))
434 return NULL;
435
436 type = type_object_to_type (type_obj);
437 if (! type)
438 {
256458bc 439 PyErr_SetString (PyExc_RuntimeError,
044c0f87 440 _("Argument must be a type."));
2c74e833
TT
441 return NULL;
442 }
443
444 TRY_CATCH (except, RETURN_MASK_ALL)
445 {
f9ffd4bb 446 struct value *val = ((value_object *) self)->value;
888fe1e1
TT
447 struct value *res_val;
448 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
f9ffd4bb
TT
449
450 if (op == UNOP_DYNAMIC_CAST)
451 res_val = value_dynamic_cast (type, val);
452 else if (op == UNOP_REINTERPRET_CAST)
453 res_val = value_reinterpret_cast (type, val);
454 else
455 {
456 gdb_assert (op == UNOP_CAST);
457 res_val = value_cast (type, val);
458 }
888fe1e1
TT
459
460 result = value_to_value_object (res_val);
461 do_cleanups (cleanup);
2c74e833
TT
462 }
463 GDB_PY_HANDLE_EXCEPTION (except);
464
888fe1e1 465 return result;
2c74e833
TT
466}
467
f9ffd4bb
TT
468/* Implementation of the "cast" method. */
469
470static PyObject *
471valpy_cast (PyObject *self, PyObject *args)
472{
473 return valpy_do_cast (self, args, UNOP_CAST);
474}
475
476/* Implementation of the "dynamic_cast" method. */
477
478static PyObject *
479valpy_dynamic_cast (PyObject *self, PyObject *args)
480{
481 return valpy_do_cast (self, args, UNOP_DYNAMIC_CAST);
482}
483
484/* Implementation of the "reinterpret_cast" method. */
485
486static PyObject *
487valpy_reinterpret_cast (PyObject *self, PyObject *args)
488{
489 return valpy_do_cast (self, args, UNOP_REINTERPRET_CAST);
490}
491
7843261b
TJB
492static Py_ssize_t
493valpy_length (PyObject *self)
494{
495 /* We don't support getting the number of elements in a struct / class. */
496 PyErr_SetString (PyExc_NotImplementedError,
044c0f87 497 _("Invalid operation on gdb.Value."));
7843261b
TJB
498 return -1;
499}
500
a16b0e22
SC
501/* Return 1 if the gdb.Field object FIELD is present in the value V.
502 Returns 0 otherwise. If any Python error occurs, -1 is returned. */
503
504static int
505value_has_field (struct value *v, PyObject *field)
506{
507 struct type *parent_type, *val_type;
508 enum type_code type_code;
509 PyObject *type_object = PyObject_GetAttrString (field, "parent_type");
510 volatile struct gdb_exception except;
511 int has_field = 0;
512
513 if (type_object == NULL)
514 return -1;
515
516 parent_type = type_object_to_type (type_object);
517 Py_DECREF (type_object);
518 if (parent_type == NULL)
519 {
520 PyErr_SetString (PyExc_TypeError,
521 _("'parent_type' attribute of gdb.Field object is not a"
522 "gdb.Type object."));
523 return -1;
524 }
525
526 TRY_CATCH (except, RETURN_MASK_ALL)
527 {
528 val_type = value_type (v);
529 val_type = check_typedef (val_type);
530 if (TYPE_CODE (val_type) == TYPE_CODE_REF
531 || TYPE_CODE (val_type) == TYPE_CODE_PTR)
532 val_type = check_typedef (TYPE_TARGET_TYPE (val_type));
533
534 type_code = TYPE_CODE (val_type);
535 if ((type_code == TYPE_CODE_STRUCT || type_code == TYPE_CODE_UNION)
536 && types_equal (val_type, parent_type))
537 has_field = 1;
538 else
539 has_field = 0;
540 }
541 GDB_PY_SET_HANDLE_EXCEPTION (except);
542
543 return has_field;
544}
545
546/* Return the value of a flag FLAG_NAME in a gdb.Field object FIELD.
547 Returns 1 if the flag value is true, 0 if it is false, and -1 if
548 a Python error occurs. */
549
550static int
551get_field_flag (PyObject *field, const char *flag_name)
552{
553 int flag_value;
554 PyObject *flag_object = PyObject_GetAttrString (field, flag_name);
555
556 if (flag_object == NULL)
557 return -1;
558
559 flag_value = PyObject_IsTrue (flag_object);
560 Py_DECREF (flag_object);
561
562 return flag_value;
563}
564
b5b08fb4
SC
565/* Return the "type" attribute of a gdb.Field object.
566 Returns NULL on error, with a Python exception set. */
567
568static struct type *
569get_field_type (PyObject *field)
570{
571 PyObject *ftype_obj = PyObject_GetAttrString (field, "type");
572 struct type *ftype;
573
574 if (ftype_obj == NULL)
575 return NULL;
576 ftype = type_object_to_type (ftype_obj);
577 Py_DECREF (ftype_obj);
578 if (ftype == NULL)
bf7105a4
JB
579 PyErr_SetString (PyExc_TypeError,
580 _("'type' attribute of gdb.Field object is not a "
581 "gdb.Type object."));
b5b08fb4
SC
582
583 return ftype;
584}
585
a16b0e22
SC
586/* Given string name or a gdb.Field object corresponding to an element inside
587 a structure, return its value object. Returns NULL on error, with a python
588 exception set. */
589
7843261b
TJB
590static PyObject *
591valpy_getitem (PyObject *self, PyObject *key)
592{
593 value_object *self_value = (value_object *) self;
08c637de 594 char *field = NULL;
b5b08fb4
SC
595 struct type *base_class_type = NULL, *field_type = NULL;
596 long bitpos = -1;
7843261b 597 volatile struct gdb_exception except;
888fe1e1 598 PyObject *result = NULL;
7843261b 599
08c637de 600 if (gdbpy_is_string (key))
256458bc 601 {
08c637de
TJB
602 field = python_string_to_host_string (key);
603 if (field == NULL)
604 return NULL;
605 }
a16b0e22
SC
606 else if (gdbpy_is_field (key))
607 {
608 int is_base_class, valid_field;
609
610 valid_field = value_has_field (self_value->value, key);
611 if (valid_field < 0)
612 return NULL;
613 else if (valid_field == 0)
614 {
615 PyErr_SetString (PyExc_TypeError,
616 _("Invalid lookup for a field not contained in "
617 "the value."));
618
619 return NULL;
620 }
621
622 is_base_class = get_field_flag (key, "is_base_class");
623 if (is_base_class < 0)
624 return NULL;
625 else if (is_base_class > 0)
626 {
b5b08fb4
SC
627 base_class_type = get_field_type (key);
628 if (base_class_type == NULL)
a16b0e22
SC
629 return NULL;
630 }
631 else
632 {
633 PyObject *name_obj = PyObject_GetAttrString (key, "name");
634
635 if (name_obj == NULL)
636 return NULL;
637
b5b08fb4
SC
638 if (name_obj != Py_None)
639 {
640 field = python_string_to_host_string (name_obj);
641 Py_DECREF (name_obj);
642 if (field == NULL)
643 return NULL;
644 }
645 else
646 {
647 PyObject *bitpos_obj;
648 int valid;
649
650 Py_DECREF (name_obj);
651
652 if (!PyObject_HasAttrString (key, "bitpos"))
653 {
654 PyErr_SetString (PyExc_AttributeError,
655 _("gdb.Field object has no name and no "
656 "'bitpos' attribute."));
657
658 return NULL;
659 }
660 bitpos_obj = PyObject_GetAttrString (key, "bitpos");
661 if (bitpos_obj == NULL)
662 return NULL;
663 valid = gdb_py_int_as_long (bitpos_obj, &bitpos);
664 Py_DECREF (bitpos_obj);
665 if (!valid)
666 return NULL;
667
668 field_type = get_field_type (key);
669 if (field_type == NULL)
670 return NULL;
671 }
a16b0e22
SC
672 }
673 }
7843261b
TJB
674
675 TRY_CATCH (except, RETURN_MASK_ALL)
676 {
3c0ed299 677 struct value *tmp = self_value->value;
888fe1e1
TT
678 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
679 struct value *res_val = NULL;
08c637de
TJB
680
681 if (field)
682 res_val = value_struct_elt (&tmp, NULL, field, 0, NULL);
b5b08fb4
SC
683 else if (bitpos >= 0)
684 res_val = value_struct_elt_bitpos (&tmp, bitpos, field_type,
685 "struct/class/union");
686 else if (base_class_type != NULL)
a16b0e22 687 {
b5b08fb4 688 struct type *val_type;
a16b0e22
SC
689
690 val_type = check_typedef (value_type (tmp));
691 if (TYPE_CODE (val_type) == TYPE_CODE_PTR)
692 res_val = value_cast (lookup_pointer_type (base_class_type), tmp);
693 else if (TYPE_CODE (val_type) == TYPE_CODE_REF)
694 res_val = value_cast (lookup_reference_type (base_class_type), tmp);
695 else
696 res_val = value_cast (base_class_type, tmp);
697 }
08c637de
TJB
698 else
699 {
700 /* Assume we are attempting an array access, and let the
701 value code throw an exception if the index has an invalid
702 type. */
703 struct value *idx = convert_value_from_python (key);
d59b6f6c 704
570e2b1a 705 if (idx != NULL)
2e4d963f
PM
706 {
707 /* Check the value's type is something that can be accessed via
708 a subscript. */
709 struct type *type;
d59b6f6c 710
2e4d963f
PM
711 tmp = coerce_ref (tmp);
712 type = check_typedef (value_type (tmp));
713 if (TYPE_CODE (type) != TYPE_CODE_ARRAY
714 && TYPE_CODE (type) != TYPE_CODE_PTR)
e10abd8f 715 error (_("Cannot subscript requested type."));
2e4d963f
PM
716 else
717 res_val = value_subscript (tmp, value_as_long (idx));
718 }
08c637de 719 }
888fe1e1
TT
720
721 if (res_val)
722 result = value_to_value_object (res_val);
723 do_cleanups (cleanup);
7843261b 724 }
570e2b1a 725
06878dd2 726 xfree (field);
7843261b
TJB
727 GDB_PY_HANDLE_EXCEPTION (except);
728
888fe1e1 729 return result;
7843261b
TJB
730}
731
732static int
733valpy_setitem (PyObject *self, PyObject *key, PyObject *value)
734{
735 PyErr_Format (PyExc_NotImplementedError,
736 _("Setting of struct elements is not currently supported."));
737 return -1;
738}
739
5374244e 740/* Called by the Python interpreter to perform an inferior function
8dc78533 741 call on the value. Returns NULL on error, with a python exception set. */
5374244e
PM
742static PyObject *
743valpy_call (PyObject *self, PyObject *args, PyObject *keywords)
744{
5374244e
PM
745 Py_ssize_t args_count;
746 volatile struct gdb_exception except;
747 struct value *function = ((value_object *) self)->value;
748 struct value **vargs = NULL;
749fd4ea 749 struct type *ftype = NULL;
888fe1e1
TT
750 struct value *mark = value_mark ();
751 PyObject *result = NULL;
f287c1f3
PM
752
753 TRY_CATCH (except, RETURN_MASK_ALL)
754 {
755 ftype = check_typedef (value_type (function));
756 }
757 GDB_PY_HANDLE_EXCEPTION (except);
5374244e
PM
758
759 if (TYPE_CODE (ftype) != TYPE_CODE_FUNC)
760 {
761 PyErr_SetString (PyExc_RuntimeError,
762 _("Value is not callable (not TYPE_CODE_FUNC)."));
763 return NULL;
764 }
765
f287c1f3
PM
766 if (! PyTuple_Check (args))
767 {
768 PyErr_SetString (PyExc_TypeError,
769 _("Inferior arguments must be provided in a tuple."));
770 return NULL;
771 }
772
5374244e
PM
773 args_count = PyTuple_Size (args);
774 if (args_count > 0)
775 {
776 int i;
777
778 vargs = alloca (sizeof (struct value *) * args_count);
779 for (i = 0; i < args_count; i++)
780 {
781 PyObject *item = PyTuple_GetItem (args, i);
782
783 if (item == NULL)
784 return NULL;
785
786 vargs[i] = convert_value_from_python (item);
787 if (vargs[i] == NULL)
788 return NULL;
789 }
790 }
791
792 TRY_CATCH (except, RETURN_MASK_ALL)
793 {
888fe1e1
TT
794 struct cleanup *cleanup = make_cleanup_value_free_to_mark (mark);
795 struct value *return_value;
796
5374244e 797 return_value = call_function_by_hand (function, args_count, vargs);
888fe1e1
TT
798 result = value_to_value_object (return_value);
799 do_cleanups (cleanup);
5374244e
PM
800 }
801 GDB_PY_HANDLE_EXCEPTION (except);
802
888fe1e1 803 return result;
5374244e
PM
804}
805
7843261b
TJB
806/* Called by the Python interpreter to obtain string representation
807 of the object. */
808static PyObject *
809valpy_str (PyObject *self)
810{
811 char *s = NULL;
7843261b 812 PyObject *result;
79a45b7d 813 struct value_print_options opts;
7843261b
TJB
814 volatile struct gdb_exception except;
815
79a45b7d
TT
816 get_user_print_options (&opts);
817 opts.deref_ref = 0;
818
7843261b
TJB
819 TRY_CATCH (except, RETURN_MASK_ALL)
820 {
5fe41fbf
TT
821 struct ui_file *stb = mem_fileopen ();
822 struct cleanup *old_chain = make_cleanup_ui_file_delete (stb);
823
79a45b7d 824 common_val_print (((value_object *) self)->value, stb, 0,
d452c4bc 825 &opts, python_language);
759ef836 826 s = ui_file_xstrdup (stb, NULL);
5fe41fbf
TT
827
828 do_cleanups (old_chain);
7843261b
TJB
829 }
830 GDB_PY_HANDLE_EXCEPTION (except);
831
7843261b
TJB
832 result = PyUnicode_Decode (s, strlen (s), host_charset (), NULL);
833 xfree (s);
834
835 return result;
836}
837
def2b000
TJB
838/* Implements gdb.Value.is_optimized_out. */
839static PyObject *
840valpy_get_is_optimized_out (PyObject *self, void *closure)
841{
842 struct value *value = ((value_object *) self)->value;
f287c1f3
PM
843 int opt = 0;
844 volatile struct gdb_exception except;
def2b000 845
f287c1f3
PM
846 TRY_CATCH (except, RETURN_MASK_ALL)
847 {
848 opt = value_optimized_out (value);
849 }
850 GDB_PY_HANDLE_EXCEPTION (except);
851
852 if (opt)
def2b000
TJB
853 Py_RETURN_TRUE;
854
855 Py_RETURN_FALSE;
856}
857
913460fc
PK
858/* Implements gdb.Value.is_lazy. */
859static PyObject *
860valpy_get_is_lazy (PyObject *self, void *closure)
861{
862 struct value *value = ((value_object *) self)->value;
863 int opt = 0;
864 volatile struct gdb_exception except;
865
866 TRY_CATCH (except, RETURN_MASK_ALL)
867 {
868 opt = value_lazy (value);
869 }
870 GDB_PY_HANDLE_EXCEPTION (except);
871
872 if (opt)
873 Py_RETURN_TRUE;
874
875 Py_RETURN_FALSE;
876}
877
878/* Implements gdb.Value.fetch_lazy (). */
879static PyObject *
880valpy_fetch_lazy (PyObject *self, PyObject *args)
881{
882 struct value *value = ((value_object *) self)->value;
883 volatile struct gdb_exception except;
884
885 TRY_CATCH (except, RETURN_MASK_ALL)
886 {
887 if (value_lazy (value))
888 value_fetch_lazy (value);
889 }
890 GDB_PY_HANDLE_EXCEPTION (except);
891
892 Py_RETURN_NONE;
893}
894
88d4aea7
PM
895/* Calculate and return the address of the PyObject as the value of
896 the builtin __hash__ call. */
256458bc 897static long
88d4aea7
PM
898valpy_hash (PyObject *self)
899{
900 return (long) (intptr_t) self;
901}
902
7843261b
TJB
903enum valpy_opcode
904{
905 VALPY_ADD,
906 VALPY_SUB,
907 VALPY_MUL,
908 VALPY_DIV,
909 VALPY_REM,
08c637de
TJB
910 VALPY_POW,
911 VALPY_LSH,
912 VALPY_RSH,
913 VALPY_BITAND,
914 VALPY_BITOR,
915 VALPY_BITXOR
7843261b
TJB
916};
917
918/* If TYPE is a reference, return the target; otherwise return TYPE. */
919#define STRIP_REFERENCE(TYPE) \
920 ((TYPE_CODE (TYPE) == TYPE_CODE_REF) ? (TYPE_TARGET_TYPE (TYPE)) : (TYPE))
921
922/* Returns a value object which is the result of applying the operation
8dc78533
JK
923 specified by OPCODE to the given arguments. Returns NULL on error, with
924 a python exception set. */
7843261b
TJB
925static PyObject *
926valpy_binop (enum valpy_opcode opcode, PyObject *self, PyObject *other)
927{
7843261b 928 volatile struct gdb_exception except;
888fe1e1 929 PyObject *result = NULL;
7843261b
TJB
930
931 TRY_CATCH (except, RETURN_MASK_ALL)
932 {
933 struct value *arg1, *arg2;
888fe1e1 934 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
0f5b7562 935 struct value *res_val = NULL;
7843261b
TJB
936
937 /* If the gdb.Value object is the second operand, then it will be passed
938 to us as the OTHER argument, and SELF will be an entirely different
939 kind of object, altogether. Because of this, we can't assume self is
940 a gdb.Value object and need to convert it from python as well. */
941 arg1 = convert_value_from_python (self);
08c637de 942 if (arg1 == NULL)
edefe1da
TT
943 {
944 do_cleanups (cleanup);
945 break;
946 }
08c637de 947
7843261b 948 arg2 = convert_value_from_python (other);
08c637de 949 if (arg2 == NULL)
edefe1da
TT
950 {
951 do_cleanups (cleanup);
952 break;
953 }
7843261b
TJB
954
955 switch (opcode)
956 {
957 case VALPY_ADD:
958 {
959 struct type *ltype = value_type (arg1);
960 struct type *rtype = value_type (arg2);
961
962 CHECK_TYPEDEF (ltype);
963 ltype = STRIP_REFERENCE (ltype);
964 CHECK_TYPEDEF (rtype);
965 rtype = STRIP_REFERENCE (rtype);
966
2497b498
UW
967 if (TYPE_CODE (ltype) == TYPE_CODE_PTR
968 && is_integral_type (rtype))
969 res_val = value_ptradd (arg1, value_as_long (arg2));
970 else if (TYPE_CODE (rtype) == TYPE_CODE_PTR
971 && is_integral_type (ltype))
972 res_val = value_ptradd (arg2, value_as_long (arg1));
7843261b
TJB
973 else
974 res_val = value_binop (arg1, arg2, BINOP_ADD);
975 }
976 break;
977 case VALPY_SUB:
978 {
979 struct type *ltype = value_type (arg1);
980 struct type *rtype = value_type (arg2);
981
982 CHECK_TYPEDEF (ltype);
983 ltype = STRIP_REFERENCE (ltype);
984 CHECK_TYPEDEF (rtype);
985 rtype = STRIP_REFERENCE (rtype);
986
2497b498
UW
987 if (TYPE_CODE (ltype) == TYPE_CODE_PTR
988 && TYPE_CODE (rtype) == TYPE_CODE_PTR)
989 /* A ptrdiff_t for the target would be preferable here. */
990 res_val = value_from_longest (builtin_type_pyint,
991 value_ptrdiff (arg1, arg2));
992 else if (TYPE_CODE (ltype) == TYPE_CODE_PTR
993 && is_integral_type (rtype))
994 res_val = value_ptradd (arg1, - value_as_long (arg2));
7843261b
TJB
995 else
996 res_val = value_binop (arg1, arg2, BINOP_SUB);
997 }
998 break;
999 case VALPY_MUL:
1000 res_val = value_binop (arg1, arg2, BINOP_MUL);
1001 break;
1002 case VALPY_DIV:
1003 res_val = value_binop (arg1, arg2, BINOP_DIV);
1004 break;
1005 case VALPY_REM:
1006 res_val = value_binop (arg1, arg2, BINOP_REM);
1007 break;
1008 case VALPY_POW:
1009 res_val = value_binop (arg1, arg2, BINOP_EXP);
1010 break;
08c637de
TJB
1011 case VALPY_LSH:
1012 res_val = value_binop (arg1, arg2, BINOP_LSH);
1013 break;
1014 case VALPY_RSH:
1015 res_val = value_binop (arg1, arg2, BINOP_RSH);
1016 break;
1017 case VALPY_BITAND:
1018 res_val = value_binop (arg1, arg2, BINOP_BITWISE_AND);
1019 break;
1020 case VALPY_BITOR:
1021 res_val = value_binop (arg1, arg2, BINOP_BITWISE_IOR);
1022 break;
1023 case VALPY_BITXOR:
1024 res_val = value_binop (arg1, arg2, BINOP_BITWISE_XOR);
1025 break;
7843261b 1026 }
888fe1e1
TT
1027
1028 if (res_val)
1029 result = value_to_value_object (res_val);
1030
1031 do_cleanups (cleanup);
7843261b
TJB
1032 }
1033 GDB_PY_HANDLE_EXCEPTION (except);
1034
888fe1e1 1035 return result;
7843261b
TJB
1036}
1037
1038static PyObject *
1039valpy_add (PyObject *self, PyObject *other)
1040{
1041 return valpy_binop (VALPY_ADD, self, other);
1042}
1043
1044static PyObject *
1045valpy_subtract (PyObject *self, PyObject *other)
1046{
1047 return valpy_binop (VALPY_SUB, self, other);
1048}
1049
1050static PyObject *
1051valpy_multiply (PyObject *self, PyObject *other)
1052{
1053 return valpy_binop (VALPY_MUL, self, other);
1054}
1055
1056static PyObject *
1057valpy_divide (PyObject *self, PyObject *other)
1058{
1059 return valpy_binop (VALPY_DIV, self, other);
1060}
1061
1062static PyObject *
1063valpy_remainder (PyObject *self, PyObject *other)
1064{
1065 return valpy_binop (VALPY_REM, self, other);
1066}
1067
1068static PyObject *
1069valpy_power (PyObject *self, PyObject *other, PyObject *unused)
1070{
1071 /* We don't support the ternary form of pow. I don't know how to express
1072 that, so let's just throw NotImplementedError to at least do something
1073 about it. */
1074 if (unused != Py_None)
1075 {
1076 PyErr_SetString (PyExc_NotImplementedError,
1077 "Invalid operation on gdb.Value.");
1078 return NULL;
1079 }
1080
1081 return valpy_binop (VALPY_POW, self, other);
1082}
1083
1084static PyObject *
1085valpy_negative (PyObject *self)
1086{
7843261b 1087 volatile struct gdb_exception except;
888fe1e1 1088 PyObject *result = NULL;
7843261b
TJB
1089
1090 TRY_CATCH (except, RETURN_MASK_ALL)
1091 {
888fe1e1
TT
1092 /* Perhaps overkill, but consistency has some virtue. */
1093 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
1094 struct value *val;
1095
7843261b 1096 val = value_neg (((value_object *) self)->value);
888fe1e1
TT
1097 result = value_to_value_object (val);
1098 do_cleanups (cleanup);
7843261b
TJB
1099 }
1100 GDB_PY_HANDLE_EXCEPTION (except);
1101
888fe1e1 1102 return result;
7843261b
TJB
1103}
1104
1105static PyObject *
1106valpy_positive (PyObject *self)
1107{
4e7a5ef5 1108 return value_to_value_object (((value_object *) self)->value);
7843261b
TJB
1109}
1110
1111static PyObject *
1112valpy_absolute (PyObject *self)
1113{
22601c15 1114 struct value *value = ((value_object *) self)->value;
f287c1f3
PM
1115 volatile struct gdb_exception except;
1116 int isabs = 1;
d59b6f6c 1117
f287c1f3
PM
1118 TRY_CATCH (except, RETURN_MASK_ALL)
1119 {
888fe1e1
TT
1120 struct cleanup *cleanup = make_cleanup_value_free_to_mark (value_mark ());
1121
f287c1f3
PM
1122 if (value_less (value, value_zero (value_type (value), not_lval)))
1123 isabs = 0;
888fe1e1
TT
1124
1125 do_cleanups (cleanup);
f287c1f3
PM
1126 }
1127 GDB_PY_HANDLE_EXCEPTION (except);
1128
1129 if (isabs)
7843261b 1130 return valpy_positive (self);
f287c1f3
PM
1131 else
1132 return valpy_negative (self);
7843261b
TJB
1133}
1134
1135/* Implements boolean evaluation of gdb.Value. */
1136static int
1137valpy_nonzero (PyObject *self)
1138{
f287c1f3 1139 volatile struct gdb_exception except;
7843261b
TJB
1140 value_object *self_value = (value_object *) self;
1141 struct type *type;
f287c1f3 1142 int nonzero = 0; /* Appease GCC warning. */
7843261b 1143
f287c1f3
PM
1144 TRY_CATCH (except, RETURN_MASK_ALL)
1145 {
5d9c5995
PM
1146 type = check_typedef (value_type (self_value->value));
1147
f287c1f3
PM
1148 if (is_integral_type (type) || TYPE_CODE (type) == TYPE_CODE_PTR)
1149 nonzero = !!value_as_long (self_value->value);
1150 else if (TYPE_CODE (type) == TYPE_CODE_FLT)
1151 nonzero = value_as_double (self_value->value) != 0;
1152 else if (TYPE_CODE (type) == TYPE_CODE_DECFLOAT)
1153 nonzero = !decimal_is_zero (value_contents (self_value->value),
1154 TYPE_LENGTH (type),
1155 gdbarch_byte_order (get_type_arch (type)));
1156 else
1157 /* All other values are True. */
1158 nonzero = 1;
1159 }
1160 /* This is not documented in the Python documentation, but if this
1161 function fails, return -1 as slot_nb_nonzero does (the default
1162 Python nonzero function). */
1163 GDB_PY_SET_HANDLE_EXCEPTION (except);
1164
1165 return nonzero;
7843261b
TJB
1166}
1167
08c637de 1168/* Implements ~ for value objects. */
7843261b 1169static PyObject *
08c637de 1170valpy_invert (PyObject *self)
7843261b 1171{
08c637de 1172 struct value *val = NULL;
7843261b
TJB
1173 volatile struct gdb_exception except;
1174
08c637de 1175 TRY_CATCH (except, RETURN_MASK_ALL)
7843261b 1176 {
08c637de
TJB
1177 val = value_complement (((value_object *) self)->value);
1178 }
1179 GDB_PY_HANDLE_EXCEPTION (except);
7843261b 1180
08c637de
TJB
1181 return value_to_value_object (val);
1182}
7843261b 1183
08c637de
TJB
1184/* Implements left shift for value objects. */
1185static PyObject *
1186valpy_lsh (PyObject *self, PyObject *other)
1187{
1188 return valpy_binop (VALPY_LSH, self, other);
1189}
7843261b 1190
08c637de
TJB
1191/* Implements right shift for value objects. */
1192static PyObject *
1193valpy_rsh (PyObject *self, PyObject *other)
1194{
1195 return valpy_binop (VALPY_RSH, self, other);
1196}
7843261b 1197
08c637de
TJB
1198/* Implements bitwise and for value objects. */
1199static PyObject *
1200valpy_and (PyObject *self, PyObject *other)
1201{
1202 return valpy_binop (VALPY_BITAND, self, other);
1203}
7843261b 1204
08c637de
TJB
1205/* Implements bitwise or for value objects. */
1206static PyObject *
1207valpy_or (PyObject *self, PyObject *other)
1208{
1209 return valpy_binop (VALPY_BITOR, self, other);
1210}
1211
1212/* Implements bitwise xor for value objects. */
1213static PyObject *
1214valpy_xor (PyObject *self, PyObject *other)
1215{
1216 return valpy_binop (VALPY_BITXOR, self, other);
1217}
1218
8dc78533
JK
1219/* Implements comparison operations for value objects. Returns NULL on error,
1220 with a python exception set. */
08c637de
TJB
1221static PyObject *
1222valpy_richcompare (PyObject *self, PyObject *other, int op)
1223{
1224 int result = 0;
08c637de
TJB
1225 volatile struct gdb_exception except;
1226
1227 if (other == Py_None)
7843261b
TJB
1228 /* Comparing with None is special. From what I can tell, in Python
1229 None is smaller than anything else. */
1230 switch (op) {
1231 case Py_LT:
1232 case Py_LE:
1233 case Py_EQ:
1234 Py_RETURN_FALSE;
1235 case Py_NE:
1236 case Py_GT:
1237 case Py_GE:
1238 Py_RETURN_TRUE;
1239 default:
1240 /* Can't happen. */
1241 PyErr_SetString (PyExc_NotImplementedError,
044c0f87 1242 _("Invalid operation on gdb.Value."));
7843261b
TJB
1243 return NULL;
1244 }
7843261b
TJB
1245
1246 TRY_CATCH (except, RETURN_MASK_ALL)
1247 {
888fe1e1
TT
1248 struct value *value_other, *mark = value_mark ();
1249 struct cleanup *cleanup;
1250
08c637de
TJB
1251 value_other = convert_value_from_python (other);
1252 if (value_other == NULL)
f02779d8
TT
1253 {
1254 result = -1;
1255 break;
1256 }
08c637de 1257
888fe1e1
TT
1258 cleanup = make_cleanup_value_free_to_mark (mark);
1259
7843261b
TJB
1260 switch (op) {
1261 case Py_LT:
1262 result = value_less (((value_object *) self)->value, value_other);
1263 break;
1264 case Py_LE:
1265 result = value_less (((value_object *) self)->value, value_other)
1266 || value_equal (((value_object *) self)->value, value_other);
1267 break;
1268 case Py_EQ:
1269 result = value_equal (((value_object *) self)->value, value_other);
1270 break;
1271 case Py_NE:
1272 result = !value_equal (((value_object *) self)->value, value_other);
1273 break;
1274 case Py_GT:
1275 result = value_less (value_other, ((value_object *) self)->value);
1276 break;
1277 case Py_GE:
1278 result = value_less (value_other, ((value_object *) self)->value)
1279 || value_equal (((value_object *) self)->value, value_other);
1280 break;
1281 default:
1282 /* Can't happen. */
1283 PyErr_SetString (PyExc_NotImplementedError,
044c0f87 1284 _("Invalid operation on gdb.Value."));
f02779d8
TT
1285 result = -1;
1286 break;
7843261b 1287 }
888fe1e1
TT
1288
1289 do_cleanups (cleanup);
7843261b
TJB
1290 }
1291 GDB_PY_HANDLE_EXCEPTION (except);
1292
f02779d8
TT
1293 /* In this case, the Python exception has already been set. */
1294 if (result < 0)
1295 return NULL;
1296
7843261b
TJB
1297 if (result == 1)
1298 Py_RETURN_TRUE;
1299
1300 Py_RETURN_FALSE;
1301}
1302
9a27f2c6 1303#ifndef IS_PY3K
08c637de
TJB
1304/* Implements conversion to int. */
1305static PyObject *
1306valpy_int (PyObject *self)
1307{
1308 struct value *value = ((value_object *) self)->value;
1309 struct type *type = value_type (value);
1310 LONGEST l = 0;
1311 volatile struct gdb_exception except;
1312
08c637de
TJB
1313 TRY_CATCH (except, RETURN_MASK_ALL)
1314 {
7c245c24 1315 if (!is_integral_type (type))
f287c1f3
PM
1316 error (_("Cannot convert value to int."));
1317
08c637de
TJB
1318 l = value_as_long (value);
1319 }
1320 GDB_PY_HANDLE_EXCEPTION (except);
1321
74aedc46 1322 return gdb_py_object_from_longest (l);
08c637de 1323}
9a27f2c6 1324#endif
08c637de
TJB
1325
1326/* Implements conversion to long. */
1327static PyObject *
1328valpy_long (PyObject *self)
1329{
1330 struct value *value = ((value_object *) self)->value;
1331 struct type *type = value_type (value);
1332 LONGEST l = 0;
1333 volatile struct gdb_exception except;
1334
08c637de
TJB
1335 TRY_CATCH (except, RETURN_MASK_ALL)
1336 {
f287c1f3
PM
1337 CHECK_TYPEDEF (type);
1338
7c245c24
JB
1339 if (!is_integral_type (type)
1340 && TYPE_CODE (type) != TYPE_CODE_PTR)
f287c1f3
PM
1341 error (_("Cannot convert value to long."));
1342
08c637de
TJB
1343 l = value_as_long (value);
1344 }
1345 GDB_PY_HANDLE_EXCEPTION (except);
1346
74aedc46 1347 return gdb_py_long_from_longest (l);
08c637de
TJB
1348}
1349
1350/* Implements conversion to float. */
1351static PyObject *
1352valpy_float (PyObject *self)
1353{
1354 struct value *value = ((value_object *) self)->value;
1355 struct type *type = value_type (value);
1356 double d = 0;
1357 volatile struct gdb_exception except;
1358
08c637de
TJB
1359 TRY_CATCH (except, RETURN_MASK_ALL)
1360 {
f287c1f3
PM
1361 CHECK_TYPEDEF (type);
1362
1363 if (TYPE_CODE (type) != TYPE_CODE_FLT)
1364 error (_("Cannot convert value to float."));
1365
08c637de
TJB
1366 d = value_as_double (value);
1367 }
1368 GDB_PY_HANDLE_EXCEPTION (except);
1369
1370 return PyFloat_FromDouble (d);
1371}
1372
7843261b
TJB
1373/* Returns an object for a value which is released from the all_values chain,
1374 so its lifetime is not bound to the execution of a command. */
1375PyObject *
1376value_to_value_object (struct value *val)
1377{
1378 value_object *val_obj;
1379
1380 val_obj = PyObject_New (value_object, &value_object_type);
1381 if (val_obj != NULL)
1382 {
1383 val_obj->value = val;
e848a8a5 1384 release_value_or_incref (val);
c0c6f777 1385 val_obj->address = NULL;
2c74e833 1386 val_obj->type = NULL;
03f17ccf 1387 val_obj->dynamic_type = NULL;
4e7a5ef5 1388 note_value (val_obj);
7843261b
TJB
1389 }
1390
1391 return (PyObject *) val_obj;
1392}
1393
4e7a5ef5
TT
1394/* Returns a borrowed reference to the struct value corresponding to
1395 the given value object. */
a6bac58e
TT
1396struct value *
1397value_object_to_value (PyObject *self)
1398{
1399 value_object *real;
d59b6f6c 1400
a6bac58e
TT
1401 if (! PyObject_TypeCheck (self, &value_object_type))
1402 return NULL;
1403 real = (value_object *) self;
1404 return real->value;
1405}
1406
7843261b 1407/* Try to convert a Python value to a gdb value. If the value cannot
4e7a5ef5
TT
1408 be converted, set a Python exception and return NULL. Returns a
1409 reference to a new value on the all_values chain. */
7843261b
TJB
1410
1411struct value *
1412convert_value_from_python (PyObject *obj)
1413{
1414 struct value *value = NULL; /* -Wall */
08c637de
TJB
1415 volatile struct gdb_exception except;
1416 int cmp;
7843261b 1417
08c637de 1418 gdb_assert (obj != NULL);
7843261b 1419
08c637de 1420 TRY_CATCH (except, RETURN_MASK_ALL)
7843261b 1421 {
256458bc 1422 if (PyBool_Check (obj))
08c637de
TJB
1423 {
1424 cmp = PyObject_IsTrue (obj);
1425 if (cmp >= 0)
1426 value = value_from_longest (builtin_type_pybool, cmp);
1427 }
06ab7b19
PM
1428 /* Make a long logic check first. In Python 3.x, internally,
1429 all integers are represented as longs. In Python 2.x, there
1430 is still a differentiation internally between a PyInt and a
1431 PyLong. Explicitly do this long check conversion first. In
1432 GDB, for Python 3.x, we #ifdef PyInt = PyLong. This check has
1433 to be done first to ensure we do not lose information in the
1434 conversion process. */
08c637de
TJB
1435 else if (PyLong_Check (obj))
1436 {
1437 LONGEST l = PyLong_AsLongLong (obj);
7843261b 1438
595939de
PM
1439 if (PyErr_Occurred ())
1440 {
1441 /* If the error was an overflow, we can try converting to
1442 ULONGEST instead. */
1443 if (PyErr_ExceptionMatches (PyExc_OverflowError))
1444 {
1445 PyObject *etype, *evalue, *etraceback, *zero;
1446
1447 PyErr_Fetch (&etype, &evalue, &etraceback);
1448 zero = PyInt_FromLong (0);
1449
1450 /* Check whether obj is positive. */
1451 if (PyObject_RichCompareBool (obj, zero, Py_GT) > 0)
1452 {
1453 ULONGEST ul;
1454
1455 ul = PyLong_AsUnsignedLongLong (obj);
1456 if (! PyErr_Occurred ())
1457 value = value_from_ulongest (builtin_type_upylong, ul);
1458 }
1459 else
1460 /* There's nothing we can do. */
1461 PyErr_Restore (etype, evalue, etraceback);
1462
1463 Py_DECREF (zero);
1464 }
1465 }
1466 else
08c637de
TJB
1467 value = value_from_longest (builtin_type_pylong, l);
1468 }
06ab7b19
PM
1469 else if (PyInt_Check (obj))
1470 {
1471 long l = PyInt_AsLong (obj);
1472
1473 if (! PyErr_Occurred ())
1474 value = value_from_longest (builtin_type_pyint, l);
1475 }
08c637de
TJB
1476 else if (PyFloat_Check (obj))
1477 {
1478 double d = PyFloat_AsDouble (obj);
7843261b 1479
08c637de
TJB
1480 if (! PyErr_Occurred ())
1481 value = value_from_double (builtin_type_pyfloat, d);
1482 }
1483 else if (gdbpy_is_string (obj))
1484 {
1485 char *s;
1486
1487 s = python_string_to_target_string (obj);
1488 if (s != NULL)
1489 {
9bc3523d
TT
1490 struct cleanup *old;
1491
08c637de 1492 old = make_cleanup (xfree, s);
3b7538c0 1493 value = value_cstring (s, strlen (s), builtin_type_pychar);
08c637de
TJB
1494 do_cleanups (old);
1495 }
1496 }
1497 else if (PyObject_TypeCheck (obj, &value_object_type))
cc924cad 1498 value = value_copy (((value_object *) obj)->value);
be759fcf
PM
1499 else if (gdbpy_is_lazy_string (obj))
1500 {
1501 PyObject *result;
d59b6f6c 1502
fb6a3ed3 1503 result = PyObject_CallMethodObjArgs (obj, gdbpy_value_cst, NULL);
be759fcf
PM
1504 value = value_copy (((value_object *) result)->value);
1505 }
08c637de 1506 else
9a27f2c6
PK
1507#ifdef IS_PY3K
1508 PyErr_Format (PyExc_TypeError,
1509 _("Could not convert Python object: %S."), obj);
1510#else
9a2b4c1b
MS
1511 PyErr_Format (PyExc_TypeError,
1512 _("Could not convert Python object: %s."),
08c637de 1513 PyString_AsString (PyObject_Str (obj)));
9a27f2c6 1514#endif
08c637de
TJB
1515 }
1516 if (except.reason < 0)
1517 {
1518 PyErr_Format (except.reason == RETURN_QUIT
1519 ? PyExc_KeyboardInterrupt : PyExc_RuntimeError,
1520 "%s", except.message);
1521 return NULL;
1522 }
7843261b
TJB
1523
1524 return value;
1525}
1526
1527/* Returns value object in the ARGth position in GDB's history. */
1528PyObject *
08c637de 1529gdbpy_history (PyObject *self, PyObject *args)
7843261b
TJB
1530{
1531 int i;
1532 struct value *res_val = NULL; /* Initialize to appease gcc warning. */
1533 volatile struct gdb_exception except;
1534
1535 if (!PyArg_ParseTuple (args, "i", &i))
1536 return NULL;
1537
1538 TRY_CATCH (except, RETURN_MASK_ALL)
1539 {
1540 res_val = access_value_history (i);
1541 }
1542 GDB_PY_HANDLE_EXCEPTION (except);
1543
1544 return value_to_value_object (res_val);
1545}
1546
595939de
PM
1547/* Returns 1 in OBJ is a gdb.Value object, 0 otherwise. */
1548
1549int
1550gdbpy_is_value_object (PyObject *obj)
1551{
1552 return PyObject_TypeCheck (obj, &value_object_type);
1553}
1554
999633ed 1555int
7843261b
TJB
1556gdbpy_initialize_values (void)
1557{
7843261b 1558 if (PyType_Ready (&value_object_type) < 0)
999633ed 1559 return -1;
7843261b 1560
aa36459a
TT
1561 return gdb_pymodule_addobject (gdb_module, "Value",
1562 (PyObject *) &value_object_type);
7843261b
TJB
1563}
1564
2c74e833
TT
1565\f
1566
def2b000 1567static PyGetSetDef value_object_getset[] = {
c0c6f777
TJB
1568 { "address", valpy_get_address, NULL, "The address of the value.",
1569 NULL },
def2b000 1570 { "is_optimized_out", valpy_get_is_optimized_out, NULL,
9a2b4c1b
MS
1571 "Boolean telling whether the value is optimized "
1572 "out (i.e., not available).",
def2b000 1573 NULL },
2c74e833 1574 { "type", valpy_get_type, NULL, "Type of the value.", NULL },
03f17ccf
TT
1575 { "dynamic_type", valpy_get_dynamic_type, NULL,
1576 "Dynamic type of the value.", NULL },
913460fc
PK
1577 { "is_lazy", valpy_get_is_lazy, NULL,
1578 "Boolean telling whether the value is lazy (not fetched yet\n\
1579from the inferior). A lazy value is fetched when needed, or when\n\
1580the \"fetch_lazy()\" method is called.", NULL },
def2b000
TJB
1581 {NULL} /* Sentinel */
1582};
1583
f9176c46 1584static PyMethodDef value_object_methods[] = {
2c74e833 1585 { "cast", valpy_cast, METH_VARARGS, "Cast the value to the supplied type." },
f9ffd4bb
TT
1586 { "dynamic_cast", valpy_dynamic_cast, METH_VARARGS,
1587 "dynamic_cast (gdb.Type) -> gdb.Value\n\
1588Cast the value to the supplied type, as if by the C++ dynamic_cast operator."
1589 },
1590 { "reinterpret_cast", valpy_reinterpret_cast, METH_VARARGS,
1591 "reinterpret_cast (gdb.Type) -> gdb.Value\n\
1592Cast the value to the supplied type, as if by the C++\n\
1593reinterpret_cast operator."
1594 },
f9176c46 1595 { "dereference", valpy_dereference, METH_NOARGS, "Dereferences the value." },
7b282c5a
SCR
1596 { "referenced_value", valpy_referenced_value, METH_NOARGS,
1597 "Return the value referenced by a TYPE_CODE_REF or TYPE_CODE_PTR value." },
9a2b4c1b
MS
1598 { "lazy_string", (PyCFunction) valpy_lazy_string,
1599 METH_VARARGS | METH_KEYWORDS,
be759fcf
PM
1600 "lazy_string ([encoding] [, length]) -> lazy_string\n\
1601Return a lazy string representation of the value." },
cc924cad 1602 { "string", (PyCFunction) valpy_string, METH_VARARGS | METH_KEYWORDS,
fbb8f299 1603 "string ([encoding] [, errors] [, length]) -> string\n\
cc924cad 1604Return Unicode string representation of the value." },
256458bc 1605 { "fetch_lazy", valpy_fetch_lazy, METH_NOARGS,
913460fc 1606 "Fetches the value from the inferior, if it was lazy." },
f9176c46
PA
1607 {NULL} /* Sentinel */
1608};
1609
1610static PyNumberMethods value_object_as_number = {
1611 valpy_add,
1612 valpy_subtract,
1613 valpy_multiply,
9a27f2c6 1614#ifndef IS_PY3K
f9176c46 1615 valpy_divide,
9a27f2c6 1616#endif
f9176c46
PA
1617 valpy_remainder,
1618 NULL, /* nb_divmod */
1619 valpy_power, /* nb_power */
1620 valpy_negative, /* nb_negative */
1621 valpy_positive, /* nb_positive */
1622 valpy_absolute, /* nb_absolute */
08c637de
TJB
1623 valpy_nonzero, /* nb_nonzero */
1624 valpy_invert, /* nb_invert */
1625 valpy_lsh, /* nb_lshift */
1626 valpy_rsh, /* nb_rshift */
1627 valpy_and, /* nb_and */
1628 valpy_xor, /* nb_xor */
1629 valpy_or, /* nb_or */
9a27f2c6
PK
1630#ifdef IS_PY3K
1631 valpy_long, /* nb_int */
1632 NULL, /* reserved */
1633#else
08c637de
TJB
1634 NULL, /* nb_coerce */
1635 valpy_int, /* nb_int */
1636 valpy_long, /* nb_long */
9a27f2c6 1637#endif
08c637de 1638 valpy_float, /* nb_float */
9a27f2c6 1639#ifndef IS_PY3K
08c637de 1640 NULL, /* nb_oct */
9a27f2c6
PK
1641 NULL, /* nb_hex */
1642#endif
1643 NULL, /* nb_inplace_add */
1644 NULL, /* nb_inplace_subtract */
1645 NULL, /* nb_inplace_multiply */
1646 NULL, /* nb_inplace_remainder */
1647 NULL, /* nb_inplace_power */
1648 NULL, /* nb_inplace_lshift */
1649 NULL, /* nb_inplace_rshift */
1650 NULL, /* nb_inplace_and */
1651 NULL, /* nb_inplace_xor */
1652 NULL, /* nb_inplace_or */
1653 NULL, /* nb_floor_divide */
1654 valpy_divide /* nb_true_divide */
f9176c46
PA
1655};
1656
1657static PyMappingMethods value_object_as_mapping = {
1658 valpy_length,
1659 valpy_getitem,
1660 valpy_setitem
1661};
1662
1663PyTypeObject value_object_type = {
9a27f2c6 1664 PyVarObject_HEAD_INIT (NULL, 0)
f9176c46
PA
1665 "gdb.Value", /*tp_name*/
1666 sizeof (value_object), /*tp_basicsize*/
1667 0, /*tp_itemsize*/
1668 valpy_dealloc, /*tp_dealloc*/
1669 0, /*tp_print*/
1670 0, /*tp_getattr*/
1671 0, /*tp_setattr*/
1672 0, /*tp_compare*/
1673 0, /*tp_repr*/
1674 &value_object_as_number, /*tp_as_number*/
1675 0, /*tp_as_sequence*/
1676 &value_object_as_mapping, /*tp_as_mapping*/
88d4aea7 1677 valpy_hash, /*tp_hash*/
5374244e 1678 valpy_call, /*tp_call*/
f9176c46
PA
1679 valpy_str, /*tp_str*/
1680 0, /*tp_getattro*/
1681 0, /*tp_setattro*/
1682 0, /*tp_as_buffer*/
9a2b4c1b
MS
1683 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES
1684 | Py_TPFLAGS_BASETYPE, /*tp_flags*/
f9176c46
PA
1685 "GDB value object", /* tp_doc */
1686 0, /* tp_traverse */
1687 0, /* tp_clear */
1688 valpy_richcompare, /* tp_richcompare */
1689 0, /* tp_weaklistoffset */
1690 0, /* tp_iter */
1691 0, /* tp_iternext */
08c637de
TJB
1692 value_object_methods, /* tp_methods */
1693 0, /* tp_members */
def2b000 1694 value_object_getset, /* tp_getset */
08c637de
TJB
1695 0, /* tp_base */
1696 0, /* tp_dict */
1697 0, /* tp_descr_get */
1698 0, /* tp_descr_set */
1699 0, /* tp_dictoffset */
1700 0, /* tp_init */
1701 0, /* tp_alloc */
1702 valpy_new /* tp_new */
f9176c46 1703};
This page took 0.852617 seconds and 4 git commands to generate.