plugkit 0.0.9

Deplug Package Development Kit
Documentation 
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

//! Layer values.
//!
//! Type Layer represents a layer of a protocol stack.

use super::token::Token;
use super::attr::Attr;
use super::payload::Payload;
use super::context::Context;
use super::symbol;
use super::range::Range;
use std::slice;

extern crate libc;

/// Maximum value of worker ID.
pub const MAX_WORKER: u8 = 16;

/// A layer object.
#[derive(Debug)]
#[repr(C)]
pub struct Layer {
    id: Token,
    data: u32,
    parent: *mut Layer,
    range: (u32, u32),
}

/// Confidence level.
#[derive(Debug)]
pub enum Confidence {
    Error = 0,
    Possible = 1,
    Probable = 2,
    Exact = 3,
}

impl Layer {
    /// Returns the ID of `self`.
    pub fn id(&self) -> Token {
        self.id
    }

    /// Finds the first attribute with `id`.
    pub fn attr(&self, id: Token) -> Option<&Attr> {
        unsafe { symbol::Layer_attr.unwrap()(self, id).as_ref() }
    }

    /// Returns an `Iterator` for the payloads of `self`.
    pub fn payloads(&self) -> Box<Iterator<Item = &Payload>> {
        unsafe {
            let mut size: libc::size_t = 0;
            let ptr = symbol::Layer_payloads.unwrap()(self, &mut size);
            let s = slice::from_raw_parts(ptr, size);
            Box::new(s.iter().map(|elem| &**elem))
        }
    }

    /// Allocates a new `Layer` and add it as a child.
    pub fn add_layer(&mut self, ctx: &mut Context, id: Token) -> &mut Layer {
        unsafe { &mut *symbol::Layer_addLayer.unwrap()(self, ctx, id) }
    }

    /// Allocates a new `Attr` and add it as a child.
    pub fn add_attr(&mut self, ctx: &mut Context, id: Token) -> &mut Attr {
        unsafe { &mut *symbol::Layer_addAttr.unwrap()(self, ctx, id) }
    }

    /// Allocates a new alias `Attr`.
    pub fn add_attr_alias(&mut self, ctx: &mut Context, alias: Token, target: Token) {
        unsafe { symbol::Layer_addAttrAlias.unwrap()(self, ctx, alias, target) }
    }

    /// Allocates a new `Payload` and add it as a child.
    pub fn add_payload(&mut self, ctx: &mut Context) -> &mut Payload {
        unsafe { &mut *symbol::Layer_addPayload.unwrap()(self, ctx) }
    }

    /// Allocates a new error `Attr`.
    pub fn add_error(&mut self, ctx: &mut Context, id: Token, msg: &str) {
        unsafe {
            symbol::Layer_addError.unwrap()(self, ctx, id, msg.as_ptr() as *const i8, msg.len())
        }
    }

    /// Adds `id` as a tag of `self`.
    pub fn add_tag(&mut self, ctx: &mut Context, id: Token) {
        unsafe {
            symbol::Layer_addTag.unwrap()(self, ctx, id);
        }
    }

    /// Returns a reference to the parent of `self`.
    pub fn parent(&self) -> Option<&Layer> {
        if self.is_root() || self.parent.is_null() {
            None
        } else {
            unsafe { Some(&*self.parent) }
        }
    }

    /// Returns a mutable reference to the parent of `self`.
    pub fn parent_mut(&mut self) -> Option<&mut Layer> {
        if self.is_root() || self.parent.is_null() {
            None
        } else {
            unsafe { Some(&mut *self.parent) }
        }
    }

    /// Returns the range of `self`.
    pub fn range(&self) -> Range {
        Range {
            start: self.range.0,
            end: self.range.1,
        }
    }

    /// Sets the range of `self`.
    pub fn set_range(&mut self, range: &Range) {
        self.range = (range.start, range.end)
    }

    /// Returns the worker ID of `self`.
    pub fn worker(&self) -> u8 {
        (self.data & 0b1111) as u8
    }

    /// Sets the worker ID of `self`.
    pub fn set_worker(&mut self, worker: u8) {
        self.data = (self.data & !0b1111) | (worker % MAX_WORKER) as u32
    }

    fn is_root(&self) -> bool {
        ((self.data >> 6) & 0b1) != 0
    }
}