core/MsBinaryFile/Common/Base/XmlTools.h

/*
 * Copyright (C) Ascensio System SIA, 2009-2026
 *
 * This program is a free software product. You can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License (AGPL)
 * version 3 as published by the Free Software Foundation, together with the
 * additional terms provided in the LICENSE file.
 *
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For
 * details, see the GNU AGPL at: https://www.gnu.org/licenses/agpl-3.0.html
 *
 * You can contact Ascensio System SIA by email at info@onlyoffice.com
 * or by postal mail at 20A-6 Ernesta Birznieka-Upisha Street, Riga,
 * LV-1050, Latvia, European Union.
 *
 * The interactive user interfaces in modified versions of the Program
 * are required to display Appropriate Legal Notices in accordance with
 * Section 5 of the GNU AGPL version 3.
 *
 * No trademark rights are granted under this License.
 *
 * All non-code elements of the Product, including illustrations,
 * icon sets, and technical writing content, are licensed under the
 * Creative Commons Attribution-ShareAlike 4.0 International License:
 * https://creativecommons.org/licenses/by-sa/4.0/legalcode
 *
 * This license applies only to such non-code elements and does not
 * modify or replace the licensing terms applicable to the Program's
 * source code, which remains licensed under the GNU Affero General
 * Public License v3.
 *
 * SPDX-License-Identifier: AGPL-3.0-only
 */
#pragma once

#include <string>
#include <unordered_map>
#include <list>

#include <boost/shared_ptr.hpp>

#include "../../../DesktopEditor/common/File.h"

inline static std::wstring ReplaceString(std::wstring subject, const std::wstring& search, const std::wstring& replace)
{
	size_t pos = 0;

	while ((pos = subject.find(search, pos)) != std::string::npos)
	{
		subject.replace(pos, search.length(), replace);
		pos += replace.length();
	}

	return subject;
}
//----------------------------------------------------------------
namespace XMLTools
{
	/*========================================================================================================
	class XMLAttribute
	========================================================================================================*/

	class XMLAttribute
	{
	private:
		std::wstring m_Name;
		std::wstring m_Value;

	public:

		XMLAttribute();
		XMLAttribute(const std::wstring& name);
		XMLAttribute(const std::wstring& name, const std::wstring& value);
		~XMLAttribute();

		void SetValue(const std::wstring& value);
		std::wstring GetName() const;

		/*========================================================================================================*/

		std::wstring GetValue() const;

		/*========================================================================================================*/

		std::wstring GetXMLString();
	};

	/*========================================================================================================
	class XMLElement
	========================================================================================================*/

	class XMLElement;
	typedef class boost::shared_ptr<XMLElement> XMLElementPtr;

	class XMLElement
	{
		typedef std::pair< std::wstring, std::wstring> AttributeValuePair;

	private:
		std::wstring									m_Name;
		std::wstring									m_ElementText;
		std::unordered_map<std::wstring, std::wstring>	m_AttributeMap;
		std::unordered_map<std::wstring, int>			m_ChildMap; //for uniq
		std::list<XMLElement>                           m_Elements;

		typedef std::list<XMLElement>::iterator          ElementsIterator;
		typedef std::list<XMLElement>::const_iterator    ElementsIteratorConst;

		typedef std::unordered_map<std::wstring, std::wstring>::iterator            AttMapIterator;
		typedef std::unordered_map<std::wstring, std::wstring>::const_iterator      AttMapIteratorConst;

	public:
		XMLElement();
		XMLElement(const std::wstring& name);
		XMLElement(const std::wstring& prefix, const std::wstring& localName);
		~XMLElement();

		void AppendText(const std::wstring& text);
		void AppendTextSymbol(const wchar_t symbol);

		void AppendAttribute(const XMLAttribute& attribute);
		void AppendAttribute(const std::wstring& name, const std::wstring& value);

		void AppendChild(const XMLElement& element, bool uniq = false);
		void AppendChild(XMLElementPtr element, bool uniq = false);

		void RemoveChild(const XMLElement& element);

		bool FindChild(const XMLElement& element);
		bool FindChildByName(const std::wstring& elementName) const;

		bool RemoveChildByName(const std::wstring& elementName);

		bool operator == (const XMLElement& element) const;

		/*========================================================================================================*/

		std::wstring GetName() const;

		/*========================================================================================================*/

		std::wstring GetXMLString();

		/*========================================================================================================*/

		unsigned int GetAttributeCount() const;

		/*========================================================================================================*/

		unsigned int GetChildCount() const;
	};

	class CStringXmlWriter
	{
		std::wstring m_str;

	public:
		CStringXmlWriter();
		std::wstring GetXmlString();

		void SetXmlString(const std::wstring& strValue);
		void Clear();
		bool SaveToFile(const std::wstring& strFilePath, bool bEncodingToUTF8 = false);

		void WriteString(const std::wstring& strValue);
		void WriteInteger(int Value, int Base = 10);
		void WriteDouble(double Value);
		void WriteBoolean(bool Value);

		void WriteNodeBegin(const std::wstring& strNodeName, bool bAttributed = false);
		void WriteNodeEnd(const std::wstring& strNodeName, bool bEmptyNode = false, bool bEndNode = true);

		void WriteNode(const std::wstring& strNodeName, const std::wstring& strNodeValue);
		void WriteNode(const std::wstring& strNodeName, int nValue, int nBase = 10, const std::wstring& strTextBeforeValue = L"", const std::wstring& strTextAfterValue = L"");
		void WriteNode(const std::wstring& strNodeName, double dValue);

		void WriteAttribute(const std::wstring& strAttributeName, const std::wstring& strAttributeValue);
		void WriteAttribute(const std::wstring& strAttributeName, int nValue, int nBase = 10, const std::wstring& strTextBeforeValue = L"", const std::wstring& strTextAfterValue = L"");
		void WriteAttribute(const std::wstring& strAttributeName, double dValue);
	};
}