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

// Copyright (c) ZeroC, Inc.

use crate::diagnostics::{Diagnostic, Diagnostics, Error};
use crate::grammar::*;

pub fn validate_dictionary(dictionary: &Dictionary, diagnostics: &mut Diagnostics) {
    has_allowed_key_type(dictionary, diagnostics);
}

fn has_allowed_key_type(dictionary: &Dictionary, diagnostics: &mut Diagnostics) {
    if let Some(e) = check_dictionary_key_type(&dictionary.key_type) {
        e.push_into(diagnostics)
    }
}

fn check_dictionary_key_type(type_ref: &TypeRef) -> Option<Diagnostic> {
    // Optional types cannot be used as dictionary keys.
    if type_ref.is_optional {
        return Some(Diagnostic::new(Error::KeyMustBeNonOptional).set_span(type_ref.span()));
    }

    let definition = type_ref.definition();
    let is_valid = match definition.concrete_type() {
        Types::Struct(struct_def) => {
            // Only compact structs can be used for dictionary keys.
            if !struct_def.is_compact {
                return Some(Diagnostic::new(Error::StructKeyMustBeCompact).set_span(type_ref.span()));
            }

            // Check that all the fields of the struct are also valid key types.
            // We collect the invalid fields so we can report them in the error message.
            let errors = struct_def
                .fields()
                .into_iter()
                .filter_map(|field| check_dictionary_key_type(field.data_type()))
                .collect::<Vec<_>>();
            if !errors.is_empty() {
                let mut error = Diagnostic::new(Error::StructKeyContainsDisallowedType {
                    struct_identifier: struct_def.identifier().to_owned(),
                })
                .set_span(type_ref.span());

                // Convert each error into a note and add it to the struct key error.
                for e in errors {
                    error = error.add_note(e.message(), e.span());
                }
                return Some(error);
            }
            true
        }

        // Only enums with underlying types can be used as dictionary keys. Fields aren't allowed.
        Types::Enum(enum_def) => {
            if enum_def.underlying.is_none() {
                let error = Diagnostic::new(Error::KeyTypeNotSupported {
                    kind: formatted_kind(definition),
                })
                .set_span(type_ref.span())
                .add_note("only enums with underlying types can be used as dictionary keys", None);
                return Some(error);
            }
            true
        }

        Types::Class(_) => false,
        Types::CustomType(_) => true,
        Types::ResultType(_) => false,
        Types::Sequence(_) => false,
        Types::Dictionary(_) => false,
        Types::Primitive(primitive) => {
            primitive.is_integral() || matches!(primitive, Primitive::Bool | Primitive::String)
        }
    };

    if !is_valid {
        return Some(
            Diagnostic::new(Error::KeyTypeNotSupported {
                kind: formatted_kind(definition),
            })
            .set_span(type_ref.span()),
        );
    }
    None
}

fn formatted_kind(definition: &dyn Type) -> String {
    match definition.concrete_type() {
        Types::Class(class_def) => format!("class '{}'", class_def.identifier()),
        Types::Enum(enum_def) => format!("enum '{}'", enum_def.identifier()),
        _ => definition.kind().to_owned(),
    }
}