XLNumberFormatter.hpp

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <vector>
#include "XLCellValue.hpp"
 
namespace OpenXLSX {
 
    // TokenType for formatting instructions
    enum class XLFormatTokenType {
        Literal,      // Literal string/character (e.g., "-", "/", " ", text)
        Year,         // yy or yyyy
        Month,        // m, mm, mmm, mmmm, mmmmm
        Day,          // d, dd, ddd, dddd
        Hour,         // h, hh
        Minute,       // m, mm (resolved via context)
        Second,       // s, ss
        AMPM,         // AM/PM, A/P
        DigitZero,    // 0 (forced digit, zero padded)
        DigitOpt,     // # (optional digit)
        Decimal,      // . (decimal point)
        Thousands,    // , (thousands separator)
        Percent,      // % (multiply value by 100)
        TextPlaceholder // @ (text placeholder)
    };
 
    // FormatToken represents a parsed chunk of the format string
    struct XLFormatToken {
        XLFormatTokenType type;
        std::string value;    // Holds the original placeholder string or literal text
        int count;            // Number of characters in the placeholder (e.g., "yyyy" = 4)
    };
 
    // FormatSection represents a single section of a multi-section format string
    struct FormatSection {
        std::vector<XLFormatToken> tokens;
        bool isDateTime{false};
        bool isNumeric{false};
        bool hasPercent{false};
        int decimalPlaces{0};
    };
 
    // XLNumberFormatter parses an Excel number format string and applies it to an XLCellValue
    class XLNumberFormatter {
    public:
        explicit XLNumberFormatter(const std::string& formatString);
 
        std::string format(const XLCellValue& value) const;
 
    private:
        std::string m_formatString;
        std::vector<FormatSection> m_sections;
 
        // Core parsing phase
        void parse();
        void parseSection(const std::string& sectionStr);
 
        // Formatting subroutines
        std::string formatDateTime(double excelDate, const FormatSection& section) const;
        std::string formatNumeric(double number, const FormatSection& section, bool addMinusSign) const;
        std::string formatText(const std::string& text, const FormatSection& section) const;
    };
 
} // namespace OpenXLSX