-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgroup_fmt_spec.html
More file actions
243 lines (156 loc) · 11.2 KB
/
Copy pathgroup_fmt_spec.html
File metadata and controls
243 lines (156 loc) · 11.2 KB
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Format specifier</title>
<link rel="stylesheet" href="_static/css/redactor.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/doxyrest-pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="fmtparser documentation" href="index.html"/>
<link rel="next" title="Format specifier fields" href="group_fmt_spec_fields.html"/>
<link rel="prev" title="Utility functions" href="group_fmt_util.html"/>
</head>
<body role="document">
<a href="#" id="js-navigation-toggle" class="navigation-toggle">
<i class="mdi mdi-menu"></i><i class="mdi mdi-close"></i>
</a>
<section class="site-sidebar">
<nav>
<a href="index.html" class="branding-link">
<img src="_static/fmtparser.png" class="logo" />
</a>
<section role="search">
<form action="search.html" method="get" class="site-searchform">
<input type="text" name="q" placeholder="Search in documentation" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</section>
<section class="site-nav">
<p class="caption"><span class="caption-text">Core API</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="example.html">Simple API usage example</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_fmt_parser.html">Parser API</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_fmt_util.html">Utility functions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Format specifier</a><ul>
<li class="toctree-l2"><a class="reference internal" href="group_fmt_spec_fields.html">Format specifier fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="group_fmt_spec_api.html">Specifier API</a></li>
<li class="toctree-l2"><a class="reference internal" href="struct_fmt_spec.html">struct fmt_spec</a></li>
<li class="toctree-l2"><a class="reference internal" href="#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="#detailed-documentation">Detailed Documentation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#typedefs">Typedefs</a></li>
<li class="toctree-l3"><a class="reference internal" href="#macros">Macros</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="group_fmt_spec_api.html">Specifier API</a></li>
</ul>
<p class="caption"><span class="caption-text">Advanced topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="global.html">Global Namespace</a></li>
</ul>
</section>
</nav>
</section>
<main class="site-main" role="main">
<nav class="site-breadcrumbs">
<ul>
<li>
<a href="index.html">Documentation</a> /
</li>
<li class="site-breadcrumbs__leaf">Format specifier</li>
</ul>
</nav>
<section class="site-content">
<div class="container">
<div class="section" id="format-specifier">
<span id="doxid-group-fmt-spec"></span><span id="index-0"></span><h1>Format specifier<a class="headerlink" href="#format-specifier" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>Format specifier is a single segment parsed from the format string. <a class="reference internal" href="#details-group-fmt-spec"><span class="std std-ref">More…</span></a></p>
<div class="line-block">
<div class="line"><a class="reference internal" href="group_fmt_spec_fields.html#doxid-group-fmt-spec-fields"><span class="std std-ref">Format specifier fields</span></a></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="group_fmt_spec_len.html#doxid-group-fmt-spec-len"><span class="std std-ref">Length specifier</span></a></div>
<div class="line"><a class="reference internal" href="group_fmt_spec_kind.html#doxid-group-fmt-spec-kind"><span class="std std-ref">Specifier kind</span></a></div>
<div class="line"><a class="reference internal" href="group_fmt_spec_type.html#doxid-group-fmt-spec-type"><span class="std std-ref">Specifier type</span></a></div>
</div>
<div class="line"><a class="reference internal" href="group_fmt_spec_api.html#doxid-group-fmt-spec-api"><span class="std std-ref">Specifier API</span></a></div>
</div>
<pre class="highlight doxyrest-overview-code-block literal-block"><span></span><span class="c1">// typedefs</span>
<span class="k">typedef</span> <span class="kt">char</span> <a class="reference internal" href="#doxid-group-fmt-spec-1ga2c58053187af69849e7c6950b590f85f"><span class="std std-ref">fmt_char</span></a><span></span><span class="p">;</span>
<span class="k">typedef</span> <span class="k">struct</span> <a class="reference internal" href="struct_fmt_spec.html#doxid-structfmt-spec"><span class="std std-ref">fmt_spec</span></a><span></span> <a class="reference internal" href="#doxid-group-fmt-spec-1ga0ac5e440156439f9e79545d857291966"><span class="std std-ref">fmt_spec</span></a><span></span><span class="p">;</span>
<span class="c1">// structs</span>
<span class="k">struct</span> <a class="reference internal" href="struct_fmt_spec.html#doxid-structfmt-spec"><span class="std std-ref">fmt_spec</span></a><span></span><span class="p">;</span>
<span class="c1">// macros</span>
<span class="cp">#define </span><a class="reference internal" href="#doxid-group-fmt-spec-1ga4b67d92635dcc1af2776f2fdfa33067d"><span class="std std-ref">FMT_CHAR_CONV</span></a><span></span><span class="p">(</span><span class="n">__chr</span><span class="p">)</span>
<span class="cp">#define </span><a class="reference internal" href="#doxid-group-fmt-spec-1gae760f6a95479e528fbbf5261c2c02a43"><span class="std std-ref">FMT_CHAR_TYPE</span></a><span></span>
<span class="cp">#define </span><span class="doxyrest-code-target target" id="doxid-group-fmt-spec-1gaef1d8819750f4428d636732c7209edd0"><span></span><span class="n">FMT_CHAR_TYPE_DEFAULT</span></span><span></span>
<span class="cp">#define </span><a class="reference internal" href="#doxid-group-fmt-spec-1ga8808bbceb0038d1dc9cecbc5de8ff690"><span class="std std-ref">FMT_VALUE_NOT_DEFINED</span></a><span></span>
<span class="cp">#define </span><a class="reference internal" href="#doxid-group-fmt-spec-1ga15038326b136a214ac01c816ecaeea23"><span class="std std-ref">FMT_VALUE_OUT_OF_LINE</span></a></pre>
</div>
<div class="section" id="detailed-documentation">
<span id="details-group-fmt-spec"></span><h2>Detailed Documentation<a class="headerlink" href="#detailed-documentation" title="Permalink to this headline">¶</a></h2>
<p>Format specifier is a single segment parsed from the format string. There may be many of them. They should be read using <code class="docutils literal notranslate"><a class="reference internal" href="group_fmt_parser.html#doxid-group-fmt-parser-1gaacffa3f20519a9219354e7bf7c53dbfe"><span class="std std-ref"><span class="pre">fmt_read_one()</span></span></a></code>.</p>
<div class="section" id="typedefs">
<h3>Typedefs<a class="headerlink" href="#typedefs" title="Permalink to this headline">¶</a></h3>
<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-group-fmt-spec-1ga2c58053187af69849e7c6950b590f85f"><span id="index-1"></span><span></span><span class="k">typedef</span> <span class="kt">char</span> <span class="n">fmt_char</span></pre>
<p>The default char type used in the parser</p>
<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-group-fmt-spec-1ga0ac5e440156439f9e79545d857291966"><span id="index-2"></span><span></span><span class="k">typedef</span> <span class="k">struct</span> <a class="reference internal" href="struct_fmt_spec.html#doxid-structfmt-spec"><span class="std std-ref">fmt_spec</span></a><span></span> <span class="n">fmt_spec</span></pre>
<p>Format specifier segment. It may mean a string or a %-something mask</p>
</div>
<div class="section" id="macros">
<h3>Macros<a class="headerlink" href="#macros" title="Permalink to this headline">¶</a></h3>
<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-group-fmt-spec-1ga4b67d92635dcc1af2776f2fdfa33067d"><span id="index-3"></span><span></span><span class="cp">#define FMT_CHAR_CONV(__chr)</span></pre>
<p>Converter from regular char to used-defined type</p>
<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-group-fmt-spec-1gae760f6a95479e528fbbf5261c2c02a43"><span id="index-4"></span><span></span><span class="cp">#define FMT_CHAR_TYPE</span></pre>
<p>Externally-defined char type</p>
<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-group-fmt-spec-1ga8808bbceb0038d1dc9cecbc5de8ff690"><span id="index-5"></span><span></span><span class="cp">#define FMT_VALUE_NOT_DEFINED</span></pre>
<p>The value is defined out of line as a separate parameter</p>
<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-group-fmt-spec-1ga15038326b136a214ac01c816ecaeea23"><span id="index-6"></span><span></span><span class="cp">#define FMT_VALUE_OUT_OF_LINE</span></pre>
<p>The value is defined out of line as a separate parameter</p>
</div>
</div>
</div>
</div>
</section>
<nav class="site-bottom-navigation" role="navigation">
<a href="group_fmt_spec_fields.html" class="btn btn--primary btn--next right"
title="Format specifier fields" accesskey="n">
Next
</a>
<a href="group_fmt_util.html" class="btn btn--primary btn--prev"
title="Utility functions" accesskey="p">
Previous
</a>
</nav>
<div class="source-link">
</div>
</main>
<footer class="site-footer">
<div class="container">
<div role="contentinfo">
<p>
© Copyright 2021, Maxim Menshikov.
</p>
</div>
<p>Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/testthedocs/sphinx_redactor_theme">theme</a>
provided by <a href="https://testthedocs.org">TestTheDocs</a>.
</div>
</footer>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="_static/target-highlight.js"></script>
<script type="text/javascript" src="_static/js/theme-min.js"></script>
</body>
</html>