react-native-nitro-xlsx 0.2.5 → 0.2.7

package/thirdparty/OpenXLSX/OpenXLSX/headers/XLComments.hpp

@@ -0,0 +1,270 @@
+/*
+
+   ____                               ____      ___ ____       ____  ____      ___
+  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_XLCOMMENTS_HPP
+#define OPENXLSX_XLCOMMENTS_HPP
+
+// ===== External Includes ===== //
+#include <cstdint>    // uint8_t, uint16_t, uint32_t
+#include <ostream>    // std::basic_ostream
+
+// ===== OpenXLSX Includes ===== //
+#include "OpenXLSX-Exports.hpp"
+// #include "XLDocument.hpp"
+#include "XLDrawing.hpp"   // XLVmlDrawing
+#include "XLException.hpp"
+#include "XLXmlData.hpp"
+#include "XLXmlFile.hpp"
+
+// TODO:
+//   add to [Content_Types].xml:
+//     <Override PartName="/xl/comments1.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml"/>
+
+namespace OpenXLSX
+{
+    /**
+     * @brief An encapsulation of a comment element
+     */
+    class OPENXLSX_EXPORT XLComment
+    {
+    public:    // ---------- Public Member Functions ---------- //
+        /**
+         * @brief
+         */
+        XLComment() = delete; // do not allow default constructor (for now) - could still be constructed with an empty XMLNode
+
+        /**
+         * @brief Constructor. New items should only be created through an XLComments object.
+         * @param node An XMLNode object with the comment XMLNode. If no input is provided, a null node is used.
+         */
+        explicit XLComment(const XMLNode& node);
+
+        /**
+         * @brief Copy Constructor.
+         * @param other Object to be copied.
+         */
+        XLComment(const XLComment& other);
+
+        /**
+         * @brief Move Constructor.
+         * @param other Object to be moved.
+         */
+        XLComment(XLComment&& other) noexcept;
+
+        /**
+         * @brief
+         */
+        ~XLComment();
+
+        /**
+         * @brief Copy assignment operator.
+         * @param other Right hand side of assignment operation.
+         * @return A reference to the lhs object.
+         */
+        XLComment& operator=(const XLComment& other);
+
+        /**
+         * @brief Move assignment operator.
+         * @param other Right hand side of assignment operation.
+         * @return A reference to lhs object.
+         */
+        XLComment& operator=(XLComment&& other) noexcept;
+
+        /**
+         * @brief Test if XLComment is linked to valid XML
+         * @return true if comment was constructed on a valid XML node, otherwise false
+         */
+        bool valid() const;
+
+        /**
+         * @brief Getter functions
+         */
+        std::string ref() const; // the cell reference of the comment
+        std::string text() const;
+        uint16_t authorId() const;
+
+        /**
+         * @brief Setter functions
+         */
+        bool setText(std::string newText);
+        bool setAuthorId(uint16_t newAuthorId);
+
+        // /**
+        //  * @brief Return a string summary of the comment properties
+        //  * @return string with info about the comment object
+        //  */
+        // std::string summary() const;
+
+    private:                                         // ---------- Private Member Variables ---------- //
+        std::unique_ptr<XMLNode> m_commentNode;      /**< An XMLNode object with the comment item */
+     };
+
+    /**
+     * @brief The XLComments class is the base class for worksheet comments
+     */
+    class OPENXLSX_EXPORT XLComments : public XLXmlFile
+    {
+        friend class XLWorksheet;   // for access to XLXmlFile::getXmlPath
+    public:
+        /**
+         * @brief Constructor
+         */
+        XLComments();
+
+        /**
+         * @brief The constructor.
+         * @param xmlData the source XML of the comments file
+         */
+        XLComments(XLXmlData* xmlData);
+
+        /**
+         * @brief The copy constructor.
+         * @param other The object to be copied.
+         */
+        XLComments(const XLComments& other);
+
+        /**
+         * @brief
+         * @param other
+         */
+        XLComments(XLComments&& other) noexcept;
+
+        /**
+         * @brief The destructor
+         */
+        ~XLComments();
+
+        /**
+         * @brief
+         * @param other
+         * @return
+         */
+        XLComments& operator=(XLComments&& other) noexcept;
+
+        /**
+         * @brief Assignment operator
+         * @return A reference to the new object.
+         */
+        XLComments& operator=(const XLComments&);
+
+        /**
+         * @brief associate the worksheet's VML drawing object with the comments so it can be modified from here
+         * @param vmlDrawing the worksheet's previously created XLVmlDrawing object
+         * @return true upon success
+         */
+        bool setVmlDrawing(XLVmlDrawing &vmlDrawing);
+
+    private: // helper functions with repeating code
+        XMLNode authorNode(uint16_t index) const;
+        XMLNode commentNode(size_t index) const;
+        XMLNode commentNode(const std::string& cellRef) const;
+
+    public:
+
+        uint16_t authorCount() const;
+
+        std::string author(uint16_t index) const;
+
+        bool deleteAuthor(uint16_t index);
+
+        uint16_t addAuthor(const std::string& authorName);
+
+        /**
+         * @brief get the amount of comments
+         * @return the amount of comments for the worksheet
+         */
+        size_t count() const;
+
+        uint16_t authorId(const std::string& cellRef) const;
+
+        bool deleteComment(const std::string& cellRef);
+
+        /**
+         * @brief get a comment by its index in the comment list
+         * @param index the index of the comment as per XML sequence, no guarantee about cell reference being in sequence
+         * @return the comment at index - will throw if index is out of bounds (>=count())
+         */
+        XLComment get(size_t index) const;
+
+        /**
+         * @brief get the comment (if any) for the referenced cell
+         * @param cellRef the cell address to check
+         * @return the comment for this cell - an empty string if no comment is set
+         */
+        std::string get(std::string const& cellRef) const;
+
+        /**
+         * @brief set the comment for the referenced cell
+         * @param cellRef the cell address to set
+         * @param comment set this text as comment for the cell
+         * @param authorId_ set this author (underscore to avoid conflict with function name)
+         * @return true upon success, false on failure
+         */
+        bool set(std::string const& cellRef, std::string const& comment, uint16_t authorId_ = 0);
+
+        /**
+         * @brief get the XLShape object for this comment
+         */
+        XLShape shape(std::string const& cellRef);
+
+        /**
+         * @brief Print the XML contents of this XLComments instance using the underlying XMLNode print function
+         */
+        void print(std::basic_ostream<char>& ostr) const;
+
+    private:
+        std::unique_ptr<XMLNode> m_authors;
+        std::unique_ptr<XMLNode> m_commentList;
+        std::unique_ptr<XLVmlDrawing> m_vmlDrawing;
+        mutable std::unique_ptr<XMLNode> m_hintNode;  // the last comment XML Node accessed by index is stored here, if any - will be reset when comments are inserted or deleted
+        mutable size_t m_hintIndex;                   // this has the index at which m_hintNode was accessed, only valid if not m_hintNode.empty()
+        inline static const std::vector< std::string_view > m_nodeOrder = {      // comments XML node required child sequence
+            "authors",
+            "commentList"
+        };
+    };
+}    // namespace OpenXLSX
+
+#endif    // OPENXLSX_XLCOMMENTS_HPP

package/thirdparty/OpenXLSX/OpenXLSX/headers/XLConstants.hpp

@@ -0,0 +1,18 @@
+//
+// Created by Kenneth Balslev on 15/08/2021.
+//
+
+#ifndef OPENXLSX_XLCONSTANTS_HPP
+#define OPENXLSX_XLCONSTANTS_HPP
+
+namespace OpenXLSX
+{
+    inline constexpr uint16_t MAX_COLS = 16'384;
+    inline constexpr uint32_t MAX_ROWS = 1'048'576;
+
+    // anchoring a comment shape below these values was not possible in LibreOffice - TBC with MS Office
+    inline constexpr uint16_t MAX_SHAPE_ANCHOR_COLUMN = 13067;  // column "SHO"
+    inline constexpr uint32_t MAX_SHAPE_ANCHOR_ROW    = 852177;
+}    // namespace OpenXLSX
+
+#endif    // OPENXLSX_XLCONSTANTS_HPP

package/thirdparty/OpenXLSX/OpenXLSX/headers/XLContentTypes.hpp

@@ -0,0 +1,264 @@
+/*
+
+   ____                               ____      ___ ____       ____  ____      ___
+  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_XLCONTENTTYPES_HPP
+#define OPENXLSX_XLCONTENTTYPES_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 <cstdint> // uint8_t
+#include <memory>
+#include <string>
+#include <vector>
+
+// ===== OpenXLSX Includes ===== //
+#include "OpenXLSX-Exports.hpp"
+#include "XLXmlFile.hpp"
+#include "XLXmlParserForwardDeclarations.hpp"
+
+namespace OpenXLSX
+{
+    /**
+     * @brief
+     */
+    enum class XLContentType : uint8_t {
+        Workbook,
+        Relationships,
+        WorkbookMacroEnabled,
+        Worksheet,
+        Chartsheet,
+        ExternalLink,
+        Theme,
+        Styles,
+        SharedStrings,
+        Drawing,
+        Chart,
+        ChartStyle,
+        ChartColorStyle,
+        ControlProperties,
+        CalculationChain,
+        VBAProject,
+        CoreProperties,
+        ExtendedProperties,
+        CustomProperties,
+        Comments,
+        Table,
+        VMLDrawing,
+        Unknown
+    };
+
+    /**
+     * @brief utility function: determine the name of an XLContentType value
+     * @param type the XLContentType to get a name for
+     * @return a string with the name of type
+     */
+    std::string XLContentTypeToString( XLContentType type );
+
+    /**
+     * @brief
+     */
+    class OPENXLSX_EXPORT XLContentItem
+    {
+        friend class XLContentTypes;
+
+    public:    // ---------- Public Member Functions ---------- //
+        /**
+         * @brief
+         */
+        XLContentItem();
+
+        /**
+         * @brief
+         * @param node
+         */
+        explicit XLContentItem(const XMLNode& node);
+
+        /**
+         * @brief
+         */
+        ~XLContentItem();
+
+        /**
+         * @brief
+         * @param other
+         * @return
+         */
+        XLContentItem(const XLContentItem& other);
+
+        /**
+         * @brief
+         * @param other
+         * @return
+         */
+        XLContentItem(XLContentItem&& other) noexcept;
+
+        /**
+         * @brief
+         * @param other
+         * @return
+         */
+        XLContentItem& operator=(const XLContentItem& other);
+
+        /**
+         * @brief
+         * @param other
+         * @return
+         */
+        XLContentItem& operator=(XLContentItem&& other) noexcept;
+
+        /**
+         * @brief
+         * @return
+         */
+        XLContentType type() const;
+
+        /**
+         * @brief
+         * @return
+         */
+        std::string path() const;
+
+    private:
+        std::unique_ptr<XMLNode> m_contentNode; /**< */
+    };
+
+    // ================================================================================
+    // XLContentTypes Class
+    // ================================================================================
+
+    /**
+     * @brief The purpose of this class is to load, store add and save item in the [Content_Types].xml file.
+     */
+    class OPENXLSX_EXPORT XLContentTypes : public XLXmlFile
+    {
+    public:    // ---------- Public Member Functions ---------- //
+        /**
+         * @brief
+         */
+        XLContentTypes();
+
+        /**
+         * @brief
+         * @param xmlData
+         */
+        explicit XLContentTypes(XLXmlData* xmlData);
+
+        /**
+         * @brief Destructor
+         */
+        ~XLContentTypes();
+
+        /**
+         * @brief
+         * @param other
+         */
+        XLContentTypes(const XLContentTypes& other);
+
+        /**
+         * @brief
+         * @param other
+         */
+        XLContentTypes(XLContentTypes&& other) noexcept;
+
+        /**
+         * @brief
+         * @param other
+         * @return
+         */
+        XLContentTypes& operator=(const XLContentTypes& other);
+
+        /**
+         * @brief
+         * @param other
+         * @return
+         */
+        XLContentTypes& operator=(XLContentTypes&& other) noexcept;
+
+        /**
+         * @brief Add a new override key/getValue pair to the data store.
+         * @param path The key
+         * @param type The getValue
+         */
+        void addOverride(const std::string& path, XLContentType type);
+
+        /**
+         * @brief
+         * @param path
+         */
+        void deleteOverride(const std::string& path);
+
+        /**
+         * @brief
+         * @param item
+         */
+        void deleteOverride(const XLContentItem& item);
+
+        /**
+         * @brief
+         * @param path
+         * @return
+         */
+        XLContentItem contentItem(const std::string& path);
+
+        /**
+         * @brief
+         * @return
+         */
+        std::vector<XLContentItem> getContentItems();
+
+    private:   // ---------- Private Member Variables ---------- //
+    };
+}    // 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_XLCONTENTTYPES_HPP