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 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
//! Contains the types necessary to parse [Luau](https://luau-lang.org/).
//! The module name is a misnomer from when Luau was just types.
//! It will be renamed to "luau" in the future.
use super::{punctuated::Punctuated, span::ContainedSpan, *};
use crate::{
util::display_option,
visitors::{Visit, VisitMut},
ShortString,
};
use derive_more::Display;
/// Any type, such as `string`, `boolean?`, `number | boolean`, etc.
#[derive(Clone, Debug, Display, PartialEq, Node)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[non_exhaustive]
pub enum TypeInfo {
/// A shorthand type annotating the structure of an array: { number }
#[display(fmt = "{}{}{}", "braces.tokens().0", "type_info", "braces.tokens().1")]
Array {
/// The braces (`{}`) containing the type info.
braces: ContainedSpan,
/// The type info for the values in the Array
type_info: Box<TypeInfo>,
},
/// A standalone type, such as `string` or `Foo`.
#[display(fmt = "{_0}")]
Basic(TokenReference),
/// A singleton string type, such as `"hello"`
#[display(fmt = "{_0}")]
String(TokenReference),
/// A singleton boolean type, such as `true`
#[display(fmt = "{_0}")]
Boolean(TokenReference),
/// A callback type, such as `(string, number) => boolean`.
#[display(
fmt = "{}{}{arguments}{}{arrow}{return_type}",
"display_option(generics)",
"parentheses.tokens().0",
"parentheses.tokens().1"
)]
Callback {
/// Optional generics provided for the arguments, such as in `<T>(T) -> string`
generics: Option<GenericDeclaration>,
/// The parentheses for the arguments.
parentheses: ContainedSpan,
/// The argument types: `(string, number)`.
arguments: Punctuated<TypeArgument>,
/// The "thin arrow" (`->`) in between the arguments and the return type.
arrow: TokenReference,
/// The return type: `boolean`.
return_type: Box<TypeInfo>,
},
/// A type using generics, such as `map<number, string>`.
#[display(
fmt = "{}{}{}{}",
"base",
"arrows.tokens().0",
"generics",
"arrows.tokens().1"
)]
Generic {
/// The type that has generics: `map`.
base: TokenReference,
/// The arrows (`<>`) containing the type parameters.
arrows: ContainedSpan,
/// The type parameters: `number, string`.
generics: Punctuated<TypeInfo>,
},
/// A generic pack: `T...`.
/// Note, these are only available as return types, when annotating a vararg (`...`) in a function parameter, or as a generic type argument.
#[display(fmt = "{name}{ellipse}")]
GenericPack {
/// The name of the type that is generic: `T`.
name: TokenReference,
/// The ellipse: `...`.
ellipse: TokenReference,
},
/// An intersection type: `string & number`, denoting both types.
#[display(fmt = "{left}{ampersand}{right}")]
Intersection {
/// The left hand side: `string`.
left: Box<TypeInfo>,
/// The ampersand (`&`) to separate the types.
ampersand: TokenReference,
/// The right hand side: `number`.
right: Box<TypeInfo>,
},
/// A type coming from a module, such as `module.Foo`
#[display(fmt = "{module}{punctuation}{type_info}")]
Module {
/// The module the type is coming from: `module`.
module: TokenReference,
/// The punctuation (`.`) to index the module.
punctuation: TokenReference,
/// The indexed type info: `Foo`.
type_info: Box<IndexedTypeInfo>,
},
/// An optional type, such as `string?`.
#[display(fmt = "{base}{question_mark}")]
Optional {
/// The type that is optional: `string`.
base: Box<TypeInfo>,
/// The question mark: `?`.
question_mark: TokenReference,
},
/// A type annotating the structure of a table: { foo: number, bar: string }
#[display(fmt = "{}{}{}", "braces.tokens().0", "fields", "braces.tokens().1")]
Table {
/// The braces (`{}`) containing the fields.
braces: ContainedSpan,
/// The fields: `foo: number, bar: string`.
fields: Punctuated<TypeField>,
},
/// A type in the form of `typeof(foo)`.
#[display(
fmt = "{}{}{}{}",
"typeof_token",
"parentheses.tokens().0",
"inner",
"parentheses.tokens().1"
)]
Typeof {
/// The token `typeof`.
typeof_token: TokenReference,
/// The parentheses used to contain the expression.
parentheses: ContainedSpan,
/// The inner expression: `foo`.
inner: Box<Expression>,
},
/// A tuple expression: `(string, number)`.
#[display(
fmt = "{}{}{}",
"parentheses.tokens().0",
"types",
"parentheses.tokens().1"
)]
Tuple {
/// The parentheses used to contain the types
parentheses: ContainedSpan,
/// The types: `(string, number)`.
types: Punctuated<TypeInfo>,
},
/// A union type: `string | number`, denoting one or the other.
#[display(fmt = "{left}{pipe}{right}")]
Union {
/// The left hand side: `string`.
left: Box<TypeInfo>,
/// The pipe (`|`) to separate the types.
pipe: TokenReference,
/// The right hand side: `number`.
right: Box<TypeInfo>,
},
/// A variadic type: `...number`.
#[display(fmt = "{ellipse}{type_info}")]
Variadic {
/// The ellipse: `...`.
ellipse: TokenReference,
/// The type that is variadic: `number`.
type_info: Box<TypeInfo>,
},
/// A variadic type pack: `...T` in `Function<...T>`
#[display(fmt = "{ellipse}{name}")]
VariadicPack {
/// The ellipse: `...`
ellipse: TokenReference,
/// The name of the type that is variadic: `T`
name: TokenReference,
},
}
/// A subset of TypeInfo that consists of items which can only be used as an index, such as `Foo` and `Foo<Bar>`,
#[derive(Clone, Debug, Display, PartialEq, Node)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[non_exhaustive]
pub enum IndexedTypeInfo {
/// A standalone type, such as `string` or `Foo`.
#[display(fmt = "{_0}")]
Basic(TokenReference),
/// A type using generics, such as `map<number, string>`.
#[display(fmt = "{base}{}{generics}{}", "arrows.tokens().0", "arrows.tokens().1")]
Generic {
/// The type that has generics: `map`.
base: TokenReference,
/// The arrows (`<>`) containing the type parameters.
arrows: ContainedSpan,
/// The type parameters: `number, string`.
generics: Punctuated<TypeInfo>,
},
}
/// A type field used within table types.
/// The `foo: number` in `{ foo: number }`.
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{key}{colon}{value}")]
pub struct TypeField {
pub(crate) key: TypeFieldKey,
pub(crate) colon: TokenReference,
pub(crate) value: TypeInfo,
}
impl TypeField {
/// Creates a new TypeField from the given key and value
pub fn new(key: TypeFieldKey, value: TypeInfo) -> Self {
Self {
key,
colon: TokenReference::symbol(": ").unwrap(),
value,
}
}
/// The key of the field, `foo` in `foo: number`.
pub fn key(&self) -> &TypeFieldKey {
&self.key
}
/// The colon in between the key name and the value type.
pub fn colon_token(&self) -> &TokenReference {
&self.colon
}
/// The type for the field, `number` in `foo: number`.
pub fn value(&self) -> &TypeInfo {
&self.value
}
/// Returns a new TypeField with the given key
pub fn with_key(self, key: TypeFieldKey) -> Self {
Self { key, ..self }
}
/// Returns a new TypeField with the `:` token
pub fn with_colon_token(self, colon_token: TokenReference) -> Self {
Self {
colon: colon_token,
..self
}
}
/// Returns a new TypeField with the `:` token
pub fn with_value(self, value: TypeInfo) -> Self {
Self { value, ..self }
}
}
/// A key in a [`TypeField`]. Can either be a name or an index signature.
#[derive(Clone, Debug, Display, PartialEq, Node)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[non_exhaustive]
pub enum TypeFieldKey {
/// A name, such as `foo`.
#[display(fmt = "{_0}")]
Name(TokenReference),
/// An index signature, such as `[number]`.
#[display(fmt = "{}{}{}", "brackets.tokens().0", "inner", "brackets.tokens().1")]
IndexSignature {
/// The brackets (`[]`) used to contain the type.
brackets: ContainedSpan,
/// The type for the index signature, `number` in `[number]`.
inner: TypeInfo,
},
}
/// A type assertion using `::`, such as `:: number`.
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{assertion_op}{cast_to}")]
pub struct TypeAssertion {
pub(crate) assertion_op: TokenReference,
pub(crate) cast_to: TypeInfo,
}
impl TypeAssertion {
/// Creates a new TypeAssertion from the given cast to TypeInfo
pub fn new(cast_to: TypeInfo) -> Self {
Self {
assertion_op: TokenReference::symbol("::").unwrap(),
cast_to,
}
}
/// The token `::`.
pub fn assertion_op(&self) -> &TokenReference {
&self.assertion_op
}
/// The type to cast the expression into, `number` in `:: number`.
pub fn cast_to(&self) -> &TypeInfo {
&self.cast_to
}
/// Returns a new TypeAssertion with the given `::` token
pub fn with_assertion_op(self, assertion_op: TokenReference) -> Self {
Self {
assertion_op,
..self
}
}
/// Returns a new TypeAssertion with the given TypeInfo to cast to
pub fn with_cast_to(self, cast_to: TypeInfo) -> Self {
Self { cast_to, ..self }
}
}
/// A type declaration, such as `type Meters = number`
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(
fmt = "{}{}{}{}{}",
"type_token",
"base",
"display_option(generics)",
"equal_token",
"declare_as"
)]
pub struct TypeDeclaration {
pub(crate) type_token: TokenReference,
pub(crate) base: TokenReference,
pub(crate) generics: Option<GenericDeclaration>,
pub(crate) equal_token: TokenReference,
pub(crate) declare_as: TypeInfo,
}
impl TypeDeclaration {
/// Creates a new TypeDeclaration from the given type name and type declaration
pub fn new(type_name: TokenReference, type_definition: TypeInfo) -> Self {
Self {
type_token: TokenReference::new(
Vec::new(),
Token::new(TokenType::Identifier {
identifier: "type".into(),
}),
vec![Token::new(TokenType::spaces(1))],
),
base: type_name,
generics: None,
equal_token: TokenReference::symbol(" = ").unwrap(),
declare_as: type_definition,
}
}
/// The token `type`.
pub fn type_token(&self) -> &TokenReference {
&self.type_token
}
/// The name of the type, `Meters` in `type Meters = number`.
pub fn type_name(&self) -> &TokenReference {
&self.base
}
/// The generics of the type, if there are any. `<T>` in `type Foo<T> = T`.
pub fn generics(&self) -> Option<&GenericDeclaration> {
self.generics.as_ref()
}
/// The `=` token in between the type name and the definition.
pub fn equal_token(&self) -> &TokenReference {
&self.equal_token
}
/// The definition of the type, `number` in `type Meters = number`.
pub fn type_definition(&self) -> &TypeInfo {
&self.declare_as
}
/// Returns a new TypeDeclaration with the given `type` token
pub fn with_type_token(self, type_token: TokenReference) -> Self {
Self { type_token, ..self }
}
/// Returns a new TypeDeclaration with the given type name
pub fn with_type_name(self, type_name: TokenReference) -> Self {
Self {
base: type_name,
..self
}
}
/// Returns a new TypeDeclaration with the given generics of the type
pub fn with_generics(self, generics: Option<GenericDeclaration>) -> Self {
Self { generics, ..self }
}
/// Returns a new TypeDeclaration with the given generics of the type
pub fn with_equal_token(self, equal_token: TokenReference) -> Self {
Self {
equal_token,
..self
}
}
/// Returns a new TypeDeclaration with the given generics of the type
pub fn with_type_definition(self, type_definition: TypeInfo) -> Self {
Self {
declare_as: type_definition,
..self
}
}
}
/// A generic declaration parameter used in [`GenericDeclaration`]. Can either be a name or a variadic pack.
#[derive(Clone, Debug, Display, PartialEq, Eq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[non_exhaustive]
pub enum GenericParameterInfo {
/// A name, such as `foo`.
#[display(fmt = "{_0}")]
Name(TokenReference),
/// A variadic type pack: `T...`.
#[display(fmt = "{name}{ellipse}")]
Variadic {
/// The name of the type that is variadic: `T`.
name: TokenReference,
/// The ellipse: `...`.
ellipse: TokenReference,
},
}
/// A generic declaration parameter us in [`GenericDeclaration`]. Consists of a [`GenericParameterInfo`] and an optional default type.
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(
fmt = "{}{}{}",
"parameter",
"display_option(self.equals())",
"display_option(self.default_type())"
)]
pub struct GenericDeclarationParameter {
pub(crate) parameter: GenericParameterInfo,
pub(crate) default: Option<(TokenReference, TypeInfo)>,
}
impl GenericDeclarationParameter {
/// Creates a new GenericDeclarationParameter
pub fn new(parameter: GenericParameterInfo) -> Self {
Self {
parameter,
default: None,
}
}
/// The generic parameter
pub fn parameter(&self) -> &GenericParameterInfo {
&self.parameter
}
/// The equals symbol denoting a default type, if present
pub fn equals(&self) -> Option<&TokenReference> {
self.default.as_ref().map(|(equals, _)| equals)
}
/// The default type, if present
pub fn default_type(&self) -> Option<&TypeInfo> {
self.default.as_ref().map(|(_, default_type)| default_type)
}
/// Returns a new GenericDeclarationParameter with the given parameter info
pub fn with_parameter(self, parameter: GenericParameterInfo) -> Self {
Self { parameter, ..self }
}
/// Returns a new GenericDeclarationParameter with the given default type
pub fn with_default(self, default: Option<(TokenReference, TypeInfo)>) -> Self {
Self { default, ..self }
}
}
/// The generics used in a [`TypeDeclaration`].
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{}{}{}", "arrows.tokens().0", "generics", "arrows.tokens().1")]
pub struct GenericDeclaration {
#[visit(contains = "generics")]
pub(crate) arrows: ContainedSpan,
pub(crate) generics: Punctuated<GenericDeclarationParameter>,
}
impl GenericDeclaration {
/// Creates a new GenericDeclaration
pub fn new() -> Self {
Self {
arrows: ContainedSpan::new(
TokenReference::symbol("<").unwrap(),
TokenReference::symbol(">").unwrap(),
),
generics: Punctuated::new(),
}
}
/// The arrows (`<>`) containing the types.
pub fn arrows(&self) -> &ContainedSpan {
&self.arrows
}
/// The names of the generics: `T, U` in `<T, U>`.
pub fn generics(&self) -> &Punctuated<GenericDeclarationParameter> {
&self.generics
}
/// Returns a new GenericDeclaration with the given arrows containing the types
pub fn with_arrows(self, arrows: ContainedSpan) -> Self {
Self { arrows, ..self }
}
/// Returns a new TypeDeclaration with the given names of the generics
pub fn with_generics(self, generics: Punctuated<GenericDeclarationParameter>) -> Self {
Self { generics, ..self }
}
}
impl Default for GenericDeclaration {
fn default() -> Self {
Self::new()
}
}
/// A type specifier, the `: number` in `local foo: number`
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{punctuation}{type_info}")]
pub struct TypeSpecifier {
pub(crate) punctuation: TokenReference,
pub(crate) type_info: TypeInfo,
}
impl TypeSpecifier {
/// Creates a new TypeSpecifier with the given type info
pub fn new(type_info: TypeInfo) -> Self {
Self {
punctuation: TokenReference::symbol(": ").unwrap(),
type_info,
}
}
/// The punctuation being used.
/// `:` for `local foo: number`.
pub fn punctuation(&self) -> &TokenReference {
&self.punctuation
}
/// The type being specified: `number` in `local foo: number`.
pub fn type_info(&self) -> &TypeInfo {
&self.type_info
}
/// Returns a new TypeSpecifier with the given punctuation
pub fn with_punctuation(self, punctuation: TokenReference) -> Self {
Self {
punctuation,
..self
}
}
/// Returns a new TypeSpecifier with the given type being specified
pub fn with_type_info(self, type_info: TypeInfo) -> Self {
Self { type_info, ..self }
}
}
/// A type argument specified in a callback type, the `count: number` in `(count: number) -> ()`
#[derive(Clone, Debug, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
pub struct TypeArgument {
pub(crate) name: Option<(TokenReference, TokenReference)>,
pub(crate) type_info: TypeInfo,
}
impl TypeArgument {
/// Creates a new TypeArgument with the given type info
pub fn new(type_info: TypeInfo) -> Self {
Self {
name: None,
type_info,
}
}
/// The name of the argument split into identifier and punctuation: `count:` in `count: number`.
pub fn name(&self) -> Option<&(TokenReference, TokenReference)> {
self.name.as_ref()
}
/// The type info for the argument: `number` in `count: number`.
pub fn type_info(&self) -> &TypeInfo {
&self.type_info
}
/// Returns a new TypeArgument with the given punctuation
pub fn with_name(self, name: Option<(TokenReference, TokenReference)>) -> Self {
Self { name, ..self }
}
/// Returns a new TypeArgument with the given type info
pub fn with_type_info(self, type_info: TypeInfo) -> Self {
Self { type_info, ..self }
}
}
impl fmt::Display for TypeArgument {
fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
if let Some((identifier, punctuation)) = self.name() {
write!(formatter, "{}{}{}", identifier, punctuation, self.type_info)
} else {
write!(formatter, "{}", self.type_info)
}
}
}
/// An exported type declaration, such as `export type Meters = number`
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{export_token}{type_declaration}")]
pub struct ExportedTypeDeclaration {
pub(crate) export_token: TokenReference,
pub(crate) type_declaration: TypeDeclaration,
}
impl ExportedTypeDeclaration {
/// Creates a new ExportedTypeDeclaration with the given type declaration
pub fn new(type_declaration: TypeDeclaration) -> Self {
Self {
export_token: TokenReference::new(
vec![],
Token::new(TokenType::Identifier {
identifier: ShortString::new("export"),
}),
vec![Token::new(TokenType::spaces(1))],
),
type_declaration,
}
}
/// The token `export`.
pub fn export_token(&self) -> &TokenReference {
&self.export_token
}
/// The type declaration, `type Meters = number`.
pub fn type_declaration(&self) -> &TypeDeclaration {
&self.type_declaration
}
/// Returns a new ExportedTypeDeclaration with the `export` token
pub fn with_export_token(self, export_token: TokenReference) -> Self {
Self {
export_token,
..self
}
}
/// Returns a new TypeDeclaration with the given type declaration
pub fn with_type_declaration(self, type_declaration: TypeDeclaration) -> Self {
Self {
type_declaration,
..self
}
}
}
make_op!(CompoundOp,
#[doc = "Compound operators, such as X += Y or X -= Y"]
{
PlusEqual,
MinusEqual,
StarEqual,
SlashEqual,
PercentEqual,
CaretEqual,
TwoDotsEqual,
}
);
impl CompoundOp {
/// The token associated with the operator
pub fn token(&self) -> &TokenReference {
match self {
Self::PlusEqual(token)
| Self::MinusEqual(token)
| Self::StarEqual(token)
| Self::SlashEqual(token)
| Self::PercentEqual(token)
| Self::CaretEqual(token)
| Self::TwoDotsEqual(token) => token,
}
}
}
/// A Compound Assignment statement, such as `x += 1` or `x -= 1`
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{lhs}{compound_operator}{rhs}")]
pub struct CompoundAssignment {
pub(crate) lhs: Var,
pub(crate) compound_operator: CompoundOp,
pub(crate) rhs: Expression,
}
impl CompoundAssignment {
/// Creates a new CompoundAssignment from the left and right hand side
pub fn new(lhs: Var, compound_operator: CompoundOp, rhs: Expression) -> Self {
Self {
lhs,
compound_operator,
rhs,
}
}
/// The variable assigned to, the `x` part of `x += 1`
pub fn lhs(&self) -> &Var {
&self.lhs
}
/// The operator used, the `+=` part of `x += 1`
pub fn compound_operator(&self) -> &CompoundOp {
&self.compound_operator
}
/// The value being assigned, the `1` part of `x += 1`
pub fn rhs(&self) -> &Expression {
&self.rhs
}
/// Returns a new CompoundAssignment with the given variable being assigned to
pub fn with_lhs(self, lhs: Var) -> Self {
Self { lhs, ..self }
}
/// Returns a new CompoundAssignment with the given operator used
pub fn with_compound_operator(self, compound_operator: CompoundOp) -> Self {
Self {
compound_operator,
..self
}
}
/// Returns a new CompoundAssignment with the given value being assigned
pub fn with_rhs(self, rhs: Expression) -> Self {
Self { rhs, ..self }
}
}
/// An if statement
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(
fmt = "{}{}{}{}{}{}{}",
"if_token",
"condition",
"then_token",
"if_expression",
"display_option(else_if_expressions.as_ref().map(join_vec))",
"else_token",
"else_expression"
)]
pub struct IfExpression {
pub(crate) if_token: TokenReference,
pub(crate) condition: Box<Expression>,
pub(crate) then_token: TokenReference,
pub(crate) if_expression: Box<Expression>,
pub(crate) else_if_expressions: Option<Vec<ElseIfExpression>>,
pub(crate) else_token: TokenReference,
pub(crate) else_expression: Box<Expression>,
}
impl IfExpression {
/// Creates a new If from the given condition
pub fn new(
condition: Expression,
if_expression: Expression,
else_expression: Expression,
) -> Self {
Self {
if_token: TokenReference::symbol("if ").unwrap(),
condition: Box::new(condition),
then_token: TokenReference::symbol(" then").unwrap(),
if_expression: Box::new(if_expression),
else_if_expressions: None,
else_token: TokenReference::symbol(" else ").unwrap(),
else_expression: Box::new(else_expression),
}
}
/// The `if` token
pub fn if_token(&self) -> &TokenReference {
&self.if_token
}
/// The condition of the if expression, `condition` in `if condition then`
pub fn condition(&self) -> &Expression {
&self.condition
}
/// The `then` token
pub fn then_token(&self) -> &TokenReference {
&self.then_token
}
/// The expression evaluated if the initial if condition holds
pub fn if_expression(&self) -> &Expression {
&self.if_expression
}
/// The `else` token
pub fn else_token(&self) -> &TokenReference {
&self.else_token
}
/// If there are `elseif` conditions, returns a vector of them
// TODO: Make this return an iterator, and remove Option part entirely?
pub fn else_if_expressions(&self) -> Option<&Vec<ElseIfExpression>> {
self.else_if_expressions.as_ref()
}
/// The else expression if all other conditions do not hold
pub fn else_expression(&self) -> &Expression {
&self.else_expression
}
/// Returns a new IfExpression with the given `if` token
pub fn with_if_token(self, if_token: TokenReference) -> Self {
Self { if_token, ..self }
}
/// Returns a new IfExpression with the given condition
pub fn with_condition(self, condition: Expression) -> Self {
Self {
condition: Box::new(condition),
..self
}
}
/// Returns a new IfExpression with the given `then` token
pub fn with_then_token(self, then_token: TokenReference) -> Self {
Self { then_token, ..self }
}
/// Returns a new IfExpression with the given if expression
pub fn with_if_expression(self, if_expression: Expression) -> Self {
Self {
if_expression: Box::new(if_expression),
..self
}
}
/// Returns a new If with the given list of `elseif` expressions
pub fn with_else_if(self, else_if_expressions: Option<Vec<ElseIfExpression>>) -> Self {
Self {
else_if_expressions,
..self
}
}
/// Returns a new IfExpression with the given `else` token
pub fn with_else_token(self, else_token: TokenReference) -> Self {
Self { else_token, ..self }
}
/// Returns a new IfExpression with the given `else` expression
pub fn with_else(self, else_expression: Expression) -> Self {
Self {
else_expression: Box::new(else_expression),
..self
}
}
}
/// An elseif expression in a bigger [`IfExpression`] expression
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{else_if_token}{condition}{then_token}{expression}")]
pub struct ElseIfExpression {
pub(crate) else_if_token: TokenReference,
pub(crate) condition: Expression,
pub(crate) then_token: TokenReference,
pub(crate) expression: Expression,
}
impl ElseIfExpression {
/// Creates a new ElseIf from the given condition
pub fn new(condition: Expression, expression: Expression) -> Self {
Self {
else_if_token: TokenReference::symbol(" elseif ").unwrap(),
condition,
then_token: TokenReference::symbol(" then ").unwrap(),
expression,
}
}
/// The `elseif` token
pub fn else_if_token(&self) -> &TokenReference {
&self.else_if_token
}
/// The condition of the `elseif`, `condition` in `elseif condition then`
pub fn condition(&self) -> &Expression {
&self.condition
}
/// The `then` token
pub fn then_token(&self) -> &TokenReference {
&self.then_token
}
/// The evaluated expression of the `elseif` when condition is true
pub fn expression(&self) -> &Expression {
&self.expression
}
/// Returns a new ElseIfExpression with the given `elseif` token
pub fn with_else_if_token(self, else_if_token: TokenReference) -> Self {
Self {
else_if_token,
..self
}
}
/// Returns a new ElseIfExpression with the given condition
pub fn with_condition(self, condition: Expression) -> Self {
Self { condition, ..self }
}
/// Returns a new ElseIfExpression with the given `then` token
pub fn with_then_token(self, then_token: TokenReference) -> Self {
Self { then_token, ..self }
}
/// Returns a new ElseIfExpression with the given expression
pub fn with_block(self, expression: Expression) -> Self {
Self { expression, ..self }
}
}
/// An interpolated string, such as `` `hello, {"world"}!` ``.
/// "segments", made up of [`InterpolatedStringSegment`]s, is each part of the string,
/// up until the `last_string`.
/// The number of segments is the number of expressions used.
/// For example, `` `1{2}3` `` would have one segment, with literal "1" (marked with a
/// [`TokenType`](crate::tokenizer::TokenType) of `InterpolatedString { token: "1", kind: InterpolatedStringKind::Begin }`),
/// and the expression `2`.
/// The `last_string` would be the literal 3, with a backtick afterwards.
#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{}{}", "join_vec(segments)", "last_string")]
pub struct InterpolatedString {
pub(crate) segments: Vec<InterpolatedStringSegment>,
pub(crate) last_string: TokenReference,
}
impl InterpolatedString {
/// Creates a new InterpolatedString from the given segments and last string
pub fn new(segments: Vec<InterpolatedStringSegment>, last_string: TokenReference) -> Self {
Self {
segments,
last_string,
}
}
/// The segments of the interpolated string
pub fn segments(&self) -> impl Iterator<Item = &InterpolatedStringSegment> {
self.segments.iter()
}
/// The last string of the interpolated string
pub fn last_string(&self) -> &TokenReference {
&self.last_string
}
/// Returns just the expressions
pub fn expressions(&self) -> impl Iterator<Item = &Expression> {
ExpressionsIterator {
segments: &self.segments,
index: 0,
}
}
/// Returns a new InterpolatedString with the given segments
pub fn with_segments(self, segments: Vec<InterpolatedStringSegment>) -> Self {
Self { segments, ..self }
}
/// Returns a new InterpolatedString with the given last string
pub fn with_last_string(self, last_string: TokenReference) -> Self {
Self {
last_string,
..self
}
}
}
/// Segments of an interpolated string, as seen in [`InterpolatedString`].
/// Read the documentation for [`InterpolatedString`] for more information.
#[derive(Clone, Debug, Display, PartialEq, Node)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[display(fmt = "{literal}{expression}")]
pub struct InterpolatedStringSegment {
/// The literal part of the segment. Guaranteed to be of TokenType::InterpolatedString
pub literal: TokenReference,
/// The expression being formatted
pub expression: Expression,
}
impl Visit for InterpolatedStringSegment {
fn visit<V: crate::visitors::Visitor>(&self, visitor: &mut V) {
self.literal.visit(visitor);
self.expression.visit(visitor);
}
}
impl VisitMut for InterpolatedStringSegment {
fn visit_mut<V: crate::visitors::VisitorMut>(self, visitor: &mut V) -> Self {
Self {
literal: self.literal.visit_mut(visitor),
expression: self.expression.visit_mut(visitor),
}
}
}
struct ExpressionsIterator<'a> {
segments: &'a [InterpolatedStringSegment],
index: usize,
}
impl<'a> Iterator for ExpressionsIterator<'a> {
type Item = &'a Expression;
fn next(&mut self) -> Option<Self::Item> {
if self.index >= self.segments.len() {
return None;
}
let segment = &self.segments[self.index];
self.index += 1;
Some(&segment.expression)
}
}