Update find command help and search memory docs

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

diff --git a/gdb/xml-support.h b/gdb/xml-support.h
index b480fe0b36cc09c356a87610cc82a2a02dcea9b6..74bc8117c0a7b01fc8ac03661221430ac18dbb14 100644 (file)
--- a/gdb/xml-support.h
+++ b/gdb/xml-support.h
@@ -1,6 +1,6 @@
 /* Helper routines for parsing XML using Expat.
 
-   Copyright (C) 2006, 2007 Free Software Foundation, Inc.
+   Copyright (C) 2006-2017 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -23,6 +23,7 @@
 
 #include "gdb_obstack.h"
 #include "vec.h"
+#include "xml-utils.h"
 
 struct gdb_xml_parser;
 struct gdb_xml_element;
@@ -47,28 +48,25 @@ LONGEST xml_builtin_xfer_partial (const char *filename,
 
 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);
+typedef gdb::unique_xmalloc_ptr<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.
+/* Append the expansion of TEXT after processing <xi:include> tags in
+   RESULT.  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.
+   On failure, this function uses NAME in a warning and returns false.
    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);
+bool xml_process_xincludes (std::string &result,
+                           const char *name, const char *text,
+                           xml_fetch_another fetcher, void *fetcher_baton,
+                           int depth);
 
 /* Simplified XML parser infrastructure.  */
 
@@ -175,37 +173,34 @@ struct gdb_xml_element
   gdb_xml_element_end_handler *end_handler;
 };
 
-/* Initialize and return a parser.  Register a cleanup to destroy the
-   parser.  */
-
-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.
+/* 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 (struct gdb_xml_parser *parser, const char *buffer);
+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, 3);
 
 /* 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, 3);
+
+/* 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.  */
 
@@ -233,4 +228,10 @@ extern gdb_xml_attribute_handler gdb_xml_parse_attr_enum;
 ULONGEST gdb_xml_parse_ulongest (struct gdb_xml_parser *parser,
                                 const char *value);
 
+/* Open FILENAME, read all its text into memory, close it, and return
+   the text.  If something goes wrong, return NULL and warn.  */
+
+extern gdb::unique_xmalloc_ptr<char> xml_fetch_content_from_file
+    (const char *filename, void *baton);
+
 #endif