v4.1.0

Improved parser for KerML, SysMLv2 - Added support for subsetting and other means for typing in KerML - Semantic Actions separeted from recursive descent productions

Author: christoph-grimm

build.gradle.kts

@@ -16,9 +16,9 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
  * - also set the value standalone according to your setup
  */
 group = "com.github.tukcps"
-version = "4.0.7" // must be number.number.number
+version = "4.1.0" // must be number.number.number
 val aaddVersion = "0.1.11"
-val sysmlapiVersion = "3.9.4"
+val sysmlapiVersion = "3.9.5"
 val useMavenAADD = true
 val useMavenSysMLAPI = true
 

doc/SysMDLanguageExtensions.md

@@ -82,7 +82,7 @@ constraint-propagation semantics are built-in and considered from ground up.
 
 ```
  attribute x: Real = 0.0 .. 0.1; // or: ... = oneOf(0.0 .. 0.1); with oneOf: Range -> Real
- attribute y: Real(0.0 .. 0.1); // or: y { inv bounds { y >= 0.0 and y <= 0.1} } 
+ attribute y: RealInRange {:>> range = "0.0 .. 0.1";} // or: y { inv bounds { y >= 0.0 and y <= 0.1} } 
 ```
 
 _Note, that for the sake of interoperability, we in the next releases we will focus on the standard-compliant version and deprecate non-compliant 

doc/Time.md

@@ -9,8 +9,8 @@ Time can be presented in the following units: second (s), minute (min), hour (h)
 
 Examples:
 ```
- t1: Real(20..50)[s] = 10.0 [s]. 
- t2: Real(20..50)[min] = 10.0 [min]. 
+ t1: Real = 10.0 [s] {:>> unit = "s"; :>> range = "20..50";} 
+ t2: Real = 10.0 [min] {:>> unit = "min"; :>> range = "20..50";} 
 ```
 
 ## Date

install/1-SysMD-Kickstart/SysMD-Modeling.md

@@ -20,6 +20,7 @@ Initially, there are only the KerML standard libraries.
 ### Import of namespaces
 Other namespaces can be imported to simplify the notations.
 For example, the standard package ```ScalarValues``` introduces standard data types like:
+
 - Real
 - Boolean
 - Integer
@@ -30,7 +31,8 @@ By importing the namespace of the package ```ScalarValues``` we can access it
 by its simple name as follows:
 ```SysML::kickstart
  private import ScalarValues::*; // Allows us shortcuts to Real, Integer, etc. 
- private import SI::*; // Allows us shortcuts to Domains 
+ private import SI::*; // Allows us shortcuts to Domains
+ private import Ranges::*; // Allows us to specify constraints & co/contravariance 
  attribute r: Real = oneOf(2.0 .. 3.0); // assigns r a value, constraine to the range 2 to 3.
  attribute i: Integer = 2; // assigns i the value 2. 
 ```
@@ -53,18 +55,18 @@ It provides additional means to add constraints to numbers; the constraints can
 ```Markdown
 library package Ranges {
  // Abstract concept of a Range from which a Real is chosen
- datatype InRange {
- feature min: ScalarValues::Real;
- feature max: ScalarValues::Real;
- inv { (min <= self) and (self <= max) }
+ abstract datatype InRange {
+ feature range: Ranges::Range; // Models a range 
+ inv { (that.min <= self) and (that <= range.max) }
  }
- datatype AllInRange :> InRange;
+ abstract datatype AllInRange :> InRange; // ... 
+ abstract datatype QuantityInRange :> InRange; // ... 
 }
 ```
  These constraints are used to represent and propagate constraints, where
 
-- _min_ is a known lower bound,
-- _max_ is a known upper bound,
+- _range_ bounds the range of a Number (e.g. Integer, Real) to the given range. 
+
 - _AllInRange_ specifies that the constraint system shall be satisfied for all values in the range _min .. max_.
 
 Below, we give some simple examples.
@@ -84,7 +86,7 @@ part rangeExample {
  attribute height: Length = oneOf(10.0 .. 100.0 [cm]);
  attribute width: Length = oneOf(1.0 .. 1.1 [m]);
  attribute length: Length = oneOf(1.0 .. 1.1 [m]);
- attribute volume: Volume = height * width * length {
+ attribute volume: Volume, Ranges::QuantityInRange = height * width * length {
  :>> range = "1000.0 .. 2000.0";
  :>> unit = "l"; 
  }
@@ -141,10 +143,10 @@ Units are converted automatically before computations are done, and the consiste
 the unit left of a dependency, and the unit right of it must be convertible into each other.
 ```SysML::kickstart
  package unitsExample {
- attribute t: Time [s]  = 1.0 [s];
- attribute v: Speed [m/s] = 3.0 [m/s];
- attribute g: Acceleration [m/s^2] = 4.0 [m/s^2];
- attribute s: Speed [m/s] = sqrt(sqr(v)+sqr(g)*sqr(t)); 
+ attribute t: Time = 1.0 [s];
+ attribute v: Speed = 3.0 [m/s];
+ attribute g: Acceleration   = 4.0 [m/s^2];
+ attribute s: Speed = sqrt(sqr(v)+sqr(g)*sqr(t)); 
  }
 ```
 Play with the units, e.g., by changing the unit after the type declaration or try ms instead of s.
@@ -153,7 +155,7 @@ For date and time, the ISO format is supported.
 We can add and subtract times in this format.
 ```SysML::kickstart::unitsExample
  attribute date: Time [DateTime] = DateTime("2021-10-10T03:00:00");
- attribute time: Time [a] = 1.0 a;
+ attribute time: Time = 1.0 a {:>> unit="a";}
  attribute dateResult: Time [DateTime] = date + time;
 ```
 ### Vectors
@@ -163,17 +165,17 @@ operations like the angle or cross-product.
 Here is an example for defining vectors:
 ```SysML::kickstart
 package vectors {
- attribute a: Mass(0.0..1.0,1.0..2.0) [kg] = (0.5,1.5) kg; 
+ attribute a: Mass = (0.5,1.5) kg {:>> range="0.0..1.0,1.0..2.0";}
  attribute b: Mass = (0.5,1.5) kg; 
- attribute c: Mass(-5.0..-1.0,-1.0..2.0, 2.0..4.0) [kg] = (-5.0, -1.0, 3.0) kg; 
+ attribute c: Mass = (-5.0, -1.0, 3.0) kg {:>> range="-5.0..-1.0,-1.0..2.0, 2.0..4.0";}
 }
 ```
 In the next example, there is a calculation with Vectors with the cross-product and angle.
 ```SysML::kickstart::vectors
- attribute a2: Real(1..1,5..5,10..10);
- attribute b2: Real(5..5,1..1,10..10);
+ attribute a2: Real, InRange {:>> range="1..1,5..5,10..10";}
+ attribute b2: Real, InRange {:>> range="5..5,1..1,10..10";}
  attribute c2: Real = a2 cross b2;
- attribute d2: Quantity [°] = angle(a2,b2); 
+ attribute d2: Quantity = angle(a2,b2) {:>>unit="°";} 
 ```
 ## Types and Functions in Expressions
 SysMD supports the following types:
@@ -249,13 +251,13 @@ vehicles via its path as shown in the example below.
 ```SysML::kickstart
  package carParts {
  part def Body {
- attribute mass: Mass(300.0) [kg];
+ attribute mass: Mass {:>> range="300.0";}
  }
  part def Engine {
- attribute mass: Mass(300.0) [kg];
+ attribute mass: Mass {:>> range="300.0";}
  }
  part def Wheel {
- attribute mass: Mass(50.0) [kg];
+ attribute mass: Mass {:>> range="50.0";}
  }
  }
 ```
@@ -291,14 +293,14 @@ Specializations inherit features.
  // We consider a vehicle to be anything that has at least one wheel. 
  // The bySubclasses determines a consistent value for mass with min diameter. 
  part def Vehicle {
- attribute mass: Mass(0..1000) [kg] = bySpecializations(mass);
+ attribute mass: Mass = bySpecializations(mass) {:>> range ="0..1000";}
  part wheels: carParts::Wheel[1 .. *]; 
  }
  
  // A car is a vehicle with Body and Engine. 
  // the sumOverParts determines a consistent minimal range consistent with parts.
  part def Car :> Vehicle {
- attribute redefines mass: Mass(0 .. 1000)[kg] = sumOverParts(mass); 
+ attribute redefines mass: Mass = sumOverParts(mass) {:>> range ="0 .. 1000";}
  part wheels: carParts::Wheel[4 .. 10]; 
  part body: carParts::Body;
  part engine: carParts::Engine;
@@ -321,7 +323,7 @@ Boolean properties. They may also have a physical unit. Then, we specify:
 
 There is also a possibility to define user defined functions with any number of input variables .
 These functions can be defined once and used multiple times.
-```SysML::Global::kickstart
+```SysML::kickstart
  package CalculationExample {
  // Definition of a Calculation
  calc def calcEnergy {

install/3-SysMLv2Tutorial/sysml.md

@@ -287,7 +287,8 @@ package stateMachineExample {
 }
 ```
 While no calculations are yet done by SysMD for state machines, one can render it.
-Navigate in the hasA tree to the state status and right-click on it. 
+Navigate in the hasA tree to the state ```tutorial::sysml::stateMachineExample::part1::status```.
+Right-click on it. 
 Select render graph, and the following automata graph will be shown: 
 
 ![Graph](Files/statemachine.png){width=400 height=220}

src/main/kotlin/com/github/tukcps/sysmd/Main.kt

@@ -18,13 +18,12 @@ val logger: Logger = LoggerFactory.getLogger("SysMD Notebook")
 
 fun main(args: Array<String>) {
 
- SplashScreen.show()
+ SplashScreen.show("headless" in args)
 
  SpringApplicationBuilder(
  SysMdRunner::class.java,
- ) .headless(false)
+ ) .headless("headless" in args)
  .run(*args)
-
 }
 
 /**
@@ -35,20 +34,10 @@ fun main(args: Array<String>) {
  */
 object SplashScreen {
 
- // Prevent splash screen during unit tests or for server mode ...
- private fun isRunningTest(): Boolean {
- try {
- Class.forName("org.junit.Test")
- } catch (e: ClassNotFoundException) {
- return false
- }
- return true
- }
-
  private var splashScreen: JFrame? = null
 
- fun show() {
- if (!isRunningTest()) {
+ fun show(headless: Boolean) {
+ if (!headless) {
  splashScreen = JFrame("SysMD Notebook Splash Screen")
  splashScreen?.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE)
  splashScreen?.setSize(1000, 800)

src/main/kotlin/com/github/tukcps/sysmd/SysMdRunner.kt

@@ -14,6 +14,7 @@ import com.github.tukcps.sysmd.exports.Exporter
 import com.github.tukcps.sysmd.exports.UcbDataPack
 import com.github.tukcps.sysmd.generated.resources.Res
 import com.github.tukcps.sysmd.generated.resources.SysMD_Icon
+import com.github.tukcps.sysmd.model.kerml.Feature
 import com.github.tukcps.sysmd.model.sysml.StateUsage
 import com.github.tukcps.sysmd.rest.RESTRepository
 import com.github.tukcps.sysmd.services.session.SessionManager
@@ -104,7 +105,7 @@ open class SysMdRunner: CommandLineRunner {
  if ("headless" !in args)
  try {
  init()
- logger.info("Starting SysMD ${AppTheme.version} with options '$args'")
+ logger.info("Starting SysMD ${AppTheme.version} with options ${args.toList()}")
  val sysMdViewModel = SysMDViewModel(session)
  application {
  val showDialog = remember { mutableStateOf(false) }
@@ -173,7 +174,7 @@ open class SysMdRunner: CommandLineRunner {
  var ucbData: UcbDataPack? = null
  val systemcExporter = Exporter()
  try {
- systemcExporter.analyzeSysMD(elementToSystemC?.value!!)
+ systemcExporter.analyzeSysMD(elementToSystemC?.value!! as Feature)
  ucbData = systemcExporter.getUCBData()
  openUCB.value = true
  } catch (e: Exception) {

src/main/kotlin/com/github/tukcps/sysmd/compiler/HoodSysmlParser.kt

@@ -28,5 +28,5 @@ class HoodSysmlParser {
  fun getActionUsages(owner: Element): List<ActionUsage> =
  owner.getOwnedElementsOfType<ActionUsage>()
 
- fun getOwner(it: Element) = it.owner.ref
+ fun getOwner(it: Element) = it.owner
 }

src/main/kotlin/com/github/tukcps/sysmd/compiler/KerML.kt

@@ -9,11 +9,10 @@ import com.github.tukcps.sysmd.compiler.parser.kerml.QualifiedName
 import com.github.tukcps.sysmd.compiler.parser.util.ParserProductionRules
 import com.github.tukcps.sysmd.compiler.scanner.Token
 import com.github.tukcps.sysmd.compiler.scanner.Token.Kind.*
-import com.github.tukcps.sysmd.compiler.semantics.SemanticActions
+import com.github.tukcps.sysmd.compiler.semantics.ActionsContext
 import com.github.tukcps.sysmd.exceptions.Issue
 import com.github.tukcps.sysmd.exceptions.SyntaxError
 import com.github.tukcps.sysmd.exceptions.SysMDException
-import com.github.tukcps.sysmd.model.kerml.TextualRepresentation
 import com.github.tukcps.sysmd.model.util.QualifiedName
 import com.github.tukcps.sysmd.quantities.Quantity
 import com.github.tukcps.sysmd.services.session.Session
@@ -46,36 +45,30 @@ open class KerML(
  keywords: Map<String, Token.Kind> = Token.kerMLKeywords,
 ) : ParserProductionRules(keywords = keywords) {
 
- var semantics: SemanticActions = SemanticActions(model, compiler = this)
+ var semantics = ActionsContext(model, compiler = this)
 
  /**
- * Parses the body of the textual representation while considering the owner prefix.
- */
- @Deprecated("Use parse with string input instead")
- fun parse(textualRepresentation: TextualRepresentation) {
- this.input = textualRepresentation.body
- semantics.initOwners(textualRepresentation.getOwnerPrefix())
- parse()
- }
-
- /**
- * Parses an input directly.
- * No TextualRepresentation is needed, and no annotations, etc.
+ * Parses an input directly given as a CharSequence.
  * @param input the char sequence that is parsed
  * @param ownerQualifiedName the qualified name of the package that gives the scope.
  */
  fun parse(
  input: CharSequence,
- ownerQualifiedName: QualifiedName = "Global",
+ ownerQualifiedName: QualifiedName = "",
  ){
  this.input = input
- semantics.initOwners(ownerQualifiedName)
+ semantics.initOwningNamespaces(ownerQualifiedName)
  parse()
  }
 
 
- // Re-definition of the Parser template's error message function
- override var error = fun(message: String) { model.status.error(message = message, this) }
+ /**
+ * Re-definition of the Parser template's error message function.
+ * error is a lambda that is used for error reporting.
+ */
+ override var error = fun(message: String) {
+ model.status.error(message = message, this, element = semantics.element())
+ }
 
  /**
  * RootNamespace :- ( NamespaceBodyElement )* EOF
@@ -86,20 +79,20 @@ open class KerML(
  NamespaceBodyElement() // KerML textual
  } catch (exception: Exception) {
  handleError(exception)
- semantics.initOwners("Global")
+ semantics.initOwningNamespaces("Global")
  }
  }
  try {
  EOF.consume()
  } catch (exception: Exception) {
  handleError(exception)
- semantics.initOwners("Global")
+ semantics.initOwningNamespaces("Global")
  }
  }
 
 
  /**
- * QualifiedNameList :- QualifiedName ("," QualifiedName )*
+ *  QualifiedNameList :- QualifiedName ("," QualifiedName )*
  * Semantics: returns a list of identifications that have been parsed.
  */
  fun QualifiedNameList(): MutableList<QualifiedName> {
@@ -170,13 +163,13 @@ open class KerML(
  } else
  model.status.fatal(exception.message?: "Unknown error", this, cause = exception)
  // Skip input until we get the next DOT (=end of triple) or RCURBRACE or EOF.
- var nested = 0;
+ var nested = 0
  while (
  (token.kind != SEMICOLON || nested > 0)
  && token.kind != EOF
  && (token.kind != RCURBRACE || nested <= 0)) {
- if (token.kind == LCURBRACE) nested = nested+1;
- if (token.kind == RCURBRACE) nested = nested-1;
+ if (token.kind == LCURBRACE) nested = nested+1
+ if (token.kind == RCURBRACE) nested = nested-1
  consume()
  }
  // If parser skips right curly brace, we need to also pop one from the owner stack.
@@ -190,14 +183,14 @@ open class KerML(
  internal fun handleSyntaxError(message: String) {
  model.status.error(message, this, semantics.namespace, Issue.Kind.ERROR_SYNTACTICAL)
  // Skip input until we get the next DOT (=end of triple) or RCURBRACE or EOF.
- var nested = 0;
+ var nested = 0
  while (
  (token.kind != SEMICOLON || nested > 0)
  && token.kind != EOF
  && (token.kind != RCURBRACE || nested <= 0)
  ) {
- if (token.kind == LCURBRACE) nested = nested+1;
- if (token.kind == RCURBRACE) nested = nested-1;
+ if (token.kind == LCURBRACE) nested = nested+1
+ if (token.kind == RCURBRACE) nested = nested-1
  consume()
  }
  // If parser skips right curly brace, we need to also pop one from the owner stack.