xlnt/source/detail/serialization/xlsx_producer.hpp

212 lines
6.4 KiB
C++
Raw Normal View History

2017-01-03 09:35:18 +08:00
// Copyright (c) 2014-2017 Thomas Fussell
2016-08-03 12:12:18 +08:00
//
// 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
2016-08-03 12:12:18 +08:00
#pragma once
#include <cstdint>
#include <iostream>
#include <memory>
2016-08-03 12:12:18 +08:00
#include <vector>
#include <detail/constants.hpp>
#include <detail/external/include_libstudxml.hpp>
2016-08-03 12:12:18 +08:00
namespace xml {
class serializer;
} // namespace xml
2016-08-03 12:12:18 +08:00
namespace xlnt {
class border;
2017-07-05 08:52:46 +08:00
class cell;
class cell_reference;
class color;
class fill;
class font;
2016-08-03 12:12:18 +08:00
class path;
2016-08-05 13:52:05 +08:00
class relationship;
2017-07-05 08:52:46 +08:00
class streaming_workbook_writer;
class variant;
2016-08-03 12:12:18 +08:00
class workbook;
class worksheet;
2016-08-05 13:52:05 +08:00
namespace detail {
2016-08-03 12:12:18 +08:00
class ozstream;
2017-07-05 08:52:46 +08:00
struct cell_impl;
struct worksheet_impl;
2016-08-03 12:12:18 +08:00
/// <summary>
/// Handles writing a workbook into an XLSX file.
/// </summary>
class xlsx_producer
2016-08-03 12:12:18 +08:00
{
public:
2016-08-05 13:52:05 +08:00
xlsx_producer(const workbook &target);
2016-08-03 12:12:18 +08:00
2017-07-05 08:52:46 +08:00
~xlsx_producer();
2016-08-03 12:12:18 +08:00
void write(std::ostream &destination);
void write(std::ostream &destination, const std::string &password);
2016-08-03 12:12:18 +08:00
private:
2017-07-05 08:52:46 +08:00
friend class xlnt::streaming_workbook_writer;
void open(std::ostream &destination);
cell add_cell(const cell_reference &ref);
worksheet add_worksheet(const std::string &title);
2016-08-03 12:12:18 +08:00
/// <summary>
/// Write all files needed to create a valid XLSX file which represents all
/// data contained in workbook.
/// </summary>
2017-07-05 08:52:46 +08:00
void populate_archive(bool streaming);
2016-08-03 12:12:18 +08:00
void begin_part(const path &part);
void end_part();
2016-08-05 13:52:05 +08:00
// Package Parts
void write_content_types();
2017-01-21 23:29:23 +08:00
void write_property(const std::string &name, const variant &value, const std::string &ns, bool custom, std::size_t pid);
void write_core_properties(const relationship &rel);
void write_extended_properties(const relationship &rel);
void write_custom_properties(const relationship &rel);
void write_image(const path &image_path);
2016-08-05 13:52:05 +08:00
// SpreadsheetML-Specific Package Parts
void write_workbook(const relationship &rel);
2016-08-05 13:52:05 +08:00
// Workbook Relationship Target Parts
void write_connections(const relationship &rel);
void write_custom_xml_mappings(const relationship &rel);
void write_external_workbook_references(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);
2016-08-05 13:52:05 +08:00
// Sheet Relationship Target Parts
void write_comments(const relationship &rel, worksheet ws, const std::vector<cell_reference> &cells);
void write_vml_drawings(const relationship &rel, worksheet ws, const std::vector<cell_reference> &cells);
2016-08-05 13:52:05 +08:00
// Other Parts
2016-08-05 13:52:05 +08:00
void write_custom_property();
void write_unknown_parts();
void write_unknown_relationships();
2016-08-05 13:52:05 +08:00
2016-08-18 19:34:18 +08:00
// 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);
2016-09-19 09:49:37 +08:00
void write_color(const xlnt::color &color);
void write_border(const xlnt::border &b);
void write_fill(const xlnt::fill &f);
void write_font(const xlnt::font &f);
void write_table_styles();
void write_colors(const std::vector<xlnt::color> &colors);
template<typename T>
void write_element(const std::string &ns, const std::string &name, T value)
{
write_start_element(ns, name);
write_characters(value);
write_end_element(ns, name);
}
void write_start_element(const std::string &name);
void write_start_element(const std::string &ns, const std::string &name);
void write_end_element(const std::string &name);
void write_end_element(const std::string &ns, const std::string &name);
void write_namespace(const std::string &ns, const std::string &prefix);
template<typename T>
void write_attribute(const std::string &name, T value)
{
current_part_serializer_->attribute(name, value);
}
template<typename T>
void write_attribute(const xml::qname &name, T value)
{
current_part_serializer_->attribute(name, value);
}
template<typename T>
void write_characters(T characters, bool preserve_whitespace = false)
{
if (preserve_whitespace)
{
write_attribute(xml::qname(constants::ns("xml"), "space"), "preserve");
}
current_part_serializer_->characters(characters);
}
2016-08-18 19:34:18 +08:00
2016-08-03 12:12:18 +08:00
/// <summary>
/// A reference to the workbook which is the object of read/write operations.
/// </summary>
2016-08-05 13:52:05 +08:00
const workbook &source_;
2017-07-05 08:52:46 +08:00
std::unique_ptr<ozstream> archive_;
std::unique_ptr<xml::serializer> current_part_serializer_;
std::unique_ptr<std::streambuf> current_part_streambuf_;
std::ostream current_part_stream_;
2017-07-05 08:52:46 +08:00
bool streaming_ = false;
std::unique_ptr<detail::cell_impl> streaming_cell_;
detail::cell_impl *current_cell_;
detail::worksheet_impl *current_worksheet_;
2016-08-03 12:12:18 +08:00
};
2016-08-05 13:52:05 +08:00
} // namespace detail
2016-08-03 12:12:18 +08:00
} // namespace xlnt