-
Notifications
You must be signed in to change notification settings - Fork 4
/
Generating-sources.html
409 lines (365 loc) · 15.9 KB
/
Generating-sources.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
<!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>Generating sources</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="Generating-sources.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="generating-sources">Generating sources</h1>
<p>Sometimes source files need to be preprocessed before they are passed
to the actual compiler. As an example you might want build an IDL
compiler and then run some files through that to generate actual
source files. In Meson this is done with
<a href="Reference-manual_functions.html#generator"><ins><code>generator()</code></ins></a> or
<a href="Reference-manual_functions.html#custom_target"><ins><code>custom_target()</code></ins></a>.</p>
<h2 id="using-custom_target">Using custom_target()</h2>
<p>Let's say you have a build target that must be built using sources
generated by a compiler. The compiler can either be a built target:</p>
<pre><code class="language-meson">mycomp = executable('mycompiler', 'compiler.c')
</code></pre>
<p>Or an external program provided by the system, or script inside the
source tree:</p>
<pre><code class="language-meson">mycomp = find_program('mycompiler')
</code></pre>
<p>Custom targets can take zero or more input files and use them to
generate one or more output files. Using a custom target, you can run
this compiler at build time to generate the sources:</p>
<pre><code class="language-meson">gen_src = custom_target('gen-output',
input : ['somefile1.c', 'file2.c'],
output : ['out.c', 'out.h'],
command : [mycomp, '@INPUT@',
'--c-out', '@OUTPUT0@',
'--h-out', '@OUTPUT1@'])
</code></pre>
<p>The <code>@INPUT@</code> there will be transformed to <code>'somefile1.c' 'file2.c'</code>. Just like the output, you can also refer to each input
file individually by index.</p>
<p>Then you just put that in your program and you're done.</p>
<h3 id="generating-headers">Generating headers</h3>
<p>Adding a generated header to a source list will ensure that the header
is generated and that the proper include paths are created for the
target:</p>
<pre><code class="language-meson">prog_python = <a href="Reference-manual_functions.html#find_program"><ins>find_program</ins></a>('python3')
foo_c = custom_target(
'foo.c',
output : 'foo.c',
input : 'my_gen.py',
command : [prog_python, '@INPUT@', '--code', '@OUTPUT@'],
)
foo_h = custom_target(
'foo.h',
output : 'foo.h',
input : 'my_gen.py',
command : [prog_python, '@INPUT@', '--header', '@OUTPUT@'],
)
libfoo = static_library('foo', [foo_c, foo_h])
executable('myexe', ['main.c', foo_h], link_with : libfoo)
</code></pre>
<p>Each target that depends on a generated header should add that header
to its sources, as seen above with <code>libfoo</code> and <code>myexe</code>. This is
because there is no way for Meson or the backend to know that <code>myexe</code>
depends on <code>foo.h</code> just because <code>libfoo</code> does, it could be a private
header.</p>
<h3 id="generating-multiple-files-at-a-time">Generating multiple files at a time</h3>
<p>Sometimes it makes sense for a single generator to create two or more
files at a time, (perhaps a header and source file), Meson has this
case covered as well. <code>custom_target</code>s can be indexed like a list to
get each output file separately. The order is the same as the order of
the output argument to <code>custom_target</code></p>
<pre><code class="language-meson">prog_python = <a href="Reference-manual_functions.html#find_program"><ins>find_program</ins></a>('python3')
foo_ch = custom_target(
'foo.[ch]',
output : ['foo.c', 'foo.h'],
input : 'my_gen.py',
command : [prog_python, '@INPUT@', '@OUTPUT@'],
)
libfoo = static_library('foo', [foo_ch])
executable('myexe', ['main.c', foo_ch[1]], link_with : libfoo)
</code></pre>
<p>In this case <code>libfoo</code> depends on both <code>foo.c</code> and <code>foo.h</code> but <code>myexe</code>
only depends on <code>foo.h</code>, the second output.</p>
<h3 id="using-dependencies-to-manage-generated-resources">Using dependencies to manage generated resources</h3>
<p>In some cases it might be easier to use <code>declare_dependency</code> to
"bundle" the header and library dependency, especially if there are
many generated headers:</p>
<pre><code class="language-meson">idep_foo = declare_dependency(
sources : [foo_h, bar_h],
link_with : [libfoo],
)
</code></pre>
<p>See <a href="Dependencies.html#declaring-your-own">dependencies</a>, and
<a href="Reference-manual_functions.html#declare_dependency"><ins><code>declare_dependency()</code></ins></a> for more
information.</p>
<h2 id="using-generator">Using generator()</h2>
<p>Generators are similar to custom targets, except that we define a
<em>generator</em>, which defines how to transform an input file into one or
more output files, and then use that on as many input files as we
want.</p>
<p>Note that generators should only be used for outputs that will only be
used as inputs for a build target or a custom target. When you use the
processed output of a generator in multiple targets, the generator
will be run multiple times to create outputs for each target. Each
output will be created in a target-private directory <code>@BUILD_DIR@</code>.</p>
<p>If you want to generate files for general purposes such as for
generating headers to be used by several sources, or data that will be
installed, and so on, use a
<a href="Reference-manual_functions.html#custom_target"><ins><code>custom_target()</code></ins></a> instead.</p>
<pre><code class="language-meson">gen = generator(mycomp,
output : '@BASENAME@.c',
arguments : ['@INPUT@', '@OUTPUT@'])
</code></pre>
<p>The first argument is the executable file to run. The next file
specifies a name generation rule. It specifies how to build the output
file name for a given input name. <code>@BASENAME@</code> is a placeholder for
the input file name without preceding path or suffix (if any). So if
the input file name were <code>some/path/filename.idl</code>, then the output
name would be <code>filename.c</code>. You can also use <code>@PLAINNAME@</code>, which
preserves the suffix which would result in a file called
<code>filename.idl.c</code>. The last line specifies the command line arguments
to pass to the executable. <code>@INPUT@</code> and <code>@OUTPUT@</code> are placeholders
for the input and output files, respectively, and will be
automatically filled in by Meson. If your rule produces multiple
output files and you need to pass them to the command line, append the
location to the output holder like this: <code>@OUTPUT0@</code>, <code>@OUTPUT1@</code> and
so on.</p>
<p>With this rule specified we can generate source files and add them to
a target.</p>
<pre><code class="language-meson">gen_src = gen.process('input1.idl', 'input2.idl')
executable('program', 'main.c', gen_src)
</code></pre>
<p>Generators can also generate multiple output files with unknown names:</p>
<pre><code class="language-meson">gen2 = generator(someprog,
output : ['@BASENAME@.c', '@BASENAME@.h'],
arguments : ['--out_dir=@BUILD_DIR@', '@INPUT@'])
</code></pre>
<p>In this case you cannot use the plain <code>@OUTPUT@</code> variable, as it
would be ambiguous. This program only needs to know the output
directory, it will generate the file names by itself.</p>
<p>To make passing different additional arguments to the generator
program at each use possible, you can use the <code>@EXTRA_ARGS@</code> string in
the <code>arguments</code> list. Note that this placeholder can only be present
as a whole string, and not as a substring. The main reason is that it
represents a list of strings, which may be empty, or contain multiple
elements; and in either case, interpolating it into the middle of a
single string would be troublesome. If there are no extra arguments
passed in from a <code>process()</code> invocation, the placeholder is entirely
omitted from the actual list of arguments, so an empty string won't be
passed to the generator program because of this. If there are multiple
elements in <code>extra_args</code>, they are inserted into to the actual
argument list as separate elements.</p>
<pre><code class="language-meson">gen3 = generator(genprog,
output : '@BASENAME@.cc',
arguments : ['@INPUT@', '@EXTRA_ARGS@', '@OUTPUT@'])
gen3_src1 = gen3.process('input1.y')
gen3_src2 = gen3.process('input2.y', extra_args: '--foo')
gen3_src3 = gen3.process('input3.y', extra_args: ['--foo', '--bar'])
</code></pre>
</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/markdown/Generating-sources.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>