lib-ruby-parser 3.0.11

Ruby parser
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
137
138
139
140

use crate::blobs::{Blob, HasBlob};
use crate::containers::{ExternalList as List, ExternalMaybe as Maybe, ExternalPtr as Ptr};

use crate::source::Comment;
use crate::source::DecodedInput;
use crate::source::MagicComment;
use crate::Diagnostic;
use crate::Node;
use crate::Token;

/// Combination of all data that `Parser` can give you
#[repr(C)]
pub struct ParserResult {
    pub(crate) blob: Blob<ParserResult>,
}

extern "C" {
    fn lib_ruby_parser__external__parser_result__new(
        ast: Blob<Maybe<Ptr<Node>>>,
        tokens: Blob<List<Token>>,
        diagnostics: Blob<List<Diagnostic>>,
        comments: Blob<List<Comment>>,
        magic_comments: Blob<List<MagicComment>>,
        input: Blob<DecodedInput>,
    ) -> Blob<ParserResult>;
    fn lib_ruby_parser__external__parser_result__drop(blob: *mut Blob<ParserResult>);
    fn lib_ruby_parser__external__parser_result__get_ast(
        blob: *const Blob<ParserResult>,
    ) -> *const Blob<Maybe<Ptr<Node>>>;
    fn lib_ruby_parser__external__parser_result__get_tokens(
        blob: *const Blob<ParserResult>,
    ) -> *const Blob<List<Token>>;
    fn lib_ruby_parser__external__parser_result__get_diagnostics(
        blob: *const Blob<ParserResult>,
    ) -> *const Blob<List<Diagnostic>>;
    fn lib_ruby_parser__external__parser_result__get_comments(
        blob: *const Blob<ParserResult>,
    ) -> *const Blob<List<Comment>>;
    fn lib_ruby_parser__external__parser_result__get_magic_comments(
        blob: *const Blob<ParserResult>,
    ) -> *const Blob<List<MagicComment>>;
    fn lib_ruby_parser__external__parser_result__get_input(
        blob: *const Blob<ParserResult>,
    ) -> *const Blob<DecodedInput>;
}

impl Drop for ParserResult {
    fn drop(&mut self) {
        unsafe { lib_ruby_parser__external__parser_result__drop(&mut self.blob) }
    }
}

impl ParserResult {
    pub(crate) fn new(
        ast: Maybe<Ptr<Node>>,
        tokens: List<Token>,
        diagnostics: List<Diagnostic>,
        comments: List<Comment>,
        magic_comments: List<MagicComment>,
        input: DecodedInput,
    ) -> Self {
        let blob = unsafe {
            lib_ruby_parser__external__parser_result__new(
                ast.into_blob(),
                tokens.into_blob(),
                diagnostics.into_blob(),
                comments.into_blob(),
                magic_comments.into_blob(),
                input.into_blob(),
            )
        };
        Self { blob }
    }

    /// Returns `ast` attribute
    pub fn ast(&self) -> &Maybe<Ptr<Node>> {
        unsafe {
            (lib_ruby_parser__external__parser_result__get_ast(&self.blob)
                as *const Maybe<Ptr<Node>>)
                .as_ref()
                .unwrap()
        }
    }
    /// Returns `tokens` attribute
    pub fn tokens(&self) -> &List<Token> {
        unsafe {
            (lib_ruby_parser__external__parser_result__get_tokens(&self.blob) as *const List<Token>)
                .as_ref()
                .unwrap()
        }
    }
    /// Returns `diagnostics` attribute
    pub fn diagnostics(&self) -> &List<Diagnostic> {
        unsafe {
            (lib_ruby_parser__external__parser_result__get_diagnostics(&self.blob)
                as *const List<Diagnostic>)
                .as_ref()
                .unwrap()
        }
    }
    /// Returns `comments` attribute
    pub fn comments(&self) -> &List<Comment> {
        unsafe {
            (lib_ruby_parser__external__parser_result__get_comments(&self.blob)
                as *const List<Comment>)
                .as_ref()
                .unwrap()
        }
    }
    /// Returns `magic_comments` attribute
    pub fn magic_comments(&self) -> &List<MagicComment> {
        unsafe {
            (lib_ruby_parser__external__parser_result__get_magic_comments(&self.blob)
                as *const List<MagicComment>)
                .as_ref()
                .unwrap()
        }
    }
    /// Returns `input` attribute
    pub fn input(&self) -> &DecodedInput {
        unsafe {
            (lib_ruby_parser__external__parser_result__get_input(&self.blob) as *const DecodedInput)
                .as_ref()
                .unwrap()
        }
    }
}

impl std::fmt::Debug for ParserResult {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("ParserResult")
            .field("ast", self.ast())
            .field("tokens", self.tokens())
            .field("diagnostics", self.diagnostics())
            .field("comments", self.comments())
            .field("magic_comments", self.magic_comments())
            .field("input", self.input())
            .finish()
    }
}