XLCommandQuery.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLCOMMANDQUERY_HPP
#define OPENXLSX_XLCOMMANDQUERY_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 <any>
#include <cstdint>    // uint8_t
#include <map>
#include <string>
 
namespace OpenXLSX
{
    enum class XLCommandType : uint8_t {
        SetSheetName,
        SetSheetVisibility,
        SetSheetIndex,
        SetSheetActive,
        ResetCalcChain,
        SetFullCalcOnLoad,
        CheckAndFixCoreProperties,
        CheckAndFixExtendedProperties,
        CheckAndFixCustomProperties,
        AddSharedStrings,
        AddWorksheet,
        AddChartsheet,
        DeleteSheet,
        CloneSheet,
        AddStyles
    };
 
    class XLCommand
    {
    public:
        explicit XLCommand(XLCommandType type) : m_type(type) {}
 
        template<typename T>
        XLCommand& setParam(const std::string& param, T value)
        {
            m_params[param] = value;
            return *this;
        }
 
        template<typename T>
        T getParam(const std::string& param) const
        { return std::any_cast<T>(m_params.at(param)); }
 
        XLCommandType type() const { return m_type; }
 
    private:
        XLCommandType                   m_type;   /*< */
        std::map<std::string, std::any> m_params; /*< */
    };
 
    enum class XLQueryType : uint8_t {
        QuerySheetName,
        QuerySheetIndex,
        QuerySheetVisibility,
        QuerySheetIsActive,
        QuerySheetType,
        QuerySheetID,
        QuerySheetRelsID,
        QuerySheetRelsTarget,
        QuerySharedStrings,
        QueryXmlData
    };
 
    class XLQuery
    {
    public:
        explicit XLQuery(XLQueryType type) : m_type(type) {}
 
        template<typename T>
        XLQuery& setParam(const std::string& param, T value)
        {
            m_params[param] = value;
            return *this;
        }
 
        template<typename T>
        T getParam(const std::string& param) const
        { return std::any_cast<T>(m_params.at(param)); }
 
        template<typename T>
        XLQuery& setResult(T value)
        {
            m_result = value;
            return *this;
        }
 
        template<typename T>
        T result() const
        { return std::any_cast<T>(m_result); }
 
        XLQueryType type() const { return m_type; }
 
    private:
        XLQueryType                     m_type;   /*< */
        std::any                        m_result; /*< */
        std::map<std::string, std::any> m_params; /*< */
    };
 
}    // 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_XLCOMMANDQUERY_HPP