Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Neargye/nameof

Nameof operator for modern C++, simply obtain the name of a variable, type, function, macro, and enum
https://github.com/Neargye/nameof

c-plus-plus c-plus-plus-17 cplusplus cplusplus-17 cpp cpp17 enum-to-string header-only metaprogramming nameof nameof-operator no-dependencies reflection serialization single-file

Last synced: about 1 month ago
JSON representation

Nameof operator for modern C++, simply obtain the name of a variable, type, function, macro, and enum

Host: GitHub
URL: https://github.com/Neargye/nameof
Owner: Neargye
License: mit
Created: 2018-03-17T03:59:41.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-05-15T21:10:38.000Z (4 months ago)
Last Synced: 2024-06-20T19:24:11.520Z (3 months ago)
Topics: c-plus-plus, c-plus-plus-17, cplusplus, cplusplus-17, cpp, cpp17, enum-to-string, header-only, metaprogramming, nameof, nameof-operator, no-dependencies, reflection, serialization, single-file
Language: C++
Homepage:
Size: 684 KB
Stars: 1,999
Watchers: 35
Forks: 108
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-game-engine-dev - Nameof - Header-only C++17, provides nameof macros to obtain name of a variable. (Libraries / C++)
AwesomeCppGameDev - nameof
awesome-code-for-gamedev - Neargye/nameof

README

        [![Github releases](https://img.shields.io/github/release/Neargye/nameof.svg)](https://github.com/Neargye/nameof/releases)

[![Conan package](https://img.shields.io/badge/Conan-package-blueviolet)](https://conan.io/center/recipes/nameof)

[![Vcpkg package](https://img.shields.io/badge/Vcpkg-package-blueviolet)](https://github.com/microsoft/vcpkg/tree/master/ports/nameof)

[![License](https://img.shields.io/github/license/Neargye/nameof.svg)](LICENSE)

[![Compiler explorer](https://img.shields.io/badge/compiler_explorer-online-blue.svg)](https://godbolt.org/z/s_ecko)

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)

# Nameof C++

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

If you like this project, please consider donating to one of the funds that help victims of the war in Ukraine: https://u24.gov.ua.

## Documentation

* [Reference](doc/reference.md)

* [Limitations](doc/limitations.md)

* [Integration](#Integration)

## [Features & Examples](example/example.cpp)

* Nameof

  ```cpp

  // Name of variable.

  NAMEOF(somevar) -> "somevar"

  // Name of member variable.

  NAMEOF(person.address.zip_code) -> "zip_code"

  // Name of function.

  NAMEOF(foo()) -> "foo"

  // Name of member function.

  NAMEOF(somevar.some_method()) -> "some_method"

  NAMEOF(somevar.some_method()) -> "some_method"

  // Name of macro.

  NAMEOF(__LINE__) -> "__LINE__"

  NAMEOF(NAMEOF(structvar)) -> "NAMEOF"

  // Obtains full name of variable, function, macro.

  NAMEOF_FULL(somevar.some_method()) -> "some_method"

  // Obtains raw name of variable, function, macro.

  NAMEOF_RAW(somevar.some_method()) -> "somevar.some_method()"

  ```

* Nameof enum

  ```cpp

  enum class Color { RED = 1, BLUE = 2, GREEN = 4 };

  auto color = Color::RED;

  // Name of enum variable.

  NAMEOF_ENUM(color) -> "RED"

  nameof::nameof_enum(color) -> "RED"

  // Static storage enum variable to string.

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

  NAMEOF_ENUM_CONST(Color::GREEN) -> "GREEN"

  nameof::nameof_enum() -> "GREEN"

  // Enum flags variable to string.

  NAMEOF_ENUM_FLAG(Color::GREEN | Color::BLUE) -> "GREEN|BLUE"

  nameof::nameof_enum_flag() -> "GREEN|BLUE"

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

  NAMEOF_ENUM_OR(Color::GREEN) -> "GREEN"

  NAMEOF_ENUM_OR((Color)0, "none") -> "none"

  ```

* Nameof type

  ```cpp

  const my::detail::SomeClass& var_ref = var;

  // Name of variable type.

  NAMEOF_TYPE_EXPR(var_ref) -> "my::detail::SomeClass"

  nameof::nameof_type() -> "my::detail::SomeClass"

  NAMEOF_FULL_TYPE_EXPR(var_ref) -> "const my::detail::SomeClass&"

  nameof::nameof_full_type() -> "const my::detail::SomeClass&"

  NAMEOF_SHORT_TYPE_EXPR(var_ref) -> "SomeClass"

  nameof::nameof_short_type() -> "SomeClass"

  using T = const my::detail::SomeClass&;

  // Name of type.

  NAMEOF_TYPE(T) ->"my::detail::SomeClass"

  nameof::nameof_type() -> "my::detail::SomeClass"

  NAMEOF_FULL_TYPE(T) -> "const my::detail::SomeClass&"

  nameof::nameof_full_type() -> "const my::detail::SomeClass&"

  NAMEOF_SHORT_TYPE(T) -> "SomeClass"

  nameof::nameof_short_type() -> "SomeClass"

  my::detail::Base* ptr = new my::detail::Derived();

  // Name of type, using rtti.

  NAMEOF_TYPE_RTTI(*ptr) -> "my::detail::Derived"

  NAMEOF_FULL_TYPE_RTTI(*ptr) -> "volatile const my::detail::Derived&"

  NAMEOF_SHORT_TYPE_RTTI(*ptr) -> "Derived"

  struct A {

    int this_is_the_name;

  };

  // Obtains name of member.

  NAMEOF_MEMBER(&A::this_is_the_name) -> "this_is_the_name"

  nameof::nameof_member(&A::this_is_the_name) -> "this_is_the_name"

  int someglobalvariable = 0;

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

  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"

  ```

## Remarks

* Before use, read the [limitations](doc/limitations.md) of functionality.

## Integration

You should add required file [nameof.hpp](include/nameof.hpp).

If you are using [vcpkg](https://github.com/Microsoft/vcpkg/) on your project for external dependencies, then you can use the [nameof package](https://github.com/microsoft/vcpkg/tree/master/ports/nameof).

If you are using [Conan](https://www.conan.io/) to manage your dependencies, merely add `nameof/x.y.z` to your conan's requires, where `x.y.z` is the release version you want to use.

Archlinux users can install `nameof` by package manager AUR, using the following command: `yay -S nameof`.

Alternatively, you can use something like [CPM](https://github.com/TheLartians/CPM) which is based on CMake's `Fetch_Content` module.

```cmake

CPMAddPackage(

    NAME nameof

    GITHUB_REPOSITORY Neargye/nameof

    GIT_TAG x.y.z # Where `x.y.z` is the release version you want to use.

)

```

## Compiler compatibility

Check in the [reference](doc/reference.md) for each features.

## Licensed under the [MIT License](LICENSE)