1 /* Routines for handling XML generic OS data provided by target.
3 Copyright (C) 2008-2014 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
23 #include "xml-support.h"
29 #if !defined(HAVE_LIBEXPAT)
32 osdata_parse (const char *xml
)
34 static int have_warned
;
39 warning (_("Can not parse XML OS data; XML support was disabled "
46 #else /* HAVE_LIBEXPAT */
48 /* Internal parsing data passed to all XML callbacks. */
49 struct osdata_parsing_data
51 struct osdata
*osdata
;
55 /* Handle the start of a <osdata> element. */
58 osdata_start_osdata (struct gdb_xml_parser
*parser
,
59 const struct gdb_xml_element
*element
,
60 void *user_data
, VEC(gdb_xml_value_s
) *attributes
)
62 struct osdata_parsing_data
*data
= user_data
;
64 struct osdata
*osdata
;
67 gdb_xml_error (parser
, _("Seen more than on osdata element"));
69 type
= xml_find_attribute (attributes
, "type")->value
;
70 osdata
= XCNEW (struct osdata
);
71 osdata
->type
= xstrdup (type
);
72 data
->osdata
= osdata
;
75 /* Handle the start of a <item> element. */
78 osdata_start_item (struct gdb_xml_parser
*parser
,
79 const struct gdb_xml_element
*element
,
80 void *user_data
, VEC(gdb_xml_value_s
) *attributes
)
82 struct osdata_parsing_data
*data
= user_data
;
83 struct osdata_item item
= { NULL
};
85 VEC_safe_push (osdata_item_s
, data
->osdata
->items
, &item
);
88 /* Handle the start of a <column> element. */
91 osdata_start_column (struct gdb_xml_parser
*parser
,
92 const struct gdb_xml_element
*element
,
93 void *user_data
, VEC(gdb_xml_value_s
) *attributes
)
95 struct osdata_parsing_data
*data
= user_data
;
96 const char *name
= xml_find_attribute (attributes
, "name")->value
;
98 data
->property_name
= xstrdup (name
);
101 /* Handle the end of a <column> element. */
104 osdata_end_column (struct gdb_xml_parser
*parser
,
105 const struct gdb_xml_element
*element
,
106 void *user_data
, const char *body_text
)
108 struct osdata_parsing_data
*data
= user_data
;
109 struct osdata
*osdata
= data
->osdata
;
110 struct osdata_item
*item
= VEC_last (osdata_item_s
, osdata
->items
);
111 struct osdata_column
*col
= VEC_safe_push (osdata_column_s
,
112 item
->columns
, NULL
);
114 /* Transfer memory ownership. NAME was already strdup'ed. */
115 col
->name
= data
->property_name
;
116 col
->value
= xstrdup (body_text
);
117 data
->property_name
= NULL
;
120 /* Discard the constructed osdata (if an error occurs). */
123 clear_parsing_data (void *p
)
125 struct osdata_parsing_data
*data
= p
;
127 osdata_free (data
->osdata
);
129 xfree (data
->property_name
);
130 data
->property_name
= NULL
;
133 /* The allowed elements and attributes for OS data object.
134 The root element is a <osdata>. */
136 const struct gdb_xml_attribute column_attributes
[] = {
137 { "name", GDB_XML_AF_NONE
, NULL
, NULL
},
138 { NULL
, GDB_XML_AF_NONE
, NULL
, NULL
}
141 const struct gdb_xml_element item_children
[] = {
142 { "column", column_attributes
, NULL
,
143 GDB_XML_EF_REPEATABLE
| GDB_XML_EF_OPTIONAL
,
144 osdata_start_column
, osdata_end_column
},
145 { NULL
, NULL
, NULL
, GDB_XML_EF_NONE
, NULL
, NULL
}
148 const struct gdb_xml_attribute osdata_attributes
[] = {
149 { "type", GDB_XML_AF_NONE
, NULL
, NULL
},
150 { NULL
, GDB_XML_AF_NONE
, NULL
, NULL
}
153 const struct gdb_xml_element osdata_children
[] = {
154 { "item", NULL
, item_children
,
155 GDB_XML_EF_REPEATABLE
| GDB_XML_EF_OPTIONAL
,
156 osdata_start_item
, NULL
},
157 { NULL
, NULL
, NULL
, GDB_XML_EF_NONE
, NULL
, NULL
}
160 const struct gdb_xml_element osdata_elements
[] = {
161 { "osdata", osdata_attributes
, osdata_children
,
162 GDB_XML_EF_NONE
, osdata_start_osdata
, NULL
},
163 { NULL
, NULL
, NULL
, GDB_XML_EF_NONE
, NULL
, NULL
}
167 osdata_parse (const char *xml
)
169 struct cleanup
*back_to
;
170 struct osdata_parsing_data data
= { NULL
};
172 back_to
= make_cleanup (clear_parsing_data
, &data
);
174 if (gdb_xml_parse_quick (_("osdata"), "osdata.dtd",
175 osdata_elements
, xml
, &data
) == 0)
177 /* Parsed successfully, don't need to delete the result. */
178 discard_cleanups (back_to
);
182 do_cleanups (back_to
);
188 osdata_item_clear (struct osdata_item
*item
)
190 if (item
->columns
!= NULL
)
192 struct osdata_column
*col
;
196 VEC_iterate (osdata_column_s
, item
->columns
,
203 VEC_free (osdata_column_s
, item
->columns
);
204 item
->columns
= NULL
;
209 osdata_free (struct osdata
*osdata
)
214 if (osdata
->items
!= NULL
)
216 struct osdata_item
*item
;
220 VEC_iterate (osdata_item_s
, osdata
->items
,
223 osdata_item_clear (item
);
224 VEC_free (osdata_item_s
, osdata
->items
);
231 osdata_free_cleanup (void *arg
)
233 struct osdata
*osdata
= arg
;
235 osdata_free (osdata
);
239 make_cleanup_osdata_free (struct osdata
*data
)
241 return make_cleanup (osdata_free_cleanup
, data
);
245 get_osdata (const char *type
)
247 struct osdata
*osdata
= NULL
;
248 char *xml
= target_get_osdata (type
);
252 struct cleanup
*old_chain
= make_cleanup (xfree
, xml
);
257 warning (_("Empty data returned by target. Wrong osdata type?"));
259 warning (_("Empty type list returned by target. No type data?"));
262 osdata
= osdata_parse (xml
);
264 do_cleanups (old_chain
);
268 error (_("Can not fetch data now."));
274 get_osdata_column (struct osdata_item
*item
, const char *name
)
276 struct osdata_column
*col
;
280 VEC_iterate (osdata_column_s
, item
->columns
,
283 if (strcmp (col
->name
, name
) == 0)
290 info_osdata_command (char *type
, int from_tty
)
292 struct ui_out
*uiout
= current_uiout
;
293 struct osdata
*osdata
= NULL
;
294 struct osdata_item
*last
= NULL
;
295 struct cleanup
*old_chain
;
298 int col_to_skip
= -1;
300 osdata
= get_osdata (type
);
301 old_chain
= make_cleanup_osdata_free (osdata
);
303 nrows
= VEC_length (osdata_item_s
, osdata
->items
);
305 if (!type
&& nrows
== 0)
306 error (_("Available types of OS data not reported."));
308 if (!VEC_empty (osdata_item_s
, osdata
->items
))
310 last
= VEC_last (osdata_item_s
, osdata
->items
);
312 ncols
= VEC_length (osdata_column_s
, last
->columns
);
314 /* As a special case, scan the listing of available data types
315 for a column named "Title", and only include it with MI
316 output; this column's normal use is for titles for interface
317 elements like menus, and it clutters up CLI output. */
318 if (!type
&& !ui_out_is_mi_like_p (uiout
))
320 struct osdata_column
*col
;
324 VEC_iterate (osdata_column_s
, last
->columns
, ix
, col
);
327 if (strcmp (col
->name
, "Title") == 0)
330 /* Be sure to reduce the total column count, otherwise
331 internal errors ensue. */
332 if (col_to_skip
>= 0)
337 make_cleanup_ui_out_table_begin_end (uiout
, ncols
, nrows
,
340 /* With no columns/items, we just output an empty table, but we
341 still output the table. This matters for MI. */
344 do_cleanups (old_chain
);
348 if (last
&& last
->columns
)
350 struct osdata_column
*col
;
354 VEC_iterate (osdata_column_s
, last
->columns
,
360 if (ix
== col_to_skip
)
363 snprintf (col_name
, 32, "col%d", ix
);
364 ui_out_table_header (uiout
, 10, ui_left
,
365 col_name
, col
->name
);
369 ui_out_table_body (uiout
);
373 struct osdata_item
*item
;
377 VEC_iterate (osdata_item_s
, osdata
->items
,
381 struct cleanup
*old_chain
;
383 struct osdata_column
*col
;
385 old_chain
= make_cleanup_ui_out_tuple_begin_end (uiout
, "item");
388 VEC_iterate (osdata_column_s
, item
->columns
,
394 if (ix_cols
== col_to_skip
)
397 snprintf (col_name
, 32, "col%d", ix_cols
);
398 ui_out_field_string (uiout
, col_name
, col
->value
);
401 do_cleanups (old_chain
);
403 ui_out_text (uiout
, "\n");
407 do_cleanups (old_chain
);
410 extern initialize_file_ftype _initialize_osdata
; /* -Wmissing-prototypes */
413 _initialize_osdata (void)
415 add_info ("os", info_osdata_command
,
416 _("Show OS data ARG."));