react-native-nitro-xlsx 0.2.5 → 0.2.7

package/thirdparty/OpenXLSX/OpenXLSX/sources/XLCellReference.cpp

@@ -0,0 +1,408 @@
+/*
+
+   ____                               ____      ___ ____       ____  ____      ___
+  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.
+
+ */
+
+// ===== External Includes ===== //
+#include <array>
+#include <cmath>
+#ifdef CHARCONV_ENABLED
+#    include <charconv>
+#endif
+#include <cctype>     // std::isdigit
+#include <cstdint>    // pull requests #216, #232
+
+
+// ===== OpenXLSX Includes ===== //
+#include "XLCellReference.hpp"
+#include "XLConstants.hpp"
+#include "XLException.hpp"
+
+using namespace OpenXLSX;
+
+constexpr uint8_t alphabetSize = 26;
+
+constexpr uint8_t asciiOffset = 64;
+
+namespace
+{
+    bool addressIsValid(uint32_t row, uint16_t column)
+    {
+        return !(row < 1 || row > OpenXLSX::MAX_ROWS || column < 1 || column > OpenXLSX::MAX_COLS);
+    }
+}    // namespace
+
+/**
+ * @details The constructor creates a new XLCellReference from a string, e.g. 'A1'. If there's no input,
+ * the default reference will be cell A1.
+ */
+XLCellReference::XLCellReference(const std::string& cellAddress)
+{
+    if (not cellAddress.empty()) setAddress(cellAddress);
+    if (cellAddress.empty() || not addressIsValid(m_row, m_column)) {    // 2024-04-25: throw exception on empty string
+        using namespace std::literals::string_literals;
+        throw XLCellAddressError("Cell reference \""s + cellAddress + "\" is invalid"s);
+        // ===== 2024-05-27: below code is obsolete due to exception on invalid cellAddress
+        // m_row         = 1;
+        // m_column      = 1;
+        // m_cellAddress = "A1";
+    }
+}
+
+/**
+ * @details This constructor creates a new XLCellReference from a given row and column number, e.g. 1,1 (=A1)
+ * @todo consider swapping the arguments.
+ */
+XLCellReference::XLCellReference(uint32_t row, uint16_t column)
+{
+    if (!addressIsValid(row, column)) throw XLCellAddressError("Cell reference is invalid");
+    setRowAndColumn(row, column);
+}
+
+/**
+ * @details This constructor creates a new XLCellReference from a row number and the column name (e.g. 1, A)
+ * @todo consider swapping the arguments.
+ */
+XLCellReference::XLCellReference(uint32_t row, const std::string& column)
+{
+    if (!addressIsValid(row, columnAsNumber(column))) throw XLCellAddressError("Cell reference is invalid");
+    setRowAndColumn(row, columnAsNumber(column));
+}
+
+/**
+ * @details explicit copy constructor to avoid confusion when reading code later (default copy constructor would work for trivial members)
+ */
+XLCellReference::XLCellReference(const XLCellReference& other)
+ : m_row(other.m_row),
+   m_column(other.m_column),
+   m_cellAddress(other.m_cellAddress)
+ {}
+
+/**
+ * @details default move constructor
+ */
+XLCellReference::XLCellReference(XLCellReference&& other) noexcept = default;
+
+/**
+ * @details default destructor
+ */
+XLCellReference::~XLCellReference() = default;
+
+/**
+ * @details explicit copy assignment operator to avoid confusion when reading code later (default would work for trivial members)
+ */
+XLCellReference& XLCellReference::operator=(const XLCellReference& other)
+{
+    if (&other != this) {
+        XLCellReference temp = other;  // copy-construct
+        *this = std::move(temp);       // move-assign & invalidate temp
+    }
+    return *this;
+}
+
+/**
+ * @details default move assignment
+ */
+XLCellReference& XLCellReference::operator=(XLCellReference&& other) noexcept = default;
+
+/**
+ * @details
+ */
+XLCellReference& XLCellReference::operator++()
+{
+    if (m_column < MAX_COLS) {
+        setColumn(m_column + 1);
+    }
+    else if (m_column == MAX_COLS && m_row < MAX_ROWS) {
+        m_column = 1;
+        setRow(m_row + 1);
+    }
+    else if (m_column == MAX_COLS && m_row == MAX_ROWS) {
+        m_column      = 1;
+        m_row         = 1;
+        m_cellAddress = "A1";
+    }
+
+    return *this;
+}
+
+/**
+ * @details
+ */
+XLCellReference XLCellReference::operator++(int)
+{    // NOLINT
+    auto oldRef(*this);
+    ++(*this);
+    return oldRef;
+}
+
+/**
+ * @details
+ */
+XLCellReference& XLCellReference::operator--()
+{
+    if (m_column > 1) {
+        setColumn(m_column - 1);
+    }
+    else if (m_column == 1 && m_row > 1) {
+        m_column = MAX_COLS;
+        setRow(m_row - 1);
+    }
+    else if (m_column == 1 && m_row == 1) {
+        m_column      = MAX_COLS;
+        m_row         = MAX_ROWS;
+        m_cellAddress = "XFD1048576";    // this address represents the very last cell that an excel spreadsheet can reference / support
+    }
+    return *this;
+}
+
+/**
+ * @details
+ */
+XLCellReference XLCellReference::operator--(int)
+{    // NOLINT
+    auto oldRef(*this);
+    --(*this);
+    return oldRef;
+}
+
+/**
+ * @details Returns the m_row property.
+ */
+uint32_t XLCellReference::row() const { return m_row; }
+
+/**
+ * @details Sets the row of the XLCellReference objects. If the number is larger than 16384 (the maximum),
+ * the row is set to 16384.
+ */
+void XLCellReference::setRow(uint32_t row)
+{
+    if (!addressIsValid(row, m_column)) throw XLCellAddressError("Cell reference is invalid");
+
+    m_row         = row;
+    m_cellAddress = columnAsString(m_column) + rowAsString(m_row);
+}
+
+/**
+ * @details Returns the m_column property.
+ */
+uint16_t XLCellReference::column() const { return m_column; }
+
+/**
+ * @details Sets the column of the XLCellReference object. If the number is larger than 1048576 (the maximum),
+ * the column is set to 1048576.
+ */
+void XLCellReference::setColumn(uint16_t column)
+{
+    if (!addressIsValid(m_row, column)) throw XLCellAddressError("Cell reference is invalid");
+
+    m_column      = column;
+    m_cellAddress = columnAsString(m_column) + rowAsString(m_row);
+}
+
+/**
+ * @details Sets row and column of the XLCellReference object. Checks that row and column is less than
+ * or equal to the maximum row and column numbers allowed by Excel.
+ */
+void XLCellReference::setRowAndColumn(uint32_t row, uint16_t column)
+{
+    if (!addressIsValid(row, column)) throw XLCellAddressError("Cell reference is invalid");
+
+    m_row         = row;
+    m_column      = column;
+    m_cellAddress = columnAsString(m_column) + rowAsString(m_row);
+}
+
+/**
+ * @details Returns the m_cellAddress property.
+ */
+std::string XLCellReference::address() const { return m_cellAddress; }
+
+/**
+ * @details Sets the address of the XLCellReference object, e.g. 'B2'. Checks that row and column is less than
+ * or equal to the maximum row and column numbers allowed by Excel.
+ */
+void XLCellReference::setAddress(const std::string& address)
+{
+    const auto [fst, snd] = coordinatesFromAddress(address);
+    m_row            = fst;
+    m_column         = snd;
+    m_cellAddress    = address;
+}
+
+/**
+ * @details
+ */
+std::string XLCellReference::rowAsString(uint32_t row)
+{
+#ifdef CHARCONV_ENABLED
+    std::array<char, 7> str {};    // NOLINT
+    const auto*         p = std::to_chars(str.data(), str.data() + str.size(), row).ptr;
+    return std::string { str.data(), static_cast<uint16_t>(p - str.data()) };
+#else
+    std::string result;
+    while (row != 0) {
+        int rem = row % 10;
+        result += (rem > 9) ? (rem - 10) + 'a' : rem + '0';
+        row = row / 10;
+    }
+
+    for (unsigned int i = 0; i < result.length() / 2; i++) std::swap(result[i], result[result.length() - i - 1]);
+
+    return result;
+#endif
+}
+
+/**
+ * @details
+ */
+uint32_t XLCellReference::rowAsNumber(const std::string& row)
+{
+#ifdef CHARCONV_ENABLED
+    uint32_t value = 0;
+    std::from_chars(row.data(), row.data() + row.size(), value);    // NOLINT
+    return value;
+#else
+    return stoul(row);
+#endif
+}
+
+/**
+ * @details Helper method to calculate the column letter from column number.
+ */
+std::string XLCellReference::columnAsString(uint16_t column)
+{
+    std::string result;
+
+    // ===== If there is one letter in the Column Name:
+    if (column <= alphabetSize) result += static_cast<char>(column + asciiOffset);
+
+    // ===== If there are two letters in the Column Name:
+    else if (column > alphabetSize && column <= alphabetSize * (alphabetSize + 1)) {
+        result += static_cast<char>((column - (alphabetSize + 1)) / alphabetSize + asciiOffset + 1);
+        result += static_cast<char>((column - (alphabetSize + 1)) % alphabetSize + asciiOffset + 1);
+    }
+
+    // ===== If there are three letters in the Column Name:
+    else {
+        result += static_cast<char>((column - 703) / (alphabetSize * alphabetSize) + asciiOffset + 1);    // NOLINT
+        result += static_cast<char>(((column - 703) / alphabetSize) % alphabetSize + asciiOffset + 1);    // NOLINT
+        result += static_cast<char>((column - 703) % alphabetSize + asciiOffset + 1);                     // NOLINT
+    }
+
+    return result;
+}
+
+/**
+ * @details Helper method to calculate the column number from column letter.
+ * @throws XLInputError
+ * @note 2024-06-03: added check for valid address
+ */
+uint16_t XLCellReference::columnAsNumber(const std::string& column)
+{
+    uint64_t letterCount = 0;
+    uint32_t colNo = 0;
+    for (const auto letter : column) {
+        if (letter >= 'A' && letter <= 'Z') {    // allow only uppercase letters
+            ++letterCount;
+            colNo = colNo * 26 + (letter - 'A' + 1);
+        }
+        else
+            break;
+    }
+
+    // ===== If the full string was decoded and colNo is within allowed range [1;MAX_COLS]
+    if(letterCount == column.length() && colNo > 0 && colNo <= MAX_COLS)
+        return colNo;
+    throw XLInputError("XLCellReference::columnAsNumber - column \"" + column + "\" is invalid");
+
+    /* 2024-06-19 OBSOLETE CODE:
+    // uint16_t result = 0;
+    // uint16_t factor = 1;
+    // 
+    // for (int16_t i = static_cast<int16_t>(column.size() - 1); i >= 0; --i) {
+    //     result += static_cast<uint16_t>((column[static_cast<uint64_t>(i)] - asciiOffset) * factor);
+    //     factor *= alphabetSize;
+    // }
+    // 
+    // return result;
+    */
+}
+
+/**
+ * @details Helper method for calculating the coordinates from the cell address.
+ * @throws XLInputError
+ * @note 2024-06-03: added check for valid address
+ */
+XLCoordinates XLCellReference::coordinatesFromAddress(const std::string& address)
+{
+    uint64_t letterCount = 0;
+    uint32_t colNo = 0;
+    for (const auto letter : address) {
+        if (letter >= 'A' && letter <= 'Z') {    // allow only uppercase letters
+            ++letterCount;
+            colNo = colNo * 26 + (letter - 'A' + 1);
+        }
+        else
+            break;
+    }
+
+    // ===== If address contains between 1 and 3 letters and has at least 1 more character for the row
+    if(colNo > 0 && colNo <= MAX_COLS && address.length() > letterCount) {
+        size_t pos = letterCount;
+        uint64_t rowNo = 0;
+        for (; pos < address.length() && std::isdigit(address[pos]); ++pos) // check digits
+            rowNo = rowNo * 10 + (address[pos] - '0');
+        if (pos == address.length() && rowNo <= MAX_ROWS)    // full address was < 4 letters + only digits
+            return std::make_pair(rowNo, colNo);
+    }
+    throw XLInputError("XLCellReference::coordinatesFromAddress - address \"" + address + "\" is invalid");
+
+    /* 2024-06-19 OBSOLETE CODE
+    // auto it = std::find_if(address.begin(), address.end(), ::isdigit);
+    // auto columnPart = std::string(address.begin(), it);
+    // auto rowPart = std::string(it, address.end());
+    //
+    // return std::make_pair(rowAsNumber(rowPart), columnAsNumber(columnPart));
+    */
+}