core/OOXML/DocxFormat/Document.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 "../Base/Nullable.h"

#include "../Common/SimpleTypes_Word.h"
#include "../Common/SimpleTypes_Shared.h"

#include "WritingElement.h"
#include "File.h"
#include "FileTypes.h"
#include "IFileContainer.h"

#include "Logic/SectionProperty.h"
#include "Logic/Pict.h"

namespace OOX
{
	namespace Vml
	{
		class CBackground;
	}
	namespace Logic
	{
		//--------------------------------------------------------------------------------
		// Background 17.2.1 (Part 1)
		//--------------------------------------------------------------------------------

		class CBackground : public WritingElement
		{
		public:
			WritingElement_AdditionMethods(CBackground)
			CBackground(OOX::Document *pMain = NULL);
			virtual ~CBackground();

			virtual void fromXML(XmlUtils::CXmlNode& oNode);
			virtual void fromXML(XmlUtils::CXmlLiteReader& oReader);

			virtual std::wstring toXML() const;
			virtual EElementType getType() const;

		private:
			void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);

		public:
			nullable<SimpleTypes::CHexColor> m_oColor;
			nullable<SimpleTypes::CThemeColor> m_oThemeColor;
			nullable<SimpleTypes::CUcharHexNumber> m_oThemeShade;
			nullable<SimpleTypes::CUcharHexNumber> m_oThemeTint;

			nullable<OOX::Logic::CDrawing> m_oDrawing;
			nullable<OOX::Vml::CBackground> m_oBackground;
		};
		
		class CDocSuppData : public WritingElement
		{//Word 2003 XML Reference
		public:
			WritingElement_AdditionMethods(CDocSuppData)
			CDocSuppData(OOX::Document* pMain = NULL);
			virtual ~CDocSuppData();

			virtual void fromXML(XmlUtils::CXmlNode& oNode);
			virtual void fromXML(XmlUtils::CXmlLiteReader& oReader);

			virtual std::wstring toXML() const;
			virtual EElementType getType() const;

		private:
			void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);

		public:
			nullable<OOX::Logic::CBinData> m_oBinData;
		};
		class CBgPict : public WritingElement
		{//Word 2003 XML Reference
		public:
			WritingElement_AdditionMethods(CBgPict)
			CBgPict(OOX::Document *pMain = NULL);
			virtual ~CBgPict();

			virtual void fromXML(XmlUtils::CXmlNode& oNode);
			virtual void fromXML(XmlUtils::CXmlLiteReader& oReader);

			virtual std::wstring toXML() const;
			virtual EElementType getType() const;

		private:
			void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);

		public:
			nullable<OOX::Logic::CBinData>		m_oBinData;
			nullable<SimpleTypes::CHexColor>	m_oColor;
			nullable_string						m_oBackgroundType;
			nullable<OOX::Vml::CBackground>		m_oBackground;
		};
	}

	//--------------------------------------------------------------------------------
	// CDocument 17.2.3 (Part 1)
	//--------------------------------------------------------------------------------
	class CDocument : public OOX::File, public IFileContainer, public WritingElementWithChilds<>
	{
	public:
		CDocument(OOX::Document *pMain = NULL, OOX::FileType type = OOX::FileTypes::Document);
		CDocument(OOX::Document *pMain, const CPath& oRootPath, const CPath& oPath, OOX::FileType type = OOX::FileTypes::Document);
		CDocument(XmlUtils::CXmlNode& oNode);
		CDocument(XmlUtils::CXmlLiteReader& oReader);
		virtual ~CDocument();

		const CDocument& operator =(const XmlUtils::CXmlNode& oNode);
		const CDocument& operator =(const XmlUtils::CXmlLiteReader& oReader);

		virtual void read(const CPath& oPath);
		
		void CreateElements(XmlUtils::CXmlLiteReader &oReader, int Depth);

		virtual void read(const CPath& oRootPath, const CPath& oPath);
		virtual void write(const CPath& oPath, const CPath& oDirectory, CContentTypes& oContent) const;
		virtual const OOX::FileType type() const;

		virtual const CPath DefaultDirectory() const;
		virtual const CPath DefaultFileName() const;

		const CPath& GetReadPath();

		void ClearItems();
		void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);
		virtual void fromXML(XmlUtils::CXmlNode& oNode);

		virtual void fromXML(XmlUtils::CXmlLiteReader& oReader);
		virtual std::wstring toXML() const;
		virtual EElementType getType() const;

//---------------------------------------------------------------------------------------------
		bool									m_bMacroEnabled = false;
		CPath									m_oReadPath;
		unsigned int							m_nDrawingMaxZIndex = 0;

		SimpleTypes::CConformanceClass			m_oConformance;

		nullable<SimpleTypes::CXmlSpace>		m_oSpace;

		nullable<OOX::Logic::CSectionProperty>	m_oSectPr;
		nullable<OOX::Logic::CBackground>		m_oBackground;
//---------------------------------------------------------------------------------------------
		struct _section
		{
			size_t start_elm = 0;
			size_t end_elm = 0;
			WritingElement* sect = NULL;
		};
		std::vector<_section> m_arrSections; // duplication ... for conversion convenience

	};

} // namespace OOX