blob: 1c4b83455f3e651d94500b570e0e55a317327707 [file] [log] [blame]
Alex Crichtoncbec8ec2017-06-02 13:19:33 -07001use std::ascii;
2use std::fmt;
3use std::iter;
4use std::ops;
5use std::str::FromStr;
6
7use proc_macro;
8
Alex Crichton1a7f7622017-07-05 17:47:15 -07009use {TokenTree, TokenNode, Delimiter, Spacing};
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070010
11#[derive(Clone)]
12pub struct TokenStream(proc_macro::TokenStream);
13
14pub struct LexError(proc_macro::LexError);
15
16impl TokenStream {
17 pub fn empty() -> TokenStream {
18 TokenStream(proc_macro::TokenStream::empty())
19 }
20
21 pub fn is_empty(&self) -> bool {
22 self.0.is_empty()
23 }
24}
25
26impl FromStr for TokenStream {
27 type Err = LexError;
28
29 fn from_str(src: &str) -> Result<TokenStream, LexError> {
30 Ok(TokenStream(src.parse().map_err(LexError)?))
31 }
32}
33
34impl fmt::Display for TokenStream {
35 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
36 self.0.fmt(f)
37 }
38}
39
40impl From<proc_macro::TokenStream> for TokenStream {
41 fn from(inner: proc_macro::TokenStream) -> TokenStream {
42 TokenStream(inner)
43 }
44}
45
46impl From<TokenStream> for proc_macro::TokenStream {
47 fn from(inner: TokenStream) -> proc_macro::TokenStream {
48 inner.0
49 }
50}
51
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070052impl From<TokenTree> for TokenStream {
53 fn from(tree: TokenTree) -> TokenStream {
54 TokenStream(proc_macro::TokenTree {
55 span: (tree.span.0).0,
56 kind: match tree.kind {
Alex Crichton1a7f7622017-07-05 17:47:15 -070057 TokenNode::Group(delim, s) => {
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070058 let delim = match delim {
59 Delimiter::Parenthesis => proc_macro::Delimiter::Parenthesis,
60 Delimiter::Bracket => proc_macro::Delimiter::Bracket,
61 Delimiter::Brace => proc_macro::Delimiter::Brace,
62 Delimiter::None => proc_macro::Delimiter::None,
63 };
Alex Crichton1a7f7622017-07-05 17:47:15 -070064 proc_macro::TokenNode::Group(delim, (s.0).0)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070065 }
Alex Crichton1a7f7622017-07-05 17:47:15 -070066 TokenNode::Op(ch, kind) => {
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070067 let kind = match kind {
Alex Crichton1a7f7622017-07-05 17:47:15 -070068 Spacing::Joint => proc_macro::Spacing::Joint,
69 Spacing::Alone => proc_macro::Spacing::Alone,
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070070 };
Alex Crichton1a7f7622017-07-05 17:47:15 -070071 proc_macro::TokenNode::Op(ch, kind)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070072 }
Alex Crichton1a7f7622017-07-05 17:47:15 -070073 TokenNode::Term(s) => {
74 proc_macro::TokenNode::Term((s.0).0)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070075 }
Alex Crichton1a7f7622017-07-05 17:47:15 -070076 TokenNode::Literal(l) => {
77 proc_macro::TokenNode::Literal((l.0).0)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070078 }
79 },
80 }.into())
81 }
82}
83
84impl iter::FromIterator<TokenStream> for TokenStream {
85 fn from_iter<I: IntoIterator<Item=TokenStream>>(streams: I) -> Self {
86 let streams = streams.into_iter().map(|s| s.0);
87 TokenStream(streams.collect::<proc_macro::TokenStream>())
88 }
89}
90
91impl fmt::Debug for TokenStream {
92 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
Alex Crichton040be632017-07-05 17:56:48 -070093 self.0.fmt(f)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -070094 }
95}
96
97impl fmt::Debug for LexError {
98 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
Alex Crichton040be632017-07-05 17:56:48 -070099 self.0.fmt(f)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700100 }
101}
102
Alex Crichton1a7f7622017-07-05 17:47:15 -0700103pub struct TokenTreeIter(proc_macro::TokenTreeIter);
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700104
105impl IntoIterator for TokenStream {
106 type Item = TokenTree;
Alex Crichton1a7f7622017-07-05 17:47:15 -0700107 type IntoIter = TokenTreeIter;
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700108
Alex Crichton1a7f7622017-07-05 17:47:15 -0700109 fn into_iter(self) -> TokenTreeIter {
110 TokenTreeIter(self.0.into_iter())
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700111 }
112}
113
Alex Crichton1a7f7622017-07-05 17:47:15 -0700114impl Iterator for TokenTreeIter {
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700115 type Item = TokenTree;
116
117 fn next(&mut self) -> Option<TokenTree> {
118 let token = match self.0.next() {
119 Some(n) => n,
120 None => return None,
121 };
122 Some(TokenTree {
123 span: ::Span(Span(token.span)),
124 kind: match token.kind {
Alex Crichton1a7f7622017-07-05 17:47:15 -0700125 proc_macro::TokenNode::Group(delim, s) => {
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700126 let delim = match delim {
127 proc_macro::Delimiter::Parenthesis => Delimiter::Parenthesis,
128 proc_macro::Delimiter::Bracket => Delimiter::Bracket,
129 proc_macro::Delimiter::Brace => Delimiter::Brace,
130 proc_macro::Delimiter::None => Delimiter::None,
131 };
Alex Crichton1a7f7622017-07-05 17:47:15 -0700132 TokenNode::Group(delim, ::TokenStream(TokenStream(s)))
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700133 }
Alex Crichton1a7f7622017-07-05 17:47:15 -0700134 proc_macro::TokenNode::Op(ch, kind) => {
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700135 let kind = match kind {
Alex Crichton1a7f7622017-07-05 17:47:15 -0700136 proc_macro::Spacing::Joint => Spacing::Joint,
137 proc_macro::Spacing::Alone => Spacing::Alone,
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700138 };
Alex Crichton1a7f7622017-07-05 17:47:15 -0700139 TokenNode::Op(ch, kind)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700140 }
Alex Crichton1a7f7622017-07-05 17:47:15 -0700141 proc_macro::TokenNode::Term(s) => {
142 TokenNode::Term(::Term(Term(s)))
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700143 }
Alex Crichton1a7f7622017-07-05 17:47:15 -0700144 proc_macro::TokenNode::Literal(l) => {
145 TokenNode::Literal(::Literal(Literal(l)))
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700146 }
147 },
148 })
149 }
150
151 fn size_hint(&self) -> (usize, Option<usize>) {
152 self.0.size_hint()
153 }
154}
155
Alex Crichton1a7f7622017-07-05 17:47:15 -0700156impl fmt::Debug for TokenTreeIter {
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700157 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
Alex Crichton1a7f7622017-07-05 17:47:15 -0700158 f.debug_struct("TokenTreeIter").finish()
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700159 }
160}
161
David Tolnay1ebe3972018-01-02 20:14:20 -0800162#[cfg(procmacro2_semver_exempt)]
Nika Layzellf8d5f212017-12-11 14:07:02 -0500163#[derive(Clone, PartialEq, Eq)]
Nika Layzellb35a9a32017-12-30 14:34:35 -0500164pub struct FileName(String);
165
David Tolnay1ebe3972018-01-02 20:14:20 -0800166#[cfg(procmacro2_semver_exempt)]
Nika Layzellb35a9a32017-12-30 14:34:35 -0500167impl fmt::Display for FileName {
168 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
169 self.0.fmt(f)
170 }
171}
172
173// NOTE: We have to generate our own filename object here because we can't wrap
174// the one provided by proc_macro.
David Tolnay1ebe3972018-01-02 20:14:20 -0800175#[cfg(procmacro2_semver_exempt)]
Nika Layzellb35a9a32017-12-30 14:34:35 -0500176#[derive(Clone, PartialEq, Eq)]
177pub struct SourceFile(proc_macro::SourceFile, FileName);
Nika Layzellf8d5f212017-12-11 14:07:02 -0500178
David Tolnay1ebe3972018-01-02 20:14:20 -0800179#[cfg(procmacro2_semver_exempt)]
Nika Layzellf8d5f212017-12-11 14:07:02 -0500180impl SourceFile {
Nika Layzellb35a9a32017-12-30 14:34:35 -0500181 fn new(sf: proc_macro::SourceFile) -> Self {
182 let filename = FileName(sf.path().to_string());
183 SourceFile(sf, filename)
184 }
185
Nika Layzellf8d5f212017-12-11 14:07:02 -0500186 /// Get the path to this source file as a string.
Nika Layzellb35a9a32017-12-30 14:34:35 -0500187 pub fn path(&self) -> &FileName {
188 &self.1
Nika Layzellf8d5f212017-12-11 14:07:02 -0500189 }
190
191 pub fn is_real(&self) -> bool {
192 self.0.is_real()
193 }
194}
195
David Tolnay1ebe3972018-01-02 20:14:20 -0800196#[cfg(procmacro2_semver_exempt)]
Nika Layzellb35a9a32017-12-30 14:34:35 -0500197impl AsRef<FileName> for SourceFile {
198 fn as_ref(&self) -> &FileName {
199 self.path()
Nika Layzellf8d5f212017-12-11 14:07:02 -0500200 }
201}
202
David Tolnay1ebe3972018-01-02 20:14:20 -0800203#[cfg(procmacro2_semver_exempt)]
Nika Layzellf8d5f212017-12-11 14:07:02 -0500204impl fmt::Debug for SourceFile {
205 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
206 self.0.fmt(f)
207 }
208}
209
David Tolnay1ebe3972018-01-02 20:14:20 -0800210#[cfg(procmacro2_semver_exempt)]
Nika Layzell1ecb6ce2017-12-30 14:34:05 -0500211pub struct LineColumn {
212 pub line: usize,
213 pub column: usize,
214}
Nika Layzellf8d5f212017-12-11 14:07:02 -0500215
Alex Crichton998f6422017-11-19 08:06:27 -0800216#[derive(Copy, Clone)]
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700217pub struct Span(proc_macro::Span);
218
219impl Span {
220 pub fn call_site() -> Span {
221 Span(proc_macro::Span::call_site())
222 }
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700223
Alex Crichtone6085b72017-11-21 07:24:25 -0800224 pub fn def_site() -> Span {
Alex Crichton998f6422017-11-19 08:06:27 -0800225 Span(proc_macro::Span::def_site())
226 }
Nika Layzellf8d5f212017-12-11 14:07:02 -0500227
David Tolnay4e8e3972018-01-05 18:10:22 -0800228 pub fn resolved_at(&self, other: Span) -> Span {
229 Span(self.0.resolved_at(other.0))
230 }
231
232 pub fn located_at(&self, other: Span) -> Span {
233 Span(self.0.located_at(other.0))
234 }
235
David Tolnay16a17202017-12-31 10:47:24 -0500236 pub fn unstable(self) -> proc_macro::Span {
237 self.0
238 }
239
David Tolnay1ebe3972018-01-02 20:14:20 -0800240 #[cfg(procmacro2_semver_exempt)]
Nika Layzellf8d5f212017-12-11 14:07:02 -0500241 pub fn source_file(&self) -> SourceFile {
Nika Layzellb35a9a32017-12-30 14:34:35 -0500242 SourceFile::new(self.0.source_file())
Nika Layzellf8d5f212017-12-11 14:07:02 -0500243 }
244
David Tolnay1ebe3972018-01-02 20:14:20 -0800245 #[cfg(procmacro2_semver_exempt)]
Nika Layzellf8d5f212017-12-11 14:07:02 -0500246 pub fn start(&self) -> LineColumn {
Nika Layzell1ecb6ce2017-12-30 14:34:05 -0500247 let proc_macro::LineColumn{ line, column } = self.0.start();
248 LineColumn { line, column }
Nika Layzellf8d5f212017-12-11 14:07:02 -0500249 }
250
David Tolnay1ebe3972018-01-02 20:14:20 -0800251 #[cfg(procmacro2_semver_exempt)]
Nika Layzellf8d5f212017-12-11 14:07:02 -0500252 pub fn end(&self) -> LineColumn {
Nika Layzell1ecb6ce2017-12-30 14:34:05 -0500253 let proc_macro::LineColumn{ line, column } = self.0.end();
254 LineColumn { line, column }
Nika Layzellf8d5f212017-12-11 14:07:02 -0500255 }
256
David Tolnay1ebe3972018-01-02 20:14:20 -0800257 #[cfg(procmacro2_semver_exempt)]
Nika Layzellf8d5f212017-12-11 14:07:02 -0500258 pub fn join(&self, other: Span) -> Option<Span> {
259 self.0.join(other.0).map(Span)
260 }
Alex Crichton998f6422017-11-19 08:06:27 -0800261}
262
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700263impl fmt::Debug for Span {
264 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
Alex Crichton040be632017-07-05 17:56:48 -0700265 self.0.fmt(f)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700266 }
267}
268
269#[derive(Copy, Clone)]
Alex Crichton1a7f7622017-07-05 17:47:15 -0700270pub struct Term(proc_macro::Term);
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700271
Alex Crichton1a7f7622017-07-05 17:47:15 -0700272impl<'a> From<&'a str> for Term {
273 fn from(string: &'a str) -> Term {
274 Term(proc_macro::Term::intern(string))
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700275 }
276}
277
Alex Crichton1a7f7622017-07-05 17:47:15 -0700278impl ops::Deref for Term {
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700279 type Target = str;
280
281 fn deref(&self) -> &str {
Alex Crichton1a7f7622017-07-05 17:47:15 -0700282 self.0.as_str()
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700283 }
284}
285
Alex Crichton1a7f7622017-07-05 17:47:15 -0700286impl fmt::Debug for Term {
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700287 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
Alex Crichton040be632017-07-05 17:56:48 -0700288 self.0.fmt(f)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700289 }
290}
291
292#[derive(Clone)]
293pub struct Literal(proc_macro::Literal);
294
295impl Literal {
296 pub fn byte_char(byte: u8) -> Literal {
297 match byte {
298 0 => Literal(to_literal("b'\\0'")),
299 b'\"' => Literal(to_literal("b'\"'")),
300 n => {
301 let mut escaped = "b'".to_string();
302 escaped.extend(ascii::escape_default(n).map(|c| c as char));
303 escaped.push('\'');
304 Literal(to_literal(&escaped))
305 }
306 }
307 }
308
309 pub fn byte_string(bytes: &[u8]) -> Literal {
Alex Crichton040be632017-07-05 17:56:48 -0700310 Literal(proc_macro::Literal::byte_string(bytes))
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700311 }
312
313 pub fn doccomment(s: &str) -> Literal {
314 Literal(to_literal(s))
315 }
316
Alex Crichton1a7f7622017-07-05 17:47:15 -0700317 pub fn float(s: f64) -> Literal {
Alex Crichton040be632017-07-05 17:56:48 -0700318 Literal(proc_macro::Literal::float(s))
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700319 }
320
Alex Crichton1a7f7622017-07-05 17:47:15 -0700321 pub fn integer(s: i64) -> Literal {
Alex Crichton040be632017-07-05 17:56:48 -0700322 Literal(proc_macro::Literal::integer(s.into()))
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700323 }
324
325 pub fn raw_string(s: &str, pounds: usize) -> Literal {
326 let mut ret = format!("r");
327 ret.extend((0..pounds).map(|_| "#"));
328 ret.push('"');
329 ret.push_str(s);
330 ret.push('"');
331 ret.extend((0..pounds).map(|_| "#"));
332 Literal(to_literal(&ret))
333 }
334
335 pub fn raw_byte_string(s: &str, pounds: usize) -> Literal {
336 let mut ret = format!("br");
337 ret.extend((0..pounds).map(|_| "#"));
338 ret.push('"');
339 ret.push_str(s);
340 ret.push('"');
341 ret.extend((0..pounds).map(|_| "#"));
342 Literal(to_literal(&ret))
343 }
344}
345
346impl fmt::Display for Literal {
347 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
348 self.0.fmt(f)
349 }
350}
351
352impl fmt::Debug for Literal {
353 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
Alex Crichton040be632017-07-05 17:56:48 -0700354 self.0.fmt(f)
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700355 }
356}
357
358fn to_literal(s: &str) -> proc_macro::Literal {
359 let stream = s.parse::<proc_macro::TokenStream>().unwrap();
360 match stream.into_iter().next().unwrap().kind {
Alex Crichton1a7f7622017-07-05 17:47:15 -0700361 proc_macro::TokenNode::Literal(l) => l,
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700362 _ => unreachable!(),
363 }
364}
365
366macro_rules! ints {
Alex Crichton040be632017-07-05 17:56:48 -0700367 ($($t:ident,)*) => {$(
368 impl From<$t> for Literal {
369 fn from(t: $t) -> Literal {
370 Literal(proc_macro::Literal::$t(t))
371 }
372 }
373 )*}
374}
375
376ints! {
Alex Crichton6e81d762017-07-14 06:09:31 -0700377 u8, u16, u32, u64, usize,
378 i8, i16, i32, i64, isize,
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700379}
380
381macro_rules! floats {
382 ($($t:ident,)*) => {$(
383 impl From<$t> for Literal {
384 fn from(t: $t) -> Literal {
Alex Crichton1a7f7622017-07-05 17:47:15 -0700385 Literal(proc_macro::Literal::$t(t))
Alex Crichtoncbec8ec2017-06-02 13:19:33 -0700386 }
387 }
388 )*}
389}
390
391floats! {
392 f32, f64,
393}
394
395impl<'a> From<&'a str> for Literal {
396 fn from(t: &'a str) -> Literal {
397 Literal(proc_macro::Literal::string(t))
398 }
399}
400
401impl From<char> for Literal {
402 fn from(t: char) -> Literal {
403 Literal(proc_macro::Literal::character(t))
404 }
405}