update readme

This commit is contained in:
neargye 2019-04-02 18:47:52 +05:00
parent 249202df54
commit b236173ad9

108
README.md
View file

@ -35,80 +35,82 @@ Header-only C++17 library provides nameof macros and functions to obtain simple
## [Examples](example/example.cpp) ## [Examples](example/example.cpp)
* Name of variable * Name of variable
```cpp ```cpp
// Name of variable. // Name of variable.
NAMEOF(somevar) -> "somevar" NAMEOF(somevar) -> "somevar"
// Name of member variable. // Name of member variable.
NAMEOF(person.address.zip_code) -> "zip_code" NAMEOF(person.address.zip_code) -> "zip_code"
``` ```
* Name of function * Name of function
```cpp ```cpp
// Name of function. // Name of function.
NAMEOF(foo<int, float>()) -> "foo" NAMEOF(foo<int, float>()) -> "foo"
NAMEOF_FULL(foo<int, float>()) -> "foo<int, float>" NAMEOF_FULL(foo<int, float>()) -> "foo<int, float>"
// Name of member function. // Name of member function.
NAMEOF(somevar.some_method()) -> "some_method" NAMEOF(somevar.some_method()) -> "some_method"
NAMEOF_FULL(somevar.some_method<int>()) -> "some_method<int>" NAMEOF_FULL(somevar.some_method<int>()) -> "some_method<int>"
``` ```
* Name of enum * Name of enum
```cpp ```cpp
auto color = Color::RED; auto color = Color::RED;
// Name of enum variable. // Name of enum variable.
NAMEOF_ENUM(color) -> "RED" NAMEOF_ENUM(color) -> "RED"
nameof::nameof_enum(color) -> "RED" nameof::nameof_enum(color) -> "RED"
constexpr auto const_color = Color::BLUE; constexpr auto const_color = Color::BLUE;
// Name of static storage enum variable. // Name of static storage enum variable.
NAMEOF_CONST_ENUM(const_color) -> "BLUE" NAMEOF_CONST_ENUM(const_color) -> "BLUE"
nameof::nameof_enum<const_color>() -> "BLUE" nameof::nameof_enum<const_color>() -> "BLUE"
``` ```
* Name of type * Name of type
```cpp ```cpp
using T = int; using T = int;
T var = 42; T var = 42;
// Name of variable type. // Name of variable type.
NAMEOF_VAR_TYPE(var) -> "int" NAMEOF_VAR_TYPE(var) -> "int"
nameof::nameof_type<decltype(var)>() -> "int" nameof::nameof_type<decltype(var)>() -> "int"
// Name of type. // Name of type.
NAMEOF_TYPE(T) -> "int" NAMEOF_TYPE(T) -> "int"
nameof::nameof_type<T>() -> "int" nameof::nameof_type<T>() -> "int"
``` ```
* Name of macro * Name of macro
```cpp ```cpp
// Name of macro. // Name of macro.
NAMEOF(__LINE__) -> "__LINE__" NAMEOF(__LINE__) -> "__LINE__"
NAMEOF(NAMEOF(structvar)) -> "NAMEOF" NAMEOF(NAMEOF(structvar)) -> "NAMEOF"
``` ```
## Remarks ## Remarks
* Nameof return std::string_view. * Nameof return std::string_view. If arguments does not have name, Nameof return empty string.
* If arguments does not have name, Nameof return empty string.
* Nameof expression arguments are identified, but do not evaluated. * Nameof expression arguments are identified, but do not evaluated.
* NAMEOF_ENUM supported on the GCC >= 9. * Enum variable must be in range (-NAMEOF_ENUM_RANGE, NAMEOF_ENUM_RANGE). By default NAMEOF_ENUM_RANGE = 128. If you need a larger range, redefine the macro NAMEOF_ENUM_RANGE.
```cpp
#define NAMEOF_ENUM_RANGE 1028 // Redefine NAMEOF_ENUM_RANGE for larger range.
#include <nameof.hpp>
```
* If you need of raw fully-qualified name, use NAMEOF_RAW. * If you need of raw fully-qualified name, use NAMEOF_RAW.
```cpp ```cpp
NAMEOF_RAW(somevar.somefield) -> "somevar.somefield" NAMEOF_RAW(somevar.somefield) -> "somevar.somefield"
NAMEOF_RAW(&SomeStruct::SomeMethod) -> "&SomeStruct::SomeMethod" NAMEOF_RAW(&SomeStruct::SomeMethod) -> "&SomeStruct::SomeMethod"
NAMEOF_RAW(const SomeClass<int> volatile *) -> "const SomeClass<int> volatile *" NAMEOF_RAW(const SomeClass<int> volatile *) -> "const SomeClass<int> volatile *"
``` ```
* Spaces and Tabs ignored * Spaces and Tabs ignored
```cpp ```cpp
NAMEOF( somevar ) -> "somevar" NAMEOF( somevar ) -> "somevar"
NAMEOF( somevar ) -> "somevar" NAMEOF( somevar ) -> "somevar"
``` ```
## Integration ## Integration
@ -119,6 +121,6 @@ You should add required file [nameof.hpp](include/nameof.hpp).
* Clang/LLVM >= 5 * Clang/LLVM >= 5
* Visual C++ >= 15.3 / Visual Studio >= 2017 * Visual C++ >= 15.3 / Visual Studio >= 2017
* Xcode >= 9 * Xcode >= 9
* GCC >= 7 * GCC >= 7 (GCC >= 9 for NAMEOF_ENUM)
## Licensed under the [MIT License](LICENSE) ## Licensed under the [MIT License](LICENSE)