libodfgen-0.1.8/src/PageSpan.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* libodfgen
 * Version: MPL 2.0 / LGPLv2.1+
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Major Contributor(s):
 * Copyright (C) 2002-2004 William Lachance (wrlach@gmail.com)
 *
 * For minor contributions see the git repository.
 *
 * Alternatively, the contents of this file may be used under the terms
 * of the GNU Lesser General Public License Version 2.1 or later
 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
 * applicable instead of those above.
 *
 * For further information visit http://libwpd.sourceforge.net
 */

/* "This product is not manufactured, approved, or supported by
 * Corel Corporation or Corel Corporation Limited."
 */
#ifndef _PAGESPAN_HXX_
#define _PAGESPAN_HXX_

#include <librevenge/librevenge.h>
#include <map>
#include <memory>
#include <set>
#include <vector>

#include "FilterInternal.hxx"

#include "Style.hxx"

class DocumentElement;
class OdfDocumentHandler;

//! the page drawing style
class PageDrawingStyle : public Style
{
public:
	PageDrawingStyle(librevenge::RVNGPropertyList const &propList, const librevenge::RVNGString &sName, Style::Zone zone);
	~PageDrawingStyle() override;
	void write(OdfDocumentHandler *pHandler) const override;

private:
	librevenge::RVNGPropertyList mpPropList;
};

//! the page layout style
class PageLayoutStyle : public Style
{
public:
	PageLayoutStyle(librevenge::RVNGPropertyList const &propList, const librevenge::RVNGString &sName, Style::Zone zone);
	~PageLayoutStyle() override;
	void write(OdfDocumentHandler *pHandler) const override;
	/** reset the page size (used by Od[pg]Generator to reset the size to union size)
		and the margins to 0
		\note size are given in inch
	 */
	void resetPageSizeAndMargins(double width, double height);

private:
	librevenge::RVNGPropertyList mpPropList;
};

class PageSpan
{
protected:
	enum ContentType : int
	{
		C_Header=0, C_HeaderFirst, C_HeaderLeft, C_HeaderLast,
		C_Footer, C_FooterFirst, C_FooterLeft, C_FooterLast,
		C_Master,
		C_NumContentTypes // keep this one last
	};
public:
	PageSpan(librevenge::RVNGString const &masterName, librevenge::RVNGString const &masterDisplay="", bool isMasterPage=false);
	virtual ~PageSpan();
	void writeMasterPages(OdfDocumentHandler *pHandler) const;
	//! returns true if this is a master page
	bool isMasterPage() const
	{
		return mbIsMasterPage;
	}
	//! returns the display name of the span's master page
	librevenge::RVNGString getDisplayMasterName() const
	{
		return msMasterDisplay;
	}
	//! returns the name of the span's master page
	librevenge::RVNGString getMasterName() const
	{
		return msMasterName;
	}
	//! set the layout name
	void setLayoutName(librevenge::RVNGString const &name)
	{
		msLayoutName=name;
	}
	//! returns the name of the span's layout page
	librevenge::RVNGString getLayoutName() const
	{
		return msLayoutName;
	}
	//! set the display page drawing name
	void setDrawingName(librevenge::RVNGString const &name)
	{
		msDrawingName=name;
	}
	//! returns the name of the span's page drawing
	librevenge::RVNGString getDrawingName() const
	{
		return msDrawingName;
	}
	void setHeaderContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_Header, pContent);
	}
	void setFooterContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_Footer, pContent);
	}
	void setHeaderLeftContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_HeaderLeft, pContent);
	}
	void setFooterLeftContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_FooterLeft, pContent);
	}
	void setHeaderFirstContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_HeaderFirst, pContent);
	}
	void setFooterFirstContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_FooterFirst, pContent);
	}
	void setHeaderLastContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_HeaderLast, pContent);
	}
	void setFooterLastContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_FooterLast, pContent);
	}
	void setMasterContent(const std::shared_ptr<libodfgen::DocumentElementVector> &pContent)
	{
		storeContent(C_Master, pContent);
	}

	/** small function which mainly replaced space by underscore */
	static librevenge::RVNGString protectString(librevenge::RVNGString const &orig);
protected:
	void storeContent(ContentType type, const std::shared_ptr<libodfgen::DocumentElementVector> &pContent);
	static void _writeContent(const char *contentTagName, const libodfgen::DocumentElementVector &content,
	                          OdfDocumentHandler *pHandler);
private:
	PageSpan(const PageSpan &);
	PageSpan &operator=(const PageSpan &);
	//! flag to know if this is a master page
	bool mbIsMasterPage;
	//! the page master name
	librevenge::RVNGString msMasterName;
	//! the page master display name
	librevenge::RVNGString msMasterDisplay;
	//! the layout display name
	librevenge::RVNGString msLayoutName;
	//! the page drawing display name
	librevenge::RVNGString msDrawingName;
	std::shared_ptr<libodfgen::DocumentElementVector> mpContent[C_NumContentTypes];
};

//! class used to store the list of created page
class PageSpanManager
{
public:
	//! constructor
	PageSpanManager() : mpPageList(), mpNameToMasterMap(),
		mpLayoutList(), mpNameToLayoutMap(), mHashLayoutMap(),
		mpDrawingList(), mpNameToDrawingMap(), mHashDrawingMap()
	{
	}
	//! destructor
	~PageSpanManager()
	{
		clean();
	}
	//! clean data
	void clean();
	//! create a new page and set it to current. Returns a pointer to this new page
	PageSpan *add(const librevenge::RVNGPropertyList &xPropList, bool masterPage=false);
	//! return the page span which correspond to a master name
	PageSpan *get(librevenge::RVNGString const &masterName);
	//! write the pages' layouts (style automatic) or the pages' drawing styles(content automatic)
	void writePageStyles(OdfDocumentHandler *pHandler, Style::Zone zone) const;
	void writeMasterPages(OdfDocumentHandler *pHandler) const;

	/** reset all layout page sizes given in inches	and the margins to 0

		\note this function is used by Od[pg]Generator to reset the
		size to union size, so it only reset size if there are several
		page layouts, ie. at least 2.
	 */
	void resetPageSizeAndMargins(double width, double height);

protected:
	/* create a new drawing style if it does not exists and returns the final name for the drawing properties.

	   \note If the property list does not contain any drawing style, returns the empty string*/
	librevenge::RVNGString findOrAddDrawing(const librevenge::RVNGPropertyList &xPropList, bool masterPage);

	/* create a new layout style if it does not exists and returns the final name for the layout properties. */
	librevenge::RVNGString findOrAddLayout(const librevenge::RVNGPropertyList &xPropList);

	//! the list of page
	std::vector<std::shared_ptr<PageSpan> > mpPageList;
	//! a map master page name to pagespan
	std::map<librevenge::RVNGString, std::shared_ptr<PageSpan> > mpNameToMasterMap;

	//! the list of layout style
	std::vector<std::shared_ptr<PageLayoutStyle> > mpLayoutList;
	//! a map named layout to page layout style
	std::map<librevenge::RVNGString, std::shared_ptr<PageLayoutStyle> > mpNameToLayoutMap;
	// hash key -> layout style
	std::map<librevenge::RVNGString, librevenge::RVNGString> mHashLayoutMap;
	//! the list of drawing style
	std::vector<std::shared_ptr<PageDrawingStyle> > mpDrawingList;
	//! a map named drawing to page drawing style
	std::map<librevenge::RVNGString, std::shared_ptr<PageDrawingStyle> > mpNameToDrawingMap;
	// hash key -> drawing style
	std::map<librevenge::RVNGString, librevenge::RVNGString> mHashDrawingMap;
};
#endif

/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */