slicec 0.3.3

The Slice parser and other core components for Slice compilers.
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

// Copyright (c) ZeroC, Inc.

use crate::grammar::*;
use crate::slice_file::Span;

#[derive(Debug)]
pub struct DocComment {
    pub overview: Option<Message>,
    pub params: Vec<ParamTag>,
    pub returns: Vec<ReturnsTag>,
    pub throws: Vec<ThrowsTag>,
    pub see: Vec<SeeTag>,
    pub span: Span,
}

#[derive(Debug)]
pub struct ParamTag {
    pub identifier: Identifier,
    pub message: Message,
    pub span: Span,
}

#[derive(Debug)]
pub struct ReturnsTag {
    pub identifier: Option<Identifier>,
    pub message: Message,
    pub span: Span,
}

#[derive(Debug)]
pub struct ThrowsTag {
    pub thrown_type: TypeRefDefinition<Exception>,
    pub message: Message,
    pub span: Span,
}

impl ThrowsTag {
    pub fn thrown_type(&self) -> Result<&Exception, &Identifier> {
        match &self.thrown_type {
            TypeRefDefinition::Patched(ptr) => Ok(ptr.borrow()),
            TypeRefDefinition::Unpatched(identifier) => Err(identifier),
        }
    }
}

#[derive(Debug)]
pub struct SeeTag {
    pub link: TypeRefDefinition<dyn Entity>,
    pub span: Span,
}

impl SeeTag {
    pub fn linked_entity(&self) -> Result<&dyn Entity, &Identifier> {
        match &self.link {
            TypeRefDefinition::Patched(ptr) => Ok(ptr.borrow()),
            TypeRefDefinition::Unpatched(identifier) => Err(identifier),
        }
    }
}

#[derive(Debug)]
pub struct LinkTag {
    pub link: TypeRefDefinition<dyn Entity>,
    pub span: Span,
}

impl LinkTag {
    pub fn linked_entity(&self) -> Result<&dyn Entity, &Identifier> {
        match &self.link {
            TypeRefDefinition::Patched(ptr) => Ok(ptr.borrow()),
            TypeRefDefinition::Unpatched(identifier) => Err(identifier),
        }
    }
}

#[derive(Debug)]
pub enum MessageComponent {
    Text(String),
    Link(LinkTag),
}

#[derive(Debug)]
pub struct Message {
    pub value: Vec<MessageComponent>,
    pub span: Span,
}

implement_Element_for!(DocComment, "doc comment");
implement_Symbol_for!(DocComment);
implement_Element_for!(ParamTag, "param tag");
implement_Symbol_for!(ParamTag);
implement_Element_for!(ReturnsTag, "returns tag");
implement_Symbol_for!(ReturnsTag);
implement_Element_for!(ThrowsTag, "throws tag");
implement_Symbol_for!(ThrowsTag);
implement_Element_for!(SeeTag, "see tag");
implement_Symbol_for!(SeeTag);
implement_Element_for!(LinkTag, "link tag");
implement_Symbol_for!(LinkTag);
implement_Element_for!(Message, "doc message");
implement_Symbol_for!(Message);