HumanReadableEnum.h File Reference

Macros for easy creation of enumerations with conversion functions between enumeration values and human readable strings. More...

#include <boost/preprocessor/tuple/to_seq.hpp>
#include <boost/preprocessor/seq/for_each.hpp>
#include <boost/bimap.hpp>
#include <boost/assign.hpp>
#include <utils/VariadicMacro.h>
#include <utils/ToString.h>

Include dependency graph for HumanReadableEnum.h:

Go to the source code of this file.

Macros
#define	MIRA_HUMANREADABLE_ENUM_VALUE_EXPAND(VALUE)   #VALUE
#define	MIRA_HUMANREADABLE_ENUM_MAP_ITEM(R, NAME, VALUE)   (NAME::VALUE, MIRA_HUMANREADABLE_ENUM_VALUE_EXPAND(VALUE))
#define	MIRA_HUMANREADABLE_ENUM_DECLARE(NAME, VALUES...)
#define	MIRA_HUMANREADABLE_ENUM_DEFINE(NAME, VALUES...)

Detailed Description

Macros for easy creation of enumerations with conversion functions between enumeration values and human readable strings.

Author

Tim van der Grinten, Ronny Stricker

Date

2018/03/06

Macro Definition Documentation

MIRA_HUMANREADABLE_ENUM_VALUE_EXPAND

#define MIRA_HUMANREADABLE_ENUM_VALUE_EXPAND

(

VALUE

)

#VALUE

MIRA_HUMANREADABLE_ENUM_MAP_ITEM

#define MIRA_HUMANREADABLE_ENUM_MAP_ITEM	(		R,
			NAME,
			VALUE
	)		(NAME::VALUE, MIRA_HUMANREADABLE_ENUM_VALUE_EXPAND(VALUE))

MIRA_HUMANREADABLE_ENUM_DECLARE

#define MIRA_HUMANREADABLE_ENUM_DECLARE	(		NAME,
			VALUES...
	)

Value:

enum class NAME { VALUES };                              \
std::string toString(const NAME& v);                     \
NAME to##NAME(const std::string& v);

MIRA_HUMANREADABLE_ENUM_DEFINE

#define MIRA_HUMANREADABLE_ENUM_DEFINE	(		NAME,
			VALUES...
	)

Value:

const boost::bimap<NAME, std::string> NAME##Map                         \
    = boost::assign::list_of<boost::bimap<NAME, std::string>::relation> \
BOOST_PP_SEQ_FOR_EACH(                                                  \
    MIRA_HUMANREADABLE_ENUM_MAP_ITEM,                                   \
    NAME,                                                               \
    BOOST_PP_TUPLE_TO_SEQ(MIRA_VARIADIC_SIZE(VALUES), (VALUES)));       \
std::string toString(const NAME& v) {                                   \
    auto it = NAME##Map.left.find(v);                                   \
    if ( it == NAME##Map.left.end() )                                   \
        MIRA_THROW(mira::XInvalidParameter, mira::toString(int(v)) +    \
                   " is not a valid value for enumeration "#NAME)       \
    return it->second;                                                  \
}                                                                       \
NAME to##NAME(const std::string& v) {                                   \
    auto it = NAME##Map.right.find(v);                                  \
    if ( it == NAME##Map.right.end() )                                  \
        MIRA_THROW(mira::XInvalidParameter, v +                         \
                   " is not a valid value for enumeration "#NAME)       \
    return it->second;                                                  \
}