xref: /llvm-project-15.0.7/libcxx/include/format (revision d2bc4fa3)
1081c1db0SMark de Wever// -*- C++ -*-
2081c1db0SMark de Wever//===--------------------------- format -----------------------------------===//
3081c1db0SMark de Wever//
4081c1db0SMark de Wever// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5081c1db0SMark de Wever// See https://llvm.org/LICENSE.txt for license information.
6081c1db0SMark de Wever// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7081c1db0SMark de Wever//
8081c1db0SMark de Wever//===----------------------------------------------------------------------===//
9081c1db0SMark de Wever
10081c1db0SMark de Wever#ifndef _LIBCPP_FORMAT
11081c1db0SMark de Wever#define _LIBCPP_FORMAT
12081c1db0SMark de Wever
13081c1db0SMark de Wever/*
14081c1db0SMark de Wever
15081c1db0SMark de Wevernamespace std {
16081c1db0SMark de Wever  // [format.error], class format_error
17081c1db0SMark de Wever  class format_error : public runtime_error {
18081c1db0SMark de Wever  public:
19081c1db0SMark de Wever    explicit format_error(const string& what_arg);
20081c1db0SMark de Wever    explicit format_error(const char* what_arg);
21081c1db0SMark de Wever  };
2238ddeadeSMark de Wever
2338ddeadeSMark de Wever  // [format.parse.ctx], class template basic_format_parse_context
2438ddeadeSMark de Wever  template<class charT>
2538ddeadeSMark de Wever  class basic_format_parse_context {
2638ddeadeSMark de Wever  public:
2738ddeadeSMark de Wever    using char_type = charT;
2838ddeadeSMark de Wever    using const_iterator = typename basic_string_view<charT>::const_iterator;
2938ddeadeSMark de Wever    using iterator = const_iterator;
3038ddeadeSMark de Wever
3138ddeadeSMark de Wever  private:
3238ddeadeSMark de Wever    iterator begin_;                                    // exposition only
3338ddeadeSMark de Wever    iterator end_;                                      // exposition only
3438ddeadeSMark de Wever    enum indexing { unknown, manual, automatic };       // exposition only
3538ddeadeSMark de Wever    indexing indexing_;                                 // exposition only
3638ddeadeSMark de Wever    size_t next_arg_id_;                                // exposition only
3738ddeadeSMark de Wever    size_t num_args_;                                   // exposition only
3838ddeadeSMark de Wever
3938ddeadeSMark de Wever  public:
4038ddeadeSMark de Wever    constexpr explicit basic_format_parse_context(basic_string_view<charT> fmt,
4138ddeadeSMark de Wever                                                  size_t num_args = 0) noexcept;
4238ddeadeSMark de Wever    basic_format_parse_context(const basic_format_parse_context&) = delete;
4338ddeadeSMark de Wever    basic_format_parse_context& operator=(const basic_format_parse_context&) = delete;
4438ddeadeSMark de Wever
4538ddeadeSMark de Wever    constexpr const_iterator begin() const noexcept;
4638ddeadeSMark de Wever    constexpr const_iterator end() const noexcept;
4738ddeadeSMark de Wever    constexpr void advance_to(const_iterator it);
4838ddeadeSMark de Wever
4938ddeadeSMark de Wever    constexpr size_t next_arg_id();
5038ddeadeSMark de Wever    constexpr void check_arg_id(size_t id);
5138ddeadeSMark de Wever  };
5238ddeadeSMark de Wever  using format_parse_context = basic_format_parse_context<char>;
5338ddeadeSMark de Wever  using wformat_parse_context = basic_format_parse_context<wchar_t>;
54081c1db0SMark de Wever}
55081c1db0SMark de Wever
56081c1db0SMark de Wever*/
57081c1db0SMark de Wever
58*d2bc4fa3SMark de Wever// Make sure all feature-test macros are available.
59d618a1ccSMark de Wever#include <version>
60*d2bc4fa3SMark de Wever// Enable the contents of the header only when libc++ was built with LIBCXX_ENABLE_INCOMPLETE_FEATURES.
61d618a1ccSMark de Wever#if !defined(_LIBCPP_HAS_NO_INCOMPLETE_FORMAT)
62d618a1ccSMark de Wever
63081c1db0SMark de Wever#include <__config>
6416342e39SMark de Wever#include <__format/format_error.h>
65de9df3f5SMark de Wever#include <__format/format_parse_context.h>
6671909de3SMark de Wever
67081c1db0SMark de Wever#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
68081c1db0SMark de Wever#  pragma GCC system_header
69081c1db0SMark de Wever#endif
70081c1db0SMark de Wever
71081c1db0SMark de Wever_LIBCPP_PUSH_MACROS
72081c1db0SMark de Wever#include <__undef_macros>
73081c1db0SMark de Wever
74081c1db0SMark de Wever_LIBCPP_BEGIN_NAMESPACE_STD
75081c1db0SMark de Wever
76081c1db0SMark de Wever#if _LIBCPP_STD_VER > 17
77081c1db0SMark de Wever
78081c1db0SMark de Wever#endif //_LIBCPP_STD_VER > 17
79081c1db0SMark de Wever
80081c1db0SMark de Wever_LIBCPP_END_NAMESPACE_STD
81081c1db0SMark de Wever
82081c1db0SMark de Wever_LIBCPP_POP_MACROS
83081c1db0SMark de Wever
84d618a1ccSMark de Wever#endif // !defined(_LIBCPP_HAS_NO_INCOMPLETE_FORMAT)
85d618a1ccSMark de Wever
86081c1db0SMark de Wever#endif // _LIBCPP_FORMAT
87