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
pub mod utils;

/// Execute a callback after removing unnamed segments.
#[macro_export]
macro_rules! clean_and_callback {
    (@internal $callback:ident [] [] [$($query:tt)*]) => {
        $callback($($query),*)
    };

    (@internal $callback:ident [$($acc:tt)+] [] [$($query:tt)*]) => {{
        $callback($($acc),+ $(, $query)*)
    }};

    (@internal $callback:ident [$($acc:tt)*] [($name:tt : $type:ty) $($tail:tt)*] [$($query:tt)*]) => {
        clean_and_callback!(@internal $callback [$($acc)* $name] [$($tail)*] [$($query)*])
    };

    (@internal $callback:ident [$($acc:tt)*] [$name:tt $($tail:tt)*] [$($query:tt)*]) => {
        clean_and_callback!(@internal $callback [$($acc)*] [$($tail)*] [$($query)*])
    };
    
    ($callback:ident [$($segment:tt)*] [$($query:tt)*]) => {
        clean_and_callback!(@internal $callback [] [$($segment)*] [$($query)*])
    }
}

#[macro_export]
/// Build a route from a pattern and a callback.
///
/// `route!(pattern => callback)` is a function from `&str` to `Option<T>`. The input represents a
/// URL's path and query string. If the input matches the pattern, its segments and query
/// parameters can be captured and exposed as parameters of the callback.
///
/// A pattern is defined with the following grammar:
///
/// ```
/// pattern := path | path ? query_string
/// path := root | root some_segments
/// root := /
/// some_segments := segment | segment / some_segments
/// segment := ident | (ident: type)
/// query_string := query | query & query_string
/// query := ident | (ident: type)
/// ```
///
/// The callback is a function from captured segments and query parameters to `T`. Captured
/// segments are passed to the callback. All query parameters are captured.  Query parameters
/// without type annotation are passed as `Option<()>`, query parameters with type annotation are
/// passed as `Option<U>`. Any type `U` can be captured as long as they implement the `FromStr`
/// trait.
///
/// Examples:
///
/// - Matches "/[?query_string]", captures nothing and calls `callback()`:
///
/// ```
/// route!(/ => callback)
/// ```
///
/// - Matches "/help[?query_string]", captures nothing and calls `callback()`:
///
/// ```
/// route!(/help => callback)
/// ```
///
/// - Matches "/sum/<a: u32>/<b: u32>[?query_string]", captures `a` and `b` as `u32`s and calls
/// `callback(a: u32, b: u32)`:
///
/// ```
/// route!(/sum/(a: u32)/(b: u32) => callback)
/// ```
///
/// - Matches "/maps/<lon: f64>/<lat: f64>?show_marker&color=<Color>", captures `lon` and `lat` as
/// `f64`s, `show_marker` as `Option<()>` and `color` as `Option<Color>`, and calls `callback(lon:
/// f64, lat: f64, show_marker: Option<()>, color: Option<Color>)`:
///
/// ```
/// route!(/maps/(lon: f64)/(lat: f64)?show_marker&(color: Color) => callback)
/// ```

macro_rules! route {
    (/ => $callback:ident) => {|uri: &str|
        route!(@try $callback [] [] uri)
    };

    (/?$($expected_query:tt)+ => $callback:ident) => {|uri: &str|
        route!(@try $callback [] [$($expected_query)*] uri)
    };

    (/$($expected_segment:tt)/+ => $callback:ident) => {|uri: &str| {
        route!(@try $callback [$($expected_segment)*] [] uri)
    }};

    (/$($expected_segment:tt)/+?$($expected_query:tt)&+ => $callback: ident) => {|uri: &str| {
        route!(@try $callback [$($expected_segment)*] [$($expected_query)*] uri)
    }};

    (@try $callback:ident [$($expected_segment:tt)*] [$($expected_query:tt)*] $uri:ident) => {{
        let path_query: Vec<&str> = $uri.splitn(2, '?').collect();
        path_query.get(0).and_then(|path| {
            let query_string = path_query.get(1).unwrap_or(&"");

            let segments = route!(@parse_segments [$($expected_segment)*] path);
            let queries = route!(@parse_queries [$($expected_query)*] query_string);

            match (segments, queries) {
                (($(Some(route!(@segment_pattern $expected_segment)),)* true,), ($(route!(@query_name $expected_query),)*)) => { 
                    Some(clean_and_callback!($callback [$( $expected_segment )*] [$( (route!(@query_name $expected_query)) )*]))
                },
                _ => None
            }
        })
    }};

    (@parse_segments [$($expected_segment:tt)*] $path:ident) => {{
        let segments: Vec<&str> = $path.split_terminator('/').collect();
        let mut segments_iter = segments.iter().skip(1);

        // Tuple of parsed values. Set the last element of the tuple to a boolean that indicates
        // that all the segments have been handled.
        ($({
            segments_iter.next().and_then(|&segment| {
                route!(@parse_segment $expected_segment segment)
            })
        },)* segments_iter.next().is_none(),)
    }};

    (@parse_segment ($name:tt : $type:ty) $data:expr) => {{
        percent_decode($data).and_then(|segment| segment.parse::<$type>().ok())
    }};

    (@parse_segment $name:tt $data:ident) => {{
        match $data { 
            stringify!($name) => Some(()),
            _ => None
        }
    }};

    (@segment_pattern ($name:tt : $type:ty)) => { $name };
    (@segment_pattern $name:tt) => { _ };

    (@parse_queries [$($expected_query:tt)*] $query_string:ident) => {{
        let queries: Vec<&str> = $query_string.split('&').collect();
        
        let mut key_values: ($(Option<route!(@query_type $expected_query)>,)*) = Default::default();

        for query in queries {
            if query.is_empty() {
                continue;
            }
            let ($(route!(@query_name $expected_query),)*) = key_values;
            key_values = ($(
                    route!(@query_name $expected_query).or(route!(@parse_query $expected_query query))
            ,)*);
        }

        key_values
    }};

    (@query_name ($name:tt : $type:ty)) => { $name };
    (@query_name $name:tt) => { $name };

    (@query_type ($name:tt : $type:ty)) => { $type };
    (@query_type $name:tt) => { () };

    (@parse_query ($name:tt : $type:ty) $data:ident) => {{
        let key_value: Vec<&str> = $data.splitn(2, '=').collect();
        match key_value.get(0) {
            Some(&stringify!($name)) => key_value.get(1).and_then(|value| value.parse::<$type>().ok()),
            _ => None
        }
    }};

    (@parse_query $name:tt $data:ident) => {
        match $data {
            stringify!($name) => Some(()),
            _ => None
        }
    }
}

#[macro_export]
/// Compose a router given an URI and a list of routes.
///
/// `route_with![route!(...), route!(...), route!(...)]` is a function from `&str` to `Option<T>`.
/// It will try to match each route sequentially and return the result of the first match.
/// Otherwise it will return `None`.
macro_rules! route_with {
    [$($route:expr),*] => {|uri| {
        None$(.or($route(uri)))*
    }}
}

#[cfg(test)]
mod tests {
    use utils::percent_decode;

    #[test]
    fn router() {
        
        let router = route_with![ route!(/ => default)
                                , route!(/double/(value: u32) => double)
                                , route!(/triple_add_decrement/(value: u32)?(add: u32)&decrement => triple_add_decrement)
                                , route!(/count/spaces/(data: String) => count_spaces)
                                ];

        assert_eq!(router(""), Some(1));
        assert_eq!(router("?"), Some(1));
        assert_eq!(router("/"), Some(1));
        assert_eq!(router("/?"), Some(1));
        assert_eq!(router("/?useless_stuff"), Some(1));
        assert_eq!(router("/foo"), None);

        assert_eq!(router("//"), None);

        assert_eq!(router("/double/16"), Some(32));
        assert_eq!(router("/double/wat"), None);
        assert_eq!(router("/double/16?"), Some(32));
        assert_eq!(router("/double/10?the_number=666&useless_stuff"), Some(20));

        assert_eq!(router("/triple_add_decrement/2"), Some(6));
        assert_eq!(router("/triple_add_decrement/2?"), Some(6));
        assert_eq!(router("/triple_add_decrement/2?add=4"), Some(10));
        assert_eq!(router("/triple_add_decrement/2?add=4&decrement"), Some(9));

        assert_eq!(router("/count/spaces/Church is%20Great and%20Barendregt is his Prophet%21"), Some(7));
        assert_eq!(router("/count/spaces/invalid%"), None);
    }

    fn default() -> u32 {
        1
    }

    fn double(value: u32) -> u32 {
        value * 2
    }

    fn triple_add_decrement(value: u32, add: Option<u32>, decrement: Option<()>) -> u32 {
        value * 3 + add.unwrap_or(0) - decrement.map(|_| 1).unwrap_or(0)
    }

    fn count_spaces(data: String) -> u32 {
        data.chars().filter(|&c| c == ' ').count() as u32
    }
}