enable unions in tuples

CHANGELOG.md

@@ -27,6 +27,10 @@ generated in the following situations:
 
 ### 2.0.5-dev
 
+* [TRLC, LRM] Allow union types as tuple field types:
+  `tuple Ref { item [TypeA, TypeB] separator @ version Integer }` now
+  permits a tuple field to reference objects of any of the listed record types.
+
 
 
 ### 2.0.4

documentation/TUTORIAL-TUPLES.md

@@ -29,8 +29,23 @@ Requirement potato {
 }
 ```
 
-Tuples can contain any kind of data, including other tuples; but it is
-not possible to have array fields or create recursive tuples.
+Tuples can contain any kind of data, including other tuples and union
+types; but it is not possible to have array fields or create recursive
+tuples.
+
+A field in a tuple may also use the union type syntax to accept
+references to any of several record types:
+
+```
+tuple LevelRef {
+   item    [SystemRequirement, AssumedRequirement]
+   separator @
+   version Integer
+}
+```
+
+This follows the same rules as union type fields on record types (see
+[Advanced Types](TUTORIAL-ADVANCED-TYPES.md)).
 
 ## Syntactic sugar
 

language-reference-manual/lrm.trlc

@@ -529,7 +529,7 @@ section "Type declarations" {
                             '}'
 
       field_declaration ::=
-        described_name [ 'optional' ] qualified_name_FIELD_TYPE
+        described_name [ 'optional' ] ( qualified_name_FIELD_TYPE | union_type )
 
       separator_declaration ::=
         'separator' separator_symbol
@@ -544,7 +544,8 @@ section "Type declarations" {
     Static_Semantics Tuple_Field_Types {
       text = '''
       A field type names any valid visible and complete
-      type. *(Specifically you may not have a recursive
+      type. This includes union types (see union_type).
+      *(Specifically you may not have a recursive
       tuple reference.)*
       '''
     }

tests-system/union-type-in-tuple-checks/output

@@ -0,0 +1,3 @@
+derived_from = s1 @ 0
+                    ^ union-type-in-tuple-checks/test.trlc:14: check error: version must be positive
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-checks/output.brief

@@ -0,0 +1,2 @@
+union-type-in-tuple-checks/test.trlc:14:23: trlc check error: version must be positive
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-checks/output.json

@@ -0,0 +1,3 @@
+derived_from = s1 @ 0
+                    ^ union-type-in-tuple-checks/test.trlc:14: check error: version must be positive
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-checks/output.smtlib

@@ -0,0 +1,3 @@
+derived_from = s1 @ 0
+                    ^ union-type-in-tuple-checks/test.trlc:14: check error: version must be positive
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-checks/test.rsl

@@ -0,0 +1,24 @@
+package Test
+
+type SystemReq {
+  description String
+}
+
+type AssumedReq {
+  rationale String
+}
+
+tuple LevelRef {
+  item      [SystemReq, AssumedReq]
+  separator @
+  version   Integer
+}
+
+checks LevelRef {
+  version > 0, error "version must be positive", version
+}
+
+type FeatReq {
+  description  String
+  derived_from LevelRef
+}

tests-system/union-type-in-tuple-checks/test.trlc

@@ -0,0 +1,15 @@
+package Test
+
+SystemReq s1 {
+  description = "system req 1"
+}
+
+FeatReq f1 {
+  description  = "ok"
+  derived_from = s1 @ 1
+}
+
+FeatReq f2 {
+  description  = "bad version"
+  derived_from = s1 @ 0
+}

tests-system/union-type-in-tuple-checks/tracing

@@ -0,0 +1,3 @@
+LRM.Tuple_Field_Types
+LRM.union_type
+LRM.Evaluation_Of_Checks

tests-system/union-type-in-tuple-duplicate/output

@@ -0,0 +1,3 @@
+item    [TypeA, TypeB, TypeA]
+                       ^^^^^ union-type-in-tuple-duplicate/test.rsl:12: error: duplicate type TypeA in union
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-duplicate/output.brief

@@ -0,0 +1,2 @@
+union-type-in-tuple-duplicate/test.rsl:12:26: trlc error: duplicate type TypeA in union
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-duplicate/output.json

@@ -0,0 +1,4 @@
+item    [TypeA, TypeB, TypeA]
+                       ^^^^^ union-type-in-tuple-duplicate/test.rsl:12: error: duplicate type TypeA in union
+{}
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-duplicate/output.smtlib

@@ -0,0 +1,3 @@
+item    [TypeA, TypeB, TypeA]
+                       ^^^^^ union-type-in-tuple-duplicate/test.rsl:12: error: duplicate type TypeA in union
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-duplicate/test.rsl

@@ -0,0 +1,20 @@
+package Test
+
+type TypeA {
+  a Integer
+}
+
+type TypeB {
+  b Integer
+}
+
+tuple BadRef {
+  item    [TypeA, TypeB, TypeA]
+  separator @
+  version Integer
+}
+
+type Req {
+  description String
+  link        BadRef
+}

tests-system/union-type-in-tuple-duplicate/test.trlc

@@ -0,0 +1 @@
+package Test

tests-system/union-type-in-tuple-duplicate/tracing

@@ -0,0 +1,2 @@
+LRM.Union_Type_No_Duplicates
+LRM.Tuple_Field_Types

tests-system/union-type-in-tuple-no-separator/output

@@ -0,0 +1 @@
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple-no-separator/output.brief

@@ -0,0 +1 @@
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple-no-separator/output.json

@@ -0,0 +1,23 @@
+{
+  "alpha1": {
+    "a": "alpha"
+  },
+  "beta1": {
+    "b": "beta"
+  },
+  "r1": {
+    "description": "linked to alpha",
+    "parent": {
+      "item": "Test.alpha1",
+      "version": 1
+    }
+  },
+  "r2": {
+    "description": "linked to beta",
+    "parent": {
+      "item": "Test.beta1",
+      "version": 2
+    }
+  }
+}
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple-no-separator/output.smtlib

@@ -0,0 +1 @@
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple-no-separator/test.rsl

@@ -0,0 +1,19 @@
+package Test
+
+type AlphaReq {
+  a String
+}
+
+type BetaReq {
+  b String
+}
+
+tuple ReqRef {
+  item    [AlphaReq, BetaReq]
+  version Integer
+}
+
+type Req {
+  description String
+  parent      ReqRef
+}

tests-system/union-type-in-tuple-no-separator/test.trlc

@@ -0,0 +1,19 @@
+package Test
+
+AlphaReq alpha1 {
+  a = "alpha"
+}
+
+BetaReq beta1 {
+  b = "beta"
+}
+
+Req r1 {
+  description = "linked to alpha"
+  parent      = (alpha1, 1)
+}
+
+Req r2 {
+  description = "linked to beta"
+  parent      = (beta1, 2)
+}

tests-system/union-type-in-tuple-no-separator/tracing

@@ -0,0 +1,3 @@
+LRM.union_type
+LRM.Tuple_Field_Types
+LRM.Tuple_Generic_Form

tests-system/union-type-in-tuple-optional/output

@@ -0,0 +1 @@
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple-optional/output.brief

@@ -0,0 +1 @@
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple-optional/output.json

@@ -0,0 +1,30 @@
+{
+  "alpha": {
+    "a": "hello"
+  },
+  "beta": {
+    "b": "world"
+  },
+  "r1": {
+    "description": "with version",
+    "link": {
+      "ref": "Test.alpha",
+      "version": 1
+    }
+  },
+  "r2": {
+    "description": "with version",
+    "link": {
+      "ref": "Test.beta",
+      "version": 2
+    }
+  },
+  "r3": {
+    "description": "without version",
+    "link": {
+      "ref": "Test.alpha",
+      "version": null
+    }
+  }
+}
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple-optional/output.smtlib

@@ -0,0 +1 @@
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple-optional/test.rsl

@@ -0,0 +1,20 @@
+package Test
+
+type TypeA {
+  a String
+}
+
+type TypeB {
+  b String
+}
+
+tuple OptRef {
+  ref       [TypeA, TypeB]
+  separator @
+  version   optional Integer
+}
+
+type Req {
+  description String
+  link        OptRef
+}

tests-system/union-type-in-tuple-optional/test.trlc

@@ -0,0 +1,24 @@
+package Test
+
+TypeA alpha {
+  a = "hello"
+}
+
+TypeB beta {
+  b = "world"
+}
+
+Req r1 {
+  description = "with version"
+  link = alpha @ 1
+}
+
+Req r2 {
+  description = "with version"
+  link = beta @ 2
+}
+
+Req r3 {
+  description = "without version"
+  link = alpha
+}

tests-system/union-type-in-tuple-optional/tracing

@@ -0,0 +1,4 @@
+LRM.Tuple_Field_Types
+LRM.union_type
+LRM.Tuple_Optional_Fields
+LRM.Tuple_Optional_Requires_Separators

tests-system/union-type-in-tuple-wrong-type/output

@@ -0,0 +1,3 @@
+derived_from = other1 @ 1
+               ^^^^^^ union-type-in-tuple-wrong-type/test.trlc:9: error: expected reference of type [SystemReq, AssumedSystemReq], but other1 is of type OtherReq
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-wrong-type/output.brief

@@ -0,0 +1,2 @@
+union-type-in-tuple-wrong-type/test.trlc:9:18: trlc error: expected reference of type [SystemReq, AssumedSystemReq], but other1 is of type OtherReq
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-wrong-type/output.json

@@ -0,0 +1,3 @@
+derived_from = other1 @ 1
+               ^^^^^^ union-type-in-tuple-wrong-type/test.trlc:9: error: expected reference of type [SystemReq, AssumedSystemReq], but other1 is of type OtherReq
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-wrong-type/output.smtlib

@@ -0,0 +1,3 @@
+derived_from = other1 @ 1
+               ^^^^^^ union-type-in-tuple-wrong-type/test.trlc:9: error: expected reference of type [SystemReq, AssumedSystemReq], but other1 is of type OtherReq
+Processed 1 model and 1 requirement file and found 1 error

tests-system/union-type-in-tuple-wrong-type/test.rsl

@@ -0,0 +1,24 @@
+package Test
+
+type SystemReq {
+  description String
+}
+
+type AssumedSystemReq {
+  rationale String
+}
+
+type OtherReq {
+  text String
+}
+
+tuple SystemLevelReqId {
+  item      [SystemReq, AssumedSystemReq]
+  separator @
+  version   Integer
+}
+
+type FeatReq {
+  description  String
+  derived_from SystemLevelReqId
+}

tests-system/union-type-in-tuple-wrong-type/test.trlc

@@ -0,0 +1,10 @@
+package Test
+
+OtherReq other1 {
+  text = "I am not a system req"
+}
+
+FeatReq bad {
+  description  = "wrong type in union tuple field"
+  derived_from = other1 @ 1
+}

tests-system/union-type-in-tuple-wrong-type/tracing

@@ -0,0 +1,3 @@
+LRM.union_type
+LRM.Tuple_Field_Types
+LRM.References_To_Extensions

tests-system/union-type-in-tuple/output

@@ -0,0 +1 @@
+Processed 1 model and 1 requirement file and found no issues

tests-system/union-type-in-tuple/output.brief

@@ -0,0 +1 @@
+Processed 1 model and 1 requirement file and found no issues