nameof_module/README.md

Nameof C++

 _   _                             __    _____
| \ | |                           / _|  / ____|_     _
|  \| | __ _ _ __ ___   ___  ___ | |_  | |   _| |_ _| |_
| . ` |/ _` | '_ ` _ \ / _ \/ _ \|  _| | |  |_   _|_   _|
| |\  | (_| | | | | | |  __/ (_) | |   | |____|_|   |_|
|_| \_|\__,_|_| |_| |_|\___|\___/|_|    \_____|

What is Nameof?

Header-only C++17 library provides nameof macros and functions to obtain simple name of variable, type, function, macro, and enum.

Features

• C++17
• Header-only
• Dependency-free
• Compile-time
• Name of variable, member variable
• Name of type, variable type
• Name of function, member function
• Name of enum, enum variable
• Name of macro
• Enum to string

Examples

• Name of variable

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

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

• Name of function

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

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

• Name of enum

auto color = Color::RED;
// Name of enum variable.
NAMEOF_ENUM(color) -> "RED"
nameof::nameof_enum(color) -> "RED"

constexpr auto const_color = Color::BLUE;
// Name of static storage enum variable.
NAMEOF_CONST_ENUM(const_color) -> "BLUE"
nameof::nameof_enum<const_color>() -> "BLUE"

• Name of type

using T = int;
T var = 42;
// Name of variable type.
NAMEOF_VAR_TYPE(var) -> "int"
nameof::nameof_type<decltype(var)>() -> "int"

// Name of type.
NAMEOF_TYPE(T) -> "int"
nameof::nameof_type<T>() -> "int"

• Name of macro

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

Remarks

• Nameof return std::string_view.

• If arguments does not have name, Nameof return empty string.

• Nameof expression arguments are identified, but do not evaluated.

• NAMEOF_ENUM supported on the GCC >= 9.

• If you need of raw fully-qualified name, use NAMEOF_RAW.

NAMEOF_RAW(somevar.somefield) -> "somevar.somefield"
NAMEOF_RAW(&SomeStruct::SomeMethod) -> "&SomeStruct::SomeMethod"
NAMEOF_RAW(const SomeClass<int> volatile *) -> "const SomeClass<int> volatile *"

• Spaces and Tabs ignored

NAMEOF(   somevar   ) -> "somevar"
NAMEOF(	somevar	) -> "somevar"

Integration

You should add required file nameof.hpp.

Compiler compatibility

• Clang/LLVM >= 5
• Visual C++ >= 15.3 / Visual Studio >= 2017
• Xcode >= 9
• GCC >= 7

Licensed under the MIT License