-
Notifications
You must be signed in to change notification settings - Fork 4
/
Reference-manual_returned_build_tgt.html
453 lines (416 loc) · 18.5 KB
/
Reference-manual_returned_build_tgt.html
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Build target</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/prism-keep-markup.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="icon" type="image/png" href="assets/images/favicon.png">
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/meson_logo.png" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Modules <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="modules-menu">
<li>
<a href="CMake-module.html">CMake</a>
</li>
<li>
<a href="Cuda-module.html">CUDA</a>
</li>
<li>
<a href="Dlang-module.html">Dlang</a>
</li>
<li>
<a href="External-Project-module.html">External Project</a>
</li>
<li>
<a href="Fs-module.html">Filesystem</a>
</li>
<li>
<a href="Gnome-module.html">GNOME</a>
</li>
<li>
<a href="Hotdoc-module.html">Hotdoc</a>
</li>
<li>
<a href="i18n-module.html">i18n</a>
</li>
<li>
<a href="Icestorm-module.html">Icestorm</a>
</li>
<li>
<a href="Java-module.html">Java</a>
</li>
<li>
<a href="Keyval-module.html">Keyval</a>
</li>
<li>
<a href="Pkgconfig-module.html">Pkgconfig</a>
</li>
<li>
<a href="Python-3-module.html">Python 3</a>
</li>
<li>
<a href="Python-module.html">Python</a>
</li>
<li>
<a href="Qt4-module.html">Qt4</a>
</li>
<li>
<a href="Qt5-module.html">Qt5</a>
</li>
<li>
<a href="Qt6-module.html">Qt6</a>
</li>
<li>
<a href="Rust-module.html">Rust</a>
</li>
<li>
<a href="Simd-module.html">Simd</a>
</li>
<li>
<a href="SourceSet-module.html">SourceSet</a>
</li>
<li>
<a href="Wayland-module.html">Wayland</a>
</li>
<li>
<a href="Windows-module.html">Windows</a>
</li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Quick References <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="quick-refs-menu">
<li>
<a href="Reference-manual.html">Functions</a>
</li>
<li>
<a href="Build-options.html">Options</a>
</li>
<li>
<a href="Configuration.html">Configuration</a>
</li>
<li>
<a href="Dependencies.html">Dependencies</a>
</li>
<li>
<a href="Unit-tests.html">Tests</a>
</li>
<li>
<a href="Syntax.html">Syntax</a>
</li>
</ul>
</li>
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Meson Build System</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Meson-documentation" data-hotdoc-ref="Reference-manual_returned_build_tgt.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="build-target-build_tgt-extends-tgt">Build target (<code>build_tgt</code> extends <a href="Reference-manual_returned_tgt.html"><ins><code>tgt</code></ins></a>)</h1>
<p>A build target is either an executable, shared library, static library,
both shared and static library or shared module.</p>
<h2 id="extended-by">Extended by</h2>
<p>Build target is extended by the following subtypes:</p>
<ul>
<li><a href="Reference-manual_returned_exe.html"><ins><code>exe</code></ins></a></li>
<li><a href="Reference-manual_returned_jar.html"><ins><code>jar</code></ins></a></li>
<li><a href="Reference-manual_returned_lib.html"><ins><code>lib</code></ins></a></li>
</ul>
<h2 id="returned-by">Returned by</h2>
<p>Build target objects are returned by the following functions and methods:</p>
<ul>
<li><a href="Reference-manual_functions.html#build_target"><ins><code>build_target()</code></ins></a></li>
<li><a href="Reference-manual_functions.html#shared_module"><ins><code>shared_module()</code></ins></a></li>
</ul>
<h2 id="build-target-methods">Build target methods</h2>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="build_tgtextract_all_objects">build_tgt.extract_all_objects()</h3>
<p>Acts the same as <code>extract_objects</code>, but returns all object files generated
by this target.</p>
<p>By default only objects built for this target are returned to maintain
backward compatibility with previous versions. The default value for the
<code>recursive</code> kwarg will eventually be changed to <code>true</code> in a future version.</p>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit of space because we remove the top margin below -->
<div style="display: flex;">
<h4 style="margin-top: 0px;" id="signature">Signature</h4>
<div style="flex-grow: 1;"></div>
<div>
<div style="margin: 0px; text-align: center;">
</div>
</div>
</div>
<pre><code class="language-meson"># Acts the same as `extract_objects`, but returns all object files generated
<a href="Reference-manual_returned_extracted_obj.html"><ins>extracted_obj</ins></a> extract_all_objects(
<a href="Reference-manual_returned_build_tgt.html#extract_all_objects_recursive"><b>recursive</b></a> : <a href="Reference-manual_elementary_bool.html"><ins>bool</ins></a> # Also return objects passed to the `objects` argument of this target
)</code></pre>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit more space -->
<h4 id="arguments">Arguments</h4>
<p>The method <code>build_tgt.extract_all_objects()</code>
accepts the following keyword arguments:</p>
<!-- Hotdoc / markdown inserts <p> around the table elements. Override the margin to make them invisible -->
<style>
.nomargin p:last-child { margin-bottom: 0px !important; }
</style>
<table>
<thead>
<tr>
<th style="white-space: nowrap; text-align: center;">Name</th>
<th style="white-space: nowrap; text-align: center;">Type</th>
<th style="width: 56%;">Description</th>
<th style="white-space: nowrap; text-align: center; width: 0px;">Tags</th>
</tr>
</thead>
<tbody class="nomargin">
<tr id="extract_all_objects_recursive">
<td style="white-space: nowrap; text-align: center; padding: 6px;"><code class="language-meson">recursive</code></td>
<td style="white-space: revert; text-align: center; padding: 6px; word-wrap: break-word;"><a href="Reference-manual_elementary_bool.html"><ins><code>bool</code></ins></a></td>
<!-- This suboptimal formatting is required to ensure hotdoc correctly generates the HTML -->
<td style="width: 56%; padding: 6px;">
<p>Also return objects passed to the <code>objects</code> argument of this target.</p>
</td>
<td style="white-space: nowrap; text-align: center; padding: 6px; width: 0px;">
<div style="margin: 0px; text-align: center;">
<p style="margin: 0px;"><em style="color: #5affff;">(since 0.46.0)</em></p>
<p style="margin: 0px;"><code class="language-meson">default =
true</code></p>
</div>
</td>
</tr>
</tbody>
</table>
<p style="padding: 7.5px; margin: 0px;"></p>
<hr>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="build_tgtextract_objects">build_tgt.extract_objects()</h3>
<p>Returns an opaque value representing the object files generated for those
source files. This is typically used to take single object files and link
them to unit tests or to compile some source files with custom flags. To
use the object file(s) in another build target, use the
<code>objects:</code> keyword argument to a <a href="Reference-manual_functions.html#build_target"><ins><code>build_target()</code></ins></a> or <a href="Reference-manual_functions.html#declare_dependency"><ins><code>declare_dependency()</code></ins></a>,
or include them in the command line of a <a href="Reference-manual_functions.html#custom_target"><ins><code>custom_target()</code></ins></a>.</p>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit of space because we remove the top margin below -->
<div style="display: flex;">
<h4 style="margin-top: 0px;" id="signature1">Signature</h4>
<div style="flex-grow: 1;"></div>
<div>
<div style="margin: 0px; text-align: center;">
</div>
</div>
</div>
<pre><code class="language-meson"># Returns an opaque value representing the object files generated for those
<a href="Reference-manual_returned_extracted_obj.html"><ins>extracted_obj</ins></a> extract_objects(
<a href="Reference-manual_elementary_str.html"><ins>str</ins></a> | <a href="Reference-manual_returned_file.html"><ins>file</ins></a> <b>source</b>..., # Source filenames for which the built objects should be extracted
)</code></pre>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit more space -->
<h4 id="arguments1">Arguments</h4>
<p>The
method accepts between <code>1</code> and <code>infinity</code> variadic
arguments (<code>source...</code>) of type <code><a href="Reference-manual_elementary_str.html"><ins><code>str</code></ins></a> | <a href="Reference-manual_returned_file.html"><ins><code>file</code></ins></a></code>.</p>
<p>Source filenames for which the built objects should be extracted.</p>
<div style="margin: 0px; text-align: center;">
</div>
<p style="padding: 5px; margin: 0px;"></p> <!-- Extra space -->
<p style="padding: 7.5px; margin: 0px;"></p>
<hr>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="build_tgtfound">build_tgt.found()</h3>
<p>Always returns <code>true</code>. This function is meant to make executables
objects feature compatible with <a href="Reference-manual_returned_external_program.html"><ins><code>external_program</code></ins></a> objects. This
simplifies use-cases where an executable is used instead of
an <a href="Reference-manual_returned_external_program.html"><ins><code>external_program</code></ins></a>.</p>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit of space because we remove the top margin below -->
<div style="display: flex;">
<h4 style="margin-top: 0px;" id="signature2">Signature</h4>
<div style="flex-grow: 1;"></div>
<div>
<div style="margin: 0px; text-align: center;">
<p style="margin: 0px;"><em style="color: #5affff;">(since 0.59.0)</em></p>
</div>
</div>
</div>
<pre><code class="language-meson"><a href="Reference-manual_elementary_bool.html"><ins>bool</ins></a> found()</code></pre>
<p style="padding: 7.5px; margin: 0px;"></p>
<hr>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="build_tgtfull_path">build_tgt.full_path()</h3>
<p>Returns a full path pointing to the result target file.
<strong>NOTE:</strong> In most cases using the object itself will do the same job
as this and will also allow Meson to setup inter-target dependencies
correctly. Please file a bug if that doesn't work for you.</p>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit of space because we remove the top margin below -->
<div style="display: flex;">
<h4 style="margin-top: 0px;" id="signature3">Signature</h4>
<div style="flex-grow: 1;"></div>
<div>
<div style="margin: 0px; text-align: center;">
</div>
</div>
</div>
<pre><code class="language-meson"><a href="Reference-manual_elementary_str.html"><ins>str</ins></a> full_path()</code></pre>
<p style="padding: 7.5px; margin: 0px;"></p>
<hr>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="build_tgtname">build_tgt.name()</h3>
<p>Returns the name of the target.</p>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit of space because we remove the top margin below -->
<div style="display: flex;">
<h4 style="margin-top: 0px;" id="signature4">Signature</h4>
<div style="flex-grow: 1;"></div>
<div>
<div style="margin: 0px; text-align: center;">
<p style="margin: 0px;"><em style="color: #5affff;">(since 0.54.0)</em></p>
</div>
</div>
</div>
<pre><code class="language-meson"><a href="Reference-manual_elementary_str.html"><ins>str</ins></a> name()</code></pre>
<p style="padding: 7.5px; margin: 0px;"></p>
<hr>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="build_tgtpath">build_tgt.path()</h3>
<p>Does the exact same as <a href="Reference-manual_returned_build_tgt.html#build_tgtfull_path"><ins><code>build_tgt.full_path()</code></ins></a>. <strong>NOTE</strong>: This
function is solely kept for compatibility with <a href="Reference-manual_returned_external_program.html"><ins><code>external_program</code></ins></a> objects.
It will be removed once the, also deprecated, corresponding <code>path()</code>
function in the <a href="Reference-manual_returned_external_program.html"><ins><code>external_program</code></ins></a> object is removed.</p>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit of space because we remove the top margin below -->
<div style="display: flex;">
<h4 style="margin-top: 0px;" id="signature5">Signature</h4>
<div style="flex-grow: 1;"></div>
<div>
<div style="margin: 0px; text-align: center;">
<p style="margin: 0px;"><em style="color: #5affff;">(since 0.59.0)</em></p>
<div style="color: #ffa844">
<p style="margin: 0px;"><strong>DEPRECATED</strong></p>
<p style="margin: 0px;"><em>in 0.59.0</em></p>
</div>
</div>
</div>
</div>
<pre><code class="language-meson"><a href="Reference-manual_elementary_str.html"><ins>str</ins></a> path()</code></pre>
<p style="padding: 7.5px; margin: 0px;"></p>
<hr>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="build_tgtprivate_dir_include">build_tgt.private_dir_include()</h3>
<p>Returns a value that works like <a href="Reference-manual_functions.html#include_directories"><ins><code>include_directories()</code></ins></a>, but points to the
private directory of this target. Usually only needed if an another target
needs to access some generated internal headers of this target.</p>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit of space because we remove the top margin below -->
<div style="display: flex;">
<h4 style="margin-top: 0px;" id="signature6">Signature</h4>
<div style="flex-grow: 1;"></div>
<div>
<div style="margin: 0px; text-align: center;">
</div>
</div>
</div>
<pre><code class="language-meson"><a href="Reference-manual_returned_inc.html"><ins>inc</ins></a> private_dir_include()</code></pre>
<p style="padding: 7.5px; margin: 0px;"></p>
<hr>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
<hr>
<div class="license-description">
Website licensing information are available on the <a href="legal.html">Legal</a> page.
</div>
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://github.com/mesonbuild/meson/edit/master/docs/_build/Reference-manual_returned_build_tgt.md" data-hotdoc-role="edit-button">Edit on GitHub</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>