XLConstants.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLCONSTANTS_HPP
#define OPENXLSX_XLCONSTANTS_HPP
 
#include <cstdint>
 
namespace OpenXLSX
{
    inline constexpr uint16_t MAX_COLS = 16'384;
    inline constexpr uint32_t MAX_ROWS = 1'048'576;
 
    struct XLRowIndex
    {
        uint32_t val;
        explicit XLRowIndex(uint32_t v) : val(v) {}
        operator uint32_t() const { return val; }
    };
 
    struct XLColIndex
    {
        uint16_t val;
        explicit XLColIndex(uint16_t v) : val(v) {}
        operator uint16_t() const { return val; }
    };
 
    inline namespace IndexLiterals
    {
        inline XLRowIndex operator""_row(unsigned long long v) { return XLRowIndex(static_cast<uint32_t>(v)); }
        inline XLColIndex operator""_col(unsigned long long v) { return XLColIndex(static_cast<uint16_t>(v)); }
    }    // namespace IndexLiterals
 
    class XLDistance
    {
    public:
        XLDistance() = default;
        static XLDistance Pixels(uint32_t px) { return XLDistance(static_cast<uint64_t>(px) * 9525); }
        static XLDistance Centimeters(double cm) { return XLDistance(static_cast<uint64_t>(cm * 360000.0)); }
        static XLDistance Inches(double inch) { return XLDistance(static_cast<uint64_t>(inch * 914400.0)); }
 
        static XLDistance Points(double pt) { return XLDistance(static_cast<uint64_t>(pt * 12700.0)); }
        static XLDistance EMU(uint64_t emu) { return XLDistance(emu); }
 
        [[nodiscard]] uint64_t getEMU() const { return m_emu; }
        [[nodiscard]] uint32_t getPixels() const { return static_cast<uint32_t>(m_emu / 9525); }
        [[nodiscard]] double   getInches() const { return static_cast<double>(m_emu) / 914400.0; }
 
    private:
        explicit XLDistance(uint64_t emu) : m_emu(emu) {}
        uint64_t m_emu{0};
    };
 
    inline namespace DistanceLiterals
    {
        inline XLDistance operator""_px(unsigned long long px) { return XLDistance::Pixels(static_cast<uint32_t>(px)); }
        inline XLDistance operator""_cm(long double cm) { return XLDistance::Centimeters(static_cast<double>(cm)); }
        inline XLDistance operator""_cm(unsigned long long cm) { return XLDistance::Centimeters(static_cast<double>(cm)); }
 
        inline XLDistance operator""_inch(long double inch) { return XLDistance::Inches(static_cast<double>(inch)); }
        inline XLDistance operator""_inch(unsigned long long inch) { return XLDistance::Inches(static_cast<double>(inch)); }
 
        inline XLDistance operator""_pt(long double pt) { return XLDistance::Points(static_cast<double>(pt)); }
        inline XLDistance operator""_pt(unsigned long long pt) { return XLDistance::Points(static_cast<double>(pt)); }
 
    }    // namespace DistanceLiterals
 
    // 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