include/tools/XmlWriter.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_TOOLS_XMLWRITER_HXX
  11 #define INCLUDED_TOOLS_XMLWRITER_HXX
  12
  13 #include <sal/config.h>
  14
  15 #include <basegfx/numeric/ftools.hxx>
  16 #include <tools/toolsdllapi.h>
  17 #include <rtl/string.hxx>
  18 #include <memory>
  19 #include <string_view>
  20 #include <vector>
  21
  22 class SvStream;
  23
  24 namespace tools
  25 {
  26 struct XmlWriterImpl;
  27
  28 /**
  29  * XmlWriter writes a XML to a SvStream. It uses libxml2 for writing but hides
  30  * all the internal libxml2 workings and uses types that are native for LO
  31  * development.
  32  *
  33  * The codepage used for XML is always "utf-8" and the output is indented by
  34  * default so it is easier to read.
  35  *
  36  */
  37 class TOOLS_DLLPUBLIC XmlWriter final
  38 {
  39 private:
  40     std::unique_ptr<XmlWriterImpl> mpImpl;
  41
  42 public:
  43     XmlWriter(SvStream* pStream);
  44
  45     ~XmlWriter();
  46
  47     bool startDocument(sal_Int32 nIndent = 2, bool bWriteXmlHeader = true);
  48     void endDocument();
  49
  50     void startElement(const char* sName);
  51     void startElement(const OString& sName) { startElement(sName.getStr()); }
  52     void startElement(const OString& sPrefix, const OString& sName, const OString& sNamespaceUri);
  53     void endElement();
  54
  55     void attribute(const char* sTagName, const OString& aValue);
  56     void attribute(const OString& sTagName, const OString& aValue)
  57     {
  58         attribute(sTagName.getStr(), aValue);
  59     }
  60     void attribute(const char* sTagName, std::u16string_view aValue);
  61     void attribute(const char* sTagName, sal_Int64 aNumber);
  62     template <typename T>
  63     requires std::is_arithmetic_v<T> void attribute(const char* sTagName, T aNumber)
  64     {
  65         if constexpr (std::is_floating_point_v<T>)
  66             return attribute(sTagName, basegfx::fround64(aNumber));
  67         else
  68             return attribute(sTagName, static_cast<sal_Int64>(aNumber));
  69     }
  70     void attributeDouble(const char* sTagName, double aNumber);
  71     void attributeBase64(const char* sTagName, std::vector<sal_uInt8> const& rValueInBytes);
  72     void attributeBase64(const char* sTagName, std::vector<char> const& rValueInBytes);
  73
  74     void content(const OString& sValue);
  75     void content(std::u16string_view sValue);
  76
  77     void element(const char* sName);
  78 };
  79
  80 } // end tools namespace
  81
  82 #endif // INCLUDED_TOOLS_XMLWRITER_HXX
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */