bitfield 0.0.6

A procedural macro to generate bitfield-like stuct
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
#![crate_type="dylib"]
#![feature(plugin_registrar, rustc_private, quote)]

extern crate syntax;
extern crate rustc;
extern crate rustc_plugin;

use rustc_plugin::Registry;
use syntax::ast;
use syntax::ast::Attribute;
use syntax::codemap::{DUMMY_SP, Span};
use syntax::ext::base::{ExtCtxt, MacEager, MacResult};
use syntax::ext::build::AstBuilder;
use syntax::ext::quote::rt::ToTokens;
use syntax::parse::common::SeqSep;
use syntax::parse::parser::Parser;
use syntax::parse::token;
use syntax::parse::token::keywords;
use syntax::ptr::P;
use syntax::util::small_vector::SmallVector;


enum Field {
    Array {
        name: String,
        count: usize,
        element_length: u8,
        is_pub: bool,
        attrs: Vec<Attribute>,
    },
    Scalar {
        name: String,
        length: u8,
        is_pub: bool,
        attrs: Vec<Attribute>,
    },
}


impl Field {
    fn bit_len(&self) -> u64 {
        match *self {
            Field::Array { count, element_length, .. } => {
                (count as u64) * element_length as u64
            }
            Field::Scalar { length, .. } => length as u64,
        }
    }

    fn gen_single_value_get_expr(cx: &mut ExtCtxt,
                                 value_type: &P<ast::Ty>,
                                 start: u64,
                                 length: u8)
                                 -> P<ast::Expr> {
        if length == 1 {
            let byte_shift = (7 - start % 8) as usize;
            quote_expr!(cx, (self.data[($start/8) as usize] & (0x1 << $byte_shift)) != 0)
        } else {
            let mut value_expr = None;
            let mut bits_to_get = length;
            let mut bit_offset = start;
            while bits_to_get > 0 {
                let can_get = std::cmp::min(bits_to_get, 8 - (bit_offset % 8) as u8);
                let index = (bit_offset / 8) as usize;
                let mask = 0xFFu8 >> (8 - can_get) as usize;
                let byte_shift = (8 - can_get - (bit_offset % 8) as u8) as usize;
                let bits_expr =
                    quote_expr!(cx, ((self.data[$index] >> $byte_shift) & $mask) as $value_type);

                value_expr = match value_expr {
                    Some(expr) => {
                        let shifted = cx.expr_binary(DUMMY_SP,
                                                     ast::BinOpKind::Shl,
                                                     expr,
                                                     cx.expr_usize(DUMMY_SP, can_get as usize));
                        Some(cx.expr_binary(DUMMY_SP, ast::BinOpKind::BitOr, shifted, bits_expr))
                    }
                    None => Some(bits_expr),
                };
                bits_to_get -= can_get;
                bit_offset += can_get as u64;
            }
            value_expr.unwrap()
        }
    }

    fn gen_single_value_set_stmt(cx: &mut ExtCtxt,
                                 type_length: u8,
                                 start: u64,
                                 length: u8)
                                 -> P<ast::Stmt> {
        if length == 1 {
            let mask = 0x1u8 << (7 - start % 8) as usize;
            let index = (start / 8) as usize;
            P(quote_stmt!(cx,
                          if value {self.data[$index] |= $mask
                          } else {self.data[$index] &= !($mask)
                          })
                  .unwrap())
        } else {
            let mut stmts = Vec::new();
            let mut bits_to_set = length;
            let mut bit_offset = start;

            let mut value_shift = (start % 8) as isize - (type_length - length) as isize +
                                  8 * (type_length / 8 - 1) as isize;

            while bits_to_set > 0 {
                let can_set = std::cmp::min(bits_to_set, 8 - (bit_offset % 8) as u8);
                let index = (bit_offset / 8) as usize;

                // only bits set to 1 in the mask are modified
                let mask = (0xFFu8 >> (8 - can_set as usize)) <<
                           (8 - can_set - (bit_offset % 8) as u8) as usize;

                // positive value of value_shift means we want to shift to the right and
                // negative value means we want shift to the left
                if value_shift > 0 {
                    let value_shift = value_shift as usize;
                    stmts.push(quote_stmt!(cx, self.data[$index] =
                        (self.data[$index] & !$mask) |
                        ((value >> $value_shift) as u8)& $mask)
                                   .unwrap());
                } else {
                    let value_shift = (-value_shift) as usize;
                    stmts.push(quote_stmt!(cx, self.data[$index] =
                        (self.data[$index] & !$mask) |
                        ((value << $value_shift) as u8)& $mask)
                                   .unwrap());
                }

                bits_to_set -= can_set;
                bit_offset += can_set as u64;
                value_shift -= 8;
            }
            let block = cx.block(DUMMY_SP, stmts, None);
            let expr = cx.expr(DUMMY_SP, ast::ExprKind::Block(block));
            P(cx.stmt_expr(expr))
        }
    }

    fn to_methods(&self,
                  cx: &mut ExtCtxt,
                  struct_ident: ast::Ident,
                  start: u64)
                  -> Vec<P<ast::Item>> {
        let mut methods = vec![];

        match *self {
            Field::Array { ref name, count, element_length, is_pub , ref attrs} => {
                let maybe_pub = make_maybe_pub(is_pub);
                let (element_type, value_type_length) = size_to_ty(cx, element_length).unwrap();
                let value_type = make_array_ty(cx, &element_type, count);
                let getter_name = "get_".to_owned() + &name[..];
                let getter_ident = token::str_to_ident(&getter_name[..]);

                let mut element_getter_exprs = Vec::with_capacity(count);
                for i in 0..count {
                    let element_start = start + (i as u64) * (element_length as u64);
                    element_getter_exprs.push(Field::gen_single_value_get_expr(cx,
                                                                               &element_type,
                                                                               element_start,
                                                                               element_length));
                }

                let getter_expr = cx.expr_vec(DUMMY_SP, element_getter_exprs);

                let getter = quote_item!(cx,
                   impl $struct_ident {
                       #[inline]
                       $maybe_pub fn $getter_ident(&self) -> $value_type {
                          $getter_expr
                       }
                   }
                ).unwrap();
                let getter = set_attrs_method(getter, attrs);
                methods.push(getter);

                let setter_name = "set_".to_owned() + &name[..];
                let setter_ident = token::str_to_ident(&setter_name[..]);
                let mut element_setter_stmts = Vec::new();
                for i in 0..count {
                    let element_start = start + (i as u64) * (element_length as u64);
                    let stmt = Field::gen_single_value_set_stmt(cx,
                                                                value_type_length,
                                                                element_start,
                                                                element_length);
                    element_setter_stmts.push(
                        quote_stmt!(cx, { let value = value[$i]; $stmt}).unwrap());
                }



                let block = cx.block(DUMMY_SP, element_setter_stmts, None);
                let expr = cx.expr(DUMMY_SP, ast::ExprKind::Block(block));
                let setter_stmt = cx.stmt_expr(expr);

                let setter = quote_item!(cx,
                   impl $struct_ident {
                       #[inline]
                       $maybe_pub fn $setter_ident(&mut self, value: $value_type) {
                          $setter_stmt
                       }
                   }
                ).unwrap();
                let setter = set_attrs_method(setter, attrs);
                methods.push(setter);

            }
            Field::Scalar { ref name, length, is_pub, ref attrs } => {
                let maybe_pub = make_maybe_pub(is_pub);
                let (value_type, value_type_length) = size_to_ty(cx, length).unwrap();
                let getter_name = "get_".to_owned() + &name[..];
                let getter_ident = token::str_to_ident(&getter_name[..]);
                let getter_expr = Field::gen_single_value_get_expr(cx, &value_type, start, length);
                let getter = quote_item!(cx,
                   impl $struct_ident {
                       #[inline]
                       $maybe_pub fn $getter_ident(&self) -> $value_type {
                          $getter_expr
                       }
                   }
                ).unwrap();
                let getter = set_attrs_method(getter, attrs);
                methods.push(getter);

                let setter_name = "set_".to_owned() + &name[..];
                let setter_ident = token::str_to_ident(&setter_name[..]);
                let setter_stmt = Field::gen_single_value_set_stmt(cx,
                                                                   value_type_length,
                                                                   start,
                                                                   length);
                let setter = quote_item!(cx,
                   impl $struct_ident {
                       #[inline]
                       $maybe_pub fn $setter_ident(&mut self, value: $value_type) {
                          $setter_stmt
                       }
                   }
                ).unwrap();
                let setter = set_attrs_method(setter, attrs);
                methods.push(setter);

            }
        }

        methods
    }
}

/// Return the smaller bool or unsigned int type than can hold an amount of bits. Also return the size
/// of the type in bits.
/// The size for the bool type is not releavant because it is never used.
fn size_to_ty(cx: &mut ExtCtxt, size: u8) -> Option<(P<ast::Ty>, u8)> {
    match size {
        i if i == 0 => None,
        i if i == 1 => Some((quote_ty!(cx, bool), 1)),
        i if i <= 8 => Some((quote_ty!(cx, u8), 8)),
        i if i <= 16 => Some((quote_ty!(cx, u16), 16)),
        i if i <= 32 => Some((quote_ty!(cx, u32), 32)),
        i if i <= 64 => Some((quote_ty!(cx, u64), 64)),
        _ => None,
    }
}

fn make_array_ty(cx: &mut ExtCtxt, elements_type: &P<ast::Ty>, length: usize) -> P<ast::Ty> {
    quote_ty!(cx, [$elements_type; $length])
}

fn make_maybe_pub(is_pub: bool) -> Option<syntax::ast::Ident> {
    if is_pub {
        Some(token::str_to_ident("pub"))
    } else {
        None
    }
}

fn parse_u64(parser: &mut Parser) -> u64 {
    let lit = parser.parse_lit();
    match lit {
        Ok(lit) => {
            match lit.node {
                ast::LitKind::Int(n, _) => n,
                _ => {
                    parser.span_err(lit.span, "unsigned integer literal expected");
                    1
                }
            }
        }
        Err(mut db) => {
            db.emit();
            1
        }
    }
}

macro_rules! expect_token {
    ($parser:expr, $token:expr) => {
        if let Err(mut e) = $parser.expect($token) {
            e.emit();
            $parser.bump();
        }
    }
}

fn parse_field(parser: &mut Parser) -> Field {
    let attrs = parser.parse_outer_attributes().unwrap();
    let is_pub = parser.eat_keyword(keywords::Pub);
    let ident = match parser.parse_ident() {
        Ok(ident) => ident,
        Err(mut e) => {
            e.emit();
            parser.abort_if_errors();
            unreachable!();
        }
    };
    let name = ident.name.to_string();
    expect_token!(parser, &token::Colon);

    if parser.eat(&token::OpenDelim(token::Bracket)) {
        // Field::Array
        let mut element_length = parse_u64(parser);
        if element_length == 0 || element_length > 64 {
            let span = parser.last_span;
            parser.span_err(span, "Elements length must be > 0 and <= 64");
            // We set element_length to a dummy value, so we can continue parsing
            element_length = 1;
        }

        expect_token!(parser, &token::Semi);

        let mut count = parse_u64(parser);
        if count == 0 {
            let span = parser.last_span;
            parser.span_err(span, "Elements count must be > 0");
            count = 1
        }

        expect_token!(parser, &token::CloseDelim(token::Bracket));

        Field::Array {
            name: name,
            element_length: element_length as u8,
            count: count as usize,
            is_pub: is_pub,
            attrs: attrs,
        }
    } else {
        // Field::Scalar
        let mut length = parse_u64(parser);
        if length == 0 || length > 64 {
            let span = parser.last_span;
            parser.span_err(span, "Field length must be > 0 and <= 64");
            length = 1;
        }
        Field::Scalar {
            name: name,
            length: length as u8,
            is_pub: is_pub,
            attrs: attrs,
        }
    }
}

fn set_attrs_method(method: P<ast::Item>, attrs: &[Attribute]) -> P<ast::Item> {
    method.map(|mut method| {
        if let ast::ItemKind::Impl(_, _, _, _, _, ref mut impl_items) = method.node {
            impl_items[0].attrs = attrs.to_vec();
        } else {
            unreachable!();
        }
        method
    })
}

fn get_impl_items(item: P<ast::Item>) -> Vec<ast::ImplItem> {
    item.and_then(|item| {
        if let ast::ItemKind::Impl(_, _, _, _, _, impl_items) = item.node {
            return impl_items;
        } else {
            unreachable!();
        }
    })
}

fn merge_impls(methods: Vec<P<syntax::ast::Item>>) -> P<syntax::ast::Item> {
    let mut methods = methods;
    let impl_block = methods.pop().unwrap();
    let mut methods_impl_items = vec![];
    for method in methods {
        methods_impl_items.extend(get_impl_items(method));
    }
    impl_block.map(|mut item| {
        if let ast::ItemKind::Impl(_, _, _, _, _, ref mut impl_items) = item.node {
            impl_items.extend(methods_impl_items);
        } else {
            unreachable!();
        }
        item
    })
}

fn expand_bitfield(cx: &mut ExtCtxt,
                   _sp: Span,
                   tts: &[ast::TokenTree])
                   -> Box<MacResult + 'static> {

    let mut parser = cx.new_parser_from_tts(tts);
    let attrs = parser.parse_outer_attributes().unwrap();
    let is_pub = parser.eat_keyword(keywords::Pub);
    let struct_ident = match parser.parse_ident() {
        Ok(ident) => ident,
        Err(mut e) => {
            e.emit();
            parser.abort_if_errors();
            unreachable!();
        }
    };

    if let Err(mut e) = parser.expect(&token::Comma) {
        e.emit();
    }

    let sep = SeqSep {
        sep: Some(token::Comma),
        trailing_sep_allowed: true,
    };

    let fields = match parser.parse_seq_to_end(&token::Eof, sep, |p| Ok(parse_field(p))) {
        Ok(fields) => fields,
        Err(mut e) => {
            e.emit();
            vec![]
        }
    };

    let mut methods = Vec::with_capacity(fields.len() * 2 + 1);
    let bit_length = fields.iter().fold(0, |a, b| a + b.bit_len());
    let byte_length = ((bit_length + 7) / 8) as usize;
    let maybe_pub = make_maybe_pub(is_pub);
    let struct_decl = quote_item!(cx, $maybe_pub struct $struct_ident { data: [u8; $byte_length]};)
                          .unwrap();
    let struct_decl = struct_decl.map(|mut s| {s.attrs = attrs; s});

    let new_doc = format!("Creates a new `{}`", struct_ident);
    let method_new = quote_item!(cx,
       impl $struct_ident {
           #[doc = $new_doc]
           $maybe_pub fn new(data: [u8; $byte_length]) -> $struct_ident {
               $struct_ident { data: data}
           }
        }
    ).unwrap();
    methods.push(method_new);

    let mut field_start = 0;
    for field in fields {
        methods.extend(field.to_methods(cx, struct_ident, field_start));
        field_start += field.bit_len();
    }

    let methods = merge_impls(methods);
    let items = vec![struct_decl, methods];
    let s = SmallVector::many(items);
    MacEager::items(s)
}

#[plugin_registrar]
pub fn plugin_registrar(reg: &mut Registry) {
    reg.register_macro("bitfield", expand_bitfield);
}