XLCellReference.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLCELLREFERENCE_HPP
#define OPENXLSX_XLCELLREFERENCE_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>    // Pull request #276
#include <string>
#include <string_view>
#include <utility>
 
// ===== OpenXLSX Includes ===== //
#include "OpenXLSX-Exports.hpp"
 
namespace OpenXLSX
{
    struct XLCoordinates
    {
        uint32_t row;
        uint16_t column;
    };
 
    class OPENXLSX_EXPORT XLCellReference final
    {
        friend bool operator==(const XLCellReference& lhs, const XLCellReference& rhs) noexcept;
        friend bool operator!=(const XLCellReference& lhs, const XLCellReference& rhs) noexcept;
        friend bool operator<(const XLCellReference& lhs, const XLCellReference& rhs) noexcept;
        friend bool operator>(const XLCellReference& lhs, const XLCellReference& rhs) noexcept;
        friend bool operator<=(const XLCellReference& lhs, const XLCellReference& rhs) noexcept;
        friend bool operator>=(const XLCellReference& lhs, const XLCellReference& rhs) noexcept;
 
        //----------------------------------------------------------------------------------------------------------------------
        //           Public Member Functions
        //----------------------------------------------------------------------------------------------------------------------
 
    public:
        XLCellReference(std::string_view cellAddress = "");    // NOLINT
 
        XLCellReference(uint32_t row, uint16_t column);
 
        XLCellReference(uint32_t row, std::string_view column);
 
        XLCellReference(const XLCellReference& other);
 
        XLCellReference(XLCellReference&& other) noexcept;
 
        ~XLCellReference();
 
        XLCellReference& operator=(const XLCellReference& other);
 
        XLCellReference& operator=(XLCellReference&& other) noexcept;
 
        XLCellReference& operator++();
 
        XLCellReference operator++(int);    // NOLINT
 
        XLCellReference& operator--();
 
        XLCellReference operator--(int);    // NOLINT
 
        uint32_t row() const noexcept;
 
        void setRow(uint32_t row);
 
        uint16_t column() const noexcept;
 
        void setColumn(uint16_t column);
 
        void setRowAndColumn(uint32_t row, uint16_t column);
 
        std::string address() const;
 
        void setAddress(std::string_view address);
 
        //----------------------------------------------------------------------------------------------------------------------
        //           Private Member Functions
        //----------------------------------------------------------------------------------------------------------------------
 
        // private:
 
        static std::string rowAsString(uint32_t row);
 
        static uint32_t rowAsNumber(std::string_view row);
 
        static std::string columnAsString(uint16_t column);
 
        static uint16_t columnAsNumber(std::string_view column);
 
        static XLCoordinates coordinatesFromAddress(std::string_view address);
 
        //----------------------------------------------------------------------------------------------------------------------
        //           Private Member Variables
        //----------------------------------------------------------------------------------------------------------------------
    private:
        uint32_t    m_row{1};            
        uint16_t    m_column{1};         
        std::string m_cellAddress{"A1"}; 
    };
 
    inline bool operator==(const XLCellReference& lhs, const XLCellReference& rhs) noexcept
    { return lhs.row() == rhs.row() and lhs.column() == rhs.column(); }
 
    inline bool operator!=(const XLCellReference& lhs, const XLCellReference& rhs) noexcept { return !(lhs == rhs); }
 
    inline bool operator<(const XLCellReference& lhs, const XLCellReference& rhs) noexcept
    { return lhs.row() < rhs.row() or (lhs.row() <= rhs.row() and lhs.column() < rhs.column()); }
 
    inline bool operator>(const XLCellReference& lhs, const XLCellReference& rhs) noexcept { return (rhs < lhs); }
 
    inline bool operator<=(const XLCellReference& lhs, const XLCellReference& rhs) noexcept { return !(lhs > rhs); }
 
    inline bool operator>=(const XLCellReference& lhs, const XLCellReference& rhs) noexcept { return !(lhs < rhs); }
}    // 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_XLCELLREFERENCE_HPP