react-native-nitro-xlsx 0.2.5 → 0.2.7

package/thirdparty/OpenXLSX/OpenXLSX/headers/OpenXLSX/XLProperties.hpp

@@ -0,0 +1,348 @@
+/*
+
+   ____                               ____      ___ ____       ____  ____      ___
+  6MMMMb                              `MM(      )M' `MM'      6MMMMb\`MM(      )M'
+ 8P    Y8                              `MM.     d'   MM      6M'    ` `MM.     d'
+6M      Mb __ ____     ____  ___  __    `MM.   d'    MM      MM        `MM.   d'
+MM      MM `M6MMMMb   6MMMMb `MM 6MMb    `MM. d'     MM      YM.        `MM. d'
+MM      MM  MM'  `Mb 6M'  `Mb MMM9 `Mb    `MMd       MM       YMMMMb     `MMd
+MM      MM  MM    MM MM    MM MM'   MM     dMM.      MM           `Mb     dMM.
+MM      MM  MM    MM MMMMMMMM MM    MM    d'`MM.     MM            MM    d'`MM.
+YM      M9  MM    MM MM       MM    MM   d'  `MM.    MM            MM   d'  `MM.
+ 8b    d8   MM.  ,M9 YM    d9 MM    MM  d'    `MM.   MM    / L    ,M9  d'    `MM.
+  YMMMM9    MMYMMM9   YMMMM9 _MM_  _MM_M(_    _)MM_ _MMMMMMM MYMMMM9 _M(_    _)MM_
+            MM
+            MM
+           _MM_
+
+  Copyright (c) 2018, Kenneth Troldal Balslev
+
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  - Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+  - Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+  - Neither the name of the author nor the
+    names of any contributors may be used to endorse or promote products
+    derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ */
+
+#ifndef OPENXLSX_XLPROPERTIES_HPP
+#define OPENXLSX_XLPROPERTIES_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 <string>
+
+// ===== OpenXLSX Includes ===== //
+#include "OpenXLSX-Exports.hpp"
+#include "XLXmlFile.hpp"
+
+namespace OpenXLSX
+{
+    /**
+     * @brief
+     */
+    class OPENXLSX_EXPORT XLProperties : public XLXmlFile
+    {
+    private:
+        /**
+         * @brief constructor helper function: within docProps/core.xml, cp:coreProperties tag, ensure that the required XML namespaces are defined
+         * @param props the cp:coreProperties node (== document_element())
+         */
+        void ensureXmlNamespaces(XMLNode & props);
+
+        /**
+         * @brief constructor helper function: create core.xml content from template
+         * @param workbook
+         */
+        void createFromTemplate();
+
+        //----------------------------------------------------------------------------------------------------------------------
+        //           Public Member Functions
+        //----------------------------------------------------------------------------------------------------------------------
+
+    public:
+        /**
+         * @brief
+         */
+        XLProperties();
+
+        /**
+         * @brief
+         * @param xmlData
+         */
+        explicit XLProperties(XLXmlData* xmlData);
+
+        /**
+         * @brief copy constructor
+         * @param other
+         */
+        XLProperties(const XLProperties& other);
+
+        /**
+         * @brief move constructor
+         * @param other
+         */
+        XLProperties(XLProperties&& other) noexcept;
+
+        /**
+         * @brief
+         */
+        ~XLProperties();
+
+        /**
+         * @brief copy assignment operator
+         * @param other
+         * @return
+         */
+        XLProperties& operator=(const XLProperties& other);
+
+        /**
+         * @brief move assignment operator
+         * @param other
+         * @return
+         */
+        XLProperties& operator=(XLProperties&& other);
+
+        /**
+         * @brief
+         * @param name
+         * @param value
+         * @return
+         */
+        void setProperty(const std::string& name, const std::string& value);
+
+        /**
+         * @brief
+         * @param name
+         * @param value
+         * @return
+         */
+        void setProperty(const std::string& name, int value);
+
+        /**
+         * @brief
+         * @param name
+         * @param value
+         * @return
+         */
+        void setProperty(const std::string& name, double value);
+
+        /**
+         * @brief
+         * @param name
+         * @return
+         */
+        std::string property(const std::string& name) const;
+
+        /**
+         * @brief
+         * @param name
+         */
+        void deleteProperty(const std::string& name);
+
+        //----------------------------------------------------------------------------------------------------------------------
+        //           Protected Member Functions
+        //----------------------------------------------------------------------------------------------------------------------
+    };
+
+    /**
+     * @brief This class is a specialization of the XLAbstractXMLFile, with the purpose of the representing the
+     * document app properties in the app.xml file (docProps folder) in the .xlsx package.
+     */
+    class OPENXLSX_EXPORT XLAppProperties : public XLXmlFile
+    {
+    private:
+        /**
+         * @brief constructor helper function: within docProps/app.xml, Properties tag, ensure that the required XML namespaces are defined
+         * @param props the Properties node (== document_element())
+         */
+        void ensureXmlNamespaces(XMLNode & props);
+
+        /**
+         * @brief constructor helper function: create app.xml content from template
+         * @param workbook
+         */
+        void createFromTemplate(XMLDocument const & workbookXml);
+
+        //--------------------------------------------------------------------------------------------------------------
+        //           Public Member Functions
+        //--------------------------------------------------------------------------------------------------------------
+
+    public:
+        /**
+         * @brief
+         */
+        XLAppProperties();
+
+        /**
+         * @brief enable XLAppProperties to re-create a worksheet list in docProps/app.xml <TitlesOfParts> element from workbookXml
+         * @param xmlData
+         * @param workbook
+         */
+        explicit XLAppProperties(XLXmlData* xmlData, XMLDocument const & workbookXml);
+
+        /**
+         * @brief
+         * @param xmlData
+         */
+        explicit XLAppProperties(XLXmlData* xmlData);
+
+        /**
+         * @brief copy constructor
+         * @param other
+         */
+        XLAppProperties(const XLAppProperties& other);
+
+        /**
+         * @brief move constructor
+         * @param other
+         */
+        XLAppProperties(XLAppProperties&& other) noexcept;
+
+        /**
+         * @brief
+         */
+        ~XLAppProperties();
+
+        /**
+         * @brief copy assignment operator
+         * @param other
+         * @return
+         */
+        XLAppProperties& operator=(const XLAppProperties& other);
+
+        /**
+         * @brief move assignment operator
+         * @param other
+         * @return
+         */
+        XLAppProperties& operator=(XLAppProperties&& other) noexcept;
+
+        /**
+         * @brief update the "HeadingPairs" entry for "Worksheets" *and* the "TitlesOfParts" vector size
+         * @param increment change the sheet count by this (negative = decrement)
+         * @throws XLInternalError when sheet count would become < 1
+         */
+        void incrementSheetCount(int16_t increment);
+
+        /**
+         * @brief initialize <TitlesOfParts> to contain all and only entries from workbookSheetNames & ensure HeadingPairs entry for Worksheets has the correct count
+         * @param workbookSheetNames the vector of sheet names as returned by XLWorkbook::sheetNames()
+         * @throws XLInternalError thrown by the underlying sheetNames call upon failure
+         */
+        void alignWorksheets(std::vector<std::string> const & workbookSheetNames);
+
+        /**
+         * @brief
+         * @param title
+         * @return
+         */
+        void addSheetName(const std::string& title);
+
+        /**
+         * @brief
+         * @param title
+         */
+        void deleteSheetName(const std::string& title);
+
+        /**
+         * @brief
+         * @param oldTitle
+         * @param newTitle
+         */
+        void setSheetName(const std::string& oldTitle, const std::string& newTitle);
+
+        /**
+         * @brief
+         * @param name
+         * @param value
+         */
+        void addHeadingPair(const std::string& name, int value);
+
+        /**
+         * @brief
+         * @param name
+         */
+        void deleteHeadingPair(const std::string& name);
+
+        /**
+         * @brief
+         * @param name
+         * @param newValue
+         */
+        void setHeadingPair(const std::string& name, int newValue);
+
+        /**
+         * @brief
+         * @param name
+         * @param value
+         * @return
+         */
+        void setProperty(const std::string& name, const std::string& value);
+
+        /**
+         * @brief
+         * @param name
+         * @return
+         */
+        std::string property(const std::string& name) const;
+
+        /**
+         * @brief
+         * @param name
+         */
+        void deleteProperty(const std::string& name);
+
+        /**
+         * @brief
+         * @param sheetName
+         * @return
+         */
+        void appendSheetName(const std::string& sheetName);
+
+        /**
+         * @brief
+         * @param sheetName
+         * @return
+         */
+        void prependSheetName(const std::string& sheetName);
+
+        /**
+         * @brief
+         * @param sheetName
+         * @param index
+         * @return
+         */
+        void insertSheetName(const std::string& sheetName, unsigned int index);
+    };
+
+}    // 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_XLPROPERTIES_HPP

package/thirdparty/OpenXLSX/OpenXLSX/headers/OpenXLSX/XLRelationships.hpp

@@ -0,0 +1,348 @@
+/*
+
+   ____                               ____      ___ ____       ____  ____      ___
+  6MMMMb                              `MM(      )M' `MM'      6MMMMb\`MM(      )M'
+ 8P    Y8                              `MM.     d'   MM      6M'    ` `MM.     d'
+6M      Mb __ ____     ____  ___  __    `MM.   d'    MM      MM        `MM.   d'
+MM      MM `M6MMMMb   6MMMMb `MM 6MMb    `MM. d'     MM      YM.        `MM. d'
+MM      MM  MM'  `Mb 6M'  `Mb MMM9 `Mb    `MMd       MM       YMMMMb     `MMd
+MM      MM  MM    MM MM    MM MM'   MM     dMM.      MM           `Mb     dMM.
+MM      MM  MM    MM MMMMMMMM MM    MM    d'`MM.     MM            MM    d'`MM.
+YM      M9  MM    MM MM       MM    MM   d'  `MM.    MM            MM   d'  `MM.
+ 8b    d8   MM.  ,M9 YM    d9 MM    MM  d'    `MM.   MM    / L    ,M9  d'    `MM.
+  YMMMM9    MMYMMM9   YMMMM9 _MM_  _MM_M(_    _)MM_ _MMMMMMM MYMMMM9 _M(_    _)MM_
+            MM
+            MM
+           _MM_
+
+  Copyright (c) 2018, Kenneth Troldal Balslev
+
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  - Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+  - Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+  - Neither the name of the author nor the
+    names of any contributors may be used to endorse or promote products
+    derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ */
+
+#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 <random>       // std::mt19937
+#include <string>
+#include <vector>
+
+// ===== OpenXLSX Includes ===== //
+#include "OpenXLSX-Exports.hpp"
+#include "XLXmlFile.hpp"
+#include "XLXmlParserForwardDeclarations.hpp"
+
+namespace OpenXLSX
+{
+    /**
+     * @brief Enable use of random (relationship) IDs
+     */
+    void UseRandomIDs();
+
+    /**
+     * @brief Disable use of random (relationship) IDs (default behavior)
+     */
+    void UseSequentialIDs();
+
+    /**
+     * @brief Return a 32 bit random value
+     * @return A 32 bit random value
+     */
+    extern std::mt19937 Rand32;
+
+    /**
+     * @brief Return a 64 bit random value (by invoking Rand32 twice)
+     * @return A 64 bit random value
+     */
+    uint64_t Rand64();
+
+    /**
+     * @brief Initialize XLRand32 data source
+     * @param pseudoRandom If true, sequence will be reproducible with a constant seed
+     */
+    void InitRandom(bool pseudoRandom = false);
+
+
+    class XLRelationships;
+
+    class XLRelationshipItem;
+
+    /**
+     * @brief An enum of the possible relationship (or XML document) types used in relationship (.rels) XML files.
+     */
+    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,
+        Unknown
+    };
+} //     namespace OpenXLSX
+
+namespace OpenXLSX_XLRelationships { // special namespace to avoid naming conflict with another GetStringFromType function
+    using namespace OpenXLSX;
+    /**
+     * @brief helper function, used only within module and from XLProperties.cpp / XLAppProperties::createFromTemplate
+     * @param type the XLRelationshipType for which to return the correct XML string
+     */
+    std::string GetStringFromType(XLRelationshipType type);
+} //    namespace OpenXLSX_XLRelationships
+
+namespace OpenXLSX {
+    /**
+     * @brief An encapsulation of a relationship item, i.e. an XML file in the document, its type and an ID number.
+     */
+    class OPENXLSX_EXPORT XLRelationshipItem
+    {
+    public:    // ---------- Public Member Functions ---------- //
+        /**
+         * @brief
+         */
+        XLRelationshipItem();
+
+        /**
+         * @brief Constructor. New items should only be created through an XLRelationship object.
+         * @param node An XMLNode object with the relationship item. If no input is provided, a null node is used.
+         */
+        explicit XLRelationshipItem(const XMLNode& node);
+
+        /**
+         * @brief Copy Constructor.
+         * @param other Object to be copied.
+         */
+        XLRelationshipItem(const XLRelationshipItem& other);
+
+        /**
+         * @brief Move Constructor.
+         * @param other Object to be moved.
+         */
+        XLRelationshipItem(XLRelationshipItem&& other) noexcept;
+
+        /**
+         * @brief
+         */
+        ~XLRelationshipItem();
+
+        /**
+         * @brief Copy assignment operator.
+         * @param other Right hand side of assignment operation.
+         * @return A reference to the lhs object.
+         */
+        XLRelationshipItem& operator=(const XLRelationshipItem& other);
+
+        /**
+         * @brief Move assignment operator.
+         * @param other Right hand side of assignment operation.
+         * @return A reference to lhs object.
+         */
+        XLRelationshipItem& operator=(XLRelationshipItem&& other) noexcept;
+
+        /**
+         * @brief Get the type of the current relationship item.
+         * @return An XLRelationshipType enum object, corresponding to the type.
+         */
+        XLRelationshipType type() const;
+
+        /**
+         * @brief Get the target, i.e. the path to the XML file the relationship item refers to.
+         * @return An XMLAttribute object containing the Target getValue.
+         */
+        std::string target() const;
+
+        /**
+         * @brief Get the id of the relationship item.
+         * @return An XMLAttribute object containing the Id getValue.
+         */
+        std::string id() const;
+
+        /**
+         * @brief Test if relationship item is empty (== m_relationshipNode->empty())
+         * @return true if this is an empty relationship item
+         */
+        bool empty() const;
+
+    private:                                         // ---------- Private Member Variables ---------- //
+        std::unique_ptr<XMLNode> m_relationshipNode; /**< An XMLNode object with the relationship item */
+    };
+
+    // ================================================================================
+    // XLRelationships Class
+    // ================================================================================
+
+    /**
+     * @brief An encapsulation of relationship files (.rels files) in an Excel document package.
+     */
+    class OPENXLSX_EXPORT XLRelationships : public XLXmlFile
+    {
+    public:    // ---------- Public Member Functions ---------- //
+        /**
+         * @brief Default constructor
+         */
+        XLRelationships();
+
+        /**
+         * @brief Nominal constructor
+         * @param xmlData
+         * @param pathTo Initialize m_path from this: the path to the relationships file origin of xmlData
+         * @note m_path is used to resolve relative relationship target paths to an absolute
+         */
+        explicit XLRelationships(XLXmlData* xmlData, std::string pathTo);
+
+        /**
+         * @brief Destructor
+         */
+        ~XLRelationships();
+
+        /**
+         * @brief copy constructor
+         * @param other
+         */
+        XLRelationships(const XLRelationships& other);
+
+        /**
+         * @brief move constructor
+         * @param other
+         */
+        XLRelationships(XLRelationships&& other) noexcept;
+
+        /**
+         * @brief copy assignment operator
+         * @param other
+         * @return
+         */
+        XLRelationships& operator=(const XLRelationships& other);
+
+        /**
+         * @brief move assignment operator
+         * @param other
+         * @return
+         */
+        XLRelationships& operator=(XLRelationships&& other) noexcept;
+
+        /**
+         * @brief Look up a relationship item by ID.
+         * @param id The ID string of the relationship item to retrieve.
+         * @return An XLRelationshipItem object.
+         */
+        XLRelationshipItem relationshipById(const std::string& id) const;
+
+        /**
+         * @brief Look up a relationship item by Target.
+         * @param target The Target string of the relationship item to retrieve.
+         * @param throwIfNotFound Throw an XLException when target is not found, default: true
+         *                        when false, XLRelationshipItem::empty() can be tested on the return value
+         * @return An XLRelationshipItem object.
+         */
+        XLRelationshipItem relationshipByTarget(const std::string& target, bool throwIfNotFound = true) const;
+
+        /**
+         * @brief Get the std::map with the relationship items, ordered by ID.
+         * @return A const reference to the std::map with relationship items.
+         */
+        std::vector<XLRelationshipItem> relationships() const;
+
+        /**
+         * @brief
+         * @param relID
+         */
+        void deleteRelationship(const std::string& relID);
+
+        /**
+         * @brief Delete an item from the Relationships register
+         * @param item The XLRelationshipItem object to delete.
+         */
+        void deleteRelationship(const XLRelationshipItem& item);
+
+        /**
+         * @brief Add a new relationship item to the XLRelationships object.
+         * @param type The type of the new relationship item.
+         * @param target The target (or path) of the XML file for the relationship item.
+         */
+        XLRelationshipItem addRelationship(XLRelationshipType type, const std::string& target);
+
+        /**
+         * @brief Check if a XLRelationshipItem with the given Target string exists.
+         * @param target The Target string to look up.
+         * @return true if the XLRelationshipItem exists; otherwise false.
+         */
+        bool targetExists(const std::string& target) const;
+
+        /**
+         * @brief Check if a XLRelationshipItem with the given Id string exists.
+         * @param id The Id string to look up.
+         * @return true if the XLRelationshipItem exists; otherwise false.
+         */
+        bool idExists(const std::string& id) const;
+
+        /**
+         * @brief print the XML contents of the relationships document using the underlying XMLNode print function
+         */
+        void print(std::basic_ostream<char>& ostr) const;
+
+        // ---------- Protected Member Functions ---------- //
+    protected:
+
+        //----------------------------------------------------------------------------------------------------------------------
+        //           Private Member Variables
+        //----------------------------------------------------------------------------------------------------------------------
+    private:
+        std::string m_path; // the path - within the XLSX file - to the relationships file on which this object is instantiated
+    };
+}    // 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