xlnt/source/detail/xlsx_producer.hpp

// Copyright (c) 2014-2016 Thomas Fussell
//
// 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_libstudxml.hpp>
#include <xlnt/xlnt_config.hpp>
#include <xlnt/packaging/zip_file.hpp>

namespace xml {
class serializer;
} // namespace xml

namespace xlnt {

class color;
class path;
class relationship;
class workbook;

namespace detail {

/// <summary>
/// Handles writing a workbook into an XLSX file.
/// </summary>
class XLNT_API 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_content_types();
	void write_core_properties(const relationship &rel);
	void write_extended_properties(const relationship &rel);
	void write_custom_properties(const relationship &rel);
    void write_thumbnail(const relationship &rel);

	// SpreadsheetML-Specific Package Parts

	void write_workbook(const relationship &rel);

	// Workbook Relationship Target Parts

	void write_calculation_chain(const relationship &rel);
	void write_connections(const relationship &rel);
	void write_custom_xml_mappings(const relationship &rel);
	void write_external_workbook_references(const relationship &rel);
	void write_metadata(const relationship &rel);
	void write_pivot_table(const relationship &rel);
	void write_shared_string_table(const relationship &rel);
	void write_shared_workbook_revision_headers(const relationship &rel);
	void write_shared_workbook(const relationship &rel);
	void write_shared_workbook_user_data(const relationship &rel);
	void write_styles(const relationship &rel);
	void write_theme(const relationship &rel);
	void write_volatile_dependencies(const relationship &rel);

	void write_chartsheet(const relationship &rel);
	void write_dialogsheet(const relationship &rel);
	void write_worksheet(const relationship &rel);

	// Sheet Relationship Target Parts

	void write_comments(const relationship &rel);
	void write_drawings(const relationship &rel);

	// Other Parts

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

	// Helpers

	/// <summary>
	/// Some XLSX producers write booleans as "true" or "false" while others use "1" and "0".
	/// Both are valid, but we can use this method to write either depending on the producer
	/// we're trying to match.
	/// </summary>
	std::string write_bool(bool boolean) const;
    
    void write_relationships(const std::vector<xlnt::relationship> &relationships, const path &part);
    void write_color(const xlnt::color &color);
    void write_dxfs();
    void write_table_styles();
    void write_colors(const std::vector<xlnt::color> &colors);
    
    /// <summary>
    /// Dereference serializer_ pointer and return a reference to the object.
    /// This is called by internal methods so that we can use . instead of ->.
    /// </summary>
    xml::serializer &serializer();

	/// <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_;
    
    /// <summary>
    /// Instead of passing the current serializer into part serialization methods,
    /// store pointer in this field and access it in methods with xlsx_producer::serializer().
    /// </summary>
    xml::serializer *serializer_;
};

} // namespace detail
} // namespace xlnt