template-quote-impl 0.5.0

A new-fashioned quote! macro implementation with pretty template-engine-like syntax
Documentation
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
extern crate proc_macro;
extern crate proc_macro2;
extern crate syn;

use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use proc_macro2::{Delimiter, Group, Literal, Punct, Spacing, Span, TokenTree};
use proc_macro_error::{abort, proc_macro_error};
use quote::{quote as qquote, quote_spanned as qquote_spanned, TokenStreamExt};
use std::collections::{HashSet, VecDeque};
use syn::{parse_quote, Expr, Ident, Path, Token};

/// The parser for `quote!` macro.
///
/// this struct has some global configs to be initialized using
/// `Default::default()` or `syn::parse::Parse::parse()`. User can specify
/// configs using `quote_configured!` macro.
struct ParseEnvironment {
	span: Expr,
	path_proc_macro2: Path,
	path_quote: Path,
	path_core: Path,
	id_stream: Ident,
	id_counter: Ident,
}

impl syn::parse::Parse for ParseEnvironment {
	fn parse(input: syn::parse::ParseStream<'_>) -> syn::parse::Result<Self> {
		// Read comma-separated `key = value` fields
		let mut fields: Vec<(Ident, Expr)> = Vec::new();
		while !input.is_empty() {
			let ident = input.parse()?;
			input.parse::<Token![:]>()?;
			let expr = input.parse()?;
			fields.push((ident, expr));
			if !input.is_empty() {
				input.parse::<Token![,]>()?;
			}
		}
		let mut this: ParseEnvironment = Default::default();
		for (id, expr) in fields {
			match (id.to_string().as_str(), expr) {
				("proc_macro2", Expr::Path(pat)) => {
					this.path_proc_macro2 = pat.path;
				}
				("quote", Expr::Path(pat)) => {
					this.path_quote = pat.path;
				}
				("core", Expr::Path(pat)) => {
					this.path_core = pat.path;
				}
				("span", expr) => {
					this.span = expr;
				}
				(key, _) => {
					return Err(input.error(format!("Bad config name: {}", key)));
				}
			}
		}
		Ok(this)
	}
}

impl core::default::Default for ParseEnvironment {
	fn default() -> Self {
		Self {
			span: parse_quote! { ::proc_macro2::Span::call_site() },
			path_proc_macro2: parse_quote! { ::proc_macro2 },
			path_quote: parse_quote! { ::template_quote },
			path_core: parse_quote! { ::core },
			id_stream: Ident::new("__template_quote_stream", Span::mixed_site()),
			id_counter: Ident::new("__template_quote_idcnt", Span::mixed_site()),
		}
	}
}

fn eat_terminator(input: &mut VecDeque<TokenTree>) -> bool {
	// Recognize a `..` rest pattern (two joint `.` puncts) wherever it appears
	// in a tuple/slice/struct pattern, not only when it is the final element.
	match (input.pop_front(), input.pop_front()) {
		(Some(TokenTree::Punct(p1)), Some(TokenTree::Punct(p2)))
			if p1.as_char() == '.' && p2.as_char() == '.' && p1.spacing() == Spacing::Joint =>
		{
			true
		}
		(a, b) => {
			if let Some(b) = b {
				input.push_front(b);
			}
			if let Some(a) = a {
				input.push_front(a);
			}
			false
		}
	}
}
fn eat_comma(input: &mut VecDeque<TokenTree>) -> bool {
	match input.pop_front() {
		Some(TokenTree::Punct(p)) if p.as_char() == ',' && p.spacing() == Spacing::Alone => true,
		Some(tt) => {
			input.push_front(tt);
			false
		}
		_ => false,
	}
}
fn collect_ident(input: &mut VecDeque<TokenTree>) -> Result<Vec<Ident>, ()> {
	fn collect_paren_stream(
		mut input: VecDeque<TokenTree>,
		ret: &mut Vec<Ident>,
	) -> Result<(), ()> {
		while !input.is_empty() {
			// A `..` rest pattern binds nothing; consume a following separator
			// so remaining elements (e.g. `[a, .., b]`) are still parsed.
			if eat_terminator(&mut input) {
				if !input.is_empty() && !eat_comma(&mut input) {
					return Err(());
				}
				continue;
			}
			ret.extend(collect_ident(&mut input)?);
			if !input.is_empty() && !eat_comma(&mut input) {
				return Err(());
			}
		}
		Ok(())
	}
	let mut ret = Vec::new();
	// Skip an optional leading `::` (absolute path in e.g. `::core::..::Some(x)`).
	if matches!(
		(input.front(), input.get(1)),
		(Some(TokenTree::Punct(p1)), Some(TokenTree::Punct(p2)))
			if p1.as_char() == ':' && p2.as_char() == ':' && p1.spacing() == Spacing::Joint
	) {
		input.pop_front();
		input.pop_front();
	}
	// Skip binding modifiers: `ref`, `mut`, `ref mut`.
	while matches!(input.front(), Some(TokenTree::Ident(id)) if id == "ref" || id == "mut") {
		input.pop_front();
	}
	match input.pop_front() {
		// Parse `let (..) = ..`
		Some(TokenTree::Group(g))
			if (g.delimiter() == Delimiter::Parenthesis || g.delimiter() == Delimiter::Bracket) =>
		{
			collect_paren_stream(g.stream().into_iter().collect(), &mut ret)?;
			Ok(ret)
		}
		Some(TokenTree::Ident(id)) => {
			loop {
				match input.pop_front() {
					Some(TokenTree::Punct(colon))
						if colon.as_char() == ':' && colon.spacing() == Spacing::Joint =>
					{
						if matches!(
						input.pop_front(),
						Some(TokenTree::Punct(colon)) if colon.as_char() == ':' && colon.spacing() == Spacing::Alone
						) && matches!(input.pop_front(), Some(TokenTree::Ident(_)))
						{
							continue;
						} else {
							return Err(());
						}
					}
					Some(o) => input.push_front(o),
					None => (),
				}
				break;
			}
			match input.pop_front() {
				// Parse `let Ident ( .. ) = ..`
				Some(TokenTree::Group(g)) if g.delimiter() == Delimiter::Parenthesis => {
					collect_paren_stream(g.stream().into_iter().collect(), &mut ret)?;
					Ok(ret)
				}
				// Parse `let Ident { key: value, value2, ... } = ..`
				Some(TokenTree::Group(g)) if g.delimiter() == Delimiter::Brace => {
					let mut inner: VecDeque<TokenTree> = g.stream().into_iter().collect();
					while !inner.is_empty() && !eat_terminator(&mut inner) {
						// Skip `ref`/`mut` modifiers on shorthand fields.
						while matches!(inner.front(), Some(TokenTree::Ident(id)) if id == "ref" || id == "mut")
						{
							inner.pop_front();
						}
						match inner.pop_front() {
							Some(TokenTree::Ident(key)) => {
								// `key: <pattern>` (recurse into the sub-pattern, so
								// non-ident values like `a: (x, y)` work) or the
								// field-shorthand `key`.
								if matches!(inner.front(), Some(TokenTree::Punct(colon)) if colon.as_char() == ':')
								{
									inner.pop_front(); // the field separator `:`
									ret.extend(collect_ident(&mut inner)?);
								} else {
									ret.push(key);
								}
							}
							_ => return Err(()),
						}
						if !inner.is_empty() && !eat_comma(&mut inner) {
							return Err(());
						}
					}
					Ok(ret)
				}
				// Parse `let ident = ..`
				Some(o) => {
					input.push_front(o);
					ret.push(id);
					Ok(ret)
				}
				None => {
					ret.push(id);
					Ok(ret)
				}
			}
		}
		_ => Err(()),
	}
}

fn collect_ident_eq(input: &mut VecDeque<TokenTree>) -> Result<Vec<Ident>, ()> {
	let v = collect_ident(input)?;
	match input.pop_front() {
		Some(TokenTree::Punct(eq)) if eq.as_char() == '=' && eq.spacing() == Spacing::Alone => {
			Ok(v)
		}
		_ => Err(()),
	}
}

fn collect_punct_in_expr(mut stream: VecDeque<TokenTree>) -> (Vec<Ident>, VecDeque<TokenTree>) {
	let mut output = VecDeque::new();
	let mut ids = Vec::new();
	while let Some(tt) = stream.pop_front() {
		match tt {
			TokenTree::Punct(punct) if punct.as_char() == '#' => match stream.pop_front() {
				Some(TokenTree::Ident(id)) => {
					ids.push(id.clone());
					output.push_back(TokenTree::Ident(id));
				}
				Some(o) => {
					output.push_back(TokenTree::Punct(punct));
					output.push_back(o);
				}
				None => {
					output.push_back(TokenTree::Punct(punct));
				}
			},
			// Recurse into groups so that `#var` nested inside a group (e.g.
			// `(#v).iter()` or `matches!(#v, _)`) is interpolated just like at
			// the top level, instead of being left as a literal `# v`.
			TokenTree::Group(group) => {
				let (inner_ids, inner) =
					collect_punct_in_expr(group.stream().into_iter().collect());
				ids.extend(inner_ids);
				let mut new_group = Group::new(group.delimiter(), inner.into_iter().collect());
				new_group.set_span(group.span());
				output.push_back(TokenTree::Group(new_group));
			}
			o => output.push_back(o),
		}
	}
	(ids, output)
}

fn hash_will_be_processed(next: Option<&TokenTree>, rest: &VecDeque<TokenTree>) -> bool {
	match next {
		Some(TokenTree::Ident(_)) => true,
		Some(TokenTree::Group(group)) if group.delimiter() == Delimiter::Brace => true,
		Some(TokenTree::Group(group)) if group.delimiter() == Delimiter::Parenthesis => {
			match (rest.front(), rest.get(1)) {
				(Some(TokenTree::Group(group2)), _) if group2.delimiter() == Delimiter::Brace => {
					true
				}
				(Some(TokenTree::Punct(punct)), _) if punct.as_char() == '*' => true,
				(Some(TokenTree::Punct(_)), Some(TokenTree::Punct(punct2)))
					if punct2.as_char() == '*' =>
				{
					true
				}
				(Some(TokenTree::Punct(_)), Some(TokenTree::Group(group2)))
					if group2.delimiter() == Delimiter::Brace =>
				{
					true
				}
				_ => false,
			}
		}
		_ => false,
	}
}

impl ParseEnvironment {
	fn emit_ident(&self, ident: &Ident) -> TokenStream2 {
		let Self {
			span,
			path_proc_macro2,
			path_quote,
			id_stream,
			..
		} = self;
		let s = ident.to_string();
		if let Some(s) = s.strip_prefix("r#") {
			qquote! {
				<_ as #path_quote::ToTokens>::to_tokens(&#path_proc_macro2::Ident::new_raw(#s, (#span)), &mut #id_stream);
			}
		} else {
			qquote! {
				<_ as #path_quote::ToTokens>::to_tokens(&#path_proc_macro2::Ident::new(#s, (#span)), &mut #id_stream);
			}
		}
	}

	fn emit_literal(&self, lit: &Literal) -> TokenStream2 {
		let Self {
			span,
			path_proc_macro2,
			id_stream,
			..
		} = self;
		let s = lit.to_string();
		qquote! {
			{
				let ts: #path_proc_macro2::TokenStream = #s.parse().expect("Invalid literal str");
				#id_stream.extend(ts.into_iter().map(|mut t| {
					t.set_span(#span);
					t
				}));
			}
		}
	}

	fn emit_punct(&self, punct: &Punct) -> TokenStream2 {
		let Self {
			span,
			path_proc_macro2,
			path_quote,
			id_stream,
			..
		} = self;
		let p = punct.as_char();
		let spacing = match punct.spacing() {
			Spacing::Alone => qquote! {#path_proc_macro2::Spacing::Alone},
			Spacing::Joint => qquote! {#path_proc_macro2::Spacing::Joint},
		};
		qquote! {
			<_ as #path_quote::ToTokens>::to_tokens(&{
				let mut p = #path_proc_macro2::Punct::new(#p, #spacing);
				p.set_span(#span);
				p
			}, &mut #id_stream);
		}
	}

	fn emit_punct_with_spacing(&self, punct: &Punct, spacing: Spacing) -> TokenStream2 {
		let mut p = Punct::new(punct.as_char(), spacing);
		p.set_span(punct.span());
		self.emit_punct(&p)
	}

	fn emit_group(&self, delim: &Delimiter, inner: TokenStream2) -> TokenStream2 {
		let Self {
			span,
			path_proc_macro2,
			path_core,
			id_stream,
			..
		} = self;
		let delim = match delim {
			Delimiter::Parenthesis => qquote! { #path_proc_macro2::Delimiter::Parenthesis },
			Delimiter::Brace => qquote! { #path_proc_macro2::Delimiter::Brace },
			Delimiter::Bracket => qquote! { #path_proc_macro2::Delimiter::Bracket },
			Delimiter::None => qquote! { #path_proc_macro2::Delimiter::None },
		};
		qquote! {
			#id_stream.extend(
				#path_core::option::Option::Some(
					#path_proc_macro2::TokenTree::Group(
						{
							let mut g = #path_proc_macro2::Group::new(#delim, {
								let mut #id_stream = #path_proc_macro2::TokenStream::new();
								{ #inner }
								#id_stream
							});
							g.set_span(#span);
							g
						}
					)
				)
			);
		}
	}

	fn parse_conditional(
		&self,
		conditional: TokenStream2,
		input: VecDeque<TokenTree>,
		vals: &mut HashSet<Ident>,
		sep: Option<Punct>,
		inline_expr_dict: &mut Vec<(Ident, TokenStream2, Span)>,
	) -> TokenStream2 {
		fn parse_if_inner(
			mut cond: VecDeque<TokenTree>,
		) -> (Vec<Ident>, Vec<Ident>, Vec<TokenTree>) {
			let span_ts: TokenStream2 = cond.iter().cloned().collect();
			let mut bak: Vec<_> = cond.iter().cloned().collect();
			match cond.pop_front() {
				Some(TokenTree::Ident(id_let)) if id_let == "let" => {
					let removing_ids = collect_ident_eq(&mut cond).unwrap_or_else(|_| {
						abort!(span_ts, "malformed `if let` conditional in template")
					});
					bak.truncate(bak.len() - cond.len());
					let (appending_ids, rem) = collect_punct_in_expr(cond);
					bak.extend(rem);
					(removing_ids, appending_ids, bak)
				}
				Some(o) => {
					cond.push_front(o);
					bak.truncate(bak.len() - cond.len());
					let (appending_ids, rem) = collect_punct_in_expr(cond);
					bak.extend(rem);
					(vec![], appending_ids, bak)
				}
				None => abort!(span_ts, "empty `if` conditional in template"),
			}
		}
		let mut cond: VecDeque<TokenTree> = conditional.clone().into_iter().collect();
		let cond_len = cond.len();
		let (removing_ids, appending_ids, cond) = match (cond.pop_front(), sep.is_some()) {
			(Some(TokenTree::Ident(id)), false) if id == "if" => {
				let (removing_ids, appending_ids, rem) = parse_if_inner(cond);
				(
					removing_ids,
					appending_ids,
					Some(TokenTree::Ident(id)).into_iter().chain(rem).collect(),
				)
			}
			(Some(TokenTree::Ident(id)), false) if id == "else" => {
				match cond.pop_front() {
					// else if
					Some(TokenTree::Ident(id_if)) if id_if == "if" => {
						let (removing_ids, appending_ids, rem) = parse_if_inner(cond);
						(
							removing_ids,
							appending_ids,
							vec![TokenTree::Ident(id), TokenTree::Ident(id_if)]
								.into_iter()
								.chain(rem)
								.collect(),
						)
					}
					Some(_) => {
						abort!(
							conditional.clone(),
							"malformed `else` in template (expected `else` or `else if`)"
						)
					}
					None => (vec![], vec![], conditional),
				}
			}
			(Some(TokenTree::Ident(id)), false) if id == "let" => {
				let removing_ids = collect_ident_eq(&mut cond).unwrap_or_else(|_| {
					abort!(conditional.clone(), "malformed `let` binding in template")
				});
				let n = cond_len - cond.len();
				let (appending_ids, rem) = collect_punct_in_expr(cond);
				let conditional: TokenStream2 =
					conditional.clone().into_iter().take(n).chain(rem).collect();
				(removing_ids, appending_ids, qquote! {#conditional ;})
			}
			(Some(TokenTree::Ident(id)), _) if id == "while" => match cond.pop_front() {
				Some(TokenTree::Ident(id_let)) if id_let == "let" => {
					let removing_ids = collect_ident_eq(&mut cond).unwrap_or_else(|_| {
						abort!(
							conditional.clone(),
							"malformed `while let` loop in template"
						)
					});
					let n = cond_len - cond.len();
					let (appending_ids, rem) = collect_punct_in_expr(cond);
					let conditional: TokenStream2 =
						conditional.clone().into_iter().take(n).chain(rem).collect();
					(removing_ids, appending_ids, conditional)
				}
				Some(o) => {
					cond.push_front(o);
					let n = cond_len - cond.len();
					let (appending_ids, rem) = collect_punct_in_expr(cond);
					let conditional: TokenStream2 =
						conditional.clone().into_iter().take(n).chain(rem).collect();
					(vec![], appending_ids, conditional)
				}
				None => abort!(conditional.clone(), "empty `while` conditional in template"),
			},
			(Some(TokenTree::Ident(id)), _) if id == "for" => {
				match (collect_ident(&mut cond), cond.pop_front()) {
					(Ok(v), Some(TokenTree::Ident(id_in))) if id_in == "in" => {
						let n = cond_len - cond.len();
						let (appending_ids, rem) = collect_punct_in_expr(cond);
						let conditional: TokenStream2 =
							conditional.clone().into_iter().take(n).chain(rem).collect();
						(v, appending_ids, conditional)
					}
					_ => abort!(
						conditional.clone(),
						"malformed `for` loop in template (expected `for <pat> in <expr>`)"
					),
				}
			}
			_ => abort!(
				conditional.clone(),
				"malformed conditional in template (expected `if`, `else`, `let`, `while` or `for`)"
			),
		};
		let inner = self.parse_inner(input, vals, inline_expr_dict);
		for id in removing_ids {
			vals.remove(&id);
		}
		for id in appending_ids {
			vals.insert(id);
		}
		if let Some(sep) = sep {
			let code_sep = self.emit_punct(&sep);
			let id_counter = &self.id_counter;
			qquote! {
				{
					let mut #id_counter = false;
					#cond {
						if #id_counter { #code_sep }
						#id_counter = true;
						#inner
					}
				}
			}
		} else {
			qquote! {
				#cond {
					#inner
				}
			}
		}
	}

	fn parse_iteration(
		&self,
		input: VecDeque<TokenTree>,
		vals: &mut HashSet<Ident>,
		sep: Option<Punct>,
		inline_expr_dict: &mut Vec<(Ident, TokenStream2, Span)>,
	) -> TokenStream2 {
		let Self {
			path_quote,
			path_core,
			..
		} = self;
		let debug_str = input
			.iter()
			.take(6)
			.map(|item| match item {
				TokenTree::Group(g) => match g.delimiter() {
					Delimiter::Parenthesis => "( .. )".to_owned(),
					Delimiter::Brace => "{ .. }".to_owned(),
					Delimiter::Bracket => "[ .. ]".to_owned(),
					Delimiter::None => "..".to_owned(),
				},
				_ => format!("{}", item),
			})
			.chain(if input.len() > 6 {
				Some("..".to_owned())
			} else {
				None
			})
			.collect::<Vec<_>>()
			.join(" ");
		// Snapshot the repetition-group tokens before `input` is consumed below,
		// so a diagnostic can point directly at the offending group.
		let group_tokens: TokenStream2 = input.iter().cloned().collect();
		let mut inner_vals = HashSet::new();
		let inner_output = self.parse_inner(input, &mut inner_vals, inline_expr_dict);
		let code_sep = sep.map(|sep| self.emit_punct(&Punct::new(sep.as_char(), Spacing::Alone)));
		let val_nam = code_sep
			.as_ref()
			.map(|_| self.id_counter.clone())
			.into_iter()
			.collect::<Vec<_>>();
		vals.extend(inner_vals.iter().cloned());
		let vars: Vec<Ident> = inner_vals.iter().cloned().collect();
		if vars.is_empty() {
			abort!(
				group_tokens,
				"Repetition group `#( {} )*` contains no interpolation variable (`#var`)", debug_str;
				note = "a repetition needs at least one `#var` inside it to drive the iteration"
			);
		}
		// Fresh call-site helper idents per distinct interpolation var: the bound
		// iterator and its runtime "is iterable" flag.
		let it_idents: Vec<Ident> = (0..vars.len())
			.map(|i| Ident::new(&format!("__template_quote_it_{}", i), Span::mixed_site()))
			.collect();
		let m_idents: Vec<Ident> = (0..vars.len())
			.map(|i| Ident::new(&format!("__template_quote_m_{}", i), Span::mixed_site()))
			.collect();
		let bindings = vars
			.iter()
			.zip(&it_idents)
			.zip(&m_idents)
			.map(|((var, it), m)| {
				qquote! {
					#[allow(unused_mut)]
					let (mut #it, #m) = (#var).__template_quote_into_iter();
				}
			});
		// Panic at runtime (preserving historical behavior) if no var is iterable.
		let checker = m_idents
			.iter()
			.fold(qquote! {false}, |acc, m| qquote! {#acc || #m});
		// Left-nested tuple pattern of the user idents matching the left-nested
		// `zip` chain of the bound iterators.
		let (first_var, rest_vars) = vars.split_first().unwrap();
		let (first_it, rest_it) = it_idents.split_first().unwrap();
		let idents_in_tuple = rest_vars
			.iter()
			.fold(qquote! {#first_var}, |prev, next| qquote! {(#prev, #next)});
		let zipped = rest_it
			.iter()
			.fold(qquote! {#first_it}, |prev, next| qquote! {#prev.zip(#next)});
		qquote! {
			{
				#(let mut #val_nam = false;)*
				#[allow(unused_imports)]
				use #path_quote::__private::ext::{
					RepAsIteratorExt as _, RepIteratorExt as _, RepToTokensExt as _,
				};
				#(#bindings)*
				if !(#checker) {
					#path_core::panic!("Cannot iterate the group: #( {} )*", #debug_str);
				}
				for #idents_in_tuple in #zipped {
					#(
						if #val_nam { #code_sep }
						#val_nam = true;
					)*
					#inner_output
				}
			}
		}
	}

	fn parse(&self, input: TokenStream2) -> TokenStream2 {
		let Self {
			path_proc_macro2,
			id_stream,
			..
		} = self;
		let mut hs = HashSet::new();
		let mut dict = Vec::new();
		let result = self.parse_inner(input.into_iter().collect(), &mut hs, &mut dict);
		let inline_vals_code =
			dict.into_iter()
				.fold(TokenStream2::new(), |acc, (id, inner, span)| {
					qquote_spanned! { span =>
						#acc
						let #id = { #inner };
					}
				});
		qquote! {
			{
				let mut #id_stream= #path_proc_macro2::TokenStream::new();
				#inline_vals_code
				{ #result }
				#id_stream
			}
		}
	}

	fn parse_inner(
		&self,
		mut input: VecDeque<TokenTree>,
		vals: &mut HashSet<Ident>,
		inline_expr_dict: &mut Vec<(Ident, TokenStream2, Span)>,
	) -> TokenStream2 {
		let Self {
			path_quote,
			id_stream,
			..
		} = self;
		let mut output = TokenStream2::new();
		while let Some(token) = input.pop_front() {
			match token {
				TokenTree::Group(group) => {
					let inner = group.stream().into_iter().collect();
					let result = self.parse_inner(inner, vals, inline_expr_dict);
					let result = self.emit_group(&group.delimiter(), result);
					output.append_all(result);
				}
				TokenTree::Punct(punct) => match (punct.as_char(), input.pop_front()) {
					// # val
					('#', Some(TokenTree::Ident(ident))) => {
						vals.insert(ident.clone());
						output.append_all(
							qquote! { <_ as #path_quote::ToTokens>::to_tokens(&#ident, &mut #id_stream); },
						);
					}
					// # { ... }
					('#', Some(TokenTree::Group(group)))
						if group.delimiter() == Delimiter::Brace =>
					{
						let inner = group.stream().into_iter().collect::<VecDeque<_>>();
						if inner.is_empty() {
							// `#{}` expands to nothing.
						} else {
							// The inner block is a statement block when it ends with
							// `;`, otherwise it is an expression to interpolate.
							let is_expr = !matches!(
								inner.back(),
								Some(TokenTree::Punct(p)) if p.as_char() == ';'
							);
							let (appending_ids, inner) = collect_punct_in_expr(inner);
							for id in appending_ids {
								vals.insert(id);
							}
							let stream: TokenStream2 = inner.into_iter().collect();
							if is_expr {
								output.append_all(qquote! {
									<_ as #path_quote::ToTokens>::to_tokens(&{
										#stream
									}, &mut #id_stream);
								});
							} else {
								output.append_all(qquote! {
									{ #stream }
								});
							}
						}
					}
					('#', Some(TokenTree::Group(group)))
						if group.delimiter() == Delimiter::Parenthesis =>
					{
						match input.pop_front() {
							// # ( ... ) { ... }
							Some(TokenTree::Group(group2))
								if group2.delimiter() == Delimiter::Brace =>
							{
								output.append_all(self.parse_conditional(
									group.stream(),
									group2.stream().into_iter().collect(),
									vals,
									None,
									inline_expr_dict,
								));
							}
							// # ( ... ) *
							Some(TokenTree::Punct(punct)) if punct.as_char() == '*' => output
								.append_all(self.parse_iteration(
									group.stream().into_iter().collect(),
									vals,
									None,
									inline_expr_dict,
								)),
							Some(TokenTree::Punct(punct0)) => match input.pop_front() {
								// # ( ... ) [SEP] *
								Some(TokenTree::Punct(punct1)) if punct1.as_char() == '*' => output
									.append_all(self.parse_iteration(
										group.stream().into_iter().collect(),
										vals,
										Some(punct0),
										inline_expr_dict,
									)),
								// # ( ... ) [SEP] { ... }
								Some(TokenTree::Group(group2))
									if group2.delimiter() == Delimiter::Brace =>
								{
									output.append_all(self.parse_conditional(
										group.stream(),
										group2.stream().into_iter().collect(),
										vals,
										Some(punct0),
										inline_expr_dict,
									));
								}
								o => {
									if let Some(o) = o {
										input.push_front(o);
									}
									input.push_front(TokenTree::Punct(punct0));
									input.push_front(TokenTree::Group(group));
									output.append_all(self.emit_punct(&punct));
								}
							},
							o => {
								if let Some(o) = o {
									input.push_front(o)
								}
								input.push_front(TokenTree::Group(group));
								output.append_all(self.emit_punct(&punct));
							}
						}
					}
					(_, o) => {
						// A punct written `Joint` immediately before an interpolation
						// that will be processed must be downgraded to `Alone`: the
						// macro cannot know what the interpolation expands to, and a
						// `Joint` punct would silently fuse with a leading punct in
						// the expansion (e.g. `-` + `>` -> `->`). This matches the
						// spacing behaviour of the upstream `quote!` macro.
						let adjust_joint_before_hash = punct.spacing() == Spacing::Joint
							&& matches!(o, Some(TokenTree::Punct(ref p)) if p.as_char() == '#')
							&& hash_will_be_processed(input.front(), &input);
						if let Some(o) = o {
							input.push_front(o);
						}
						if adjust_joint_before_hash {
							output.append_all(self.emit_punct_with_spacing(&punct, Spacing::Alone));
						} else {
							output.append_all(self.emit_punct(&punct));
						}
					}
				},
				TokenTree::Ident(o) => output.append_all(self.emit_ident(&o)),
				TokenTree::Literal(o) => output.append_all(self.emit_literal(&o)),
			}
		}
		output
	}
}

#[proc_macro]
#[proc_macro_error]
pub fn quote(input: TokenStream) -> TokenStream {
	let env: ParseEnvironment = Default::default();
	env.parse(input.into()).into()
}

#[proc_macro]
#[proc_macro_error]
pub fn quote_configured(input: TokenStream) -> TokenStream {
	let input0: TokenStream2 = input.into();
	let mut input = VecDeque::new();
	input.extend(input0.into_iter());
	let env: ParseEnvironment = match input.pop_front() {
		Some(TokenTree::Group(g)) if g.delimiter() == Delimiter::Brace => syn::parse2(g.stream())
			.unwrap_or_else(|e| abort!(g, "malformed `quote_configured!` config block: {}", e)),
		Some(other) => abort!(
			other,
			"`quote_configured!` expects a `{{ key: path, ... }}` config block first"
		),
		None => abort!(
			Span::call_site(),
			"`quote_configured!` expects a `{{ key: path, ... }} => ...` invocation"
		),
	};
	match input.pop_front() {
		Some(TokenTree::Punct(p)) if p.as_char() == '=' && p.spacing() == Spacing::Joint => (),
		Some(other) => abort!(
			other,
			"`quote_configured!` expects `=>` after the config block"
		),
		None => abort!(
			Span::call_site(),
			"`quote_configured!` expects `=>` after the config block"
		),
	}
	match input.pop_front() {
		Some(TokenTree::Punct(p)) if p.as_char() == '>' && p.spacing() == Spacing::Alone => (),
		Some(other) => abort!(
			other,
			"`quote_configured!` expects `=>` after the config block"
		),
		None => abort!(
			Span::call_site(),
			"`quote_configured!` expects `=>` after the config block"
		),
	}
	let mut stream = TokenStream2::new();
	stream.extend(input);
	env.parse(stream).into()
}

#[proc_macro]
#[proc_macro_error]
pub fn quote_spanned(input: TokenStream) -> TokenStream {
	let input0: TokenStream2 = input.into();
	let mut input = VecDeque::new();
	input.extend(input0.into_iter());
	let mut span = TokenStream2::new(); // Tokens before '=>'
	loop {
		match input.pop_front() {
			Some(TokenTree::Punct(p)) if p.as_char() == '=' && p.spacing() == Spacing::Joint => {
				match input.pop_front() {
					Some(TokenTree::Punct(p))
						if p.as_char() == '>' && p.spacing() == Spacing::Alone =>
					{
						// Found '=>'.
						break;
					}
					Some(o) => {
						span.extend(Some(TokenTree::Punct(p)));
						input.push_front(o);
					}
					None => {
						span.extend(Some(TokenTree::Punct(p)));
					}
				}
			}
			Some(o) => span.extend(Some(o)),
			None => abort!(
				Span::call_site(),
				"`quote_spanned!` expects `<span-expr> => <tokens>` (no `=>` found)"
			),
		}
	}
	let mut env: ParseEnvironment = Default::default();
	let span_tokens = span.clone();
	env.span = syn::parse2(span).unwrap_or_else(|e| {
		abort!(
			span_tokens,
			"the `<span>` before `=>` in `quote_spanned!` must be an expression: {}",
			e
		)
	});
	let mut stream = TokenStream2::new();
	stream.extend(input);
	env.parse(stream).into()
}