libstdc++: source_location Source File

libstdc++

source_location
Go to the documentation of this file.
1// <source_location> -*- C++ -*-
2
3// Copyright (C) 2020-2026 Free Software Foundation, Inc.
4//
5// This file is part of the GNU ISO C++ Library. This library is free
6// software; you can redistribute it and/or modify it under the
7// terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 3, or (at your option)
9// any later version.
10
11// This library is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// Under Section 7 of GPL version 3, you are granted additional
17// permissions described in the GCC Runtime Library Exception, version
18// 3.1, as published by the Free Software Foundation.
19
20// You should have received a copy of the GNU General Public License and
21// a copy of the GCC Runtime Library Exception along with this program;
22// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23// <http://www.gnu.org/licenses/>.
24
25/** @file include/source_location
26 * This is a Standard C++ Library header.
27 */
28
29#ifndef _GLIBCXX_SRCLOC
30#define _GLIBCXX_SRCLOC 1
31
32#define __glibcxx_want_source_location
33#include <bits/version.h>
34
35#if __cpp_lib_source_location // C++ >= 20 && builtin_source_location
36#include <bits/c++config.h>
37
38namespace std
39{
40_GLIBCXX_BEGIN_NAMESPACE_VERSION
41#ifdef __glibcxx_contracts
42 namespace contracts { class contract_violation; }
43#endif
44
45 /// A class that describes a location in source code.
46 struct source_location
47 {
48 private:
49 using uint_least32_t = __UINT_LEAST32_TYPE__;
50 struct __impl
51 {
52 const char* _M_file_name;
53 const char* _M_function_name;
54 unsigned _M_line;
55 unsigned _M_column;
56 };
57 using __builtin_ret_type = decltype(__builtin_source_location());
58
59 public:
60
61 // [support.srcloc.cons], creation
62 static consteval source_location
63 current(__builtin_ret_type __p = __builtin_source_location()) noexcept
64 {
65 source_location __ret;
66 __ret._M_impl = static_cast <const __impl*>(__p);
67 return __ret;
68 }
69
70 constexpr source_location() noexcept { }
71
72 // [support.srcloc.obs], observers
73 constexpr uint_least32_t
74 line() const noexcept
75 { return _M_impl ? _M_impl->_M_line : 0u; }
76
77 constexpr uint_least32_t
78 column() const noexcept
79 { return _M_impl ? _M_impl->_M_column : 0u; }
80
81 constexpr const char*
82 file_name() const noexcept
83 { return _M_impl ? _M_impl->_M_file_name : ""; }
84
85 constexpr const char*
86 function_name() const noexcept
87 { return _M_impl ? _M_impl->_M_function_name : ""; }
88
89 private:
90 const __impl* _M_impl = nullptr;
91
92#ifdef __glibcxx_contracts
93 friend class std::contracts::contract_violation;
94#endif
95 };
96
97_GLIBCXX_END_NAMESPACE_VERSION
98} // namespace std
99#endif // __cpp_lib_source_location
100#endif // _GLIBCXX_SRCLOC
version.h
c++config.h
std
ISO C++ entities toplevel namespace is std.