-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathFs-module.html
446 lines (401 loc) · 16.2 KB
/
Fs-module.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
<!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>FS (filesystem) module</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/notes.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="Fs-module.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="fs-filesystem-module">FS (filesystem) module</h1>
<p>This module provides functions to inspect the file system. It is
available starting with version 0.53.0.</p>
<p>Since 0.59.0, all functions accept <code>files()</code> objects if they can do something
useful with them (this excludes <code>exists</code>, <code>is_dir</code>, <code>is_file</code>, <code>is_absolute</code>
since a <code>files()</code> object is always the absolute path to an existing file).</p>
<h2 id="usage">Usage</h2>
<p>The module may be imported as follows:</p>
<pre><code class="language-meson">fs = <a href="Reference-manual_functions.html#import"><ins>import</ins></a>('fs')
</code></pre>
<h2 id="file-lookup-rules">File lookup rules</h2>
<p>Non-absolute paths are looked up relative to the directory where the
current <code>meson.build</code> file is.</p>
<p>If specified, a leading <code>~</code> is expanded to the user home directory.
Environment variables are not available as is the rule throughout Meson.
That is, $HOME, %USERPROFILE%, $MKLROOT, etc. have no meaning to the Meson
filesystem module. If needed, pass such variables into Meson via command
line options in <code>meson.options</code>, native-file or cross-file.</p>
<p>Where possible, symlinks and parent directory notation are resolved to an
absolute path.</p>
<h3 id="exists">exists</h3>
<p>Takes a single string argument and returns true if an entity with that
name exists on the file system. This can be a file, directory or a
special entry such as a device node.</p>
<h3 id="is_dir">is_dir</h3>
<p>Takes a single string argument and returns true if a directory with
that name exists on the file system.</p>
<h3 id="is_file">is_file</h3>
<p>Takes a single string argument and returns true if an file with that
name exists on the file system.</p>
<h3 id="is_symlink">is_symlink</h3>
<p>Takes a single string or (since 0.59.0) <code>files()</code> argument and returns true if
the path pointed to by the string is a symbolic link.</p>
<h2 id="file-parameters">File Parameters</h2>
<h3 id="is_absolute">is_absolute</h3>
<p><em>since 0.54.0</em></p>
<p>Return a boolean indicating if the path string or (since 0.59.0) <code>files()</code>
specified is absolute, WITHOUT expanding <code>~</code>.</p>
<p>Examples:</p>
<pre><code class="language-meson">fs.is_absolute('~') # false
home = fs.expanduser('~')
fs.is_absolute(home) # true
fs.is_absolute(home / 'foo') # true, even if ~/foo doesn't exist
fs.is_absolute('foo/bar') # false, even if ./foo/bar exists
</code></pre>
<h3 id="hash">hash</h3>
<p>The <code>fs.hash(filename, hash_algorithm)</code> method returns a string containing
the hexadecimal <code>hash_algorithm</code> digest of a file.
<code>hash_algorithm</code> is a string; the available hash algorithms include:
md5, sha1, sha224, sha256, sha384, sha512.</p>
<h3 id="size">size</h3>
<p>The <code>fs.size(filename)</code> method returns the size of the file in integer bytes.</p>
<h3 id="is_samepath">is_samepath</h3>
<p>The <code>fs.is_samepath(path1, path2)</code> returns boolean <code>true</code> if both
paths resolve to the same path. For example, suppose path1 is a
symlink and path2 is a relative path. If <code>path1</code> can be resolved to
<code>path2</code>, then <code>true</code> is returned. If <code>path1</code> is not resolved to
<code>path2</code>, <code>false</code> is returned. If <code>path1</code> or <code>path2</code> do not exist,
<code>false</code> is returned.</p>
<p>Examples:</p>
<pre><code class="language-meson">x = 'foo.txt'
y = 'sub/../foo.txt'
z = 'bar.txt' # a symlink pointing to foo.txt
j = 'notafile.txt' # nonexistent file
fs.is_samepath(x, y) # true
fs.is_samepath(x, z) # true
fs.is_samepath(x, j) # false
p = 'foo/bar'
q = 'foo/bar/baz/..'
r = 'buz' # a symlink pointing to foo/bar
s = 'notapath' # nonexistent directory
fs.is_samepath(p, q) # true
fs.is_samepath(p, r) # true
fs.is_samepath(p, s) # false
</code></pre>
<h2 id="filename-modification">Filename modification</h2>
<p>The files need not actually exist yet for these path string
manipulation methods.</p>
<h3 id="expanduser">expanduser</h3>
<p><em>since 0.54.0</em></p>
<p>A path string with a leading <code>~</code> is expanded to the user home
directory</p>
<p>Examples:</p>
<pre><code class="language-meson">fs.expanduser('~') # user home directory
fs.expanduser('~/foo') # <homedir>/foo
</code></pre>
<h3 id="as_posix">as_posix</h3>
<p><em>since 0.54.0</em></p>
<p><code>fs.as_posix(path)</code> assumes a Windows path, even if on a Unix-like
system. Thus, all <code>'\'</code> or <code>'\\'</code> are turned to '/', even if you meant
to escape a character.</p>
<p>Examples</p>
<pre><code class="language-meson">fs.as_posix('\\') == '/' # true
fs.as_posix('\\\\') == '/' # true
fs.as_posix('foo\\bar/baz') == 'foo/bar/baz' # true
</code></pre>
<h3 id="replace_suffix">replace_suffix</h3>
<p>The <code>replace_suffix</code> method is a <em>string manipulation</em> convenient for
filename modifications. It allows changing the filename suffix like:</p>
<h4 id="swap-suffix">swap suffix</h4>
<pre><code class="language-meson">original = '/opt/foo.ini'
new = fs.replace_suffix(original, '.txt') # /opt/foo.txt
</code></pre>
<h4 id="add-suffix">add suffix</h4>
<pre><code class="language-meson">original = '/opt/foo'
new = fs.replace_suffix(original, '.txt') # /opt/foo.txt
</code></pre>
<h4 id="compound-suffix-swap">compound suffix swap</h4>
<pre><code class="language-meson">original = '/opt/foo.dll.a'
new = fs.replace_suffix(original, '.so') # /opt/foo.dll.so
</code></pre>
<h4 id="delete-suffix">delete suffix</h4>
<pre><code class="language-meson">original = '/opt/foo.dll.a'
new = fs.replace_suffix(original, '') # /opt/foo.dll
</code></pre>
<h3 id="parent">parent</h3>
<p>Returns the parent directory (i.e. dirname).</p>
<pre><code class="language-meson">new = fs.parent('foo/bar') # foo
new = fs.parent('foo/bar/baz.dll') # foo/bar
</code></pre>
<h3 id="name">name</h3>
<p>Returns the last component of the path (i.e. basename).</p>
<pre><code class="language-meson">fs.name('foo/bar/baz.dll.a') # baz.dll.a
</code></pre>
<h3 id="stem">stem</h3>
<p><em>since 0.54.0</em></p>
<p>Returns the last component of the path, dropping the last part of the
suffix</p>
<pre><code class="language-meson">fs.stem('foo/bar/baz.dll') # baz
fs.stem('foo/bar/baz.dll.a') # baz.dll
</code></pre>
<h3 id="read">read</h3>
<ul>
<li>
<code>read(path, encoding: 'utf-8')</code> <em>(since 0.57.0)</em>:
return a <a href="Syntax.html#strings">string</a> with the contents of the given <code>path</code>.
If the <code>encoding</code> keyword argument is not specified, the file specified by
<code>path</code> is assumed to be utf-8 encoded. Binary files are not supported. The
provided paths should be relative to the current <code>meson.current_source_dir()</code>
or an absolute path outside the build directory is accepted. If the file
specified by <code>path</code> changes, this will trigger Meson to reconfigure the
project. If the file specified by <code>path</code> is a <code>files()</code> object it
cannot refer to a built file.</li>
</ul>
<h3 id="relative_to">relative_to</h3>
<p><em>Since 1.3.0</em></p>
<p>Return a relative filepath. In the event a relative path could not be found, the
absolute path of <code>to</code> is returned. Relative path arguments will be assumed to be
relative to <code>meson.current_source_dir()</code>.</p>
<p>Has the following positional arguments:</p>
<ul>
<li>to <code>str | file | custom_tgt | custom_idx | build_tgt</code>: end path</li>
<li>from <code>str | file | custom_tgt | custom_idx | build_tgt</code>: start path</li>
</ul>
<p>returns:</p>
<ul>
<li>a string</li>
</ul>
<h3 id="copyfile">copyfile</h3>
<p><em>Since 0.64.0</em></p>
<p>Copy a file from the source directory to the build directory at build time</p>
<p>Has the following positional arguments:</p>
<ul>
<li>src <code>File | str</code>: the file to copy</li>
</ul>
<p>Has the following optional arguments:</p>
<ul>
<li>dest <code>str</code>: the name of the output file. If unset will be the basename of
the src argument</li>
</ul>
<p>Has the following keyword arguments:</p>
<ul>
<li>install <code>bool</code>: Whether to install the copied file, defaults to false</li>
<li>install_dir <code>str</code>: Where to install the file to</li>
<li>install_tag: <code>str</code>: the install tag to assign to this target</li>
<li>install_mode <code>array[str | int]</code>: the mode to install the file with</li>
</ul>
<p>returns:</p>
<ul>
<li>a <a href="Reference-manual_functions.html#custom_target"><ins><code>custom_target()</code></ins></a> object</li>
</ul>
<pre><code class="language-meson">copy = fs.copyfile('input-file', 'output-file')
</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/Fs-module.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>