gdbsupport/xml-utils.h

   1 /* Shared helper routines for manipulating XML.
   2
   3    Copyright (C) 2006-2024 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #ifndef COMMON_XML_UTILS_H
  21 #define COMMON_XML_UTILS_H
  22
  23 /* Return a string with special characters from TEXT replaced by entity
  24    references.  */
  25
  26 extern std::string xml_escape_text (const char *text);
  27
  28 /* Append TEXT to RESULT, with special characters replaced by entity
  29    references.  */
  30
  31 extern void xml_escape_text_append (std::string &result, const char *text);
  32
  33 /* Simple printf to string function.  Current implemented formatters:
  34    %s - append an xml escaped text to BUFFER.
  35    %d - append an signed integer to BUFFER.
  36    %u - append an unsigned integer to BUFFER.
  37    %x - append an unsigned integer formatted in hexadecimal to BUFFER.
  38    %o - append an unsigned integer formatted in octal to BUFFER.  */
  39
  40 void string_xml_appendf (std::string &buffer, const char *format, ...)
  41   ATTRIBUTE_PRINTF (2, 3);
  42
  43 #endif /* COMMON_XML_UTILS_H */