mirror of
https://github.com/fmtlib/fmt.git
synced 2024-11-30 21:50:06 +00:00
Update paper
This commit is contained in:
parent
6c184efa75
commit
195d6a5663
@ -66,6 +66,7 @@ Victor Zverovich, victor.zverovich@gmail.com
|
|||||||
<a href="#Safety">Safety</a><br>
|
<a href="#Safety">Safety</a><br>
|
||||||
<a href="#Locale">Locale Support</a><br>
|
<a href="#Locale">Locale Support</a><br>
|
||||||
<a href="#PosArguments">Positional Arguments</a><br>
|
<a href="#PosArguments">Positional Arguments</a><br>
|
||||||
|
<a href="Performance">Performance</a><br>
|
||||||
<a href="Footprint">Binary Footprint</a><br>
|
<a href="Footprint">Binary Footprint</a><br>
|
||||||
<a href="#Wording">Proposed Wording</a><br>
|
<a href="#Wording">Proposed Wording</a><br>
|
||||||
<a href="#References">References</a><br>
|
<a href="#References">References</a><br>
|
||||||
@ -124,7 +125,8 @@ Therefore we propose a new syntax based on the ones used in Python
|
|||||||
<a href="#3">[3]</a>, the .NET family of languages <a href="#4">[4]</a>,
|
<a href="#3">[3]</a>, the .NET family of languages <a href="#4">[4]</a>,
|
||||||
and Rust <a href="#5">[5]</a>. This syntax employs <code>'{'</code> and
|
and Rust <a href="#5">[5]</a>. This syntax employs <code>'{'</code> and
|
||||||
<code>'}'</code> as replacement field delimiters instead of <code>'%'</code>
|
<code>'}'</code> as replacement field delimiters instead of <code>'%'</code>
|
||||||
and it is described in details in TODO:link. Here are some of the advantages:
|
and it is described in details in the <a href="#SyntaxRef">syntax reference</a>.
|
||||||
|
Here are some of the advantages:
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
@ -287,7 +289,7 @@ arguments because the word order may vary in different languages
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
<pre class="example">
|
<pre class="example">
|
||||||
<code>printf("String `%s' has %d characters\n", string, length(string)))</code>
|
<code>printf("String `%s' has %d characters\n", string, length(string)));</code>
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<p>A possible German translation of the format string might be:</p>
|
<p>A possible German translation of the format string might be:</p>
|
||||||
@ -299,12 +301,12 @@ arguments because the word order may vary in different languages
|
|||||||
<p>
|
<p>
|
||||||
using POSIX positional arguments <a href="#2">[2]</a>. Unfortunately these
|
using POSIX positional arguments <a href="#2">[2]</a>. Unfortunately these
|
||||||
positional specifiers are not portable <a href="#6">[6]</a>. The C++ I/O
|
positional specifiers are not portable <a href="#6">[6]</a>. The C++ I/O
|
||||||
streams don't support positional arguments by design because formatting
|
streams don't support such rearranging of arguments by design because they
|
||||||
arguments are interleaved with the portions of the literal string:
|
are interleaved with the portions of the literal string:
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<pre class="example">
|
<pre class="example">
|
||||||
<code>std::cout << "String `" << string << "' has " << length(string) << " characters\n"</code>
|
<code>std::cout << "String `" << string << "' has " << length(string) << " characters\n";</code>
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
@ -313,7 +315,7 @@ arguments, for example:
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
<pre class="example">
|
<pre class="example">
|
||||||
<code>std::format("String `{}' has {} characters\n", string, length(string)))</code>
|
<code>std::format("String `{}' has {} characters\n", string, length(string)));</code>
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<p>with the German translation of the format string:</p>
|
<p>with the German translation of the format string:</p>
|
||||||
@ -342,23 +344,33 @@ TODO: rephrase and mention format_args
|
|||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
<code>namespace std {
|
<code>namespace std {
|
||||||
|
class format_error;
|
||||||
|
|
||||||
class format_args;
|
class format_args;
|
||||||
|
|
||||||
template <class Char>
|
template <class Char>
|
||||||
basic_string<Char> format(const Char *fmt, format_args args);
|
basic_string<Char> format(const Char* fmt, format_args args);
|
||||||
|
|
||||||
template <class Char, class ...Args>
|
template <class Char, class ...Args>
|
||||||
basic_string<Char> format(const Char *fmt, const Args&... args);
|
basic_string<Char> format(const Char* fmt, const Args&... args);
|
||||||
}</code>
|
}</code>
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<h3>Format string syntax</h3>
|
<h3><a name="SyntaxRef">Format string syntax</a></h3>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Format strings contain <em>replacement fields</em> surrounded by curly braces
|
||||||
|
<code>{}</code>. Anything that is not contained in braces is considered literal
|
||||||
|
text, which is copied unchanged to the output. A brace character can be
|
||||||
|
included in the literal text by doubling: <code>{{</code> and <code>}}</code>.
|
||||||
|
The syntax for replacement fields is as follows:
|
||||||
|
</p>
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
<code>replacement-field ::= '{' [arg-id] [':' format-spec] '}'
|
<code>replacement-field ::= '{' [arg-id] [':' format-spec] '}'
|
||||||
arg-id ::= integer
|
arg-id ::= integer
|
||||||
integer ::= digit+
|
integer ::= digit+
|
||||||
digit ::= '0'...'9'
|
digit ::= '0'...'9'</code>
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<!-- The notation is the same as in n4296 22.4.3.1. -->
|
<!-- The notation is the same as in n4296 22.4.3.1. -->
|
||||||
@ -373,6 +385,61 @@ type ::= int-type | 'a' | 'A' | 'c' | 'e' | 'E' | 'f' | 'F' | 'g' | 'G'
|
|||||||
int-type ::= 'b' | 'B' | 'd' | 'o' | 'x' | 'X'</code>
|
int-type ::= 'b' | 'B' | 'd' | 'o' | 'x' | 'X'</code>
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
|
<h3>Class <code>format_error</code></h3>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
<code>class format_error : public std::runtime_error {
|
||||||
|
public:
|
||||||
|
explicit format_error(const string& what_arg);
|
||||||
|
explicit format_error(const char* what_arg);
|
||||||
|
};</code>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
The class <code>format_error</code> defines the type of objects thrown as
|
||||||
|
exceptions to report errors from the formatting library.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt><code>format_error(const string& what_arg);</code></dt>
|
||||||
|
<dd>
|
||||||
|
<p><i>Effects</i>: Constructs an object of class <code>format_error</code>.</p>
|
||||||
|
<p><i>Postcondition</i>: <code>strcmp(what(), what_arg.c_str()) == 0</code>.</p>
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt><code>format_error(const char* what_arg);</code></dt>
|
||||||
|
<dd>
|
||||||
|
<p><i>Effects</i>: Constructs an object of class <code>format_error</code>.</p>
|
||||||
|
<p><i>Postcondition</i>: <code>strcmp(what(), what_arg) == 0</code>.</p>
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<h3>Function template <code>format</code></h3>
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>
|
||||||
|
<pre>
|
||||||
|
<code>template <class Char>
|
||||||
|
basic_string<Char> format(const Char* fmt, format_args args);
|
||||||
|
|
||||||
|
template <class Char, class ...Args>
|
||||||
|
basic_string<Char> format(const Char* fmt, const Args&... args);</code>
|
||||||
|
</pre>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p><i>Requires</i>: <code>fmt</code> shall not be a null pointer.</p>
|
||||||
|
<p>
|
||||||
|
<i>Effects</i>: Each function returns a <code>basic_string</code> object
|
||||||
|
constructed from the format string argument <code>fmt</code> with each
|
||||||
|
replacement field substituted with the character representation of the
|
||||||
|
argument it refers to, formatted according to the specification given in the
|
||||||
|
field.
|
||||||
|
</p>
|
||||||
|
<p><i>Returns</i>: The formatted string.</p>
|
||||||
|
<p><i>Throws</i>: <code>format_error</code> if <code>fmt</code> is not a valid
|
||||||
|
format string.</p>
|
||||||
|
</dd>
|
||||||
|
|
||||||
<h2><a name="Implementation">Implementation</a></h2>
|
<h2><a name="Implementation">Implementation</a></h2>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
Loading…
Reference in New Issue
Block a user