Skip to content

Commit

Permalink
Update compiler plugin readme
Browse files Browse the repository at this point in the history
  • Loading branch information
robflop committed Aug 14, 2024
1 parent 2db69ba commit 3d603af
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions Modules/LoRe Compiler Plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,31 @@ For more information on the sbt-dotty plugin, see the
- Arithmetic operators `+`, `-`, `/`, `*` and parentheses on integers
- String literals without operations (e.g. "foo")
- The unary operator `!` (negation) and the binary operators `&&`, `||` as well as `<`, `>`, `<=`, `>=`, `==` and `!=`
- Type instantiations e.g. List, Map (i.e. "Foo(bar)" where Foo is a type)
- The arrow syntax for Map tuples (i.e. foo -> bar) is not supported, but normal tuples (foo, bar) are
- Arrow (anonymous) functions
- Tuples
- Definitions of Sources using all of the above as input values

## (LoRe) Syntax not supported yet (non-exhaustive)

- Definitions of Derived instances
- Definitions of Interaction instances
- "requires", "modifies" and "executes" method calls
- Function calls
- Field calls (normal and curly braces)

## (LoRe) Syntax not supported yet (non-exhaustive)

- Parentheses (?)
- Sequences
- Arrow (anonymous) functions
- Type Aliases
- Asserts and Assumes (Viper)
- Invariants
- If-Clauses
- Tuples
- Implication and Bi-Implication operators
- In-Set operator
- Quantification operators (Existential and Universal)

## Examples

- The `sourceExamples` file contains around 50 example definitions using various syntax with Sources across integers, strings and booleans
- The `derivedExamples` file contains around 17 example definitions for function/method/property calls and Derived instantiations
- The `interactionExamples` file contains around 14 definitions for types (List, Map), arrow functions, and Interactions with various method calls on them

0 comments on commit 3d603af

Please sign in to comment.