P2093R14 Formatted output

Author: burblebee

source/back.tex

@@ -29,6 +29,11 @@ \chapter{Bibliography}
   Edited by Mark Davis. Revision 33; issued for Unicode 13.0.0.
   2020-02-13 [viewed 2021-06-08].
   Available from: \url{https://www.unicode.org/reports/tr31/tr31-33.html}
+\item
+  The Unicode Standard Version 14.0,
+  \doccite{Core Specification}, Chapter 3.9.
+  Unicode Consortium, ISBN 978-1-936213-29-0, copyright \copyright 2021 Unicode, Inc.
+  Available from: \url{https://www.unicode.org/versions/Unicode14.0.0/UnicodeStandard-14.0.pdf}
 \item
   IANA Time Zone Database.
   Available from: \url{https://www.iana.org/time-zones}

source/iostreams.tex

@@ -4162,6 +4162,14 @@
 
   template<class Ostream, class T>
     Ostream&& operator<<(Ostream&& os, const T& x);
+
+  template<class... Args>
+    void print(ostream& os, @\exposid{format-string}@<Args...> fmt, Args&&... args);
+  template<class... Args>
+    void println(ostream& os, @\exposid{format-string}@<Args...> fmt, Args&&... args);
+
+  void vprint_unicode(ostream& os, string_view fmt, format_args args);
+  void vprint_nonunicode(ostream& os, string_view fmt, format_args args);
 }
 \end{codeblock}
 
@@ -4203,6 +4211,29 @@
 }
 \end{codeblock}
 
+\rSec2[print.syn]{Header \tcode{<print>} synopsis}
+
+\indexheader{print}%
+\begin{codeblock}
+namespace std {
+  template<class... Args>
+    void print(@\exposid{format-string}@<Args...> fmt, Args&&... args);
+  template<class... Args>
+    void print(FILE* stream, @\exposid{format-string}@<Args...> fmt, Args&&... args);
+
+  template<class... Args>
+    void println(@\exposid{format-string}@<Args...> fmt, Args&&... args);
+  template<class... Args>
+    void println(FILE* stream, @\exposid{format-string}@<Args...> fmt, Args&&... args);
+
+  void vprint_unicode(string_view fmt, format_args args);
+  void vprint_unicode(FILE* stream, string_view fmt, format_args args);
+
+  void vprint_nonunicode(string_view fmt, format_args args);
+  void vprint_nonunicode(FILE* stream, string_view fmt, format_args args);
+}
+\end{codeblock}
+
 \rSec2[input.streams]{Input streams}
 
 \rSec3[input.streams.general]{General}
@@ -7462,6 +7493,255 @@
 \end{itemize}
 \end{itemdescr}
 
+\rSec2[print.fun]{Print functions}
+
+\indexlibraryglobal{print}%
+\begin{itemdecl}
+template<class... Args>
+  void print(@\exposid{format-string}@<Args...> fmt, Args&&... args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+Equivalent to:
+\begin{codeblock}
+print(stdout, fmt, std::forward<Args>(args)...);
+\end{codeblock}
+\end{itemdescr}
+
+\indexlibraryglobal{print}%
+\begin{itemdecl}
+template<class... Args>
+  void print(FILE* stream, @\exposid{format-string}@<Args...> fmt, Args&&... args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+If the ordinary literal encoding ([lex.charset]) is UTF-8, equivalent to:
+\begin{codeblock}
+vprint_unicode(stream, fmt.@\exposid{str}@, make_format_args(std::forward<Args>(args)...));
+\end{codeblock}
+Otherwise, equivalent to:
+\begin{codeblock}
+vprint_nonunicode(stream, fmt.@\exposid{str}@, make_format_args(std::forward<Args>(args)...));
+\end{codeblock}
+\end{itemdescr}
+
+\indexlibraryglobal{println}%
+\begin{itemdecl}
+template<class... Args>
+  void println(@\exposid{format-string}@<Args...> fmt, Args&&... args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+Equivalent to:
+\begin{codeblock}
+println(stdout, fmt, std::forward<Args>(args)...);
+\end{codeblock}
+\end{itemdescr}
+
+\indexlibraryglobal{println}%
+\begin{itemdecl}
+template<class... Args>
+  void println(FILE* stream, @\exposid{format-string}@<Args...> fmt, Args&&... args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+Equivalent to:
+\begin{codeblock}
+print(stream, "{}\n", format(fmt, std::forward<Args>(args)...));
+\end{codeblock}
+\end{itemdescr}
+
+\indexlibraryglobal{vprint_unicode}%
+\begin{itemdecl}
+void vprint_unicode(string_view fmt, format_args args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+Equivalent to:
+\begin{codeblock}
+vprint_unicode(stdout, fmt, args);
+\end{codeblock}
+\end{itemdescr}
+
+\indexlibraryglobal{vprint_unicode}%
+\begin{itemdecl}
+void vprint_unicode(FILE* stream, string_view fmt, format_args args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\expects
+\tcode{stream} is a valid pointer to an output C stream.
+
+\pnum
+\effects
+The function initializes an automatic variable via
+\begin{codeblock}
+string out = vformat(fmt, args);
+\end{codeblock}
+If \tcode{stream} refers to a terminal capable of displaying Unicode,
+writes \tcode{out} to the terminal using the native Unicode API;
+if \tcode{out} contains invalid code units,
+\indextext{undefined}%
+the behavior is undefined and
+implementations are encouraged to diagnose it.
+Otherwise writes \tcode{out} to \tcode{stream} unchanged.
+\begin{note}
+On POSIX and Windows, \tcode{stream} referring to a terminal means that,
+respectively,
+\tcode{isatty(fileno(\linebreak{}stream))} and
+\tcode{GetConsoleMode(_get_osfhandle(_fileno(stream)), ...)}
+return nonzero.
+\end{note}
+\begin{note}
+On Windows, the native Unicode API is \tcode{WriteConsoleW}.
+\end{note}
+
+\pnum
+\throws
+Any exception thrown by the call to \tcode{vformat}\iref{format.err.report}.
+\tcode{system_error} if writing to the terminal or \tcode{stream} fails.
+May throw \tcode{bad_alloc}.
+
+\pnum
+\recommended
+If invoking the native Unicode API requires transcoding,
+implementations should substitute invalid code units
+with \unicode{fffd}{replacement character} per
+The Unicode Standard Version 14.0 - Core Specification, Chapter 3.9.
+\end{itemdescr}
+
+\indexlibraryglobal{vprint_nonunicode}%
+\begin{itemdecl}
+void vprint_nonunicode(string_view fmt, format_args args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+Equivalent to:
+\begin{codeblock}
+vprint_nonunicode(stdout, fmt, args);
+\end{codeblock}
+\end{itemdescr}
+
+\indexlibraryglobal{vprint_nonunicode}%
+\begin{itemdecl}
+void vprint_nonunicode(FILE* stream, string_view fmt, format_args args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\expects
+\tcode{stream} is a valid pointer to an output C stream.
+
+\pnum
+\effects
+Writes the result of \tcode{vformat(fmt, args)} to \tcode{stream}.
+
+\pnum
+\throws
+Any exception thrown by the call to \tcode{vformat}\iref{format.err.report}.
+\tcode{system_error} if writing to \tcode{stream} fails.
+May throw \tcode{bad_alloc}.
+\end{itemdescr}
+
+\rSec2[ostream.formatted.print]{Print}
+
+\indexlibraryglobal{print}%
+\begin{itemdecl}
+template<class... Args>
+  void print(ostream& os, @\exposid{format-string}@<Args...> fmt, Args&&... args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+If the ordinary literal encoding\iref{lex.charset} is UTF-8, equivalent to:
+\begin{codeblock}
+vprint_unicode(os, fmt.@\exposid{str}@, make_format_args(std::forward<Args>(args)...));
+\end{codeblock}
+Otherwise, equivalent to:
+\begin{codeblock}
+vprint_nonunicode(os, fmt.@\exposid{str}@, make_format_args(std::forward<Args>(args)...));
+\end{codeblock}
+\end{itemdescr}
+
+\indexlibraryglobal{println}%
+\begin{itemdecl}
+template<class... Args>
+  void println(ostream& os, @\exposid{format-string}@<Args...> fmt, Args&&... args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+Equivalent to:
+\begin{codeblock}
+print(os, "{}\n", format(fmt, std::forward<Args>(args)...));
+\end{codeblock}
+\end{itemdescr}
+
+\indexlibraryglobal{vprint_unicode}%
+\indexlibraryglobal{vprint_nonunicode}%
+\begin{itemdecl}
+void vprint_unicode(ostream& os, string_view fmt, format_args args);
+void vprint_nonunicode(ostream& os, string_view fmt, format_args args);
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\effects
+Behaves as a formatted output function\iref{ostream.formatted.reqmts}
+of \tcode{os}, except that:
+\begin{itemize}
+\item
+failure to generate output is reported as specified below, and
+\item
+any exception thrown by the call to \tcode{vformat} is propagated
+without regard to the value of \tcode{os.exceptions()} and
+without turning on \tcode{ios_base::badbit} in the error state of \tcode{os}.
+\end{itemize}
+After constructing a \tcode{sentry} object,
+the function initializes an automatic variable via
+\begin{codeblock}
+string out = vformat(os.getloc(), fmt, args);
+\end{codeblock}
+If the function is \tcode{vprint_unicode} and
+\tcode{os} is a stream that refers to a terminal capable of displaying Unicode
+which is determined in an implementation-defined manner,
+writes \tcode{out} to the terminal using the native Unicode API;
+if \tcode{out} contains invalid code units,
+\indextext{undefined}%
+the behavior is undefined and
+implementations are encouraged to diagnose it.
+Otherwise (if \tcode{os} is not such a stream or
+the function is \tcode{vprint_nonunicode}),
+inserts the character sequence
+\tcode{[out.begin(), out.end())} into \tcode{os}.
+If writing to the terminal or inserting into \tcode{os} fails,
+calls \tcode{os.setstate(ios_base::badbit)}
+(which may throw \tcode{ios_base::failure}).
+
+\pnum
+\recommended
+For \tcode{vprint_unicode},
+if invoking the native Unicode API requires transcoding,
+implementations should substitute invalid code units
+with \unicode{fffd}{replacement character} per
+The Unicode Standard Version 14.0 - Core Specification, Chapter 3.9.
+\end{itemdescr}
+
 \rSec1[string.streams]{String-based streams}
 
 \rSec2[sstream.syn]{Header \tcode{<sstream>} synopsis}

source/lib-intro.tex

@@ -1056,6 +1056,7 @@
 \tcode{<numeric>} \\
 \tcode{<optional>} \\
 \tcode{<ostream>} \\
+\tcode{<print>} \\
 \tcode{<queue>} \\
 \tcode{<random>} \\
 \tcode{<ranges>} \\

source/support.tex

@@ -668,6 +668,7 @@
 #define @\defnlibxname{cpp_lib_out_ptr}@                           202106L // also in \libheader{memory}
 #define @\defnlibxname{cpp_lib_parallel_algorithm}@                201603L // also in \libheader{algorithm}, \libheader{numeric}
 #define @\defnlibxname{cpp_lib_polymorphic_allocator}@             201902L // also in \libheader{memory_resource}
+#define @\defnlibxname{cpp_lib_print}@                             202207L // also in \libheader{print}, \libheader{ostream}
 #define @\defnlibxname{cpp_lib_quoted_string_io}@                  201304L // also in \libheader{iomanip}
 #define @\defnlibxname{cpp_lib_ranges}@                            202202L
   // also in \libheader{algorithm}, \libheader{functional}, \libheader{iterator}, \libheader{memory}, \libheader{ranges}