gdb/xml-tdesc.h

   1 /* XML target description support for GDB.
   2
   3    Copyright (C) 2006-2024 Free Software Foundation, Inc.
   4
   5    Contributed by CodeSourcery.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef XML_TDESC_H
  23 #define XML_TDESC_H
  24
  25 #include <optional>
  26 #include <string>
  27
  28 struct target_ops;
  29 struct target_desc;
  30
  31 /* Read an XML target description from FILENAME.  Parse it, and return
  32    the parsed description.  */
  33
  34 const struct target_desc *file_read_description_xml (const char *filename);
  35
  36 /* Read an XML target description using OPS.  Parse it, and return the
  37    parsed description.  */
  38
  39 const struct target_desc *target_read_description_xml (struct target_ops *);
  40
  41 /* Fetches an XML target description using OPS, processing includes,
  42    but not parsing it.  Used to dump whole tdesc as a single XML file.
  43    Returns the description on success, and a disengaged optional
  44    otherwise.  */
  45 std::optional<std::string> target_fetch_description_xml (target_ops *ops);
  46
  47 /* Take an xml string, parse it, and return the parsed description.  Does not
  48    handle a string containing includes.  */
  49
  50 const struct target_desc *string_read_description_xml (const char *xml);
  51
  52 #endif /* XML_TDESC_H */
  53