aboutsummaryrefslogtreecommitdiff
path: root/src/spanned.rs
blob: 1673d66a0474762a388465d43651f29188dc7ac3 (plain)
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
//! ```
//! #[macro_use]
//! extern crate serde_derive;
//!
//! extern crate toml;
//! use toml::spanned::Spanned;
//!
//! #[derive(Deserialize)]
//! struct Value {
//!     s: Spanned<String>,
//! }
//!
//! fn main() {
//!     let t = "s = \"value\"\n";
//!
//!     let u: Value = toml::from_str(t).unwrap();
//!
//!     assert_eq!(u.s.start, 4);
//!     assert_eq!(u.s.end, 11);
//! }
//! ```

use serde::{de, ser};
use std::fmt;

#[doc(hidden)]
pub const NAME: &'static str = "$__toml_private_Spanned";
#[doc(hidden)]
pub const START: &'static str = "$__toml_private_start";
#[doc(hidden)]
pub const END: &'static str = "$__toml_private_end";
#[doc(hidden)]
pub const VALUE: &'static str = "$__toml_private_value";

macro_rules! key_deserialize {
    ($ident:ident, $field:expr, $name:expr) => {
        struct $ident;

        impl<'de> de::Deserialize<'de> for $ident {
            fn deserialize<D>(deserializer: D) -> Result<$ident, D::Error>
                where D: de::Deserializer<'de>
            {
                struct FieldVisitor;

                impl<'de> de::Visitor<'de> for FieldVisitor {
                    type Value = ();

                    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                        formatter.write_str("a valid spanned field")
                    }

                    fn visit_str<E>(self, s: &str) -> Result<(), E>
                        where E: de::Error
                    {
                        if s == $field {
                            Ok(())
                        } else {
                            Err(de::Error::custom(
                                concat!("expected spanned field `", $name, "`")))
                        }
                    }
                }

                deserializer.deserialize_identifier(FieldVisitor)?;
                Ok($ident)
            }
        }
    }
}


/// A spanned value, indicating the range at which it is defined in the source.
#[derive(Debug)]
pub struct Spanned<T> {
    /// The start range.
    pub start: usize,
    /// The end range (exclusive).
    pub end: usize,
    /// The spanned value.
    pub value: T,
}

impl<'de, T> de::Deserialize<'de> for Spanned<T>
    where T: de::Deserialize<'de>
{
    fn deserialize<D>(deserializer: D) -> Result<Spanned<T>, D::Error>
        where D: de::Deserializer<'de>
    {
        struct SpannedVisitor<T>(::std::marker::PhantomData<T>);

        impl<'de, T> de::Visitor<'de> for SpannedVisitor<T>
            where T: de::Deserialize<'de>
        {
            type Value = Spanned<T>;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("a TOML spanned")
            }

            fn visit_map<V>(self, mut visitor: V) -> Result<Spanned<T>, V::Error>
                where V: de::MapAccess<'de>
            {
                let start = visitor.next_key::<StartKey>()?;

                if start.is_none() {
                    return Err(de::Error::custom("spanned start key not found"))
                }

                let start: usize = visitor.next_value()?;

                let end = visitor.next_key::<EndKey>()?;

                if end.is_none() {
                    return Err(de::Error::custom("spanned end key not found"))
                }

                let end: usize = visitor.next_value()?;

                let value = visitor.next_key::<ValueKey>()?;

                if value.is_none() {
                    return Err(de::Error::custom("spanned value key not found"))
                }

                let value: T = visitor.next_value()?;

                Ok(Spanned {
                    start: start,
                    end: end,
                    value: value
                })
            }
        }

        key_deserialize!(StartKey, START, "start");
        key_deserialize!(EndKey, END, "end");
        key_deserialize!(ValueKey, VALUE, "value");

        let visitor = SpannedVisitor(::std::marker::PhantomData);

        static FIELDS: [&'static str; 3] = [START, END, VALUE];
        deserializer.deserialize_struct(NAME, &FIELDS, visitor)
    }
}

impl<T: ser::Serialize> ser::Serialize for Spanned<T> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: ser::Serializer,
    {
        self.value.serialize(serializer)
    }
}