David Tolnay | b79ee96 | 2016-09-04 09:39:20 -0700 | [diff] [blame] | 1 | use super::*; |
| 2 | |
David Tolnay | aed77b0 | 2016-09-23 20:50:31 -0700 | [diff] [blame] | 3 | /// Doc-comments are promoted to attributes that have `is_sugared_doc` = true |
David Tolnay | b79ee96 | 2016-09-04 09:39:20 -0700 | [diff] [blame] | 4 | #[derive(Debug, Clone, Eq, PartialEq)] |
| 5 | pub struct Attribute { |
| 6 | pub value: MetaItem, |
| 7 | pub is_sugared_doc: bool, |
| 8 | } |
| 9 | |
| 10 | /// A compile-time attribute item. |
| 11 | /// |
| 12 | /// E.g. `#[test]`, `#[derive(..)]` or `#[feature = "foo"]` |
| 13 | #[derive(Debug, Clone, Eq, PartialEq)] |
| 14 | pub enum MetaItem { |
| 15 | /// Word meta item. |
| 16 | /// |
| 17 | /// E.g. `test` as in `#[test]` |
| 18 | Word(Ident), |
| 19 | /// List meta item. |
| 20 | /// |
| 21 | /// E.g. `derive(..)` as in `#[derive(..)]` |
| 22 | List(Ident, Vec<MetaItem>), |
| 23 | /// Name value meta item. |
| 24 | /// |
| 25 | /// E.g. `feature = "foo"` as in `#[feature = "foo"]` |
David Tolnay | f4bbbd9 | 2016-09-23 14:41:55 -0700 | [diff] [blame] | 26 | NameValue(Ident, Lit), |
David Tolnay | b79ee96 | 2016-09-04 09:39:20 -0700 | [diff] [blame] | 27 | } |
| 28 | |
David Tolnay | 8e661e2 | 2016-09-27 00:00:04 -0700 | [diff] [blame^] | 29 | impl MetaItem { |
| 30 | pub fn name(&self) -> &str { |
| 31 | match *self { |
| 32 | MetaItem::Word(ref name) => name.as_ref(), |
| 33 | MetaItem::List(ref name, _) => name.as_ref(), |
| 34 | MetaItem::NameValue(ref name, _) => name.as_ref(), |
| 35 | } |
| 36 | } |
| 37 | } |
| 38 | |
David Tolnay | 86eca75 | 2016-09-04 11:26:41 -0700 | [diff] [blame] | 39 | #[cfg(feature = "parsing")] |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 40 | pub mod parsing { |
| 41 | use super::*; |
David Tolnay | 5533772 | 2016-09-11 12:58:56 -0700 | [diff] [blame] | 42 | use ident::parsing::ident; |
David Tolnay | f4bbbd9 | 2016-09-23 14:41:55 -0700 | [diff] [blame] | 43 | use lit::{Lit, StrStyle}; |
| 44 | use lit::parsing::lit; |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 45 | use nom::multispace; |
David Tolnay | b79ee96 | 2016-09-04 09:39:20 -0700 | [diff] [blame] | 46 | |
David Tolnay | b5a7b14 | 2016-09-13 22:46:39 -0700 | [diff] [blame] | 47 | named!(pub attribute -> Attribute, alt!( |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 48 | do_parse!( |
| 49 | punct!("#") >> |
| 50 | punct!("[") >> |
| 51 | meta_item: meta_item >> |
| 52 | punct!("]") >> |
| 53 | (Attribute { |
| 54 | value: meta_item, |
| 55 | is_sugared_doc: false, |
| 56 | }) |
| 57 | ) |
| 58 | | |
| 59 | do_parse!( |
| 60 | punct!("///") >> |
| 61 | space: multispace >> |
David Tolnay | b5a7b14 | 2016-09-13 22:46:39 -0700 | [diff] [blame] | 62 | content: take_until!("\n") >> |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 63 | (Attribute { |
| 64 | value: MetaItem::NameValue( |
David Tolnay | 42f5029 | 2016-09-04 13:54:21 -0700 | [diff] [blame] | 65 | "doc".into(), |
David Tolnay | f4bbbd9 | 2016-09-23 14:41:55 -0700 | [diff] [blame] | 66 | Lit::Str( |
| 67 | format!("///{}{}", space, content), |
| 68 | StrStyle::Cooked, |
| 69 | ), |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 70 | ), |
| 71 | is_sugared_doc: true, |
| 72 | }) |
| 73 | ) |
| 74 | )); |
David Tolnay | b79ee96 | 2016-09-04 09:39:20 -0700 | [diff] [blame] | 75 | |
David Tolnay | b5a7b14 | 2016-09-13 22:46:39 -0700 | [diff] [blame] | 76 | named!(meta_item -> MetaItem, alt!( |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 77 | do_parse!( |
David Tolnay | 5533772 | 2016-09-11 12:58:56 -0700 | [diff] [blame] | 78 | id: ident >> |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 79 | punct!("(") >> |
| 80 | inner: separated_list!(punct!(","), meta_item) >> |
| 81 | punct!(")") >> |
David Tolnay | 5533772 | 2016-09-11 12:58:56 -0700 | [diff] [blame] | 82 | (MetaItem::List(id, inner)) |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 83 | ) |
| 84 | | |
| 85 | do_parse!( |
David Tolnay | f4bbbd9 | 2016-09-23 14:41:55 -0700 | [diff] [blame] | 86 | name: ident >> |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 87 | punct!("=") >> |
David Tolnay | f4bbbd9 | 2016-09-23 14:41:55 -0700 | [diff] [blame] | 88 | value: lit >> |
| 89 | (MetaItem::NameValue(name, value)) |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 90 | ) |
| 91 | | |
David Tolnay | 5533772 | 2016-09-11 12:58:56 -0700 | [diff] [blame] | 92 | map!(ident, MetaItem::Word) |
David Tolnay | 9d8f197 | 2016-09-04 11:58:48 -0700 | [diff] [blame] | 93 | )); |
| 94 | } |
David Tolnay | 87d0b44 | 2016-09-04 11:52:12 -0700 | [diff] [blame] | 95 | |
| 96 | #[cfg(feature = "printing")] |
| 97 | mod printing { |
| 98 | use super::*; |
| 99 | use quote::{Tokens, ToTokens}; |
| 100 | |
| 101 | impl ToTokens for Attribute { |
| 102 | fn to_tokens(&self, tokens: &mut Tokens) { |
David Tolnay | fbef234 | 2016-09-04 14:42:34 -0700 | [diff] [blame] | 103 | tokens.append("#"); |
| 104 | tokens.append("["); |
David Tolnay | 87d0b44 | 2016-09-04 11:52:12 -0700 | [diff] [blame] | 105 | self.value.to_tokens(tokens); |
| 106 | tokens.append("]"); |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | impl ToTokens for MetaItem { |
| 111 | fn to_tokens(&self, tokens: &mut Tokens) { |
| 112 | match *self { |
David Tolnay | 2646907 | 2016-09-04 13:59:48 -0700 | [diff] [blame] | 113 | MetaItem::Word(ref ident) => { |
| 114 | ident.to_tokens(tokens); |
| 115 | } |
David Tolnay | 87d0b44 | 2016-09-04 11:52:12 -0700 | [diff] [blame] | 116 | MetaItem::List(ref ident, ref inner) => { |
David Tolnay | 2646907 | 2016-09-04 13:59:48 -0700 | [diff] [blame] | 117 | ident.to_tokens(tokens); |
David Tolnay | 87d0b44 | 2016-09-04 11:52:12 -0700 | [diff] [blame] | 118 | tokens.append("("); |
David Tolnay | 94ebdf9 | 2016-09-04 13:33:16 -0700 | [diff] [blame] | 119 | tokens.append_separated(inner, ","); |
David Tolnay | 87d0b44 | 2016-09-04 11:52:12 -0700 | [diff] [blame] | 120 | tokens.append(")"); |
| 121 | } |
| 122 | MetaItem::NameValue(ref name, ref value) => { |
David Tolnay | 2646907 | 2016-09-04 13:59:48 -0700 | [diff] [blame] | 123 | name.to_tokens(tokens); |
David Tolnay | 87d0b44 | 2016-09-04 11:52:12 -0700 | [diff] [blame] | 124 | tokens.append("="); |
| 125 | value.to_tokens(tokens); |
| 126 | } |
| 127 | } |
| 128 | } |
| 129 | } |
| 130 | } |