gdb-8.0.1/gdb/osdata.c - toolchain/gdb - Git at Google

 /* Routines for handling XML generic OS data provided by target.

    Copyright (C) 2008-2017 Free Software Foundation, Inc.

    This file is part of GDB.

    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
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

 #include "defs.h"
 #include "target.h"
 #include "vec.h"
 #include "xml-support.h"
 #include "osdata.h"
 #include "ui-out.h"
 #include "gdbcmd.h"

 #if !defined(HAVE_LIBEXPAT)

 struct osdata *
 osdata_parse (const char *xml)
 {
   static int have_warned;

   if (!have_warned)
     {
       have_warned = 1;
       warning (_("Can not parse XML OS data; XML support was disabled "
                 "at compile time"));
     }

   return NULL;
 }

 #else /* HAVE_LIBEXPAT */

 /* Internal parsing data passed to all XML callbacks.  */
 struct osdata_parsing_data
   {
     struct osdata *osdata;
     char *property_name;
   };

 /* Handle the start of a <osdata> element.  */

 static void
 osdata_start_osdata (struct gdb_xml_parser *parser,
                         const struct gdb_xml_element *element,
                         void *user_data, VEC(gdb_xml_value_s) *attributes)
 {
   struct osdata_parsing_data *data = (struct osdata_parsing_data *) user_data;
   char *type;
   struct osdata *osdata;

   if (data->osdata)
     gdb_xml_error (parser, _("Seen more than on osdata element"));

   type = (char *) xml_find_attribute (attributes, "type")->value;
   osdata = XCNEW (struct osdata);
   osdata->type = xstrdup (type);
   data->osdata = osdata;
 }

 /* Handle the start of a <item> element.  */

 static void
 osdata_start_item (struct gdb_xml_parser *parser,
                   const struct gdb_xml_element *element,
                   void *user_data, VEC(gdb_xml_value_s) *attributes)
 {
   struct osdata_parsing_data *data = (struct osdata_parsing_data *) user_data;
   struct osdata_item item = { NULL };

   VEC_safe_push (osdata_item_s, data->osdata->items, &item);
 }

 /* Handle the start of a <column> element.  */

 static void
 osdata_start_column (struct gdb_xml_parser *parser,
                     const struct gdb_xml_element *element,
                     void *user_data, VEC(gdb_xml_value_s) *attributes)
 {
   struct osdata_parsing_data *data = (struct osdata_parsing_data *) user_data;
   const char *name
     = (const char *) xml_find_attribute (attributes, "name")->value;

   data->property_name = xstrdup (name);
 }

 /* Handle the end of a <column> element.  */

 static void
 osdata_end_column (struct gdb_xml_parser *parser,
                   const struct gdb_xml_element *element,
                   void *user_data, const char *body_text)
 {
   struct osdata_parsing_data *data = (struct osdata_parsing_data *) user_data;
   struct osdata *osdata = data->osdata;
   struct osdata_item *item = VEC_last (osdata_item_s, osdata->items);
   struct osdata_column *col = VEC_safe_push (osdata_column_s,
                                             item->columns, NULL);

   /* Transfer memory ownership.  NAME was already strdup'ed.  */
   col->name = data->property_name;
   col->value = xstrdup (body_text);
   data->property_name = NULL;
 }

 /* Discard the constructed osdata (if an error occurs).  */

 static void
 clear_parsing_data (void *p)
 {
   struct osdata_parsing_data *data = (struct osdata_parsing_data *) p;

   osdata_free (data->osdata);
   data->osdata = NULL;
   xfree (data->property_name);
   data->property_name = NULL;
 }

 /* The allowed elements and attributes for OS data object.
    The root element is a <osdata>.  */

 const struct gdb_xml_attribute column_attributes[] = {
   { "name", GDB_XML_AF_NONE, NULL, NULL },
   { NULL, GDB_XML_AF_NONE, NULL, NULL }
 };

 const struct gdb_xml_element item_children[] = {
   { "column", column_attributes, NULL,
     GDB_XML_EF_REPEATABLE | GDB_XML_EF_OPTIONAL,
     osdata_start_column, osdata_end_column },
   { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
 };

 const struct gdb_xml_attribute osdata_attributes[] = {
   { "type", GDB_XML_AF_NONE, NULL, NULL },
   { NULL, GDB_XML_AF_NONE, NULL, NULL }
 };

 const struct gdb_xml_element osdata_children[] = {
   { "item", NULL, item_children,
     GDB_XML_EF_REPEATABLE | GDB_XML_EF_OPTIONAL,
     osdata_start_item, NULL },
   { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
 };

 const struct gdb_xml_element osdata_elements[] = {
   { "osdata", osdata_attributes, osdata_children,
     GDB_XML_EF_NONE, osdata_start_osdata, NULL },
   { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
 };

 struct osdata *
 osdata_parse (const char *xml)
 {
   struct cleanup *back_to;
   struct osdata_parsing_data data = { NULL };

   back_to = make_cleanup (clear_parsing_data, &data);

   if (gdb_xml_parse_quick (_("osdata"), "osdata.dtd",
 			   osdata_elements, xml, &data) == 0)
     {
       /* Parsed successfully, don't need to delete the result.  */
       discard_cleanups (back_to);
       return data.osdata;
     }

   do_cleanups (back_to);
   return NULL;
 }
 #endif

 static void
 osdata_item_clear (struct osdata_item *item)
 {
   if (item->columns != NULL)
     {
       struct osdata_column *col;
       int ix;

       for (ix = 0;
 	   VEC_iterate (osdata_column_s, item->columns,
 			ix, col);
 	   ix++)
        {
 	 xfree (col->name);
 	 xfree (col->value);
        }
       VEC_free (osdata_column_s, item->columns);
       item->columns = NULL;
     }
 }

 void
 osdata_free (struct osdata *osdata)
 {
   if (osdata == NULL)
     return;

   if (osdata->items != NULL)
     {
       struct osdata_item *item;
       int ix;

       for (ix = 0;
           VEC_iterate (osdata_item_s, osdata->items,
                        ix, item);
           ix++)
        osdata_item_clear (item);
       VEC_free (osdata_item_s, osdata->items);
     }

   xfree (osdata);
 }

 static void
 osdata_free_cleanup (void *arg)
 {
   struct osdata *osdata = (struct osdata *) arg;

   osdata_free (osdata);
 }

 struct cleanup *
 make_cleanup_osdata_free (struct osdata *data)
 {
   return make_cleanup (osdata_free_cleanup, data);
 }

 struct osdata *
 get_osdata (const char *type)
 {
   struct osdata *osdata = NULL;
   char *xml = target_get_osdata (type);

   if (xml)
     {
       struct cleanup *old_chain = make_cleanup (xfree, xml);

       if (xml[0] == '\0')
 	{
 	  if (type)
 	    warning (_("Empty data returned by target.  Wrong osdata type?"));
 	  else
 	    warning (_("Empty type list returned by target.  No type data?"));
 	}
       else
 	osdata = osdata_parse (xml);

       do_cleanups (old_chain);
     }

   if (!osdata)
     error (_("Can not fetch data now."));

   return osdata;
 }

 const char *
 get_osdata_column (struct osdata_item *item, const char *name)
 {
   struct osdata_column *col;
   int ix_cols;

   for (ix_cols = 0;
        VEC_iterate (osdata_column_s, item->columns,
 		    ix_cols, col);
        ix_cols++)
     if (strcmp (col->name, name) == 0)
       return col->value;

   return NULL;
 }

 void
 info_osdata (const char *type)
 {
   struct ui_out *uiout = current_uiout;
   struct osdata *osdata = NULL;
   struct osdata_item *last = NULL;
   struct cleanup *old_chain;
   int ncols = 0;
   int nrows;
   int col_to_skip = -1;

   if (type == NULL)
     type = "";

   osdata = get_osdata (type);
   old_chain = make_cleanup_osdata_free (osdata);

   nrows = VEC_length (osdata_item_s, osdata->items);

   if (*type == '\0' && nrows == 0)
     error (_("Available types of OS data not reported."));

   if (!VEC_empty (osdata_item_s, osdata->items))
     {
       last = VEC_last (osdata_item_s, osdata->items);
       if (last->columns)
         ncols = VEC_length (osdata_column_s, last->columns);

       /* As a special case, scan the listing of available data types
 	 for a column named "Title", and only include it with MI
 	 output; this column's normal use is for titles for interface
 	 elements like menus, and it clutters up CLI output.  */
       if (*type == '\0' && !uiout->is_mi_like_p ())
 	{
 	  struct osdata_column *col;
 	  int ix;

 	  for (ix = 0;
 	       VEC_iterate (osdata_column_s, last->columns, ix, col);
 	       ix++)
 	    {
 	      if (strcmp (col->name, "Title") == 0)
 		col_to_skip = ix;
 	    }
 	  /* Be sure to reduce the total column count, otherwise
 	     internal errors ensue.  */
 	  if (col_to_skip >= 0)
 	    --ncols;
 	}
     }

   make_cleanup_ui_out_table_begin_end (uiout, ncols, nrows,
 				       "OSDataTable");

   /* With no columns/items, we just output an empty table, but we
      still output the table.  This matters for MI.  */
   if (ncols == 0)
     {
       do_cleanups (old_chain);
       return;
     }

   if (last && last->columns)
     {
       struct osdata_column *col;
       int ix;

       for (ix = 0;
           VEC_iterate (osdata_column_s, last->columns,
                        ix, col);
           ix++)
 	{
 	  char col_name[32];

 	  if (ix == col_to_skip)
 	    continue;

 	  snprintf (col_name, 32, "col%d", ix);
 	  uiout->table_header (10, ui_left,
 			       col_name, col->name);
         }
     }

   uiout->table_body ();

   if (nrows != 0)
     {
       struct osdata_item *item;
       int ix_items;

       for (ix_items = 0;
           VEC_iterate (osdata_item_s, osdata->items,
                        ix_items, item);
           ix_items++)
        {
          struct cleanup *old_chain;
          int ix_cols;
          struct osdata_column *col;

          old_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "item");

          for (ix_cols = 0;
               VEC_iterate (osdata_column_s, item->columns,
                            ix_cols, col);
               ix_cols++)
 	   {
 	     char col_name[32];

 	     if (ix_cols == col_to_skip)
 	       continue;

 	     snprintf (col_name, 32, "col%d", ix_cols);
 	     uiout->field_string (col_name, col->value);
 	   }

          do_cleanups (old_chain);

          uiout->text ("\n");
        }
     }

   do_cleanups (old_chain);
 }

 static void
 info_osdata_command (char *arg, int from_tty)
 {
   info_osdata (arg);
 }

 extern initialize_file_ftype _initialize_osdata; /* -Wmissing-prototypes */

 void
 _initialize_osdata (void)
 {
   add_info ("os", info_osdata_command,
            _("Show OS data ARG."));
 }
	/* Routines for handling XML generic OS data provided by target.

	Copyright (C) 2008-2017 Free Software Foundation, Inc.

	This file is part of GDB.

	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
	the Free Software Foundation; either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program. If not, see <http://www.gnu.org/licenses/>. */

	#include "defs.h"
	#include "target.h"
	#include "vec.h"
	#include "xml-support.h"
	#include "osdata.h"
	#include "ui-out.h"
	#include "gdbcmd.h"

	#if !defined(HAVE_LIBEXPAT)

	struct osdata *
	osdata_parse (const char *xml)
	{
	static int have_warned;

	if (!have_warned)
	{
	have_warned = 1;
	warning (_("Can not parse XML OS data; XML support was disabled "
	"at compile time"));
	}

	return NULL;
	}

	#else /* HAVE_LIBEXPAT */

	/* Internal parsing data passed to all XML callbacks. */
	struct osdata_parsing_data
	{
	struct osdata *osdata;
	char *property_name;
	};

	/* Handle the start of a <osdata> element. */

	static void
	osdata_start_osdata (struct gdb_xml_parser *parser,
	const struct gdb_xml_element *element,
	void user_data, VEC(gdb_xml_value_s) attributes)
	{
	struct osdata_parsing_data data = (struct osdata_parsing_data ) user_data;
	char *type;
	struct osdata *osdata;

	if (data->osdata)
	gdb_xml_error (parser, _("Seen more than on osdata element"));

	type = (char *) xml_find_attribute (attributes, "type")->value;
	osdata = XCNEW (struct osdata);
	osdata->type = xstrdup (type);
	data->osdata = osdata;
	}

	/* Handle the start of a <item> element. */

	static void
	osdata_start_item (struct gdb_xml_parser *parser,
	const struct gdb_xml_element *element,
	void user_data, VEC(gdb_xml_value_s) attributes)
	{
	struct osdata_parsing_data data = (struct osdata_parsing_data ) user_data;
	struct osdata_item item = { NULL };

	VEC_safe_push (osdata_item_s, data->osdata->items, &item);
	}

	/* Handle the start of a <column> element. */

	static void
	osdata_start_column (struct gdb_xml_parser *parser,
	const struct gdb_xml_element *element,
	void user_data, VEC(gdb_xml_value_s) attributes)
	{
	struct osdata_parsing_data data = (struct osdata_parsing_data ) user_data;
	const char *name
	= (const char *) xml_find_attribute (attributes, "name")->value;

	data->property_name = xstrdup (name);
	}

	/* Handle the end of a <column> element. */

	static void
	osdata_end_column (struct gdb_xml_parser *parser,
	const struct gdb_xml_element *element,
	void user_data, const char body_text)
	{
	struct osdata_parsing_data data = (struct osdata_parsing_data ) user_data;
	struct osdata *osdata = data->osdata;
	struct osdata_item *item = VEC_last (osdata_item_s, osdata->items);
	struct osdata_column *col = VEC_safe_push (osdata_column_s,
	item->columns, NULL);

	/* Transfer memory ownership. NAME was already strdup'ed. */
	col->name = data->property_name;
	col->value = xstrdup (body_text);
	data->property_name = NULL;
	}

	/* Discard the constructed osdata (if an error occurs). */

	static void
	clear_parsing_data (void *p)
	{
	struct osdata_parsing_data data = (struct osdata_parsing_data ) p;

	osdata_free (data->osdata);
	data->osdata = NULL;
	xfree (data->property_name);
	data->property_name = NULL;
	}

	/* The allowed elements and attributes for OS data object.
	The root element is a <osdata>. */

	const struct gdb_xml_attribute column_attributes[] = {
	{ "name", GDB_XML_AF_NONE, NULL, NULL },
	{ NULL, GDB_XML_AF_NONE, NULL, NULL }
	};

	const struct gdb_xml_element item_children[] = {
	{ "column", column_attributes, NULL,
	GDB_XML_EF_REPEATABLE \| GDB_XML_EF_OPTIONAL,
	osdata_start_column, osdata_end_column },
	{ NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
	};

	const struct gdb_xml_attribute osdata_attributes[] = {
	{ "type", GDB_XML_AF_NONE, NULL, NULL },
	{ NULL, GDB_XML_AF_NONE, NULL, NULL }
	};

	const struct gdb_xml_element osdata_children[] = {
	{ "item", NULL, item_children,
	GDB_XML_EF_REPEATABLE \| GDB_XML_EF_OPTIONAL,
	osdata_start_item, NULL },
	{ NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
	};

	const struct gdb_xml_element osdata_elements[] = {
	{ "osdata", osdata_attributes, osdata_children,
	GDB_XML_EF_NONE, osdata_start_osdata, NULL },
	{ NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
	};

	struct osdata *
	osdata_parse (const char *xml)
	{
	struct cleanup *back_to;
	struct osdata_parsing_data data = { NULL };

	back_to = make_cleanup (clear_parsing_data, &data);

	if (gdb_xml_parse_quick (_("osdata"), "osdata.dtd",
	osdata_elements, xml, &data) == 0)
	{
	/* Parsed successfully, don't need to delete the result. */
	discard_cleanups (back_to);
	return data.osdata;
	}

	do_cleanups (back_to);
	return NULL;
	}
	#endif

	static void
	osdata_item_clear (struct osdata_item *item)
	{
	if (item->columns != NULL)
	{
	struct osdata_column *col;
	int ix;

	for (ix = 0;
	VEC_iterate (osdata_column_s, item->columns,
	ix, col);
	ix++)
	{
	xfree (col->name);
	xfree (col->value);
	}
	VEC_free (osdata_column_s, item->columns);
	item->columns = NULL;
	}
	}

	void
	osdata_free (struct osdata *osdata)
	{
	if (osdata == NULL)
	return;

	if (osdata->items != NULL)
	{
	struct osdata_item *item;
	int ix;

	for (ix = 0;
	VEC_iterate (osdata_item_s, osdata->items,
	ix, item);
	ix++)
	osdata_item_clear (item);
	VEC_free (osdata_item_s, osdata->items);
	}

	xfree (osdata);
	}

	static void
	osdata_free_cleanup (void *arg)
	{
	struct osdata osdata = (struct osdata ) arg;

	osdata_free (osdata);
	}

	struct cleanup *
	make_cleanup_osdata_free (struct osdata *data)
	{
	return make_cleanup (osdata_free_cleanup, data);
	}

	struct osdata *
	get_osdata (const char *type)
	{
	struct osdata *osdata = NULL;
	char *xml = target_get_osdata (type);

	if (xml)
	{
	struct cleanup *old_chain = make_cleanup (xfree, xml);

	if (xml[0] == '\0')
	{
	if (type)
	warning (_("Empty data returned by target. Wrong osdata type?"));
	else
	warning (_("Empty type list returned by target. No type data?"));
	}
	else
	osdata = osdata_parse (xml);

	do_cleanups (old_chain);
	}

	if (!osdata)
	error (_("Can not fetch data now."));

	return osdata;
	}

	const char *
	get_osdata_column (struct osdata_item item, const char name)
	{
	struct osdata_column *col;
	int ix_cols;

	for (ix_cols = 0;
	VEC_iterate (osdata_column_s, item->columns,
	ix_cols, col);
	ix_cols++)
	if (strcmp (col->name, name) == 0)
	return col->value;

	return NULL;
	}

	void
	info_osdata (const char *type)
	{
	struct ui_out *uiout = current_uiout;
	struct osdata *osdata = NULL;
	struct osdata_item *last = NULL;
	struct cleanup *old_chain;
	int ncols = 0;
	int nrows;
	int col_to_skip = -1;

	if (type == NULL)
	type = "";

	osdata = get_osdata (type);
	old_chain = make_cleanup_osdata_free (osdata);

	nrows = VEC_length (osdata_item_s, osdata->items);

	if (*type == '\0' && nrows == 0)
	error (_("Available types of OS data not reported."));

	if (!VEC_empty (osdata_item_s, osdata->items))
	{
	last = VEC_last (osdata_item_s, osdata->items);
	if (last->columns)
	ncols = VEC_length (osdata_column_s, last->columns);

	/* As a special case, scan the listing of available data types
	for a column named "Title", and only include it with MI
	output; this column's normal use is for titles for interface
	elements like menus, and it clutters up CLI output. */
	if (*type == '\0' && !uiout->is_mi_like_p ())
	{
	struct osdata_column *col;
	int ix;

	for (ix = 0;
	VEC_iterate (osdata_column_s, last->columns, ix, col);
	ix++)
	{
	if (strcmp (col->name, "Title") == 0)
	col_to_skip = ix;
	}
	/* Be sure to reduce the total column count, otherwise
	internal errors ensue. */
	if (col_to_skip >= 0)
	--ncols;
	}
	}

	make_cleanup_ui_out_table_begin_end (uiout, ncols, nrows,
	"OSDataTable");

	/* With no columns/items, we just output an empty table, but we
	still output the table. This matters for MI. */
	if (ncols == 0)
	{
	do_cleanups (old_chain);
	return;
	}

	if (last && last->columns)
	{
	struct osdata_column *col;
	int ix;

	for (ix = 0;
	VEC_iterate (osdata_column_s, last->columns,
	ix, col);
	ix++)
	{
	char col_name[32];

	if (ix == col_to_skip)
	continue;

	snprintf (col_name, 32, "col%d", ix);
	uiout->table_header (10, ui_left,
	col_name, col->name);
	}
	}

	uiout->table_body ();

	if (nrows != 0)
	{
	struct osdata_item *item;
	int ix_items;

	for (ix_items = 0;
	VEC_iterate (osdata_item_s, osdata->items,
	ix_items, item);
	ix_items++)
	{
	struct cleanup *old_chain;
	int ix_cols;
	struct osdata_column *col;

	old_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "item");

	for (ix_cols = 0;
	VEC_iterate (osdata_column_s, item->columns,
	ix_cols, col);
	ix_cols++)
	{
	char col_name[32];

	if (ix_cols == col_to_skip)
	continue;

	snprintf (col_name, 32, "col%d", ix_cols);
	uiout->field_string (col_name, col->value);
	}

	do_cleanups (old_chain);

	uiout->text ("\n");
	}
	}

	do_cleanups (old_chain);
	}

	static void
	info_osdata_command (char *arg, int from_tty)
	{
	info_osdata (arg);
	}

	extern initialize_file_ftype _initialize_osdata; /* -Wmissing-prototypes */

	void
	_initialize_osdata (void)
	{
	add_info ("os", info_osdata_command,
	_("Show OS data ARG."));
	}