-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcpp_tooling.html
More file actions
376 lines (376 loc) · 16.6 KB
/
cpp_tooling.html
File metadata and controls
376 lines (376 loc) · 16.6 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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>C++ notes around tooling</title>
<style>
html {
color: #1a1a1a;
background-color: #fdfdfd;
}
body {
margin: 0 auto;
max-width: 36em;
padding-left: 50px;
padding-right: 50px;
padding-top: 50px;
padding-bottom: 50px;
hyphens: auto;
overflow-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media (max-width: 600px) {
body {
font-size: 0.9em;
padding: 12px;
}
h1 {
font-size: 1.8em;
}
}
@media print {
html {
background-color: white;
}
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #1a1a1a;
}
a:visited {
color: #1a1a1a;
}
img {
max-width: 100%;
}
svg {
height: auto;
max-width: 100%;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.4em;
}
h5, h6 {
font-size: 1em;
font-style: italic;
}
h6 {
font-weight: normal;
}
ol, ul {
padding-left: 1.7em;
margin-top: 1em;
}
li > ol, li > ul {
margin-top: 0;
}
blockquote {
margin: 1em 0 1em 1.7em;
padding-left: 1em;
border-left: 2px solid #e6e6e6;
color: #606060;
}
code {
font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
font-size: 85%;
margin: 0;
hyphens: manual;
}
pre {
margin: 1em 0;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
overflow-wrap: normal;
}
.sourceCode {
background-color: transparent;
overflow: visible;
}
hr {
background-color: #1a1a1a;
border: none;
height: 1px;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
font-variant-numeric: lining-nums tabular-nums;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 4em;
text-align: center;
}
#TOC li {
list-style: none;
}
#TOC ul {
padding-left: 1.3em;
}
#TOC > ul {
padding-left: 0;
}
#TOC a:not(:hover) {
text-decoration: none;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
/* The extra [class] is a hack that increases specificity enough to
override a similar rule in reveal.js */
ul.task-list[class]{list-style: none;}
ul.task-list li input[type="checkbox"] {
font-size: inherit;
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
/* CSS for syntax highlighting */
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
background-color: #ffffff;
color: #a0a0a0;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #a0a0a0; padding-left: 4px; }
div.sourceCode
{ color: #1f1c1b; background-color: #ffffff; }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span { color: #1f1c1b; } /* Normal */
code span.al { color: #bf0303; background-color: #f7e6e6; font-weight: bold; } /* Alert */
code span.an { color: #ca60ca; } /* Annotation */
code span.at { color: #0057ae; } /* Attribute */
code span.bn { color: #b08000; } /* BaseN */
code span.bu { color: #644a9b; font-weight: bold; } /* BuiltIn */
code span.cf { color: #1f1c1b; font-weight: bold; } /* ControlFlow */
code span.ch { color: #924c9d; } /* Char */
code span.cn { color: #aa5500; } /* Constant */
code span.co { color: #898887; } /* Comment */
code span.cv { color: #0095ff; } /* CommentVar */
code span.do { color: #607880; } /* Documentation */
code span.dt { color: #0057ae; } /* DataType */
code span.dv { color: #b08000; } /* DecVal */
code span.er { color: #bf0303; text-decoration: underline; } /* Error */
code span.ex { color: #0095ff; font-weight: bold; } /* Extension */
code span.fl { color: #b08000; } /* Float */
code span.fu { color: #644a9b; } /* Function */
code span.im { color: #ff5500; } /* Import */
code span.in { color: #b08000; } /* Information */
code span.kw { color: #1f1c1b; font-weight: bold; } /* Keyword */
code span.op { color: #1f1c1b; } /* Operator */
code span.ot { color: #006e28; } /* Other */
code span.pp { color: #006e28; } /* Preprocessor */
code span.re { color: #0057ae; background-color: #e0e9f8; } /* RegionMarker */
code span.sc { color: #3daee9; } /* SpecialChar */
code span.ss { color: #ff5500; } /* SpecialString */
code span.st { color: #bf0303; } /* String */
code span.va { color: #0057ae; } /* Variable */
code span.vs { color: #bf0303; } /* VerbatimString */
code span.wa { color: #bf0303; } /* Warning */
</style>
</head>
<body>
<header id="title-block-header">
<h1 class="title">C++ notes around tooling</h1>
</header>
<nav id="TOC" role="doc-toc">
<ul>
<li><a href="#clang-format-force-multi-line-formatting"
id="toc-clang-format-force-multi-line-formatting"><span
class="toc-section-number">1</span> # clang-format, force multi-line
formatting</a></li>
<li><a href="#initial-clang-format-setup"
id="toc-initial-clang-format-setup"><span
class="toc-section-number">2</span> # initial clang-format
setup</a></li>
<li><a href="#disable-clang-format-for-piece-of-code"
id="toc-disable-clang-format-for-piece-of-code"><span
class="toc-section-number">3</span> # disable clang-format for piece of
code</a></li>
<li><a href="#clang-format-command-line-for-file-formatting"
id="toc-clang-format-command-line-for-file-formatting"><span
class="toc-section-number">4</span> # clang-format command line for file
formatting</a></li>
<li><a href="#msvc-dump-classobject-memory-layout"
id="toc-msvc-dump-classobject-memory-layout"><span
class="toc-section-number">5</span> # MSVC: dump class/object memory
layout</a></li>
</ul>
</nav>
<h3 data-number="1" id="clang-format-force-multi-line-formatting"><span
class="header-section-number">1</span> <a
href="#clang-format-force-multi-line-formatting"># </a>clang-format,
force multi-line formatting</h3>
<p>Add <code>//</code> comment at the end of line to force clang-format
to NOT merge everything into single line. This:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode numberSource cpp numberLines"><code class="sourceCode cpp"><span id="cb1-1"><a href="#cb1-1"></a><span class="at">const</span> <span class="dt">int</span> status <span class="op">=</span> <span class="op">...;</span></span>
<span id="cb1-2"><a href="#cb1-2"></a><span class="cf">if</span> <span class="op">((</span>status <span class="op">==</span> e1<span class="op">)</span> <span class="op">||</span> <span class="op">(</span>status <span class="op">==</span> e2<span class="op">)</span> <span class="op">||</span> other_error<span class="op">)</span></span>
<span id="cb1-3"><a href="#cb1-3"></a><span class="op">{</span></span>
<span id="cb1-4"><a href="#cb1-4"></a> HandleMe<span class="op">();</span></span>
<span id="cb1-5"><a href="#cb1-5"></a><span class="op">}</span></span></code></pre></div>
<p>becomes:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode numberSource cpp numberLines"><code class="sourceCode cpp"><span id="cb2-1"><a href="#cb2-1"></a><span class="at">const</span> <span class="dt">int</span> status <span class="op">=</span> <span class="op">...;</span></span>
<span id="cb2-2"><a href="#cb2-2"></a><span class="cf">if</span> <span class="op">((</span>status <span class="op">==</span> e1<span class="op">)</span> <span class="co">//</span></span>
<span id="cb2-3"><a href="#cb2-3"></a> <span class="op">||</span> <span class="op">(</span>status <span class="op">==</span> e2<span class="op">)</span> <span class="co">//</span></span>
<span id="cb2-4"><a href="#cb2-4"></a> <span class="op">||</span> other_error<span class="op">)</span></span>
<span id="cb2-5"><a href="#cb2-5"></a><span class="op">{</span></span>
<span id="cb2-6"><a href="#cb2-6"></a> HandleMe<span class="op">();</span></span>
<span id="cb2-7"><a href="#cb2-7"></a><span class="op">}</span></span></code></pre></div>
<h3 data-number="2" id="initial-clang-format-setup"><span
class="header-section-number">2</span> <a
href="#initial-clang-format-setup"># </a>initial clang-format setup</h3>
<ul>
<li>Note clang-format version with
<code>clang-format.exe --version</code>.</li>
<li>Dump some (any?) available style to .clang-format with
<code>clang-format.exe --style=Microsoft --dump-config > .clang-format</code>.</li>
<li>(You may want to force everyone to use same clang-format
version).</li>
<li>(Check <a
href="https://clang.llvm.org/docs/ClangFormatStyleOptions.html">ClangFormatStyleOptions</a>
reference).</li>
</ul>
<p>Add header with above info to .clang-format, submit:</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode numberSource numberLines"><code class="sourceCode"><span id="cb3-1"><a href="#cb3-1"></a># clang-format version 18.1.8</span>
<span id="cb3-2"><a href="#cb3-2"></a># clang-format.exe --style=Microsoft --dump-config > .clang-format</span>
<span id="cb3-3"><a href="#cb3-3"></a>---</span>
<span id="cb3-4"><a href="#cb3-4"></a>Language: Cpp</span>
<span id="cb3-5"><a href="#cb3-5"></a># BasedOnStyle: Microsoft</span>
<span id="cb3-6"><a href="#cb3-6"></a>...</span></code></pre></div>
<h3 data-number="3" id="disable-clang-format-for-piece-of-code"><span
class="header-section-number">3</span> <a
href="#disable-clang-format-for-piece-of-code"># </a>disable
clang-format for piece of code</h3>
<div class="sourceCode" id="cb4"><pre
class="sourceCode numberSource cpp numberLines"><code class="sourceCode cpp"><span id="cb4-1"><a href="#cb4-1"></a><span class="co">// clang-format off</span></span>
<span id="cb4-2"><a href="#cb4-2"></a>MyHandle<span class="op">(</span><span class="dv">56</span></span>
<span id="cb4-3"><a href="#cb4-3"></a> <span class="op">,</span> <span class="st">"args"</span></span>
<span id="cb4-4"><a href="#cb4-4"></a> <span class="op">,</span> <span class="st">"data"</span></span>
<span id="cb4-5"><a href="#cb4-5"></a> <span class="op">);</span></span>
<span id="cb4-6"><a href="#cb4-6"></a><span class="co">// clang-format on</span></span></code></pre></div>
<h3 data-number="4"
id="clang-format-command-line-for-file-formatting"><span
class="header-section-number">4</span> <a
href="#clang-format-command-line-for-file-formatting"># </a>clang-format
command line for file formatting</h3>
<p>Single file:</p>
<div class="sourceCode" id="cb5"><pre
class="sourceCode numberSource numberLines"><code class="sourceCode"><span id="cb5-1"><a href="#cb5-1"></a>clang-format.exe -i --style=file:.clang-format "main.cpp"</span></code></pre></div>
<p>Folder:</p>
<div class="sourceCode" id="cb6"><pre
class="sourceCode numberSource numberLines"><code class="sourceCode"><span id="cb6-1"><a href="#cb6-1"></a>ls -Path . -Recurse -File -Include *.h,*.cpp `</span>
<span id="cb6-2"><a href="#cb6-2"></a> | % { clang-format.exe -i --style=file:.clang-format $_.FullName }</span></code></pre></div>
<h3 data-number="5" id="msvc-dump-classobject-memory-layout"><span
class="header-section-number">5</span> <a
href="#msvc-dump-classobject-memory-layout"># </a>MSVC: dump
class/object memory layout</h3>
<p>See <a
href="https://ofekshilon.com/2010/11/07/d1reportallclasslayout-dumping-object-memory-layout/">/d1reportAllClassLayout
– Dumping Object Memory Layout</a> and <a
href="https://randomascii.wordpress.com/2013/12/01/vc-2013-class-layout-change-and-wasted-space/">VC++
2013 class Layout Change and Wasted Space</a>. For this code:</p>
<div class="sourceCode" id="cb7"><pre
class="sourceCode numberSource cpp numberLines"><code class="sourceCode cpp"><span id="cb7-1"><a href="#cb7-1"></a><span class="co">// main.cpp</span></span>
<span id="cb7-2"><a href="#cb7-2"></a><span class="kw">struct</span> MyBase</span>
<span id="cb7-3"><a href="#cb7-3"></a><span class="op">{</span></span>
<span id="cb7-4"><a href="#cb7-4"></a> <span class="kw">virtual</span> <span class="op">~</span>MyBase<span class="op">()</span> <span class="op">=</span> <span class="cf">default</span><span class="op">;</span></span>
<span id="cb7-5"><a href="#cb7-5"></a> <span class="kw">virtual</span> <span class="dt">void</span> MyFoo<span class="op">()</span> <span class="op">{};</span></span>
<span id="cb7-6"><a href="#cb7-6"></a> <span class="dt">int</span> _data <span class="op">=</span> <span class="op">-</span><span class="dv">1</span><span class="op">;</span></span>
<span id="cb7-7"><a href="#cb7-7"></a><span class="op">};</span></span>
<span id="cb7-8"><a href="#cb7-8"></a></span>
<span id="cb7-9"><a href="#cb7-9"></a><span class="kw">struct</span> MyDerived <span class="op">:</span> MyBase</span>
<span id="cb7-10"><a href="#cb7-10"></a><span class="op">{</span></span>
<span id="cb7-11"><a href="#cb7-11"></a> <span class="kw">virtual</span> <span class="dt">void</span> MyFoo<span class="op">()</span> <span class="kw">override</span> <span class="op">{};</span></span>
<span id="cb7-12"><a href="#cb7-12"></a> <span class="dt">float</span> _id <span class="op">=</span> <span class="fl">0.0</span><span class="bu">f</span><span class="op">;</span></span>
<span id="cb7-13"><a href="#cb7-13"></a><span class="op">};</span></span></code></pre></div>
<p>Running</p>
<p>cl /d1reportSingleClassLayout<mark>MyDerived</mark> main.cpp</p>
<p>will dump:</p>
<div class="sourceCode" id="cb8"><pre
class="sourceCode numberSource numberLines"><code class="sourceCode"><span id="cb8-1"><a href="#cb8-1"></a>class MyDerived size(12):</span>
<span id="cb8-2"><a href="#cb8-2"></a> +---</span>
<span id="cb8-3"><a href="#cb8-3"></a> 0 | +--- (base class MyBase)</span>
<span id="cb8-4"><a href="#cb8-4"></a> 0 | | {vfptr}</span>
<span id="cb8-5"><a href="#cb8-5"></a> 4 | | _data</span>
<span id="cb8-6"><a href="#cb8-6"></a> | +---</span>
<span id="cb8-7"><a href="#cb8-7"></a> 8 | _id</span>
<span id="cb8-8"><a href="#cb8-8"></a> +---</span>
<span id="cb8-9"><a href="#cb8-9"></a></span>
<span id="cb8-10"><a href="#cb8-10"></a>MyDerived::$vftable@:</span>
<span id="cb8-11"><a href="#cb8-11"></a> | &MyDerived_meta</span>
<span id="cb8-12"><a href="#cb8-12"></a> | 0</span>
<span id="cb8-13"><a href="#cb8-13"></a> 0 | &MyDerived::{dtor}</span>
<span id="cb8-14"><a href="#cb8-14"></a> 1 | &MyDerived::MyFoo</span></code></pre></div>
<p>Note there is also <code>/d1reportAllClassLayout</code> so you don’t
need to specify class name.</p>
</body>
</html>