Namespaces
Variants
Views
Actions

std::source_location

From cppreference.com
< cpp‎ | utility
 
 
Utilities library
Language support
Type support (basic types, RTTI)
Library feature-test macros (C++20)
Dynamic memory management
Program utilities
Coroutine support (C++20)
Variadic functions
source_location
(C++20)
Debugging support
(C++26)
Three-way comparison
(C++20)
(C++20)(C++20)(C++20)
(C++20)(C++20)(C++20)
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)(C++20)(C++20)   
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Elementary string conversions
(C++17)
(C++17)

 
 
Defined in header <source_location>
struct source_location;
(since C++20)

The std::source_location class represents certain information about the source code, such as file names, line numbers, and function names. Previously, functions that desire to obtain this information about the call site (for logging, testing, or debugging purposes) must use macros so that predefined macros like __LINE__ and __FILE__ are expanded in the context of the caller. The std::source_location class provides a better alternative.

std::source_location meets the DefaultConstructible, CopyConstructible, CopyAssignable and Destructible requirements. Lvalue of std::source_location meets the Swappable requirement.

Additionally, the following conditions are true:

It is intended that std::source_location has a small size and can be copied efficiently.

It is unspecified whether the copy/move constructors and the copy/move assignment operators of std::source_location are trivial and/or constexpr.

Contents

[edit] Member functions

Creation
constructs a new source_location with implementation-defined values
(public member function) [edit]
[static]
constructs a new source_location corresponding to the location of the call site
(public static member function) [edit]
Field access
return the line number represented by this object
(public member function) [edit]
return the column number represented by this object
(public member function) [edit]
return the file name represented by this object
(public member function) [edit]
return the name of the function represented by this object, if any
(public member function) [edit]

[edit] Notes

Feature-test macro Value Std Feature
__cpp_lib_source_location 201907L (C++20) Source-code information capture (std::source_location)

[edit] Example

#include <iostream>
#include <source_location>
#include <string_view>
 
void log(const std::string_view message,
         const std::source_location location =
               std::source_location::current())
{
    std::clog << "file: "
              << location.file_name() << '('
              << location.line() << ':'
              << location.column() << ") `"
              << location.function_name() << "`: "
              << message << '\n';
}
 
template<typename T>
void fun(T x)
{
    log(x);
}
 
int main(int, char*[])
{
    log("Hello world!");
    fun("Hello C++20!");
}

Possible output:

file: main.cpp(23:8) `int main(int, char**)`: Hello world!
file: main.cpp(18:8) `void fun(T) [with T = const char*]`: Hello C++20!

[edit] See also

changes the source code's line number and, optionally, the current file name
(preprocessing directive)[edit]
representation of an evaluation in a stacktrace
(class) [edit]