1#![stable(feature = "proc_macro_lib", since = "1.15.0")]
13#![deny(missing_docs)]
14#![doc(
15 html_playground_url = "https://play.rust-lang.org/",
16 issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
17 test(no_crate_inject, attr(deny(warnings))),
18 test(attr(allow(dead_code, deprecated, unused_variables, unused_mut)))
19)]
20#![doc(rust_logo)]
21#![feature(rustdoc_internals)]
22#![feature(staged_api)]
23#![feature(allow_internal_unstable)]
24#![feature(decl_macro)]
25#![feature(maybe_uninit_write_slice)]
26#![feature(negative_impls)]
27#![feature(panic_can_unwind)]
28#![feature(restricted_std)]
29#![feature(rustc_attrs)]
30#![feature(stmt_expr_attributes)]
31#![feature(extend_one)]
32#![recursion_limit = "256"]
33#![allow(internal_features)]
34#![deny(ffi_unwind_calls)]
35#![warn(rustdoc::unescaped_backticks)]
36#![warn(unreachable_pub)]
37#![deny(unsafe_op_in_unsafe_fn)]
38
39#[unstable(feature = "proc_macro_internals", issue = "27812")]
40#[doc(hidden)]
41pub mod bridge;
42
43mod diagnostic;
44mod escape;
45mod to_tokens;
46
47use std::ffi::CStr;
48use std::ops::{Range, RangeBounds};
49use std::path::PathBuf;
50use std::str::FromStr;
51use std::{error, fmt};
52
53#[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
54pub use diagnostic::{Diagnostic, Level, MultiSpan};
55#[unstable(feature = "proc_macro_value", issue = "136652")]
56pub use rustc_literal_escaper::EscapeError;
57use rustc_literal_escaper::{MixedUnit, Mode, byte_from_char, unescape_mixed, unescape_unicode};
58#[unstable(feature = "proc_macro_totokens", issue = "130977")]
59pub use to_tokens::ToTokens;
60
61use crate::escape::{EscapeOptions, escape_bytes};
62
63#[unstable(feature = "proc_macro_value", issue = "136652")]
65#[derive(Debug, PartialEq, Eq)]
66pub enum ConversionErrorKind {
67 FailedToUnescape(EscapeError),
69 InvalidLiteralKind,
71}
72
73#[stable(feature = "proc_macro_is_available", since = "1.57.0")]
87pub fn is_available() -> bool {
88 bridge::client::is_available()
89}
90
91#[rustc_diagnostic_item = "TokenStream"]
99#[stable(feature = "proc_macro_lib", since = "1.15.0")]
100#[derive(Clone)]
101pub struct TokenStream(Option<bridge::client::TokenStream>);
102
103#[stable(feature = "proc_macro_lib", since = "1.15.0")]
104impl !Send for TokenStream {}
105#[stable(feature = "proc_macro_lib", since = "1.15.0")]
106impl !Sync for TokenStream {}
107
108#[stable(feature = "proc_macro_lib", since = "1.15.0")]
110#[non_exhaustive]
111#[derive(Debug)]
112pub struct LexError;
113
114#[stable(feature = "proc_macro_lexerror_impls", since = "1.44.0")]
115impl fmt::Display for LexError {
116 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
117 f.write_str("cannot parse string into token stream")
118 }
119}
120
121#[stable(feature = "proc_macro_lexerror_impls", since = "1.44.0")]
122impl error::Error for LexError {}
123
124#[stable(feature = "proc_macro_lib", since = "1.15.0")]
125impl !Send for LexError {}
126#[stable(feature = "proc_macro_lib", since = "1.15.0")]
127impl !Sync for LexError {}
128
129#[unstable(feature = "proc_macro_expand", issue = "90765")]
131#[non_exhaustive]
132#[derive(Debug)]
133pub struct ExpandError;
134
135#[unstable(feature = "proc_macro_expand", issue = "90765")]
136impl fmt::Display for ExpandError {
137 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
138 f.write_str("macro expansion failed")
139 }
140}
141
142#[unstable(feature = "proc_macro_expand", issue = "90765")]
143impl error::Error for ExpandError {}
144
145#[unstable(feature = "proc_macro_expand", issue = "90765")]
146impl !Send for ExpandError {}
147
148#[unstable(feature = "proc_macro_expand", issue = "90765")]
149impl !Sync for ExpandError {}
150
151impl TokenStream {
152 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
154 pub fn new() -> TokenStream {
155 TokenStream(None)
156 }
157
158 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
160 pub fn is_empty(&self) -> bool {
161 self.0.as_ref().map(|h| h.is_empty()).unwrap_or(true)
162 }
163
164 #[unstable(feature = "proc_macro_expand", issue = "90765")]
175 pub fn expand_expr(&self) -> Result<TokenStream, ExpandError> {
176 let stream = self.0.as_ref().ok_or(ExpandError)?;
177 match bridge::client::TokenStream::expand_expr(stream) {
178 Ok(stream) => Ok(TokenStream(Some(stream))),
179 Err(_) => Err(ExpandError),
180 }
181 }
182}
183
184#[stable(feature = "proc_macro_lib", since = "1.15.0")]
192impl FromStr for TokenStream {
193 type Err = LexError;
194
195 fn from_str(src: &str) -> Result<TokenStream, LexError> {
196 Ok(TokenStream(Some(bridge::client::TokenStream::from_str(src))))
197 }
198}
199
200#[stable(feature = "proc_macro_lib", since = "1.15.0")]
212impl fmt::Display for TokenStream {
213 #[allow(clippy::recursive_format_impl)] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
215 match &self.0 {
216 Some(ts) => write!(f, "{}", ts.to_string()),
217 None => Ok(()),
218 }
219 }
220}
221
222#[stable(feature = "proc_macro_lib", since = "1.15.0")]
224impl fmt::Debug for TokenStream {
225 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
226 f.write_str("TokenStream ")?;
227 f.debug_list().entries(self.clone()).finish()
228 }
229}
230
231#[stable(feature = "proc_macro_token_stream_default", since = "1.45.0")]
232impl Default for TokenStream {
233 fn default() -> Self {
234 TokenStream::new()
235 }
236}
237
238#[unstable(feature = "proc_macro_quote", issue = "54722")]
239pub use quote::{quote, quote_span};
240
241fn tree_to_bridge_tree(
242 tree: TokenTree,
243) -> bridge::TokenTree<bridge::client::TokenStream, bridge::client::Span, bridge::client::Symbol> {
244 match tree {
245 TokenTree::Group(tt) => bridge::TokenTree::Group(tt.0),
246 TokenTree::Punct(tt) => bridge::TokenTree::Punct(tt.0),
247 TokenTree::Ident(tt) => bridge::TokenTree::Ident(tt.0),
248 TokenTree::Literal(tt) => bridge::TokenTree::Literal(tt.0),
249 }
250}
251
252#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
254impl From<TokenTree> for TokenStream {
255 fn from(tree: TokenTree) -> TokenStream {
256 TokenStream(Some(bridge::client::TokenStream::from_token_tree(tree_to_bridge_tree(tree))))
257 }
258}
259
260struct ConcatTreesHelper {
263 trees: Vec<
264 bridge::TokenTree<
265 bridge::client::TokenStream,
266 bridge::client::Span,
267 bridge::client::Symbol,
268 >,
269 >,
270}
271
272impl ConcatTreesHelper {
273 fn new(capacity: usize) -> Self {
274 ConcatTreesHelper { trees: Vec::with_capacity(capacity) }
275 }
276
277 fn push(&mut self, tree: TokenTree) {
278 self.trees.push(tree_to_bridge_tree(tree));
279 }
280
281 fn build(self) -> TokenStream {
282 if self.trees.is_empty() {
283 TokenStream(None)
284 } else {
285 TokenStream(Some(bridge::client::TokenStream::concat_trees(None, self.trees)))
286 }
287 }
288
289 fn append_to(self, stream: &mut TokenStream) {
290 if self.trees.is_empty() {
291 return;
292 }
293 stream.0 = Some(bridge::client::TokenStream::concat_trees(stream.0.take(), self.trees))
294 }
295}
296
297struct ConcatStreamsHelper {
300 streams: Vec<bridge::client::TokenStream>,
301}
302
303impl ConcatStreamsHelper {
304 fn new(capacity: usize) -> Self {
305 ConcatStreamsHelper { streams: Vec::with_capacity(capacity) }
306 }
307
308 fn push(&mut self, stream: TokenStream) {
309 if let Some(stream) = stream.0 {
310 self.streams.push(stream);
311 }
312 }
313
314 fn build(mut self) -> TokenStream {
315 if self.streams.len() <= 1 {
316 TokenStream(self.streams.pop())
317 } else {
318 TokenStream(Some(bridge::client::TokenStream::concat_streams(None, self.streams)))
319 }
320 }
321
322 fn append_to(mut self, stream: &mut TokenStream) {
323 if self.streams.is_empty() {
324 return;
325 }
326 let base = stream.0.take();
327 if base.is_none() && self.streams.len() == 1 {
328 stream.0 = self.streams.pop();
329 } else {
330 stream.0 = Some(bridge::client::TokenStream::concat_streams(base, self.streams));
331 }
332 }
333}
334
335#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
337impl FromIterator<TokenTree> for TokenStream {
338 fn from_iter<I: IntoIterator<Item = TokenTree>>(trees: I) -> Self {
339 let iter = trees.into_iter();
340 let mut builder = ConcatTreesHelper::new(iter.size_hint().0);
341 iter.for_each(|tree| builder.push(tree));
342 builder.build()
343 }
344}
345
346#[stable(feature = "proc_macro_lib", since = "1.15.0")]
349impl FromIterator<TokenStream> for TokenStream {
350 fn from_iter<I: IntoIterator<Item = TokenStream>>(streams: I) -> Self {
351 let iter = streams.into_iter();
352 let mut builder = ConcatStreamsHelper::new(iter.size_hint().0);
353 iter.for_each(|stream| builder.push(stream));
354 builder.build()
355 }
356}
357
358#[stable(feature = "token_stream_extend", since = "1.30.0")]
359impl Extend<TokenTree> for TokenStream {
360 fn extend<I: IntoIterator<Item = TokenTree>>(&mut self, trees: I) {
361 let iter = trees.into_iter();
362 let mut builder = ConcatTreesHelper::new(iter.size_hint().0);
363 iter.for_each(|tree| builder.push(tree));
364 builder.append_to(self);
365 }
366}
367
368#[stable(feature = "token_stream_extend", since = "1.30.0")]
369impl Extend<TokenStream> for TokenStream {
370 fn extend<I: IntoIterator<Item = TokenStream>>(&mut self, streams: I) {
371 let iter = streams.into_iter();
372 let mut builder = ConcatStreamsHelper::new(iter.size_hint().0);
373 iter.for_each(|stream| builder.push(stream));
374 builder.append_to(self);
375 }
376}
377
378#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
380pub mod token_stream {
381 use crate::{Group, Ident, Literal, Punct, TokenStream, TokenTree, bridge};
382
383 #[derive(Clone)]
387 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
388 pub struct IntoIter(
389 std::vec::IntoIter<
390 bridge::TokenTree<
391 bridge::client::TokenStream,
392 bridge::client::Span,
393 bridge::client::Symbol,
394 >,
395 >,
396 );
397
398 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
399 impl Iterator for IntoIter {
400 type Item = TokenTree;
401
402 fn next(&mut self) -> Option<TokenTree> {
403 self.0.next().map(|tree| match tree {
404 bridge::TokenTree::Group(tt) => TokenTree::Group(Group(tt)),
405 bridge::TokenTree::Punct(tt) => TokenTree::Punct(Punct(tt)),
406 bridge::TokenTree::Ident(tt) => TokenTree::Ident(Ident(tt)),
407 bridge::TokenTree::Literal(tt) => TokenTree::Literal(Literal(tt)),
408 })
409 }
410
411 fn size_hint(&self) -> (usize, Option<usize>) {
412 self.0.size_hint()
413 }
414
415 fn count(self) -> usize {
416 self.0.count()
417 }
418 }
419
420 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
421 impl IntoIterator for TokenStream {
422 type Item = TokenTree;
423 type IntoIter = IntoIter;
424
425 fn into_iter(self) -> IntoIter {
426 IntoIter(self.0.map(|v| v.into_trees()).unwrap_or_default().into_iter())
427 }
428 }
429}
430
431#[unstable(feature = "proc_macro_quote", issue = "54722")]
438#[allow_internal_unstable(proc_macro_def_site, proc_macro_internals, proc_macro_totokens)]
439#[rustc_builtin_macro]
440pub macro quote($($t:tt)*) {
441 }
443
444#[unstable(feature = "proc_macro_internals", issue = "27812")]
445#[doc(hidden)]
446mod quote;
447
448#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
450#[derive(Copy, Clone)]
451pub struct Span(bridge::client::Span);
452
453#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
454impl !Send for Span {}
455#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
456impl !Sync for Span {}
457
458macro_rules! diagnostic_method {
459 ($name:ident, $level:expr) => {
460 #[unstable(feature = "proc_macro_diagnostic", issue = "54140")]
463 pub fn $name<T: Into<String>>(self, message: T) -> Diagnostic {
464 Diagnostic::spanned(self, $level, message)
465 }
466 };
467}
468
469impl Span {
470 #[unstable(feature = "proc_macro_def_site", issue = "54724")]
472 pub fn def_site() -> Span {
473 Span(bridge::client::Span::def_site())
474 }
475
476 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
481 pub fn call_site() -> Span {
482 Span(bridge::client::Span::call_site())
483 }
484
485 #[stable(feature = "proc_macro_mixed_site", since = "1.45.0")]
490 pub fn mixed_site() -> Span {
491 Span(bridge::client::Span::mixed_site())
492 }
493
494 #[unstable(feature = "proc_macro_span", issue = "54725")]
497 pub fn parent(&self) -> Option<Span> {
498 self.0.parent().map(Span)
499 }
500
501 #[unstable(feature = "proc_macro_span", issue = "54725")]
505 pub fn source(&self) -> Span {
506 Span(self.0.source())
507 }
508
509 #[unstable(feature = "proc_macro_span", issue = "54725")]
511 pub fn byte_range(&self) -> Range<usize> {
512 self.0.byte_range()
513 }
514
515 #[unstable(feature = "proc_macro_span", issue = "54725")]
517 pub fn start(&self) -> Span {
518 Span(self.0.start())
519 }
520
521 #[unstable(feature = "proc_macro_span", issue = "54725")]
523 pub fn end(&self) -> Span {
524 Span(self.0.end())
525 }
526
527 #[unstable(feature = "proc_macro_span", issue = "54725")]
531 pub fn line(&self) -> usize {
532 self.0.line()
533 }
534
535 #[unstable(feature = "proc_macro_span", issue = "54725")]
539 pub fn column(&self) -> usize {
540 self.0.column()
541 }
542
543 #[unstable(feature = "proc_macro_span", issue = "54725")]
548 pub fn file(&self) -> String {
549 self.0.file()
550 }
551
552 #[unstable(feature = "proc_macro_span", issue = "54725")]
558 pub fn local_file(&self) -> Option<PathBuf> {
559 self.0.local_file().map(|s| PathBuf::from(s))
560 }
561
562 #[unstable(feature = "proc_macro_span", issue = "54725")]
566 pub fn join(&self, other: Span) -> Option<Span> {
567 self.0.join(other.0).map(Span)
568 }
569
570 #[stable(feature = "proc_macro_span_resolved_at", since = "1.45.0")]
573 pub fn resolved_at(&self, other: Span) -> Span {
574 Span(self.0.resolved_at(other.0))
575 }
576
577 #[stable(feature = "proc_macro_span_located_at", since = "1.45.0")]
580 pub fn located_at(&self, other: Span) -> Span {
581 other.resolved_at(*self)
582 }
583
584 #[unstable(feature = "proc_macro_span", issue = "54725")]
586 pub fn eq(&self, other: &Span) -> bool {
587 self.0 == other.0
588 }
589
590 #[stable(feature = "proc_macro_source_text", since = "1.66.0")]
598 pub fn source_text(&self) -> Option<String> {
599 self.0.source_text()
600 }
601
602 #[doc(hidden)]
604 #[unstable(feature = "proc_macro_internals", issue = "27812")]
605 pub fn save_span(&self) -> usize {
606 self.0.save_span()
607 }
608
609 #[doc(hidden)]
611 #[unstable(feature = "proc_macro_internals", issue = "27812")]
612 pub fn recover_proc_macro_span(id: usize) -> Span {
613 Span(bridge::client::Span::recover_proc_macro_span(id))
614 }
615
616 diagnostic_method!(error, Level::Error);
617 diagnostic_method!(warning, Level::Warning);
618 diagnostic_method!(note, Level::Note);
619 diagnostic_method!(help, Level::Help);
620}
621
622#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
624impl fmt::Debug for Span {
625 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
626 self.0.fmt(f)
627 }
628}
629
630#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
632#[derive(Clone)]
633pub enum TokenTree {
634 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
636 Group(#[stable(feature = "proc_macro_lib2", since = "1.29.0")] Group),
637 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
639 Ident(#[stable(feature = "proc_macro_lib2", since = "1.29.0")] Ident),
640 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
642 Punct(#[stable(feature = "proc_macro_lib2", since = "1.29.0")] Punct),
643 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
645 Literal(#[stable(feature = "proc_macro_lib2", since = "1.29.0")] Literal),
646}
647
648#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
649impl !Send for TokenTree {}
650#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
651impl !Sync for TokenTree {}
652
653impl TokenTree {
654 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
657 pub fn span(&self) -> Span {
658 match *self {
659 TokenTree::Group(ref t) => t.span(),
660 TokenTree::Ident(ref t) => t.span(),
661 TokenTree::Punct(ref t) => t.span(),
662 TokenTree::Literal(ref t) => t.span(),
663 }
664 }
665
666 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
672 pub fn set_span(&mut self, span: Span) {
673 match *self {
674 TokenTree::Group(ref mut t) => t.set_span(span),
675 TokenTree::Ident(ref mut t) => t.set_span(span),
676 TokenTree::Punct(ref mut t) => t.set_span(span),
677 TokenTree::Literal(ref mut t) => t.set_span(span),
678 }
679 }
680}
681
682#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
684impl fmt::Debug for TokenTree {
685 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
686 match *self {
689 TokenTree::Group(ref tt) => tt.fmt(f),
690 TokenTree::Ident(ref tt) => tt.fmt(f),
691 TokenTree::Punct(ref tt) => tt.fmt(f),
692 TokenTree::Literal(ref tt) => tt.fmt(f),
693 }
694 }
695}
696
697#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
698impl From<Group> for TokenTree {
699 fn from(g: Group) -> TokenTree {
700 TokenTree::Group(g)
701 }
702}
703
704#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
705impl From<Ident> for TokenTree {
706 fn from(g: Ident) -> TokenTree {
707 TokenTree::Ident(g)
708 }
709}
710
711#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
712impl From<Punct> for TokenTree {
713 fn from(g: Punct) -> TokenTree {
714 TokenTree::Punct(g)
715 }
716}
717
718#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
719impl From<Literal> for TokenTree {
720 fn from(g: Literal) -> TokenTree {
721 TokenTree::Literal(g)
722 }
723}
724
725#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
737impl fmt::Display for TokenTree {
738 #[allow(clippy::recursive_format_impl)] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
740 match self {
741 TokenTree::Group(t) => write!(f, "{t}"),
742 TokenTree::Ident(t) => write!(f, "{t}"),
743 TokenTree::Punct(t) => write!(f, "{t}"),
744 TokenTree::Literal(t) => write!(f, "{t}"),
745 }
746 }
747}
748
749#[derive(Clone)]
753#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
754pub struct Group(bridge::Group<bridge::client::TokenStream, bridge::client::Span>);
755
756#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
757impl !Send for Group {}
758#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
759impl !Sync for Group {}
760
761#[derive(Copy, Clone, Debug, PartialEq, Eq)]
763#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
764pub enum Delimiter {
765 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
767 Parenthesis,
768 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
770 Brace,
771 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
773 Bracket,
774 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
792 None,
793}
794
795impl Group {
796 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
802 pub fn new(delimiter: Delimiter, stream: TokenStream) -> Group {
803 Group(bridge::Group {
804 delimiter,
805 stream: stream.0,
806 span: bridge::DelimSpan::from_single(Span::call_site().0),
807 })
808 }
809
810 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
812 pub fn delimiter(&self) -> Delimiter {
813 self.0.delimiter
814 }
815
816 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
821 pub fn stream(&self) -> TokenStream {
822 TokenStream(self.0.stream.clone())
823 }
824
825 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
833 pub fn span(&self) -> Span {
834 Span(self.0.span.entire)
835 }
836
837 #[stable(feature = "proc_macro_group_span", since = "1.55.0")]
844 pub fn span_open(&self) -> Span {
845 Span(self.0.span.open)
846 }
847
848 #[stable(feature = "proc_macro_group_span", since = "1.55.0")]
855 pub fn span_close(&self) -> Span {
856 Span(self.0.span.close)
857 }
858
859 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
866 pub fn set_span(&mut self, span: Span) {
867 self.0.span = bridge::DelimSpan::from_single(span.0);
868 }
869}
870
871#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
875impl fmt::Display for Group {
876 #[allow(clippy::recursive_format_impl)] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
878 write!(f, "{}", TokenStream::from(TokenTree::from(self.clone())))
879 }
880}
881
882#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
883impl fmt::Debug for Group {
884 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
885 f.debug_struct("Group")
886 .field("delimiter", &self.delimiter())
887 .field("stream", &self.stream())
888 .field("span", &self.span())
889 .finish()
890 }
891}
892
893#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
898#[derive(Clone)]
899pub struct Punct(bridge::Punct<bridge::client::Span>);
900
901#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
902impl !Send for Punct {}
903#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
904impl !Sync for Punct {}
905
906#[derive(Copy, Clone, Debug, PartialEq, Eq)]
909#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
910pub enum Spacing {
911 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
923 Joint,
924 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
931 Alone,
932}
933
934impl Punct {
935 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
942 pub fn new(ch: char, spacing: Spacing) -> Punct {
943 const LEGAL_CHARS: &[char] = &[
944 '=', '<', '>', '!', '~', '+', '-', '*', '/', '%', '^', '&', '|', '@', '.', ',', ';',
945 ':', '#', '$', '?', '\'',
946 ];
947 if !LEGAL_CHARS.contains(&ch) {
948 panic!("unsupported character `{:?}`", ch);
949 }
950 Punct(bridge::Punct {
951 ch: ch as u8,
952 joint: spacing == Spacing::Joint,
953 span: Span::call_site().0,
954 })
955 }
956
957 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
959 pub fn as_char(&self) -> char {
960 self.0.ch as char
961 }
962
963 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
967 pub fn spacing(&self) -> Spacing {
968 if self.0.joint { Spacing::Joint } else { Spacing::Alone }
969 }
970
971 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
973 pub fn span(&self) -> Span {
974 Span(self.0.span)
975 }
976
977 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
979 pub fn set_span(&mut self, span: Span) {
980 self.0.span = span.0;
981 }
982}
983
984#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
987impl fmt::Display for Punct {
988 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
989 write!(f, "{}", self.as_char())
990 }
991}
992
993#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
994impl fmt::Debug for Punct {
995 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
996 f.debug_struct("Punct")
997 .field("ch", &self.as_char())
998 .field("spacing", &self.spacing())
999 .field("span", &self.span())
1000 .finish()
1001 }
1002}
1003
1004#[stable(feature = "proc_macro_punct_eq", since = "1.50.0")]
1005impl PartialEq<char> for Punct {
1006 fn eq(&self, rhs: &char) -> bool {
1007 self.as_char() == *rhs
1008 }
1009}
1010
1011#[stable(feature = "proc_macro_punct_eq_flipped", since = "1.52.0")]
1012impl PartialEq<Punct> for char {
1013 fn eq(&self, rhs: &Punct) -> bool {
1014 *self == rhs.as_char()
1015 }
1016}
1017
1018#[derive(Clone)]
1020#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1021pub struct Ident(bridge::Ident<bridge::client::Span, bridge::client::Symbol>);
1022
1023impl Ident {
1024 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1044 pub fn new(string: &str, span: Span) -> Ident {
1045 Ident(bridge::Ident {
1046 sym: bridge::client::Symbol::new_ident(string, false),
1047 is_raw: false,
1048 span: span.0,
1049 })
1050 }
1051
1052 #[stable(feature = "proc_macro_raw_ident", since = "1.47.0")]
1057 pub fn new_raw(string: &str, span: Span) -> Ident {
1058 Ident(bridge::Ident {
1059 sym: bridge::client::Symbol::new_ident(string, true),
1060 is_raw: true,
1061 span: span.0,
1062 })
1063 }
1064
1065 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1068 pub fn span(&self) -> Span {
1069 Span(self.0.span)
1070 }
1071
1072 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1074 pub fn set_span(&mut self, span: Span) {
1075 self.0.span = span.0;
1076 }
1077}
1078
1079#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1082impl fmt::Display for Ident {
1083 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1084 if self.0.is_raw {
1085 f.write_str("r#")?;
1086 }
1087 fmt::Display::fmt(&self.0.sym, f)
1088 }
1089}
1090
1091#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1092impl fmt::Debug for Ident {
1093 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1094 f.debug_struct("Ident")
1095 .field("ident", &self.to_string())
1096 .field("span", &self.span())
1097 .finish()
1098 }
1099}
1100
1101#[derive(Clone)]
1106#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1107pub struct Literal(bridge::Literal<bridge::client::Span, bridge::client::Symbol>);
1108
1109macro_rules! suffixed_int_literals {
1110 ($($name:ident => $kind:ident,)*) => ($(
1111 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1123 pub fn $name(n: $kind) -> Literal {
1124 Literal(bridge::Literal {
1125 kind: bridge::LitKind::Integer,
1126 symbol: bridge::client::Symbol::new(&n.to_string()),
1127 suffix: Some(bridge::client::Symbol::new(stringify!($kind))),
1128 span: Span::call_site().0,
1129 })
1130 }
1131 )*)
1132}
1133
1134macro_rules! unsuffixed_int_literals {
1135 ($($name:ident => $kind:ident,)*) => ($(
1136 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1150 pub fn $name(n: $kind) -> Literal {
1151 Literal(bridge::Literal {
1152 kind: bridge::LitKind::Integer,
1153 symbol: bridge::client::Symbol::new(&n.to_string()),
1154 suffix: None,
1155 span: Span::call_site().0,
1156 })
1157 }
1158 )*)
1159}
1160
1161impl Literal {
1162 fn new(kind: bridge::LitKind, value: &str, suffix: Option<&str>) -> Self {
1163 Literal(bridge::Literal {
1164 kind,
1165 symbol: bridge::client::Symbol::new(value),
1166 suffix: suffix.map(bridge::client::Symbol::new),
1167 span: Span::call_site().0,
1168 })
1169 }
1170
1171 suffixed_int_literals! {
1172 u8_suffixed => u8,
1173 u16_suffixed => u16,
1174 u32_suffixed => u32,
1175 u64_suffixed => u64,
1176 u128_suffixed => u128,
1177 usize_suffixed => usize,
1178 i8_suffixed => i8,
1179 i16_suffixed => i16,
1180 i32_suffixed => i32,
1181 i64_suffixed => i64,
1182 i128_suffixed => i128,
1183 isize_suffixed => isize,
1184 }
1185
1186 unsuffixed_int_literals! {
1187 u8_unsuffixed => u8,
1188 u16_unsuffixed => u16,
1189 u32_unsuffixed => u32,
1190 u64_unsuffixed => u64,
1191 u128_unsuffixed => u128,
1192 usize_unsuffixed => usize,
1193 i8_unsuffixed => i8,
1194 i16_unsuffixed => i16,
1195 i32_unsuffixed => i32,
1196 i64_unsuffixed => i64,
1197 i128_unsuffixed => i128,
1198 isize_unsuffixed => isize,
1199 }
1200
1201 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1214 pub fn f32_unsuffixed(n: f32) -> Literal {
1215 if !n.is_finite() {
1216 panic!("Invalid float literal {n}");
1217 }
1218 let mut repr = n.to_string();
1219 if !repr.contains('.') {
1220 repr.push_str(".0");
1221 }
1222 Literal::new(bridge::LitKind::Float, &repr, None)
1223 }
1224
1225 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1239 pub fn f32_suffixed(n: f32) -> Literal {
1240 if !n.is_finite() {
1241 panic!("Invalid float literal {n}");
1242 }
1243 Literal::new(bridge::LitKind::Float, &n.to_string(), Some("f32"))
1244 }
1245
1246 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1259 pub fn f64_unsuffixed(n: f64) -> Literal {
1260 if !n.is_finite() {
1261 panic!("Invalid float literal {n}");
1262 }
1263 let mut repr = n.to_string();
1264 if !repr.contains('.') {
1265 repr.push_str(".0");
1266 }
1267 Literal::new(bridge::LitKind::Float, &repr, None)
1268 }
1269
1270 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1284 pub fn f64_suffixed(n: f64) -> Literal {
1285 if !n.is_finite() {
1286 panic!("Invalid float literal {n}");
1287 }
1288 Literal::new(bridge::LitKind::Float, &n.to_string(), Some("f64"))
1289 }
1290
1291 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1293 pub fn string(string: &str) -> Literal {
1294 let escape = EscapeOptions {
1295 escape_single_quote: false,
1296 escape_double_quote: true,
1297 escape_nonascii: false,
1298 };
1299 let repr = escape_bytes(string.as_bytes(), escape);
1300 Literal::new(bridge::LitKind::Str, &repr, None)
1301 }
1302
1303 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1305 pub fn character(ch: char) -> Literal {
1306 let escape = EscapeOptions {
1307 escape_single_quote: true,
1308 escape_double_quote: false,
1309 escape_nonascii: false,
1310 };
1311 let repr = escape_bytes(ch.encode_utf8(&mut [0u8; 4]).as_bytes(), escape);
1312 Literal::new(bridge::LitKind::Char, &repr, None)
1313 }
1314
1315 #[stable(feature = "proc_macro_byte_character", since = "1.79.0")]
1317 pub fn byte_character(byte: u8) -> Literal {
1318 let escape = EscapeOptions {
1319 escape_single_quote: true,
1320 escape_double_quote: false,
1321 escape_nonascii: true,
1322 };
1323 let repr = escape_bytes(&[byte], escape);
1324 Literal::new(bridge::LitKind::Byte, &repr, None)
1325 }
1326
1327 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1329 pub fn byte_string(bytes: &[u8]) -> Literal {
1330 let escape = EscapeOptions {
1331 escape_single_quote: false,
1332 escape_double_quote: true,
1333 escape_nonascii: true,
1334 };
1335 let repr = escape_bytes(bytes, escape);
1336 Literal::new(bridge::LitKind::ByteStr, &repr, None)
1337 }
1338
1339 #[stable(feature = "proc_macro_c_str_literals", since = "1.79.0")]
1341 pub fn c_string(string: &CStr) -> Literal {
1342 let escape = EscapeOptions {
1343 escape_single_quote: false,
1344 escape_double_quote: true,
1345 escape_nonascii: false,
1346 };
1347 let repr = escape_bytes(string.to_bytes(), escape);
1348 Literal::new(bridge::LitKind::CStr, &repr, None)
1349 }
1350
1351 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1353 pub fn span(&self) -> Span {
1354 Span(self.0.span)
1355 }
1356
1357 #[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1359 pub fn set_span(&mut self, span: Span) {
1360 self.0.span = span.0;
1361 }
1362
1363 #[unstable(feature = "proc_macro_span", issue = "54725")]
1375 pub fn subspan<R: RangeBounds<usize>>(&self, range: R) -> Option<Span> {
1376 self.0.span.subspan(range.start_bound().cloned(), range.end_bound().cloned()).map(Span)
1377 }
1378
1379 fn with_symbol_and_suffix<R>(&self, f: impl FnOnce(&str, &str) -> R) -> R {
1380 self.0.symbol.with(|symbol| match self.0.suffix {
1381 Some(suffix) => suffix.with(|suffix| f(symbol, suffix)),
1382 None => f(symbol, ""),
1383 })
1384 }
1385
1386 fn with_stringify_parts<R>(&self, f: impl FnOnce(&[&str]) -> R) -> R {
1391 fn get_hashes_str(num: u8) -> &'static str {
1395 const HASHES: &str = "\
1396 ################################################################\
1397 ################################################################\
1398 ################################################################\
1399 ################################################################\
1400 ";
1401 const _: () = assert!(HASHES.len() == 256);
1402 &HASHES[..num as usize]
1403 }
1404
1405 self.with_symbol_and_suffix(|symbol, suffix| match self.0.kind {
1406 bridge::LitKind::Byte => f(&["b'", symbol, "'", suffix]),
1407 bridge::LitKind::Char => f(&["'", symbol, "'", suffix]),
1408 bridge::LitKind::Str => f(&["\"", symbol, "\"", suffix]),
1409 bridge::LitKind::StrRaw(n) => {
1410 let hashes = get_hashes_str(n);
1411 f(&["r", hashes, "\"", symbol, "\"", hashes, suffix])
1412 }
1413 bridge::LitKind::ByteStr => f(&["b\"", symbol, "\"", suffix]),
1414 bridge::LitKind::ByteStrRaw(n) => {
1415 let hashes = get_hashes_str(n);
1416 f(&["br", hashes, "\"", symbol, "\"", hashes, suffix])
1417 }
1418 bridge::LitKind::CStr => f(&["c\"", symbol, "\"", suffix]),
1419 bridge::LitKind::CStrRaw(n) => {
1420 let hashes = get_hashes_str(n);
1421 f(&["cr", hashes, "\"", symbol, "\"", hashes, suffix])
1422 }
1423
1424 bridge::LitKind::Integer | bridge::LitKind::Float | bridge::LitKind::ErrWithGuar => {
1425 f(&[symbol, suffix])
1426 }
1427 })
1428 }
1429
1430 #[unstable(feature = "proc_macro_value", issue = "136652")]
1432 pub fn str_value(&self) -> Result<String, ConversionErrorKind> {
1433 self.0.symbol.with(|symbol| match self.0.kind {
1434 bridge::LitKind::Str => {
1435 if symbol.contains('\\') {
1436 let mut buf = String::with_capacity(symbol.len());
1437 let mut error = None;
1438 unescape_unicode(
1442 symbol,
1443 Mode::Str,
1444 &mut #[inline(always)]
1445 |_, c| match c {
1446 Ok(c) => buf.push(c),
1447 Err(err) => {
1448 if err.is_fatal() {
1449 error = Some(ConversionErrorKind::FailedToUnescape(err));
1450 }
1451 }
1452 },
1453 );
1454 if let Some(error) = error { Err(error) } else { Ok(buf) }
1455 } else {
1456 Ok(symbol.to_string())
1457 }
1458 }
1459 bridge::LitKind::StrRaw(_) => Ok(symbol.to_string()),
1460 _ => Err(ConversionErrorKind::InvalidLiteralKind),
1461 })
1462 }
1463
1464 #[unstable(feature = "proc_macro_value", issue = "136652")]
1467 pub fn cstr_value(&self) -> Result<Vec<u8>, ConversionErrorKind> {
1468 self.0.symbol.with(|symbol| match self.0.kind {
1469 bridge::LitKind::CStr => {
1470 let mut error = None;
1471 let mut buf = Vec::with_capacity(symbol.len());
1472
1473 unescape_mixed(symbol, Mode::CStr, &mut |_span, c| match c {
1474 Ok(MixedUnit::Char(c)) => {
1475 buf.extend_from_slice(c.encode_utf8(&mut [0; 4]).as_bytes())
1476 }
1477 Ok(MixedUnit::HighByte(b)) => buf.push(b),
1478 Err(err) => {
1479 if err.is_fatal() {
1480 error = Some(ConversionErrorKind::FailedToUnescape(err));
1481 }
1482 }
1483 });
1484 if let Some(error) = error {
1485 Err(error)
1486 } else {
1487 buf.push(0);
1488 Ok(buf)
1489 }
1490 }
1491 bridge::LitKind::CStrRaw(_) => {
1492 let mut buf = symbol.to_owned().into_bytes();
1496 buf.push(0);
1497 Ok(buf)
1498 }
1499 _ => Err(ConversionErrorKind::InvalidLiteralKind),
1500 })
1501 }
1502
1503 #[unstable(feature = "proc_macro_value", issue = "136652")]
1506 pub fn byte_str_value(&self) -> Result<Vec<u8>, ConversionErrorKind> {
1507 self.0.symbol.with(|symbol| match self.0.kind {
1508 bridge::LitKind::ByteStr => {
1509 let mut buf = Vec::with_capacity(symbol.len());
1510 let mut error = None;
1511
1512 unescape_unicode(symbol, Mode::ByteStr, &mut |_, c| match c {
1513 Ok(c) => buf.push(byte_from_char(c)),
1514 Err(err) => {
1515 if err.is_fatal() {
1516 error = Some(ConversionErrorKind::FailedToUnescape(err));
1517 }
1518 }
1519 });
1520 if let Some(error) = error { Err(error) } else { Ok(buf) }
1521 }
1522 bridge::LitKind::ByteStrRaw(_) => {
1523 Ok(symbol.to_owned().into_bytes())
1526 }
1527 _ => Err(ConversionErrorKind::InvalidLiteralKind),
1528 })
1529 }
1530}
1531
1532#[stable(feature = "proc_macro_literal_parse", since = "1.54.0")]
1543impl FromStr for Literal {
1544 type Err = LexError;
1545
1546 fn from_str(src: &str) -> Result<Self, LexError> {
1547 match bridge::client::FreeFunctions::literal_from_str(src) {
1548 Ok(literal) => Ok(Literal(literal)),
1549 Err(()) => Err(LexError),
1550 }
1551 }
1552}
1553
1554#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1557impl fmt::Display for Literal {
1558 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1559 self.with_stringify_parts(|parts| {
1560 for part in parts {
1561 fmt::Display::fmt(part, f)?;
1562 }
1563 Ok(())
1564 })
1565 }
1566}
1567
1568#[stable(feature = "proc_macro_lib2", since = "1.29.0")]
1569impl fmt::Debug for Literal {
1570 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1571 f.debug_struct("Literal")
1572 .field("kind", &format_args!("{:?}", self.0.kind))
1574 .field("symbol", &self.0.symbol)
1575 .field("suffix", &format_args!("{:?}", self.0.suffix))
1577 .field("span", &self.0.span)
1578 .finish()
1579 }
1580}
1581
1582#[unstable(feature = "proc_macro_tracked_env", issue = "99515")]
1584pub mod tracked_env {
1585 use std::env::{self, VarError};
1586 use std::ffi::OsStr;
1587
1588 #[unstable(feature = "proc_macro_tracked_env", issue = "99515")]
1594 pub fn var<K: AsRef<OsStr> + AsRef<str>>(key: K) -> Result<String, VarError> {
1595 let key: &str = key.as_ref();
1596 let value = crate::bridge::client::FreeFunctions::injected_env_var(key)
1597 .map_or_else(|| env::var(key), Ok);
1598 crate::bridge::client::FreeFunctions::track_env_var(key, value.as_deref().ok());
1599 value
1600 }
1601}
1602
1603#[unstable(feature = "track_path", issue = "99515")]
1605pub mod tracked_path {
1606
1607 #[unstable(feature = "track_path", issue = "99515")]
1611 pub fn path<P: AsRef<str>>(path: P) {
1612 let path: &str = path.as_ref();
1613 crate::bridge::client::FreeFunctions::track_path(path);
1614 }
1615}