sha512sum/nameof_module
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
nameof_module/doc/reference.md
neargye f2522c2cc0 * add sep param to nameof_enum_flag 
* fix noexcept
2023-06-14 02:44:15 +04:00

14 KiB
Raw Blame History

Reference

Synopsis

  • Before use, read the limitations of functionality.

  • To check is nameof_enum supported compiler use macro NAMEOF_ENUM_SUPPORTED or constexpr constant nameof::is_nameof_enum_supported.
    If nameof_enum used on unsupported compiler, occurs the compilation error. To suppress error define macro NAMEOF_ENUM_NO_CHECK_SUPPORT.

  • To check is nameof_type supported compiler use macro NAMEOF_TYPE_SUPPORTED or constexpr constant nameof::is_nameof_type_supported.
    If nameof_type used on unsupported compiler, occurs the compilation error. To suppress error define macro NAMEOF_TYPE_NO_CHECK_SUPPORT.

  • To check is nameof_type_rtti supported compiler use macro NAMEOF_TYPE_RTTI_SUPPORTED or constexpr constant nameof::is_nameof_type_rtti_supported.
    If nameof_type used on unsupported compiler, occurs the compilation error. To suppress error define macro NAMEOF_TYPE_NO_CHECK_SUPPORT.

  • To check is nameof_member supported compiler use macro NAMEOF_MEMBER_SUPPORTED or constexpr constant nameof::is_nameof_member_supported.
    If nameof_member used on unsupported compiler, occurs the compilation error. To suppress error define macro NAMEOF_TYPE_NO_CHECK_SUPPORT.

  • To check is nameof_pointer supported compiler use macro NAMEOF_POINTER_SUPPORTED or constexpr constant nameof::is_nameof_pointer_supported.
    If nameof_pointer used on unsupported compiler, occurs the compilation error. To suppress error define macro NAMEOF_TYPE_NO_CHECK_SUPPORT.

  • To add custom enum or type names see the example.

  • To change the type of strings, use special macros:

    #include <my_lib/string.hpp>
#include <my_lib/string_view.hpp>
#define NAMEOF_USING_ALIAS_STRING using string = my_lib::String;
#define NAMEOF_USING_ALIAS_STRING_VIEW using string_view = my_lib::StringView;
#include <nameof.hpp>

NAMEOF

  • Obtains name of variable, function, macro.

  • Returns nameof::cstring - constexpr implementation of an string. Marked constexpr and noexcept.

  • If argument does not have name, occurs the compilation error "Expression does not have a name.".

  • Examples

    // Name of variable.
NAMEOF(somevar) -> "somevar"

// Name of member variable.
NAMEOF(person.address.zip_code) -> "zip_code"

// Name of function.
NAMEOF(foo<int, float>()) -> "foo"

// Name of member function.
NAMEOF(somevar.some_method()) -> "some_method"
NAMEOF(somevar.some_method<int>()) -> "some_method"

// Name of macro.
NAMEOF(__LINE__) -> "__LINE__"
NAMEOF(NAMEOF(structvar)) -> "NAMEOF"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_FULL

  • Obtains full (with template suffix) name of variable, function, macro.

  • Returns nameof::cstring - constexpr implementation of an string. Marked constexpr and noexcept.

  • If argument does not have name, occurs the compilation error "Expression does not have a name.".

  • Examples

    // Full name of template function.
NAMEOF_FULL(foo<int, float>()) -> "foo<int, float>"

// Full name of template member function.
NAMEOF_FULL(somevar.some_method<int>()) -> "some_method<int>"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_RAW

  • Obtains raw name of variable, function, macro.

  • Returns nameof::cstring - constexpr implementation of an string. Marked constexpr and noexcept.

  • If argument does not have name, occurs the compilation error "Expression does not have a name.".

  • Examples

    NAMEOF_RAW(::somevar.somefield) -> "::somevar.somefield"
NAMEOF_RAW(&some_class::some_method<int>) -> "&some_class::some_method<int>"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_ENUM

  • Obtains name of enum variable.

  • Returns string_view. Marked constexpr and noexcept.

  • If argument does not have name or out of range, returns empty string_view, in debug occurs assert.

  • Examples

    auto color = Color::RED;
NAMEOF_ENUM(color) -> "RED"
nameof::nameof_enum(color) -> "RED"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 9 and C++ >= 17

NAMEOF_ENUM_OR

  • Obtains name of enum variable or default value if enum variable out of range.

  • Returns string.

  • If argument does not have name or out of range, returns default_value.

    auto color = Color::RED;
NAMEOF_ENUM_OR(color, "none") -> "RED"
NAMEOF_ENUM_OR((Color)-1, "none") -> "none"
nameof::nameof_enum_or(color, "none") -> "RED"
nameof::nameof_enum_or((Color)-1, "none") -> "none"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 9 and C++ >= 17

NAMEOF_ENUM_CONST

  • Obtains name of static storage enum variable.

  • Returns string_view. Marked constexpr and noexcept.

  • This version is much lighter on the compile times and is not restricted to the enum_range limitation.

  • If argument does not have name, occurs the compilation error "Enum value does not have a name.".

  • Examples

    NAMEOF_ENUM_CONST(Color::GREEN) -> "GREEN"
nameof::nameof_enum<Color::GREEN>() -> "GREEN"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 9 and C++ >= 17

NAMEOF_ENUM_FLAG

  • Obtains name of enum flag variable.

  • Returns string.

  • If argument does not have name or out of range, returns empty string, in debug occurs assert.

  • Examples

    enum class AnimalFlags { HasClaws = 1 << 0, CanFly = 1 << 1, EatsFish = 1 << 2, Endangered = 1 << 3 };
auto flag = AnimalFlags::Endangered;

NAMEOF_ENUM_FLAG(flag) -> "Endangered"
nameof_enum_flag(flag) -> "Endangered"

flag = AnimalFlags::CanFly | AnimalFlags::Endangered;
NAMEOF_ENUM_FLAG(flag) -> "CanFly|Endangered"
nameof_enum_flag(flag) -> "CanFly|Endangered"
nameof_enum_flag(flag, '$') -> "CanFly$Endangered"

NAMEOF_ENUM(HasClaws | CanFly) -> ""
nameof_enum(HasClaws | CanFly) -> ""

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 9 and C++ >= 17

NAMEOF_TYPE

  • Obtains type name, reference and cv-qualifiers are ignored.

  • Returns string_view. Marked constexpr and noexcept.

  • In all cases, reference and cv-qualifiers are ignored by NAMEOF_TYPE (that is, NAMEOF_TYPE(const T&) == NAMEOF_TYPE(T)).

  • Returns compiler-specific type name.

  • If type does not have name, occurs the compilation error "Type does not have a name.".

  • Examples

    using T = const int&;
NAMEOF_TYPE(T) -> "int"
nameof::nameof_type<T>() -> "int"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_FULL_TYPE

  • Obtains full type name, with reference and cv-qualifiers.

  • Returns string_view. Marked constexpr and noexcept.

  • Returns compiler-specific type name.

  • If type does not have name, occurs the compilation error "Type does not have a name.".

  • Examples

    using T = const int&;
NAMEOF_TYPE(T) -> "const int&"
nameof::nameof_full_type<T>() -> "const int&"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_SHORT_TYPE

  • Obtains short type name.

  • Returns string_view. Marked constexpr and noexcept.

  • Returns compiler-specific type name.

  • If type does not have name, occurs the compilation error "Type does not have a name.".

  • Examples

    using T = const my::detail::SomeClass<int>&;
NAMEOF_SHORT_TYPE(T) -> "SomeClass"
nameof::nameof_short_type<T>() -> "SomeClass"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_TYPE_EXPR

  • Obtains string name type of expression, reference and cv-qualifiers are ignored.

  • Returns string_view. Marked constexpr and noexcept.

  • Returns compiler-specific type name.

  • In all cases, reference and cv-qualifiers are ignored.

  • If type does not have name, occurs the compilation error "Type does not have a name.".

  • Examples

    using T = const int&;
T var = 42;
NAMEOF_TYPE_EXPR(var) -> "int"
nameof::nameof_type<decltype(var)>() -> "int"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_FULL_TYPE_EXPR

  • Obtains full type name of expression, with reference and cv-qualifiers.

  • Returns string_view. Marked constexpr and noexcept.

  • Returns compiler-specific type name.

  • If type does not have name, occurs the compilation error "Type does not have a name.".

  • Examples

    using T = const int&;
T var = 42;
NAMEOF_FULL_TYPE_EXPR(var) -> "const int&"
nameof::nameof_full_type<decltype(var)>() -> "const int&"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_SHORT_TYPE_EXPR

  • Obtains short type name of expression.

  • Returns string_view. Marked constexpr and noexcept.

  • Returns compiler-specific type name.

  • If type does not have name, occurs the compilation error "Type does not have a name.".

  • Examples

    const my::detail::SomeClass<int> var;
NAMEOF_SHORT_TYPE_EXPR(var) -> "SomeClass"
nameof::nameof_short_type<decltype(var)>() -> "SomeClass"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2017 and C++ >= 17
    GCC >= 7 and C++ >= 17

NAMEOF_TYPE_RTTI

  • Obtains type name, using RTTI.

  • Returns string.

  • Examples

    volatile const my::detail::Base* ptr = new my::detail::Derived();
NAMEOF_TYPE_RTTI(*ptr) -> "my::detail::Derived"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17 and RTTI enabled
    Visual Studio >= 2017 and C++ >= 17 and RTTI enabled
    GCC >= 7 and C++ >= 17 and RTTI enabled

NAMEOF_FULL_TYPE_RTTI

  • Obtains full type name, using RTTI.

  • Returns string.

  • Examples

    volatile const my::detail::Base* ptr = new my::detail::Derived();
NAMEOF_FULL_TYPE_RTTI(cv_ref) -> "volatile const my::detail::Derived&"
``

NAMEOF_SHORT_TYPE_RTTI

  • Obtains short type name, using RTTI.

  • Returns string.

  • Examples

    volatile const my::detail::Base* ptr = new my::detail::Derived();
NAMEOF_SHORT_TYPE_RTTI(*ptr) -> "Derived"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17 and RTTI enabled
    Visual Studio >= 2017 and C++ >= 17 and RTTI enabled
    GCC >= 7 and C++ >= 17 and RTTI enabled

NAMEOF_MEMBER

  • Obtains name of member.

  • Returns string_view.

  • Examples

    struct A {
  int this_is_the_name;
};
// ..
NAMEOF_MEMBER(&A::this_is_the_name) -> "this_is_the_name"
nameof::nameof_member(&A::this_is_the_name) -> "this_is_the_name"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2022 and C++ >= 20
    GCC >= 7 and C++ >= 17

NAMEOF_POINTER

  • Obtains name of a function, a global or class static variable.

  • Returns string_view.

  • Examples

    int someglobalvariable = 0;
// ..
NAMEOF_POINTER(&someglobalconstvariable) == "someglobalconstvariable"
nameof::nameof_pointer(&someglobalconstvariable) == "someglobalconstvariable"

constexpr auto global_ptr = &someglobalvariable;
NAMEOF_POINTER(global_ptr) == "someglobalconstvariable"
nameof::nameof_pointer(global_ptr) == "someglobalconstvariable"

  • Compiler compatibility Clang/LLVM >= 5 and C++ >= 17
    Visual Studio >= 2022 and C++ >= 20
    GCC >= 7 and C++ >= 17