From 371e813d7c6a200ae24f84d2d8dce94ee67115f1 Mon Sep 17 00:00:00 2001 From: "A. Jiang" Date: Tue, 13 Oct 2026 13:41:06 +0800 Subject: [PATCH] [format] Clean up exposition-only names for `` components Apply italic style, use trailing underscore and kebab-case for single- and multi-component names respectively. In _`dynamic-format-string`_ and `basic_format_string`: - _`str`_ -> _`str_`_ In `basic_format_parse_context`: - _`indexing`_ -> _`indexing-t`_ (to avoid conflict) - _`unknown`_ -> _`unknown_`_ - _`manual`_ -> _`manual_`_ - _`automatic`_ -> _`automatic_`_ - _`next_arg_id_`_ -> _`num-arg-id`_ - _`num_args_`_ -> _`num-args`_ In `range_formatter` and `formatter`: - _`opening-bracket_`_ -> _`opening-bracket`_ - _`closing-bracket_`_ -> _`closing-bracket`_ In _`format-arg-store`_: - _`args`_ -> _`args_`_ --- source/text.tex | 132 ++++++++++++++++++++++++------------------------ 1 file changed, 66 insertions(+), 66 deletions(-) diff --git a/source/text.tex b/source/text.tex index 10e3a416be..9c20723782 100644 --- a/source/text.tex +++ b/source/text.tex @@ -5758,9 +5758,9 @@ template struct @\exposid{dynamic-format-string}@ { // \expos private: - basic_string_view @\exposid{str}@; // \expos + basic_string_view @\exposid{str_}@; // \expos public: - constexpr @\exposid{dynamic-format-string}@(basic_string_view s) noexcept : @\exposid{str}@(s) {} + constexpr @\exposid{dynamic-format-string}@(basic_string_view s) noexcept : @\exposid{str_}@(s) {} @\exposid{dynamic-format-string}@(const @\exposid{dynamic-format-string}@&) = delete; @\exposid{dynamic-format-string}@& operator=(const @\exposid{dynamic-format-string}@&) = delete; }; @@ -6691,13 +6691,13 @@ template struct @\libglobal{basic_format_string}@ { private: - basic_string_view @\exposidnc{str}@; // \expos + basic_string_view @\exposidnc{str_}@; // \expos public: template consteval basic_format_string(const T& s); - constexpr basic_format_string(@\exposid{dynamic-format-string}@ s) noexcept : str(s.@\exposid{str}@) {} + constexpr basic_format_string(@\exposid{dynamic-format-string}@ s) noexcept : str(s.@\exposid{str_}@) {} - constexpr basic_string_view get() const noexcept { return @\exposid{str}@; } + constexpr basic_string_view get() const noexcept { return @\exposid{str_}@; } }; } \end{codeblock} @@ -6713,13 +6713,13 @@ \pnum \effects -Direct-non-list-initializes \exposid{str} with \tcode{s}. +Direct-non-list-initializes \exposid{str_} with \tcode{s}. \pnum \remarks A call to this function is not a core constant expression\iref{expr.const.core} unless there exist \tcode{args} of types \tcode{Args} -such that \exposid{str} is a format string for \tcode{args}. +such that \exposid{str_} is a format string for \tcode{args}. \end{itemdescr} \rSec2[format.functions]{Formatting functions} @@ -6747,7 +6747,7 @@ \effects Equivalent to: \begin{codeblock} -return vformat(fmt.@\exposid{str}@, make_format_args(args...)); +return vformat(fmt.@\exposid{str_}@, make_format_args(args...)); \end{codeblock} \end{itemdescr} @@ -6762,7 +6762,7 @@ \effects Equivalent to: \begin{codeblock} -return vformat(fmt.@\exposid{str}@, make_wformat_args(args...)); +return vformat(fmt.@\exposid{str_}@, make_wformat_args(args...)); \end{codeblock} \end{itemdescr} @@ -6777,7 +6777,7 @@ \effects Equivalent to: \begin{codeblock} -return vformat(loc, fmt.@\exposid{str}@, make_format_args(args...)); +return vformat(loc, fmt.@\exposid{str_}@, make_format_args(args...)); \end{codeblock} \end{itemdescr} @@ -6792,7 +6792,7 @@ \effects Equivalent to: \begin{codeblock} -return vformat(loc, fmt.@\exposid{str}@, make_wformat_args(args...)); +return vformat(loc, fmt.@\exposid{str_}@, make_wformat_args(args...)); \end{codeblock} \end{itemdescr} @@ -6828,7 +6828,7 @@ \effects Equivalent to: \begin{codeblock} -return vformat_to(std::move(out), fmt.@\exposid{str}@, make_format_args(args...)); +return vformat_to(std::move(out), fmt.@\exposid{str_}@, make_format_args(args...)); \end{codeblock} \end{itemdescr} @@ -6843,7 +6843,7 @@ \effects Equivalent to: \begin{codeblock} -return vformat_to(std::move(out), fmt.@\exposid{str}@, make_wformat_args(args...)); +return vformat_to(std::move(out), fmt.@\exposid{str_}@, make_wformat_args(args...)); \end{codeblock} \end{itemdescr} @@ -6858,7 +6858,7 @@ \effects Equivalent to: \begin{codeblock} -return vformat_to(std::move(out), loc, fmt.@\exposid{str}@, make_format_args(args...)); +return vformat_to(std::move(out), loc, fmt.@\exposid{str_}@, make_format_args(args...)); \end{codeblock} \end{itemdescr} @@ -6873,7 +6873,7 @@ \effects Equivalent to: \begin{codeblock} -return vformat_to(std::move(out), loc, fmt.@\exposid{str}@, make_wformat_args(args...)); +return vformat_to(std::move(out), loc, fmt.@\exposid{str_}@, make_wformat_args(args...)); \end{codeblock} \end{itemdescr} @@ -6943,7 +6943,7 @@ \pnum Let \begin{itemize} -\item \tcode{charT} be \tcode{decltype(fmt.\exposid{str})::value_type}, +\item \tcode{charT} be \tcode{decltype(fmt.\exposid{str_})::value_type}, \item \tcode{N} be \tcode{formatted_size(fmt, args...)} for the functions without a \tcode{loc} parameter and \tcode{formatted_size(loc, fmt, args...)} for the functions with a \tcode{loc} parameter, and @@ -6992,7 +6992,7 @@ \begin{itemdescr} \pnum -Let \tcode{charT} be \tcode{decltype(fmt.\exposid{str})::value_type}. +Let \tcode{charT} be \tcode{decltype(fmt.\exposid{str_})::value_type}. \pnum \expects @@ -7502,12 +7502,12 @@ using iterator = const_iterator; private: - iterator begin_; // \expos - iterator end_; // \expos - enum indexing { unknown, manual, automatic }; // \expos - indexing indexing_; // \expos - size_t next_arg_id_; // \expos - size_t num_args_; // \expos + iterator @\exposid{begin_}@; // \expos + iterator @\exposid{end_}@; // \expos + enum @\exposid{indexing-t}@ { @\exposid{unknown_}@, @\exposid{manual_}@, @\exposid{automatic_}@ }; // \expos + @\exposid{indexing-t}@ @\exposid{indexing_}@; // \expos + size_t @\exposid{next-arg-id}@; // \expos + size_t @\exposid{num-args}@; // \expos public: constexpr explicit basic_format_parse_context(basic_string_view fmt) noexcept; @@ -7549,11 +7549,11 @@ \pnum \effects Initializes -\tcode{begin_} with \tcode{fmt.begin()}, -\tcode{end_} with \tcode{fmt.end()}, -\tcode{indexing_} with \tcode{unknown}, -\tcode{next_arg_id_} with \tcode{0}, and -\tcode{num_args_} with \tcode{0}. +\exposid{begin_} with \tcode{fmt.begin()}, +\exposid{end_} with \tcode{fmt.end()}, +\exposid{indexing_} with \exposid{unknown_}, +\exposid{next-arg-id} with \tcode{0}, and +\exposid{num-args} with \tcode{0}. \begin{note} Any call to \tcode{next_arg_id}, \tcode{check_arg_id}, or \tcode{check_dynamic_spec} @@ -7570,7 +7570,7 @@ \begin{itemdescr} \pnum \returns -\tcode{begin_}. +\exposid{begin_}. \end{itemdescr} \indexlibrarymember{end}{basic_format_parse_context}% @@ -7581,7 +7581,7 @@ \begin{itemdescr} \pnum \returns -\tcode{end_}. +\exposid{end_}. \end{itemdescr} \indexlibrarymember{advance_to}{basic_format_parse_context}% @@ -7596,7 +7596,7 @@ \pnum \effects -Equivalent to: \tcode{begin_ = it;} +Equivalent to: \tcode{\exposid{begin_} = it;} \end{itemdescr} \indexlibrarymember{next_arg_id}{basic_format_parse_context}% @@ -7607,24 +7607,24 @@ \begin{itemdescr} \pnum \effects -If \tcode{indexing_ != manual} is \tcode{true}, equivalent to: +If \tcode{\exposid{indexing_} != \exposid{manual_}} is \tcode{true}, equivalent to: \begin{codeblock} -if (indexing_ == unknown) - indexing_ = automatic; -return next_arg_id_++; +if (@\exposid{indexing_}@ == @\exposid{unknown_}@) + @\exposid{indexing_}@ = @\exposid{automatic_}@; +return @\exposid{next-arg-id}@++; \end{codeblock} \pnum \throws -\tcode{format_error} if \tcode{indexing_ == manual} is \tcode{true}. +\tcode{format_error} if \tcode{\exposid{indexing_} == \exposid{manual_}} is \tcode{true}. \begin{note} This indicates mixing of automatic and manual argument indexing. \end{note} \pnum \remarks -Let \tcode{\placeholder{cur-arg-id}} be the value of \tcode{next_arg_id_} prior to this call. -Call expressions where \tcode{\placeholder{cur-arg-id} >= num_args_} is \tcode{true} +Let \tcode{\placeholder{cur-arg-id}} be the value of \exposid{next-arg-id} prior to this call. +Call expressions where \tcode{\placeholder{cur-arg-id} >= \exposid{num-args}} is \tcode{true} are not core constant expressions\iref{expr.const.core}. \end{itemdescr} @@ -7636,16 +7636,16 @@ \begin{itemdescr} \pnum \effects -If \tcode{indexing_ != automatic} is \tcode{true}, equivalent to: +If \tcode{\exposid{indexing_} != \exposid{automatic_}} is \tcode{true}, equivalent to: \begin{codeblock} -if (indexing_ == unknown) - indexing_ = manual; +if (@\exposid{indexing_}@ == @\exposid{unknown_}@) + @\exposid{indexing_}@ = @\exposid{manual_}@; \end{codeblock} \pnum \throws \tcode{format_error} if -\tcode{indexing_ == automatic} is \tcode{true}. +\tcode{\exposid{indexing_} == \exposid{automatic_}} is \tcode{true}. \begin{note} This indicates mixing of automatic and manual argument indexing. \end{note} @@ -7653,7 +7653,7 @@ \pnum \remarks A call to this function is a core constant expression\iref{expr.const.core} only if -\tcode{id < num_args_} is \tcode{true}. +\tcode{id < \exposid{num-args}} is \tcode{true}. \end{itemdescr} \indexlibrarymember{check_dynamic_spec}{basic_format_parse_context}% @@ -7686,7 +7686,7 @@ A call to this function is a core constant expression only if \begin{itemize} \item -\tcode{id < num_args_} is \tcode{true} and +\tcode{id < \exposid{num-args}} is \tcode{true} and \item the type of the corresponding format argument (after conversion to \tcode{basic_format_arg}) is one of the types in \tcode{Ts...}. @@ -7731,8 +7731,8 @@ namespace std { template class basic_format_context { - basic_format_args args_; // \expos - Out out_; // \expos + basic_format_args @\exposid{args_}@; // \expos + Out @\exposid{out_}@; // \expos basic_format_context(const basic_format_context&) = delete; basic_format_context& operator=(const basic_format_context&) = delete; @@ -7796,7 +7796,7 @@ \begin{itemdescr} \pnum \returns -\tcode{args_.get(id)}. +\tcode{\exposid{args_}.get(id)}. \end{itemdescr} \indexlibrarymember{locale}{basic_format_context}% @@ -7820,7 +7820,7 @@ \begin{itemdescr} \pnum \effects -Equivalent to: \tcode{return std::move(out_);} +Equivalent to: \tcode{return std::move(\exposid{out_});} \end{itemdescr} \indexlibrarymember{advance_to}{basic_format_context}% @@ -7831,7 +7831,7 @@ \begin{itemdescr} \pnum \effects -Equivalent to: \tcode{out_ = std::move(it);} +Equivalent to: \tcode{\exposid{out_} = std::move(it);} \end{itemdescr} \indextext{left-pad}% @@ -7945,8 +7945,8 @@ class range_formatter { formatter @\exposid{underlying_}@; // \expos basic_string_view @\exposid{separator_}@ = @\exposid{STATICALLY-WIDEN}@(", "); // \expos - basic_string_view @\exposid{opening-bracket_}@ = @\exposid{STATICALLY-WIDEN}@("["); // \expos - basic_string_view @\exposid{closing-bracket_}@ = @\exposid{STATICALLY-WIDEN}@("]"); // \expos + basic_string_view @\exposid{opening-bracket}@ = @\exposid{STATICALLY-WIDEN}@("["); // \expos + basic_string_view @\exposid{closing-bracket}@ = @\exposid{STATICALLY-WIDEN}@("]"); // \expos public: constexpr void set_separator(basic_string_view sep) noexcept; @@ -8088,8 +8088,8 @@ \effects Equivalent to: \begin{codeblock} -@\exposid{opening-bracket_}@ = opening; -@\exposid{closing-bracket_}@ = closing; +@\exposid{opening-bracket}@ = opening; +@\exposid{closing-bracket}@ = closing; \end{codeblock} \end{itemdescr} @@ -8109,7 +8109,7 @@ \fmtgrammarterm{format-spec} in \fmtgrammarterm{range-format-spec} or, if the latter is not present, an empty \fmtgrammarterm{format-spec}. The values of -\exposid{opening-bracket_}, \exposid{closing-bracket_}, and \exposid{separator_} +\exposid{opening-bracket}, \exposid{closing-bracket}, and \exposid{separator_} are modified if and only if required by the \fmtgrammarterm{range-type} or the \tcode{n} option, if present. If: @@ -8155,7 +8155,7 @@ Otherwise, \begin{itemize} \item -\exposid{opening-bracket_}, +\exposid{opening-bracket}, \item for each element \tcode{e} of the range \tcode{r}: \begin{itemize} @@ -8165,7 +8165,7 @@ \exposid{separator_}, unless \tcode{e} is the last element of \tcode{r}, and \end{itemize} \item -\exposid{closing-bracket_}. +\exposid{closing-bracket}. \end{itemize} \end{itemize} @@ -8701,7 +8701,7 @@ namespace std { template class @\exposidnc{format-arg-store}@ { // \expos - array, sizeof...(Args)> @\exposidnc{args}@; // \expos + array, sizeof...(Args)> @\exposidnc{args_}@; // \expos }; } \end{codeblock} @@ -8791,7 +8791,7 @@ \effects Initializes \exposid{size_} with \tcode{sizeof...(Args)} and -\exposid{data_} with \tcode{store.\exposid{args}.data()}. +\exposid{data_} with \tcode{store.\exposid{args_}.data()}. \end{itemdescr} \indexlibrarymember{get}{basic_format_args}% @@ -8820,8 +8820,8 @@ private: tuple, charT>...> @\exposid{underlying_}@; // \expos basic_string_view @\exposid{separator_}@ = @\exposid{STATICALLY-WIDEN}@(", "); // \expos - basic_string_view @\exposid{opening-bracket_}@ = @\exposid{STATICALLY-WIDEN}@("("); // \expos - basic_string_view @\exposid{closing-bracket_}@ = @\exposid{STATICALLY-WIDEN}@(")"); // \expos + basic_string_view @\exposid{opening-bracket}@ = @\exposid{STATICALLY-WIDEN}@("("); // \expos + basic_string_view @\exposid{closing-bracket}@ = @\exposid{STATICALLY-WIDEN}@(")"); // \expos public: constexpr void set_separator(basic_string_view sep) noexcept; @@ -8929,8 +8929,8 @@ \effects Equivalent to: \begin{codeblock} -@\exposid{opening-bracket_}@ = opening; -@\exposid{closing-bracket_}@ = closing; +@\exposid{opening-bracket}@ = opening; +@\exposid{closing-bracket}@ = closing; \end{codeblock} \end{itemdescr} @@ -8947,8 +8947,8 @@ Parses the format specifiers as a \fmtgrammarterm{tuple-format-spec} and stores the parsed specifiers in \tcode{*this}. The values of -\exposid{opening-bracket_}, -\exposid{closing-bracket_}, and +\exposid{opening-bracket}, +\exposid{closing-bracket}, and \exposid{separator_} are modified if and only if required by the \fmtgrammarterm{tuple-type}, if present. @@ -8987,7 +8987,7 @@ adjusted according to the \fmtgrammarterm{tuple-format-spec}: \begin{itemize} \item -\exposid{opening-bracket_}, +\exposid{opening-bracket}, \item for each index \tcode{I} in the \range{0}{sizeof...(Ts)}: \begin{itemize} @@ -8998,7 +8998,7 @@ via \tcode{get(\exposid{underlying_})}, and \end{itemize} \item -\exposid{closing-bracket_}. +\exposid{closing-bracket}. \end{itemize} \pnum