Skip to content

Rework struct toString() #733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 6, 2025
Merged

Rework struct toString() #733

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
07aa0e3
Rework struct toString()
Kronos3 Jun 5, 2025
71203e6
Clean up the init code
Kronos3 Jun 5, 2025
b7594eb
Clean up spaces in formatted string
Kronos3 Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 73 additions & 84 deletions compiler/lib/src/main/scala/codegen/CppWriter/StructCppWriter.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,68 +354,79 @@ case class StructCppWriter(

private def getFunctionMembers: List[CppDoc.Class.Member] = {
// Members on which to call toString()
val toStringMemberNames =
val needsTmpString =
astMembers.map((_, node, _) => {
val t = typeMembers(node.data.name)
(node, node.data.name, typeCppWriter.write(t))
}).filter((n, _, tn) => (sizes.contains(n.data.name), typeMembers(n.data.name).getUnderlyingType) match {
}).find((n, _, tn) => (sizes.contains(n.data.name), typeMembers(n.data.name).getUnderlyingType) match {
// Only plain string types don't need a tmp string form appending to the struct
case (false, _: Type.String) => false
case (false, t) if s.isPrimitive(t, tn) => false
case _ => true
})
// String initialization for arrays and serializable member types in toString()
val initStrings = toStringMemberNames match {
case Nil => Nil
case names =>
List(
Line.blank ::
lines("// Declare strings to hold any serializable toString() arguments"),
names.flatMap((_, n, _) => lines(s"Fw::String ${n}Str;")),
Line.blank ::
lines("// Call toString for arrays and serializable types"),
names.flatMap((node, n, tn) => {
val formatStr = FormatCppWriter.write(
s,
getFormatStr(n),
node.data.typeName
)
}).isDefined

val getMemberToString = (node: AstNode[Ast.StructTypeMember], n: String, tn: String) => {
(sizes.contains(node.data.name), typeMembers(node.data.name).getUnderlyingType) match {
case (false, _: Type.String) =>
// Type is already a string, no need to perform any conversion
lines(s"sb += this->m_$n;")
case (false, t) if s.isPrimitive(t, tn) =>
// Format the primitive into a temporary string buffer
val formatStr = FormatCppWriter.write(
s,
getFormatStr(name),
node.data.typeName
)
lines(s"""|tmp.format("$formatStr", ${promoteF32ToF64 (t) (s"this->m_$n")});
|sb += tmp;""")
case (true, _) =>
// An array member
// Iterate through each member and format it into 'tmp'
// Append 'tmp' to the final string
val formatStr = FormatCppWriter.write(
s,
getFormatStr(name),
node.data.typeName
)

(sizes.contains(n), typeMembers(n).getUnderlyingType) match {
case (true, _: Type.String) =>
case (true, t) if s.isPrimitive(t, tn) =>
case (true, _) =>
case _ => lines(s"this->m_$n.toString(${n}Str);")
}
val fillTmpString = (typeMembers(n).getUnderlyingType) match {
case (_: Type.String) =>
s"tmp = this->m_$n[i];"
case t if s.isPrimitive(t, tn) =>
s"""tmp.format("$formatStr", ${promoteF32ToF64 (t) (s"this->m_$n[i]")});"""
case _ =>
s"this->m_$n[i].toString(tmp);"
}

// Loop through and format each element if this is an array
if (sizes.contains(n)) {
val fillTmpString = (typeMembers(n).getUnderlyingType) match {
case (_: Type.String) =>
s"${n}Tmp = this->m_$n[i];"
case t if s.isPrimitive(t, tn) =>
s"""${n}Tmp.format("$formatStr", ${promoteF32ToF64 (t) (s"this->m_$n[i]")});"""
case _ =>
s"this->m_$n[i].toString(${n}Tmp);"
}

iterateN(sizes(n), lines(
s"""|Fw::String ${n}Tmp;
|${fillTmpString}
|
|FwSizeType size = ${n}Tmp.length() + (i > 0 ? 2 : 0);
|if ((size + ${n}Str.length()) <= ${n}Str.maxLength()) {
| if (i > 0) {
| ${n}Str += ", ";
| }
| ${n}Str += ${n}Tmp;
|} else {
| break;
|}"""))
} else lines(s"this->m_$n.toString(${n}Str);")
}),
).flatten
List.concat(
lines("sb += \"[ \";"),
iterateN(sizes(n), lines(
s"""|${fillTmpString}
|if (i > 0) {
| sb += ", ";
|}
|sb += tmp;"""
)),
lines("sb += \"] \";"),
)
case (false, _) =>
// A complex (non-array) type
lines(s"""|this->m_$n.toString(tmp);
|sb += tmp;""")
}
}

// toString() append formatted member to string
val memberToString =
astMembers.map((_, node, _) => {
val t = typeMembers(node.data.name)
(node, node.data.name, typeCppWriter.write(t))
}).map((node, n, tn) => List.concat(
lines(s"""|
|// Format $n
|sb += "$n = ";"""),
getMemberToString(node, n, tn),
))

def writeSerializeStatusCheck =
wrapInIf(
"status != Fw::FW_SERIALIZE_OK",
Expand Down Expand Up @@ -497,37 +508,15 @@ case class StructCppWriter(
),
CppDoc.Type("void"),
List.concat(
lines("static const char* formatString ="),
lines(astMembers.flatMap((_, node, _) => {
val n = node.data.name
val formatStr = FormatCppWriter.write(
s,
getFormatStr(n),
node.data.typeName
)
if sizes.contains(n) then {
List(s"$n = [ %s ]")
} else
List(s"$n = $formatStr")
}).mkString("\"( \"\n\"", ", \"\n\"", "\"\n\" )\";")).map(indentIn),
initStrings,
Line.blank ::
wrapInScope(
"sb.format(",
{
line("formatString,") ::
lines(memberList.flatMap((n, tn) =>
(sizes.contains(n), typeMembers(n).getUnderlyingType) match {
case (false, _: Type.String) =>
List(s"this->m_$n.toChar()")
case (false, t) if s.isPrimitive(t, tn) =>
List(promoteF32ToF64 (t) (s"this->m_$n"))
case _ =>
List(s"${n}Str.toChar()")
}).mkString(",\n"))
},
");"
)
if needsTmpString then lines("Fw::String tmp;") else List(),
lines("sb = \"( \";"),
memberToString.zipWithIndex.flatMap((memberToStringLines, idx) => {
if idx > 0 then List.concat(
lines("sb += \", \";"),
memberToStringLines,
) else memberToStringLines
}),
lines("sb += \" )\";"),
),
CppDoc.Function.NonSV,
CppDoc.Function.Const
Expand Down
23 changes: 8 additions & 15 deletions compiler/tools/fpp-to-cpp/test/alias/AbsSerializableAc.ref.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,21 +108,14 @@ Fw::SerializeStatus Abs ::
void Abs ::
toString(Fw::StringBase& sb) const
{
static const char* formatString =
"( "
"A = %s"
" )";

// Declare strings to hold any serializable toString() arguments
Fw::String AStr;

// Call toString for arrays and serializable types
this->m_A.toString(AStr);

sb.format(
formatString,
AStr.toChar()
);
Fw::String tmp;
sb = "( ";

// Format A
sb += "A = ";
this->m_A.toString(tmp);
sb += tmp;
sb += " )";
}

#endif
Expand Down
39 changes: 24 additions & 15 deletions compiler/tools/fpp-to-cpp/test/alias/BasicSerializableAc.ref.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,21 +152,30 @@ Fw::SerializeStatus Basic ::
void Basic ::
toString(Fw::StringBase& sb) const
{
static const char* formatString =
"( "
"A = %" PRIu32 ", "
"B = %f, "
"C = %s, "
"D = %s"
" )";

sb.format(
formatString,
this->m_A,
static_cast<F64>(this->m_B),
this->m_C.toChar(),
this->m_D.toChar()
);
Fw::String tmp;
sb = "( ";

// Format A
sb += "A = ";
tmp.format("%" PRIu32 "", this->m_A);
sb += tmp;
sb += ", ";

// Format B
sb += "B = ";
tmp.format("%f", static_cast<F64>(this->m_B));
sb += tmp;
sb += ", ";

// Format C
sb += "C = ";
sb += this->m_C;
sb += ", ";

// Format D
sb += "D = ";
sb += this->m_D;
sb += " )";
}

#endif
Expand Down
41 changes: 26 additions & 15 deletions compiler/tools/fpp-to-cpp/test/alias/NamespaceSerializableAc.ref.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,21 +152,32 @@ Fw::SerializeStatus Namespace ::
void Namespace ::
toString(Fw::StringBase& sb) const
{
static const char* formatString =
"( "
"A = %" PRIu32 ", "
"B = %" PRIu32 ", "
"C = %" PRIu32 ", "
"D = %" PRIu32 ""
" )";

sb.format(
formatString,
this->m_A,
this->m_B,
this->m_C,
this->m_D
);
Fw::String tmp;
sb = "( ";

// Format A
sb += "A = ";
tmp.format("%" PRIu32 "", this->m_A);
sb += tmp;
sb += ", ";

// Format B
sb += "B = ";
tmp.format("%" PRIu32 "", this->m_B);
sb += tmp;
sb += ", ";

// Format C
sb += "C = ";
tmp.format("%" PRIu32 "", this->m_C);
sb += tmp;
sb += ", ";

// Format D
sb += "D = ";
tmp.format("%" PRIu32 "", this->m_D);
sb += tmp;
sb += " )";
}

#endif
Expand Down
Loading