Merge pull request #707 from nasa/feature/external-params

Add support for externally stored parameters

Author: bocchino

.gitignore

@@ -8,3 +8,6 @@ __SHADOW__
 __pycache__
 dist/
 fprime_fpp/fpp_version_info.py
+# Scala metals project files
+compiler/project/metals.sbt
+compiler/project/project/

compiler/lib/src/main/scala/analysis/Analysis.scala

@@ -309,12 +309,12 @@ case class Analysis(
   def getIntValueOpt[T](nodeOpt: Option[AstNode[T]]): Result.Result[Option[Int]] =
     Result.mapOpt(nodeOpt, (node: AstNode[T]) => getIntValue(node.id))
 
-  /** Gets an optional nonnegative BigInt value from an AST ndoe */
+  /** Gets an optional nonnegative BigInt value from an AST node */
   def getNonnegativeBigIntValueOpt[T](nodeOpt: Option[AstNode[T]]):
     Result.Result[Option[BigInt]] =
     Result.mapOpt(nodeOpt, (node: AstNode[T]) => getNonnegativeBigIntValue(node.id))
 
-  /** Gets an optional nonnegative int value from an AST ndoe */
+  /** Gets an optional nonnegative int value from an AST node */
   def getNonnegativeIntValueOpt[T](nodeOpt: Option[AstNode[T]]): Result.Result[Option[Int]] =
     Result.mapOpt(nodeOpt, (node: AstNode[T]) => getNonnegativeIntValue(node.id))
 

compiler/lib/src/main/scala/analysis/Semantics/Component.scala

@@ -49,6 +49,9 @@ case class Component(
   /** Query whether the component has parameters */
   def hasParameters = this.paramMap.size > 0
 
+  /** Query whether the component has external parameters */
+  def hasExternalParameters = paramMap.values.exists(_.isExternal)
+
   /** Query whether the component has commands */
   def hasCommands = this.commandMap.size > 0
 
@@ -148,7 +151,7 @@ case class Component(
         val loc = instance.getLoc
         val prevLoc = prevInstance.getLoc
         Left(SemanticError.DuplicateStateMachineInstance(name, loc, prevLoc))
-      case None => 
+      case None =>
         val stateMachineInstanceMap = this.stateMachineInstanceMap + (name -> instance)
         val component = this.copy(stateMachineInstanceMap = stateMachineInstanceMap)
         Right(component)
@@ -164,7 +167,7 @@ case class Component(
         val loc = instance.getLoc
         val prevLoc = prevInstance.getLoc
         Left(SemanticError.DuplicatePortInstance(name, loc, prevLoc))
-      case None => 
+      case None =>
         val portMap = this.portMap + (name -> instance)
         val component = this.copy(portMap = portMap)
         Right(component)
@@ -180,7 +183,7 @@ case class Component(
         val loc = instance.getLoc
         val prevLoc = prevInstance.getLoc
         Left(SemanticError.DuplicatePortInstance(kind.toString, loc, prevLoc))
-      case None => 
+      case None =>
         val specialPortMap = this.specialPortMap + (kind -> instance)
         val component = this.copy(specialPortMap = specialPortMap)
         Right(component)
@@ -224,7 +227,7 @@ case class Component(
       defaultEventId = result._2
     )
   }
-  
+
   /** Add a parameter */
   def addParam(
     idOpt: Option[Param.Id],
@@ -305,7 +308,7 @@ case class Component(
         portKinds: List[Ast.SpecPortInstance.SpecialKind]
       ) = if (condition) Result.map(
         portKinds,
-        (portKind: Ast.SpecPortInstance.SpecialKind) => 
+        (portKind: Ast.SpecPortInstance.SpecialKind) =>
           this.specialPortMap.get(portKind) match {
             case Some(_) => Right(())
             case None =>
@@ -436,7 +439,7 @@ case class Component(
           val error = SemanticError.PassiveStateMachine(loc)
           Left(error)
         }
-      ) 
+      )
       for {
         _ <- checkPortInstances()
         _ <- checkCommands()

compiler/lib/src/main/scala/analysis/Semantics/Param.scala

@@ -9,7 +9,8 @@ final case class Param(
   paramType: Type,
   default: Option[Value],
   setOpcode: BigInt,
-  saveOpcode: BigInt
+  saveOpcode: BigInt,
+  isExternal: Boolean
 ) {
 
   /** Gets the name of the parameter */
@@ -52,7 +53,7 @@ object Param {
       yield {
         val (setOpcode, defaultOpcode1) = computeOpcode(setOpcodeOpt, defaultOpcode)
         val (saveOpcode, defaultOpcode2) = computeOpcode(saveOpcodeOpt, defaultOpcode1)
-        (Param(aNode, paramType, default, setOpcode, saveOpcode), defaultOpcode2)
+        (Param(aNode, paramType, default, setOpcode, saveOpcode, data.isExternal), defaultOpcode2)
       }
    }
 

compiler/lib/src/main/scala/ast/Ast.scala

@@ -590,8 +590,9 @@ object Ast {
     typeName: AstNode[TypeName],
     default: Option[AstNode[Expr]],
     id: Option[AstNode[Expr]],
-    setOpcode:  Option[AstNode[Expr]],
-    saveOpcode:  Option[AstNode[Expr]]
+    setOpcode: Option[AstNode[Expr]],
+    saveOpcode: Option[AstNode[Expr]],
+    isExternal: Boolean
   )
 
   /** Port instance specifier */

compiler/lib/src/main/scala/codegen/AstWriter.scala

@@ -473,7 +473,7 @@ object AstWriter extends AstVisitor with LineUtils {
   ) = {
     val (_, node, _) = aNode
     val data = node.data
-    lines("spec param") ++
+    lines(if data.isExternal then "external spec param" else "spec param") ++
     List.concat(
       ident(data.name),
       typeNameNode(data.typeName),

compiler/lib/src/main/scala/codegen/CppWriter/ComponentCppWriter/ComponentCppWriter.scala

@@ -93,11 +93,13 @@ case class ComponentCppWriter (
       guardedList (hasChannels) (List("Fw/Tlm/TlmString.hpp"))
     val prmStrHeaders =
       guardedList (hasParameters) (List("Fw/Prm/PrmString.hpp"))
+    val prmExtHeaders =
+      guardedList (hasExternalParameters) (List("Fw/Prm/PrmExternalTypes.hpp"))
     val logStrHeaders =
       guardedList (hasEvents) (List("Fw/Log/LogString.hpp"))
     val internalStrHeaders =
       guardedList (hasInternalPorts) (List("Fw/Types/InternalInterfaceString.hpp"))
-    val systemHeaders = 
+    val systemHeaders =
       (guardedList (hasEvents) (
         List("atomic")
       )).map(CppWriter.systemHeaderString).sortBy(_.toLowerCase()).map(line)
@@ -114,6 +116,7 @@ case class ComponentCppWriter (
         cmdStrHeaders,
         tlmStrHeaders,
         prmStrHeaders,
+        prmExtHeaders,
         logStrHeaders,
         internalStrHeaders
       ).map(CppWriter.headerString)
@@ -263,10 +266,10 @@ case class ComponentCppWriter (
           ),
           lines(
             s"""|
-                |//! Friend class for white-box testing
-                |friend class ${componentClassName}Friend;
                 |//! Friend class tester to support autocoded test harness
                 |friend class ${componentName}TesterBase;
+                |//! Friend class tester implementation to support white-box testing
+                |friend class ${componentName}Tester;
                 |"""
           )
         ).flatten
@@ -524,8 +527,8 @@ case class ComponentCppWriter (
     }
 
     addAccessTagAndComment(
-      "PROTECTED",
-      "Component construction and destruction",
+    "PROTECTED",
+    "Component construction and destruction",
       List(
         constructorClassMember(
           Some(s"Construct $componentClassName object"),
@@ -537,17 +540,18 @@ case class ComponentCppWriter (
               Some("\"\"")
             )
           ),
-          s"Fw::${kindStr}ComponentBase(compName)" ::
-            smInstancesByName.map((name, smi) => {
+          List(s"Fw::${kindStr}ComponentBase(compName)") :::
+            (if (hasExternalParameters) List("paramDelegatePtr(NULL)") else Nil) :::
+            smInstancesByName.map { (name, smi) =>
               val sm = s.a.stateMachineMap(smi.symbol)
               val hasActionsOrGuards = sm.hasActions || sm.hasGuards
               val args = (smi.getSmKind, hasActionsOrGuards) match {
-                case (StateMachine.Kind.External, _) => "this"
-                case (StateMachine.Kind.Internal, true) => "*this"
-                case (StateMachine.Kind.Internal, false) => ""
+                case (StateMachine.Kind.External, _)       => "this"
+                case (StateMachine.Kind.Internal, true)    => "*this"
+                case (StateMachine.Kind.Internal, false)   => ""
               }
               s"m_stateMachine_$name($args)"
-            }),
+            },
           intersperseBlankLines(
             List(
               intersperseBlankLines(
@@ -558,8 +562,8 @@ case class ComponentCppWriter (
               throttledEvents.map((_, event) => line(
                 s"this->${eventThrottleCounterName(event.getName)} = 0;"
               )),
-              sortedParams.map((_, param) => line(
-                s"this->${paramValidityFlagName(param.getName)} = Fw::ParamValid::UNINIT;"
+              sortedParams.flatMap((_, param) => guardedList(!param.isExternal) (
+                lines(s"this->${paramValidityFlagName(param.getName)} = Fw::ParamValid::UNINIT;")
               ))
             )
           )

compiler/lib/src/main/scala/codegen/CppWriter/ComponentCppWriter/ComponentCppWriterUtils.scala

@@ -313,6 +313,8 @@ abstract class ComponentCppWriterUtils(
 
   val hasParameters: Boolean = component.paramMap.nonEmpty
 
+  val hasExternalParameters: Boolean = component.paramMap.values.exists(_.isExternal)
+
   val hasDataProducts: Boolean = component.hasDataProducts
 
   val hasContainers: Boolean = containersByName != Nil
@@ -333,30 +335,32 @@ abstract class ComponentCppWriterUtils(
 
   /** Parameters for the init function */
   val initParams: List[CppDoc.Function.Param] = List.concat(
-    if componentData.kind != Ast.ComponentKind.Passive then List(
-      CppDoc.Function.Param(
-        CppDoc.Type("FwSizeType"),
-        "queueDepth",
-        Some("The queue depth")
+    guardedList (componentData.kind != Ast.ComponentKind.Passive) (
+      List(
+        CppDoc.Function.Param(
+          CppDoc.Type("FwSizeType"),
+          "queueDepth",
+          Some("The queue depth")
+        )
       )
-    )
-    else Nil,
-    if hasSerialAsyncInputPorts then List(
-      CppDoc.Function.Param(
-        CppDoc.Type("FwSizeType"),
-        "msgSize",
-        Some("The message size")
+    ),
+    guardedList (hasSerialAsyncInputPorts) (
+      List(
+        CppDoc.Function.Param(
+          CppDoc.Type("FwSizeType"),
+          "msgSize",
+          Some("The message size")
+        )
       )
-    )
-    else Nil,
+    ),
     List(
       CppDoc.Function.Param(
         CppDoc.Type("FwEnumStoreType"),
         "instance",
         Some("The instance number"),
         Some("0")
       )
-    ),
+    )
   )
 
   val portParamTypeMap: ComponentCppWriterUtils.PortParamTypeMap =

compiler/lib/src/main/scala/codegen/CppWriter/ComponentCppWriter/ComponentImplWriter.scala

@@ -122,7 +122,25 @@ case class ComponentImplWriter(
       hookCmds.map(getCommandOverflowHook)
     )
 
-  private def getConstructor: CppDoc.Class.Member =
+  private def getConstructor: CppDoc.Class.Member = {
+    val initializers = if (hasExternalParameters) {
+      Nil
+    } else {
+      List(s"$className(compName)")
+    }
+    val bodyLines = if (hasExternalParameters) {
+      lines(
+        s"""|// TODO Initialize the ParamExternalDelegate
+            |// The register function can be called directly here:
+            |// E.G. this->registerExternalParameters(SomeParamExternalDelegateChild());
+            |// Or you can call the register function in a public setup method
+            |// that is called when setting up the component instance.
+            |"""
+      )
+    } else {
+      Nil
+    }
+
     constructorClassMember(
       Some(s"Construct $componentImplClassName object"),
       List(
@@ -132,9 +150,10 @@ case class ComponentImplWriter(
           Some("The component name")
         )
       ),
-      List(s"$className(compName)"),
-      Nil
+      initializers,
+      bodyLines
     )
+  }
 
   private def getConstructorsAndDestructors: List[CppDoc.Class.Member] =
     addAccessTagAndComment(