1// -*- C++ -*-
2//===----------------------------------------------------------------------===//
3//
4// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP___FORMAT_FORMAT_ARG_H
11#define _LIBCPP___FORMAT_FORMAT_ARG_H
12
13#include <__assert>
14#include <__concepts/arithmetic.h>
15#include <__config>
16#include <__cstddef/size_t.h>
17#include <__format/format_parse_context.h>
18#include <__format/formattable.h>
19#include <__functional/invoke.h>
20#include <__fwd/format.h>
21#include <__memory/addressof.h>
22#include <__type_traits/conditional.h>
23#include <__type_traits/remove_const.h>
24#include <__utility/forward.h>
25#include <__utility/move.h>
26#include <__utility/unreachable.h>
27#include <__variant/monostate.h>
28#include <cstdint>
29#include <string_view>
30
31#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
32# pragma GCC system_header
33#endif
34
35_LIBCPP_PUSH_MACROS
36#include <__undef_macros>
37
38_LIBCPP_BEGIN_NAMESPACE_STD
39
40#if _LIBCPP_STD_VER >= 20
41
42namespace __format {
43/// The type stored in @ref basic_format_arg.
44///
45/// @note The 128-bit types are unconditionally in the list to avoid the values
46/// of the enums to depend on the availability of 128-bit integers.
47///
48/// @note The value is stored as a 5-bit value in the __packed_arg_t_bits. This
49/// limits the maximum number of elements to 32.
50/// When modifying update the test
51/// test/libcxx/utilities/format/format.arguments/format.arg/arg_t.compile.pass.cpp
52/// It could be packed in 4-bits but that means a new type directly becomes an
53/// ABI break. The packed type is 64-bit so this reduces the maximum number of
54/// packed elements from 16 to 12.
55///
56/// @note Some members of this enum are an extension. These extensions need
57/// special behaviour in visit_format_arg. There they need to be wrapped in a
58/// handle to satisfy the user observable behaviour. The internal function
59/// __visit_format_arg doesn't do this wrapping. So in the format functions
60/// this function is used to avoid unneeded overhead.
61enum class __arg_t : uint8_t {
62 __none,
63 __boolean,
64 __char_type,
65 __int,
66 __long_long,
67 __i128, // extension
68 __unsigned,
69 __unsigned_long_long,
70 __u128, // extension
71 __float,
72 __double,
73 __long_double,
74 __const_char_type_ptr,
75 __string_view,
76 __ptr,
77 __handle
78};
79
80inline constexpr unsigned __packed_arg_t_bits = 5;
81inline constexpr uint8_t __packed_arg_t_mask = 0x1f;
82
83inline constexpr unsigned __packed_types_storage_bits = 64;
84inline constexpr unsigned __packed_types_max = __packed_types_storage_bits / __packed_arg_t_bits;
85
86constexpr bool __use_packed_format_arg_store(size_t __size) { return __size <= __packed_types_max; }
87
88constexpr __arg_t __get_packed_type(uint64_t __types, size_t __id) {
89 _LIBCPP_ASSERT_INTERNAL(__id <= __packed_types_max, "");
90
91 if (__id > 0)
92 __types >>= __id * __packed_arg_t_bits;
93
94 return static_cast<__format::__arg_t>(__types & __packed_arg_t_mask);
95}
96
97} // namespace __format
98
99// This function is not user observable, so it can directly use the non-standard
100// types of the "variant". See __arg_t for more details.
101template <class _Visitor, class _Context>
102decltype(auto) __visit_format_arg(_Visitor&& __vis, basic_format_arg<_Context> __arg) {
103 switch (__arg.__type_) {
104 case __format::__arg_t::__none:
105 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__monostate_);
106 case __format::__arg_t::__boolean:
107 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__boolean_);
108 case __format::__arg_t::__char_type:
109 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__char_type_);
110 case __format::__arg_t::__int:
111 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__int_);
112 case __format::__arg_t::__long_long:
113 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__long_long_);
114 case __format::__arg_t::__i128:
115# if _LIBCPP_HAS_INT128
116 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__i128_);
117# else
118 __libcpp_unreachable();
119# endif
120 case __format::__arg_t::__unsigned:
121 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__unsigned_);
122 case __format::__arg_t::__unsigned_long_long:
123 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__unsigned_long_long_);
124 case __format::__arg_t::__u128:
125# if _LIBCPP_HAS_INT128
126 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__u128_);
127# else
128 __libcpp_unreachable();
129# endif
130 case __format::__arg_t::__float:
131 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__float_);
132 case __format::__arg_t::__double:
133 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__double_);
134 case __format::__arg_t::__long_double:
135 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__long_double_);
136 case __format::__arg_t::__const_char_type_ptr:
137 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__const_char_type_ptr_);
138 case __format::__arg_t::__string_view:
139 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__string_view_);
140 case __format::__arg_t::__ptr:
141 return std::invoke(std::forward<_Visitor>(__vis), __arg.__value_.__ptr_);
142 case __format::__arg_t::__handle:
143 return std::invoke(
144 std::forward<_Visitor>(__vis), typename basic_format_arg<_Context>::handle{__arg.__value_.__handle_});
145 }
146
147 __libcpp_unreachable();
148}
149
150# if _LIBCPP_STD_VER >= 26
151
152template <class _Rp, class _Visitor, class _Context>
153_Rp __visit_format_arg(_Visitor&& __vis, basic_format_arg<_Context> __arg) {
154 switch (__arg.__type_) {
155 case __format::__arg_t::__none:
156 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__monostate_);
157 case __format::__arg_t::__boolean:
158 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__boolean_);
159 case __format::__arg_t::__char_type:
160 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__char_type_);
161 case __format::__arg_t::__int:
162 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__int_);
163 case __format::__arg_t::__long_long:
164 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__long_long_);
165 case __format::__arg_t::__i128:
166# if _LIBCPP_HAS_INT128
167 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__i128_);
168# else
169 __libcpp_unreachable();
170# endif
171 case __format::__arg_t::__unsigned:
172 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__unsigned_);
173 case __format::__arg_t::__unsigned_long_long:
174 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__unsigned_long_long_);
175 case __format::__arg_t::__u128:
176# if _LIBCPP_HAS_INT128
177 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__u128_);
178# else
179 __libcpp_unreachable();
180# endif
181 case __format::__arg_t::__float:
182 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__float_);
183 case __format::__arg_t::__double:
184 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__double_);
185 case __format::__arg_t::__long_double:
186 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__long_double_);
187 case __format::__arg_t::__const_char_type_ptr:
188 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__const_char_type_ptr_);
189 case __format::__arg_t::__string_view:
190 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__string_view_);
191 case __format::__arg_t::__ptr:
192 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), __arg.__value_.__ptr_);
193 case __format::__arg_t::__handle:
194 return std::invoke_r<_Rp>(
195 std::forward<_Visitor>(__vis), typename basic_format_arg<_Context>::handle{__arg.__value_.__handle_});
196 }
197
198 __libcpp_unreachable();
199}
200
201# endif // _LIBCPP_STD_VER >= 26
202
203/// Contains the values used in basic_format_arg.
204///
205/// This is a separate type so it's possible to store the values and types in
206/// separate arrays.
207template <class _Context>
208class __basic_format_arg_value {
209 using _CharT _LIBCPP_NODEBUG = typename _Context::char_type;
210
211public:
212 /// Contains the implementation for basic_format_arg::handle.
213 struct __handle {
214 template <class _Tp>
215 explicit __handle(_Tp& __v) noexcept
216 : __ptr_(std::addressof(__v)),
217 __format_([](basic_format_parse_context<_CharT>& __parse_ctx, _Context& __ctx, const void* __ptr) {
218 using _Dp = remove_const_t<_Tp>;
219 using _Qp = conditional_t<__formattable_with<const _Dp, _Context>, const _Dp, _Dp>;
220 static_assert(__formattable_with<_Qp, _Context>, "Mandated by [format.arg]/10");
221
222 typename _Context::template formatter_type<_Dp> __f;
223 __parse_ctx.advance_to(__f.parse(__parse_ctx));
224 __ctx.advance_to(__f.format(*const_cast<_Qp*>(static_cast<const _Dp*>(__ptr)), __ctx));
225 }) {}
226
227 const void* __ptr_;
228 void (*__format_)(basic_format_parse_context<_CharT>&, _Context&, const void*);
229 };
230
231 union {
232 monostate __monostate_;
233 bool __boolean_;
234 _CharT __char_type_;
235 int __int_;
236 unsigned __unsigned_;
237 long long __long_long_;
238 unsigned long long __unsigned_long_long_;
239# if _LIBCPP_HAS_INT128
240 __int128_t __i128_;
241 __uint128_t __u128_;
242# endif
243 float __float_;
244 double __double_;
245 long double __long_double_;
246 const _CharT* __const_char_type_ptr_;
247 basic_string_view<_CharT> __string_view_;
248 const void* __ptr_;
249 __handle __handle_;
250 };
251
252 // These constructors contain the exact storage type used. If adjustments are
253 // required, these will be done in __create_format_arg.
254
255 __basic_format_arg_value() noexcept : __monostate_() {}
256 __basic_format_arg_value(bool __value) noexcept : __boolean_(__value) {}
257 __basic_format_arg_value(_CharT __value) noexcept : __char_type_(__value) {}
258 __basic_format_arg_value(int __value) noexcept : __int_(__value) {}
259 __basic_format_arg_value(unsigned __value) noexcept : __unsigned_(__value) {}
260 __basic_format_arg_value(long long __value) noexcept : __long_long_(__value) {}
261 __basic_format_arg_value(unsigned long long __value) noexcept : __unsigned_long_long_(__value) {}
262# if _LIBCPP_HAS_INT128
263 __basic_format_arg_value(__int128_t __value) noexcept : __i128_(__value) {}
264 __basic_format_arg_value(__uint128_t __value) noexcept : __u128_(__value) {}
265# endif
266 __basic_format_arg_value(float __value) noexcept : __float_(__value) {}
267 __basic_format_arg_value(double __value) noexcept : __double_(__value) {}
268 __basic_format_arg_value(long double __value) noexcept : __long_double_(__value) {}
269 __basic_format_arg_value(const _CharT* __value) noexcept : __const_char_type_ptr_(__value) {}
270 __basic_format_arg_value(basic_string_view<_CharT> __value) noexcept : __string_view_(__value) {}
271 __basic_format_arg_value(const void* __value) noexcept : __ptr_(__value) {}
272 __basic_format_arg_value(__handle&& __value) noexcept : __handle_(std::move(__value)) {}
273};
274
275template <class _Context>
276class _LIBCPP_NO_SPECIALIZATIONS basic_format_arg {
277public:
278 class handle;
279
280 basic_format_arg() noexcept : __type_{__format::__arg_t::__none} {}
281
282 explicit operator bool() const noexcept { return __type_ != __format::__arg_t::__none; }
283
284# if _LIBCPP_STD_VER >= 26
285
286 // This function is user facing, so it must wrap the non-standard types of
287 // the "variant" in a handle to stay conforming. See __arg_t for more details.
288 template <class _Visitor>
289 decltype(auto) visit(this basic_format_arg __arg, _Visitor&& __vis) {
290 switch (__arg.__type_) {
291# if _LIBCPP_HAS_INT128
292 case __format::__arg_t::__i128: {
293 typename __basic_format_arg_value<_Context>::__handle __h{__arg.__value_.__i128_};
294 return std::invoke(std::forward<_Visitor>(__vis), typename basic_format_arg<_Context>::handle{__h});
295 }
296
297 case __format::__arg_t::__u128: {
298 typename __basic_format_arg_value<_Context>::__handle __h{__arg.__value_.__u128_};
299 return std::invoke(std::forward<_Visitor>(__vis), typename basic_format_arg<_Context>::handle{__h});
300 }
301# endif
302 default:
303 return std::__visit_format_arg(std::forward<_Visitor>(__vis), __arg);
304 }
305 }
306
307 // This function is user facing, so it must wrap the non-standard types of
308 // the "variant" in a handle to stay conforming. See __arg_t for more details.
309 template <class _Rp, class _Visitor>
310 _Rp visit(this basic_format_arg __arg, _Visitor&& __vis) {
311 switch (__arg.__type_) {
312# if _LIBCPP_HAS_INT128
313 case __format::__arg_t::__i128: {
314 typename __basic_format_arg_value<_Context>::__handle __h{__arg.__value_.__i128_};
315 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), typename basic_format_arg<_Context>::handle{__h});
316 }
317
318 case __format::__arg_t::__u128: {
319 typename __basic_format_arg_value<_Context>::__handle __h{__arg.__value_.__u128_};
320 return std::invoke_r<_Rp>(std::forward<_Visitor>(__vis), typename basic_format_arg<_Context>::handle{__h});
321 }
322# endif
323 default:
324 return std::__visit_format_arg<_Rp>(std::forward<_Visitor>(__vis), __arg);
325 }
326 }
327
328# endif // _LIBCPP_STD_VER >= 26
329
330private:
331 using char_type = typename _Context::char_type;
332
333 // TODO FMT Implement constrain [format.arg]/4
334 // Constraints: The template specialization
335 // typename Context::template formatter_type<T>
336 // meets the Formatter requirements ([formatter.requirements]). The extent
337 // to which an implementation determines that the specialization meets the
338 // Formatter requirements is unspecified, except that as a minimum the
339 // expression
340 // typename Context::template formatter_type<T>()
341 // .format(declval<const T&>(), declval<Context&>())
342 // shall be well-formed when treated as an unevaluated operand.
343
344public:
345 __basic_format_arg_value<_Context> __value_;
346 __format::__arg_t __type_;
347
348 explicit basic_format_arg(__format::__arg_t __type, __basic_format_arg_value<_Context> __value) noexcept
349 : __value_(__value), __type_(__type) {}
350};
351
352template <class _Context>
353class basic_format_arg<_Context>::handle {
354public:
355 void format(basic_format_parse_context<char_type>& __parse_ctx, _Context& __ctx) const {
356 __handle_.__format_(__parse_ctx, __ctx, __handle_.__ptr_);
357 }
358
359 explicit handle(typename __basic_format_arg_value<_Context>::__handle& __handle) noexcept : __handle_(__handle) {}
360
361private:
362 typename __basic_format_arg_value<_Context>::__handle& __handle_;
363};
364
365// This function is user facing, so it must wrap the non-standard types of
366// the "variant" in a handle to stay conforming. See __arg_t for more details.
367template <class _Visitor, class _Context>
368_LIBCPP_DEPRECATED_IN_CXX26 decltype(auto) visit_format_arg(_Visitor&& __vis, basic_format_arg<_Context> __arg) {
369 switch (__arg.__type_) {
370# if _LIBCPP_HAS_INT128
371 case __format::__arg_t::__i128: {
372 typename __basic_format_arg_value<_Context>::__handle __h{__arg.__value_.__i128_};
373 return std::invoke(std::forward<_Visitor>(__vis), typename basic_format_arg<_Context>::handle{__h});
374 }
375
376 case __format::__arg_t::__u128: {
377 typename __basic_format_arg_value<_Context>::__handle __h{__arg.__value_.__u128_};
378 return std::invoke(std::forward<_Visitor>(__vis), typename basic_format_arg<_Context>::handle{__h});
379 }
380# endif // _LIBCPP_HAS_INT128
381 default:
382 return std::__visit_format_arg(std::forward<_Visitor>(__vis), __arg);
383 }
384}
385
386#endif // _LIBCPP_STD_VER >= 20
387
388_LIBCPP_END_NAMESPACE_STD
389
390_LIBCPP_POP_MACROS
391
392#endif // _LIBCPP___FORMAT_FORMAT_ARG_H
393