-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathmacros.html
1188 lines (978 loc) · 60.9 KB
/
macros.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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<title>Le macro</title>
<link rel="stylesheet" type="text/css" href="rustbook.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<div id="nav">
<button id="toggle-nav">
<span class="sr-only">Toggle navigation</span>
<span class="bar"></span>
<span class="bar"></span>
<span class="bar"></span>
</button>
</div>
<div id='toc' class='mobile-hidden'>
<ul class='chapter'>
<li><a href='README.html'><b>1.</b> Introduzione</a>
</li>
<li><a href='getting-started.html'><b>2.</b> Come Iniziare</a>
</li>
<li><a href='guessing-game.html'><b>3.</b> Tutorial: Gioco-indovina</a>
</li>
<li><a href='syntax-and-semantics.html'><b>4.</b> Sintassi e semantica</a>
<ul class='section'>
<li><a href='variable-bindings.html'><b>4.1.</b> Legami di variabili</a>
</li>
<li><a href='functions.html'><b>4.2.</b> Funzioni</a>
</li>
<li><a href='primitive-types.html'><b>4.3.</b> Tipi primitivi</a>
</li>
<li><a href='comments.html'><b>4.4.</b> Commenti</a>
</li>
<li><a href='if.html'><b>4.5.</b> if</a>
</li>
<li><a href='loops.html'><b>4.6.</b> Cicli</a>
</li>
<li><a href='vectors.html'><b>4.7.</b> Vettori</a>
</li>
<li><a href='ownership.html'><b>4.8.</b> Possesso</a>
</li>
<li><a href='references-and-borrowing.html'><b>4.9.</b> Riferimenti e prestito</a>
</li>
<li><a href='lifetimes.html'><b>4.10.</b> Tempo di vita</a>
</li>
<li><a href='mutability.html'><b>4.11.</b> Mutabilità</a>
</li>
<li><a href='structs.html'><b>4.12.</b> Strutture</a>
</li>
<li><a href='enums.html'><b>4.13.</b> Enumerazioni</a>
</li>
<li><a href='match.html'><b>4.14.</b> Match</a>
</li>
<li><a href='patterns.html'><b>4.15.</b> Pattern</a>
</li>
<li><a href='method-syntax.html'><b>4.16.</b> Sintassi dei metodi</a>
</li>
<li><a href='strings.html'><b>4.17.</b> Stringhe</a>
</li>
<li><a href='generics.html'><b>4.18.</b> Genericità</a>
</li>
<li><a href='traits.html'><b>4.19.</b> Tratti</a>
</li>
<li><a href='drop.html'><b>4.20.</b> Drop</a>
</li>
<li><a href='if-let.html'><b>4.21.</b> `if let`</a>
</li>
<li><a href='trait-objects.html'><b>4.22.</b> Oggetti-tratti</a>
</li>
<li><a href='closures.html'><b>4.23.</b> Chiusure</a>
</li>
<li><a href='ufcs.html'><b>4.24.</b> Sintassi universale di chiamata di funzione</a>
</li>
<li><a href='crates-and-modules.html'><b>4.25.</b> Crate e moduli</a>
</li>
<li><a href='const-and-static.html'><b>4.26.</b> `const` e `static`</a>
</li>
<li><a href='attributes.html'><b>4.27.</b> Attributi</a>
</li>
<li><a href='type-aliases.html'><b>4.28.</b> Alias tramite `type`</a>
</li>
<li><a href='casting-between-types.html'><b>4.29.</b> Forzatura di tipo</a>
</li>
<li><a href='associated-types.html'><b>4.30.</b> Tipi associati</a>
</li>
<li><a href='unsized-types.html'><b>4.31.</b> Tipi non dimensionati</a>
</li>
<li><a href='operators-and-overloading.html'><b>4.32.</b> Operatori e sovraccaricamento</a>
</li>
<li><a href='deref-coercions.html'><b>4.33.</b> Coercizione Deref</a>
</li>
<li><a class='active' href='macros.html'><b>4.34.</b> Le macro</a>
</li>
<li><a href='raw-pointers.html'><b>4.35.</b> Puntatori grezzi</a>
</li>
<li><a href='unsafe.html'><b>4.36.</b> `unsafe`</a>
</li>
</ul>
</li>
<li><a href='effective-rust.html'><b>5.</b> Rust efficace</a>
<ul class='section'>
<li><a href='the-stack-and-the-heap.html'><b>5.1.</b> Lo stack e lo heap</a>
</li>
<li><a href='testing.html'><b>5.2.</b> Collaudo</a>
</li>
<li><a href='conditional-compilation.html'><b>5.3.</b> Compilazione condizionale</a>
</li>
<li><a href='documentation.html'><b>5.4.</b> Documentazione</a>
</li>
<li><a href='iterators.html'><b>5.5.</b> Iteratori</a>
</li>
<li><a href='concurrency.html'><b>5.6.</b> Concorrenza</a>
</li>
<li><a href='error-handling.html'><b>5.7.</b> Gestione degli errori</a>
</li>
<li><a href='choosing-your-guarantees.html'><b>5.8.</b> Scegliere le garanzie</a>
</li>
<li><a href='ffi.html'><b>5.9.</b> FFI</a>
</li>
<li><a href='borrow-and-asref.html'><b>5.10.</b> Prestito e AsRef</a>
</li>
<li><a href='release-channels.html'><b>5.11.</b> Canali di rilascio</a>
</li>
<li><a href='using-rust-without-the-standard-library.html'><b>5.12.</b> Usare Rust senza la libreria standard</a>
</li>
</ul>
</li>
<li><a href='nightly-rust.html'><b>6.</b> Rust notturno</a>
<ul class='section'>
<li><a href='compiler-plugins.html'><b>6.1.</b> Plugin del compilatore</a>
</li>
<li><a href='inline-assembly.html'><b>6.2.</b> Assembly in-line</a>
</li>
<li><a href='no-stdlib.html'><b>6.3.</b> Omettere la libreria stdandard</a>
</li>
<li><a href='intrinsics.html'><b>6.4.</b> Intrinseci</a>
</li>
<li><a href='lang-items.html'><b>6.5.</b> Elementi "lang"</a>
</li>
<li><a href='advanced-linking.html'><b>6.6.</b> Link avanzato</a>
</li>
<li><a href='benchmark-tests.html'><b>6.7.</b> Collaudi prestazionali</a>
</li>
<li><a href='box-syntax-and-patterns.html'><b>6.8.</b> Sintassi di box e relativi pattern</a>
</li>
<li><a href='slice-patterns.html'><b>6.9.</b> Pattern di slice</a>
</li>
<li><a href='associated-constants.html'><b>6.10.</b> Costanti associate</a>
</li>
<li><a href='custom-allocators.html'><b>6.11.</b> Allocatori personalizzati</a>
</li>
</ul>
</li>
<li><a href='glossary.html'><b>7.</b> Glossario</a>
</li>
<li><a href='syntax-index.html'><b>8.</b> Indice analitico della sintassi</a>
</li>
</ul>
</div>
<div id='page-wrapper'>
<div id='page'>
<h1 class="title">Le macro</h1>
<p>Abbiamo già visto molti degli strumenti forniti da Rust per creare astrazioni e
per riutilizzare il codice. Queste unità di riuso del codice hanno una ricca
struttura semantica. Per esempio, le funzioni hanno una firma di tipo,
i parametri di tipo hanno dei legami di tratti, e le funzioni sovraccaricate
devono appartenere a un particolare tratto.</p>
<p>Questa struttura significa che le astrazioni del nucleo di Rust hanno
potenti verifiche di correttezza in fase di compilazione. Ma questo si paga
con una ridotta flessibilit. Se si identifica visivamente un pattern di codice
ripetuto, si può trovare difficile o contorto esprimere quel pattern come
funzione generica, tratto, qualcos'altro entro la semantica di Rust.</p>
<p>Le macro ci consentono di astrarre a livello sintattico. Un'invocazione
di macro è un'abbreviazione di una forma sintattica "espansa". Questa
espansione avviene nelle fasi iniziali della compilazione, prima di ogni
verifica statica. Di conseguenza, le macro possono catturare molti pattern
di riutilizzo del codice che le astrazioni del nucleo di Rust non possono.</p>
<p>Lo svantaggio è che il codice basato su macro può essere più difficile
da capire harder, perché poche delle regole incorporate si applicano. Come
le normali funzione, le macro che si comportano bene possono essere usate senza
dover capire come sono implementate. Però, può essere difficile progettare
una macro che si comporta bene! Inoltre, gli errori di compilazione nel codice
che usa macro sono più difficili da capire, perché descrivono errori nel codice
espanso, non nella forma sorgente scritta dagli sviluppatori.</p>
<p>Questi svantaggi rendono le macro qualcosa come "caratteristiche da ultima
spiaggia". Ciò non vuol dire che le macro vanno evitate; fanno parte di Rust
perché talvolta servono per scrivere del codice molto conciso e astratto.
Si deve solo tenere a mente di questi pro e contro.</p>
<h1 id='definire-una-macro' class='section-header'><a href='#definire-una-macro'>Definire una macro</a></h1>
<p>Si avrà già visto la macro <code>vec!</code>, usata per inizializzare un <a href="vectors.html">vettore</a> con una lista di elementi specificati.</p>
<span class='rusttest'>fn main() {
let x: Vec<u32> = vec![1, 2, 3];
assert_eq!(x, [1, 2, 3]);
}</span><pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>x</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u32</span><span class='op'>></span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>];</pre>
<p>Questa non può essere una normale funzione, perché prende un numero variabile
di argomenti. Ma la possiamo immaginare come abbreviazione sintattica di:</p>
<span class='rusttest'>fn main() {
let x: Vec<u32> = {
let mut temp_vec = Vec::new();
temp_vec.push(1);
temp_vec.push(2);
temp_vec.push(3);
temp_vec
};
assert_eq!(x, [1, 2, 3]);
}</span><pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>x</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u32</span><span class='op'>></span> <span class='op'>=</span> {
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>temp_vec</span> <span class='op'>=</span> <span class='ident'>Vec</span>::<span class='ident'>new</span>();
<span class='ident'>temp_vec</span>.<span class='ident'>push</span>(<span class='number'>1</span>);
<span class='ident'>temp_vec</span>.<span class='ident'>push</span>(<span class='number'>2</span>);
<span class='ident'>temp_vec</span>.<span class='ident'>push</span>(<span class='number'>3</span>);
<span class='ident'>temp_vec</span>
};</pre>
<p>Possiamo implementare questa abbreviazione, usando una macro: <sup id="fnref1"><a href="#fn1" rel="footnote">1</a></sup></p>
<span class='rusttest'>macro_rules! vec {
( $( $x:expr ),* ) => {
{
let mut temp_vec = Vec::new();
$(
temp_vec.push($x);
)*
temp_vec
}
};
}
fn main() {
assert_eq!(vec![1,2,3], [1, 2, 3]);
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>vec</span> {
( $( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>:<span class='ident'>expr</span> ),<span class='op'>*</span> ) <span class='op'>=></span> {
{
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>temp_vec</span> <span class='op'>=</span> <span class='ident'>Vec</span>::<span class='ident'>new</span>();
$(
<span class='ident'>temp_vec</span>.<span class='ident'>push</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>);
)<span class='op'>*</span>
<span class='ident'>temp_vec</span>
}
};
}</pre>
<p>Urca, c'è un sacco di sintassi nuova! Analizziamola.</p>
<span class='rusttest'>fn main() {
macro_rules! vec { ... }
}</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>vec</span> { ... }</pre>
<p>Questo dice che stiamo definendo una macro chiamata <code>vec</code>, come <code>fn vec</code>
definirebbe una funzione chiamata <code>vec</code>. Quando si invoca una macro, il nome
della macro è seguito da un punto esclamativo, per es. <code>vec!</code>. Il punto
esclamativo fa parte della sintassi di invocazione e serve a distinguere
una macro da una normale funzione.</p>
<h2 id='pattern-matching' class='section-header'><a href='#pattern-matching'>Pattern-matching</a></h2>
<p>La macro viene definita tramite una serie di regole, che sono casi
di pattern-matching. Sopra, avevamo</p>
<span class='rusttest'>fn main() {
( $( $x:expr ),* ) => { ... };
}</span><pre class='rust rust-example-rendered'>
( $( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>:<span class='ident'>expr</span> ),<span class='op'>*</span> ) <span class='op'>=></span> { ... };</pre>
<p>Questo è simile a un braccio di un'espressione <code>match</code>, ma la corrispondenza
avviene con gli alberi sintattici di Rust, in fase di compilazione.
Il punto-e-virgola dopo l'ultimo caso (che qui è anche l'unico) è facoltativo.
Il "pattern" sul lato sinistro di <code>=></code> è noto come ‘matcher’. Queste
espressioni hanno <a href="../reference.html#macros">la loro piccola grammatica</a> all'interno del linguaggio.</p>
<p>Il matcher <code>$x:expr</code> combacierà con qualunque espressione Rust, legando
quell'albero sintattico alla ‘metavariabile’ <code>$x</code>. L'identificatore <code>expr</code> è
uno ‘specificatore di frammento’; le possibilità complete verranno elencate
più avanti in questa sezione.
Circondando il matcher con <code>$(...),*</code> significa che potranno combaciare
nessuna o alcune espressioni, separate da virgole.</p>
<p>A parte la speciale sintassi del matcher, ogni token Rust che appare in
un matcher deve combaciare esattamente. Per esempio,</p>
<span class='rusttest'>macro_rules! foo {
(x => $e:expr) => (println!("modalità X: {}", $e));
(y => $e:expr) => (println!("modalità Y: {}", $e));
}
fn main() {
foo!(y => 3);
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>foo</span> {
(<span class='ident'>x</span> <span class='op'>=></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>e</span>:<span class='ident'>expr</span>) <span class='op'>=></span> (<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"modalità X: {}"</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>e</span>));
(<span class='ident'>y</span> <span class='op'>=></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>e</span>:<span class='ident'>expr</span>) <span class='op'>=></span> (<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"modalità Y: {}"</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>e</span>));
}
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='macro'>foo</span><span class='macro'>!</span>(<span class='ident'>y</span> <span class='op'>=></span> <span class='number'>3</span>);
}</pre>
<p>stamperà</p>
<pre><code class="language-text">modalità Y: 3
</code></pre>
<p>Con</p>
<span class='rusttest'>fn main() {
foo!(z => 3);
}</span><pre class='rust rust-example-rendered'>
<span class='macro'>foo</span><span class='macro'>!</span>(<span class='ident'>z</span> <span class='op'>=></span> <span class='number'>3</span>);</pre>
<p>otterremo un errore di compilazione</p>
<pre><code class="language-text">error: no rules expected the token `z`
</code></pre>
<h2 id='espansione' class='section-header'><a href='#espansione'>Espansione</a></h2>
<p>Il lato destro di una regola di macro è normale sintassi Rust, per lo più.
Ma possiamo innestare pezzetti della sintassi catturata dal matcher.
Dall'esempio originale:</p>
<span class='rusttest'>fn main() {
$(
temp_vec.push($x);
)*
}</span><pre class='rust rust-example-rendered'>
$(
<span class='ident'>temp_vec</span>.<span class='ident'>push</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>);
)<span class='op'>*</span></pre>
<p>Ogni espressione combaciante <code>$x</code> produrrà una singola istruzione <code>push</code>
nell'espansione della macro. La ripetizione dell'espansione procede di pari
passo con la ripetizione del matcher (fra poco ne diremo di più).</p>
<p>Siccome <code>$x</code> era già stata dichiarata come combaciante un'espressione, non si
ripete <code>:expr</code> sul lato destro. Inoltre, non si aggiunge una virgola
di separazione come parte dell'operatore di ripetizione. Invece, si mette
il punto-e-virgola di terminazione all'interno del blocco ripetuto.</p>
<p>Un altro dettaglio: la macro <code>vec!</code> ha <em>due</em> coppie di graffe sul lato destro.
Vengono spesso combinate così:</p>
<span class='rusttest'>fn main() {
macro_rules! foo {
() => {{
...
}}
}
}</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>foo</span> {
() <span class='op'>=></span> {{
...
}}
}</pre>
<p>Le graffe esterne fanno parte della sintassi di <code>macro_rules!</code>. Di fatto,
si può usare <code>()</code> o <code>[]</code> invece. Delimitano semplicemente il lato destro
nel suo insieme.</p>
<p>Le graffe interne fanno parte della sintassi espansa. Si ricordi che la macro
<code>vec!</code> va usata in un contesto di espressione. Per scrivere un'espressione
contenente più istruzioni, tra cui delle istruzioni <code>let</code>, si deve usare
un blocco. Se invece si scrive una macro che si espande a una singola
espressione, non c'è bisogno di queste graffe ulteriori.</p>
<p>Si noti che non abbiamo mai <em>dichiarato</em> che la macro produce un'espressione.
Infatti, questo non è determinato fino a quando usiamo la macro
come espressione. Con attenzione, si può scrivere una macro la cui espansione
funziona in più contesti. Per esempio, un'abbreviazione di un tipo di dati
potrebbe essere valida sia come espressione che come pattern.</p>
<h2 id='ripetizione' class='section-header'><a href='#ripetizione'>Ripetizione</a></h2>
<p>L'operatore di ripetizione segue due regole principali:</p>
<ol>
<li><code>$(...)*</code> percorre uno "strato" di ripetizioni, per ogni <code>$nome</code> che
contiene, di pari passo, e</li>
<li>ogni <code>$nome</code> deve essere sotto almeno tanti <code>$(...)*</code> quanti sono quelli
con cui ha combaciato. Se è sotto a un numero maggiore, verrà
appropriatamente duplicato.</li>
</ol>
<p>La seguente macro barocca illustra la duplicazione di variabili
da livelli esterni di ripetizione.</p>
<span class='rusttest'>macro_rules! o_O {
(
$(
$x:expr; [ $( $y:expr ),* ]
);*
) => {
&[ $($( $x + $y ),*),* ]
}
}
fn main() {
let a: &[i32]
= o_O!(10; [1, 2, 3];
20; [4, 5, 6]);
assert_eq!(a, [11, 12, 13, 24, 25, 26]);
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>o_O</span> {
(
$(
<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>:<span class='ident'>expr</span>; [ $( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>y</span>:<span class='ident'>expr</span> ),<span class='op'>*</span> ]
);<span class='op'>*</span>
) <span class='op'>=></span> {
<span class='kw-2'>&</span>[ $($( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span> <span class='op'>+</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>y</span> ),<span class='op'>*</span>),<span class='op'>*</span> ]
}
}
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='kw-2'>&</span>[<span class='ident'>i32</span>]
<span class='op'>=</span> <span class='macro'>o_O</span><span class='macro'>!</span>(<span class='number'>10</span>; [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>];
<span class='number'>20</span>; [<span class='number'>4</span>, <span class='number'>5</span>, <span class='number'>6</span>]);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>a</span>, [<span class='number'>11</span>, <span class='number'>12</span>, <span class='number'>13</span>, <span class='number'>24</span>, <span class='number'>25</span>, <span class='number'>26</span>]);
}</pre>
<p>Questa è la sintassi più comune del matcher. Questi esempi usano <code>$(...)*</code>,
che è un combaciamento di tipo "nessuno o alcuni". Alternativamente si può
scrivere <code>$(...)+</code> per un combaciamento di tipo "uno o alcuni". Entrambe
le forme comprendono un separatore facoltativo, che può essere qualunque token
eccetto <code>+</code> o <code>*</code>.</p>
<p>Questo sistema si pasa su
"<a href="https://www.cs.indiana.edu/ftp/techreports/TR206.pdf">Macro-by-Example</a>"
(collegamento a file PDF).</p>
<h1 id='igiene' class='section-header'><a href='#igiene'>Igiene</a></h1>
<p>Alcuni linguaggi implementano macro usando semplici sostituzioni di testo,
il che comporta vari svantaggi. Per esempio, questo programma C stampa <code>13</code>
invece dell'atteso <code>25</code>.</p>
<pre><code class="language-text">#define PER_CINQUE(x) 5 * x
int main() {
printf("%d\n", PER_CINQUE(2 + 3));
return 0;
}
</code></pre>
<p>Dopo l'espansione abbiamo <code>5 * 2 + 3</code>, e la moltiplicazione ha la precedenza
sull'addizione. Chi avesse usato molto le macro del C, probabilmente conosce
le tecniche standard per evitare questo difetto, e così pure cinque o sei
altri. In Rust, non dobbiamo preoccuparcene.</p>
<span class='rusttest'>macro_rules! per_cinque {
($x:expr) => (5 * $x);
}
fn main() {
assert_eq!(25, per_cinque!(2 + 3));
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>per_cinque</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>:<span class='ident'>expr</span>) <span class='op'>=></span> (<span class='number'>5</span> <span class='op'>*</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>);
}
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='number'>25</span>, <span class='macro'>per_cinque</span><span class='macro'>!</span>(<span class='number'>2</span> <span class='op'>+</span> <span class='number'>3</span>));
}</pre>
<p>La metavariabile <code>$x</code> viene analizzata dal parser come singola espressione, e
mantiene il suo posto nell'albero sintattico anche dopo la sostituzione.</p>
<p>Un altro difetto tipico dei sistemi di macro è la ‘cattura di variabile’. Ecco
una macro C, che usa [una estensione del GNU C] per emulare i blocchi
di espressione di Rust.</p>
<pre><code class="language-text">#define LOG(msg) ({ \
int state = get_log_state(); \
if (state > 0) { \
printf("log(%d): %s\n", state, msg); \
} \
})
</code></pre>
<p>Ecco un semplice caso d'uso che che funziona malissimo:</p>
<pre><code class="language-text">const char *state = "reticulating splines";
LOG(state)
</code></pre>
<p>Questo si espande in</p>
<pre><code class="language-text">const char *state = "reticulating splines";
{
int state = get_log_state();
if (state > 0) {
printf("log(%d): %s\n", state, state);
}
}
</code></pre>
<p>La seconda variabile chiamata <code>state</code> oscura la prima. Questo è un difetto
perché l'istruzione printf dovrebbe riferirsi a entrambe.</p>
<p>L'equivalente macro di Rust ha il comportamento desiderato.</p>
<span class='rusttest'>fn get_log_state() -> i32 { 3 }
macro_rules! log {
($msg:expr) => {{
let state: i32 = get_log_state();
if state > 0 {
println!("log({}): {}", state, $msg);
}
}};
}
fn main() {
let state: &str = "reticulating splines";
log!(state);
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>log</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>msg</span>:<span class='ident'>expr</span>) <span class='op'>=></span> {{
<span class='kw'>let</span> <span class='ident'>state</span>: <span class='ident'>i32</span> <span class='op'>=</span> <span class='ident'>get_log_state</span>();
<span class='kw'>if</span> <span class='ident'>state</span> <span class='op'>></span> <span class='number'>0</span> {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"log({}): {}"</span>, <span class='ident'>state</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>msg</span>);
}
}};
}
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='kw'>let</span> <span class='ident'>state</span>: <span class='kw-2'>&</span><span class='ident'>str</span> <span class='op'>=</span> <span class='string'>"reticulating splines"</span>;
<span class='macro'>log</span><span class='macro'>!</span>(<span class='ident'>state</span>);
}</pre>
<p>Questa funziona perché Rust ha un <a href="https://en.wikipedia.org/wiki/Hygienic_macro">sistema igienico di macro</a>. Ogni espansione
di macro avviene in un ‘contesto sintattico’ distinto, e ogni variabile viene
etichettata con il contesto sintattico in cui è stata introdotta. È come se la
variabile <code>state</code> dentro <code>main</code> fosse dipinta di un diverso "colore" rispetto
alla variabile <code>state</code> interna alla macro, e perciò non entrano in conflitto.</p>
<p>Ciò restringe anche la capacità delle macros di introdurre nuovi legami
al punto di invocazione. Del codice come l seguente non funzionerà:</p>
<span class='rusttest'>macro_rules! foo {
() => (let x = 3;);
}
fn main() {
foo!();
println!("{}", x);
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>foo</span> {
() <span class='op'>=></span> (<span class='kw'>let</span> <span class='ident'>x</span> <span class='op'>=</span> <span class='number'>3</span>;);
}
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='macro'>foo</span><span class='macro'>!</span>();
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"{}"</span>, <span class='ident'>x</span>);
}</pre>
<p>Invece, bisogna passare il nome della variabile all'invocazione, così che
sia etichettata con il giusto contesto sintattico.</p>
<span class='rusttest'>macro_rules! foo {
($v:ident) => (let $v = 3;);
}
fn main() {
foo!(x);
println!("{}", x);
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>foo</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>v</span>:<span class='ident'>ident</span>) <span class='op'>=></span> (<span class='kw'>let</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>v</span> <span class='op'>=</span> <span class='number'>3</span>;);
}
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='macro'>foo</span><span class='macro'>!</span>(<span class='ident'>x</span>);
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"{}"</span>, <span class='ident'>x</span>);
}</pre>
<p>Questo vale per i legami <code>let</code> e le etichette dei cicli, ma non per
gli <a href="../reference.html#items">elementi</a>. Quindi il seguente codice compila:</p>
<span class='rusttest'>macro_rules! foo {
() => (fn x() { });
}
fn main() {
foo!();
x();
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>foo</span> {
() <span class='op'>=></span> (<span class='kw'>fn</span> <span class='ident'>x</span>() { });
}
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='macro'>foo</span><span class='macro'>!</span>();
<span class='ident'>x</span>();
}</pre>
<h1 id='macro-ricorsive' class='section-header'><a href='#macro-ricorsive'>Macro ricorsive</a></h1>
<p>Un'espansione di macro può comprendere altre invocazioni di macro, comprese
invocazioni proprio della stessa macro che si sta definendo. Queste macro
ricorsive sono utili per elaborare dell'input strutturato ad albero, come
esemplificato da questa (semplicistica) abbreviazione dell'HTML:</p>
<span class='rusttest'>#![allow(unused_must_use)]
macro_rules! write_html {
($w:expr, ) => (());
($w:expr, $e:tt) => (write!($w, "{}", $e));
($w:expr, $tag:ident [ $($inner:tt)* ] $($rest:tt)*) => {{
write!($w, "<{}>", stringify!($tag));
write_html!($w, $($inner)*);
write!($w, "</{}>", stringify!($tag));
write_html!($w, $($rest)*);
}};
}
fn main() {
// FIXME(#21826)
use std::fmt::Write;
let mut out = String::new();
write_html!(&mut out,
html[
head[title["Guida alle macro"]]
body[h1["Le macro sono il meglio!"]]
]);
assert_eq!(out,
"<html><head><title>Guida alle macro</title></head>\
<body><h1>Le macro sono il meglio!</h1></body></html>");
}
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>write_html</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>w</span>:<span class='ident'>expr</span>, ) <span class='op'>=></span> (());
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>w</span>:<span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>e</span>:<span class='ident'>tt</span>) <span class='op'>=></span> (<span class='macro'>write</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>w</span>, <span class='string'>"{}"</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>e</span>));
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>w</span>:<span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>tag</span>:<span class='ident'>ident</span> [ $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>inner</span>:<span class='ident'>tt</span>)<span class='op'>*</span> ] $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>rest</span>:<span class='ident'>tt</span>)<span class='op'>*</span>) <span class='op'>=></span> {{
<span class='macro'>write</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>w</span>, <span class='string'>"<{}>"</span>, <span class='macro'>stringify</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>tag</span>));
<span class='macro'>write_html</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>w</span>, $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>inner</span>)<span class='op'>*</span>);
<span class='macro'>write</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>w</span>, <span class='string'>"</{}>"</span>, <span class='macro'>stringify</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>tag</span>));
<span class='macro'>write_html</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>w</span>, $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>rest</span>)<span class='op'>*</span>);
}};
}
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>fmt</span>::<span class='ident'>Write</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>out</span> <span class='op'>=</span> <span class='ident'>String</span>::<span class='ident'>new</span>();
<span class='macro'>write_html</span><span class='macro'>!</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>out</span>,
<span class='ident'>html</span>[
<span class='ident'>head</span>[<span class='ident'>title</span>[<span class='string'>"Guida alle macro"</span>]]
<span class='ident'>body</span>[<span class='ident'>h1</span>[<span class='string'>"Le macro sono il meglio!"</span>]]
]);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>out</span>,
<span class='string'>"<html><head><title>Guida alle macro</title></head>\
<body><h1>Le macro sono il meglio!</h1></body></html>"</span>);
}</pre>
<h1 id='debug-del-codice-delle-macro' class='section-header'><a href='#debug-del-codice-delle-macro'>Debug del codice delle macro</a></h1>
<p>Per vedere il risultato dell'espansione delle macro, si esegua
<code>rustc --pretty expanded</code>. L'output rappresenta un interno crate, perciò lo
si può anche inoltrare a <code>rustc</code>, che talvolta produrrà dei messaggi d'errore
migliori di quelli della compilazione originale. Si noti che l'output
di <code>--pretty expanded</code> può avere un significato diverso se più variabili
con lo stesso nome (ma diversi contesti sintattici) sono in gioco nello stesso
ambito. In questo caso <code>--pretty expanded,hygiene</code> esporrà i contesti
sintattici.</p>
<p><code>rustc</code> fornisce due estensioni sintattiche che aiutano il debug delle macro.
Per adesso, sono instabili e richiedono dei feature gate.</p>
<ul>
<li><p><code>log_syntax!(...)</code> stamperà i suoi argomenti sullo standard output, in fase
di compilazione, e si espanderà a niente.</p></li>
<li><p><code>trace_macros!(true)</code> abiliterà l'emissione di un messaggio di compilazione
ogni volta che una macro viene espansa. Si usi <code>trace_macros!(false)</code>
nel corso dell'espansione per disattivarla.</p></li>
</ul>
<h1 id='requisiti-sintattici' class='section-header'><a href='#requisiti-sintattici'>Requisiti sintattici</a></h1>
<p>Anche quando il codice Rust contiene macro non espanse, può essere analizzato
dal parser producendo un completo <a href="glossary.html#abstract-syntax-tree">albero sintattico</a>. Questa proprietà
può essere molto utile per gli editor e per altri strumenti che elaborano
il codice. Ha anche alcune conseguenze per la progettazione del sistema
di macro di Rust.</p>
<p>Una conseguenza è che Rust deve determinare, quando analizza un'invocazione
di macro, se la macro si espanderà in</p>
<ul>
<li>nessuno o alcuni elementi,</li>
<li>nessuno o alcuni metodi,</li>
<li>un'espressione,</li>
<li>un'istruzione, oppure</li>
<li>un pattern.</li>
</ul>
<p>Un'invocazione di macro entro un blocco potrebbe espandersi in alcuni elementi,
oppure in un'espressione / istruzione. Rust usa una semplice regola
per risolvere questa ambiguità. Un'invocazione di macro che si espande
in elementi deve essere o</p>
<ul>
<li>delimitata da graffe, per es. <code>foo! { ... }</code>, oppure</li>
<li>terminata da un punto-e-virgola, per es. <code>foo!(...);</code></li>
</ul>
<p>Un'altra conseguenza dell'analisi pre-espansione è che l'invocazione
della macro deve consistere in token Rust validi. Inoltre, le parentesi tonde,
quadre, e graffe devono essere bilanciate internamente a un'invocazione
di macro. Per esempio, <code>foo!([)</code> è proibito. Questo consente a Rust si sapere
dove finisce l'invocazione della macro.</p>
<p>Più formalmente, il corpo dell'invocazione della macro deve essere una sequenza
di ‘alberi di token’. Un albero di token è definito ricorsivamente come o</p>
<ul>
<li>una sequenza di alberi di token circondati da <code>()</code>, <code>[]</code>, o <code>{}</code>, oppure</li>
<li>qualunque altro token singolo.</li>
</ul>
<p>Internamente a un matcher, ogni metavariabile ha uno ‘specificatore
di frammento’, che identifica a quale forma sintattica combacia. Eccoli:</p>
<ul>
<li><code>ident</code>: un identificatore. Per es.: <code>x</code>, o <code>foo</code>.</li>
<li><code>path</code>: un nome qualificato. Per es.: <code>T::SpecialA</code>.</li>
<li><code>expr</code>: un'espressione. Per es.: <code>2 + 2</code>, o <code>if true { 1 } else { 2 }</code>,
o <code>f(42)</code>.</li>
<li><code>ty</code>: un tipo. Per es.: <code>i32</code>, o <code>Vec<(char, String)></code>, o <code>&T</code>.</li>
<li><code>pat</code>: un pattern. Per es.: <code>Some(t)</code>, o <code>(17, 'a')</code>, o <code>_</code>.</li>
<li><code>stmt</code>: una singola istruzione. Per es.: <code>let x = 3</code>.</li>
<li><code>block</code>: una sequenza di istruzioni delimitata da graffe, che eventualmente
finisce con un'espressione. Per es.: <code>{ log(errore, "ciao"); return 12; }</code>.</li>
<li><code>item</code>: un <a href="../reference.html#items">elemento</a>. Per es.: <code>fn foo() { }</code>, o <code>struct Bar;</code>.</li>
<li><code>meta</code>: un "meta elemento", come si trova negli attributi. Per es.:
<code>cfg(target_os = "windows")</code>.</li>
<li><code>tt</code>: un singolo albero di token.</li>
</ul>
<p>Ci sono altre regole che riguardano il token che segue una metavariabile:</p>
<ul>
<li>le variabili di tipo <code>expr</code> e <code>stmt</code> possono essere seguite solamente da uno
dei seguenti token: <code>=> , ;</code></li>
<li>le variabili di tipo <code>ty</code> e <code>path</code> possono essere seguite solamente da uno
di: <code>=> , = | ; : > [ { as where</code></li>
<li>le variabili di tipo <code>pat</code> possono essere seguite solamente da uno di:
<code>=> , = | if in</code></li>
<li>le variabili di alri tipi possono essere seguite da qualunque token.</li>
</ul>
<p>Queste regole forniscono alla sintassi di Rust un po' di flessibilità
di evolvere senza perdere compatibilità con le macro esistenti.</p>
<p>Il sistema delle macro non tratta affatto l'ambiguità sintattica. Per esempio,
la grammatica <code>$($i:ident)* $e:expr</code> non verrà mai accettato dal parser,
perché il parser sarebbe costretto a scegliere fra analizzare <code>$i</code>
e anlizzare <code>$e</code>. Cambiare la sintassi di invocazione per mettere
un token distintivo davanti può correggere il difetto. In questo caso,
si può scrivere <code>$(I $i:ident)* E $e:expr</code>.</p>
<h1 id='gli-ambiti-e-limportexport-di-macro' class='section-header'><a href='#gli-ambiti-e-limportexport-di-macro'>Gli ambiti e l'import/export di macro</a></h1>
<p>Le macro vengono espanse in una fase iniziale della compilazione, prima della
risoluzione dei nomi. Uno svantaggio è che gli ambiti funzionano diversamente
per le macro, rispetto agli altri costrutti del linguaggio.</p>
<p>Sia la definizione che l'espansione delle macro avvengono in un singolo
attraversamento lessicale del codice sorgente del crate. Quindi una macro
definita nell'ambito del modulo è visibile a tutto il codice seguente nello
stesso modulo, che comprende il corpo di ogni successivo elemendo <code>mod</code> figlio.</p>
<p>Una macro definita entro il corpo di un'unica <code>fn</code>, o da qualunque altra parte
non nell'ambito di un modulo, è visibile solamente entro quell'elemento.</p>
<p>Se un modulo ha l'attributo <code>macro_use</code>, le sue macro sono visibili anche nel
suo modulo genitore dopo l'elemento <code>mod</code> del figlio. Se anche il genitore
ha <code>macro_use</code> allora le macro saranno visibili nel nonno dopo l'elemento
<code>mod</code> del genitore, e così via.</p>
<p>L'attributo <code>macro_use</code> può apparire anche su <code>extern crate</code>. In questo
contesto controlla quali macro vengono caricate da crate esterno, per es.:</p>
<span class='rusttest'>fn main() {
#[macro_use(foo, bar)]
extern crate baz;
}</span><pre class='rust rust-example-rendered'>
<span class='attribute'>#[<span class='ident'>macro_use</span>(<span class='ident'>foo</span>, <span class='ident'>bar</span>)]</span>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>baz</span>;</pre>
<p>Se l'attributo è dato semplicemente come <code>#[macro_use]</code>, tutte le macro vengono
caricate. Se non c'è nessun attributo <code>#[macro_use]</code> allora nessuna macro viene
caricata. Solamente le macro definite con l'attributo <code>#[macro_export]</code> possono
essere caricate.</p>
<p>Per caricare le macro di un crate senza linkarlo nell'output, si usi anche
l'attributo use <code>#[no_link]</code>.</p>
<p>Per esempio:</p>
<span class='rusttest'>macro_rules! m1 { () => (()) }
// qui è visibile: m1
mod foo {
// qui è visibile: m1
#[macro_export]
macro_rules! m2 { () => (()) }
// qui sono visibili: m1, m2
}
// qui è visibile: m1
macro_rules! m3 { () => (()) }
// qui sono visibili: m1, m3
#[macro_use]
mod bar {
// qui sono visibili: m1, m3
macro_rules! m4 { () => (()) }
// qui sono visibili: m1, m3, m4
}
// qui sono visibili: m1, m3, m4
fn main() { }
</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>m1</span> { () <span class='op'>=></span> (()) }
<span class='comment'>// qui è visibile: m1</span>
<span class='kw'>mod</span> <span class='ident'>foo</span> {
<span class='comment'>// qui è visibile: m1</span>
<span class='attribute'>#[<span class='ident'>macro_export</span>]</span>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>m2</span> { () <span class='op'>=></span> (()) }
<span class='comment'>// qui sono visibili: m1, m2</span>
}
<span class='comment'>// qui è visibile: m1</span>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>m3</span> { () <span class='op'>=></span> (()) }
<span class='comment'>// qui sono visibili: m1, m3</span>
<span class='attribute'>#[<span class='ident'>macro_use</span>]</span>
<span class='kw'>mod</span> <span class='ident'>bar</span> {
<span class='comment'>// qui sono visibili: m1, m3</span>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>m4</span> { () <span class='op'>=></span> (()) }
<span class='comment'>// qui sono visibili: m1, m3, m4</span>
}
<span class='comment'>// qui sono visibili: m1, m3, m4</span></pre>
<p>Quando questa libreria viene caricata usando <code>#[macro_use] extern crate</code>,
verrà importata solo <code>m2</code>.</p>
<p>Il Rust Reference ha un <a href="../reference.html#macro-related-attributes">elenco di attributi relativi alle macro</a>.</p>
<h1 id='la-variabile-crate' class='section-header'><a href='#la-variabile-crate'>La variabile <code>$crate</code></a></h1>
<p>Un'ulteriore difficoltà avviene quando una macro viene usata in più crate.
Diciamo che <code>mylib</code> definisce</p>
<span class='rusttest'>pub fn incrementa(x: u32) -> u32 {
x + 1
}
#[macro_export]
macro_rules! inc_a {
($x:expr) => ( ::incrementa($x) )
}
#[macro_export]
macro_rules! inc_b {
($x:expr) => ( ::mylib::increment($x) )
}
fn main() { }
</span><pre class='rust rust-example-rendered'>
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>incrementa</span>(<span class='ident'>x</span>: <span class='ident'>u32</span>) <span class='op'>-></span> <span class='ident'>u32</span> {
<span class='ident'>x</span> <span class='op'>+</span> <span class='number'>1</span>
}
<span class='attribute'>#[<span class='ident'>macro_export</span>]</span>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>inc_a</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>:<span class='ident'>expr</span>) <span class='op'>=></span> ( ::<span class='ident'>incrementa</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>) )
}
<span class='attribute'>#[<span class='ident'>macro_export</span>]</span>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>inc_b</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>:<span class='ident'>expr</span>) <span class='op'>=></span> ( ::<span class='ident'>mylib</span>::<span class='ident'>increment</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>) )
}</pre>
<p><code>inc_a</code> funziona solamente entro <code>mylib</code>, mentre <code>inc_b</code> funziona solamente
al di fuori della libreria. Inoltre, <code>inc_b</code> non funzionerà se l'utente
importerà <code>mylib</code> sotto un altro nome.</p>
<p>Rust non ha (ancora) un sistema d'igiene per i riferimenti dei crate, ma
fornisce una semplice soluzione a questo problema. Entro una macro importata
da un crate chiamato <code>foo</code>, la speciale variabile di macro <code>$crate</code>
si espanderà in <code>::foo</code>. D'altra parte, quando una macro è definita e poi usata
nello stesso crate, <code>$crate</code> si espanderà a niente. Ciò significa
che possiamo scrivere</p>
<span class='rusttest'>#[macro_export]
macro_rules! inc {
($x:expr) => ( $crate::incrementa($x) )
}
fn main() { }
</span><pre class='rust rust-example-rendered'>
<span class='attribute'>#[<span class='ident'>macro_export</span>]</span>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>inc</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>:<span class='ident'>expr</span>) <span class='op'>=></span> ( <span class='macro-nonterminal'>$</span><span class='kw'>crate</span>::<span class='macro-nonterminal'>incrementa</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>x</span>) )
}</pre>
<p>per definire una singola macro che funziona sia all'interno che all'esterno
della nostra libreria. Il nome della funzione si espanderà a <code>::increment</code> in
un caso, e a <code>::mylib::increment</code> nell'altro.</p>
<p>Per mantenere semplice e corretto questo sistema, <code>#[macro_use] extern crate ...</code> può apparire solamente alla radice del nostro crate, non dentro un <code>mod</code>.</p>
<h1 id='lestremità-profonda' class='section-header'><a href='#lestremità-profonda'>L'estremità profonda</a></h1>
<p>La sezione introduttiva ha accennato alle macro ricorsive, ma non ha raccontato
tutta la storia. Le macro ricorsive sono utili per un'altra ragione: ogni
invocazione ricorsiva dà un'altra opportunità di far combaciare gli argomenti
della macro.</p>
<p>Come esempio estremo, è possibile, per quanto poco consigliabile, implementare
l'automa del linguaggio esoterico di programmazione <a href="https://esolangs.org/wiki/Bitwise_Cyclic_Tag">Bitwise_Cyclic_Tag</a> entro il sistema delle macro
di Rust.</p>
<span class='rusttest'>fn main() {
macro_rules! bct {
// cmd 0: d ... => ...
(0, $($ps:tt),* ; $_d:tt)
=> (bct!($($ps),*, 0 ; ));
(0, $($ps:tt),* ; $_d:tt, $($ds:tt),*)
=> (bct!($($ps),*, 0 ; $($ds),*));
// cmd 1p: 1 ... => 1 ... p
(1, $p:tt, $($ps:tt),* ; 1)
=> (bct!($($ps),*, 1, $p ; 1, $p));
(1, $p:tt, $($ps:tt),* ; 1, $($ds:tt),*)
=> (bct!($($ps),*, 1, $p ; 1, $($ds),*, $p));
// cmd 1p: 0 ... => 0 ...
(1, $p:tt, $($ps:tt),* ; $($ds:tt),*)
=> (bct!($($ps),*, 1, $p ; $($ds),*));
// arrestati quando la stringa di dati è vuota
( $($ps:tt),* ; )
=> (());
}
}</span><pre class='rust rust-example-rendered'>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>bct</span> {
<span class='comment'>// cmd 0: d ... => ...</span>
(<span class='number'>0</span>, $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ps</span>:<span class='ident'>tt</span>),<span class='op'>*</span> ; <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>_d</span>:<span class='ident'>tt</span>)
<span class='op'>=></span> (<span class='macro'>bct</span><span class='macro'>!</span>($(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ps</span>),<span class='op'>*</span>, <span class='number'>0</span> ; ));
(<span class='number'>0</span>, $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ps</span>:<span class='ident'>tt</span>),<span class='op'>*</span> ; <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>_d</span>:<span class='ident'>tt</span>, $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ds</span>:<span class='ident'>tt</span>),<span class='op'>*</span>)
<span class='op'>=></span> (<span class='macro'>bct</span><span class='macro'>!</span>($(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ps</span>),<span class='op'>*</span>, <span class='number'>0</span> ; $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ds</span>),<span class='op'>*</span>));
<span class='comment'>// cmd 1p: 1 ... => 1 ... p</span>
(<span class='number'>1</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>p</span>:<span class='ident'>tt</span>, $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ps</span>:<span class='ident'>tt</span>),<span class='op'>*</span> ; <span class='number'>1</span>)