Compare commits

..

33 Commits

Author SHA1 Message Date
Martino Ferrari
0cbbf5939a Implemented operators and better indexing 2026-01-30 00:49:42 +01:00
Martino Ferrari
ecc7039306 Improved scoping 2026-01-29 23:03:46 +01:00
Martino Ferrari
2fd6d3d096 added hover doc to variable 2026-01-29 15:55:28 +01:00
Martino Ferrari
2e25c8ff11 adding referencing of variables 2026-01-29 15:50:37 +01:00
Martino Ferrari
8be139ab27 Implemented regex validation for variables 2026-01-29 15:38:10 +01:00
Martino Ferrari
cb79d490e7 Initial support to variables and to producer/consumer logic 2026-01-28 18:25:48 +01:00
Martino Ferrari
b8d45f276d initial working on variables and consumer/producer logic 2026-01-28 17:59:29 +01:00
Martino Ferrari
03fe7d33b0 added variables and producer check 2026-01-28 17:50:49 +01:00
Martino Ferrari
8811ac9273 improved gitignore 2026-01-28 13:46:30 +01:00
Martino Ferrari
71c86f1dcb removed examples 2026-01-28 13:44:15 +01:00
Martino Ferrari
ab22a939d7 improved init 2026-01-28 13:44:05 +01:00
Martino Ferrari
01bcd66594 Improving CLI tool and improving documentation 2026-01-28 13:32:32 +01:00
Martino Ferrari
31996ae710 minor improvement on the cue schema validator 2026-01-28 01:18:26 +01:00
Martino Ferrari
776b1fddc3 removed project node from output 2026-01-28 01:18:09 +01:00
Martino Ferrari
597fd3eddf improved sdnpublisher schema 2026-01-28 00:07:10 +01:00
Martino Ferrari
6781d50ee4 Minor changes 2026-01-27 15:39:25 +01:00
Martino Ferrari
1d7dc665d6 More tests on AST 2026-01-27 15:31:01 +01:00
Martino Ferrari
4ea406a17b more tests 2026-01-27 15:27:34 +01:00
Martino Ferrari
fed39467fd improved doc and tests 2026-01-27 15:19:49 +01:00
Martino Ferrari
15afdc91f4 Improved performances and hover 2026-01-27 15:14:47 +01:00
Martino Ferrari
213fc81cfb Improving LSP 2026-01-27 14:42:46 +01:00
Martino Ferrari
71a3c40108 Better LSP error handling 2026-01-27 08:58:38 +01:00
Martino Ferrari
aedc715ef3 Better code 2026-01-27 00:04:36 +01:00
Martino Ferrari
73cfc43f4b Updated readme. 2026-01-26 23:27:01 +01:00
Martino Ferrari
599beb6f4f updated license 2026-01-26 14:25:47 +01:00
Martino Ferrari
30a105df63 updated readme 2026-01-26 14:24:36 +01:00
Martino Ferrari
04196d8a1f Implement better completion 2026-01-25 15:21:38 +01:00
Martino Ferrari
02274f1bbf Implemented suggestion / autocompletion for signal in GAM 2026-01-25 00:28:50 +01:00
Martino Ferrari
12ed4cfbd2 reverse symbol renaming for signals 2026-01-25 00:18:40 +01:00
Martino Ferrari
bbeb344d19 Improved indexing, hover documentation and implemente renaming 2026-01-25 00:13:07 +01:00
Martino Ferrari
eeb4f5da2e added gam referencing 2026-01-24 23:47:59 +01:00
Martino Ferrari
8e13020d50 better signal hover message 2026-01-24 21:37:08 +01:00
Martino Ferrari
c9cc67f663 Minimal changes 2026-01-24 15:33:23 +01:00
63 changed files with 5337 additions and 6672 deletions

32
.gitignore vendored
View File

@@ -1,4 +1,30 @@
build
*.log
mdt
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
# Test binary, built with `go test -c`
*.test
# Code coverage profiles and other test artifacts
*.out
coverage.*
*.coverprofile
profile.cov
# Dependency directories (remove the comment below to include it)
# vendor/
# Go workspace file
go.work
go.work.sum
# env file
.env
# build folder
build
# log output
*.log

View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2026 MARTe Community
Copyright (c) 2026 Martino G. Ferrari <manda.mgf@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@@ -1,9 +1,9 @@
BINARY_NAME=mdt
BUILD_DIR=build
.PHONY: all build test coverage clean install
.PHONY: all build test coverage clean install vet fmt
all: test build
all: vet test build
build:
mkdir -p $(BUILD_DIR)
@@ -16,6 +16,12 @@ coverage:
go test -cover -coverprofile=coverage.out ./test/... -coverpkg=./internal/...
go tool cover -func=coverage.out
vet:
go vet ./...
fmt:
go fmt ./...
clean:
rm -rf $(BUILD_DIR)
rm -f coverage.out

View File

@@ -4,11 +4,29 @@
## Features
- **Portability**: A single statically compiled executable compatible with any Linux 3.2+ machine (as well as possible to compile and run on Windows and Mac OS X)
- **LSP Server**: Real-time syntax checking, validation, autocomplete, hover documentation, and navigation (Go to Definition/References).
- **Builder**: Merges multiple configuration files into a single, ordered output file.
- **Formatter**: Standardizes configuration file formatting.
- **Validator**: Advanced semantic validation using [CUE](https://cuelang.org/) schemas, ensuring type safety and structural correctness.
### MARTe extended configuration language
Few additional features have been added to the standard MARTe configuration language:
- Multi file configuration support
- Multi file definition merging
- File level namespace / node
- Doc-strings support
- Pragmas for warning suppression / documentation
## Documentation
- [Step-by-Step Tutorial](docs/TUTORIAL.md)
- [Editor Integration Guide](docs/EDITOR_INTEGRATION.md)
- [Configuration Guide](docs/CONFIGURATION_GUIDE.md)
- [Examples Readme](/examples/README.md)
## Installation
### From Source
@@ -23,13 +41,17 @@ go install github.com/marte-community/marte-dev-tools/cmd/mdt@latest
### CLI Commands
- **Init**: Initialize a MARTe project.
```bash
mdt init project_name
```
- **Check**: Run validation on a file or project.
```bash
mdt check path/to/project
```
- **Build**: Merge project files into a single output.
```bash
mdt build -o output.marte main.marte
mdt build [-o output.marte] main.marte ...
```
- **Format**: Format configuration files.
```bash
@@ -47,6 +69,7 @@ go install github.com/marte-community/marte-dev-tools/cmd/mdt@latest
## MARTe Configuration
The tools support the MARTe configuration format with extended features:
- **Objects**: `+Node = { Class = ... }`
- **Signals**: `Signal = { Type = ... }`
- **Namespaces**: `#package PROJECT.NODE` for organizing multi-file projects.
@@ -59,11 +82,16 @@ Validation is fully schema-driven using CUE.
- **Custom Schema**: Add a `.marte_schema.cue` file to your project root to extend or override definitions.
**Example `.marte_schema.cue`:**
```cue
package schema
#Classes: {
MyCustomGAM: {
#meta: {
direction: "INOUT"
multithreaded: true
}
Param1: int
Param2?: string
...
@@ -75,22 +103,25 @@ package schema
Use comments starting with `//!` to control validation behavior:
- `//!unused: Reason` - Suppress "Unused GAM" or "Unused Signal" warnings.
- `//!implicit: Reason` - Suppress "Implicitly Defined Signal" warnings.
- `//!cast(DefinedType, UsageType)` - Allow type mismatch between definition and usage (e.g. `//!cast(uint32, int32)`).
- `//!allow(unused)` - Global suppression for the file.
- `//! unused: Reason` - Suppress "Unused GAM" or "Unused Signal" warnings.
- `//! implicit: Reason` - Suppress "Implicitly Defined Signal" warnings.
- `//! cast(DefinedType, UsageType)` - Allow type mismatch between definition and usage (e.g. `//!cast(uint32, int32)`).
- `//! allow(unused)` - Global suppression for the file.
## Development
### Building
```bash
go build ./cmd/mdt
```
### Running Tests
```bash
go test ./...
```
## License
MIT

View File

@@ -3,6 +3,8 @@ package main
import (
"bytes"
"os"
"path/filepath"
"strings"
"github.com/marte-community/marte-dev-tools/internal/builder"
"github.com/marte-community/marte-dev-tools/internal/formatter"
@@ -16,7 +18,7 @@ import (
func main() {
if len(os.Args) < 2 {
logger.Println("Usage: mdt <command> [arguments]")
logger.Println("Commands: lsp, build, check, fmt")
logger.Println("Commands: lsp, build, check, fmt, init")
os.Exit(1)
}
@@ -30,6 +32,8 @@ func main() {
runCheck(os.Args[2:])
case "fmt":
runFmt(os.Args[2:])
case "init":
runInit(os.Args[2:])
default:
logger.Printf("Unknown command: %s\n", command)
os.Exit(1)
@@ -41,13 +45,47 @@ func runLSP() {
}
func runBuild(args []string) {
if len(args) < 1 {
logger.Println("Usage: mdt build <input_files...>")
files := []string{}
overrides := make(map[string]string)
outputFile := ""
for i := 0; i < len(args); i++ {
arg := args[i]
if strings.HasPrefix(arg, "-v") {
pair := arg[2:]
parts := strings.SplitN(pair, "=", 2)
if len(parts) == 2 {
overrides[parts[0]] = parts[1]
}
} else if arg == "-o" {
if i+1 < len(args) {
outputFile = args[i+1]
i++
}
} else {
files = append(files, arg)
}
}
if len(files) < 1 {
logger.Println("Usage: mdt build [-o output] [-vVAR=VAL] <input_files...>")
os.Exit(1)
}
b := builder.NewBuilder(args)
err := b.Build(os.Stdout)
b := builder.NewBuilder(files, overrides)
var out *os.File = os.Stdout
if outputFile != "" {
f, err := os.Create(outputFile)
if err != nil {
logger.Printf("Error creating output file: %v\n", err)
os.Exit(1)
}
defer f.Close()
out = f
}
err := b.Build(out)
if err != nil {
logger.Printf("Build failed: %v\n", err)
os.Exit(1)
@@ -61,7 +99,6 @@ func runCheck(args []string) {
}
tree := index.NewProjectTree()
// configs := make(map[string]*parser.Configuration) // We don't strictly need this map if we just build the tree
for _, file := range args {
content, err := os.ReadFile(file)
@@ -80,14 +117,9 @@ func runCheck(args []string) {
tree.AddFile(file, config)
}
// idx.ResolveReferences() // Not implemented in new tree yet, but Validator uses Tree directly
v := validator.NewValidator(tree, ".")
v.ValidateProject()
// Legacy loop removed as ValidateProject covers it via recursion
v.CheckUnused()
for _, diag := range v.Diagnostics {
level := "ERROR"
if diag.Level == validator.LevelWarning {
@@ -134,3 +166,70 @@ func runFmt(args []string) {
logger.Printf("Formatted %s\n", file)
}
}
func runInit(args []string) {
if len(args) < 1 {
logger.Println("Usage: mdt init <project_name>")
os.Exit(1)
}
projectName := args[0]
if err := os.MkdirAll(filepath.Join(projectName, "src"), 0755); err != nil {
logger.Fatalf("Error creating project directories: %v", err)
}
files := map[string]string{
"Makefile": `MDT=mdt
all: check build
check:
$(MDT) check src/*.marte
build:
$(MDT) build -o app.marte src/*.marte
fmt:
$(MDT) fmt src/*.marte
`,
".marte_schema.cue": `package schema
#Classes: {
// Add your project-specific classes here
}
`,
"src/app.marte": `#package App
+Main = {
Class = RealTimeApplication
+States = {
Class = ReferenceContainer
+Run = {
Class = RealTimeState
+MainThread = {
Class = RealTimeThread
Functions = {}
}
}
}
+Data = {
Class = ReferenceContainer
}
}
`,
"src/components.marte": `#package App.Data
// Define your DataSources here
`,
}
for path, content := range files {
fullPath := filepath.Join(projectName, path)
if err := os.WriteFile(fullPath, []byte(content), 0644); err != nil {
logger.Fatalf("Error creating file %s: %v", fullPath, err)
}
logger.Printf("Created %s\n", fullPath)
}
logger.Printf("Project '%s' initialized successfully.\n", projectName)
}

116
docs/CODE_DOCUMENTATION.md Normal file
View File

@@ -0,0 +1,116 @@
# mdt Internal Code Documentation
This document provides a detailed overview of the `mdt` codebase architecture and internal components.
## Architecture Overview
`mdt` is built as a modular system where core functionalities are separated into internal packages. The data flow typically follows this pattern:
1. **Parsing**: Source code is parsed into an Abstract Syntax Tree (AST).
2. **Indexing**: ASTs from multiple files are aggregated into a unified `ProjectTree`.
3. **Processing**: The `ProjectTree` is used by the Validator, Builder, and LSP server to perform their respective tasks.
## Package Structure
```
cmd/
mdt/ # Application entry point (CLI)
internal/
builder/ # Logic for merging and building configurations
formatter/ # Code formatting engine
index/ # Symbol table and project structure management
logger/ # Centralized logging
lsp/ # Language Server Protocol implementation
parser/ # Lexer, Parser, and AST definitions
schema/ # CUE schema loading and integration
validator/ # Semantic analysis and validation logic
```
## Core Packages
### 1. `internal/parser`
Responsible for converting MARTe configuration text into structured data.
* **Lexer (`lexer.go`)**: Tokenizes the input stream. Handles MARTe specific syntax like `#package`, `//!` pragmas, and `//#` docstrings. Supports standard identifiers and `#`-prefixed identifiers.
* **Parser (`parser.go`)**: Recursive descent parser. Converts tokens into a `Configuration` object containing definitions, comments, and pragmas.
* **AST (`ast.go`)**: Defines the node types (`ObjectNode`, `Field`, `Value`, `VariableDefinition`, etc.). All nodes implement the `Node` interface providing position information.
### 2. `internal/index`
The brain of the system. It maintains a holistic view of the project.
* **ProjectTree**: The central data structure. It holds the root of the configuration hierarchy (`Root`), references, and isolated files.
* **ProjectNode**: Represents a logical node in the configuration. Since a node can be defined across multiple files (fragments), `ProjectNode` aggregates these fragments. It also stores locally defined variables in its `Variables` map.
* **NodeMap**: A hash map index (`map[string][]*ProjectNode`) for $O(1)$ symbol lookups, optimizing `FindNode` operations.
* **Reference Resolution**: The `ResolveReferences` method links `Reference` objects to their target `ProjectNode` or `VariableDefinition`. It uses `resolveScopedName` to respect lexical scoping rules, searching up the hierarchy from the reference's container.
### 3. `internal/validator`
Ensures configuration correctness.
* **Validator**: Iterates over the `ProjectTree` to check rules.
* **Checks**:
* **Structure**: Duplicate fields, invalid content.
* **Schema**: Unifies nodes with CUE schemas (loaded via `internal/schema`) to validate types and mandatory fields.
* **Signals**: Verifies that signals referenced in GAMs exist in DataSources and match types.
* **Threading**: Checks `CheckDataSourceThreading` to ensure non-multithreaded DataSources are not shared across threads in the same state.
* **Ordering**: `CheckINOUTOrdering` verifies that for `INOUT` signals, the producing GAM appears before the consuming GAM in the thread's execution list.
* **Variables**: `CheckVariables` validates variable values against their defined CUE types (e.g. `uint`, regex). `CheckUnresolvedVariables` ensures all used variables are defined.
* **Unused**: Detects unused GAMs and Signals (suppressible via pragmas).
### 4. `internal/lsp`
Implements the Language Server Protocol.
* **Server (`server.go`)**: Handles JSON-RPC messages over stdio.
* **Incremental Sync**: Supports `textDocumentSync: 2`. `HandleDidChange` applies patches to the in-memory document buffers using `offsetAt` logic.
* **Features**:
* `HandleCompletion`: Context-aware suggestions (Schema fields, Signal references, Class names).
* `HandleHover`: Shows documentation, signal types, and usage analysis (e.g., "Used in GAMs: Controller (Input)").
* `HandleDefinition` / `HandleReferences`: specific lookup using the `index`.
### 5. `internal/builder`
Merges multiple MARTe files into a single output.
* **Logic**: It parses all input files, builds a temporary `ProjectTree`, and then reconstructs the source code.
* **Merging**: It interleaves fields and subnodes from different file fragments to produce a coherent single-file configuration, respecting the `#package` hierarchy.
### 6. `internal/schema`
Manages CUE schemas.
* **Loading**: Loads the embedded default schema (`marte.cue`) and merges it with any user-provided `.marte_schema.cue`.
* **Metadata**: Handles the `#meta` field in schemas to extract properties like `direction` and `multithreaded` support for the validator.
## Key Data Flows
### Reference Resolution
1. **Scan**: Files are parsed and added to the `ProjectTree`.
2. **Index**: `RebuildIndex` populates `NodeMap`.
3. **Resolve**: `ResolveReferences` iterates all recorded references (values) and calls `FindNode`.
4. **Link**: If found, `ref.Target` is set to the `ProjectNode`.
### Validation Lifecycle
1. `mdt check` or LSP `didChange` triggers validation.
2. A new `Validator` is created with the current `Tree`.
3. `ValidateProject` is called.
4. It walks the tree, runs checks, and populates `Diagnostics`.
5. Diagnostics are printed (CLI) or published via `textDocument/publishDiagnostics` (LSP).
### Threading Check Logic
1. Finds the `RealTimeApplication` node.
2. Iterates through `States` and `Threads`.
3. For each Thread, resolves the `Functions` (GAMs).
4. For each GAM, resolves connected `DataSources` via Input/Output signals.
5. Maps `DataSource -> Thread` within the context of a State.
6. If a DataSource is seen in >1 Thread, it checks the `#meta.multithreaded` property. If false (default), an error is raised.
### INOUT Ordering Logic
1. Iterates Threads.
2. Iterates GAMs in execution order.
3. Tracks `producedSignals` and `consumedSignals`.
4. For each GAM, checks Inputs. If Input is `INOUT` (and not multithreaded) and not in `producedSignals`, reports "Consumed before Produced" error.
5. Registers Outputs in `producedSignals`.
6. At end of thread, checks for signals that were produced but never consumed, reporting a warning.

199
docs/CONFIGURATION_GUIDE.md Normal file
View File

@@ -0,0 +1,199 @@
# MARTe Configuration Guide
This guide explains the syntax, features, and best practices for writing MARTe configurations using `mdt`.
## 1. Syntax Overview
MARTe configurations use a hierarchical object-oriented syntax.
### Objects (Nodes)
Objects are defined using `+` (public/instantiated) or `$` (template/class-like) prefixes. Every object **must** have a `Class` field.
```marte
+MyObject = {
Class = MyClass
Field1 = 100
Field2 = "Hello"
}
```
### Fields and Values
- **Fields**: Alphanumeric identifiers (e.g., `Timeout`, `CycleTime`).
- **Values**:
- Integers: `10`, `-5`, `0xFA`
- Floats: `3.14`, `1e-3`
- Strings: `"Text"`
- Booleans: `true`, `false`
- References: `MyObject`, `MyObject.SubNode`
- Arrays: `{ 1 2 3 }` or `{ "A" "B" }`
### Comments and Documentation
- Line comments: `// This is a comment`
- Docstrings: `//# This documents the following node`. These appear in hover tooltips.
```marte
//# This is the main application
+App = { ... }
```
## 2. Signals and Data Flow
Signals define how data moves between DataSources (drivers) and GAMs (algorithms).
### Defining Signals
Signals are typically defined in a `DataSource`. They must have a `Type`.
```marte
+MyDataSource = {
Class = GAMDataSource
Signals = {
Signal1 = { Type = uint32 }
Signal2 = { Type = float32 }
}
}
```
### Using Signals in GAMs
GAMs declare inputs and outputs. You can refer to signals directly or alias them.
```marte
+MyGAM = {
Class = IOGAM
InputSignals = {
Signal1 = {
DataSource = MyDataSource
Type = uint32 // Must match DataSource definition
}
MyAlias = {
Alias = Signal2
DataSource = MyDataSource
Type = float32
}
}
}
```
### Threading Rules
**Validation Rule**: A DataSource that is **not** marked as multithreaded (default) cannot be used by GAMs running in different threads within the same State.
**Ordering Rule**: For `INOUT` signals (data dependency within a thread), the Producer GAM must appear **before** the Consumer GAM in the thread's `Functions` list. This ensures correct data flow within the cycle. This rule is skipped if the DataSource is marked as `multithreaded: true`.
To allow sharing, the DataSource class in the schema must have `#meta: multithreaded: true`.
## 3. Schemas and Validation
`mdt` validates your configuration against CUE schemas.
### Built-in Schema
Common classes (`RealTimeApplication`, `StateMachine`, `IOGAM`, etc.) are built-in.
### Custom Schemas
You can extend the schema by creating a `.marte_schema.cue` file in your project root.
**Example: Adding a custom GAM**
```cue
package schema
#Classes: {
MyCustomGAM: {
// Metadata for Validator/LSP
#meta: {
direction: "INOUT" // "IN", "OUT", "INOUT"
multithreaded: false
}
// Fields
Gain: float
Offset?: float // Optional
InputSignals: {...}
OutputSignals: {...}
}
}
```
## 4. Multi-file Projects
You can split your configuration into multiple files.
### Namespaces
Use `#package` to define where the file's content fits in the hierarchy.
**file1.marte**
```marte
#package MyApp.Controller
+MyController = { ... }
```
This places `MyController` under `MyApp.Controller`.
### Building
The `build` command merges all files.
```bash
mdt build -o final.marte src/*.marte
```
## 5. Pragmas (Suppressing Warnings)
If validation is too strict, you can suppress warnings using pragmas (`//!`).
- **Suppress Unused Warning**:
```marte
+MyGAM = {
Class = IOGAM
//! ignore(unused): This GAM is triggered externally
}
```
- **Suppress Implicit Signal Warning**:
```marte
InputSignals = {
//! ignore(implicit)
ImplicitSig = { Type = uint32 }
}
```
- **Type Casting**:
```marte
Sig1 = {
//! cast(uint32, int32): Intentional mismatch
DataSource = DS
Type = int32
}
```
## 6. Variables
You can define variables using `#var`. The type expression supports CUE syntax.
```marte
#var MyVar: uint32 = 100
#var Env: "PROD" | "DEV" = "DEV"
```
### Usage
Reference a variable using `$`:
```marte
Field = $MyVar
```
### Expressions
You can use operators in field values. Supported operators:
- **Math**: `+`, `-`, `*`, `/`, `%`, `^` (XOR), `&`, `|` (Bitwise)
- **String Concatenation**: `..`
```marte
Field1 = 10 + 20 * 2 // 50
Field2 = "Hello " .. "World"
Field3 = $MyVar + 5
```
### Build Override
You can override variable values during build:
```bash
mdt build -vMyVar=200 -vEnv="PROD" src/*.marte
```

158
docs/EDITOR_INTEGRATION.md Normal file
View File

@@ -0,0 +1,158 @@
# Editor Integration Guide
`mdt` includes a Language Server Protocol (LSP) implementation that provides features like:
- Syntax highlighting and error reporting
- Auto-completion
- Go to Definition / References
- Hover documentation
- Symbol renaming
The LSP server is started via the command:
```bash
mdt lsp
```
It communicates via **stdio**.
## VS Code
You can use a generic LSP extension like [Generic LSP Client](https://marketplace.visualstudio.com/items?itemName=summne.vscode-generic-lsp-client) or configure a custom task.
**Using "Run on Save" or similar extensions is an option, but for true LSP support:**
1. Install the **"glspc"** (Generic LSP Client) extension or similar.
2. Configure it in your `settings.json`:
```json
"glspc.languageServer configurations": [
{
"languageId": "marte",
"command": "mdt",
"args": ["lsp"],
"rootUri": "${workspaceFolder}"
}
]
```
3. Associate `.marte` files with the language ID:
```json
"files.associations": {
"*.marte": "marte"
}
```
## Neovim (Native LSP)
Add the following to your `init.lua` or `init.vim` (using `nvim-lspconfig`):
```lua
local lspconfig = require'lspconfig'
local configs = require'lspconfig.configs'
if not configs.marte then
configs.marte = {
default_config = {
cmd = {'mdt', 'lsp'},
filetypes = {'marte'},
root_dir = lspconfig.util.root_pattern('.git', 'go.mod', '.marte_schema.cue'),
settings = {},
},
}
end
lspconfig.marte.setup{}
-- Add filetype detection
vim.cmd([[
autocmd BufNewFile,BufRead *.marte setfiletype marte
]])
```
## Helix
Add this to your `languages.toml` (usually in `~/.config/helix/languages.toml`):
```toml
[[language]]
name = "marte"
scope = "source.marte"
injection-regex = "marte"
file-types = ["marte"]
roots = [".git", ".marte_schema.cue"]
comment-token = "//"
indent = { tab-width = 2, unit = " " }
language-servers = [ "mdt-lsp" ]
[language-server.mdt-lsp]
command = "mdt"
args = ["lsp"]
```
## Vim
### Using `vim-lsp`
```vim
if executable('mdt')
au User lsp_setup call lsp#register_server({
\ 'name': 'mdt-lsp',
\ 'cmd': {server_info->['mdt', 'lsp']},
\ 'whitelist': ['marte'],
\ })
endif
au BufRead,BufNewFile *.marte set filetype=marte
```
### Using `ALE`
```vim
call ale#linter#define('marte', {
\ 'name': 'mdt',
\ 'lsp': 'stdio',
\ 'executable': 'mdt',
\ 'command': '%e lsp',
\ 'project_root': function('ale#handlers#python#FindProjectRoot'),
\})
```
## Zed
Add to your `settings.json`:
```json
"lsp": {
"marte": {
"binary": {
"path": "mdt",
"arguments": ["lsp"]
}
}
}
```
## Kakoune (kak-lsp)
In your `kak-lsp.toml`:
```toml
[language.marte]
filetypes = ["marte"]
roots = [".git", ".marte_schema.cue"]
command = "mdt"
args = ["lsp"]
```
## Eclipse
1. Install **LSP4E** plugin.
2. Go to **Preferences > Language Servers**.
3. Add a new Language Server:
- **Content Type**: Text / Custom (Associate `*.marte` with a content type).
- **Launch configuration**: Program.
- **Command**: `mdt`
- **Arguments**: `lsp`
- **Input/Output**: Standard Input/Output.

173
docs/TUTORIAL.md Normal file
View File

@@ -0,0 +1,173 @@
# Creating a MARTe Application with mdt
This tutorial will guide you through creating, building, and validating a complete MARTe application using the `mdt` toolset.
## Prerequisites
- `mdt` installed and available in your PATH.
- `make` (optional but recommended).
## Step 1: Initialize the Project
Start by creating a new project named `MyControlApp`.
```bash
mdt init MyControlApp
cd MyControlApp
```
This command creates a standard project structure:
- `Makefile`: For building and checking the project.
- `.marte_schema.cue`: For defining custom schemas (if needed).
- `src/app.marte`: The main application definition.
- `src/components.marte`: A placeholder for defining components (DataSources).
## Step 2: Define Components
Open `src/components.marte`. This file uses the `#package App.Data` namespace, meaning all definitions here will be children of `App.Data`.
Let's define a **Timer** (input source) and a **Logger** (output destination).
```marte
#package MyContollApp.App.Data
+DDB = {
Class = GAMDataSource
}
+TimingDataSource = {
Class = TimingDataSource
}
+Timer = {
Class = LinuxTimer
Signals = {
Counter = {
Type = uint32
}
Time = {
Type = uint32
}
}
}
+Logger = {
Class = LoggerDataSource
Signals = {
LogValue = {
Type = float32
}
}
}
```
## Step 3: Implement Logic (GAM)
Open `src/app.marte`. This file defines the `App` node.
We will add a GAM that takes the time from the Timer, converts it, and logs it.
Add the GAM definition inside the `+Main` object (or as a separate object if you prefer modularity). Let's modify `src/app.marte`:
```marte
#package MyContollApp
+App = {
Class = RealTimeApplication
+Functions = {
Class = RefenceContainer
// Define the GAM
+Converter = {
Class = IOGAM
InputSignals = {
TimeIn = {
DataSource = Timer
Type = uint32
Frequency = 100 //Hz
Alias = Time // Refers to 'Time' signal in Timer
}
}
OutputSignals = {
LogOut = {
DataSource = Logger
Type = float32
Alias = LogValue
}
}
}
}
+States = {
Class = ReferenceContainer
+Run = {
Class = RealTimeState
+MainThread = {
Class = RealTimeThread
Functions = { Converter } // Run our GAM
}
}
}
+Data = {
Class = ReferenceContainer
DefaultDataSource = DDB
}
+Scheduler = {
Class = GAMScheduler
TimingDataSource = TimingDataSource
}
}
```
## Step 4: Validate
Run the validation check to ensure everything is correct (types match, references are valid).
```bash
mdt check src/*.marte
```
Or using Make:
```bash
make check
```
If you made a mistake (e.g., mismatched types), `mdt` will report an error.
## Step 5: Build
Merge all files into a single configuration file.
```bash
mdt build -o final_app.marte src/*.marte
```
Or using Make:
```bash
make build
```
This produces `app.marte` (or `final_app.marte`), which contains the flattened, merged configuration ready for the MARTe framework.
## Step 6: Advanced - Custom Schema
Suppose you want to enforce that your DataSources support multithreading. You can modify `.marte_schema.cue`.
```cue
package schema
#Classes: {
// Enforce that LinuxTimer must be multithreaded (example)
LinuxTimer: {
#meta: {
multithreaded: true
}
...
}
}
```
Now, if you use `LinuxTimer` in multiple threads, `mdt check` will allow it (because of `#meta.multithreaded: true`). By default, it would disallow it.
## Conclusion
You have successfully initialized, implemented, validated, and built a MARTe application using `mdt`.

44
examples/README.md Normal file
View File

@@ -0,0 +1,44 @@
# Examples
This directory contains example projects demonstrating different features and usage patterns of `mdt`.
## Directory Structure
```
examples/
simple/ # A basic, single-file application
complex/ # A multi-file project with custom schema
README.md # This file
```
## Running Examples
Prerequisite: `mdt` must be built (or installed). The Makefiles in the examples assume `mdt` is available at `../../build/mdt`.
### Simple Project
Demonstrates a minimal setup:
- Single `main.marte` file.
- Basic Thread and GAM definition.
**Run:**
```bash
cd simple
make check
make build
```
### Complex Project
Demonstrates advanced features:
- **Multi-file Structure**: `src/app.marte` (Logic) and `src/components.marte` (Data).
- **Namespaces**: Use of `#package` to organize nodes.
- **Custom Schema**: `.marte_schema.cue` defines a custom class (`CustomController`) with specific metadata (`#meta.multithreaded`).
- **Validation**: Enforces strict typing and custom rules.
**Run:**
```bash
cd complex
make check
make build
```

View File

@@ -0,0 +1,12 @@
package schema
#Classes: {
CustomController: {
#meta: {
multithreaded: false
}
Gain: float
InputSignals: {...}
OutputSignals: {...}
}
}

12
examples/complex/Makefile Normal file
View File

@@ -0,0 +1,12 @@
MDT=../../build/mdt
all: check build
check:
$(MDT) check src/*.marte
build:
$(MDT) build -o app_full.marte src/*.marte
fmt:
$(MDT) fmt src/*.marte

View File

@@ -0,0 +1,42 @@
#package complex_ex
+App = {
Class = RealTimeApplication
+States = {
Class = ReferenceContainer
+Run = {
Class = RealTimeState
+ControlThread = {
Class = RealTimeThread
Functions = { Controller }
}
}
}
+Functions = {
Class = ReferenceContainer
+Controller = {
Class = CustomController // Defined in .marte_schema.cue
Gain = 10.5
InputSignals = {
Ref = {
DataSource = App.Data.References
Type = float32
}
}
OutputSignals = {
Actuation = {
DataSource = App.Data.Actuators
Type = float32
}
}
}
}
+Data = {
Class = ReferenceContainer
DefaultDataSource = DDB1
}
+Scheduler = {
Class = GAMScheduler
TimingDataSource = TimingDS
}
}

View File

@@ -0,0 +1,24 @@
#package complex_ex.App.Data
+References = {
Class = GAMDataSource
Signals = {
Ref = {
Type = float32
}
}
}
+Actuators = {
Class = GAMDataSource
Signals = {
Actuation = {
Type = float32
}
}
}
+TimingDS = {
Class = TimingDataSource
}
+DDB1 = {
Class = GAMDataSource
}

View File

@@ -1,27 +0,0 @@
//!allow(unused): Ignore unused GAMs in this file
//!allow(implicit): Ignore implicit signals in this file
+Data = {
Class = ReferenceContainer
+MyDS = {
Class = FileReader
Filename = "test"
Signals = {}
}
}
+MyGAM = {
Class = IOGAM
InputSignals = {
// Implicit signal (not in MyDS)
ImplicitSig = {
DataSource = MyDS
Type = uint32
}
}
}
// Unused GAM
+UnusedGAM = {
Class = IOGAM
}

12
examples/simple/Makefile Normal file
View File

@@ -0,0 +1,12 @@
MDT=../../build/mdt
all: check build
check:
$(MDT) check main.marte
build:
$(MDT) build -o output.marte main.marte
fmt:
$(MDT) fmt main.marte

View File

@@ -0,0 +1,60 @@
//# Main Application
+App = {
Class = RealTimeApplication
+Data = {
Class = ReferenceContainer
DefaultDataSource = DDB1
+Timer = {
Class = LinuxTimer
Signals = {
Counter = {
Type = uint32
}
//! unused: Time variable is not used
Time = {
Type = uint32
}
}
}
+Logger = {
Class = LoggerDataSource
}
+DDB1 = {
Class = GAMDataSource
}
}
+States = {
Class = ReferenceContainer
+Idle = {
Class = RealTimeState
+Thread1 = {
Class = RealTimeThread
CPUs = 0x1
Functions = { MyGAM }
}
}
}
+Functions = {
Class = ReferenceContainer
+MyGAM = {
Class = IOGAM
InputSignals = {
Counter = {
DataSource = Timer
Type = uint32
Frequency = 100 //Hz
}
}
OutputSignals = {
CounterCopy = {
DataSource = Logger
Type = uint32
}
}
}
}
+Scheduler = {
Class = GAMScheduler
TimingDataSource = Timer
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -11,11 +11,13 @@ import (
)
type Builder struct {
Files []string
Files []string
Overrides map[string]string
variables map[string]parser.Value
}
func NewBuilder(files []string) *Builder {
return &Builder{Files: files}
func NewBuilder(files []string, overrides map[string]string) *Builder {
return &Builder{Files: files, Overrides: overrides, variables: make(map[string]parser.Value)}
}
func (b *Builder) Build(f *os.File) error {
@@ -56,27 +58,60 @@ func (b *Builder) Build(f *os.File) error {
tree.AddFile(file, config)
}
b.collectVariables(tree)
if expectedProject == "" {
for _, iso := range tree.IsolatedFiles {
tree.Root.Fragments = append(tree.Root.Fragments, iso.Fragments...)
for name, child := range iso.Children {
if existing, ok := tree.Root.Children[name]; ok {
b.mergeNodes(existing, child)
} else {
tree.Root.Children[name] = child
child.Parent = tree.Root
}
}
}
}
// Determine root node to print
rootNode := tree.Root
if expectedProject != "" {
if child, ok := tree.Root.Children[expectedProject]; ok {
rootNode = child
}
}
// Write entire root content (definitions and children) to the single output file
b.writeNodeContent(f, tree.Root, 0)
b.writeNodeBody(f, rootNode, 0)
return nil
}
func (b *Builder) writeNodeContent(f *os.File, node *index.ProjectNode, indent int) {
// 1. Sort Fragments: Class first
sort.SliceStable(node.Fragments, func(i, j int) bool {
return hasClass(node.Fragments[i]) && !hasClass(node.Fragments[j])
})
indentStr := strings.Repeat(" ", indent)
// If this node has a RealName (e.g. +App), we print it as an object definition
if node.RealName != "" {
fmt.Fprintf(f, "%s%s = {\n", indentStr, node.RealName)
indent++
indentStr = strings.Repeat(" ", indent)
}
b.writeNodeBody(f, node, indent)
if node.RealName != "" {
indent--
indentStr = strings.Repeat(" ", indent)
fmt.Fprintf(f, "%s}\n", indentStr)
}
}
func (b *Builder) writeNodeBody(f *os.File, node *index.ProjectNode, indent int) {
// 1. Sort Fragments: Class first
sort.SliceStable(node.Fragments, func(i, j int) bool {
return hasClass(node.Fragments[i]) && !hasClass(node.Fragments[j])
})
writtenChildren := make(map[string]bool)
// 2. Write definitions from fragments
@@ -85,6 +120,8 @@ func (b *Builder) writeNodeContent(f *os.File, node *index.ProjectNode, indent i
switch d := def.(type) {
case *parser.Field:
b.writeDefinition(f, d, indent)
case *parser.VariableDefinition:
continue
case *parser.ObjectNode:
norm := index.NormalizeName(d.Name)
if child, ok := node.Children[norm]; ok {
@@ -110,12 +147,6 @@ func (b *Builder) writeNodeContent(f *os.File, node *index.ProjectNode, indent i
child := node.Children[k]
b.writeNodeContent(f, child, indent)
}
if node.RealName != "" {
indent--
indentStr = strings.Repeat(" ", indent)
fmt.Fprintf(f, "%s}\n", indentStr)
}
}
func (b *Builder) writeDefinition(f *os.File, def parser.Definition, indent int) {
@@ -127,6 +158,7 @@ func (b *Builder) writeDefinition(f *os.File, def parser.Definition, indent int)
}
func (b *Builder) formatValue(val parser.Value) string {
val = b.evaluate(val)
switch v := val.(type) {
case *parser.StringValue:
if v.Quoted {
@@ -139,6 +171,8 @@ func (b *Builder) formatValue(val parser.Value) string {
return v.Raw
case *parser.BoolValue:
return fmt.Sprintf("%v", v.Value)
case *parser.VariableReferenceValue:
return v.Name
case *parser.ReferenceValue:
return v.Value
case *parser.ArrayValue:
@@ -152,6 +186,18 @@ func (b *Builder) formatValue(val parser.Value) string {
}
}
func (b *Builder) mergeNodes(dest, src *index.ProjectNode) {
dest.Fragments = append(dest.Fragments, src.Fragments...)
for name, child := range src.Children {
if existing, ok := dest.Children[name]; ok {
b.mergeNodes(existing, child)
} else {
dest.Children[name] = child
child.Parent = dest
}
}
}
func hasClass(frag *index.Fragment) bool {
for _, def := range frag.Definitions {
if f, ok := def.(*parser.Field); ok && f.Name == "Class" {
@@ -160,3 +206,133 @@ func hasClass(frag *index.Fragment) bool {
}
return false
}
func (b *Builder) collectVariables(tree *index.ProjectTree) {
processNode := func(n *index.ProjectNode) {
for _, frag := range n.Fragments {
for _, def := range frag.Definitions {
if vdef, ok := def.(*parser.VariableDefinition); ok {
if valStr, ok := b.Overrides[vdef.Name]; ok {
p := parser.NewParser("Temp = " + valStr)
cfg, _ := p.Parse()
if len(cfg.Definitions) > 0 {
if f, ok := cfg.Definitions[0].(*parser.Field); ok {
b.variables[vdef.Name] = f.Value
continue
}
}
}
if vdef.DefaultValue != nil {
b.variables[vdef.Name] = vdef.DefaultValue
}
}
}
}
}
tree.Walk(processNode)
}
func (b *Builder) evaluate(val parser.Value) parser.Value {
switch v := val.(type) {
case *parser.VariableReferenceValue:
name := strings.TrimPrefix(v.Name, "$")
if res, ok := b.variables[name]; ok {
return b.evaluate(res)
}
return v
case *parser.BinaryExpression:
left := b.evaluate(v.Left)
right := b.evaluate(v.Right)
return b.compute(left, v.Operator, right)
}
return val
}
func (b *Builder) compute(left parser.Value, op parser.Token, right parser.Value) parser.Value {
if op.Type == parser.TokenConcat {
s1 := b.valToString(left)
s2 := b.valToString(right)
return &parser.StringValue{Value: s1 + s2, Quoted: true}
}
lF, lIsF := b.valToFloat(left)
rF, rIsF := b.valToFloat(right)
if lIsF || rIsF {
res := 0.0
switch op.Type {
case parser.TokenPlus:
res = lF + rF
case parser.TokenMinus:
res = lF - rF
case parser.TokenStar:
res = lF * rF
case parser.TokenSlash:
res = lF / rF
}
return &parser.FloatValue{Value: res, Raw: fmt.Sprintf("%g", res)}
}
lI, lIsI := b.valToInt(left)
rI, rIsI := b.valToInt(right)
if lIsI && rIsI {
res := int64(0)
switch op.Type {
case parser.TokenPlus:
res = lI + rI
case parser.TokenMinus:
res = lI - rI
case parser.TokenStar:
res = lI * rI
case parser.TokenSlash:
if rI != 0 {
res = lI / rI
}
case parser.TokenPercent:
if rI != 0 {
res = lI % rI
}
case parser.TokenAmpersand:
res = lI & rI
case parser.TokenPipe:
res = lI | rI
case parser.TokenCaret:
res = lI ^ rI
}
return &parser.IntValue{Value: res, Raw: fmt.Sprintf("%d", res)}
}
return left
}
func (b *Builder) valToString(v parser.Value) string {
switch val := v.(type) {
case *parser.StringValue:
return val.Value
case *parser.IntValue:
return val.Raw
case *parser.FloatValue:
return val.Raw
default:
return ""
}
}
func (b *Builder) valToFloat(v parser.Value) (float64, bool) {
switch val := v.(type) {
case *parser.FloatValue:
return val.Value, true
case *parser.IntValue:
return float64(val.Value), true
}
return 0, false
}
func (b *Builder) valToInt(v parser.Value) (int64, bool) {
switch val := v.(type) {
case *parser.IntValue:
return val.Value, true
}
return 0, false
}

View File

@@ -104,6 +104,14 @@ func (f *Formatter) formatDefinition(def parser.Definition, indent int) int {
fmt.Fprintf(f.writer, "%s}", indentStr)
return d.Subnode.EndPosition.Line
case *parser.VariableDefinition:
fmt.Fprintf(f.writer, "%s#var %s: %s", indentStr, d.Name, d.TypeExpr)
if d.DefaultValue != nil {
fmt.Fprint(f.writer, " = ")
endLine := f.formatValue(d.DefaultValue, indent)
return endLine
}
return d.Position.Line
}
return 0
}
@@ -142,6 +150,9 @@ func (f *Formatter) formatValue(val parser.Value, indent int) int {
case *parser.ReferenceValue:
fmt.Fprint(f.writer, v.Value)
return v.Position.Line
case *parser.VariableReferenceValue:
fmt.Fprint(f.writer, v.Name)
return v.Position.Line
case *parser.ArrayValue:
fmt.Fprint(f.writer, "{ ")
for i, e := range v.Elements {

View File

@@ -5,15 +5,20 @@ import (
"path/filepath"
"strings"
"github.com/marte-community/marte-dev-tools/internal/logger"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
type VariableInfo struct {
Def *parser.VariableDefinition
File string
}
type ProjectTree struct {
Root *ProjectNode
References []Reference
IsolatedFiles map[string]*ProjectNode
GlobalPragmas map[string][]string
NodeMap map[string][]*ProjectNode
}
func (pt *ProjectTree) ScanDirectory(rootPath string) error {
@@ -37,10 +42,12 @@ func (pt *ProjectTree) ScanDirectory(rootPath string) error {
}
type Reference struct {
Name string
Position parser.Position
File string
Target *ProjectNode // Resolved target
Name string
Position parser.Position
File string
Target *ProjectNode
TargetVariable *parser.VariableDefinition
IsVariable bool
}
type ProjectNode struct {
@@ -53,6 +60,7 @@ type ProjectNode struct {
Metadata map[string]string // Store extra info like Class, Type, Size
Target *ProjectNode // Points to referenced node (for Direct References/Links)
Pragmas []string
Variables map[string]VariableInfo
}
type Fragment struct {
@@ -67,8 +75,9 @@ type Fragment struct {
func NewProjectTree() *ProjectTree {
return &ProjectTree{
Root: &ProjectNode{
Children: make(map[string]*ProjectNode),
Metadata: make(map[string]string),
Children: make(map[string]*ProjectNode),
Metadata: make(map[string]string),
Variables: make(map[string]VariableInfo),
},
IsolatedFiles: make(map[string]*ProjectNode),
GlobalPragmas: make(map[string][]string),
@@ -120,8 +129,11 @@ func (pt *ProjectTree) removeFileFromNode(node *ProjectNode, file string) {
node.Metadata = make(map[string]string)
pt.rebuildMetadata(node)
for _, child := range node.Children {
for name, child := range node.Children {
pt.removeFileFromNode(child, file)
if len(child.Fragments) == 0 && len(child.Children) == 0 {
delete(node.Children, name)
}
}
}
@@ -171,8 +183,9 @@ func (pt *ProjectTree) AddFile(file string, config *parser.Configuration) {
if config.Package == nil {
node := &ProjectNode{
Children: make(map[string]*ProjectNode),
Metadata: make(map[string]string),
Children: make(map[string]*ProjectNode),
Metadata: make(map[string]string),
Variables: make(map[string]VariableInfo),
}
pt.IsolatedFiles[file] = node
pt.populateNode(node, file, config)
@@ -181,24 +194,20 @@ func (pt *ProjectTree) AddFile(file string, config *parser.Configuration) {
node := pt.Root
parts := strings.Split(config.Package.URI, ".")
// Skip first part as per spec (Project Name is namespace only)
startIdx := 0
if len(parts) > 0 {
startIdx = 1
}
for i := startIdx; i < len(parts); i++ {
for i := 0; i < len(parts); i++ {
part := strings.TrimSpace(parts[i])
if part == "" {
continue
}
if _, ok := node.Children[part]; !ok {
node.Children[part] = &ProjectNode{
Name: part,
RealName: part,
Children: make(map[string]*ProjectNode),
Parent: node,
Metadata: make(map[string]string),
Name: part,
RealName: part,
Children: make(map[string]*ProjectNode),
Parent: node,
Metadata: make(map[string]string),
Variables: make(map[string]VariableInfo),
}
}
node = node.Children[part]
@@ -221,16 +230,20 @@ func (pt *ProjectTree) populateNode(node *ProjectNode, file string, config *pars
case *parser.Field:
fileFragment.Definitions = append(fileFragment.Definitions, d)
pt.indexValue(file, d.Value)
case *parser.VariableDefinition:
fileFragment.Definitions = append(fileFragment.Definitions, d)
node.Variables[d.Name] = VariableInfo{Def: d, File: file}
case *parser.ObjectNode:
fileFragment.Definitions = append(fileFragment.Definitions, d)
norm := NormalizeName(d.Name)
if _, ok := node.Children[norm]; !ok {
node.Children[norm] = &ProjectNode{
Name: norm,
RealName: d.Name,
Children: make(map[string]*ProjectNode),
Parent: node,
Metadata: make(map[string]string),
Name: norm,
RealName: d.Name,
Children: make(map[string]*ProjectNode),
Parent: node,
Metadata: make(map[string]string),
Variables: make(map[string]VariableInfo),
}
}
child := node.Children[norm]
@@ -276,16 +289,20 @@ func (pt *ProjectTree) addObjectFragment(node *ProjectNode, file string, obj *pa
frag.Definitions = append(frag.Definitions, d)
pt.indexValue(file, d.Value)
pt.extractFieldMetadata(node, d)
case *parser.VariableDefinition:
frag.Definitions = append(frag.Definitions, d)
node.Variables[d.Name] = VariableInfo{Def: d, File: file}
case *parser.ObjectNode:
frag.Definitions = append(frag.Definitions, d)
norm := NormalizeName(d.Name)
if _, ok := node.Children[norm]; !ok {
node.Children[norm] = &ProjectNode{
Name: norm,
RealName: d.Name,
Children: make(map[string]*ProjectNode),
Parent: node,
Metadata: make(map[string]string),
Name: norm,
RealName: d.Name,
Children: make(map[string]*ProjectNode),
Parent: node,
Metadata: make(map[string]string),
Variables: make(map[string]VariableInfo),
}
}
child := node.Children[norm]
@@ -381,6 +398,13 @@ func (pt *ProjectTree) indexValue(file string, val parser.Value) {
Position: v.Position,
File: file,
})
case *parser.VariableReferenceValue:
pt.References = append(pt.References, Reference{
Name: strings.TrimPrefix(v.Name, "$"),
Position: v.Position,
File: file,
IsVariable: true,
})
case *parser.ArrayValue:
for _, elem := range v.Elements {
pt.indexValue(file, elem)
@@ -388,26 +412,49 @@ func (pt *ProjectTree) indexValue(file string, val parser.Value) {
}
}
func (pt *ProjectTree) RebuildIndex() {
pt.NodeMap = make(map[string][]*ProjectNode)
visitor := func(n *ProjectNode) {
pt.NodeMap[n.Name] = append(pt.NodeMap[n.Name], n)
if n.RealName != n.Name {
pt.NodeMap[n.RealName] = append(pt.NodeMap[n.RealName], n)
}
}
pt.Walk(visitor)
}
func (pt *ProjectTree) ResolveReferences() {
pt.RebuildIndex()
for i := range pt.References {
ref := &pt.References[i]
if isoNode, ok := pt.IsolatedFiles[ref.File]; ok {
ref.Target = pt.FindNode(isoNode, ref.Name, nil)
} else {
ref.Target = pt.FindNode(pt.Root, ref.Name, nil)
container := pt.GetNodeContaining(ref.File, ref.Position)
if v := pt.ResolveVariable(container, ref.Name); v != nil {
ref.TargetVariable = v.Def
continue
}
ref.Target = pt.resolveScopedName(container, ref.Name)
}
}
func (pt *ProjectTree) FindNode(root *ProjectNode, name string, predicate func(*ProjectNode) bool) *ProjectNode {
if pt.NodeMap == nil {
pt.RebuildIndex()
}
if strings.Contains(name, ".") {
parts := strings.Split(name, ".")
rootName := parts[0]
var candidates []*ProjectNode
pt.findAllNodes(root, rootName, &candidates)
candidates := pt.NodeMap[rootName]
for _, cand := range candidates {
if !pt.isDescendant(cand, root) {
continue
}
curr := cand
valid := true
for i := 1; i < len(parts); i++ {
@@ -429,38 +476,44 @@ func (pt *ProjectTree) FindNode(root *ProjectNode, name string, predicate func(*
return nil
}
if root.RealName == name || root.Name == name {
if predicate == nil || predicate(root) {
return root
candidates := pt.NodeMap[name]
for _, cand := range candidates {
if !pt.isDescendant(cand, root) {
continue
}
}
for _, child := range root.Children {
if res := pt.FindNode(child, name, predicate); res != nil {
return res
if predicate == nil || predicate(cand) {
return cand
}
}
return nil
}
func (pt *ProjectTree) findAllNodes(root *ProjectNode, name string, results *[]*ProjectNode) {
if root.RealName == name || root.Name == name {
*results = append(*results, root)
func (pt *ProjectTree) isDescendant(node, root *ProjectNode) bool {
if node == root {
return true
}
for _, child := range root.Children {
pt.findAllNodes(child, name, results)
if root == nil {
return true
}
curr := node
for curr != nil {
if curr == root {
return true
}
curr = curr.Parent
}
return false
}
type QueryResult struct {
Node *ProjectNode
Field *parser.Field
Reference *Reference
Variable *parser.VariableDefinition
}
func (pt *ProjectTree) Query(file string, line, col int) *QueryResult {
logger.Printf("File: %s:%d:%d", file, line, col)
for i := range pt.References {
logger.Printf("%s", pt.Root.Name)
ref := &pt.References[i]
if ref.File == file {
if line == ref.Position.Line && col >= ref.Position.Column && col < ref.Position.Column+len(ref.Name) {
@@ -506,6 +559,10 @@ func (pt *ProjectTree) queryNode(node *ProjectNode, file string, line, col int)
if line == f.Position.Line && col >= f.Position.Column && col < f.Position.Column+len(f.Name) {
return &QueryResult{Field: f}
}
} else if v, ok := def.(*parser.VariableDefinition); ok {
if line == v.Position.Line {
return &QueryResult{Variable: v}
}
}
}
}
@@ -559,3 +616,66 @@ func (pt *ProjectTree) findNodeContaining(node *ProjectNode, file string, pos pa
}
return nil
}
func (pt *ProjectTree) resolveScopedName(ctx *ProjectNode, name string) *ProjectNode {
if ctx == nil {
return pt.FindNode(pt.Root, name, nil)
}
parts := strings.Split(name, ".")
first := parts[0]
normFirst := NormalizeName(first)
var startNode *ProjectNode
curr := ctx
for curr != nil {
if child, ok := curr.Children[normFirst]; ok {
startNode = child
break
}
curr = curr.Parent
}
if startNode == nil && ctx != pt.Root {
if child, ok := pt.Root.Children[normFirst]; ok {
startNode = child
}
}
if startNode == nil {
// Fallback to deep search from context root
root := ctx
for root.Parent != nil {
root = root.Parent
}
return pt.FindNode(root, name, nil)
}
curr = startNode
for i := 1; i < len(parts); i++ {
norm := NormalizeName(parts[i])
if child, ok := curr.Children[norm]; ok {
curr = child
} else {
return nil
}
}
return curr
}
func (pt *ProjectTree) ResolveVariable(ctx *ProjectNode, name string) *VariableInfo {
curr := ctx
for curr != nil {
if v, ok := curr.Variables[name]; ok {
return &v
}
curr = curr.Parent
}
if ctx == nil {
if v, ok := pt.Root.Variables[name]; ok {
return &v
}
}
return nil
}

View File

@@ -20,12 +20,10 @@ import (
"cuelang.org/go/cue"
)
type CompletionParams struct {
TextDocument TextDocumentIdentifier `json:"textDocument"`
Position Position `json:"position"`
Context CompletionContext `json:"context,omitempty"`
Context CompletionContext `json:"context"`
}
type CompletionContext struct {
@@ -51,6 +49,7 @@ var Tree = index.NewProjectTree()
var Documents = make(map[string]string)
var ProjectRoot string
var GlobalSchema *schema.Schema
var Output io.Writer = os.Stdout
type JsonRpcMessage struct {
Jsonrpc string `json:"jsonrpc"`
@@ -93,7 +92,9 @@ type VersionedTextDocumentIdentifier struct {
}
type TextDocumentContentChangeEvent struct {
Text string `json:"text"`
Range *Range `json:"range,omitempty"`
RangeLength int `json:"rangeLength,omitempty"`
Text string `json:"text"`
}
type HoverParams struct {
@@ -161,6 +162,16 @@ type DocumentFormattingParams struct {
Options FormattingOptions `json:"options"`
}
type RenameParams struct {
TextDocument TextDocumentIdentifier `json:"textDocument"`
Position Position `json:"position"`
NewName string `json:"newName"`
}
type WorkspaceEdit struct {
Changes map[string][]TextEdit `json:"changes"`
}
type FormattingOptions struct {
TabSize int `json:"tabSize"`
InsertSpaces bool `json:"insertSpaces"`
@@ -171,7 +182,6 @@ type TextEdit struct {
NewText string `json:"newText"`
}
func RunServer() {
reader := bufio.NewReader(os.Stdin)
for {
@@ -215,6 +225,12 @@ func readMessage(reader *bufio.Reader) (*JsonRpcMessage, error) {
}
func HandleMessage(msg *JsonRpcMessage) {
defer func() {
if r := recover(); r != nil {
logger.Printf("Panic in HandleMessage: %v", r)
}
}()
switch msg.Method {
case "initialize":
var params InitializeParams
@@ -232,18 +248,22 @@ func HandleMessage(msg *JsonRpcMessage) {
if err := Tree.ScanDirectory(root); err != nil {
logger.Printf("ScanDirectory failed: %v\n", err)
}
logger.Printf("Scan done")
Tree.ResolveReferences()
logger.Printf("Resolve done")
GlobalSchema = schema.LoadFullSchema(ProjectRoot)
logger.Printf("Schema done")
}
}
respond(msg.ID, map[string]any{
"capabilities": map[string]any{
"textDocumentSync": 1, // Full sync
"textDocumentSync": 2, // Incremental sync
"hoverProvider": true,
"definitionProvider": true,
"referencesProvider": true,
"documentFormattingProvider": true,
"renameProvider": true,
"completionProvider": map[string]any{
"triggerCharacters": []string{"=", " "},
},
@@ -300,6 +320,11 @@ func HandleMessage(msg *JsonRpcMessage) {
if err := json.Unmarshal(msg.Params, &params); err == nil {
respond(msg.ID, HandleFormatting(params))
}
case "textDocument/rename":
var params RenameParams
if err := json.Unmarshal(msg.Params, &params); err == nil {
respond(msg.ID, HandleRename(params))
}
}
}
@@ -327,28 +352,76 @@ func HandleDidOpen(params DidOpenTextDocumentParams) {
}
func HandleDidChange(params DidChangeTextDocumentParams) {
if len(params.ContentChanges) == 0 {
return
uri := params.TextDocument.URI
text, ok := Documents[uri]
if !ok {
// If not found, rely on full sync being first or error
}
text := params.ContentChanges[0].Text
Documents[params.TextDocument.URI] = text
path := uriToPath(params.TextDocument.URI)
for _, change := range params.ContentChanges {
if change.Range == nil {
text = change.Text
} else {
text = applyContentChange(text, change)
}
}
Documents[uri] = text
path := uriToPath(uri)
p := parser.NewParser(text)
config, err := p.Parse()
if err != nil {
publishParserError(params.TextDocument.URI, err)
publishParserError(uri, err)
} else {
publishParserError(params.TextDocument.URI, nil)
publishParserError(uri, nil)
}
if config != nil {
Tree.AddFile(path, config)
Tree.ResolveReferences()
runValidation(params.TextDocument.URI)
runValidation(uri)
}
}
func applyContentChange(text string, change TextDocumentContentChangeEvent) string {
startOffset := offsetAt(text, change.Range.Start)
endOffset := offsetAt(text, change.Range.End)
if startOffset == -1 || endOffset == -1 {
return text
}
return text[:startOffset] + change.Text + text[endOffset:]
}
func offsetAt(text string, pos Position) int {
line := 0
col := 0
for i, r := range text {
if line == pos.Line && col == pos.Character {
return i
}
if line > pos.Line {
break
}
if r == '\n' {
line++
col = 0
} else {
if r >= 0x10000 {
col += 2
} else {
col++
}
}
}
if line == pos.Line && col == pos.Character {
return len(text)
}
return -1
}
func HandleFormatting(params DocumentFormattingParams) []TextEdit {
uri := params.TextDocument.URI
text, ok := Documents[uri]
@@ -382,10 +455,9 @@ func HandleFormatting(params DocumentFormattingParams) []TextEdit {
}
}
func runValidation(uri string) {
func runValidation(_ string) {
v := validator.NewValidator(Tree, ProjectRoot)
v.ValidateProject()
v.CheckUnused()
// Group diagnostics by file
fileDiags := make(map[string][]LSPDiagnostic)
@@ -522,6 +594,11 @@ func HandleHover(params HoverParams) *Hover {
}
} else if res.Field != nil {
content = fmt.Sprintf("**Field**: `%s`", res.Field.Name)
} else if res.Variable != nil {
content = fmt.Sprintf("**Variable**: `%s`\nType: `%s`", res.Variable.Name, res.Variable.TypeExpr)
if res.Variable.DefaultValue != nil {
content += fmt.Sprintf("\nDefault: `%s`", valueToString(res.Variable.DefaultValue))
}
} else if res.Reference != nil {
targetName := "Unresolved"
fullInfo := ""
@@ -531,12 +608,19 @@ func HandleHover(params HoverParams) *Hover {
targetName = res.Reference.Target.RealName
targetDoc = res.Reference.Target.Doc
fullInfo = formatNodeInfo(res.Reference.Target)
} else if res.Reference.TargetVariable != nil {
v := res.Reference.TargetVariable
targetName = v.Name
fullInfo = fmt.Sprintf("**Variable**: `%s`\nType: `%s`", v.Name, v.TypeExpr)
if v.DefaultValue != nil {
fullInfo += fmt.Sprintf("\nDefault: `%s`", valueToString(v.DefaultValue))
}
}
content = fmt.Sprintf("**Reference**: `%s` -> `%s`", res.Reference.Name, targetName)
if fullInfo != "" {
content += fmt.Sprintf("\n\n---\n%s", fullInfo)
} else if targetDoc != "" { // Fallback if formatNodeInfo returned empty (unlikely)
} else if targetDoc != "" {
content += fmt.Sprintf("\n\n%s", targetDoc)
}
}
@@ -553,6 +637,34 @@ func HandleHover(params HoverParams) *Hover {
}
}
func valueToString(val parser.Value) string {
switch v := val.(type) {
case *parser.StringValue:
if v.Quoted {
return fmt.Sprintf("\"%s\"", v.Value)
}
return v.Value
case *parser.IntValue:
return v.Raw
case *parser.FloatValue:
return v.Raw
case *parser.BoolValue:
return fmt.Sprintf("%v", v.Value)
case *parser.ReferenceValue:
return v.Value
case *parser.VariableReferenceValue:
return v.Name
case *parser.ArrayValue:
elements := []string{}
for _, e := range v.Elements {
elements = append(elements, valueToString(e))
}
return fmt.Sprintf("{ %s }", strings.Join(elements, " "))
default:
return ""
}
}
func HandleCompletion(params CompletionParams) *CompletionList {
uri := params.TextDocument.URI
path := uriToPath(uri)
@@ -567,10 +679,7 @@ func HandleCompletion(params CompletionParams) *CompletionList {
}
lineStr := lines[params.Position.Line]
col := params.Position.Character
if col > len(lineStr) {
col = len(lineStr)
}
col := min(params.Position.Character, len(lineStr))
prefix := lineStr[:col]
@@ -601,12 +710,88 @@ func HandleCompletion(params CompletionParams) *CompletionList {
// Case 2: Typing a key inside an object
container := Tree.GetNodeContaining(path, parser.Position{Line: params.Position.Line + 1, Column: col + 1})
if container != nil {
if container.Parent != nil && isGAM(container.Parent) {
if container.Name == "InputSignals" {
return suggestGAMSignals(container, "Input")
}
if container.Name == "OutputSignals" {
return suggestGAMSignals(container, "Output")
}
}
return suggestFields(container)
}
return nil
}
func suggestGAMSignals(_ *index.ProjectNode, direction string) *CompletionList {
var items []CompletionItem
processNode := func(node *index.ProjectNode) {
if !isDataSource(node) {
return
}
cls := node.Metadata["Class"]
if cls == "" {
return
}
dir := "NIL"
if GlobalSchema != nil {
classPath := cue.ParsePath(fmt.Sprintf("#Classes.%s.#meta.direction", cls))
val := GlobalSchema.Value.LookupPath(classPath)
if val.Err() == nil {
var s string
if err := val.Decode(&s); err == nil {
dir = s
}
}
}
compatible := false
switch direction {
case "Input":
compatible = dir == "IN" || dir == "INOUT"
case "Output":
compatible = dir == "OUT" || dir == "INOUT"
default:
compatible = false
}
if !compatible {
return
}
signalsContainer := node.Children["Signals"]
if signalsContainer == nil {
return
}
for _, sig := range signalsContainer.Children {
dsName := node.Name
sigName := sig.Name
label := fmt.Sprintf("%s:%s", dsName, sigName)
insertText := fmt.Sprintf("%s = {\n DataSource = %s \n}", sigName, dsName)
items = append(items, CompletionItem{
Label: label,
Kind: 6, // Variable
Detail: "Signal from " + dsName,
InsertText: insertText,
InsertTextFormat: 2, // Snippet
})
}
}
Tree.Walk(processNode)
if len(items) > 0 {
return &CompletionList{Items: items}
}
return nil
}
func suggestClasses() *CompletionList {
if GlobalSchema == nil {
return nil
@@ -784,10 +969,10 @@ func suggestCUEEnums(container *index.ProjectNode, field string) *CompletionList
continue
}
// Ensure strings are quoted
if v.Kind() == cue.StringKind && !strings.HasPrefix(str, "\"") {
str = fmt.Sprintf("\"%s\"", str)
}
// Ensure strings are quoted
if v.Kind() == cue.StringKind && !strings.HasPrefix(str, "\"") {
str = fmt.Sprintf("\"%s\"", str)
}
items = append(items, CompletionItem{
Label: str,
@@ -811,14 +996,11 @@ func suggestObjects(root *index.ProjectNode, filter string) *CompletionList {
var walk func(*index.ProjectNode)
walk = func(node *index.ProjectNode) {
match := false
if filter == "GAM" {
if isGAM(node) {
match = true
}
} else if filter == "DataSource" {
if isDataSource(node) {
match = true
}
switch filter {
case "GAM":
match = isGAM(node)
case "DataSource":
match = isDataSource(node)
}
if match {
@@ -866,14 +1048,35 @@ func HandleDefinition(params DefinitionParams) any {
}
var targetNode *index.ProjectNode
if res.Reference != nil && res.Reference.Target != nil {
targetNode = res.Reference.Target
var targetVar *parser.VariableDefinition
if res.Reference != nil {
if res.Reference.Target != nil {
targetNode = res.Reference.Target
} else if res.Reference.TargetVariable != nil {
targetVar = res.Reference.TargetVariable
}
} else if res.Node != nil {
if res.Node.Target != nil {
targetNode = res.Node.Target
} else {
targetNode = res.Node
}
} else if res.Variable != nil {
targetVar = res.Variable
}
if targetVar != nil {
container := Tree.GetNodeContaining(path, parser.Position{Line: line, Column: col})
if info := Tree.ResolveVariable(container, targetVar.Name); info != nil {
return []Location{{
URI: "file://" + info.File,
Range: Range{
Start: Position{Line: targetVar.Position.Line - 1, Character: targetVar.Position.Column - 1},
End: Position{Line: targetVar.Position.Line - 1, Character: targetVar.Position.Column - 1 + len(targetVar.Name) + 5}, // #var + space + Name? Rough estimate
},
}}
}
}
if targetNode != nil {
@@ -906,10 +1109,48 @@ func HandleReferences(params ReferenceParams) []Location {
}
var targetNode *index.ProjectNode
var targetVar *parser.VariableDefinition
if res.Node != nil {
targetNode = res.Node
} else if res.Reference != nil && res.Reference.Target != nil {
targetNode = res.Reference.Target
} else if res.Reference != nil {
if res.Reference.Target != nil {
targetNode = res.Reference.Target
} else if res.Reference.TargetVariable != nil {
targetVar = res.Reference.TargetVariable
}
} else if res.Variable != nil {
targetVar = res.Variable
}
if targetVar != nil {
var locations []Location
// Declaration
if params.Context.IncludeDeclaration {
container := Tree.GetNodeContaining(path, parser.Position{Line: line, Column: col})
if info := Tree.ResolveVariable(container, targetVar.Name); info != nil {
locations = append(locations, Location{
URI: "file://" + info.File,
Range: Range{
Start: Position{Line: targetVar.Position.Line - 1, Character: targetVar.Position.Column - 1},
End: Position{Line: targetVar.Position.Line - 1, Character: targetVar.Position.Column - 1 + len(targetVar.Name) + 5},
},
})
}
}
// References
for _, ref := range Tree.References {
if ref.TargetVariable == targetVar {
locations = append(locations, Location{
URI: "file://" + ref.File,
Range: Range{
Start: Position{Line: ref.Position.Line - 1, Character: ref.Position.Column - 1},
End: Position{Line: ref.Position.Line - 1, Character: ref.Position.Column - 1 + len(ref.Name) + 1}, // $Name
},
})
}
}
return locations
}
if targetNode == nil {
@@ -981,6 +1222,14 @@ func formatNodeInfo(node *index.ProjectNode) string {
typ := node.Metadata["Type"]
ds := node.Metadata["DataSource"]
if ds == "" {
if node.Parent != nil && node.Parent.Name == "Signals" {
if node.Parent.Parent != nil {
ds = node.Parent.Parent.Name
}
}
}
if typ != "" || ds != "" {
sigInfo := "\n"
if typ != "" {
@@ -1053,19 +1302,214 @@ func formatNodeInfo(node *index.ProjectNode) string {
}
}
// Find GAM usages
var gams []string
// 1. Check References (explicit text references)
for _, ref := range Tree.References {
if ref.Target == node {
container := Tree.GetNodeContaining(ref.File, ref.Position)
if container != nil {
curr := container
for curr != nil {
if isGAM(curr) {
suffix := ""
p := container
for p != nil && p != curr {
if p.Name == "InputSignals" {
suffix = " (Input)"
break
}
if p.Name == "OutputSignals" {
suffix = " (Output)"
break
}
p = p.Parent
}
gams = append(gams, curr.RealName+suffix)
break
}
curr = curr.Parent
}
}
}
}
// 2. Check Direct Usages (Nodes targeting this node)
Tree.Walk(func(n *index.ProjectNode) {
if n.Target == node {
if n.Parent != nil && (n.Parent.Name == "InputSignals" || n.Parent.Name == "OutputSignals") {
if n.Parent.Parent != nil && isGAM(n.Parent.Parent) {
suffix := " (Input)"
if n.Parent.Name == "OutputSignals" {
suffix = " (Output)"
}
gams = append(gams, n.Parent.Parent.RealName+suffix)
}
}
}
})
if len(gams) > 0 {
uniqueGams := make(map[string]bool)
info += "\n\n**Used in GAMs**:\n"
for _, g := range gams {
if !uniqueGams[g] {
uniqueGams[g] = true
info += fmt.Sprintf("- %s\n", g)
}
}
}
return info
}
func HandleRename(params RenameParams) *WorkspaceEdit {
path := uriToPath(params.TextDocument.URI)
line := params.Position.Line + 1
col := params.Position.Character + 1
res := Tree.Query(path, line, col)
if res == nil {
return nil
}
var targetNode *index.ProjectNode
var targetField *parser.Field
if res.Node != nil {
if res.Node.Target != nil {
targetNode = res.Node.Target
} else {
targetNode = res.Node
}
} else if res.Field != nil {
targetField = res.Field
} else if res.Reference != nil {
if res.Reference.Target != nil {
targetNode = res.Reference.Target
} else {
return nil
}
}
changes := make(map[string][]TextEdit)
addEdit := func(file string, rng Range, newText string) {
uri := "file://" + file
changes[uri] = append(changes[uri], TextEdit{Range: rng, NewText: newText})
}
if targetNode != nil {
// 1. Rename Definitions
prefix := ""
if len(targetNode.RealName) > 0 {
first := targetNode.RealName[0]
if first == '+' || first == '$' {
prefix = string(first)
}
}
normNewName := strings.TrimLeft(params.NewName, "+$")
finalDefName := prefix + normNewName
for _, frag := range targetNode.Fragments {
if frag.IsObject {
rng := Range{
Start: Position{Line: frag.ObjectPos.Line - 1, Character: frag.ObjectPos.Column - 1},
End: Position{Line: frag.ObjectPos.Line - 1, Character: frag.ObjectPos.Column - 1 + len(targetNode.RealName)},
}
addEdit(frag.File, rng, finalDefName)
}
}
// 2. Rename References
for _, ref := range Tree.References {
if ref.Target == targetNode {
// Handle qualified names (e.g. Pkg.Node)
if strings.Contains(ref.Name, ".") {
if strings.HasSuffix(ref.Name, "."+targetNode.Name) {
prefixLen := len(ref.Name) - len(targetNode.Name)
rng := Range{
Start: Position{Line: ref.Position.Line - 1, Character: ref.Position.Column - 1 + prefixLen},
End: Position{Line: ref.Position.Line - 1, Character: ref.Position.Column - 1 + len(ref.Name)},
}
addEdit(ref.File, rng, normNewName)
} else if ref.Name == targetNode.Name {
rng := Range{
Start: Position{Line: ref.Position.Line - 1, Character: ref.Position.Column - 1},
End: Position{Line: ref.Position.Line - 1, Character: ref.Position.Column - 1 + len(ref.Name)},
}
addEdit(ref.File, rng, normNewName)
}
} else {
rng := Range{
Start: Position{Line: ref.Position.Line - 1, Character: ref.Position.Column - 1},
End: Position{Line: ref.Position.Line - 1, Character: ref.Position.Column - 1 + len(ref.Name)},
}
addEdit(ref.File, rng, normNewName)
}
}
}
// 3. Rename Implicit Node References (Signals in GAMs relying on name match)
Tree.Walk(func(n *index.ProjectNode) {
if n.Target == targetNode {
hasAlias := false
for _, frag := range n.Fragments {
for _, def := range frag.Definitions {
if f, ok := def.(*parser.Field); ok && f.Name == "Alias" {
hasAlias = true
}
}
}
if !hasAlias {
for _, frag := range n.Fragments {
if frag.IsObject {
rng := Range{
Start: Position{Line: frag.ObjectPos.Line - 1, Character: frag.ObjectPos.Column - 1},
End: Position{Line: frag.ObjectPos.Line - 1, Character: frag.ObjectPos.Column - 1 + len(n.RealName)},
}
addEdit(frag.File, rng, normNewName)
}
}
}
}
})
return &WorkspaceEdit{Changes: changes}
} else if targetField != nil {
container := Tree.GetNodeContaining(path, targetField.Position)
if container != nil {
for _, frag := range container.Fragments {
for _, def := range frag.Definitions {
if f, ok := def.(*parser.Field); ok {
if f.Name == targetField.Name {
rng := Range{
Start: Position{Line: f.Position.Line - 1, Character: f.Position.Column - 1},
End: Position{Line: f.Position.Line - 1, Character: f.Position.Column - 1 + len(f.Name)},
}
addEdit(frag.File, rng, params.NewName)
}
}
}
}
}
return &WorkspaceEdit{Changes: changes}
}
return nil
}
func respond(id any, result any) {
msg := JsonRpcMessage{
Jsonrpc: "2.0",
ID: id,
Result: result,
msg := map[string]any{
"jsonrpc": "2.0",
"id": id,
"result": result,
}
send(msg)
}
func send(msg any) {
body, _ := json.Marshal(msg)
fmt.Printf("Content-Length: %d\r\n\r\n%s", len(body), body)
fmt.Fprintf(Output, "Content-Length: %d\r\n\r\n%s", len(body), body)
}

View File

@@ -45,6 +45,8 @@ type Subnode struct {
Definitions []Definition
}
func (s *Subnode) Pos() Position { return s.Position }
type Value interface {
Node
isValue()
@@ -115,7 +117,39 @@ type Comment struct {
Doc bool // true if starts with //#
}
func (c *Comment) Pos() Position { return c.Position }
type Pragma struct {
Position Position
Text string
}
func (p *Pragma) Pos() Position { return p.Position }
type VariableDefinition struct {
Position Position
Name string
TypeExpr string
DefaultValue Value
}
func (v *VariableDefinition) Pos() Position { return v.Position }
func (v *VariableDefinition) isDefinition() {}
type VariableReferenceValue struct {
Position Position
Name string
}
func (v *VariableReferenceValue) Pos() Position { return v.Position }
func (v *VariableReferenceValue) isValue() {}
type BinaryExpression struct {
Position Position
Left Value
Operator Token
Right Value
}
func (b *BinaryExpression) Pos() Position { return b.Position }
func (b *BinaryExpression) isValue() {}

View File

@@ -23,6 +23,19 @@ const (
TokenComment
TokenDocstring
TokenComma
TokenColon
TokenPipe
TokenLBracket
TokenRBracket
TokenSymbol
TokenPlus
TokenMinus
TokenStar
TokenSlash
TokenPercent
TokenCaret
TokenAmpersand
TokenConcat
)
type Token struct {
@@ -124,14 +137,53 @@ func (l *Lexer) NextToken() Token {
return l.emit(TokenRBrace)
case ',':
return l.emit(TokenComma)
case ':':
return l.emit(TokenColon)
case '|':
return l.emit(TokenPipe)
case '[':
return l.emit(TokenLBracket)
case ']':
return l.emit(TokenRBracket)
case '+':
if unicode.IsSpace(l.peek()) {
return l.emit(TokenPlus)
}
return l.lexObjectIdentifier()
case '-':
if unicode.IsDigit(l.peek()) {
return l.lexNumber()
}
if unicode.IsSpace(l.peek()) {
return l.emit(TokenMinus)
}
return l.lexIdentifier()
case '*':
return l.emit(TokenStar)
case '/':
p := l.peek()
if p == '/' || p == '*' || p == '#' || p == '!' {
return l.lexComment()
}
return l.emit(TokenSlash)
case '%':
return l.emit(TokenPercent)
case '^':
return l.emit(TokenCaret)
case '&':
return l.emit(TokenAmpersand)
case '.':
if l.peek() == '.' {
l.next()
return l.emit(TokenConcat)
}
return l.emit(TokenSymbol)
case '~', '!', '<', '>', '(', ')', '?', '\\':
return l.emit(TokenSymbol)
case '"':
return l.lexString()
case '/':
return l.lexComment()
case '#':
return l.lexPackage()
case '+':
fallthrough
return l.lexHashIdentifier()
case '$':
return l.lexObjectIdentifier()
}
@@ -151,7 +203,7 @@ func (l *Lexer) NextToken() Token {
func (l *Lexer) lexIdentifier() Token {
for {
r := l.next()
if unicode.IsLetter(r) || unicode.IsDigit(r) || r == '_' || r == '-' || r == '.' || r == ':' {
if unicode.IsLetter(r) || unicode.IsDigit(r) || r == '_' || r == '-' || r == '.' {
continue
}
l.backup()
@@ -243,18 +295,19 @@ func (l *Lexer) lexUntilNewline(t TokenType) Token {
}
}
func (l *Lexer) lexPackage() Token {
func (l *Lexer) lexHashIdentifier() Token {
// We are at '#', l.start is just before it
for {
r := l.next()
if unicode.IsLetter(r) {
if unicode.IsLetter(r) || unicode.IsDigit(r) || r == '_' || r == '-' || r == '.' || r == '#' {
continue
}
l.backup()
break
}
if l.input[l.start:l.pos] == "#package" {
val := l.input[l.start:l.pos]
if val == "#package" {
return l.lexUntilNewline(TokenPackage)
}
return l.emit(TokenError)
return l.emit(TokenIdentifier)
}

View File

@@ -101,6 +101,9 @@ func (p *Parser) parseDefinition() (Definition, bool) {
switch tok.Type {
case TokenIdentifier:
name := tok.Value
if name == "#var" {
return p.parseVariableDefinition(tok)
}
if p.peek().Type != TokenEqual {
p.addError(tok.Position, "expected =")
return nil, false
@@ -223,6 +226,56 @@ func (p *Parser) parseSubnode() (Subnode, bool) {
}
func (p *Parser) parseValue() (Value, bool) {
return p.parseExpression(0)
}
func getPrecedence(t TokenType) int {
switch t {
case TokenStar, TokenSlash, TokenPercent:
return 5
case TokenPlus, TokenMinus:
return 4
case TokenConcat:
return 3
case TokenAmpersand:
return 2
case TokenPipe, TokenCaret:
return 1
default:
return 0
}
}
func (p *Parser) parseExpression(minPrecedence int) (Value, bool) {
left, ok := p.parseAtom()
if !ok {
return nil, false
}
for {
t := p.peek()
prec := getPrecedence(t.Type)
if prec == 0 || prec <= minPrecedence {
break
}
p.next()
right, ok := p.parseExpression(prec)
if !ok {
return nil, false
}
left = &BinaryExpression{
Position: left.Pos(),
Left: left,
Operator: t,
Right: right,
}
}
return left, true
}
func (p *Parser) parseAtom() (Value, bool) {
tok := p.next()
switch tok.Type {
case TokenString:
@@ -244,6 +297,8 @@ func (p *Parser) parseValue() (Value, bool) {
true
case TokenIdentifier:
return &ReferenceValue{Position: tok.Position, Value: tok.Value}, true
case TokenObjectIdentifier:
return &VariableReferenceValue{Position: tok.Position, Name: tok.Value}, true
case TokenLBrace:
arr := &ArrayValue{Position: tok.Position}
for {
@@ -269,3 +324,59 @@ func (p *Parser) parseValue() (Value, bool) {
return nil, false
}
}
func (p *Parser) parseVariableDefinition(startTok Token) (Definition, bool) {
nameTok := p.next()
if nameTok.Type != TokenIdentifier {
p.addError(nameTok.Position, "expected variable name")
return nil, false
}
if p.next().Type != TokenColon {
p.addError(nameTok.Position, "expected :")
return nil, false
}
var typeTokens []Token
startLine := nameTok.Position.Line
for {
t := p.peek()
if t.Position.Line > startLine || t.Type == TokenEOF {
break
}
if t.Type == TokenEqual {
if p.peekN(1).Type == TokenSymbol && p.peekN(1).Value == "~" {
p.next()
p.next()
typeTokens = append(typeTokens, Token{Type: TokenSymbol, Value: "=~", Position: t.Position})
continue
}
break
}
typeTokens = append(typeTokens, p.next())
}
typeExpr := ""
for _, t := range typeTokens {
typeExpr += t.Value + " "
}
var defVal Value
if p.peek().Type == TokenEqual {
p.next()
val, ok := p.parseValue()
if ok {
defVal = val
} else {
return nil, false
}
}
return &VariableDefinition{
Position: startTok.Position,
Name: nameTok.Value,
TypeExpr: strings.TrimSpace(typeExpr),
DefaultValue: defVal,
}, true
}

View File

@@ -2,9 +2,32 @@ package schema
#Classes: {
RealTimeApplication: {
Functions: {...} // type: node
Data!: {...} // type: node
States!: {...} // type: node
Functions!: {
Class: "ReferenceContainer"
[_= !~"^Class$"]: {
#meta: type: "gam"
...
}
} // type: node
Data!: {
Class: "ReferenceContainer"
DefaultDataSource: string
[_= !~"^(Class|DefaultDataSource)$"]: {
#meta: type: "datasource"
...
}
}
States!: {
Class: "ReferenceContainer"
[_= !~"^Class$"]: {
Class: "RealTimeState"
...
}
} // type: node
Scheduler!: {
...
#meta: type: "scheduler"
}
...
}
Message: {
@@ -13,7 +36,7 @@ package schema
StateMachineEvent: {
NextState!: string
NextStateError!: string
Timeout: uint32
Timeout?: uint32
[_= !~"^(Class|NextState|Timeout|NextStateError|[#_$].+)$"]: Message
...
}
@@ -23,7 +46,7 @@ package schema
Class: "ReferenceContainer"
...
}
[_ = !~"^(Class|ENTER)$"]: StateMachineEvent
[_ = !~"^(Class|ENTER|EXIT)$"]: StateMachineEvent
...
}
StateMachine: {
@@ -40,15 +63,19 @@ package schema
}
GAMScheduler: {
TimingDataSource: string // type: reference
#meta: type: "scheduler"
...
}
TimingDataSource: {
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
IOGAM: {
InputSignals?: {...} // type: node
OutputSignals?: {...} // type: node
#meta: type: "gam"
...
}
ReferenceContainer: {
@@ -56,81 +83,114 @@ package schema
}
ConstantGAM: {
...
#meta: type: "gam"
}
PIDGAM: {
Kp: float | int // type: float (allow int as it promotes)
Ki: float | int
Kd: float | int
#meta: type: "gam"
...
}
FileDataSource: {
Filename: string
Format?: string
direction: "INOUT"
Filename: string
Format?: string
#meta: multithreaded: bool | *false
#meta: direction: "INOUT"
#meta: type: "datasource"
...
}
LoggerDataSource: {
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
DANStream: {
Timeout?: int
direction: "OUT"
Timeout?: int
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
EPICSCAInput: {
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
EPICSCAOutput: {
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
EPICSPVAInput: {
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
EPICSPVAOutput: {
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
SDNSubscriber: {
Address: string
Port: int
Interface?: string
direction: "IN"
ExecutionMode?: *"IndependentThread" | "RealTimeThread"
Topic!: string
Address?: string
Interface!: string
CPUs?: uint32
InternalTimeout?: uint32
Timeout?: uint32
IgnoreTimeoutError?: 0 | 1
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
SDNPublisher: {
Address: string
Port: int
Interface?: string
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
UDPReceiver: {
Port: int
Address?: string
direction: "IN"
Port: int
Address?: string
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
UDPSender: {
Destination: string
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
FileReader: {
Filename: string
Format?: string
Interpolate?: string
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
FileWriter: {
Filename: string
Format?: string
StoreOnTrigger?: int
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
OrderedClass: {
@@ -138,15 +198,25 @@ package schema
Second: string
...
}
BaseLib2GAM: {...}
ConversionGAM: {...}
DoubleHandshakeGAM: {...}
BaseLib2GAM: {
#meta: type: "gam"
...
}
ConversionGAM: {
#meta: type: "gam"
...
}
DoubleHandshakeGAM: {
#meta: type: "gam"
...
}
FilterGAM: {
Num: [...]
Den: [...]
ResetInEachState?: _
InputSignals?: {...}
OutputSignals?: {...}
#meta: type: "gam"
...
}
HistogramGAM: {
@@ -154,26 +224,60 @@ package schema
StateChangeResetName?: string
InputSignals?: {...}
OutputSignals?: {...}
#meta: type: "gam"
...
}
Interleaved2FlatGAM: {
#meta: type: "gam"
...
}
FlattenedStructIOGAM: {
#meta: type: "gam"
...
}
Interleaved2FlatGAM: {...}
FlattenedStructIOGAM: {...}
MathExpressionGAM: {
Expression: string
InputSignals?: {...}
OutputSignals?: {...}
#meta: type: "gam"
...
}
MessageGAM: {
#meta: type: "gam"
...
}
MuxGAM: {
#meta: type: "gam"
...
}
SimulinkWrapperGAM: {
#meta: type: "gam"
...
}
SSMGAM: {
#meta: type: "gam"
...
}
StatisticsGAM: {
#meta: type: "gam"
...
}
TimeCorrectionGAM: {
#meta: type: "gam"
...
}
TriggeredIOGAM: {
#meta: type: "gam"
...
}
WaveformGAM: {
#meta: type: "gam"
...
}
MessageGAM: {...}
MuxGAM: {...}
SimulinkWrapperGAM: {...}
SSMGAM: {...}
StatisticsGAM: {...}
TimeCorrectionGAM: {...}
TriggeredIOGAM: {...}
WaveformGAM: {...}
DAN: {
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
...
}
LinuxTimer: {
@@ -184,11 +288,15 @@ package schema
CPUMask?: int
TimeProvider?: {...}
Signals: {...}
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
LinkDataSource: {
direction: "INOUT"
#meta: multithreaded: bool | *false
#meta: direction: "INOUT"
#meta: type: "datasource"
...
}
MDSReader: {
@@ -196,7 +304,9 @@ package schema
ShotNumber: int
Frequency: float | int
Signals: {...}
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
MDSWriter: {
@@ -212,57 +322,88 @@ package schema
NumberOfPostTriggers?: int
Signals: {...}
Messages?: {...}
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
NI1588TimeStamp: {
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
NI6259ADC: {
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
NI6259DAC: {
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
NI6259DIO: {
direction: "INOUT"
#meta: multithreaded: bool | *false
#meta: direction: "INOUT"
#meta: type: "datasource"
...
}
NI6368ADC: {
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
NI6368DAC: {
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
NI6368DIO: {
direction: "INOUT"
#meta: multithreaded: bool | *false
#meta: direction: "INOUT"
#meta: type: "datasource"
...
}
NI9157CircularFifoReader: {
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
NI9157MxiDataSource: {
direction: "INOUT"
#meta: multithreaded: bool | *false
#meta: direction: "INOUT"
#meta: type: "datasource"
...
}
OPCUADSInput: {
direction: "IN"
#meta: multithreaded: bool | *false
#meta: direction: "IN"
#meta: type: "datasource"
...
}
OPCUADSOutput: {
direction: "OUT"
#meta: multithreaded: bool | *false
#meta: direction: "OUT"
#meta: type: "datasource"
...
}
RealTimeThreadAsyncBridge: {
#meta: direction: "INOUT"
#meta: multithreaded: bool | true
#meta: type: "datasource"
...
}
RealTimeThreadAsyncBridge: {...}
RealTimeThreadSynchronisation: {...}
UARTDataSource: {
direction: "INOUT"
#meta: multithreaded: bool | *false
#meta: direction: "INOUT"
#meta: type: "datasource"
...
}
BaseLib2Wrapper: {...}
@@ -272,16 +413,25 @@ package schema
OPCUA: {...}
SysLogger: {...}
GAMDataSource: {
direction: "INOUT"
#meta: multithreaded: false
#meta: direction: "INOUT"
#meta: type: "datasource"
...
}
}
#Meta: {
direction?: "IN" | "OUT" | "INOUT"
multithreaded?: bool
...
}
// Definition for any Object.
// It must have a Class field.
// Based on Class, it validates against #Classes.
#Object: {
Class: string
Class: string
"#meta"?: #Meta
// Allow any other field by default (extensibility),
// unless #Classes definition is closed.
// We allow open structs now.

View File

@@ -53,6 +53,11 @@ func (v *Validator) ValidateProject() {
for _, node := range v.Tree.IsolatedFiles {
v.validateNode(node)
}
v.CheckUnused()
v.CheckDataSourceThreading()
v.CheckINOUTOrdering()
v.CheckVariables()
v.CheckUnresolvedVariables()
}
func (v *Validator) validateNode(node *index.ProjectNode) {
@@ -91,7 +96,7 @@ func (v *Validator) validateNode(node *index.ProjectNode) {
className := ""
if node.RealName != "" && (node.RealName[0] == '+' || node.RealName[0] == '$') {
if classFields, ok := fields["Class"]; ok && len(classFields) > 0 {
className = v.getFieldValue(classFields[0])
className = v.getFieldValue(classFields[0], node)
}
hasType := false
@@ -184,7 +189,7 @@ func (v *Validator) nodeToMap(node *index.ProjectNode) map[string]interface{} {
for name, defs := range fields {
if len(defs) > 0 {
// Use the last definition (duplicates checked elsewhere)
m[name] = v.valueToInterface(defs[len(defs)-1].Value)
m[name] = v.valueToInterface(defs[len(defs)-1].Value, node)
}
}
@@ -203,13 +208,13 @@ func (v *Validator) nodeToMap(node *index.ProjectNode) map[string]interface{} {
return m
}
func (v *Validator) valueToInterface(val parser.Value) interface{} {
func (v *Validator) valueToInterface(val parser.Value, ctx *index.ProjectNode) interface{} {
switch t := val.(type) {
case *parser.StringValue:
return t.Value
case *parser.IntValue:
i, _ := strconv.ParseInt(t.Raw, 0, 64)
return i // CUE handles int64
return i
case *parser.FloatValue:
f, _ := strconv.ParseFloat(t.Raw, 64)
return f
@@ -217,10 +222,18 @@ func (v *Validator) valueToInterface(val parser.Value) interface{} {
return t.Value
case *parser.ReferenceValue:
return t.Value
case *parser.VariableReferenceValue:
name := strings.TrimPrefix(t.Name, "$")
if info := v.Tree.ResolveVariable(ctx, name); info != nil {
if info.Def.DefaultValue != nil {
return v.valueToInterface(info.Def.DefaultValue, ctx)
}
}
return nil
case *parser.ArrayValue:
var arr []interface{}
for _, e := range t.Elements {
arr = append(arr, v.valueToInterface(e))
arr = append(arr, v.valueToInterface(e, ctx))
}
return arr
}
@@ -284,7 +297,7 @@ func (v *Validator) validateGAMSignal(gamNode, signalNode *index.ProjectNode, di
fields := v.getFields(signalNode)
var dsName string
if dsFields, ok := fields["DataSource"]; ok && len(dsFields) > 0 {
dsName = v.getFieldValue(dsFields[0])
dsName = v.getFieldValue(dsFields[0], signalNode)
}
if dsName == "" {
@@ -313,8 +326,8 @@ func (v *Validator) validateGAMSignal(gamNode, signalNode *index.ProjectNode, di
dsClass := v.getNodeClass(dsNode)
if dsClass != "" {
// Lookup class definition in Schema
// path: #Classes.ClassName.direction
path := cue.ParsePath(fmt.Sprintf("#Classes.%s.direction", dsClass))
// path: #Classes.ClassName.#meta.direction
path := cue.ParsePath(fmt.Sprintf("#Classes.%s.#meta.direction", dsClass))
val := v.Schema.Value.LookupPath(path)
if val.Err() == nil {
@@ -343,7 +356,7 @@ func (v *Validator) validateGAMSignal(gamNode, signalNode *index.ProjectNode, di
// Check Signal Existence
targetSignalName := index.NormalizeName(signalNode.RealName)
if aliasFields, ok := fields["Alias"]; ok && len(aliasFields) > 0 {
targetSignalName = v.getFieldValue(aliasFields[0]) // Alias is usually the name in DataSource
targetSignalName = v.getFieldValue(aliasFields[0], signalNode) // Alias is usually the name in DataSource
}
var targetNode *index.ProjectNode
@@ -392,7 +405,7 @@ func (v *Validator) validateGAMSignal(gamNode, signalNode *index.ProjectNode, di
})
} else {
// Check Type validity even for implicit
typeVal := v.getFieldValue(typeFields[0])
typeVal := v.getFieldValue(typeFields[0], signalNode)
if !isValidType(typeVal) {
v.Diagnostics = append(v.Diagnostics, Diagnostic{
Level: LevelError,
@@ -418,7 +431,7 @@ func (v *Validator) validateGAMSignal(gamNode, signalNode *index.ProjectNode, di
// Check Type validity if present
if typeFields, ok := fields["Type"]; ok && len(typeFields) > 0 {
typeVal := v.getFieldValue(typeFields[0])
typeVal := v.getFieldValue(typeFields[0], signalNode)
if !isValidType(typeVal) {
v.Diagnostics = append(v.Diagnostics, Diagnostic{
Level: LevelError,
@@ -499,7 +512,7 @@ func (v *Validator) getFields(node *index.ProjectNode) map[string][]*parser.Fiel
return fields
}
func (v *Validator) getFieldValue(f *parser.Field) string {
func (v *Validator) getFieldValue(f *parser.Field, ctx *index.ProjectNode) string {
switch val := f.Value.(type) {
case *parser.StringValue:
return val.Value
@@ -509,6 +522,15 @@ func (v *Validator) getFieldValue(f *parser.Field) string {
return val.Raw
case *parser.FloatValue:
return val.Raw
case *parser.BoolValue:
return strconv.FormatBool(val.Value)
case *parser.VariableReferenceValue:
name := strings.TrimPrefix(val.Name, "$")
if info := v.Tree.ResolveVariable(ctx, name); info != nil {
if info.Def.DefaultValue != nil {
return v.getFieldValue(&parser.Field{Value: info.Def.DefaultValue}, ctx)
}
}
}
return ""
}
@@ -542,11 +564,6 @@ func isValidType(t string) bool {
return false
}
func (v *Validator) checkType(val parser.Value, expectedType string) bool {
// Legacy function, replaced by CUE.
return true
}
func (v *Validator) getFileForField(f *parser.Field, node *index.ProjectNode) string {
for _, frag := range node.Fragments {
for _, def := range frag.Definitions {
@@ -746,3 +763,373 @@ func (v *Validator) isGloballyAllowed(warningType string, contextFile string) bo
}
return false
}
func (v *Validator) CheckDataSourceThreading() {
if v.Tree.Root == nil {
return
}
// 1. Find RealTimeApplication
var appNode *index.ProjectNode
findApp := func(n *index.ProjectNode) {
if cls, ok := n.Metadata["Class"]; ok && cls == "RealTimeApplication" {
appNode = n
}
}
v.Tree.Walk(findApp)
if appNode == nil {
return
}
// 2. Find States
var statesNode *index.ProjectNode
if s, ok := appNode.Children["States"]; ok {
statesNode = s
} else {
for _, child := range appNode.Children {
if cls, ok := child.Metadata["Class"]; ok && cls == "StateMachine" {
statesNode = child
break
}
}
}
if statesNode == nil {
return
}
// 3. Iterate States
for _, state := range statesNode.Children {
dsUsage := make(map[*index.ProjectNode]string) // DS Node -> Thread Name
var threads []*index.ProjectNode
// Search for threads in the state (either direct children or inside "Threads" container)
for _, child := range state.Children {
if child.RealName == "Threads" {
for _, t := range child.Children {
if cls, ok := t.Metadata["Class"]; ok && cls == "RealTimeThread" {
threads = append(threads, t)
}
}
} else {
if cls, ok := child.Metadata["Class"]; ok && cls == "RealTimeThread" {
threads = append(threads, child)
}
}
}
for _, thread := range threads {
gams := v.getThreadGAMs(thread)
for _, gam := range gams {
dss := v.getGAMDataSources(gam)
for _, ds := range dss {
if existingThread, ok := dsUsage[ds]; ok {
if existingThread != thread.RealName {
if !v.isMultithreaded(ds) {
v.Diagnostics = append(v.Diagnostics, Diagnostic{
Level: LevelError,
Message: fmt.Sprintf("DataSource '%s' is not multithreaded but used in multiple threads (%s, %s) in state '%s'", ds.RealName, existingThread, thread.RealName, state.RealName),
Position: v.getNodePosition(gam),
File: v.getNodeFile(gam),
})
}
}
} else {
dsUsage[ds] = thread.RealName
}
}
}
}
}
}
func (v *Validator) getThreadGAMs(thread *index.ProjectNode) []*index.ProjectNode {
var gams []*index.ProjectNode
fields := v.getFields(thread)
if funcs, ok := fields["Functions"]; ok && len(funcs) > 0 {
f := funcs[0]
if arr, ok := f.Value.(*parser.ArrayValue); ok {
for _, elem := range arr.Elements {
if ref, ok := elem.(*parser.ReferenceValue); ok {
target := v.resolveReference(ref.Value, v.getNodeFile(thread), isGAM)
if target != nil {
gams = append(gams, target)
}
}
}
}
}
return gams
}
func (v *Validator) getGAMDataSources(gam *index.ProjectNode) []*index.ProjectNode {
dsMap := make(map[*index.ProjectNode]bool)
processSignals := func(container *index.ProjectNode) {
if container == nil {
return
}
for _, sig := range container.Children {
fields := v.getFields(sig)
if dsFields, ok := fields["DataSource"]; ok && len(dsFields) > 0 {
dsName := v.getFieldValue(dsFields[0], sig)
dsNode := v.resolveReference(dsName, v.getNodeFile(sig), isDataSource)
if dsNode != nil {
dsMap[dsNode] = true
}
}
}
}
processSignals(gam.Children["InputSignals"])
processSignals(gam.Children["OutputSignals"])
var dss []*index.ProjectNode
for ds := range dsMap {
dss = append(dss, ds)
}
return dss
}
func (v *Validator) isMultithreaded(ds *index.ProjectNode) bool {
if meta, ok := ds.Children["#meta"]; ok {
fields := v.getFields(meta)
if mt, ok := fields["multithreaded"]; ok && len(mt) > 0 {
val := v.getFieldValue(mt[0], meta)
return val == "true"
}
}
return false
}
func (v *Validator) CheckINOUTOrdering() {
if v.Tree.Root == nil {
return
}
var appNode *index.ProjectNode
findApp := func(n *index.ProjectNode) {
if cls, ok := n.Metadata["Class"]; ok && cls == "RealTimeApplication" {
appNode = n
}
}
v.Tree.Walk(findApp)
if appNode == nil {
return
}
var statesNode *index.ProjectNode
if s, ok := appNode.Children["States"]; ok {
statesNode = s
} else {
for _, child := range appNode.Children {
if cls, ok := child.Metadata["Class"]; ok && cls == "StateMachine" {
statesNode = child
break
}
}
}
if statesNode == nil {
return
}
for _, state := range statesNode.Children {
var threads []*index.ProjectNode
for _, child := range state.Children {
if child.RealName == "Threads" {
for _, t := range child.Children {
if cls, ok := t.Metadata["Class"]; ok && cls == "RealTimeThread" {
threads = append(threads, t)
}
}
} else {
if cls, ok := child.Metadata["Class"]; ok && cls == "RealTimeThread" {
threads = append(threads, child)
}
}
}
for _, thread := range threads {
producedSignals := make(map[*index.ProjectNode]map[string][]*index.ProjectNode)
consumedSignals := make(map[*index.ProjectNode]map[string]bool)
gams := v.getThreadGAMs(thread)
for _, gam := range gams {
v.processGAMSignalsForOrdering(gam, "InputSignals", producedSignals, consumedSignals, true, thread, state)
v.processGAMSignalsForOrdering(gam, "OutputSignals", producedSignals, consumedSignals, false, thread, state)
}
// Check for produced but not consumed
for ds, signals := range producedSignals {
for sigName, producers := range signals {
consumed := false
if cSet, ok := consumedSignals[ds]; ok {
if cSet[sigName] {
consumed = true
}
}
if !consumed {
for _, prod := range producers {
v.Diagnostics = append(v.Diagnostics, Diagnostic{
Level: LevelWarning,
Message: fmt.Sprintf("INOUT Signal '%s' (DS '%s') is produced in thread '%s' but never consumed in the same thread.", sigName, ds.RealName, thread.RealName),
Position: v.getNodePosition(prod),
File: v.getNodeFile(prod),
})
}
}
}
}
}
}
}
func (v *Validator) processGAMSignalsForOrdering(gam *index.ProjectNode, containerName string, produced map[*index.ProjectNode]map[string][]*index.ProjectNode, consumed map[*index.ProjectNode]map[string]bool, isInput bool, thread, state *index.ProjectNode) {
container := gam.Children[containerName]
if container == nil {
return
}
for _, sig := range container.Children {
fields := v.getFields(sig)
var dsNode *index.ProjectNode
var sigName string
if sig.Target != nil {
if sig.Target.Parent != nil && sig.Target.Parent.Parent != nil {
dsNode = sig.Target.Parent.Parent
sigName = sig.Target.RealName
}
}
if dsNode == nil {
if dsFields, ok := fields["DataSource"]; ok && len(dsFields) > 0 {
dsName := v.getFieldValue(dsFields[0], sig)
dsNode = v.resolveReference(dsName, v.getNodeFile(sig), isDataSource)
}
if aliasFields, ok := fields["Alias"]; ok && len(aliasFields) > 0 {
sigName = v.getFieldValue(aliasFields[0], sig)
} else {
sigName = sig.RealName
}
}
if dsNode == nil || sigName == "" {
continue
}
sigName = index.NormalizeName(sigName)
if v.isMultithreaded(dsNode) {
continue
}
dir := v.getDataSourceDirection(dsNode)
if dir != "INOUT" {
continue
}
if isInput {
isProduced := false
if set, ok := produced[dsNode]; ok {
if len(set[sigName]) > 0 {
isProduced = true
}
}
if !isProduced {
v.Diagnostics = append(v.Diagnostics, Diagnostic{
Level: LevelError,
Message: fmt.Sprintf("INOUT Signal '%s' (DS '%s') is consumed by GAM '%s' in thread '%s' (State '%s') before being produced by any previous GAM.", sigName, dsNode.RealName, gam.RealName, thread.RealName, state.RealName),
Position: v.getNodePosition(sig),
File: v.getNodeFile(sig),
})
}
if consumed[dsNode] == nil {
consumed[dsNode] = make(map[string]bool)
}
consumed[dsNode][sigName] = true
} else {
if produced[dsNode] == nil {
produced[dsNode] = make(map[string][]*index.ProjectNode)
}
produced[dsNode][sigName] = append(produced[dsNode][sigName], sig)
}
}
}
func (v *Validator) getDataSourceDirection(ds *index.ProjectNode) string {
cls := v.getNodeClass(ds)
if cls == "" {
return ""
}
if v.Schema == nil {
return ""
}
path := cue.ParsePath(fmt.Sprintf("#Classes.%s.#meta.direction", cls))
val := v.Schema.Value.LookupPath(path)
if val.Err() == nil {
s, _ := val.String()
return s
}
return ""
}
func (v *Validator) CheckVariables() {
if v.Schema == nil {
return
}
ctx := v.Schema.Context
checkNodeVars := func(node *index.ProjectNode) {
for _, info := range node.Variables {
def := info.Def
// Compile Type
typeVal := ctx.CompileString(def.TypeExpr)
if typeVal.Err() != nil {
v.Diagnostics = append(v.Diagnostics, Diagnostic{
Level: LevelError,
Message: fmt.Sprintf("Invalid type expression for variable '%s': %v", def.Name, typeVal.Err()),
Position: def.Position,
File: info.File,
})
continue
}
if def.DefaultValue != nil {
valInterface := v.valueToInterface(def.DefaultValue, node)
valVal := ctx.Encode(valInterface)
// Unify
res := typeVal.Unify(valVal)
if err := res.Validate(cue.Concrete(true)); err != nil {
v.Diagnostics = append(v.Diagnostics, Diagnostic{
Level: LevelError,
Message: fmt.Sprintf("Variable '%s' value mismatch: %v", def.Name, err),
Position: def.Position,
File: info.File,
})
}
}
}
}
v.Tree.Walk(checkNodeVars)
}
func (v *Validator) CheckUnresolvedVariables() {
for _, ref := range v.Tree.References {
if ref.IsVariable && ref.TargetVariable == nil {
v.Diagnostics = append(v.Diagnostics, Diagnostic{
Level: LevelError,
Message: fmt.Sprintf("Unresolved variable reference: '$%s'", ref.Name),
Position: ref.Position,
File: ref.File,
})
}
}
}

View File

@@ -21,11 +21,12 @@ The executable should support the following subcommands:
The LSP server should provide the following capabilities:
- **Diagnostics**: Report syntax errors and validation issues.
- **Incremental Sync**: Supports `textDocumentSync` kind 2 (Incremental) for better performance with large files.
- **Hover Documentation**:
- **Objects**: Display `CLASS::Name` and any associated docstrings.
- **Signals**: Display `DataSource.Name TYPE (SIZE) [IN/OUT/INOUT]` along with docstrings.
- **GAMs**: Show the list of States where the GAM is referenced.
- **Referenced Signals**: Show the list of GAMs where the signal is referenced.
- **Referenced Signals**: Show the list of GAMs where the signal is referenced (indicating Input/Output direction).
- **Go to Definition**: Jump to the definition of a reference, supporting navigation across any file in the current project.
- **Go to References**: Find usages of a node or field, supporting navigation across any file in the current project.
- **Code Completion**: Autocomplete fields, values, and references.
@@ -34,6 +35,13 @@ The LSP server should provide the following capabilities:
- **Reference Suggestions**:
- `DataSource` fields suggest available DataSource objects.
- `Functions` (in Threads) suggest available GAM objects.
- **Signal Completion**: Inside `InputSignals` or `OutputSignals` of a GAM:
- Suggests available signals from valid DataSources (filtering by direction: `IN`/`INOUT` for Inputs, `OUT`/`INOUT` for Outputs).
- Format: `SIGNAL_NAME:DATASOURCE_NAME`.
- Auto-inserts: `SIGNAL_NAME = { DataSource = DATASOURCE_NAME }`.
- **Rename Symbol**: Rename an object, field, or reference across the entire project scope.
- Supports renaming of Definitions (`+Name` or `Name`), preserving any modifiers (`+`/`$`).
- Updates all references to the renamed symbol, including qualified references (e.g., `Pkg.Name`).
- **Code Snippets**: Provide snippets for common patterns (e.g., `+Object = { ... }`).
- **Formatting**: Format the document using the same rules and engine as the `fmt` command.
@@ -50,7 +58,7 @@ The LSP server should provide the following capabilities:
- **Build Process**:
- The build tool merges all files sharing the same base namespace into a **single output configuration**.
- **Namespace Consistency**: The build tool must verify that all input files belong to the same project namespace (the first segment of the `#package` URI). If multiple project namespaces are detected, the build must fail with an error.
- **Target**: The build output is written to a single target file (e.g., provided via CLI or API).
- **Target**: The build output is written to standard output (`stdout`) by default. It can be written to a target file if the `-o` (or `--output`) argument is provided via CLI.
- **Multi-File Definitions**: Nodes and objects can be defined across multiple files. The build tool, validator, and LSP must merge these definitions (including all fields and sub-nodes) from the entire project to create a unified view before processing or validating.
- **Global References**: References to nodes, signals, or objects can point to definitions located in any file within the project. Support for dot-separated paths (e.g., `Node.SubNode`) is required.
- **Merging Order**: For objects defined across multiple files, definitions are merged. The build tool must preserve the relative order of fields and sub-nodes as they appear in the source files, interleaving them correctly in the final output.
@@ -166,6 +174,7 @@ The tool must build an index of the configuration to support LSP features and va
- **Conditional Fields**: Validation of fields whose presence or value depends on the values of other fields within the same node or context.
- **Schema Definition**:
- Class validation rules must be defined in a separate schema file using the **CUE** language.
- **Metadata**: Class properties like direction (`#direction`) and multithreading support (`#multithreaded`) are stored within a `#meta` field in the class definition (e.g., `#meta: { direction: "IN", multithreaded: true }`).
- **Project-Specific Classes**: Developers can define their own project-specific classes and corresponding validation rules, expanding the validation capabilities for their specific needs.
- **Schema Loading**:
- **Default Schema**: The tool should look for a default schema file `marte_schema.cue` in standard system locations:
@@ -211,6 +220,7 @@ The LSP and `check` command should report the following:
- Field type mismatches.
- Grammar errors (e.g., missing closing brackets).
- **Invalid Function Reference**: Elements in the `Functions` array of a `State.Thread` must be valid references to defined GAM nodes.
- **Threading Violation**: A DataSource that is not marked as multithreaded (via `#meta.multithreaded`) is used by GAMs running in different threads within the same State.
## Logging

109
test/ast_test.go Normal file
View File

@@ -0,0 +1,109 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestASTCoverage(t *testing.T) {
pos := parser.Position{Line: 1, Column: 1}
var n parser.Node
var d parser.Definition
var v parser.Value
// Field
f := &parser.Field{Position: pos}
n = f
d = f
if n.Pos() != pos {
t.Error("Field.Pos failed")
}
_ = d
// ObjectNode
o := &parser.ObjectNode{Position: pos}
n = o
d = o
if n.Pos() != pos {
t.Error("ObjectNode.Pos failed")
}
// StringValue
sv := &parser.StringValue{Position: pos}
n = sv
v = sv
if n.Pos() != pos {
t.Error("StringValue.Pos failed")
}
_ = v
// IntValue
iv := &parser.IntValue{Position: pos}
n = iv
v = iv
if n.Pos() != pos {
t.Error("IntValue.Pos failed")
}
// FloatValue
fv := &parser.FloatValue{Position: pos}
n = fv
v = fv
if n.Pos() != pos {
t.Error("FloatValue.Pos failed")
}
// BoolValue
bv := &parser.BoolValue{Position: pos}
n = bv
v = bv
if n.Pos() != pos {
t.Error("BoolValue.Pos failed")
}
// ReferenceValue
rv := &parser.ReferenceValue{Position: pos}
n = rv
v = rv
if n.Pos() != pos {
t.Error("ReferenceValue.Pos failed")
}
// ArrayValue
av := &parser.ArrayValue{Position: pos}
n = av
v = av
if n.Pos() != pos {
t.Error("ArrayValue.Pos failed")
}
// Package
pkg := &parser.Package{Position: pos}
n = pkg
if n.Pos() != pos {
t.Error("Package.Pos failed")
}
// Subnode
sn := &parser.Subnode{Position: pos}
n = sn
if n.Pos() != pos {
t.Error("Subnode.Pos failed")
}
// Comment
cmt := &parser.Comment{Position: pos}
n = cmt
if n.Pos() != pos {
t.Error("Comment.Pos failed")
}
// Pragma
prg := &parser.Pragma{Position: pos}
n = prg
if n.Pos() != pos {
t.Error("Pragma.Pos failed")
}
}

View File

@@ -32,7 +32,7 @@ FieldB = 20
os.WriteFile("build_multi_test/f2.marte", []byte(f2Content), 0644)
// Execute Build
b := builder.NewBuilder([]string{"build_multi_test/f1.marte", "build_multi_test/f2.marte"})
b := builder.NewBuilder([]string{"build_multi_test/f1.marte", "build_multi_test/f2.marte"}, nil)
// Prepare output file
// Should be +MyObj.marte (normalized MyObj.marte) - Actually checking content

View File

@@ -0,0 +1,45 @@
package integration
import (
"bytes"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/formatter"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestFormatterVariables(t *testing.T) {
content := `
#var MyInt: int = 10
#var MyStr: string | "A" = "default"
+Obj = {
Field1 = $MyInt
Field2 = $MyStr
}
`
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatalf("Parse failed: %v", err)
}
var buf bytes.Buffer
formatter.Format(cfg, &buf)
output := buf.String()
// Parser reconstructs type expression with spaces
if !strings.Contains(output, "#var MyInt: int = 10") {
t.Errorf("Variable MyInt formatted incorrectly. Got:\n%s", output)
}
// Note: parser adds space after each token in TypeExpr
// string | "A" -> "string | \"A\""
if !strings.Contains(output, "#var MyStr: string | \"A\" = \"default\"") {
t.Errorf("Variable MyStr formatted incorrectly. Got:\n%s", output)
}
if !strings.Contains(output, "Field1 = $MyInt") {
t.Errorf("Variable reference $MyInt formatted incorrectly. Got:\n%s", output)
}
}

View File

@@ -0,0 +1,58 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestIndexCleanup(t *testing.T) {
idx := index.NewProjectTree()
file := "cleanup.marte"
content := `
#package Pkg
+Node = { Class = Type }
`
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
idx.AddFile(file, cfg)
// Check node exists
// Root -> Pkg -> Node
pkgNode := idx.Root.Children["Pkg"]
if pkgNode == nil {
t.Fatal("Pkg node should exist")
}
if pkgNode.Children["Node"] == nil {
t.Fatal("Node should exist")
}
// Update file: remove +Node
content2 := `
#package Pkg
// Removed node
`
p2 := parser.NewParser(content2)
cfg2, _ := p2.Parse()
idx.AddFile(file, cfg2)
// Check Node is gone
pkgNode = idx.Root.Children["Pkg"]
if pkgNode == nil {
// Pkg should exist because of #package Pkg
t.Fatal("Pkg node should exist after update")
}
if pkgNode.Children["Node"] != nil {
t.Error("Node should be gone")
}
// Test removing file completely
idx.RemoveFile(file)
if len(idx.Root.Children) != 0 {
t.Errorf("Root should be empty after removing file, got %d children", len(idx.Root.Children))
}
}

66
test/index_test.go Normal file
View File

@@ -0,0 +1,66 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
)
func TestNodeMap(t *testing.T) {
pt := index.NewProjectTree()
root := pt.Root
// Create structure: +A -> +B -> +C
nodeA := &index.ProjectNode{Name: "A", RealName: "+A", Children: make(map[string]*index.ProjectNode), Parent: root}
root.Children["A"] = nodeA
nodeB := &index.ProjectNode{Name: "B", RealName: "+B", Children: make(map[string]*index.ProjectNode), Parent: nodeA}
nodeA.Children["B"] = nodeB
nodeC := &index.ProjectNode{Name: "C", RealName: "+C", Children: make(map[string]*index.ProjectNode), Parent: nodeB}
nodeB.Children["C"] = nodeC
// Rebuild Index
pt.RebuildIndex()
// Find by Name
found := pt.FindNode(root, "C", nil)
if found != nodeC {
t.Errorf("FindNode(C) failed. Got %v, want %v", found, nodeC)
}
// Find by RealName
found = pt.FindNode(root, "+C", nil)
if found != nodeC {
t.Errorf("FindNode(+C) failed. Got %v, want %v", found, nodeC)
}
// Find by Path
found = pt.FindNode(root, "A.B.C", nil)
if found != nodeC {
t.Errorf("FindNode(A.B.C) failed. Got %v, want %v", found, nodeC)
}
// Find by Path with RealName
found = pt.FindNode(root, "+A.+B.+C", nil)
if found != nodeC {
t.Errorf("FindNode(+A.+B.+C) failed. Got %v, want %v", found, nodeC)
}
}
func TestResolveReferencesWithMap(t *testing.T) {
pt := index.NewProjectTree()
root := pt.Root
nodeA := &index.ProjectNode{Name: "A", RealName: "+A", Children: make(map[string]*index.ProjectNode), Parent: root}
root.Children["A"] = nodeA
ref := index.Reference{Name: "A", File: "test.marte"}
pt.References = append(pt.References, ref)
pt.ResolveReferences()
if pt.References[0].Target != nodeA {
t.Error("ResolveReferences failed to resolve A")
}
}

View File

@@ -168,7 +168,7 @@ func TestBuildCommand(t *testing.T) {
// Test Merge
files := []string{"integration/build_merge_1.marte", "integration/build_merge_2.marte"}
b := builder.NewBuilder(files)
b := builder.NewBuilder(files, nil)
outputFile, err := os.Create("build_test/TEST.marte")
if err != nil {
@@ -195,7 +195,7 @@ func TestBuildCommand(t *testing.T) {
// Test Order (Class First)
filesOrder := []string{"integration/build_order_1.marte", "integration/build_order_2.marte"}
bOrder := builder.NewBuilder(filesOrder)
bOrder := builder.NewBuilder(filesOrder, nil)
outputFileOrder, err := os.Create("build_test/ORDER.marte")
if err != nil {

59
test/logger_test.go Normal file
View File

@@ -0,0 +1,59 @@
package integration
import (
"os"
"os/exec"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/logger"
)
func TestLoggerPrint(t *testing.T) {
if os.Getenv("TEST_LOGGER_PRINT") == "1" {
logger.Printf("Test Printf %d", 123)
logger.Println("Test Println")
return
}
cmd := exec.Command(os.Args[0], "-test.run=TestLoggerPrint")
cmd.Env = append(os.Environ(), "TEST_LOGGER_PRINT=1")
out, err := cmd.CombinedOutput()
if err != nil {
t.Fatalf("process failed: %v", err)
}
output := string(out)
if !strings.Contains(output, "Test Printf 123") {
t.Error("Printf output missing")
}
if !strings.Contains(output, "Test Println") {
t.Error("Println output missing")
}
}
func TestLoggerFatal(t *testing.T) {
if os.Getenv("TEST_LOGGER_FATAL") == "1" {
logger.Fatal("Test Fatal")
return
}
cmd := exec.Command(os.Args[0], "-test.run=TestLoggerFatal")
cmd.Env = append(os.Environ(), "TEST_LOGGER_FATAL=1")
err := cmd.Run()
if e, ok := err.(*exec.ExitError); ok && !e.Success() {
return // Success (exit code non-zero)
}
t.Fatalf("process ran with err %v, want exit status 1", err)
}
func TestLoggerFatalf(t *testing.T) {
if os.Getenv("TEST_LOGGER_FATALF") == "1" {
logger.Fatalf("Test Fatalf %d", 456)
return
}
cmd := exec.Command(os.Args[0], "-test.run=TestLoggerFatalf")
cmd.Env = append(os.Environ(), "TEST_LOGGER_FATALF=1")
err := cmd.Run()
if e, ok := err.(*exec.ExitError); ok && !e.Success() {
return // Success
}
t.Fatalf("process ran with err %v, want exit status 1", err)
}

View File

@@ -0,0 +1,90 @@
package integration
import (
"bytes"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/schema"
)
func TestLSPAppTestRepro(t *testing.T) {
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
lsp.GlobalSchema = schema.LoadFullSchema(".")
var buf bytes.Buffer
lsp.Output = &buf
content := `+App = {
Class = RealTimeApplication
+Data = {
Class = ReferenceContainer
DefaultDataSource = DDB
+DDB = {
Class = GAMDataSource
}
+TimingDataSource = {
Class = TimingDataSource
}
}
+Functions = {
Class = ReferenceContainer
+FnA = {
Class = IOGAM
InputSignals = {
A = {
DataSource = DDB
Type = uint32
Value = $Value
}
}
OutputSignals = {
B = {
DataSource = DDB
Type = uint32
}
}
}
}
+States = {
Class = ReferenceContainer
+State = {
Class = RealTimeState
Threads = {
+Th1 = {
Class = RealTimeThread
Functions = { FnA }
}
}
}
}
+Scheduler = {
Class = GAMScheduler
TimingDataSource = TimingDataSource
}
}
`
uri := "file://examples/app_test.marte"
lsp.HandleDidOpen(lsp.DidOpenTextDocumentParams{
TextDocument: lsp.TextDocumentItem{URI: uri, Text: content},
})
output := buf.String()
// Check Unresolved Variable
if !strings.Contains(output, "Unresolved variable reference: '$Value'") {
t.Error("LSP missing unresolved variable error")
}
// Check INOUT consumed but not produced
if !strings.Contains(output, "consumed by GAM '+FnA'") {
t.Error("LSP missing consumed but not produced error")
}
if t.Failed() {
t.Log(output)
}
}

167
test/lsp_binary_test.go Normal file
View File

@@ -0,0 +1,167 @@
package integration
import (
"bufio"
"encoding/json"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
"time"
)
func TestLSPBinaryDiagnostics(t *testing.T) {
// 1. Build mdt
// Ensure we are in test directory context
buildCmd := exec.Command("go", "build", "-o", "../build/mdt", "../cmd/mdt")
if output, err := buildCmd.CombinedOutput(); err != nil {
t.Fatalf("Failed to build mdt: %v\nOutput: %s", err, output)
}
// 2. Start mdt lsp
cmd := exec.Command("../build/mdt", "lsp")
stdin, _ := cmd.StdinPipe()
stdout, _ := cmd.StdoutPipe()
stderr, _ := cmd.StderrPipe()
// Pipe stderr to test log for debugging
go func() {
scanner := bufio.NewScanner(stderr)
for scanner.Scan() {
t.Logf("LSP STDERR: %s", scanner.Text())
}
}()
if err := cmd.Start(); err != nil {
t.Fatalf("Failed to start mdt lsp: %v", err)
}
defer func() {
cmd.Process.Kill()
cmd.Wait()
}()
reader := bufio.NewReader(stdout)
send := func(m interface{}) {
body, _ := json.Marshal(m)
msg := fmt.Sprintf("Content-Length: %d\r\n\r\n%s", len(body), body)
stdin.Write([]byte(msg))
}
readCh := make(chan map[string]interface{}, 100)
go func() { for {
// Parse Header
line, err := reader.ReadString('\n')
if err != nil {
close(readCh)
return
}
var length int
// Handle Content-Length: <len>\r\n
if _, err := fmt.Sscanf(strings.TrimSpace(line), "Content-Length: %d", &length); err != nil {
// Maybe empty line or other header?
continue
}
// Read until empty line (\r\n)
for {
l, err := reader.ReadString('\n')
if err != nil {
close(readCh)
return
}
if l == "\r\n" {
break
}
}
body := make([]byte, length)
if _, err := io.ReadFull(reader, body); err != nil {
close(readCh)
return
}
var m map[string]interface{}
if err := json.Unmarshal(body, &m); err == nil {
readCh <- m
}
}
}()
cwd, _ := os.Getwd()
projectRoot := filepath.Dir(cwd)
absPath := filepath.Join(projectRoot, "examples/app_test.marte")
uri := "file://" + absPath
// 3. Initialize
examplesDir := filepath.Join(projectRoot, "examples")
send(map[string]interface{}{
"jsonrpc": "2.0",
"id": 1,
"method": "initialize",
"params": map[string]interface{}{
"rootUri": "file://" + examplesDir,
},
})
// 4. Open app_test.marte
content, err := os.ReadFile(absPath)
if err != nil {
t.Fatalf("Failed to read test file: %v", err)
}
send(map[string]interface{}{
"jsonrpc": "2.0",
"method": "textDocument/didOpen",
"params": map[string]interface{}{
"textDocument": map[string]interface{}{
"uri": uri,
"languageId": "marte",
"version": 1,
"text": string(content),
},
},
})
// 5. Wait for diagnostics
foundOrdering := false
foundVariable := false
timeout := time.After(30 * time.Second)
for {
select {
case msg, ok := <-readCh:
if !ok {
t.Fatal("LSP stream closed unexpectedly")
}
t.Logf("Received: %v", msg)
if method, ok := msg["method"].(string); ok && method == "textDocument/publishDiagnostics" {
params := msg["params"].(map[string]interface{})
// Check URI match?
// if params["uri"] != uri { continue } // Might be absolute vs relative
diags := params["diagnostics"].([]interface{})
for _, d := range diags {
m := d.(map[string]interface{})["message"].(string)
if strings.Contains(m, "INOUT Signal 'A'") {
foundOrdering = true
t.Log("Found Ordering error")
}
if strings.Contains(m, "Unresolved variable reference: '$Value'") {
foundVariable = true
t.Log("Found Variable error")
}
}
if foundOrdering && foundVariable {
return // Success
}
}
case <-timeout:
t.Fatal("Timeout waiting for diagnostics")
}
}
}

View File

@@ -0,0 +1,90 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/schema"
)
func TestSuggestSignalsRobustness(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
lsp.ProjectRoot = "."
lsp.GlobalSchema = schema.NewSchema()
// Inject schema with INOUT
custom := []byte(`
package schema
#Classes: {
InOutReader: { #meta: direction: "INOUT" }
}
`)
val := lsp.GlobalSchema.Context.CompileBytes(custom)
lsp.GlobalSchema.Value = lsp.GlobalSchema.Value.Unify(val)
content := `
+DS = {
Class = InOutReader
+Signals = {
Sig = { Type = uint32 }
}
}
+GAM = {
Class = IOGAM
+InputSignals = {
}
+OutputSignals = {
}
}
`
uri := "file://robust.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("robust.marte", cfg)
// Check Input (Line 10)
paramsIn := lsp.CompletionParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 10, Character: 8},
}
listIn := lsp.HandleCompletion(paramsIn)
found := false
if listIn != nil {
for _, item := range listIn.Items {
if item.Label == "DS:Sig" {
found = true
}
}
}
if !found {
t.Error("INOUT signal not found in InputSignals")
}
// Check Output (Line 13)
paramsOut := lsp.CompletionParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 13, Character: 8},
}
listOut := lsp.HandleCompletion(paramsOut)
found = false
if listOut != nil {
for _, item := range listOut.Items {
if item.Label == "DS:Sig" {
found = true
}
}
}
if !found {
t.Error("INOUT signal not found in OutputSignals")
}
}

View File

@@ -0,0 +1,128 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/schema"
)
func TestSuggestSignalsInGAM(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
lsp.ProjectRoot = "."
lsp.GlobalSchema = schema.NewSchema()
// Inject schema for directionality
custom := []byte(`
package schema
#Classes: {
FileReader: { direction: "IN" }
FileWriter: { direction: "OUT" }
}
`)
val := lsp.GlobalSchema.Context.CompileBytes(custom)
lsp.GlobalSchema.Value = lsp.GlobalSchema.Value.Unify(val)
content := `
+InDS = {
Class = FileReader
+Signals = {
InSig = { Type = uint32 }
}
}
+OutDS = {
Class = FileWriter
+Signals = {
OutSig = { Type = uint32 }
}
}
+GAM = {
Class = IOGAM
+InputSignals = {
}
+OutputSignals = {
}
}
`
uri := "file://signals.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("signals.marte", cfg)
// 1. Suggest in InputSignals
// Line 16 (empty line inside InputSignals)
paramsIn := lsp.CompletionParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 16, Character: 8},
}
listIn := lsp.HandleCompletion(paramsIn)
if listIn == nil {
t.Fatal("Expected suggestions in InputSignals")
}
foundIn := false
foundOut := false
for _, item := range listIn.Items {
if item.Label == "InDS:InSig" {
foundIn = true
// Normalize spaces for check
insert := strings.ReplaceAll(item.InsertText, " ", "")
expected := "InSig={DataSource=InDS}"
if !strings.Contains(insert, expected) && !strings.Contains(item.InsertText, "InSig = {") {
// Snippet might differ slightly, but should contain essentials
t.Errorf("InsertText mismatch: %s", item.InsertText)
}
}
if item.Label == "OutDS:OutSig" {
foundOut = true
}
}
if !foundIn {
t.Error("Did not find InDS:InSig")
}
if foundOut {
t.Error("Should not find OutDS:OutSig in InputSignals")
}
// 2. Suggest in OutputSignals
// Line 19
paramsOut := lsp.CompletionParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 19, Character: 8},
}
listOut := lsp.HandleCompletion(paramsOut)
if listOut == nil {
t.Fatal("Expected suggestions in OutputSignals")
}
foundIn = false
foundOut = false
for _, item := range listOut.Items {
if item.Label == "InDS:InSig" {
foundIn = true
}
if item.Label == "OutDS:OutSig" {
foundOut = true
}
}
if foundIn {
t.Error("Should not find InDS:InSig in OutputSignals")
}
if !foundOut {
t.Error("Did not find OutDS:OutSig in OutputSignals")
}
}

110
test/lsp_coverage_test.go Normal file
View File

@@ -0,0 +1,110 @@
package integration
import (
"bytes"
"encoding/json"
"os"
"os/exec"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/lsp"
)
func TestLSPIncrementalSync(t *testing.T) {
lsp.Documents = make(map[string]string)
var buf bytes.Buffer
lsp.Output = &buf
content := "Line1\nLine2\nLine3"
uri := "file://inc.marte"
lsp.Documents[uri] = content
// Replace "Line2" (Line 1, 0-5) with "Modified"
change := lsp.TextDocumentContentChangeEvent{
Range: &lsp.Range{
Start: lsp.Position{Line: 1, Character: 0},
End: lsp.Position{Line: 1, Character: 5},
},
Text: "Modified",
}
params := lsp.DidChangeTextDocumentParams{
TextDocument: lsp.VersionedTextDocumentIdentifier{URI: uri, Version: 2},
ContentChanges: []lsp.TextDocumentContentChangeEvent{change},
}
lsp.HandleDidChange(params)
expected := "Line1\nModified\nLine3"
if lsp.Documents[uri] != expected {
t.Errorf("Incremental update failed. Got:\n%q\nWant:\n%q", lsp.Documents[uri], expected)
}
// Insert at end
change2 := lsp.TextDocumentContentChangeEvent{
Range: &lsp.Range{
Start: lsp.Position{Line: 2, Character: 5},
End: lsp.Position{Line: 2, Character: 5},
},
Text: "\nLine4",
}
params2 := lsp.DidChangeTextDocumentParams{
TextDocument: lsp.VersionedTextDocumentIdentifier{URI: uri, Version: 3},
ContentChanges: []lsp.TextDocumentContentChangeEvent{change2},
}
lsp.HandleDidChange(params2)
expected2 := "Line1\nModified\nLine3\nLine4"
if lsp.Documents[uri] != expected2 {
t.Errorf("Incremental insert failed. Got:\n%q\nWant:\n%q", lsp.Documents[uri], expected2)
}
}
func TestLSPLifecycle(t *testing.T) {
var buf bytes.Buffer
lsp.Output = &buf
// Shutdown
msgShutdown := &lsp.JsonRpcMessage{
Method: "shutdown",
ID: 1,
}
lsp.HandleMessage(msgShutdown)
if !strings.Contains(buf.String(), `"result":null`) {
t.Error("Shutdown response incorrect")
}
// Exit
if os.Getenv("TEST_LSP_EXIT") == "1" {
msgExit := &lsp.JsonRpcMessage{Method: "exit"}
lsp.HandleMessage(msgExit)
return
}
cmd := exec.Command(os.Args[0], "-test.run=TestLSPLifecycle")
cmd.Env = append(os.Environ(), "TEST_LSP_EXIT=1")
err := cmd.Run()
if err != nil {
t.Errorf("Exit failed: %v", err)
}
}
func TestLSPMalformedParams(t *testing.T) {
var buf bytes.Buffer
lsp.Output = &buf
// Malformed Hover
msg := &lsp.JsonRpcMessage{
Method: "textDocument/hover",
ID: 2,
Params: json.RawMessage(`{invalid`),
}
lsp.HandleMessage(msg)
output := buf.String()
// Should respond with nil result
if !strings.Contains(output, `"result":null`) {
t.Errorf("Expected nil result for malformed params, got: %s", output)
}
}

74
test/lsp_crash_test.go Normal file
View File

@@ -0,0 +1,74 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestLSPCrashOnUndefinedReference(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
content := `
+App = {
Class = RealTimeApplication
+State = {
Class = RealTimeState
+Thread = {
Class = RealTimeThread
Functions = { UndefinedGAM }
}
}
}
`
uri := "file://crash.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("crash.marte", cfg)
lsp.Tree.ResolveReferences()
// Line 7: " Functions = { UndefinedGAM }"
// 12 spaces + "Functions" (9) + " = { " (5) = 26 chars prefix.
// UndefinedGAM starts at 26.
params := lsp.DefinitionParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 7, Character: 27},
}
// This should NOT panic
defer func() {
if r := recover(); r != nil {
t.Errorf("Recovered from panic: %v", r)
}
}()
res := lsp.HandleDefinition(params)
if res != nil {
t.Error("Expected nil for undefined reference definition")
}
// 2. Hover
hParams := lsp.HoverParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 7, Character: 27},
}
hover := lsp.HandleHover(hParams)
if hover == nil {
t.Error("Expected hover for unresolved reference")
} else {
content := hover.Contents.(lsp.MarkupContent).Value
if !strings.Contains(content, "Unresolved") {
t.Errorf("Expected 'Unresolved' in hover, got: %s", content)
}
}
}

View File

@@ -0,0 +1,161 @@
package integration
import (
"bytes"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/schema"
)
func TestLSPDiagnosticsAppTest(t *testing.T) {
// Setup LSP environment
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
lsp.GlobalSchema = schema.LoadFullSchema(".") // Use default schema
// Capture output
var buf bytes.Buffer
lsp.Output = &buf
// Content from examples/app_test.marte (implicit signals, unresolved var, ordering error)
content := `+App = {
Class = RealTimeApplication
+Data = {
Class = ReferenceContainer
DefaultDataSource = DDB
+DDB = {
Class = GAMDataSource
}
+TimingDataSource = {
Class = TimingDataSource
}
}
+Functions = {
Class = ReferenceContainer
+FnA = {
Class = IOGAM
InputSignals = {
A = {
DataSource = DDB
Type = uint32
Value = $Value
}
}
OutputSignals = {
B = {
DataSource = DDB
Type = uint32
}
}
}
}
+States = {
Class = ReferenceContainer
+State = {
Class = RealTimeState
Threads = {
+Th1 = {
Class = RealTimeThread
Functions = { FnA }
}
}
}
}
+Scheduler = {
Class = GAMScheduler
TimingDataSource = TimingDataSource
}
}
`
uri := "file://app_test.marte"
// Simulate DidOpen
lsp.HandleDidOpen(lsp.DidOpenTextDocumentParams{
TextDocument: lsp.TextDocumentItem{
URI: uri,
Text: content,
},
})
output := buf.String()
// Verify Diagnostics are published
if !strings.Contains(output, "textDocument/publishDiagnostics") {
t.Fatal("LSP did not publish diagnostics")
}
// 1. Check Unresolved Variable Error ($Value)
if !strings.Contains(output, "Unresolved variable reference: '$Value'") {
t.Error("Missing diagnostic for unresolved variable '$Value'")
}
// 2. Check INOUT Ordering Error (Signal A consumed but not produced)
// Message format: INOUT Signal 'A' (DS '+DDB') is consumed by GAM '+FnA' ... before being produced ...
if !strings.Contains(output, "INOUT Signal 'A'") || !strings.Contains(output, "before being produced") {
t.Error("Missing diagnostic for INOUT ordering error (Signal A)")
}
// 3. Check INOUT Unused Warning (Signal B produced but not consumed)
// Message format: INOUT Signal 'B' ... produced ... but never consumed ...
if !strings.Contains(output, "INOUT Signal 'B'") || !strings.Contains(output, "never consumed") {
t.Error("Missing diagnostic for unused INOUT signal (Signal B)")
}
// 4. Check Implicit Signal Warnings (A and B)
if !strings.Contains(output, "Implicitly Defined Signal: 'A'") {
t.Error("Missing diagnostic for implicit signal 'A'")
}
if !strings.Contains(output, "Implicitly Defined Signal: 'B'") {
t.Error("Missing diagnostic for implicit signal 'B'")
}
// Check Unused GAM Warning (FnA is used in Th1, so should NOT be unused)
// Wait, is FnA used?
// Functions = { FnA }.
// resolveScopedName should find it?
// In previous analysis, FnA inside Functions container might be hard to find from State?
// But TestLSPAppTestRepro passed?
// If FindNode finds it (Validator uses FindNode), then it is referenced.
// CheckUnused uses `v.Tree.References`.
// `ResolveReferences` populates references.
// `ResolveReferences` uses `resolveScopedName`.
// If `resolveScopedName` fails to find FnA from Th1 (because FnA is in Functions and not sibling/ancestor),
// Then `ref.Target` is nil.
// So `FnA` is NOT referenced in Index.
// So `CheckUnused` reports "Unused GAM".
// BUT Validator uses `resolveReference` (FindNode) to verify Functions array.
// So Validator knows it is valid.
// But `CheckUnused` relies on Index References.
// If Index doesn't resolve it, `CheckUnused` warns.
// Does output contain "Unused GAM: +FnA"?
// If so, `resolveScopedName` failed.
// Let's check output if test fails or just check existence.
if strings.Contains(output, "Unused GAM: +FnA") {
// This indicates scoping limitation or intended behavior if path is not full.
// "Ref = FnA" vs "Ref = Functions.FnA".
// MARTe scoping usually allows global search?
// I added fallback to Root search in resolveScopedName.
// FnA is child of Functions. Functions is child of App.
// Root children: App.
// App children: Functions.
// Functions children: FnA.
// Fallback checks `pt.Root.Children[name]`.
// Name is "FnA".
// Root children has "App". No "FnA".
// So fallback fails.
// So Index fails to resolve "FnA".
// So "Unused GAM" warning IS expected given current Index logic.
// I will NOT assert it is missing, unless I fix Index to search deep global (FindNode) as fallback?
// Validator uses FindNode (Deep).
// Index uses Scoped + Root Top Level.
// If I want Index to match Validator, I should use FindNode as final fallback?
// But that defeats scoping strictness.
// Ideally `app_test.marte` should use `Functions.FnA` or `App.Functions.FnA`.
// But for this test, I just check the requested diagnostics.
}
}

View File

@@ -0,0 +1,81 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestHoverDataSourceName(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
content := `
+DS1 = {
Class = FileReader
+Signals = {
Sig1 = { Type = uint32 }
}
}
+GAM1 = {
Class = IOGAM
+InputSignals = {
S1 = {
DataSource = DS1
Alias = Sig1
}
}
}
`
uri := "file://test_ds.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatalf("Parse error: %v", err)
}
lsp.Tree.AddFile("test_ds.marte", cfg)
lsp.Tree.ResolveReferences()
// Test 1: Explicit Signal (Sig1)
// Position: "Sig1" at line 5 (0-based 4)
// Line 4: " Sig1 = { Type = uint32 }"
// Col: 8
params1 := lsp.HoverParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 4, Character: 9},
}
hover1 := lsp.HandleHover(params1)
if hover1 == nil {
t.Fatal("Expected hover for Sig1")
}
content1 := hover1.Contents.(lsp.MarkupContent).Value
// Expectation: explicit signal shows owner datasource
if !strings.Contains(content1, "**DataSource**: `+DS1`") && !strings.Contains(content1, "**DataSource**: `DS1`") {
t.Errorf("Expected DataSource: +DS1 in hover for Sig1, got: %s", content1)
}
// Test 2: Implicit Signal (S1)
// Position: "S1" at line 11 (0-based 10)
params2 := lsp.HoverParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 10, Character: 9},
}
hover2 := lsp.HandleHover(params2)
if hover2 == nil {
t.Fatal("Expected hover for S1")
}
content2 := hover2.Contents.(lsp.MarkupContent).Value
// Expectation: implicit signal shows referenced datasource
if !strings.Contains(content2, "**DataSource**: `DS1`") {
t.Errorf("Expected DataSource: DS1 in hover for S1, got: %s", content2)
}
}

View File

@@ -0,0 +1,75 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestHoverGAMUsage(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
content := `
+DS1 = {
Class = FileReader
+Signals = {
Sig1 = { Type = uint32 }
}
}
+GAM1 = {
Class = IOGAM
+InputSignals = {
S1 = {
DataSource = DS1
Alias = Sig1
}
}
}
+GAM2 = {
Class = IOGAM
+OutputSignals = {
S2 = {
DataSource = DS1
Alias = Sig1
}
}
}
`
uri := "file://test_gam_usage.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("test_gam_usage.marte", cfg)
lsp.Tree.ResolveReferences()
// Query hover for Sig1 (Line 5)
// Line 4: Sig1... (0-based)
params := lsp.HoverParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 4, Character: 9},
}
hover := lsp.HandleHover(params)
if hover == nil {
t.Fatal("Expected hover")
}
contentHover := hover.Contents.(lsp.MarkupContent).Value
if !strings.Contains(contentHover, "**Used in GAMs**") {
t.Errorf("Expected 'Used in GAMs' section, got:\n%s", contentHover)
}
if !strings.Contains(contentHover, "- +GAM1") {
t.Error("Expected +GAM1 in usage list")
}
if !strings.Contains(contentHover, "- +GAM2") {
t.Error("Expected +GAM2 in usage list")
}
}

View File

@@ -0,0 +1,67 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestLSPHoverVariable(t *testing.T) {
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
content := `
#var MyInt: int = 123
+Obj = {
Field = $MyInt
}
`
uri := "file://hover_var.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("hover_var.marte", cfg)
lsp.Tree.ResolveReferences()
// 1. Hover on Definition (#var MyInt)
// Line 2 (index 1). # is at 0. Name "MyInt" is at 5.
paramsDef := lsp.HoverParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 1, Character: 5},
}
resDef := lsp.HandleHover(paramsDef)
if resDef == nil {
t.Fatal("Expected hover for definition")
}
contentDef := resDef.Contents.(lsp.MarkupContent).Value
if !strings.Contains(contentDef, "Type: `int`") {
t.Errorf("Hover def missing type. Got: %s", contentDef)
}
if !strings.Contains(contentDef, "Default: `123`") {
t.Errorf("Hover def missing default value. Got: %s", contentDef)
}
// 2. Hover on Reference ($MyInt)
// Line 4 (index 3). $MyInt is at col 12.
paramsRef := lsp.HoverParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 3, Character: 12},
}
resRef := lsp.HandleHover(paramsRef)
if resRef == nil {
t.Fatal("Expected hover for reference")
}
contentRef := resRef.Contents.(lsp.MarkupContent).Value
if !strings.Contains(contentRef, "Type: `int`") {
t.Errorf("Hover ref missing type. Got: %s", contentRef)
}
if !strings.Contains(contentRef, "Default: `123`") {
t.Errorf("Hover ref missing default value. Got: %s", contentRef)
}
}

73
test/lsp_inout_test.go Normal file
View File

@@ -0,0 +1,73 @@
package integration
import (
"bytes"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/schema"
)
func TestLSPINOUTOrdering(t *testing.T) {
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
// Mock schema if necessary, but we rely on internal schema
lsp.GlobalSchema = schema.LoadFullSchema(".")
var buf bytes.Buffer
lsp.Output = &buf
content := `
+App = {
Class = RealTimeApplication
+Data = {
Class = ReferenceContainer
+DDB = {
Class = GAMDataSource
}
}
+Functions = {
Class = ReferenceContainer
+A = {
Class = IOGAM
InputSignals = {
A = {
DataSource = DDB
Type = uint32
}
}
OutputSignals = {
B = {
DataSource = DDB
Type = uint32
}
}
}
}
+States = {
Class = ReferenceContainer
+State = {
Class =RealTimeState
Threads = {
+Th1 = {
Class = RealTimeThread
Functions = {A}
}
}
}
}
}
`
uri := "file://app.marte"
lsp.HandleDidOpen(lsp.DidOpenTextDocumentParams{
TextDocument: lsp.TextDocumentItem{URI: uri, Text: content},
})
output := buf.String()
if !strings.Contains(output, "INOUT Signal 'A'") {
t.Error("LSP did not report INOUT ordering error")
t.Log(output)
}
}

View File

@@ -0,0 +1,66 @@
package integration
import (
"bytes"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/schema"
)
func TestLSPINOUTWarning(t *testing.T) {
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
lsp.GlobalSchema = schema.LoadFullSchema(".")
var buf bytes.Buffer
lsp.Output = &buf
content := `
+App = {
Class = RealTimeApplication
+Data = {
Class = ReferenceContainer
+DDB = {
Class = GAMDataSource
}
}
+Functions = {
Class = ReferenceContainer
+Producer = {
Class = IOGAM
OutputSignals = {
ProducedSig = {
DataSource = DDB
Type = uint32
}
}
}
}
+States = {
Class = ReferenceContainer
+State = {
Class =RealTimeState
Threads = {
+Th1 = {
Class = RealTimeThread
Functions = {Producer}
}
}
}
}
}
`
uri := "file://warning.marte"
lsp.HandleDidOpen(lsp.DidOpenTextDocumentParams{
TextDocument: lsp.TextDocumentItem{URI: uri, Text: content},
})
output := buf.String()
if !strings.Contains(output, "produced in thread '+Th1' but never consumed") {
t.Error("LSP did not report INOUT usage warning")
t.Log(output)
}
}

View File

@@ -0,0 +1,89 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/validator"
)
func TestRenameImplicitToDefinition(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
content := `
+DS = {
Class = FileReader
+Signals = {
Sig1 = { Type = uint32 }
}
}
+GAM = {
Class = IOGAM
+InputSignals = {
// Implicit usage
Sig1 = { DataSource = DS }
}
}
`
uri := "file://rename_imp.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("rename_imp.marte", cfg)
lsp.Tree.ResolveReferences()
// Run validator to link targets
v := validator.NewValidator(lsp.Tree, ".")
v.ValidateProject()
// Rename Implicit Sig1 (Line 11, 0-based 11)
// Line 11: " Sig1 = { DataSource = DS }"
params := lsp.RenameParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 11, Character: 9},
NewName: "NewSig",
}
edit := lsp.HandleRename(params)
if edit == nil {
t.Fatal("Expected edits")
}
edits := edit.Changes[uri]
// Expect:
// 1. Rename Implicit Sig1 (Line 9) -> NewSig
// 2. Rename Definition Sig1 (Line 4) -> NewSig
if len(edits) != 2 {
t.Errorf("Expected 2 edits, got %d", len(edits))
for _, e := range edits {
t.Logf("Edit at line %d", e.Range.Start.Line)
}
}
foundDef := false
foundImp := false
for _, e := range edits {
if e.Range.Start.Line == 4 {
foundDef = true
}
if e.Range.Start.Line == 11 {
foundImp = true
}
}
if !foundDef {
t.Error("Definition not renamed")
}
if !foundImp {
t.Error("Implicit usage not renamed")
}
}

View File

@@ -0,0 +1,110 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/validator"
)
func TestRenameSignalInGAM(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
content := `
+DS = {
Class = FileReader
+Signals = {
Sig1 = { Type = uint32 }
}
}
+GAM = {
Class = IOGAM
+InputSignals = {
// Implicit match
Sig1 = { DataSource = DS }
// Explicit Alias
S2 = { DataSource = DS Alias = Sig1 }
}
}
`
uri := "file://rename_sig.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("rename_sig.marte", cfg)
lsp.Tree.ResolveReferences()
// Run validator to populate Targets
v := validator.NewValidator(lsp.Tree, ".")
v.ValidateProject()
// Rename DS.Sig1 to NewSig
// Sig1 is at Line 5.
// Line 0: empty
// Line 1: +DS
// Line 2: Class
// Line 3: +Signals
// Line 4: Sig1
params := lsp.RenameParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 4, Character: 9}, // Sig1
NewName: "NewSig",
}
edit := lsp.HandleRename(params)
if edit == nil {
t.Fatal("Expected edits")
}
edits := edit.Changes[uri]
// Expect:
// 1. Definition of Sig1 in DS (Line 5) -> NewSig
// 2. Definition of Sig1 in GAM (Line 10) -> NewSig (Implicit match)
// 3. Alias reference in S2 (Line 12) -> NewSig
// Line 10: Sig1 = ... (0-based 9)
// Line 12: S2 = ... Alias = Sig1 (0-based 11)
expectedCount := 3
if len(edits) != expectedCount {
t.Errorf("Expected %d edits, got %d", expectedCount, len(edits))
for _, e := range edits {
t.Logf("Edit: %s at %d", e.NewText, e.Range.Start.Line)
}
}
// Check Implicit Signal Rename
foundImplicit := false
for _, e := range edits {
if e.Range.Start.Line == 11 {
if e.NewText == "NewSig" {
foundImplicit = true
}
}
}
if !foundImplicit {
t.Error("Did not find implicit signal rename")
}
// Check Alias Rename
foundAlias := false
for _, e := range edits {
if e.Range.Start.Line == 13 {
// Alias = Sig1. Range should cover Sig1.
if e.NewText == "NewSig" {
foundAlias = true
}
}
}
if !foundAlias {
t.Error("Did not find alias reference rename")
}
}

92
test/lsp_rename_test.go Normal file
View File

@@ -0,0 +1,92 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestHandleRename(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
content := `
#package Some
+MyNode = {
Class = Type
}
+Consumer = {
Link = MyNode
PkgLink = Some.MyNode
}
`
uri := "file://rename.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("rename.marte", cfg)
lsp.Tree.ResolveReferences()
// Rename +MyNode to NewNode
// +MyNode is at Line 2 (after #package)
// Line 0: empty
// Line 1: #package
// Line 2: +MyNode
params := lsp.RenameParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 2, Character: 4}, // +MyNode
NewName: "NewNode",
}
edit := lsp.HandleRename(params)
if edit == nil {
t.Fatal("Expected edits")
}
edits := edit.Changes[uri]
if len(edits) != 3 {
t.Errorf("Expected 3 edits (Def, Link, PkgLink), got %d", len(edits))
}
// Verify Definition change (+MyNode -> +NewNode)
foundDef := false
for _, e := range edits {
if e.NewText == "+NewNode" {
foundDef = true
if e.Range.Start.Line != 2 {
t.Errorf("Definition edit line wrong: %d", e.Range.Start.Line)
}
}
}
if !foundDef {
t.Error("Did not find definition edit +NewNode")
}
// Verify Link change (MyNode -> NewNode)
foundLink := false
for _, e := range edits {
if e.NewText == "NewNode" && e.Range.Start.Line == 6 { // Link = MyNode
foundLink = true
}
}
if !foundLink {
t.Error("Did not find Link edit")
}
// Verify PkgLink change (Some.MyNode -> Some.NewNode)
foundPkg := false
for _, e := range edits {
if e.NewText == "NewNode" && e.Range.Start.Line == 7 { // PkgLink = Some.MyNode
foundPkg = true
}
}
if !foundPkg {
t.Error("Did not find PkgLink edit")
}
}

View File

@@ -0,0 +1,77 @@
package integration
import (
"bytes"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/schema"
)
func TestLSPValidationThreading(t *testing.T) {
// Setup
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
lsp.ProjectRoot = "."
lsp.GlobalSchema = schema.NewSchema() // Empty schema but not nil
// Capture Output
var buf bytes.Buffer
lsp.Output = &buf
content := `
+Data = {
Class = ReferenceContainer
+SharedDS = {
Class = GAMDataSource
#meta = {
direction = "INOUT"
multithreaded = false
}
Signals = {
Sig1 = { Type = uint32 }
}
}
}
+GAM1 = { Class = IOGAM InputSignals = { Sig1 = { DataSource = SharedDS Type = uint32 } } }
+GAM2 = { Class = IOGAM OutputSignals = { Sig1 = { DataSource = SharedDS Type = uint32 } } }
+App = {
Class = RealTimeApplication
+States = {
Class = ReferenceContainer
+State1 = {
Class = RealTimeState
+Thread1 = { Class = RealTimeThread Functions = { GAM1 } }
+Thread2 = { Class = RealTimeThread Functions = { GAM2 } }
}
}
}
`
uri := "file://threading.marte"
// Call HandleDidOpen directly
params := lsp.DidOpenTextDocumentParams{
TextDocument: lsp.TextDocumentItem{
URI: uri,
Text: content,
},
}
lsp.HandleDidOpen(params)
// Check output
output := buf.String()
// We look for publishDiagnostics notification
if !strings.Contains(output, "textDocument/publishDiagnostics") {
t.Fatal("Did not receive publishDiagnostics")
}
// We look for the specific error message
expectedError := "DataSource '+SharedDS' is not multithreaded but used in multiple threads"
if !strings.Contains(output, expectedError) {
t.Errorf("Expected error '%s' not found in LSP output. Output:\n%s", expectedError, output)
}
}

View File

@@ -0,0 +1,62 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/lsp"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestLSPVariableRefs(t *testing.T) {
lsp.Tree = index.NewProjectTree()
lsp.Documents = make(map[string]string)
content := `
#var MyVar: int = 1
+Obj = {
Field = $MyVar
}
`
uri := "file://vars.marte"
lsp.Documents[uri] = content
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
lsp.Tree.AddFile("vars.marte", cfg)
lsp.Tree.ResolveReferences()
// 1. Definition from Usage
// Line 4: " Field = $MyVar"
// $ is at col 12 (0-based) ?
// " Field = " is 4 + 6 + 3 = 13 chars?
// 4 spaces. Field (5). " = " (3). 4+5+3 = 12.
// So $ is at 12.
paramsDef := lsp.DefinitionParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 3, Character: 12},
}
resDef := lsp.HandleDefinition(paramsDef)
locs, ok := resDef.([]lsp.Location)
if !ok || len(locs) != 1 {
t.Fatalf("Expected 1 definition location, got %v", resDef)
}
// Line 2 in file is index 1.
if locs[0].Range.Start.Line != 1 {
t.Errorf("Expected definition at line 1, got %d", locs[0].Range.Start.Line)
}
// 2. References from Definition
// #var at line 2 (index 1). Col 0.
paramsRef := lsp.ReferenceParams{
TextDocument: lsp.TextDocumentIdentifier{URI: uri},
Position: lsp.Position{Line: 1, Character: 1},
Context: lsp.ReferenceContext{IncludeDeclaration: true},
}
resRef := lsp.HandleReferences(paramsRef)
if len(resRef) != 2 { // Decl + Usage
t.Errorf("Expected 2 references, got %d", len(resRef))
}
}

58
test/operators_test.go Normal file
View File

@@ -0,0 +1,58 @@
package integration
import (
"os"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/builder"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestOperators(t *testing.T) {
content := `
#var A: int = 10
#var B: int = 20
#var S1: string = "Hello"
#var S2: string = "World"
+Obj = {
Math = $A + $B
Precedence = $A + $B * 2
Concat = $S1 .. " " .. $S2
}
`
// Check Parser
p := parser.NewParser(content)
_, err := p.Parse()
if err != nil {
t.Fatalf("Parse failed: %v", err)
}
// Check Builder Output
f, _ := os.CreateTemp("", "ops.marte")
f.WriteString(content)
f.Close()
defer os.Remove(f.Name())
b := builder.NewBuilder([]string{f.Name()}, nil)
outF, _ := os.CreateTemp("", "out.marte")
defer os.Remove(outF.Name())
b.Build(outF)
outF.Close()
outContent, _ := os.ReadFile(outF.Name())
outStr := string(outContent)
if !strings.Contains(outStr, "Math = 30") {
t.Errorf("Math failed. Got:\n%s", outStr)
}
// 10 + 20 * 2 = 50
if !strings.Contains(outStr, "Precedence = 50") {
t.Errorf("Precedence failed. Got:\n%s", outStr)
}
if !strings.Contains(outStr, "Concat = \"Hello World\"") {
t.Errorf("Concat failed. Got:\n%s", outStr)
}
}

View File

@@ -0,0 +1,53 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/validator"
)
func TestRegexVariable(t *testing.T) {
content := `
#var IP: string & =~"^[0-9.]+$" = "127.0.0.1"
#var BadIP: string & =~"^[0-9.]+$" = "abc"
+Obj = {
IP = $IP
}
`
// Test Validator
pt := index.NewProjectTree()
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatalf("Parse failed: %v", err)
}
pt.AddFile("regex.marte", cfg)
v := validator.NewValidator(pt, ".")
v.CheckVariables()
foundError := false
for _, d := range v.Diagnostics {
if strings.Contains(d.Message, "Variable 'BadIP' value mismatch") {
foundError = true
}
}
if !foundError {
t.Error("Expected error for BadIP")
for _, d := range v.Diagnostics {
t.Logf("Diag: %s", d.Message)
}
}
// Test valid variable
for _, d := range v.Diagnostics {
if strings.Contains(d.Message, "Variable 'IP' value mismatch") {
t.Error("Unexpected error for IP")
}
}
}

65
test/scoping_test.go Normal file
View File

@@ -0,0 +1,65 @@
package integration
import (
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestNameScoping(t *testing.T) {
// App1 = { A = { Data = 10 } B = { Ref = A } }
// App2 = { C = { Data = 10 } A = { Data = 12 } D = { Ref = A } }
content := `
+App1 = {
Class = App
+A = { Class = Node Data = 10 }
+B = { Class = Node Ref = A }
}
+App2 = {
Class = App
+C = { Class = Node Data = 10 }
+A = { Class = Node Data = 12 }
+D = { Class = Node Ref = A }
}
`
pt := index.NewProjectTree()
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil { t.Fatal(err) }
pt.AddFile("main.marte", cfg)
pt.ResolveReferences()
// Helper to find ref target
findRefTarget := func(refName string, containerName string) *index.ProjectNode {
for _, ref := range pt.References {
if ref.Name == refName {
container := pt.GetNodeContaining(ref.File, ref.Position)
if container != nil && container.RealName == containerName {
return ref.Target
}
}
}
return nil
}
targetB := findRefTarget("A", "+B")
if targetB == nil {
t.Fatal("Could not find reference A in +B")
}
// Check if targetB is App1.A
if targetB.Parent == nil || targetB.Parent.RealName != "+App1" {
t.Errorf("App1.B.Ref resolved to wrong target: %v (Parent %v)", targetB.RealName, targetB.Parent.RealName)
}
targetD := findRefTarget("A", "+D")
if targetD == nil {
t.Fatal("Could not find reference A in +D")
}
// Check if targetD is App2.A
if targetD.Parent == nil || targetD.Parent.RealName != "+App2" {
t.Errorf("App2.D.Ref resolved to wrong target: %v (Parent %v)", targetD.RealName, targetD.Parent.RealName)
}
}

View File

@@ -0,0 +1,124 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/validator"
)
func TestDataSourceThreadingValidation(t *testing.T) {
content := `
+Data = {
Class = ReferenceContainer
+SharedDS = {
Class = GAMDataSource
#meta = {
direction = "INOUT"
multithreaded = false
}
Signals = {
Sig1 = { Type = uint32 }
}
}
+MultiDS = {
Class = GAMDataSource
#meta = {
direction = "INOUT"
multithreaded = true
}
Signals = {
Sig1 = { Type = uint32 }
}
}
}
+GAM1 = {
Class = IOGAM
InputSignals = {
Sig1 = { DataSource = SharedDS Type = uint32 }
}
}
+GAM2 = {
Class = IOGAM
OutputSignals = {
Sig1 = { DataSource = SharedDS Type = uint32 }
}
}
+GAM3 = {
Class = IOGAM
InputSignals = {
Sig1 = { DataSource = MultiDS Type = uint32 }
}
}
+GAM4 = {
Class = IOGAM
OutputSignals = {
Sig1 = { DataSource = MultiDS Type = uint32 }
}
}
+App = {
Class = RealTimeApplication
+States = {
Class = ReferenceContainer
+State1 = {
Class = RealTimeState
+Thread1 = {
Class = RealTimeThread
Functions = { GAM1 }
}
+Thread2 = {
Class = RealTimeThread
Functions = { GAM2 }
}
}
+State2 = {
Class = RealTimeState
+Thread1 = {
Class = RealTimeThread
Functions = { GAM3 }
}
+Thread2 = {
Class = RealTimeThread
Functions = { GAM4 }
}
}
}
}
`
pt := index.NewProjectTree()
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
pt.AddFile("main.marte", cfg)
// Since we don't load schema here (empty path), it won't validate classes via CUE,
// but CheckDataSourceThreading relies on parsing logic, not CUE schema unification.
// So it should work.
v := validator.NewValidator(pt, "")
v.ValidateProject()
foundError := false
for _, d := range v.Diagnostics {
if strings.Contains(d.Message, "not multithreaded but used in multiple threads") {
if strings.Contains(d.Message, "SharedDS") {
foundError = true
}
if strings.Contains(d.Message, "MultiDS") {
t.Error("Unexpected threading error for MultiDS")
}
}
}
if !foundError {
t.Error("Expected threading error for SharedDS")
// Debug
for _, d := range v.Diagnostics {
t.Logf("Diag: %s", d.Message)
}
}
}

View File

@@ -15,7 +15,7 @@ func TestSDNSubscriberValidation(t *testing.T) {
+MySDN = {
Class = SDNSubscriber
Address = "239.0.0.1"
// Missing Port
// Missing Interface
}
`
p := parser.NewParser(content)
@@ -32,7 +32,7 @@ func TestSDNSubscriberValidation(t *testing.T) {
found := false
for _, d := range v.Diagnostics {
if strings.Contains(d.Message, "Port: incomplete value") {
if strings.Contains(d.Message, "Interface: field is required but not present") {
found = true
break
}

View File

@@ -23,6 +23,7 @@ func TestGAMSignalLinking(t *testing.T) {
+MyGAM = {
Class = IOGAM
//! ignore(unused)
InputSignals = {
MySig = {
DataSource = MyDS

View File

@@ -0,0 +1,93 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/validator"
)
func TestINOUTOrdering(t *testing.T) {
content := `
+Data = {
Class = ReferenceContainer
+MyDS = {
Class = GAMDataSource
#meta = { multithreaded = false } // Explicitly false
Signals = { Sig1 = { Type = uint32 } }
}
}
+GAM_Consumer = {
Class = IOGAM
InputSignals = {
Sig1 = { DataSource = MyDS Type = uint32 }
}
}
+GAM_Producer = {
Class = IOGAM
OutputSignals = {
Sig1 = { DataSource = MyDS Type = uint32 }
}
}
+App = {
Class = RealTimeApplication
+States = {
Class = ReferenceContainer
+State1 = {
Class = RealTimeState
+Thread1 = {
Class = RealTimeThread
Functions = { GAM_Consumer, GAM_Producer } // Fail
}
}
+State2 = {
Class = RealTimeState
+Thread2 = {
Class = RealTimeThread
Functions = { GAM_Producer, GAM_Consumer } // Pass
}
}
}
}
`
pt := index.NewProjectTree()
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
pt.AddFile("main.marte", cfg)
// Use validator with default schema (embedded)
// We pass "." but it shouldn't matter if no .marte_schema.cue exists
v := validator.NewValidator(pt, ".")
v.ValidateProject()
foundError := false
for _, d := range v.Diagnostics {
if strings.Contains(d.Message, "consumed by GAM '+GAM_Consumer'") &&
strings.Contains(d.Message, "before being produced") {
foundError = true
}
}
if !foundError {
t.Error("Expected INOUT ordering error for State1")
for _, d := range v.Diagnostics {
t.Logf("Diag: %s", d.Message)
}
}
foundErrorState2 := false
for _, d := range v.Diagnostics {
if strings.Contains(d.Message, "State '+State2'") && strings.Contains(d.Message, "before being produced") {
foundErrorState2 = true
}
}
if foundErrorState2 {
t.Error("Unexpected INOUT ordering error for State2 (Correct order)")
}
}

View File

@@ -107,7 +107,11 @@ func TestHierarchicalPackageMerge(t *testing.T) {
}
// We can also inspect the tree to verify FieldX is there (optional, but good for confidence)
baseNode := idx.Root.Children["Base"]
projNode := idx.Root.Children["Proj"]
if projNode == nil {
t.Fatal("Proj node not found")
}
baseNode := projNode.Children["Base"]
if baseNode == nil {
t.Fatal("Base node not found")
}

View File

@@ -0,0 +1,79 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/validator"
)
func TestSchemaMetaValidation(t *testing.T) {
// 1. Valid Usage
validContent := `
+App = {
Class = RealTimeApplication
Functions = { Class = ReferenceContainer }
Data = { Class = ReferenceContainer DefaultDataSource = "DS" }
States = { Class = ReferenceContainer }
Scheduler = { Class = GAMScheduler TimingDataSource = "DS" }
#meta = {
multithreaded = true
}
}
`
pt := index.NewProjectTree()
p := parser.NewParser(validContent)
cfg, err := p.Parse()
if err != nil {
t.Fatal(err)
}
pt.AddFile("valid.marte", cfg)
v := validator.NewValidator(pt, "")
v.ValidateProject()
if len(v.Diagnostics) > 0 {
for _, d := range v.Diagnostics {
t.Logf("Diag: %s", d.Message)
}
t.Errorf("Expected no errors for valid #meta")
}
// 2. Invalid Usage (Wrong Type)
invalidContent := `
+App = {
Class = RealTimeApplication
Functions = { Class = ReferenceContainer }
Data = { Class = ReferenceContainer DefaultDataSource = "DS" }
States = { Class = ReferenceContainer }
Scheduler = { Class = GAMScheduler TimingDataSource = "DS" }
#meta = {
multithreaded = "yes" // Should be bool
}
}
`
pt2 := index.NewProjectTree()
p2 := parser.NewParser(invalidContent)
cfg2, _ := p2.Parse()
pt2.AddFile("invalid.marte", cfg2)
v2 := validator.NewValidator(pt2, "")
v2.ValidateProject()
foundError := false
for _, d := range v2.Diagnostics {
// CUE validation error message
if strings.Contains(d.Message, "mismatched types") || strings.Contains(d.Message, "conflicting values") {
foundError = true
}
}
if !foundError {
t.Error("Expected error for invalid #meta type, got nothing")
for _, d := range v2.Diagnostics {
t.Logf("Diag: %s", d.Message)
}
}
}

View File

@@ -0,0 +1,101 @@
package integration
import (
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/index"
"github.com/marte-community/marte-dev-tools/internal/parser"
"github.com/marte-community/marte-dev-tools/internal/validator"
)
func TestVariableValidation(t *testing.T) {
// Need a schema that enforces strict types to test usage validation.
// We can use built-in types or rely on Variable Definition validation.
// Test Case 1: Variable Definition Mismatch
contentDef := `
#var Positive: uint = -5
`
pt := index.NewProjectTree()
p := parser.NewParser(contentDef)
cfg, err := p.Parse()
if err != nil { t.Fatal(err) }
pt.AddFile("def.marte", cfg)
v := validator.NewValidator(pt, ".")
v.CheckVariables()
foundError := false
for _, d := range v.Diagnostics {
if strings.Contains(d.Message, "Variable 'Positive' value mismatch") {
foundError = true
}
}
if !foundError {
t.Error("Expected error for invalid variable definition")
}
// Test Case 2: Variable Usage Mismatch
// We need a class with specific field type.
// PIDGAM.Kp is float | int.
// Let's use string variable.
contentUsage := `
#var MyStr: string = "hello"
+MyPID = {
Class = PIDGAM
Kp = $MyStr
Ki = 0.0
Kd = 0.0
}
`
pt2 := index.NewProjectTree()
p2 := parser.NewParser(contentUsage)
cfg2, err := p2.Parse()
if err != nil { t.Fatal(err) }
pt2.AddFile("usage.marte", cfg2)
v2 := validator.NewValidator(pt2, ".")
v2.ValidateProject() // Should run CUE validation on nodes
foundUsageError := false
for _, d := range v2.Diagnostics {
// Schema validation error
if strings.Contains(d.Message, "Schema Validation Error") &&
(strings.Contains(d.Message, "conflicting values") || strings.Contains(d.Message, "mismatched types")) {
foundUsageError = true
}
}
if !foundUsageError {
t.Error("Expected error for invalid variable usage in PIDGAM.Kp")
for _, d := range v2.Diagnostics {
t.Logf("Diag: %s", d.Message)
}
}
// Test Case 3: Valid Usage
contentValid := `
#var MyGain: float = 1.5
+MyPID = {
Class = PIDGAM
Kp = $MyGain
Ki = 0.0
Kd = 0.0
}
`
pt3 := index.NewProjectTree()
p3 := parser.NewParser(contentValid)
cfg3, err := p3.Parse()
if err != nil { t.Fatal(err) }
pt3.AddFile("valid.marte", cfg3)
v3 := validator.NewValidator(pt3, ".")
v3.ValidateProject()
for _, d := range v3.Diagnostics {
if strings.Contains(d.Message, "Schema Validation Error") {
t.Errorf("Unexpected schema error: %s", d.Message)
}
}
}

72
test/variables_test.go Normal file
View File

@@ -0,0 +1,72 @@
package integration
import (
"os"
"strings"
"testing"
"github.com/marte-community/marte-dev-tools/internal/builder"
"github.com/marte-community/marte-dev-tools/internal/parser"
)
func TestVariables(t *testing.T) {
content := `
#var MyInt: int = 10
#var MyStr: string = "default"
+Obj = {
Class = Test
Field1 = $MyInt
Field2 = $MyStr
}
`
// Test Parsing
p := parser.NewParser(content)
cfg, err := p.Parse()
if err != nil {
t.Fatalf("Parse failed: %v", err)
}
// Check definitions: #var, #var, +Obj
if len(cfg.Definitions) != 3 {
t.Errorf("Expected 3 definitions, got %d", len(cfg.Definitions))
}
// Test Builder resolution
f, _ := os.CreateTemp("", "vars.marte")
f.WriteString(content)
f.Close()
defer os.Remove(f.Name())
// Build with override
overrides := map[string]string{
"MyInt": "999",
}
b := builder.NewBuilder([]string{f.Name()}, overrides)
outF, _ := os.CreateTemp("", "out.marte")
outName := outF.Name()
defer os.Remove(outName)
err = b.Build(outF)
outF.Close()
if err != nil {
t.Fatalf("Build failed: %v", err)
}
outContent, _ := os.ReadFile(outName)
outStr := string(outContent)
if !strings.Contains(outStr, "Field1 = 999") {
t.Errorf("Variable override failed for MyInt. Got:\n%s", outStr)
}
if !strings.Contains(outStr, "Field2 = \"default\"") {
t.Errorf("Default value failed for MyStr. Got:\n%s", outStr)
}
// Check #var is removed
if strings.Contains(outStr, "#var") {
t.Error("#var definition present in output")
}
}