base.h

/*
 * openSF Integration Libraries (OSFI)
 * Deimos Space, S.L.U.
 * 
 * This file is part of OSFI. OSFI is free software; you can redistribute it
 * and/or modify it under the terms of the 'ESA Software Community Licence Permissive' as
 * published by the European Space Agency; either version 2.4 of the License,
 * or (at your option) any later version. You should have received a
 * copy of the 'ESA Software Community Licence Permissive - v2.4' along with this program
 * or one can be found at <http://eop-cfi.esa.int/index.php/docs-and-mission-data/licensing-documents>.
 *
 * @file
 * @brief OSFI-C++ header common to many classes in the ConFM module.
 */
 
#ifndef OSFI_CONFM_BASE_H_
#define OSFI_CONFM_BASE_H_
 
#if __cplusplus >= 201402L
 
# define OSFI_DEPRECATED(reason) [[deprecated(reason)]]
#else
# define OSFI_DEPRECATED(reason) /*deprecated*/
#endif
 
#include <string>
#include <vector>
#include <iosfwd>
#include <utility>
#include <cstdint>
 
namespace osfi {
    namespace confm {
        enum class ElementType {
            INTEGER = 1,
            FLOAT, BOOLEAN, STRING, FILE, FOLDER, TIME
        };
        std::string to_string(ElementType et);
        ElementType as_ElementType(const std::string& str);
 
        struct TimeValue {
            std::int16_t year;
            std::int8_t  month, dom, hour, minute, sec;
            std::int32_t nanosec;
            // TODO in the future, implement operator<=> for C++20-compliant compilers
            // auto operator<=>(const TimeValue& other) const = default;
        };
        std::string to_string(const TimeValue&);
        std::ostream& operator<<(std::ostream&, const TimeValue&);
        bool operator==(const TimeValue& a, const TimeValue& b);
        bool operator<(const TimeValue& a, const TimeValue& b);
#define OSFI_RELOP_IMPL(op, T) \
        inline bool operator op(const T& a, const T& b) { \
            return std::rel_ops::operator op(a, b); \
        }
        OSFI_RELOP_IMPL(!=, TimeValue)
        OSFI_RELOP_IMPL(<=, TimeValue)
        OSFI_RELOP_IMPL(>=, TimeValue)
        OSFI_RELOP_IMPL(>, TimeValue)
#undef OSFI_RELOP_IMPL
 
        template<ElementType et>
        struct parsed_type;
        // Specializations for each element type
        template<> struct parsed_type<ElementType::INTEGER> { using type = int; };
        template<> struct parsed_type<ElementType::FLOAT>   { using type = double; };
        template<> struct parsed_type<ElementType::BOOLEAN> { using type = bool; };
        template<> struct parsed_type<ElementType::STRING>  { using type = std::string; };
        template<> struct parsed_type<ElementType::FILE>    { using type = std::string; };
        template<> struct parsed_type<ElementType::FOLDER>  { using type = std::string; };
        template<> struct parsed_type<ElementType::TIME>    { using type = TimeValue; };
 
        template<ElementType et>
        using parsed_type_t = typename parsed_type<et>::type;
    }
}
 
#endif // OSFI_CONFM_BASE_H_