Merge pull request #965 from nasa/issue-880-neighbor-path

Improve header paths in generated C++ code

Author: bocchino

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

@@ -100,7 +100,7 @@ case class ArrayCppWriter (
   private def getCppIncludes: CppDoc.Member = {
     val userHeaders = List(
       "Fw/Types/Assert.hpp",
-      s"${s.getRelativePath(fileName).toString}.hpp"
+      s.getIncludePath(symbol, fileName)
     ).sorted.map(CppWriter.headerString).map(line)
     linesMember(Line.blank :: userHeaders, CppDoc.Lines.Cpp)
   }

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

@@ -145,7 +145,7 @@ case class ComponentCppWriter (
       "Fw/Types/Assert.hpp",
       "Fw/Types/ExternalString.hpp",
       "Fw/Types/String.hpp",
-      s"${s.getRelativePath(fileName).toString}.hpp"
+      s.getIncludePath(componentSymbol, fileName)
     ).sorted.map(CppWriter.headerString).flatMap({
       case s: "#include \"Fw/Types/String.hpp\"" =>
         lines(

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

@@ -16,14 +16,10 @@ case class ComponentGTestBaseWriter(
 
   private val namespaceIdentList = componentNamespaceIdentList
 
-  private val relativeFileName = s.getRelativePath(fileName).toString
-
   private val symbol = componentSymbol
 
   private val testerFileName = ComputeCppFiles.FileNames.getComponentTesterBase(componentName)
 
-  private val testerRelativeFileName = s.getRelativePath(testerFileName).toString
-
   def write: CppDoc = {
     val includeGuard = s.includeGuardFromQualifiedName(symbol, fileName)
     CppWriter.createCppDoc(
@@ -53,7 +49,7 @@ case class ComponentGTestBaseWriter(
 
   private def getHppIncludes = {
     val userHeaders = List(
-      s"$testerRelativeFileName.hpp",
+      s.getIncludePath(componentSymbol, testerFileName),
       "gtest/gtest.h"
     ).sorted.map(CppWriter.headerString).map(line)
     linesMember(
@@ -62,9 +58,11 @@ case class ComponentGTestBaseWriter(
   }
 
   private def getCppIncludes = {
-    val userHeader = lines(CppWriter.headerString(s"$relativeFileName.hpp"))
+    val userHeaders = lines(
+      CppWriter.headerString(s.getIncludePath(componentSymbol, fileName))
+    )
     linesMember(
-      addBlankPrefix(userHeader),
+      addBlankPrefix(userHeaders),
       CppDoc.Lines.Cpp
     )
   }

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

@@ -14,8 +14,6 @@ case class ComponentTesterBaseWriter(
 
   private val componentFileName = ComputeCppFiles.FileNames.getComponent(componentName)
 
-  private val componentRelativeFileName = s.getRelativePath(componentFileName).toString
-
   private val fileName = ComputeCppFiles.FileNames.getComponentTesterBase(componentName)
 
   private val historyWriter = ComponentHistory(s, aNode)
@@ -24,14 +22,10 @@ case class ComponentTesterBaseWriter(
 
   private val namespaceIdentList = componentNamespaceIdentList
 
-  private val relativeFileName = s.getRelativePath(fileName).toString
-
-  private val symbol = componentSymbol
-
   private val externalParameterDelegate = ExternalParameterDelegate(s, aNode)
 
   def write: CppDoc = {
-    val includeGuard = s.includeGuardFromQualifiedName(symbol, fileName)
+    val includeGuard = s.includeGuardFromQualifiedName(componentSymbol, fileName)
     CppWriter.createCppDoc(
       s"$name component test harness base class",
       fileName,
@@ -61,7 +55,7 @@ case class ComponentTesterBaseWriter(
 
   private def getHppIncludes: CppDoc.Member = {
     val standardHeaders = List(
-      s"$componentRelativeFileName.hpp",
+      s.getIncludePath(componentSymbol, componentFileName),
       "Fw/Comp/PassiveComponentBase.hpp",
       "Fw/Port/InputSerializePort.hpp",
       "Fw/Types/Assert.hpp",
@@ -87,15 +81,17 @@ case class ComponentTesterBaseWriter(
   }
 
   private def getCppIncludes: CppDoc.Member = {
-    val userHeader = lines(CppWriter.headerString(s"$relativeFileName.hpp"))
+    val userHeaders = lines(
+      CppWriter.headerString(s.getIncludePath(componentSymbol, fileName))
+    )
     val systemHeaders = List(
       "cstdlib",
       "cstring"
     ).sorted.map(CppWriter.systemHeaderString).map(line)
     linesMember(
       List.concat(
         Line.blank :: systemHeaders,
-        Line.blank :: userHeader
+        Line.blank :: userHeaders
       ),
       CppDoc.Lines.Cpp
     )

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

@@ -127,16 +127,27 @@ case class CppWriterState(
       getQualifyingNameAsIdentList(psOpt, suffix1)
   }
 
+  /** Get the neighbor path of a symbol.
+   *  This is the path of the directory where the symbol is located,
+   *  with prefixes removed. */
+  def getNeighborPath(
+    sym: Symbol,
+    fileName: String
+  ): String = {
+    val loc = sym.getLoc.tuLocation
+    val fullPath = loc.getNeighborPath(fileName)
+    val path = removeLongestPathPrefix(fullPath)
+    path.toString
+  }
+
   /** Get an include path for a symbol and a file name base */
   def getIncludePath(
     sym: Symbol,
     fileNameBase: String,
     headerExtension: String = "hpp"
   ): String = {
-    val loc = sym.getLoc.tuLocation
-    val fullPath = loc.getNeighborPath(fileNameBase)
-    val path = removeLongestPathPrefix(fullPath)
-    s"${path.toString}.$headerExtension"
+    val neighborPath = getNeighborPath(sym, fileNameBase)
+    s"${neighborPath}.$headerExtension"
   }
 
   /** Write include directives for autocoded files */

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

@@ -97,7 +97,7 @@ case class EnumCppWriter(
     val systemStrings = List("cstring", "limits")
     val strings = List(
       "Fw/Types/Assert.hpp",
-      s"${s.getRelativePath(fileName).toString}.hpp"
+      s.getIncludePath(symbol, fileName)
     )
     linesMember(
       List(

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

@@ -151,7 +151,7 @@ case class PortCppWriter (
     val userHeaders = List(
       "Fw/Types/Assert.hpp",
       "Fw/Types/ExternalString.hpp",
-      s"${s.getRelativePath(fileName).toString}.hpp"
+      s.getIncludePath(symbol, fileName)
     ).sorted.map(CppWriter.headerString).map(line)
     linesMember(
       Line.blank :: userHeaders,

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

@@ -75,7 +75,7 @@ case class StateMachineCppWriter(
   private def getCppIncludes: CppDoc.Member = {
     val userHeaders = List.concat(
       standardUserCppHeaders,
-      List(s"${s.getRelativePath(fileName)}.hpp").map(CppWriter.headerString)
+      List(s.getIncludePath(symbol, fileName)).map(CppWriter.headerString)
     ).sorted
     val headerLines = List.concat(
       addBlankPrefix(standardSystemCppHeaders.map(line)),

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

@@ -132,7 +132,7 @@ case class StructCppWriter(
   private def getCppIncludes: CppDoc.Member = {
     val userHeaders = List(
       "Fw/Types/Assert.hpp",
-      s"${s.getRelativePath(fileName).toString}.hpp",
+      s.getIncludePath(symbol, fileName)
     ).sorted.map(CppWriter.headerString).map(line)
     linesMember(Line.blank :: userHeaders, CppDoc.Lines.Cpp)
   }

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

@@ -17,7 +17,9 @@ case class TlmPacketSetCppWriter(
 
   private val Some(t) = s.a.topology
 
-  private val d = s.a.dictionaryMap(Symbol.Topology(t.aNode))
+  private val topologySymbol = Symbol.Topology(t.aNode)
+
+  private val d = s.a.dictionaryMap(topologySymbol)
 
   private val tps = d.tlmPacketSetMap(name)
 
@@ -49,7 +51,7 @@ case class TlmPacketSetCppWriter(
       "Fw/Types/Assert.hpp",
       "Fw/Types/StringBase.hpp",
       "Fw/Time/Time.hpp",
-      s"${s.getRelativePath(fileName).toString}.hpp",
+      s.getIncludePath(topologySymbol, fileName)
     ).sorted.map(CppWriter.headerString)
     val usedSymbolHeaders = s.writeIncludeDirectives(d.usedSymbolSet)
     val headers = standardHeaders ++ usedSymbolHeaders
@@ -127,7 +129,7 @@ case class TlmPacketSetCppWriter(
     )
 
   private def getIncludeGuard: String = {
-    val guard = s.a.getEnclosingNames(Symbol.Topology(t.aNode)) match {
+    val guard = s.a.getEnclosingNames(topologySymbol) match {
       case Nil => namespaceName
       case names =>
         val qualifier = CppWriterState.identFromQualifiedName(
@@ -139,7 +141,7 @@ case class TlmPacketSetCppWriter(
   }
 
   private def getMembers: List[CppDoc.Member] = {
-    val nsil = s.getNamespaceIdentList(Symbol.Topology(t.aNode)) :+
+    val nsil = s.getNamespaceIdentList(topologySymbol) :+
       namespaceName
     val members = getHppMembers ++ getCppMembers
     getHppIncludesMember :: getCppIncludesMember ::