xlnt/source/detail/xlsx_producer.hpp

// Copyright (c) 2014-2016 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, WRISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file
#pragma once

#include <cstdint>
#include <iostream>
#include <vector>

#include <detail/include_pugixml.hpp>
#include <xlnt/xlnt_config.hpp>
#include <xlnt/packaging/zip_file.hpp>

namespace xlnt {

class path;
class relationship;
class workbook;

namespace detail {

/// <summary>
/// Handles writing a workbook into an XLSX file.
/// </summary>
class XLNT_CLASS xlsx_producer
{
public:
	xlsx_producer(const workbook &target);

	void write(const path &destination);

	void write(std::ostream &destination);

	void write(std::vector<std::uint8_t> &destination);

private:
	/// <summary>
	/// Write all files needed to create a valid XLSX file which represents all
	/// data contained in workbook.
	/// </summary>
	void populate_archive();

	// Package Parts

	void write_manifest();
	void write_core_properties(pugi::xml_node root);
	void write_extended_properties(pugi::xml_node root);
	void write_custom_properties(pugi::xml_node root);

	// SpreadsheetML-Specific Package Parts

	void write_workbook(pugi::xml_node root);

	// Workbook Relationship Target Parts

	void write_calculation_chain(pugi::xml_node root);
	void write_connections(pugi::xml_node root);
	void write_custom_xml_mappings(pugi::xml_node root);
	void write_external_workbook_references(pugi::xml_node root);
	void write_metadata(pugi::xml_node root);
	void write_pivot_table(pugi::xml_node root);
	void write_shared_string_table(pugi::xml_node root);
	void write_shared_workbook_revision_headers(pugi::xml_node root);
	void write_shared_workbook(pugi::xml_node root);
	void write_shared_workbook_user_data(pugi::xml_node root);
	void write_styles(pugi::xml_node root);
	void write_theme(pugi::xml_node root);
	void write_volatile_dependencies(pugi::xml_node root);

	void write_chartsheet(pugi::xml_node root, const relationship &rel);
	void write_dialogsheet(pugi::xml_node root, const relationship &rel);
	void write_worksheet(pugi::xml_node root, const relationship &rel);

	// Sheet Relationship Target Parts

	void write_comments(pugi::xml_node root);
	void write_drawings(pugi::xml_node root);

	// Other Parts

	void write_custom_property();
	void write_unknown_parts();
	void write_unknown_relationships();

	/// <summary>
	/// A reference to the workbook which is the object of read/write operations.
	/// </summary>
	const workbook &source_;

	/// <summary>
	/// A reference to the archive into which files representing the workbook
	/// will be written.
	/// </summary>
	zip_file destination_;
};

} // namespace detail
} // namespace xlnt