v4.0.1

Author: christoph-grimm

README.md

@@ -12,8 +12,9 @@ where
 
 Furthermore, SysMD Notebook's requirements are _executable_. 
 With executable requirements and specification documents, we mean that 
-an integrated constraint solver that checks the consistency of SysML v2 models and computes missing values.
-Excel in many cases does a similar job; SysMD does it a bit more sophisticated and integrated with SysML v2.
+an integrated constraint solver checks the consistency of SysML v2 models and computes missing values.
+Excel in early system analysis does a similar job; 
+SysMD does it a bit more sophisticated and integrated with SysML v2.
 SysMD Notebook's UI looks as follows:
 
 ![SysMD](doc/pics/SysMD-Screenshot.png)
@@ -44,9 +45,7 @@ and returns an over-approximation of values that satisfy all constraints or an e
 - [List of supported units](doc/AvailableUnits.md)
 - [Modeling of time and date](doc/Time.md)
 
-
-Also, in the folder 'doc' some documentation is provided. 
-
+Also, in the folder 'doc' some documentation is provided.
 
 ## Running SysMD Notebook
 
@@ -77,12 +76,24 @@ To create a platform-specific installer, use the gradle target ```sysMDPackage`
 ./gradlew sysMDPackage
 ```
 
+# Supported and unsupported parts of KerML and SysML v2
+
+SysMD Notebook is a work in progress and does not (yet) support the full range of KerML and SysML v2.
+However, a significant subset is supported with a focus on the intended use case.
+The following gives some indications on what is supported: 
+ 
+- _Supported_: modeling of packages, parts, ports, attributes, calculations, expressions, interfaces, requirements and constraints; both usages and definitions.
+- _Not supported_: modeling of automata, states, time slices, user-defined keywords, etc. 
+
+Note that automata and states might compile, but the constraint propagation mechanism does not use the respective parts properly. 
+Also, KerML is implemented with support for features, classes, packages, expressions, etc. -- but with some restrictions for expressions. 
+
 # Release notes (only major versions)
 
-- SysMD 4.0 implements the platform-specific REST API of SysML v2. 
-For this purpose, SysMD 4.0 includes Spring Boot for the REST API. 
+- SysMD 4.0 implements parts of the platform-specific REST API of SysML v2 (projects endpoint, but not versioning). For this purpose, SysMD 4.0 includes Spring Boot for the REST API.
 
 # Acknowledgements 
+
 SysMD was developed and is maintained by
 - University of Kaiserslautern-Landau
 - HOOD Group

build.gradle.kts

@@ -16,7 +16,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
  * - also set the value standalone according to your setup
  */
 group = "com.github.tukcps"
-version = "4.0.0" // must be number.number.number
+version = "4.0.1" // must be number.number.number
 val aaddVersion = "0.1.9"
 val sysmlapiVersion = "3.9.4"
 val useMavenAADD = true
@@ -33,11 +33,11 @@ if (JavaVersion.current() < JavaVersion.VERSION_21) {
 // Plugins needed: id and versions.
 plugins {
  // Plugin that checks for updates:
- id("com.github.ben-manes.versions") version "0.51.0"
+ id("com.github.ben-manes.versions") version "0.52.0"
  id("idea")
  kotlin("jvm") version "2.1.20"
  kotlin("plugin.serialization") version "2.1.20"
- id("org.springframework.boot") version "3.4.3"
+ id("org.springframework.boot") version "3.4.4"
  id("io.spring.dependency-management") version "1.1.7"
  alias(libs.plugins.jetbrainsCompose) apply true
  alias(libs.plugins.compose.compiler) apply true
@@ -123,7 +123,7 @@ dependencies {
 
  // compose ui tests
  testImplementation(kotlin("test"))
- testImplementation("org.springframework.boot:spring-boot-starter-test:3.4.3") {
+ testImplementation("org.springframework.boot:spring-boot-starter-test:3.4.4") {
  exclude(group = "org.mockito", module = "mockito-core")
  }
 

doc/SysMDLanguageExtensions.md

@@ -109,4 +109,4 @@ SysMD includes Units as part of the value (quantity), and not as a data type.
 Units are hard-coded and not yet fully compliant with SysML v2. 
 
 For example, in SysML v2 one writes ```[micro*m]```, in SysMD ```"[µm]"```. 
-See description of the units for details. 
+See description of the units for details. 

src/main/kotlin/com/github/tukcps/sysmd/compiler/parser/kerml/KerMLKernel.kt

@@ -167,7 +167,7 @@ fun KerML.Metaclass() {
  *
  * Note: PrefixMetadataMember is a qualified Name or FeatureChain
  */
-fun KerML.PrefixMetadataFeature() {
+fun KerML.PrefixMetadataAnnotation() {
  HASHTAG.consume()
  QualifiedName()
 }
@@ -244,12 +244,15 @@ fun KerML.MetadataBody(owner: FeatureActions<Feature>) {
 }
 
 /**
- * MetadataBodyElement = NonFeatureMember | MetadataBodyFeatureMember
- * | AliasMember | Import
+ * MetadataBodyElement =
+ * NonFeatureMember
+ * | MetadataBodyFeatureMember
+ * | AliasMember
+ * | Import
  */
 fun KerML.MetadataBodyElement() {
  alternatives {
- // TODO: NonFeatureMember
+ nonFeatureElementStart starts { NonFeatureElement() }
  METADATA starts { MetadataFeature() }
  ALIAS starts { AliasMember() }
  IMPORT starts { Import() }
@@ -354,7 +357,6 @@ fun KerML.LibraryPackage() {
 }
 
 
-
 /**
  * 8.2.5.7.1 Functions
  *

src/main/kotlin/com/github/tukcps/sysmd/compiler/parser/kerml/KerMLRoot.kt

@@ -140,6 +140,7 @@ fun KerML.MemberPrefix() {
 fun KerML.NamespaceBodyElement() {
  MemberPrefix() // Consume and remember them in context
  FeaturePrefix() // Optional anyhow, we just consume and remember them in context
+ optional(HASHTAG) { PrefixMetadataMember() }
  alternatives {
  nonFeatureElementStart starts { NonFeatureElement() }
  featureElementStart starts { FeatureElement() }
@@ -401,8 +402,8 @@ fun KerML.AnnotatingElement() {
  * | Subclassification | Disjoining | FeatureInverting | FeatureTyping
  * | Subsetting | Redefinition | TypeFeaturing
  */
-
 fun KerML.NonFeatureElement() {
+ noOrMore(start = HASHTAG) { PrefixMetadataMember() }
  alternatives {
  annotatingElementStart starts { AnnotatingElement() }
  DEPENDENCY starts { Dependency() }

src/main/kotlin/com/github/tukcps/sysmd/compiler/parser/sysmlv2/Metadata.kt

@@ -0,0 +1,61 @@
+package com.github.tukcps.sysmd.compiler.parser.sysmlv2
+
+import com.github.tukcps.sysmd.compiler.SysMLv2
+import com.github.tukcps.sysmd.compiler.parser.util.Unsupported
+
+
+/**
+ * 8.2.2.27 Metadata Textual Notation
+ *
+ * MetadataDefinition =
+ * ('abstract')? DefinitionExtensionKeyWord*
+ * 'metadata' 'def' Definition
+ */
+fun SysMLv2.MetadataDefinition() {
+ Unsupported()
+}
+
+
+/**
+ * PrefixMetadataUsage = OwnedFeatureTyping
+ */
+fun SysMLv2.PrefixMetadataUsage() {
+ Unsupported()
+}
+
+
+/**
+ * MetadataUsage =
+ * UsageExtensionKeyword* ( '@' | 'metadata' )
+ * MetadataUsageDeclaration
+ * ( 'about' ownedRelationship += Annotation
+ * ( ',' ownedRelationship += Annotation )*
+ * )?
+ * MetadataBody
+ * MetadataUsageDeclaration : MetadataUsage =
+ * ( Identification ( ':' | 'typed' 'by' ) )?
+ * ownedRelationship += OwnedFeatureTyping
+ * MetadataBody : Type =
+ * ';' |
+ * '{' ( ownedRelationship += DefinitionMember
+ * | ownedRelationship += MetadataBodyUsageMember
+ * | ownedRelationship += AliasMember
+ * | ownedRelationship += Import
+ * )*
+ * '}'
+ */
+
+/**
+ * MetadataBodyUsageMember : FeatureMembership =
+ * ownedMemberFeature = MetadataBodyUsage
+ * MetadataBodyUsage : ReferenceUsage :
+ * 'ref'? ( ':>>' | 'redefines' )? ownedRelationship += OwnedRedefinition
+ * FeatureSpecializationPart? ValuePart?
+ * MetadataBody
+ * ExtendedDefinition : Definition =
+ * BasicDefinitionPrefix? DefinitionExtensionKeyword+
+ * 'def' Definition
+ * ExtendedUsage : Usage =
+ * UnextendedUsagePrefix UsageExtensionKeyword+
+ * Usage
+ */

src/main/kotlin/com/github/tukcps/sysmd/compiler/parser/sysmlv2/Package.kt

@@ -85,24 +85,25 @@ fun SysMLv2.DefinitionElement() {
  PACKAGE starts { Package() }
  LIBRARY starts { Package() }
  annotatingElementStart starts { AnnotatingElement() }
- DEPENDENCY   starts { Dependency() }
+ DEPENDENCY or HASHTAG starts { Dependency() }
  ATTRIBUTE then DEF starts { AttributeDefinition() }
- // ENUM not supported
+ ENUM starts { Unsupported("Enumerations are not yet supported") }
  OCCURRENCE then DEF starts { OccurrenceDefinition() }
  INDIVIDUAL then DEF starts { Unsupported() }
  ITEM then DEF starts { ItemDefinition() }
  PART then DEF starts { PartDefinition() }
  CONNECTION then DEF starts { ConnectionDefinition() }
  ALLOCATION then DEF starts { AllocationDefinition() }
- // FLOW isn't supported
+ FLOW starts { "Flows are not yet supported" }
  INTERFACE then DEF starts { InterfaceDefinition() }
  PORT then DEF starts { PortDefinition() }
  ACTION then DEF starts { ActionDefinition() }
  CALC then DEF starts { CalculationDefinition() }
  STATE then DEF starts { StateDefinition() }
  CONSTRAINT then DEF starts { ConstraintDefinition() }
  REQUIREMENT then DEF starts { RequirementDefinition() }
- METADATA then DEF starts { Unsupported() }
+ VIEW then DEF starts { Unsupported("Views are not yet supported") }
+ METADATA then DEF starts { MetadataDefinition() }
  others { throwSyntaxError("Invalid definition") }
  }
 }

src/main/kotlin/com/github/tukcps/sysmd/compiler/scanner/Token.kt

@@ -56,9 +56,8 @@ class Token(
  READONLY, REF, REGULAR_COMMENT, RELATIONSHIP, REQUIRE, REP, RETURN, REDEFINES, REFERENCES, REQUIREMENT,
  SATISFY, SEND, SNAPSHOT, SPECIALIZATION, SPECIALIZES, STAKEHOLDER, STANDARD, STATE, STEP, STRUCT, STRUCTURE, SUBJECT, SUCCESSION, SUBSETS, SUBTYPE,
  THEN, TIMESLICE, TO, TRANSITION, TYPE, TYPED,
- UNIQUE, UNIONS, VARIATION,
- // SysMLv2 Keywords Digital Twin
- MEASURABLE, CONTROLLABLE, VARIABLE,
+ UNIQUE, UNIONS,
+ VARIATION, VIEW,
 
  // Operators
  LCURBRACE { override fun toString() = "{" },
@@ -269,10 +268,8 @@ class Token(
  "unions" to Kind.UNIONS,
  "package" to Kind.PACKAGE,
  "part" to Kind.PART,
- "measurable" to Kind.MEASURABLE,
- "controllable" to Kind.CONTROLLABLE,
- "variable" to Kind.VARIABLE,
  "variation" to Kind.VARIATION,
+ "view" to Kind.VIEW,
  "message" to Kind.MESSAGE,
  "return" to Kind.RETURN,
  )

src/main/kotlin/com/github/tukcps/sysmd/exceptions/Issue.kt

@@ -60,4 +60,6 @@ class Issue(
  result = 31 * result + (elementPath?.hashCode() ?: 0)
  return result
  }
+
+ override fun toString() = message
 }

src/main/kotlin/com/github/tukcps/sysmd/ui/paneleft/projectlist/Project.kt

@@ -41,16 +41,18 @@ fun Project(
 
  if (projectViewModel.showSaveDialog.value) {
  SaveDialog(projectViewModel.showSaveDialog,
- onSave = { projectListViewModel.editorTabsViewModel.save(); projectViewModel.showSaveDialog.value = false },
- onDrop = {}
+ onSave = { projectListViewModel.editorTabsViewModel.save(); projectViewModel.openProject(); projectViewModel.showSaveDialog.value = false },
+ onDrop = { projectViewModel.openProject(); projectViewModel.showSaveDialog.value = false }
  )
  }
 
  Card(
  modifier = Modifier
  .fillMaxWidth()
  .padding(all = 5.dp)
- .selectable(selected = false) { projectViewModel.openProject() },
+ .selectable(selected = false) {
+ if (projectViewModel.unsavedChangesExist()) projectViewModel.showSaveDialog.value = true
+ else projectViewModel.openProject() },
  shape = RoundedCornerShape(12.dp),
  ) {
  Box {