xlnt/include/xlnt/workbook/workbook.hpp

// Copyright (c) 2015 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 <memory>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>

#include "../common/relationship.hpp"

namespace xlnt {

class alignment;
class border;
class color;
class document_properties;
class drawing;
class fill;
class font;
class named_range;
class pattern_fill;
class protection;
class range;
class range_reference;
class relationship;
class worksheet;
class zip_file;
    
enum class encoding;

namespace detail {    
    struct workbook_impl;
} // namespace detail

struct content_type
{
	bool is_default;
	std::string extension;
	std::string part_name;
	std::string type;
};

/// <summary>
/// workbook is the container for all other parts of the document.
/// </summary>
class workbook
{
public:
    class iterator
    {
    public:
        iterator(workbook &wb, std::size_t index);
        iterator(const iterator &);
        iterator &operator=(const iterator &);
        worksheet operator*();
        bool operator==(const iterator &comparand) const;
        bool operator!=(const iterator &comparand) const { return !(*this == comparand); }
        iterator operator++(int);
        iterator &operator++();

    private:
        workbook &wb_;
        std::size_t index_;
    };

    class const_iterator
    {
    public:
        const_iterator(const workbook &wb, std::size_t index);
        const_iterator(const const_iterator &);
        const_iterator &operator=(const const_iterator &);
        const worksheet operator*();
        bool operator==(const const_iterator &comparand) const;
        bool operator!=(const const_iterator &comparand) const { return !(*this == comparand); }
        const_iterator operator++(int);
        const_iterator &operator++();

    private:
        const workbook &wb_;
        std::size_t index_;
    };
    
    static std::size_t index_from_ws_filename(const std::string &filename);

    //constructors
    workbook();
    workbook(encoding e);
    
    workbook &operator=(workbook other);
    workbook(workbook &&other);
    workbook(const workbook &other);
    
    friend void swap(workbook &left, workbook &right);

    worksheet get_active_sheet();

    bool get_guess_types() const;
    void set_guess_types(bool guess);

    bool get_data_only() const;
    void set_data_only(bool data_only);
    
    //create
    worksheet create_sheet();
    worksheet create_sheet(std::size_t index);
    worksheet create_sheet(const std::string &title);
    worksheet create_sheet(std::size_t index, const std::string &title);
	worksheet create_sheet(const std::string &title, const relationship &rel);
    
    //add
    void add_sheet(worksheet worksheet);
    void add_sheet(worksheet worksheet, std::size_t index);
    
    //remove
    void remove_sheet(worksheet worksheet);
    void clear();
    
    //container operations
    worksheet get_sheet_by_name(const std::string &sheet_name);
    const worksheet get_sheet_by_name(const std::string &sheet_name) const;
    worksheet get_sheet_by_index(std::size_t index);
    const worksheet get_sheet_by_index(std::size_t index) const;
    bool contains(const std::string &key) const;
    int get_index(worksheet worksheet);
    
    worksheet operator[](const std::string &name);
    worksheet operator[](std::size_t index);
    
    iterator begin();
    iterator end();
    
    const_iterator begin() const { return cbegin(); }
    const_iterator end() const { return cend(); }
    
    const_iterator cbegin() const;
    const_iterator cend() const;
    
    std::vector<std::string> get_sheet_names() const;
    
    document_properties &get_properties();
    const document_properties &get_properties() const;
    
    //named ranges
    std::vector<named_range> get_named_ranges() const;
    void create_named_range(const std::string &name, worksheet worksheet, const range_reference &reference);
    bool has_named_range(const std::string &name) const;
    range get_named_range(const std::string &name);
    void remove_named_range(const std::string &name);
    
    //serialization
    bool save(std::vector<unsigned char> &data);
    bool save(const std::string &filename);
    bool load(const std::vector<unsigned char> &data);
    bool load(const std::string &filename);
    bool load(const std::istream &stream);
    bool load(zip_file &archive);
    
    bool operator==(const workbook &rhs) const;
    
    bool operator!=(const workbook &rhs) const
    {
        return !(*this == rhs);
    }
    
    bool operator==(std::nullptr_t) const;
    
    bool operator!=(std::nullptr_t) const
    {
        return !(*this == std::nullptr_t{});
    }

	std::vector<content_type> get_content_types() const;
    
	void create_relationship(const std::string &id, const std::string &target, relationship::type type);
	relationship get_relationship(const std::string &id) const;
    std::vector<relationship> get_relationships() const;
    
    void add_alignment(alignment a);
    void add_border(border b);
    void add_fill(fill &f);
    void add_font(font f);
    void add_protection(protection p);
    void add_color(color c);
    void add_number_format(const std::string &format);
    
    void set_code_name(const std::string &code_name);
    
    bool has_loaded_theme();
    std::string get_loaded_theme();
    
private:
    friend class worksheet;
    std::shared_ptr<detail::workbook_impl> d_;
};
    
} // namespace xlnt