aboutsummaryrefslogtreecommitdiff
path: root/libstdc++-v3/include/std/print
blob: 459bb9fb746205e6d611a62fed81b14ba0d2c111 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
// <print> Print functions -*- C++ -*-

// Copyright The GNU Toolchain Authors.
//
// This file is part of the GNU ISO C++ Library.  This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
// Free Software Foundation; either version 3, or (at your option)
// any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.

// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
// <http://www.gnu.org/licenses/>.

/** @file include/print
 *  This is a Standard C++ Library header.
 */

#ifndef _GLIBCXX_PRINT
#define _GLIBCXX_PRINT 1

#ifdef _GLIBCXX_SYSHDR
#pragma GCC system_header
#endif

#include <bits/requires_hosted.h> // for std::format

#define __glibcxx_want_print
#include <bits/version.h>

#ifdef __cpp_lib_print // C++ >= 23

#include <format>             // format_args (TODO: move to bits/formatfwd.h?)
#include <cstdio>             // FILE, EOF, putc
#include <cerrno>             // EACCES, EIO
#include <bits/functexcept.h> // __throw_system_error

#ifdef _WIN32
# include <system_error>
#endif

#ifndef _GLIBCXX_NO_INLINE_PRINT
# include <bits/print.h>
#endif

namespace std _GLIBCXX_VISIBILITY(default)
{
_GLIBCXX_BEGIN_NAMESPACE_VERSION

  void
  vprint_nonunicode(FILE* __stream, string_view __fmt, format_args __args);

  void
  vprint_nonunicode_buffered(FILE* __stream, string_view __fmt,
			     format_args __args);

  void
  vprint_unicode(FILE* __stream, string_view __fmt, format_args __args);

  void
  vprint_unicode_buffered(FILE* __stream, string_view __fmt,
			  format_args __args);

  void
  vprint_unicode_buffered(string_view __fmt, format_args __args);

  void
  vprint_nonunicode_buffered(string_view __fmt, format_args __args);

  template<typename... _Args>
    inline void
    print(FILE* __stream, format_string<_Args...> __fmt, _Args&&... __args)
    {
      constexpr bool __locksafe =
	(enable_nonlocking_formatter_optimization<remove_cvref_t<_Args>> && ...);

      auto __fmtargs = std::make_format_args(__args...);
#if defined(_WIN32) && !defined(__CYGWIN__)
      if constexpr (__unicode::__literal_encoding_is_utf8())
	std::vprint_unicode_buffered(__stream, __fmt.get(), __fmtargs);
      else
#endif

      if constexpr (__locksafe)
	std::vprint_nonunicode(__stream, __fmt.get(), __fmtargs);
      else
	std::vprint_nonunicode_buffered(__stream, __fmt.get(), __fmtargs);
    }

  template<typename... _Args>
    inline void
    print(format_string<_Args...> __fmt, _Args&&... __args)
    { std::print(stdout, __fmt, std::forward<_Args>(__args)...); }

  template<typename... _Args>
    inline void
    println(FILE* __stream, format_string<_Args...> __fmt, _Args&&... __args)
    {
      constexpr bool __locksafe =
	(enable_nonlocking_formatter_optimization<remove_cvref_t<_Args>> && ...);

      // The standard wants us to call
      // print(stream, dynamic_format(string(fmt.get()) + '\n'), args...)
      // here, but we can avoid that string concatenation in most cases,
      // and we know what that would call, so we can call that directly.

      auto __fmtargs = std::make_format_args(__args...);

#if defined(_WIN32) && !defined(__CYGWIN__)
      if constexpr (__unicode::__literal_encoding_is_utf8())
	{
	  // We can't avoid the string concatenation here, but we can call
	  // vprint_unicode_buffered directly, since that's what print would do.
	  string __fmtn;
	  __fmtn.reserve(__fmt.get().size() + 1);
	  __fmtn = __fmt.get();
	  __fmtn += '\n';
	  std::vprint_unicode_buffered(__stream, __fmtn, __fmtargs);
	}
      else
#endif

#ifdef _GLIBCXX_NO_INLINE_PRINT
	{
	  string __fmtn;
	  __fmtn.reserve(__fmt.get().size() + 1);
	  __fmtn = __fmt.get();
	  __fmtn += '\n';
	  std::vprint_nonunicode(__stream, __fmtn, __fmtargs);
	}
#else
      // For non-Windows and for non-Unicode on Windows, we know that print
      // would call vprint_nonunicode or vprint_nonunicode_buffered with a
      // newline appended to the format-string. Use a _File_sink that adds
      // the newline automatically and write to it directly.
      if constexpr (__locksafe)
	std::vformat_to(__format::_File_sink(__stream, true).out(),
			__fmt.get(), __fmtargs);
      else
	{
	  // Format to a string buffer first, then write the result to a
	  // _File_sink that adds a newline.
	  __format::_Str_sink<char> __buf;
	  std::vformat_to(__buf.out(), __fmt.get(), __fmtargs);
	  string_view __s(__buf.view());
	  __format::_File_sink(__stream, true).out() = __s;
	}
#endif
    }

  template<typename... _Args>
    inline void
    println(format_string<_Args...> __fmt, _Args&&... __args)
    { std::println(stdout, __fmt, std::forward<_Args>(__args)...); }

  inline void
  vprint_unicode_buffered(string_view __fmt, format_args __args)
  { std::vprint_unicode_buffered(stdout, __fmt, __args); }

  inline void
  vprint_nonunicode_buffered(string_view __fmt, format_args __args)
  { std::vprint_nonunicode_buffered(stdout, __fmt, __args); }

  // Defined for C++26, supported as an extension to C++23.
  inline void println(FILE* __stream)
  {
#if defined(_WIN32) && !defined(__CYGWIN__)
    if constexpr (__unicode::__literal_encoding_is_utf8())
      std::vprint_unicode_buffered(__stream, "\n", std::make_format_args());
    else
#endif
      if (std::putc('\n', __stream) == EOF)
	__throw_system_error(EIO);
  }

  inline void println() { std::println(stdout); }

_GLIBCXX_END_NAMESPACE_VERSION
} // namespace std
#endif // __cpp_lib_print
#endif // _GLIBCXX_PRINT