workbook.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
// Copyright (c) 2024-2025 xlnt-community
//
// 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, ARISING 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 <functional>
#include <iterator>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/internal/features.hpp>

#if XLNT_HAS_INCLUDE(<string_view>) && XLNT_HAS_FEATURE(U8_STRING_VIEW)
  #include <string_view>
#endif

namespace xlnt {

enum class calendar;
enum class core_property;
enum class extended_property;
enum class relationship_type;

class alignment;
class border;
class calculation_properties;
class cell;
class cell_style;
class color;
class const_worksheet_iterator;
class fill;
class font;
class format;
class rich_text;
class manifest;
class metadata_property;
class named_range;
class number_format;
class path;
class pattern_fill;
class protection;
class range;
class range_reference;
class relationship;
class streaming_workbook_reader;
class style;
class style_serializer;
class theme;
class variant;
class workbook_view;
class worksheet;
class worksheet_iterator;
class zip_file;

struct datetime;

namespace detail {

struct stylesheet;
struct workbook_impl;
struct worksheet_impl;
class xlsx_consumer;
class xlsx_producer;

} // namespace detail

class XLNT_API workbook
{
public:
    enum class clone_method
    {
        deep_copy,
        shallow_copy
    };

    using iterator = worksheet_iterator;

    using const_iterator = const_worksheet_iterator;

    using reverse_iterator = std::reverse_iterator<iterator>;

    using const_reverse_iterator = std::reverse_iterator<const_iterator>;

    static workbook empty();

    // Constructors

    workbook();

    workbook(const xlnt::path &file);

    workbook(const xlnt::path &file, const std::string &password);

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    workbook(const xlnt::path &file, std::u8string_view password);
#endif

    workbook(std::istream &data);

    workbook(std::istream &data, const std::string &password);

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    workbook(std::istream &data, std::u8string_view password);
#endif

    workbook(workbook &&other) = default;

    workbook(const workbook &other) = default;

    ~workbook() = default;

    workbook clone(clone_method method) const;

    // Worksheets

    worksheet create_sheet();

    worksheet create_sheet(std::size_t index);

    worksheet create_sheet_with_rel(const std::string &title, const relationship &rel);

    worksheet copy_sheet(worksheet worksheet);

    worksheet copy_sheet(worksheet worksheet, std::size_t index);

    worksheet active_sheet();

    void active_sheet(std::size_t index);

    worksheet sheet_by_title(const std::string &title);

    const worksheet sheet_by_title(const std::string &title) const;

    worksheet sheet_by_index(std::size_t index);

    const worksheet sheet_by_index(std::size_t index) const;

    worksheet sheet_by_id(std::size_t id);

    const worksheet sheet_by_id(std::size_t id) const;

    bool sheet_hidden_by_index(std::size_t index) const;

    bool contains(const std::string &title) const;

    std::size_t index(worksheet worksheet);

    // remove worksheets

    void remove_sheet(worksheet worksheet);

    void clear();

    // iterators

    iterator begin();

    iterator end();

    const_iterator begin() const;

    const_iterator end() const;

    const_iterator cbegin() const;

    const_iterator cend() const;

    void apply_to_cells(std::function<void(cell)> f);

    std::vector<std::string> sheet_titles() const;

    std::size_t sheet_count() const;

    // Metadata Properties

    bool has_core_property(xlnt::core_property type) const;

    std::vector<xlnt::core_property> core_properties() const;

    variant core_property(xlnt::core_property type) const;

    void core_property(xlnt::core_property type, const variant &value);

    bool has_extended_property(xlnt::extended_property type) const;

    std::vector<xlnt::extended_property> extended_properties() const;

    variant extended_property(xlnt::extended_property type) const;

    void extended_property(xlnt::extended_property type, const variant &value);

    bool has_custom_property(const std::string &property_name) const;

    std::vector<std::string> custom_properties() const;

    variant custom_property(const std::string &property_name) const;

    void custom_property(const std::string &property_name, const variant &value);

    calendar base_date() const;

    void base_date(calendar base_date);

    bool has_title() const;

    std::string title() const;

    void title(const std::string &title);

    void abs_path(const std::string &path);

    void arch_id_flags(const std::size_t flags);

    // Named Ranges

    std::vector<xlnt::named_range> named_ranges() const;

    void create_named_range(const std::string &name, worksheet worksheet, const range_reference &reference);

    void create_named_range(const std::string &name, worksheet worksheet, const std::string &reference_string);

    bool has_named_range(const std::string &name) const;

    class range named_range(const std::string &name);

    void remove_named_range(const std::string &name);

    // Serialization/Deserialization

    void save(std::vector<std::uint8_t> &data) const;

    void save(std::vector<std::uint8_t> &data, const std::string &password) const;

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    void save(std::vector<std::uint8_t> &data, std::u8string_view password) const;
#endif

    void save(const std::string &filename) const;

    void save(const std::string &filename, const std::string &password) const;

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    void save(std::u8string_view filename) const;

    void save(std::u8string_view filename, std::u8string_view password) const;
#endif

#ifdef _MSC_VER
    void save(const std::wstring &filename) const;

    void save(const std::wstring &filename, const std::string &password) const;
#endif

    void save(const xlnt::path &filename) const;

    void save(const xlnt::path &filename, const std::string &password) const;

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    void save(const xlnt::path &filename, std::u8string_view password) const;
#endif

    void save(std::ostream &stream) const;

    void save(std::ostream &stream, const std::string &password) const;

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    void save(std::ostream &stream, std::u8string_view password) const;
#endif

    void load(const std::vector<std::uint8_t> &data);

    void load(const std::vector<std::uint8_t> &data, const std::string &password);

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    void load(const std::vector<std::uint8_t> &data, std::u8string_view password);
#endif

    void load(const std::string &filename);

    void load(const std::string &filename, const std::string &password);

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    void load(std::u8string_view filename);

    void load(std::u8string_view filename, std::u8string_view password);
#endif


#ifdef _MSC_VER
    void load(const std::wstring &filename);

    void load(const std::wstring &filename, const std::string &password);
#endif

    void load(const xlnt::path &filename);

    void load(const xlnt::path &filename, const std::string &password);

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    void load(const xlnt::path &filename, std::u8string_view password);
#endif

    void load(std::istream &stream);

    void load(std::istream &stream, const std::string &password);

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    void load(std::istream &stream, std::u8string_view password);
#endif

    // View

    bool has_view() const;

    workbook_view view() const;

    void view(const workbook_view &view);

    // Properties

    bool has_code_name() const;

    std::string code_name() const;

    void code_name(const std::string &code_name);

    bool has_file_version() const;

    std::string app_name() const;

    std::size_t last_edited() const;

    std::size_t lowest_edited() const;

    std::size_t rup_build() const;

    // Theme

    bool has_theme() const;

    const xlnt::theme &theme() const;

    void theme(const class theme &value);

    // Formats

    xlnt::format format(std::size_t format_index);

    const xlnt::format format(std::size_t format_index) const;

    xlnt::format create_format(bool default_format = false);

    void clear_formats();

    // Styles

    bool has_style(const std::string &name) const;

    class style style(const std::string &name);

    const class style style(const std::string &name) const;

    class style create_style(const std::string &name);

    class style create_builtin_style(std::size_t builtin_id);

    void clear_styles();

    void default_slicer_style(const std::string &value);

    std::string default_slicer_style() const;

    void enable_known_fonts();

    void disable_known_fonts();

    bool known_fonts_enabled() const;

    // Manifest

    class manifest &manifest();

    const class manifest &manifest() const;

    // shared strings

    std::size_t add_shared_string(const rich_text &shared, bool allow_duplicates = false);

    const rich_text &shared_strings(std::size_t index) const;

    std::vector<rich_text> &shared_strings();

    const std::vector<rich_text> &shared_strings() const;

    // Thumbnail

    void thumbnail(const std::vector<std::uint8_t> &thumbnail,
        const std::string &extension, const std::string &content_type);

    const std::vector<std::uint8_t> &thumbnail() const;

    const std::unordered_map<std::string, std::vector<std::uint8_t>>& binaries() const;

    // Calculation properties

    bool has_calculation_properties() const;

    class calculation_properties calculation_properties() const;

    void calculation_properties(const class calculation_properties &props);

    bool compare(const workbook &other, bool compare_by_reference) const;

    // Operators

    workbook &operator=(const workbook &other) = default;

    workbook &operator=(workbook &&other) = default;

    worksheet operator[](const std::string &name);

    worksheet operator[](std::size_t index);

    bool operator==(const workbook &rhs) const;

    bool operator!=(const workbook &rhs) const;

private:
    friend class streaming_workbook_reader;
    friend class worksheet;
    friend class detail::xlsx_consumer;
    friend class detail::xlsx_producer;
    friend struct detail::worksheet_impl;

    workbook(std::shared_ptr<detail::workbook_impl> impl);

    workbook(std::weak_ptr<detail::workbook_impl> impl);

    void set_impl(std::shared_ptr<detail::workbook_impl> impl);

    template <typename T>
    void construct(const xlnt::path &file, const T &password);

    template <typename T>
    void construct(std::istream &data, const T &password);

    template <typename T>
    void save_internal(std::vector<std::uint8_t> &data, const T &password) const;

    template <typename T>
    void save_internal(const T &filename) const;

    template <typename T>
    void save_internal(const T &filename, const T &password) const;

    template <typename T>
    void save_internal(const xlnt::path &filename, const T &password) const;

    template <typename T>
    void save_internal(std::ostream &stream, const T &password) const;

    template <typename T>
    void load_internal(const std::vector<std::uint8_t> &data, const T &password);

    template <typename T>
    void load_internal(const T &filename);

    template <typename T>
    void load_internal(const T &filename, const T &password);

    template <typename T>
    void load_internal(const xlnt::path &filename, const T &password);

    template <typename T>
    void load_internal(std::istream &stream, const T &password);

    detail::workbook_impl &impl();

    const detail::workbook_impl &impl() const;

    void register_package_part(relationship_type type);

    void register_workbook_part(relationship_type type);

    void register_worksheet_part(worksheet ws, relationship_type type);

    void garbage_collect_formulae();

    void update_sheet_properties();

    void swap(workbook &other);

    void reorder_relationships();

    std::shared_ptr<detail::workbook_impl> d_;
};

} // namespace xlnt