-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathReference-manual_elementary_bool.html
398 lines (361 loc) · 18.3 KB
/
Reference-manual_elementary_bool.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
<!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>bool</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="Reference-manual_elementary_bool.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="boolean-bool">Boolean (<code>bool</code>)</h1>
<p>A boolean object which is either <code>true</code> or <code>false</code></p>
<h2 id="returned-by">Returned by</h2>
<p>Boolean objects are returned by the following functions and methods:</p>
<ul>
<li><a href="Reference-manual_functions.html#add_languages"><ins><code>add_languages()</code></ins></a></li>
<li><a href="Reference-manual_functions.html#get_option"><ins><code>get_option()</code></ins></a></li>
<li><a href="Reference-manual_functions.html#is_disabler"><ins><code>is_disabler()</code></ins></a></li>
<li><a href="Reference-manual_functions.html#is_variable"><ins><code>is_variable()</code></ins></a></li>
<li><a href="Reference-manual_returned_build_tgt.html#build_tgtfound"><ins><code>build_tgt.found()</code></ins></a></li>
<li><a href="Reference-manual_returned_cfg_data.html#cfg_dataget"><ins><code>cfg_data.get()</code></ins></a></li>
<li><a href="Reference-manual_returned_cfg_data.html#cfg_dataget_unquoted"><ins><code>cfg_data.get_unquoted()</code></ins></a></li>
<li><a href="Reference-manual_returned_cfg_data.html#cfg_datahas"><ins><code>cfg_data.has()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilercheck_header"><ins><code>compiler.check_header()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilercompiles"><ins><code>compiler.compiles()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_argument"><ins><code>compiler.has_argument()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_define"><ins><code>compiler.has_define()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_function"><ins><code>compiler.has_function()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_function_attribute"><ins><code>compiler.has_function_attribute()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_header"><ins><code>compiler.has_header()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_header_symbol"><ins><code>compiler.has_header_symbol()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_link_argument"><ins><code>compiler.has_link_argument()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_member"><ins><code>compiler.has_member()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_members"><ins><code>compiler.has_members()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_multi_arguments"><ins><code>compiler.has_multi_arguments()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_multi_link_arguments"><ins><code>compiler.has_multi_link_arguments()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerhas_type"><ins><code>compiler.has_type()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilerlinks"><ins><code>compiler.links()</code></ins></a></li>
<li><a href="Reference-manual_returned_compiler.html#compilersymbols_have_underscore_prefix"><ins><code>compiler.symbols_have_underscore_prefix()</code></ins></a></li>
<li><a href="Reference-manual_returned_dep.html#depfound"><ins><code>dep.found()</code></ins></a></li>
<li><a href="Reference-manual_elementary_dict.html#dicthas_key"><ins><code>dict.has_key()</code></ins></a></li>
<li><a href="Reference-manual_returned_disabler.html#disablerfound"><ins><code>disabler.found()</code></ins></a></li>
<li><a href="Reference-manual_returned_external_program.html#external_programfound"><ins><code>external_program.found()</code></ins></a></li>
<li><a href="Reference-manual_returned_feature.html#featureallowed"><ins><code>feature.allowed()</code></ins></a></li>
<li><a href="Reference-manual_returned_feature.html#featureauto"><ins><code>feature.auto()</code></ins></a></li>
<li><a href="Reference-manual_returned_feature.html#featuredisabled"><ins><code>feature.disabled()</code></ins></a></li>
<li><a href="Reference-manual_returned_feature.html#featureenabled"><ins><code>feature.enabled()</code></ins></a></li>
<li><a href="Reference-manual_elementary_int.html#intis_even"><ins><code>int.is_even()</code></ins></a></li>
<li><a href="Reference-manual_elementary_int.html#intis_odd"><ins><code>int.is_odd()</code></ins></a></li>
<li><a href="Reference-manual_elementary_list.html#listcontains"><ins><code>list.contains()</code></ins></a></li>
<li><a href="Reference-manual_builtin_meson.html#mesoncan_run_host_binaries"><ins><code>meson.can_run_host_binaries()</code></ins></a></li>
<li><a href="Reference-manual_builtin_meson.html#mesonhas_exe_wrapper"><ins><code>meson.has_exe_wrapper()</code></ins></a></li>
<li><a href="Reference-manual_builtin_meson.html#mesonhas_external_property"><ins><code>meson.has_external_property()</code></ins></a></li>
<li><a href="Reference-manual_builtin_meson.html#mesonis_cross_build"><ins><code>meson.is_cross_build()</code></ins></a></li>
<li><a href="Reference-manual_builtin_meson.html#mesonis_subproject"><ins><code>meson.is_subproject()</code></ins></a></li>
<li><a href="Reference-manual_builtin_meson.html#mesonis_unity"><ins><code>meson.is_unity()</code></ins></a></li>
<li><a href="Reference-manual_returned_module.html#modulefound"><ins><code>module.found()</code></ins></a></li>
<li><a href="Reference-manual_returned_runresult.html#runresultcompiled"><ins><code>runresult.compiled()</code></ins></a></li>
<li><a href="Reference-manual_elementary_str.html#strcontains"><ins><code>str.contains()</code></ins></a></li>
<li><a href="Reference-manual_elementary_str.html#strendswith"><ins><code>str.endswith()</code></ins></a></li>
<li><a href="Reference-manual_elementary_str.html#strstartswith"><ins><code>str.startswith()</code></ins></a></li>
<li><a href="Reference-manual_elementary_str.html#strversion_compare"><ins><code>str.version_compare()</code></ins></a></li>
<li><a href="Reference-manual_returned_subproject.html#subprojectfound"><ins><code>subproject.found()</code></ins></a></li>
</ul>
<h2 id="boolean-methods">Boolean methods</h2>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="boolto_int">bool.to_int()</h3>
<p>Returns <code>1</code> if <code>true</code> and <code>0</code> if <code>false</code></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"><a href="Reference-manual_elementary_int.html"><ins>int</ins></a> to_int()</code></pre>
<p style="padding: 7.5px; margin: 0px;"></p>
<hr>
<p style="padding: 7.5px; margin: 0px;"></p>
<h3 id="boolto_string">bool.to_string()</h3>
<p>Returns the string <code>'true'</code> if the boolean is true or <code>'false'</code> otherwise.
You can also pass it two strings as positional
arguments to specify what to return for true/false. For instance,
<code>bool.to_string('yes', 'no')</code> will return <code>yes</code> if the boolean is
true and <code>no</code> if it is false.</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 the string `'true'` if the boolean is true or `'false'` otherwise
<a href="Reference-manual_elementary_str.html"><ins>str</ins></a> to_string(
<a href="Reference-manual_elementary_str.html"><ins>str</ins></a> [<a href="Reference-manual_elementary_bool.html#to_string_true_str"><b>true_str</b></a>], # The string to return when the boolean is `true`
<a href="Reference-manual_elementary_str.html"><ins>str</ins></a> [<a href="Reference-manual_elementary_bool.html#to_string_false_str"><b>false_str</b></a>], # The string to return when the boolean is `false`
)</code></pre>
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit more space -->
<h4 id="arguments">Arguments</h4>
<p>The method <code>bool.to_string()</code> accepts the following positional 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="to_string_true_str">
<td style="white-space: nowrap; text-align: center; padding: 6px;"><code class="language-meson">true_str</code></td>
<td style="white-space: revert; text-align: center; padding: 6px; word-wrap: break-word;"><a href="Reference-manual_elementary_str.html"><ins><code>str</code></ins></a></td>
<!-- This suboptimal formatting is required to ensure hotdoc correctly generates the HTML -->
<td style="width: 56%; padding: 6px;">
<p>The string to return when the boolean is <code>true</code></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;"><b>[optional]</b></p>
<p style="margin: 0px;"><code class="language-meson">default =
'true'</code></p>
</div>
</td>
</tr>
<tr id="to_string_false_str">
<td style="white-space: nowrap; text-align: center; padding: 6px;"><code class="language-meson">false_str</code></td>
<td style="white-space: revert; text-align: center; padding: 6px; word-wrap: break-word;"><a href="Reference-manual_elementary_str.html"><ins><code>str</code></ins></a></td>
<!-- This suboptimal formatting is required to ensure hotdoc correctly generates the HTML -->
<td style="width: 56%; padding: 6px;">
<p>The string to return when the boolean is <code>false</code></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;"><b>[optional]</b></p>
<p style="margin: 0px;"><code class="language-meson">default =
'false'</code></p>
</div>
</td>
</tr>
</tbody>
</table>
<p style="padding: 5px; margin: 0px;"></p> <!-- Extra space -->
<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_elementary_bool.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>