gdb/python/py-lazy-string.c

   1 /* Python interface to lazy strings.
   2
   3    Copyright (C) 2010-2017 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 #include "defs.h"
  21 #include "python-internal.h"
  22 #include "charset.h"
  23 #include "value.h"
  24 #include "valprint.h"
  25 #include "language.h"
  26
  27 typedef struct {
  28   PyObject_HEAD
  29   /*  Holds the address of the lazy string.  */
  30   CORE_ADDR address;
  31
  32   /*  Holds the encoding that will be applied to the string
  33       when the string is printed by GDB.  If the encoding is set
  34       to None then GDB will select the most appropriate
  35       encoding when the sting is printed.  */
  36   char *encoding;
  37
  38   /* Holds the length of the string in characters.  If the
  39      length is -1, then the string will be fetched and encoded up to
  40      the first null of appropriate width.  */
  41   long length;
  42
  43   /*  This attribute holds the type that is represented by the lazy
  44       string's type.  */
  45   struct type *type;
  46 } lazy_string_object;
  47
  48 extern PyTypeObject lazy_string_object_type
  49     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("lazy_string_object");
  50
  51 static PyObject *
  52 stpy_get_address (PyObject *self, void *closure)
  53 {
  54   lazy_string_object *self_string = (lazy_string_object *) self;
  55
  56   return gdb_py_long_from_ulongest (self_string->address);
  57 }
  58
  59 static PyObject *
  60 stpy_get_encoding (PyObject *self, void *closure)
  61 {
  62   lazy_string_object *self_string = (lazy_string_object *) self;
  63   PyObject *result;
  64
  65   /* An encoding can be set to NULL by the user, so check before
  66      attempting a Python FromString call.  If NULL return Py_None.  */
  67   if (self_string->encoding)
  68     result = PyString_FromString (self_string->encoding);
  69   else
  70     {
  71       result = Py_None;
  72       Py_INCREF (result);
  73     }
  74
  75   return result;
  76 }
  77
  78 static PyObject *
  79 stpy_get_length (PyObject *self, void *closure)
  80 {
  81   lazy_string_object *self_string = (lazy_string_object *) self;
  82
  83   return PyLong_FromLong (self_string->length);
  84 }
  85
  86 static PyObject *
  87 stpy_get_type (PyObject *self, void *closure)
  88 {
  89   lazy_string_object *str_obj = (lazy_string_object *) self;
  90
  91   return type_to_type_object (str_obj->type);
  92 }
  93
  94 static PyObject *
  95 stpy_convert_to_value  (PyObject *self, PyObject *args)
  96 {
  97   lazy_string_object *self_string = (lazy_string_object *) self;
  98   struct value *val = NULL;
  99
 100   if (self_string->address == 0)
 101     {
 102       PyErr_SetString (gdbpy_gdb_memory_error,
 103                        _("Cannot create a value from NULL."));
 104       return NULL;
 105     }
 106
 107   TRY
 108     {
 109       val = value_at_lazy (self_string->type, self_string->address);
 110     }
 111   CATCH (except, RETURN_MASK_ALL)
 112     {
 113       GDB_PY_HANDLE_EXCEPTION (except);
 114     }
 115   END_CATCH
 116
 117   return value_to_value_object (val);
 118 }
 119
 120 static void
 121 stpy_dealloc (PyObject *self)
 122 {
 123   lazy_string_object *self_string = (lazy_string_object *) self;
 124
 125   xfree (self_string->encoding);
 126 }
 127
 128 PyObject *
 129 gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
 130                            const char *encoding, struct type *type)
 131 {
 132   lazy_string_object *str_obj = NULL;
 133
 134   if (address == 0 && length != 0)
 135     {
 136       PyErr_SetString (gdbpy_gdb_memory_error,
 137                        _("Cannot create a lazy string with address 0x0, " \
 138                          "and a non-zero length."));
 139       return NULL;
 140     }
 141
 142   if (!type)
 143     {
 144       PyErr_SetString (PyExc_RuntimeError,
 145                        _("A lazy string's type cannot be NULL."));
 146       return NULL;
 147     }
 148
 149   str_obj = PyObject_New (lazy_string_object, &lazy_string_object_type);
 150   if (!str_obj)
 151     return NULL;
 152
 153   str_obj->address = address;
 154   str_obj->length = length;
 155   if (encoding == NULL || !strcmp (encoding, ""))
 156     str_obj->encoding = NULL;
 157   else
 158     str_obj->encoding = xstrdup (encoding);
 159   str_obj->type = type;
 160
 161   return (PyObject *) str_obj;
 162 }
 163
 164 int
 165 gdbpy_initialize_lazy_string (void)
 166 {
 167   if (PyType_Ready (&lazy_string_object_type) < 0)
 168     return -1;
 169
 170   Py_INCREF (&lazy_string_object_type);
 171   return 0;
 172 }
 173
 174 /* Determine whether the printer object pointed to by OBJ is a
 175    Python lazy string.  */
 176 int
 177 gdbpy_is_lazy_string (PyObject *result)
 178 {
 179   return PyObject_TypeCheck (result, &lazy_string_object_type);
 180 }
 181
 182 /* Extract the parameters from the lazy string object STRING.
 183    ENCODING may be set to NULL, if no encoding is found.  */
 184
 185 void
 186 gdbpy_extract_lazy_string (PyObject *string, CORE_ADDR *addr,
 187                            struct type **str_type,
 188                            long *length,
 189                            gdb::unique_xmalloc_ptr<char> *encoding)
 190 {
 191   lazy_string_object *lazy;
 192
 193   gdb_assert (gdbpy_is_lazy_string (string));
 194
 195   lazy = (lazy_string_object *) string;
 196
 197   *addr = lazy->address;
 198   *str_type = lazy->type;
 199   *length = lazy->length;
 200   encoding->reset (lazy->encoding ? xstrdup (lazy->encoding) : NULL);
 201 }
 202
 203 \f
 204
 205 static PyMethodDef lazy_string_object_methods[] = {
 206   { "value", stpy_convert_to_value, METH_NOARGS,
 207     "Create a (lazy) value that contains a pointer to the string." },
 208   {NULL}  /* Sentinel */
 209 };
 210
 211
 212 static PyGetSetDef lazy_string_object_getset[] = {
 213   { "address", stpy_get_address, NULL, "Address of the string.", NULL },
 214   { "encoding", stpy_get_encoding, NULL, "Encoding of the string.", NULL },
 215   { "length", stpy_get_length, NULL, "Length of the string.", NULL },
 216   { "type", stpy_get_type, NULL, "Type associated with the string.", NULL },
 217   { NULL }  /* Sentinel */
 218 };
 219
 220 PyTypeObject lazy_string_object_type = {
 221   PyVarObject_HEAD_INIT (NULL, 0)
 222   "gdb.LazyString",               /*tp_name*/
 223   sizeof (lazy_string_object),    /*tp_basicsize*/
 224   0,                              /*tp_itemsize*/
 225   stpy_dealloc,                   /*tp_dealloc*/
 226   0,                              /*tp_print*/
 227   0,                              /*tp_getattr*/
 228   0,                              /*tp_setattr*/
 229   0,                              /*tp_compare*/
 230   0,                              /*tp_repr*/
 231   0,                              /*tp_as_number*/
 232   0,                              /*tp_as_sequence*/
 233   0,                              /*tp_as_mapping*/
 234   0,                              /*tp_hash */
 235   0,                              /*tp_call*/
 236   0,                              /*tp_str*/
 237   0,                              /*tp_getattro*/
 238   0,                              /*tp_setattro*/
 239   0,                              /*tp_as_buffer*/
 240   Py_TPFLAGS_DEFAULT,             /*tp_flags*/
 241   "GDB lazy string object",       /* tp_doc */
 242   0,                              /* tp_traverse */
 243   0,                              /* tp_clear */
 244   0,                              /* tp_richcompare */
 245   0,                              /* tp_weaklistoffset */
 246   0,                              /* tp_iter */
 247   0,                              /* tp_iternext */
 248   lazy_string_object_methods,     /* tp_methods */
 249   0,                              /* tp_members */
 250   lazy_string_object_getset       /* tp_getset */
 251 };