XLRelationships.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLRELATIONSHIPS_HPP
#define OPENXLSX_XLRELATIONSHIPS_HPP
 
#ifdef _MSC_VER    // conditionally enable MSVC specific pragmas to avoid other compilers warning about unknown pragmas
#    pragma warning(push)
#    pragma warning(disable : 4251)
#    pragma warning(disable : 4275)
#endif    // _MSC_VER
 
// ===== External Includes ===== //
#include <gsl/pointers>
#include <random>    // std::mt19937
#include <string>
#include <vector>
 
// ===== OpenXLSX Includes ===== //
#include "OpenXLSX-Exports.hpp"
#include "XLXmlFile.hpp"
#include "XLXmlParser.hpp"
 
namespace OpenXLSX
{
    void UseRandomIDs();
 
    void UseSequentialIDs();
 
    extern thread_local std::mt19937 Rand32;
 
    uint64_t Rand64();
 
    void InitRandom(bool pseudoRandom = false);
 
    class XLRelationships;
 
    class XLRelationshipItem;
 
    enum class XLRelationshipType {
        CoreProperties,
        ExtendedProperties,
        CustomProperties,
        Workbook,
        Worksheet,
        Chartsheet,
        Dialogsheet,
        Macrosheet,
        CalculationChain,
        ExternalLink,
        ExternalLinkPath,
        Theme,
        Styles,
        Chart,
        ChartStyle,
        ChartColorStyle,
        Image,
        Drawing,
        VMLDrawing,
        SharedStrings,
        PrinterSettings,
        VBAProject,
        ControlProperties,
        Comments,
        Table,
        Hyperlink,
        Unknown,
        PivotTable,
        Slicer,
        SlicerCache,
        PivotCacheDefinition,
        PivotCacheRecords,
        ThreadedComments,
        Person
    };
}    //     namespace OpenXLSX
 
namespace OpenXLSX_XLRelationships
{    // special namespace to avoid naming conflict with another GetStringFromType function
    using namespace OpenXLSX;
    std::string GetStringFromType(XLRelationshipType type);
}    //    namespace OpenXLSX_XLRelationships
 
namespace OpenXLSX
{
    class OPENXLSX_EXPORT XLRelationshipItem
    {
    public:
        XLRelationshipItem() = default;
 
        explicit XLRelationshipItem(const XMLNode& node);
 
        ~XLRelationshipItem()                                              = default;
        XLRelationshipItem(const XLRelationshipItem& other)                = default;
        XLRelationshipItem(XLRelationshipItem&& other) noexcept            = default;
        XLRelationshipItem& operator=(const XLRelationshipItem& other)     = default;
        XLRelationshipItem& operator=(XLRelationshipItem&& other) noexcept = default;
 
        [[nodiscard]] XLRelationshipType type() const;
 
        [[nodiscard]] std::string target() const;
 
        [[nodiscard]] std::string id() const;
 
        [[nodiscard]] bool empty() const;
 
    private:
        XMLNode m_relationshipNode; 
    };
 
    class OPENXLSX_EXPORT XLRelationships : public XLXmlFile
    {
    public:
        XLRelationships() = default;
 
        explicit XLRelationships(gsl::not_null<XLXmlData*> xmlData, std::string pathTo);
 
        ~XLRelationships();
 
        XLRelationships(const XLRelationships& other)                = default;
        XLRelationships(XLRelationships&& other) noexcept            = default;
        XLRelationships& operator=(const XLRelationships& other)     = default;
        XLRelationships& operator=(XLRelationships&& other) noexcept = default;
 
        [[nodiscard]] XLRelationshipItem relationshipById(std::string_view id) const;
 
        [[nodiscard]] XLRelationshipItem relationshipByTarget(std::string_view target, bool throwIfNotFound = true) const;
 
        [[nodiscard]] std::vector<XLRelationshipItem> relationships() const;
 
        void deleteRelationship(std::string_view relID);
        void deleteRelationship(const XLRelationshipItem& item);
 
        XLRelationshipItem addRelationship(XLRelationshipType type, std::string_view target, bool isExternal = false);
 
        [[nodiscard]] bool targetExists(std::string_view target) const;
        [[nodiscard]] bool idExists(std::string_view id) const;
 
        void print(std::basic_ostream<char>& ostr) const;
 
    private:
        std::string m_path; 
    };
}    // namespace OpenXLSX
 
#ifdef _MSC_VER    // conditionally enable MSVC specific pragmas to avoid other compilers warning about unknown pragmas
#    pragma warning(pop)
#endif    // _MSC_VER
 
#endif    // OPENXLSX_XLRELATIONSHIPS_HPP