/* Python interface to lazy strings.
|
/* Python interface to lazy strings.
|
|
|
Copyright (C) 2010 Free Software Foundation, Inc.
|
Copyright (C) 2010 Free Software Foundation, Inc.
|
|
|
This file is part of GDB.
|
This file is part of GDB.
|
|
|
This program is free software; you can redistribute it and/or modify
|
This program is free software; you can redistribute it and/or modify
|
it under the terms of the GNU General Public License as published by
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation; either version 3 of the License, or
|
the Free Software Foundation; either version 3 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
#include "defs.h"
|
#include "defs.h"
|
#include "python-internal.h"
|
#include "python-internal.h"
|
#include "charset.h"
|
#include "charset.h"
|
#include "value.h"
|
#include "value.h"
|
#include "exceptions.h"
|
#include "exceptions.h"
|
#include "valprint.h"
|
#include "valprint.h"
|
#include "language.h"
|
#include "language.h"
|
|
|
typedef struct {
|
typedef struct {
|
PyObject_HEAD
|
PyObject_HEAD
|
/* Holds the address of the lazy string. */
|
/* Holds the address of the lazy string. */
|
CORE_ADDR address;
|
CORE_ADDR address;
|
|
|
/* Holds the encoding that will be applied to the string
|
/* Holds the encoding that will be applied to the string
|
when the string is printed by GDB. If the encoding is set
|
when the string is printed by GDB. If the encoding is set
|
to None then GDB will select the most appropriate
|
to None then GDB will select the most appropriate
|
encoding when the sting is printed. */
|
encoding when the sting is printed. */
|
char *encoding;
|
char *encoding;
|
|
|
/* Holds the length of the string in characters. If the
|
/* Holds the length of the string in characters. If the
|
length is -1, then the string will be fetched and encoded up to
|
length is -1, then the string will be fetched and encoded up to
|
the first null of appropriate width. */
|
the first null of appropriate width. */
|
long length;
|
long length;
|
|
|
/* This attribute holds the type that is represented by the lazy
|
/* This attribute holds the type that is represented by the lazy
|
string's type. */
|
string's type. */
|
struct type *type;
|
struct type *type;
|
} lazy_string_object;
|
} lazy_string_object;
|
|
|
static PyTypeObject lazy_string_object_type;
|
static PyTypeObject lazy_string_object_type;
|
|
|
static PyObject *
|
static PyObject *
|
stpy_get_address (PyObject *self, void *closure)
|
stpy_get_address (PyObject *self, void *closure)
|
{
|
{
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
return PyLong_FromUnsignedLongLong (self_string->address);
|
return PyLong_FromUnsignedLongLong (self_string->address);
|
}
|
}
|
|
|
static PyObject *
|
static PyObject *
|
stpy_get_encoding (PyObject *self, void *closure)
|
stpy_get_encoding (PyObject *self, void *closure)
|
{
|
{
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
PyObject *result;
|
PyObject *result;
|
|
|
/* An encoding can be set to NULL by the user, so check before
|
/* An encoding can be set to NULL by the user, so check before
|
attempting a Python FromString call. If NULL return Py_None. */
|
attempting a Python FromString call. If NULL return Py_None. */
|
if (self_string->encoding)
|
if (self_string->encoding)
|
result = PyString_FromString (self_string->encoding);
|
result = PyString_FromString (self_string->encoding);
|
else
|
else
|
{
|
{
|
result = Py_None;
|
result = Py_None;
|
Py_INCREF (result);
|
Py_INCREF (result);
|
}
|
}
|
|
|
return result;
|
return result;
|
}
|
}
|
|
|
static PyObject *
|
static PyObject *
|
stpy_get_length (PyObject *self, void *closure)
|
stpy_get_length (PyObject *self, void *closure)
|
{
|
{
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
return PyLong_FromLong (self_string->length);
|
return PyLong_FromLong (self_string->length);
|
}
|
}
|
|
|
PyObject *
|
PyObject *
|
stpy_get_type (PyObject *self, void *closure)
|
stpy_get_type (PyObject *self, void *closure)
|
{
|
{
|
lazy_string_object *str_obj = (lazy_string_object *) self;
|
lazy_string_object *str_obj = (lazy_string_object *) self;
|
return type_to_type_object (str_obj->type);
|
return type_to_type_object (str_obj->type);
|
}
|
}
|
|
|
static PyObject *
|
static PyObject *
|
stpy_convert_to_value (PyObject *self, PyObject *args)
|
stpy_convert_to_value (PyObject *self, PyObject *args)
|
{
|
{
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
struct value *val;
|
struct value *val;
|
|
|
val = value_at_lazy (self_string->type, self_string->address);
|
val = value_at_lazy (self_string->type, self_string->address);
|
return value_to_value_object (val);
|
return value_to_value_object (val);
|
}
|
}
|
|
|
static void
|
static void
|
stpy_dealloc (PyObject *self)
|
stpy_dealloc (PyObject *self)
|
{
|
{
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
lazy_string_object *self_string = (lazy_string_object *) self;
|
xfree (self_string->encoding);
|
xfree (self_string->encoding);
|
}
|
}
|
|
|
PyObject *
|
PyObject *
|
gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
|
gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
|
const char *encoding, struct type *type)
|
const char *encoding, struct type *type)
|
{
|
{
|
lazy_string_object *str_obj = NULL;
|
lazy_string_object *str_obj = NULL;
|
|
|
if (address == 0)
|
if (address == 0)
|
{
|
{
|
PyErr_SetString (PyExc_MemoryError,
|
PyErr_SetString (PyExc_MemoryError,
|
"Cannot create a lazy string from a GDB-side string.");
|
"Cannot create a lazy string from a GDB-side string.");
|
return NULL;
|
return NULL;
|
}
|
}
|
|
|
if (!type)
|
if (!type)
|
{
|
{
|
PyErr_SetString (PyExc_RuntimeError,
|
PyErr_SetString (PyExc_RuntimeError,
|
"A lazy string's type cannot be NULL.");
|
"A lazy string's type cannot be NULL.");
|
return NULL;
|
return NULL;
|
}
|
}
|
|
|
str_obj = PyObject_New (lazy_string_object, &lazy_string_object_type);
|
str_obj = PyObject_New (lazy_string_object, &lazy_string_object_type);
|
if (!str_obj)
|
if (!str_obj)
|
return NULL;
|
return NULL;
|
|
|
str_obj->address = address;
|
str_obj->address = address;
|
str_obj->length = length;
|
str_obj->length = length;
|
if (encoding == NULL || !strcmp (encoding, ""))
|
if (encoding == NULL || !strcmp (encoding, ""))
|
str_obj->encoding = NULL;
|
str_obj->encoding = NULL;
|
else
|
else
|
str_obj->encoding = xstrdup (encoding);
|
str_obj->encoding = xstrdup (encoding);
|
str_obj->type = type;
|
str_obj->type = type;
|
|
|
return (PyObject *) str_obj;
|
return (PyObject *) str_obj;
|
}
|
}
|
|
|
void
|
void
|
gdbpy_initialize_lazy_string (void)
|
gdbpy_initialize_lazy_string (void)
|
{
|
{
|
if (PyType_Ready (&lazy_string_object_type) < 0)
|
if (PyType_Ready (&lazy_string_object_type) < 0)
|
return;
|
return;
|
|
|
Py_INCREF (&lazy_string_object_type);
|
Py_INCREF (&lazy_string_object_type);
|
}
|
}
|
|
|
/* Determine whether the printer object pointed to by OBJ is a
|
/* Determine whether the printer object pointed to by OBJ is a
|
Python lazy string. */
|
Python lazy string. */
|
int
|
int
|
gdbpy_is_lazy_string (PyObject *result)
|
gdbpy_is_lazy_string (PyObject *result)
|
{
|
{
|
return PyObject_TypeCheck (result, &lazy_string_object_type);
|
return PyObject_TypeCheck (result, &lazy_string_object_type);
|
}
|
}
|
|
|
/* Extract and return the actual string from the lazy string object
|
/* Extract and return the actual string from the lazy string object
|
STRING. Addtionally, the string type is written to *STR_TYPE, the
|
STRING. Addtionally, the string type is written to *STR_TYPE, the
|
string length is written to *LENGTH, and the string encoding is
|
string length is written to *LENGTH, and the string encoding is
|
written to *ENCODING. On error, NULL is returned. The caller is
|
written to *ENCODING. On error, NULL is returned. The caller is
|
responsible for freeing the returned buffer. */
|
responsible for freeing the returned buffer. */
|
gdb_byte *
|
gdb_byte *
|
gdbpy_extract_lazy_string (PyObject *string, struct type **str_type,
|
gdbpy_extract_lazy_string (PyObject *string, struct type **str_type,
|
long *length, char **encoding)
|
long *length, char **encoding)
|
{
|
{
|
int width;
|
int width;
|
int bytes_read;
|
int bytes_read;
|
gdb_byte *buffer = NULL;
|
gdb_byte *buffer = NULL;
|
int errcode = 0;
|
int errcode = 0;
|
CORE_ADDR addr;
|
CORE_ADDR addr;
|
struct gdbarch *gdbarch;
|
struct gdbarch *gdbarch;
|
enum bfd_endian byte_order;
|
enum bfd_endian byte_order;
|
PyObject *py_len = NULL, *py_encoding = NULL;
|
PyObject *py_len = NULL, *py_encoding = NULL;
|
PyObject *py_addr = NULL, *py_type = NULL;
|
PyObject *py_addr = NULL, *py_type = NULL;
|
volatile struct gdb_exception except;
|
volatile struct gdb_exception except;
|
|
|
py_len = PyObject_GetAttrString (string, "length");
|
py_len = PyObject_GetAttrString (string, "length");
|
py_encoding = PyObject_GetAttrString (string, "encoding");
|
py_encoding = PyObject_GetAttrString (string, "encoding");
|
py_addr = PyObject_GetAttrString (string, "address");
|
py_addr = PyObject_GetAttrString (string, "address");
|
py_type = PyObject_GetAttrString (string, "type");
|
py_type = PyObject_GetAttrString (string, "type");
|
|
|
/* A NULL encoding, length, address or type is not ok. */
|
/* A NULL encoding, length, address or type is not ok. */
|
if (!py_len || !py_encoding || !py_addr || !py_type)
|
if (!py_len || !py_encoding || !py_addr || !py_type)
|
goto error;
|
goto error;
|
|
|
*length = PyLong_AsLong (py_len);
|
*length = PyLong_AsLong (py_len);
|
addr = PyLong_AsUnsignedLongLong (py_addr);
|
addr = PyLong_AsUnsignedLongLong (py_addr);
|
|
|
/* If the user supplies Py_None an encoding, set encoding to NULL.
|
/* If the user supplies Py_None an encoding, set encoding to NULL.
|
This will trigger the resulting LA_PRINT_CALL to automatically
|
This will trigger the resulting LA_PRINT_CALL to automatically
|
select an encoding. */
|
select an encoding. */
|
if (py_encoding == Py_None)
|
if (py_encoding == Py_None)
|
*encoding = NULL;
|
*encoding = NULL;
|
else
|
else
|
*encoding = xstrdup (PyString_AsString (py_encoding));
|
*encoding = xstrdup (PyString_AsString (py_encoding));
|
|
|
*str_type = type_object_to_type (py_type);
|
*str_type = type_object_to_type (py_type);
|
gdbarch = get_type_arch (*str_type);
|
gdbarch = get_type_arch (*str_type);
|
byte_order = gdbarch_byte_order (gdbarch);
|
byte_order = gdbarch_byte_order (gdbarch);
|
width = TYPE_LENGTH (*str_type);
|
width = TYPE_LENGTH (*str_type);
|
|
|
TRY_CATCH (except, RETURN_MASK_ALL)
|
TRY_CATCH (except, RETURN_MASK_ALL)
|
{
|
{
|
errcode = read_string (addr, *length, width,
|
errcode = read_string (addr, *length, width,
|
*length, byte_order, &buffer,
|
*length, byte_order, &buffer,
|
&bytes_read);
|
&bytes_read);
|
}
|
}
|
if (except.reason < 0)
|
if (except.reason < 0)
|
{
|
{
|
PyErr_Format (except.reason == RETURN_QUIT \
|
PyErr_Format (except.reason == RETURN_QUIT \
|
? PyExc_KeyboardInterrupt : PyExc_RuntimeError, \
|
? PyExc_KeyboardInterrupt : PyExc_RuntimeError, \
|
"%s", except.message); \
|
"%s", except.message); \
|
goto error;
|
goto error;
|
|
|
}
|
}
|
|
|
if (errcode)
|
if (errcode)
|
goto error;
|
goto error;
|
|
|
*length = bytes_read / width;
|
*length = bytes_read / width;
|
|
|
Py_DECREF (py_encoding);
|
Py_DECREF (py_encoding);
|
Py_DECREF (py_len);
|
Py_DECREF (py_len);
|
Py_DECREF (py_addr);
|
Py_DECREF (py_addr);
|
Py_DECREF (py_type);
|
Py_DECREF (py_type);
|
return buffer;
|
return buffer;
|
|
|
error:
|
error:
|
Py_XDECREF (py_encoding);
|
Py_XDECREF (py_encoding);
|
Py_XDECREF (py_len);
|
Py_XDECREF (py_len);
|
Py_XDECREF (py_addr);
|
Py_XDECREF (py_addr);
|
Py_XDECREF (py_type);
|
Py_XDECREF (py_type);
|
xfree (buffer);
|
xfree (buffer);
|
*length = 0;
|
*length = 0;
|
*str_type = NULL;
|
*str_type = NULL;
|
return NULL;
|
return NULL;
|
}
|
}
|
|
|
|
|
|
|
static PyMethodDef lazy_string_object_methods[] = {
|
static PyMethodDef lazy_string_object_methods[] = {
|
{ "value", stpy_convert_to_value, METH_NOARGS,
|
{ "value", stpy_convert_to_value, METH_NOARGS,
|
"Create a (lazy) value that contains a pointer to the string." },
|
"Create a (lazy) value that contains a pointer to the string." },
|
{NULL} /* Sentinel */
|
{NULL} /* Sentinel */
|
};
|
};
|
|
|
|
|
static PyGetSetDef lazy_string_object_getset[] = {
|
static PyGetSetDef lazy_string_object_getset[] = {
|
{ "address", stpy_get_address, NULL, "Address of the string.", NULL },
|
{ "address", stpy_get_address, NULL, "Address of the string.", NULL },
|
{ "encoding", stpy_get_encoding, NULL, "Encoding of the string.", NULL },
|
{ "encoding", stpy_get_encoding, NULL, "Encoding of the string.", NULL },
|
{ "length", stpy_get_length, NULL, "Length of the string.", NULL },
|
{ "length", stpy_get_length, NULL, "Length of the string.", NULL },
|
{ "type", stpy_get_type, NULL, "Type associated with the string.", NULL },
|
{ "type", stpy_get_type, NULL, "Type associated with the string.", NULL },
|
{ NULL } /* Sentinel */
|
{ NULL } /* Sentinel */
|
};
|
};
|
|
|
static PyTypeObject lazy_string_object_type = {
|
static PyTypeObject lazy_string_object_type = {
|
PyObject_HEAD_INIT (NULL)
|
PyObject_HEAD_INIT (NULL)
|
0, /*ob_size*/
|
0, /*ob_size*/
|
"gdb.LazyString", /*tp_name*/
|
"gdb.LazyString", /*tp_name*/
|
sizeof (lazy_string_object), /*tp_basicsize*/
|
sizeof (lazy_string_object), /*tp_basicsize*/
|
0, /*tp_itemsize*/
|
0, /*tp_itemsize*/
|
stpy_dealloc, /*tp_dealloc*/
|
stpy_dealloc, /*tp_dealloc*/
|
0, /*tp_print*/
|
0, /*tp_print*/
|
0, /*tp_getattr*/
|
0, /*tp_getattr*/
|
0, /*tp_setattr*/
|
0, /*tp_setattr*/
|
0, /*tp_compare*/
|
0, /*tp_compare*/
|
0, /*tp_repr*/
|
0, /*tp_repr*/
|
0, /*tp_as_number*/
|
0, /*tp_as_number*/
|
0, /*tp_as_sequence*/
|
0, /*tp_as_sequence*/
|
0, /*tp_as_mapping*/
|
0, /*tp_as_mapping*/
|
0, /*tp_hash */
|
0, /*tp_hash */
|
0, /*tp_call*/
|
0, /*tp_call*/
|
0, /*tp_str*/
|
0, /*tp_str*/
|
0, /*tp_getattro*/
|
0, /*tp_getattro*/
|
0, /*tp_setattro*/
|
0, /*tp_setattro*/
|
0, /*tp_as_buffer*/
|
0, /*tp_as_buffer*/
|
Py_TPFLAGS_DEFAULT, /*tp_flags*/
|
Py_TPFLAGS_DEFAULT, /*tp_flags*/
|
"GDB lazy string object", /* tp_doc */
|
"GDB lazy string object", /* tp_doc */
|
0, /* tp_traverse */
|
0, /* tp_traverse */
|
0, /* tp_clear */
|
0, /* tp_clear */
|
0, /* tp_richcompare */
|
0, /* tp_richcompare */
|
0, /* tp_weaklistoffset */
|
0, /* tp_weaklistoffset */
|
0, /* tp_iter */
|
0, /* tp_iter */
|
0, /* tp_iternext */
|
0, /* tp_iternext */
|
lazy_string_object_methods, /* tp_methods */
|
lazy_string_object_methods, /* tp_methods */
|
0, /* tp_members */
|
0, /* tp_members */
|
lazy_string_object_getset /* tp_getset */
|
lazy_string_object_getset /* tp_getset */
|
};
|
};
|
|
|
