/* Helper routines for parsing XML using Expat.
- Copyright (C) 2006, 2007 Free Software Foundation, Inc.
+ Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011
+ 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 2 of the License, or
+ 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,
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, write to the Free Software
- Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef XML_SUPPORT_H
struct gdb_xml_element;
struct gdb_xml_attribute;
+/* Return an XML document which was compiled into GDB, from
+ the given FILENAME, or NULL if the file was not compiled in. */
+
+const char *fetch_xml_builtin (const char *filename);
+
+/* A to_xfer_partial helper function which reads XML files which were
+ compiled into GDB. The target may call this function from its own
+ to_xfer_partial handler, after converting object and annex to the
+ appropriate filename. */
+
+LONGEST xml_builtin_xfer_partial (const char *filename,
+ gdb_byte *readbuf, const gdb_byte *writebuf,
+ ULONGEST offset, LONGEST len);
+
+/* The text of compiled-in XML documents, from xml-builtin.c
+ (generated). */
+
+extern const char *xml_builtin[][2];
+
+/* Return a malloc allocated string with special characters from TEXT
+ replaced by entity references. */
+
+char *xml_escape_text (const char *text);
+
+/* Support for XInclude. */
+
+/* Callback to fetch a new XML file, based on the provided HREF. */
+
+typedef char *(*xml_fetch_another) (const char *href, void *baton);
+
+/* Return a new string which is the expansion of TEXT after processing
+ <xi:include> tags. FETCHER will be called (with FETCHER_BATON) to
+ retrieve any new files. DEPTH should be zero on the initial call.
+
+ On failure, this function uses NAME in a warning and returns NULL.
+ It may throw an exception, but does not for XML parsing
+ problems. */
+
+char *xml_process_xincludes (const char *name, const char *text,
+ xml_fetch_another fetcher, void *fetcher_baton,
+ int depth);
+
+/* Simplified XML parser infrastructure. */
+
/* A name and value pair, used to record parsed attributes. */
struct gdb_xml_value
(const char *name, const struct gdb_xml_element *elements,
void *user_data);
+/* Associate DTD_NAME, which must be the name of a compiled-in DTD,
+ with PARSER. */
+
+void gdb_xml_use_dtd (struct gdb_xml_parser *parser, const char *dtd_name);
+
/* Invoke PARSER on BUFFER. BUFFER is the data to parse, which
should be NUL-terminated.
int gdb_xml_parse (struct gdb_xml_parser *parser, const char *buffer);
+/* Parse a XML document. DOCUMENT is the data to parse, which should
+ be NUL-terminated. If non-NULL, use the compiled-in DTD named
+ DTD_NAME to drive the parsing.
+
+ The return value is 0 for success or -1 for error. It may throw,
+ but only if something unexpected goes wrong during parsing; parse
+ errors will be caught, warned about, and reported as failure. */
+
+int gdb_xml_parse_quick (const char *name, const char *dtd_name,
+ const struct gdb_xml_element *elements,
+ const char *document, void *user_data);
+
/* Issue a debugging message from one of PARSER's handlers. */
void gdb_xml_debug (struct gdb_xml_parser *parser, const char *format, ...)
- ATTR_FORMAT (printf, 2, 0);
+ ATTRIBUTE_PRINTF (2, 0);
/* Issue an error message from one of PARSER's handlers, and stop
parsing. */
void gdb_xml_error (struct gdb_xml_parser *parser, const char *format, ...)
- ATTR_NORETURN ATTR_FORMAT (printf, 2, 0);
+ ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (2, 0);
+
+/* Find the attribute named NAME in the set of parsed attributes
+ ATTRIBUTES. Returns NULL if not found. */
+
+struct gdb_xml_value *xml_find_attribute (VEC(gdb_xml_value_s) *attributes,
+ const char *name);
/* Parse an integer attribute into a ULONGEST. */
ULONGEST value;
};
+/* A handler_data for yes/no boolean values. */
+extern const struct gdb_xml_enum gdb_xml_enums_boolean[];
+
extern gdb_xml_attribute_handler gdb_xml_parse_attr_enum;
/* Parse an integer string into a ULONGEST and return it, or call
ULONGEST gdb_xml_parse_ulongest (struct gdb_xml_parser *parser,
const char *value);
+/* Simple printf to obstack function. Current implemented formatters:
+ %s - grow an xml escaped text in OBSTACK. */
+
+extern void obstack_xml_printf (struct obstack *obstack,
+ const char *format, ...)
+ ATTRIBUTE_PRINTF_2;
+
+/* Open FILENAME, read all its text into memory, close it, and return
+ the text. If something goes wrong, return NULL and warn. */
+
+extern char *xml_fetch_content_from_file (const char *filename,
+ void *baton);
+
#endif
projects / deliverable / binutils-gdb.git / blobdiff