nameof

Nom de C ++

La bibliothèque C ++ 17 de l'en-tête fournit des macros et des fonctions pour obtenir simplement le nom d'une variable, type, fonction, macro et énumération.

Si vous aimez ce projet, envisagez de faire un don à l'un des fonds qui aident les victimes de la guerre en Ukraine: https://u24.gov.ua.

Documentation

• Référence
• Limites
• Intégration

Caractéristiques et exemples

• Nom de

   // 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"
  
  // Obtains full name of variable, function, macro.
  NAMEOF_FULL(somevar.some_method< int >()) -> "some_method<int>"
  
  // Obtains raw name of variable, function, macro.
  NAMEOF_RAW(somevar.some_method< int >()) -> "somevar.some_method<int>()"

• Nom de l'énumération

   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<Color::GREEN>() -> "GREEN"
  
  // Enum flags variable to string.
  NAMEOF_ENUM_FLAG(Color::GREEN | Color::BLUE) -> "GREEN|BLUE"
  nameof::nameof_enum_flag<Color::GREEN | Color::BLUE>() -> "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"

• Nom de type

   const my::detail::SomeClass< int >& var_ref = var;
  // Name of variable type.
  NAMEOF_TYPE_EXPR (var_ref) -> "my::detail::SomeClass<int>"
  nameof::nameof_type<decltype(var_ref)>() -> "my::detail::SomeClass<int>"
  NAMEOF_FULL_TYPE_EXPR(var_ref) -> " const my::detail::SomeClass<int>&"
  nameof::nameof_full_type<decltype(var_ref)>() -> " const my::detail::SomeClass<int>&"
  NAMEOF_SHORT_TYPE_EXPR(var_ref) -> "SomeClass"
  nameof::nameof_short_type<decltype(var_ref)>() -> "SomeClass"
  
  using T = const my::detail::SomeClass<int>&;
  // Name of type.
  NAMEOF_TYPE (T) ->"my::detail::SomeClass<int>"
  nameof::nameof_type<T>() -> "my::detail::SomeClass<int>"
  NAMEOF_FULL_TYPE(T) -> " const my::detail::SomeClass<int>&"
  nameof::nameof_full_type<T>() -> " const my::detail::SomeClass<int>&"
  NAMEOF_SHORT_TYPE(T) -> "SomeClass"
  nameof::nameof_short_type<T>() -> "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"

Remarques

• Avant d'utiliser, lisez les limites des fonctionnalités.

Intégration

Vous devez ajouter le nom de fichier requis de.hpp.

Si vous utilisez VCPKG sur votre projet de dépendances externes, vous pouvez utiliser le package Nomof.

Si vous utilisez Conan pour gérer vos dépendances, ajoutez simplement nameof/xyz à vos conan, où xyz est la version de version que vous souhaitez utiliser.

Les utilisateurs d'Archlinux peuvent installer nameof de Package Manager AUR, en utilisant la commande suivante: yay -S nameof .

Alternativement, vous pouvez utiliser quelque chose comme CPM qui est basé sur le module Fetch_Content de 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.
)

Compatibilité du compilateur

Vérifiez la référence pour chaque fonctionnalité.

Sous licence sous la licence du MIT