Merge pull request nasa#554 from nasa/issue-553-fpp-to-xml

[fpp-to-xml] Escape special characters in comments
jwest115 · Jan 6, 2025 · 8245f4f · 8245f4f
2 parents 0530a61 + cb09cf7
commit 8245f4f
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 6 deletions.
diff --git a/compiler/lib/src/main/scala/codegen/XmlWriter/AnnotationXmlWriter.scala b/compiler/lib/src/main/scala/codegen/XmlWriter/AnnotationXmlWriter.scala
@@ -8,7 +8,7 @@ object AnnotationXmlWriter extends LineUtils {
 
   /** Write a multiline comment */
   def multilineComment[T](a: Ast.Annotated[T]): List[Line] = {
-    (a._1 ++ a._3).map(line) match {
+    (a._1 ++ a._3).map(line compose XmlTags.escaped) match {
       case Nil => Nil
       case ls => {
         val tags = XmlTags.tags("comment")
@@ -19,7 +19,7 @@ object AnnotationXmlWriter extends LineUtils {
 
   /** Write a single-line comment */
   def singleLineComment[T](a: Ast.Annotated[T]): Option[(String, String)] = {
-    val s = (a._1 ++ a._3).mkString(" ")
+    val s = (a._1 ++ a._3).map(XmlTags.escaped).mkString(" ")
     if (s.length > 0) Some(("comment", s)) else None
   }
 

diff --git a/compiler/tools/fpp-to-xml/test/array/ArraySpecialCommentArrayAi.ref.xml b/compiler/tools/fpp-to-xml/test/array/ArraySpecialCommentArrayAi.ref.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- =====================================================================
+ArraySpecialCommentArrayAi.xml
+Generated by fpp-to-xml
+====================================================================== -->
+<array name="ArraySpecialComment">
+  <comment>
+  An array with special characters in XML comments
+  &amp;&apos;&lt;&gt;&quot;
+  &amp;&apos;&lt;&gt;&quot;
+  </comment>
+  <type>U32</type>
+  <size>3</size>
+  <format>%u</format>
+  <default>
+    <value>0</value>
+    <value>0</value>
+    <value>0</value>
+  </default>
+</array>
diff --git a/compiler/tools/fpp-to-xml/test/array/array_special_comment.fpp b/compiler/tools/fpp-to-xml/test/array/array_special_comment.fpp
@@ -0,0 +1,3 @@
+@ An array with special characters in XML comments
+@ &'<>"
+array ArraySpecialComment = [3] U32 @< &'<>"
diff --git a/compiler/tools/fpp-to-xml/test/array/array_special_comment.ref.txt b/compiler/tools/fpp-to-xml/test/array/array_special_comment.ref.txt
diff --git a/compiler/tools/fpp-to-xml/test/array/run.sh b/compiler/tools/fpp-to-xml/test/array/run.sh
@@ -12,6 +12,12 @@ array_ok()
     diff_xml ArrayOK1Array ArrayOK2Array ArrayOK3Array ArrayOK4Array ArrayOK5Array
 }
 
+array_special_comment()
+{
+  run_test "-p $PWD" array_special_comment && \
+    diff_xml ArraySpecialCommentArray
+}
+
 array_struct()
 {
   run_test "-p $PWD" array_struct && \

diff --git a/compiler/tools/fpp-to-xml/test/array/tests.sh b/compiler/tools/fpp-to-xml/test/array/tests.sh
@@ -1,6 +1,7 @@
 tests="
 array_enum
 array_ok
+array_special_comment
 array_struct
 built_in_type
 array_struct_member_array

diff --git a/compiler/tools/fpp-to-xml/test/array/update-ref.sh b/compiler/tools/fpp-to-xml/test/array/update-ref.sh
@@ -13,6 +13,12 @@ array_ok()
   move_xml ArrayOK1Array ArrayOK2Array ArrayOK3Array ArrayOK4Array ArrayOK5Array
 }
 
+array_special_comment()
+{
+  update "-p $PWD" array_special_comment
+  move_xml ArraySpecialCommentArray
+}
+
 array_struct()
 {
   update "-p $PWD" array_struct
@@ -25,6 +31,7 @@ array_struct_member_array()
   update "-p $PWD" array_struct_member_array
   move_xml ArrayStructMemberArraySerializable ArrayStructMemberArrayArray
 }
+
 built_in_type()
 {
   update "-p $PWD" built_in_type

diff --git a/compiler/tools/fpp-to-xml/test/scripts/check-xml.sh b/compiler/tools/fpp-to-xml/test/scripts/check-xml.sh
@@ -3,10 +3,6 @@
 # ----------------------------------------------------------------------
 # Compile ref XML files, to check them for validity
 # ----------------------------------------------------------------------
-# 1. Compile from XML to C++
-# 2. Compile to C++ where feasible. Skip it if the F Prime dependencies
-#    are too complicated.
-# ----------------------------------------------------------------------
 
 pwd=$PWD