relationship.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
// Copyright (c) 2024 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 <string>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/packaging/uri.hpp>
#include <xlnt/utils/path.hpp>

namespace xlnt {

enum class XLNT_API target_mode
{
    internal,
    external
};

enum class XLNT_API relationship_type
{
    unknown,

    // Package parts
    core_properties,
    extended_properties,
    custom_properties,
    office_document,
    thumbnail,
    printer_settings,

    // SpreadsheetML parts
    calculation_chain,
    chartsheet,
    comments,
    connections,
    custom_property,
    custom_xml_mappings,
    dialogsheet,
    drawings,
    external_workbook_references,
    pivot_table,
    pivot_table_cache_definition,
    pivot_table_cache_records,
    query_table,
    shared_string_table,
    shared_workbook_revision_headers,
    shared_workbook,
    theme,
    revision_log,
    shared_workbook_user_data,
    single_cell_table_definitions,
    stylesheet,
    table_definition,
    vml_drawing,
    volatile_dependencies,
    worksheet,
    vbaproject,

    // Worksheet parts
    hyperlink,
    image
};

class XLNT_API relationship
{
public:
    relationship();

    relationship(const std::string &id, relationship_type t, const uri &source,
        const uri &target, xlnt::target_mode mode);

    const std::string &id() const;

    relationship_type type() const;

    xlnt::target_mode target_mode() const;

    const uri &source() const;

    const uri &target() const;

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

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

private:
    std::string id_;

    relationship_type type_;

    uri source_;

    uri target_;

    xlnt::target_mode mode_;
};

} // namespace xlnt