vhdl_parser 0.13.0

VHDL 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
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
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
// You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) 2018, Olof Kraigher olof.kraigher@gmail.com

use super::common::ParseResult;
use super::declarative_part::parse_declarative_part;
use super::interface_declaration::parse_parameter_interface_list;
use super::names::parse_selected_name;
use super::sequential_statement::parse_labeled_sequential_statements;
use super::tokens::{Kind::*, TokenStream};
use crate::ast::*;
use crate::data::*;

pub fn parse_signature(stream: &mut TokenStream) -> ParseResult<Signature> {
    stream.expect_kind(LeftSquare)?;
    let mut type_marks = Vec::new();
    let mut return_mark = None;
    let mut errmsg = None;
    loop {
        let token = stream.peek_expect()?;

        try_token_kind!(
            token,

            Identifier => {
                type_marks.push(parse_selected_name(stream)?);
                let sep_token = stream.expect()?;

                try_token_kind!(
                    sep_token,
                    Comma => {},
                    RightSquare => {
                        break;
                    },
                    Return => {
                        let new_return_mark = Some(parse_selected_name(stream)?);
                        if return_mark.is_some() {
                            errmsg = Some(Diagnostic::error(sep_token, "Duplicate return in signature"));
                        } else {
                            return_mark = new_return_mark;
                        }
                    }
                )
            },
            Return => {
                stream.move_after(&token);
                let new_return_mark = Some(parse_selected_name(stream)?);
                if return_mark.is_some() {
                    errmsg = Some(Diagnostic::error(token, "Duplicate return in signature"));
                } else {
                    return_mark = new_return_mark;
                }
            },
            RightSquare => {
                stream.move_after(&token);
                break;
            }
        )
    }
    if let Some(diagnostic) = errmsg {
        // @TODO recoverable error should not return Err
        return Err(diagnostic);
    }

    Ok(match return_mark {
        Some(return_mark) => Signature::Function(type_marks, return_mark),
        None => Signature::Procedure(type_marks),
    })
}

fn parse_designator(stream: &mut TokenStream) -> ParseResult<WithPos<SubprogramDesignator>> {
    let token = stream.expect()?;
    Ok(try_token_kind!(
        token,
        Identifier => token.expect_ident()?.map_into(SubprogramDesignator::Identifier),
        StringLiteral => token.expect_string()?.map_into(SubprogramDesignator::OperatorSymbol)
    ))
}

pub fn parse_subprogram_declaration_no_semi(
    stream: &mut TokenStream,
    diagnostics: &mut dyn DiagnosticHandler,
) -> ParseResult<SubprogramDeclaration> {
    let token = stream.expect()?;

    let (is_function, is_pure) = {
        try_token_kind!(
            token,
            Procedure => (false, false),
            Function => (true, true),
            Impure => {
                stream.expect_kind(Function)?;
                (true, false)
            }
        )
    };

    let designator = parse_designator(stream)?;

    let parameter_list = {
        if stream.peek_kind()? == Some(LeftPar) {
            parse_parameter_interface_list(stream, diagnostics)?
        } else {
            Vec::new()
        }
    };

    if is_function {
        stream.expect_kind(Return)?;
        let return_type = parse_selected_name(stream)?;
        Ok(SubprogramDeclaration::Function(FunctionSpecification {
            pure: is_pure,
            designator,
            parameter_list,
            return_type,
        }))
    } else {
        Ok(SubprogramDeclaration::Procedure(ProcedureSpecification {
            designator,
            parameter_list,
        }))
    }
}

pub fn parse_subprogram_declaration(
    stream: &mut TokenStream,
    diagnostics: &mut dyn DiagnosticHandler,
) -> ParseResult<SubprogramDeclaration> {
    let res = parse_subprogram_declaration_no_semi(stream, diagnostics);
    stream.expect_kind(SemiColon)?;
    res
}

/// LRM 4.3 Subprogram bodies
pub fn parse_subprogram_body(
    stream: &mut TokenStream,
    specification: SubprogramDeclaration,
    diagnostics: &mut dyn DiagnosticHandler,
) -> ParseResult<SubprogramBody> {
    let end_kind = {
        match specification {
            SubprogramDeclaration::Procedure(..) => Procedure,
            SubprogramDeclaration::Function(..) => Function,
        }
    };
    let declarations = parse_declarative_part(stream, diagnostics, true)?;

    let (statements, end_token) = parse_labeled_sequential_statements(stream, diagnostics)?;
    try_token_kind!(
        end_token,
        End => {
            stream.pop_if_kind(end_kind)?;
            stream.pop_if_kind(Identifier)?;
            stream.pop_if_kind(StringLiteral)?;
            stream.expect_kind(SemiColon)?;
        }
    );
    Ok(SubprogramBody {
        specification,
        declarations,
        statements,
    })
}

pub fn parse_subprogram(
    stream: &mut TokenStream,
    diagnostics: &mut dyn DiagnosticHandler,
) -> ParseResult<Declaration> {
    let specification = parse_subprogram_declaration_no_semi(stream, diagnostics)?;
    match_token_kind!(
        stream.expect()?,
        Is => {
            Ok(Declaration::SubprogramBody(parse_subprogram_body(stream, specification, diagnostics)?))
        },
        SemiColon => {
            Ok(Declaration::SubprogramDeclaration(specification))
        }
    )
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::data::Latin1String;
    use crate::syntax::test::Code;

    #[test]
    pub fn parses_procedure_specification() {
        let code = Code::new(
            "\
procedure foo;
",
        );
        assert_eq!(
            code.with_stream_no_diagnostics(parse_subprogram_declaration),
            SubprogramDeclaration::Procedure(ProcedureSpecification {
                designator: code
                    .s1("foo")
                    .ident()
                    .map_into(SubprogramDesignator::Identifier),
                parameter_list: Vec::new(),
            })
        );
    }

    #[test]
    pub fn parses_function_specification() {
        let code = Code::new(
            "\
function foo return lib.foo.natural;
",
        );
        assert_eq!(
            code.with_stream_no_diagnostics(parse_subprogram_declaration),
            SubprogramDeclaration::Function(FunctionSpecification {
                pure: true,
                designator: code
                    .s1("foo")
                    .ident()
                    .map_into(SubprogramDesignator::Identifier),
                parameter_list: Vec::new(),
                return_type: code.s1("lib.foo.natural").selected_name()
            })
        );
    }

    #[test]
    pub fn parses_function_specification_operator() {
        let code = Code::new(
            "\
function \"+\" return lib.foo.natural;
",
        );
        assert_eq!(
            code.with_stream_no_diagnostics(parse_subprogram_declaration),
            SubprogramDeclaration::Function(FunctionSpecification {
                pure: true,
                designator: WithPos {
                    item: SubprogramDesignator::OperatorSymbol(Latin1String::from_utf8_unchecked(
                        "+"
                    )),
                    pos: code.s1("\"+\"").pos()
                },
                parameter_list: Vec::new(),
                return_type: code.s1("lib.foo.natural").selected_name()
            })
        );
    }

    #[test]
    pub fn parses_impure_function_specification() {
        let code = Code::new(
            "\
impure function foo return lib.foo.natural;
",
        );
        assert_eq!(
            code.with_stream_no_diagnostics(parse_subprogram_declaration),
            SubprogramDeclaration::Function(FunctionSpecification {
                pure: false,
                designator: code
                    .s1("foo")
                    .ident()
                    .map_into(SubprogramDesignator::Identifier),
                parameter_list: Vec::new(),
                return_type: code.s1("lib.foo.natural").selected_name()
            })
        );
    }

    #[test]
    pub fn parses_procedure_specification_with_parameters() {
        let code = Code::new(
            "\
procedure foo(foo : natural);
",
        );
        assert_eq!(
            code.with_stream_no_diagnostics(parse_subprogram_declaration),
            SubprogramDeclaration::Procedure(ProcedureSpecification {
                designator: code
                    .s1("foo")
                    .ident()
                    .map_into(SubprogramDesignator::Identifier),
                parameter_list: vec![code.s1("foo : natural").parameter()],
            })
        );
    }

    #[test]
    pub fn parses_function_specification_with_parameters() {
        let code = Code::new(
            "\
function foo(foo : natural) return lib.foo.natural;
",
        );
        assert_eq!(
            code.with_stream_no_diagnostics(parse_subprogram_declaration),
            SubprogramDeclaration::Function(FunctionSpecification {
                pure: true,
                designator: code
                    .s1("foo")
                    .ident()
                    .map_into(SubprogramDesignator::Identifier),
                parameter_list: vec![code.s1("foo : natural").parameter()],
                return_type: code.s1("lib.foo.natural").selected_name()
            })
        );
    }

    #[test]
    pub fn parses_function_signature_only_return() {
        let code = Code::new("[return bar.type_mark]");
        assert_eq!(
            code.with_stream(parse_signature),
            Signature::Function(vec![], code.s1("bar.type_mark").selected_name())
        );
    }

    #[test]
    pub fn parses_function_signature_one_argument() {
        let code = Code::new("[foo.type_mark return bar.type_mark]");
        assert_eq!(
            code.with_stream(parse_signature),
            Signature::Function(
                vec![code.s1("foo.type_mark").selected_name()],
                code.s1("bar.type_mark").selected_name()
            )
        );
    }

    #[test]
    pub fn parses_procedure_signature() {
        let code = Code::new("[foo.type_mark]");
        assert_eq!(
            code.with_stream(parse_signature),
            Signature::Procedure(vec![code.s1("foo.type_mark").selected_name()])
        );
    }

    #[test]
    pub fn parses_function_signature_many_arguments() {
        let code = Code::new("[foo.type_mark, foo2.type_mark return bar.type_mark]");
        assert_eq!(
            code.with_stream(parse_signature),
            Signature::Function(
                vec![
                    code.s1("foo.type_mark").selected_name(),
                    code.s1("foo2.type_mark").selected_name()
                ],
                code.s1("bar.type_mark").selected_name()
            )
        );
    }

    #[test]
    pub fn parses_function_signature_many_return_error() {
        let code = Code::new("[return bar.type_mark return bar2]");
        assert_eq!(
            code.with_stream_err(parse_signature),
            Diagnostic::error(code.s("return", 2), "Duplicate return in signature")
        );

        let code = Code::new("[foo return bar.type_mark return bar2]");
        assert_eq!(
            code.with_stream_err(parse_signature),
            Diagnostic::error(code.s("return", 2), "Duplicate return in signature")
        );
    }

    #[test]
    pub fn parses_subprogram_body() {
        let code = Code::new(
            "\
function foo(arg : natural) return natural is
  constant foo : natural := 0;
begin
  return foo + arg;
end function;
",
        );
        let specification = code
            .s1("function foo(arg : natural) return natural")
            .subprogram_decl();
        let declarations = code.s1("constant foo : natural := 0;").declarative_part();
        let statements = vec![code.s1("return foo + arg;").sequential_statement()];
        let body = SubprogramBody {
            specification,
            declarations,
            statements,
        };
        assert_eq!(
            code.with_stream_no_diagnostics(parse_subprogram),
            Declaration::SubprogramBody(body)
        );
    }

    #[test]
    pub fn parses_subprogram_declaration() {
        let code = Code::new(
            "\
function foo(arg : natural) return natural;
",
        );
        let specification = code
            .s1("function foo(arg : natural) return natural")
            .subprogram_decl();
        assert_eq!(
            code.with_stream_no_diagnostics(parse_subprogram),
            Declaration::SubprogramDeclaration(specification)
        );
    }
}