2010-02-10 Sterling Augustine <sterling@tensilica.com>

[deliverable/binutils-gdb.git] / gdb / xml-support.h

diff --git a/gdb/xml-support.h b/gdb/xml-support.h
index 8a9dd61fb0d06101c34c3f4a4953b4f7045dd92a..ba2928dd3d50d37f782c500373a94e71581691e4 100644 (file)
--- a/gdb/xml-support.h
+++ b/gdb/xml-support.h
@@ -1,12 +1,12 @@
 /* Helper routines for parsing XML using Expat.
 
-   Copyright (C) 2006, 2007 Free Software Foundation, Inc.
+   Copyright (C) 2006, 2007, 2008, 2009, 2010 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,
@@ -15,9 +15,7 @@
    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
@@ -30,6 +28,50 @@ struct gdb_xml_parser;
 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
@@ -140,6 +182,11 @@ struct gdb_xml_parser *gdb_xml_create_parser_and_cleanup
   (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.
 
@@ -175,6 +222,9 @@ struct gdb_xml_enum
   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
@@ -183,4 +233,17 @@ extern gdb_xml_attribute_handler gdb_xml_parse_attr_enum;
 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