concepts.h 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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. #ifndef _LIBCPP___FORMAT_CONCEPTS_H
  10. #define _LIBCPP___FORMAT_CONCEPTS_H
  11. #include <__concepts/same_as.h>
  12. #include <__concepts/semiregular.h>
  13. #include <__config>
  14. #include <__format/format_parse_context.h>
  15. #include <__fwd/format.h>
  16. #include <__fwd/tuple.h>
  17. #include <__tuple/tuple_size.h>
  18. #include <__type_traits/is_specialization.h>
  19. #include <__type_traits/remove_const.h>
  20. #include <__type_traits/remove_reference.h>
  21. #include <__utility/pair.h>
  22. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  23. # pragma GCC system_header
  24. #endif
  25. _LIBCPP_BEGIN_NAMESPACE_STD
  26. #if _LIBCPP_STD_VER >= 20
  27. /// The character type specializations of \ref formatter.
  28. template <class _CharT>
  29. concept __fmt_char_type =
  30. same_as<_CharT, char>
  31. # ifndef _LIBCPP_HAS_NO_WIDE_CHARACTERS
  32. || same_as<_CharT, wchar_t>
  33. # endif
  34. ;
  35. // The output iterator isn't specified. A formatter should accept any
  36. // output_iterator. This iterator is a minimal iterator to test the concept.
  37. // (Note testing for (w)format_context would be a valid choice, but requires
  38. // selecting the proper one depending on the type of _CharT.)
  39. template <class _CharT>
  40. using __fmt_iter_for = _CharT*;
  41. template <class _Tp, class _Context, class _Formatter = typename _Context::template formatter_type<remove_const_t<_Tp>>>
  42. concept __formattable_with =
  43. semiregular<_Formatter> &&
  44. requires(_Formatter& __f,
  45. const _Formatter& __cf,
  46. _Tp&& __t,
  47. _Context __fc,
  48. basic_format_parse_context<typename _Context::char_type> __pc) {
  49. { __f.parse(__pc) } -> same_as<typename decltype(__pc)::iterator>;
  50. { __cf.format(__t, __fc) } -> same_as<typename _Context::iterator>;
  51. };
  52. template <class _Tp, class _CharT>
  53. concept __formattable =
  54. __formattable_with<remove_reference_t<_Tp>, basic_format_context<__fmt_iter_for<_CharT>, _CharT>>;
  55. # if _LIBCPP_STD_VER >= 23
  56. template <class _Tp, class _CharT>
  57. concept formattable = __formattable<_Tp, _CharT>;
  58. // [tuple.like] defines a tuple-like exposition only concept. This concept is
  59. // not related to that. Therefore it uses a different name for the concept.
  60. //
  61. // TODO FMT Add a test to validate we fail when using that concept after P2165
  62. // has been implemented.
  63. template <class _Tp>
  64. concept __fmt_pair_like =
  65. __is_specialization_v<_Tp, pair> || (__is_specialization_v<_Tp, tuple> && tuple_size_v<_Tp> == 2);
  66. # endif //_LIBCPP_STD_VER >= 23
  67. #endif //_LIBCPP_STD_VER >= 20
  68. _LIBCPP_END_NAMESPACE_STD
  69. #endif // _LIBCPP___FORMAT_CONCEPTS_H