2018-04-19 16:12:19 +00:00
# Nameof C++
2018-04-10 19:32:51 +00:00
```text
_ _ __ _____
| \ | | / _| / ____ |_ _
| \| | __ _ _ __ ___ ___ ___ | |_ | | _| |_ _| |_
| . ` |/ _` | '_ ` _ \ / _ \/ _ \| _ | | | |_ _|_ _|
| |\ | (_| | | | | | | __ / (_) | | | |____|_| |_|
|_| \_|\__,_|_| |_| |_|\___|\___/|_| \_____|
```
2018-03-27 08:04:47 +00:00
2018-04-19 16:12:19 +00:00
Branch | Linux/OSX | Windows | License | Codacy
-------|-----------|---------|---------|-------
master |[![Build Status](https://travis-ci.org/Neargye/nameof.svg?branch=master)](https://travis-ci.org/Neargye/nameof)|[![Build status](https://ci.appveyor.com/api/projects/status/yq5fk0d9mwljbubt/branch/master?svg=true)](https://ci.appveyor.com/project/Neargye/nameof/branch/master)|[![License](https://img.shields.io/github/license/Neargye/nameof.svg)](LICENSE)|[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1d06f3f07afe4f34acd29c0c8efa830b)](https://www.codacy.com/app/Neargye/nameof?utm_source=github.com& utm_medium=referral& utm_content=Neargye/nameof& utm_campaign=Badge_Grade)
2018-03-27 09:03:12 +00:00
2018-04-10 19:32:51 +00:00
C++ alternative to [nameof ](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/nameof ) operator in [C# ](https://en.wikipedia.org/wiki/C_Sharp_(programming_language )).
2018-05-01 13:19:34 +00:00
Used to obtain the simple name of a variable, type, member, function, macros.
2018-03-27 08:04:47 +00:00
Before, you had to use string literals to refer to definitions, which is brittle when renaming code elements because tools do not know to check these string literals.
2018-04-02 13:25:10 +00:00
A nameof macros expression has this form:
2018-03-27 08:04:47 +00:00
```cpp
2018-03-27 16:05:59 +00:00
std::cout < < NAMEOF ( person . address . zip_code ) < < std::endl ; / / prints " zip_code "
2018-03-27 08:04:47 +00:00
```
## Features
* Simple name
* C++11
* Header-only
* Dependency-free
* Compile-time
* Compilation check
2018-05-01 13:19:34 +00:00
## [Examples](example/example.cpp)
2018-03-27 08:04:47 +00:00
2018-04-02 13:25:10 +00:00
* Name of a variable, member or function and etc
2018-03-27 08:04:47 +00:00
```cpp
2018-04-10 19:32:51 +00:00
NAMEOF(somevar) -> "somevar"
NAMEOF(somevar.somefield) -> "somefield"
NAMEOF(SomeMethod) -> "SomeMethod"
2018-03-27 08:04:47 +00:00
```
2018-03-27 14:00:06 +00:00
* Name of enum
```cpp
NAMEOF(SomeEnum::RED) -> "RED"
NAMEOF(SomeEnum::GREEN) -> "GREEN"
```
2018-03-27 08:04:47 +00:00
* Name of type
```cpp
2018-04-10 19:32:51 +00:00
NAMEOF(volatile const int) -> "volatile const int int"
2018-04-04 12:19:02 +00:00
NAMEOF(std::string) -> "string"
2018-03-27 08:04:47 +00:00
```
2018-04-14 19:49:27 +00:00
* Name of macros
```cpp
NAMEOF(__LINE__) -> "__LINE__"
NAMEOF(__FILE__) -> "__FILE__"
```
2018-03-27 08:04:47 +00:00
* Constexpr
2018-03-17 05:15:00 +00:00
2018-03-17 08:18:42 +00:00
```cpp
2018-04-10 19:32:51 +00:00
constexpr auto constexpr_work_fine = NAMEOF(somevar); -> "somevar"
2018-03-27 08:04:47 +00:00
```
2018-03-17 05:15:00 +00:00
2018-03-27 08:04:47 +00:00
* Compilation check
2018-03-17 04:31:59 +00:00
2018-03-27 08:04:47 +00:00
```cpp
2018-04-10 19:32:51 +00:00
NAMEOF(std::stringgg) -> error namespace "std" has no member "stringgg"
2018-03-27 08:04:47 +00:00
```
2018-03-17 04:31:59 +00:00
2018-03-27 08:04:47 +00:00
* Validate parameters
```cpp
void f(char* s) {
if (s == nullptr)
throw std::invalid_argument(NAMEOF(s));
}
```
2018-03-17 04:31:59 +00:00
2018-03-27 14:00:06 +00:00
* Serialization, for example json:
```cpp
void to_json(json& j, const person& p) {
j = json{{NAMEOF(p.name), p.name},
{NAMEOF(p.address), p.address},
{NAMEOF(p.age), p.age}};
}
void from_json(const json& j, person& p) {
p.name = j.at(NAMEOF(p.name));
p.address = j.at(NAMEOF(p.address));
p.age = j.at(NAMEOF(p.age));
}
```
2018-03-27 08:04:47 +00:00
* Logging
2018-03-17 04:31:59 +00:00
2018-03-27 08:04:47 +00:00
```cpp
void f() {
Log(NAMEOF(f), " method entry");
2018-03-17 04:31:59 +00:00
}
```
2018-03-27 08:04:47 +00:00
## Remarks
2018-04-10 19:32:51 +00:00
* The argument expression identifies a code definition, but it is never evaluated.
2018-05-01 13:19:34 +00:00
* If you need fully-qualified name, use NAMEOF_FULL().
2018-03-27 08:04:47 +00:00
```cpp
2018-04-10 19:32:51 +00:00
NAMEOF_FULL(somevar.somefield) -> "somevar.somefield"
NAMEOF_FULL(& SomeStruct::SomeMethod) -> "& SomeStruct::SomeMethod"
2018-04-04 12:19:02 +00:00
NAMEOF_FULL(std::string) -> "std::string"
```
2018-04-10 19:32:51 +00:00
## Integration
2018-04-04 12:19:02 +00:00
2018-05-01 13:19:34 +00:00
You should add required file [nameof.hpp ](include/nameof.hpp ) and switch to C++11.
2018-04-04 12:19:02 +00:00
2018-04-10 19:32:51 +00:00
## Compiler compatibility
* GCC
* Clang
* MSVC
2018-03-27 08:04:47 +00:00
2018-04-14 19:52:48 +00:00
## Licensed under the [MIT License](LICENSE)