Merge pull request #580 from jwest115/fpp-576

Require displayable types in records
nasa · Jan 25, 2025 · 5762c34 · 5762c34
2 parents 275a026 + 0ace648
commit 5762c34
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 10 deletions.
diff --git a/compiler/lib/src/main/scala/analysis/CheckSemantics/CheckComponentDefs.scala b/compiler/lib/src/main/scala/analysis/CheckSemantics/CheckComponentDefs.scala
@@ -119,9 +119,9 @@ object CheckComponentDefs
     aNode: Ast.Annotated[AstNode[Ast.SpecRecord]]
   ) = {
     val data = aNode._2.data
-    val record = Record.fromSpecRecord(a, aNode)
     for {
       idOpt <- a.getNonnegativeBigIntValueOpt(data.id)
+      record <- Record.fromSpecRecord(a, aNode)
       component <- a.component.get.addRecord(idOpt, record)
     }
     yield a.copy(component = Some(component))

diff --git a/compiler/lib/src/main/scala/analysis/Semantics/Record.scala b/compiler/lib/src/main/scala/analysis/Semantics/Record.scala
@@ -24,11 +24,14 @@ object Record {
 
   /** Creates a record from a record specifier */
   def fromSpecRecord(a: Analysis, aNode: Ast.Annotated[AstNode[Ast.SpecRecord]]):
-    Record = {
+    Result.Result[Record] = {
       val node = aNode._2
       val data = node.data
       val recordType = a.typeMap(data.recordType.id)
-      Record(aNode, recordType, data.isArray)
+      for {
+        _ <- a.checkDisplayableType(data.recordType.id, "type of record is not displayable")
+      }
+      yield Record(aNode, recordType, data.isArray)
     }
 
 }
diff --git a/compiler/tools/fpp-check/test/record/not_displayable.fpp b/compiler/tools/fpp-check/test/record/not_displayable.fpp
@@ -0,0 +1,21 @@
+module Fw {
+
+  port DpRequest
+  port DpResponse
+  port DpSend
+  port Time
+
+}
+
+passive component C {
+
+  product request port productRequestOut
+  sync product recv port productRecvIn
+  product send port productSendOut
+  time get port timeGetOut
+
+  type A
+  product container Container
+  product record R: A id 0x100
+
+}
diff --git a/compiler/tools/fpp-check/test/record/not_displayable.ref.txt b/compiler/tools/fpp-check/test/record/not_displayable.ref.txt
@@ -0,0 +1,10 @@
+fpp-check
+[ local path prefix ]/compiler/tools/fpp-check/test/record/not_displayable.fpp:19.21
+  product record R: A id 0x100
+                    ^
+error: type of record is not displayable
+
+[ local path prefix ]/compiler/tools/fpp-check/test/record/not_displayable.fpp:17.3
+  type A
+  ^
+Type is defined here
diff --git a/compiler/tools/fpp-check/test/record/tests.sh b/compiler/tools/fpp-check/test/record/tests.sh
@@ -8,5 +8,6 @@ missing_container
 missing_ports
 missing_product_recv_port
 missing_product_send_port
+not_displayable
 ok
 "
diff --git a/compiler/tools/fpp-locate-uses/test/defs.fpp b/compiler/tools/fpp-locate-uses/test/defs.fpp
@@ -78,8 +78,8 @@ constant queue_size_def = 10
 constant stack_size_def = 10
 constant priority_def = 10
 constant cpu_def = 0
-type RecordType
 constant record_id = 0
+array RecordType = [3] U32
 constant container_id = 0
 constant container_priority = 0
 constant product_recv_priority = 0

diff --git a/docs/fpp-spec.html b/docs/fpp-spec.html
@@ -6762,7 +6762,7 @@ <h4 id="Specifiers_Record-Specifiers_Semantics">7.13.2. Semantics</h4>
 </li>
 <li>
 <p>The type name <em>T</em> following the identifier specifies the type of the data stored
-in the record.</p>
+in the record. <em>T</em> must be a <a href="#Types_Displayable-Types">displayable type</a>.</p>
 <div class="olist loweralpha">
 <ol class="loweralpha" type="a">
 <li>
@@ -10582,7 +10582,7 @@ <h3 id="Analysis-and-Translation_Translation-Tools">22.4. Translation Tools</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-11 16:51:10 -0800
+Last updated 2025-01-24 15:53:17 -0800
 </div>
 </div>
 <script src="code-prettify/run_prettify.js"></script>

diff --git a/docs/fpp-users-guide.html b/docs/fpp-users-guide.html
@@ -8161,7 +8161,9 @@ <h4 id="Defining-Components_Data-Products_Basic-Data-Products">10.9.1. Basic Dat
 The simplest record specification consists of the keywords <code>product</code> <code>record</code>,
 a name, and a data type.
 The name is the name of the record.
-The data type is the type of the data that the record holds.</p>
+The data type is the type of the data that the record holds.
+The data type must be a
+<a href="#Defining-Components_Commands_Formal-Parameters">displayable type</a>.</p>
 </div>
 <div class="paragraph">
 <p>As an example, here is a component called <code>BasicDataProducts</code> that specifies
@@ -14817,7 +14819,7 @@ <h4 id="Writing-C-Plus-Plus-Implementations_Implementing-Deployments_Public-Symb
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-11 16:51:28 -0800
+Last updated 2025-01-24 15:52:51 -0800
 </div>
 </div>
 <script src="code-prettify/run_prettify.js"></script>

diff --git a/docs/index.html b/docs/index.html
@@ -463,7 +463,7 @@ <h1>F Prime Prime (FPP)</h1>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-07-20 12:45:03 -0700
+Last updated 2025-01-24 15:43:35 -0800
 </div>
 </div>
 </body>

diff --git a/docs/spec/Specifiers/Record-Specifiers.adoc b/docs/spec/Specifiers/Record-Specifiers.adoc
@@ -21,7 +21,7 @@ _]_
 . The identifier names the record.
 
 . The type name _T_ following the identifier specifies the type of the data stored
-in the record.
+in the record. _T_ must be a <<Types_Displayable-Types,displayable type>>.
 
 .. If the keyword `array` appears after the type name, then the record stores
 a variable number of elements of type _T_.

diff --git a/docs/users-guide/Defining-Components.adoc b/docs/users-guide/Defining-Components.adoc
@@ -2224,6 +2224,8 @@ The simplest record specification consists of the keywords `product` `record`,
 a name, and a data type.
 The name is the name of the record.
 The data type is the type of the data that the record holds.
+The data type must be a 
+<<Defining-Components_Commands_Formal-Parameters,displayable type>>.
 
 As an example, here is a component called `BasicDataProducts` that specifies
 two records and two containers.