Fixes #1708 by Completing the work In Fw (#3173)

* Making string formatting into a fprime implementation choice

* Removing printf from Fw and cleaning-up toString methods

* Fixes to get UTs to compile

* Reverting test change to assert

* Removing error console and restoring assert functionality

* Create empty library to avoid 3.16 limitations on interface libs

* Turning off unused check on intentionally unused variable

* sp

* Fixing recursive calls and other CI problems

* Fixing compile issues

Author: LeStarch

Fw/Buffer/Buffer.hpp

@@ -16,7 +16,6 @@
 #include <Fw/Types/Serializable.hpp>
 #if FW_SERIALIZABLE_TO_STRING
     #include <Fw/Types/StringType.hpp>
-    #include <cstdio> // snprintf
     #ifdef BUILD_UT
         #include <iostream>
         #include <Fw/Types/String.hpp>

Fw/Comp/ActiveComponentBase.cpp

@@ -2,7 +2,6 @@
 #include <Fw/Comp/ActiveComponentBase.hpp>
 #include <Fw/Types/Assert.hpp>
 #include <Os/TaskString.hpp>
-#include <cstdio>
 
 namespace Fw {
 
@@ -38,14 +37,9 @@ namespace Fw {
         QueuedComponentBase::init(instance);
     }
 
-#if FW_OBJECT_TO_STRING == 1 && FW_OBJECT_NAMES == 1
-    void ActiveComponentBase::toString(char* buffer, NATIVE_INT_TYPE size) {
-        FW_ASSERT(size > 0);
-        FW_ASSERT(buffer != nullptr);
-        PlatformIntType status = snprintf(buffer, static_cast<size_t>(size), "ActComp: %s", this->m_objName.toChar());
-        if (status < 0) {
-            buffer[0] = 0;
-        }
+#if FW_OBJECT_TO_STRING == 1
+    const char* ActiveComponentBase::getToStringFormatString() {
+            return "ActComp: %s";
     }
 #endif
 
@@ -55,9 +49,7 @@ namespace Fw {
 #if FW_OBJECT_NAMES == 1
         taskName = this->getObjName();
 #else
-        char taskNameChar[FW_TASK_NAME_BUFFER_SIZE];
-        (void)snprintf(taskNameChar,sizeof(taskNameChar),"ActComp_%" PRI_FwSizeType,Os::Task::getNumTasks());
-        taskName = taskNameChar;
+        (void) taskName.format("ActComp_%" PRI_FwSizeType, Os::Task::getNumTasks());
 #endif
         // Cooperative threads tasks externalize the task loop, and as such use the state machine as their task function
         // Standard multithreading tasks use the task loop to respectively call the state machine

Fw/Comp/ActiveComponentBase.hpp

@@ -50,7 +50,7 @@ class ActiveComponentBase : public QueuedComponentBase {
     Os::Task m_task;           //!< task object for active component
 
 #if FW_OBJECT_TO_STRING == 1
-    virtual void toString(char* str, NATIVE_INT_TYPE size);  //!< create string description of component
+    virtual const char* getToStringFormatString(); //!< Format string for toString function
 #endif
   PRIVATE:
     Lifecycle m_stage;         //!< Lifecycle stage of the component

Fw/Comp/PassiveComponentBase.cpp

@@ -2,19 +2,30 @@
 #include <Fw/Types/Assert.hpp>
 #include <FpConfig.hpp>
 
-#include <cstdio>
+#include <Fw/Types/ExternalString.hpp>
 
 namespace Fw {
 
     PassiveComponentBase::PassiveComponentBase(const char* name) : Fw::ObjBase(name), m_idBase(0), m_instance(0) {
     }
 
-#if FW_OBJECT_TO_STRING == 1 && FW_OBJECT_NAMES == 1
+#if FW_OBJECT_TO_STRING == 1
+    const char* PassiveComponentBase::getToStringFormatString() {
+        return "Comp: %s";
+    }
+
     void PassiveComponentBase::toString(char* buffer, NATIVE_INT_TYPE size) {
         FW_ASSERT(size > 0);
         FW_ASSERT(buffer != nullptr);
-        PlatformIntType status = snprintf(buffer, static_cast<size_t>(size), "Comp: %s", this->m_objName.toChar());
-        if (status < 0) {
+        Fw::FormatStatus status = Fw::ExternalString(buffer, static_cast<Fw::ExternalString::SizeType>(size)).format(
+            this->getToStringFormatString(),
+#if FW_OBJECT_NAMES == 1
+            this->m_objName.toChar()
+#else
+            "UNKNOWN"
+#endif
+        );
+        if (status != Fw::FormatStatus::SUCCESS) {
             buffer[0] = 0;
         }
     }

Fw/Comp/PassiveComponentBase.hpp

@@ -22,8 +22,11 @@ namespace Fw {
             virtual ~PassiveComponentBase(); //!< Destructor
             void init(NATIVE_INT_TYPE instance); //!< Initialization function
             NATIVE_INT_TYPE getInstance() const;
+
+
 #if FW_OBJECT_TO_STRING == 1
-            virtual void toString(char* str, NATIVE_INT_TYPE size); //!< returns string description of component
+            virtual const char* getToStringFormatString(); //!< Return the format  for a generic component toString
+            void toString(char* str, NATIVE_INT_TYPE size) override; //!< returns string description of component
 #endif
         PRIVATE:
             U32 m_idBase; //!< ID base for opcodes etc.

Fw/Comp/QueuedComponentBase.cpp

@@ -19,14 +19,9 @@ namespace Fw {
         PassiveComponentBase::init(instance);
     }
 
-#if FW_OBJECT_TO_STRING == 1 && FW_OBJECT_NAMES == 1
-    void QueuedComponentBase::toString(char* buffer, NATIVE_INT_TYPE size) {
-        FW_ASSERT(size > 0);
-        FW_ASSERT(buffer != nullptr);
-        PlatformIntType status = snprintf(buffer, static_cast<size_t>(size), "QueueComp: %s", this->m_objName.toChar());
-        if (status < 0) {
-            buffer[0] = 0;
-        }
+#if FW_OBJECT_TO_STRING == 1
+    const char* QueuedComponentBase::getToStringFormatString() {
+        return "QueueComp: %s";
     }
 #endif
 
@@ -36,9 +31,7 @@ namespace Fw {
 #if FW_OBJECT_NAMES == 1
         queueName = this->m_objName;
 #else
-        char queueNameChar[FW_QUEUE_NAME_BUFFER_SIZE];
-        (void)snprintf(queueNameChar,sizeof(queueNameChar),"CompQ_%" PRI_FwSizeType,Os::Queue::getNumQueues());
-        queueName = queueNameChar;
+        queueName.format("CompQ_%" PRI_FwSizeType,Os::Queue::getNumQueues());
 #endif
     	return this->m_queue.create(queueName, depth, msgSize);
     }

Fw/Comp/QueuedComponentBase.hpp

@@ -37,7 +37,7 @@ namespace Fw {
             Os::Queue::Status createQueue(FwSizeType depth, FwSizeType msgSize);
             virtual MsgDispatchStatus doDispatch()=0; //!< method to dispatch a single message in the queue.
 #if FW_OBJECT_TO_STRING == 1
-            virtual void toString(char* str, NATIVE_INT_TYPE size); //!< dump string representation of component
+            virtual const char* getToStringFormatString(); //!< Format string for toString function
 #endif
             NATIVE_INT_TYPE getNumMsgsDropped(); //!< return number of messages dropped
             void incNumMsgDropped(); //!< increment the number of messages dropped

Fw/Obj/ObjBase.cpp

@@ -1,8 +1,7 @@
 #include <FpConfig.hpp>
 #include <Fw/Obj/ObjBase.hpp>
-#include <cstring>
-#include <cstdio>
 #include <Fw/Types/Assert.hpp>
+#include <Fw/Types/ExternalString.hpp>
 
 namespace Fw {
 
@@ -48,8 +47,8 @@ namespace Fw {
     void ObjBase::toString(char* str, NATIVE_INT_TYPE size) {
         FW_ASSERT(size > 0);
         FW_ASSERT(str != nullptr);
-        PlatformIntType status = snprintf(str, static_cast<size_t>(size), "Obj: %s", this->m_objName.toChar());
-        if (status < 0) {
+        Fw::FormatStatus formatStatus = Fw::ExternalString(str, static_cast<Fw::ExternalString::SizeType>(size)).format("Obj: %s", this->m_objName.toChar());
+        if (formatStatus != Fw::FormatStatus::SUCCESS) {
             str[0] = 0;
         }
     }

Fw/Port/InputPortBase.cpp

@@ -26,18 +26,8 @@ namespace Fw {
     }
 
 #if FW_OBJECT_TO_STRING == 1
-    void InputPortBase::toString(char* buffer, NATIVE_INT_TYPE size) {
-#if FW_OBJECT_NAMES == 1
-        FW_ASSERT(size > 0);
-        FW_ASSERT(buffer != nullptr);
-        PlatformIntType status = snprintf(buffer, static_cast<size_t>(size), "InputPort: %s->%s", this->m_objName.toChar(),
-                                        this->isConnected() ? this->m_connObj->getObjName() : "None");
-        if (status < 0) {
-            buffer[0] = 0;
-        }
-#else
-        (void)snprintf(buffer,size,"%s","Unnamed Input port");
-#endif
+    const char* InputPortBase::getToStringFormatString() {
+        return "Input Port: %s %s->(%s)";
     }
 #endif
 

Fw/Port/InputPortBase.hpp

@@ -21,12 +21,12 @@ namespace Fw {
 
             InputPortBase(); // Constructor
             virtual ~InputPortBase(); // Destructor
-            virtual void init();
+            void init() override;
 
             PassiveComponentBase* m_comp; // !< pointer to containing component
             NATIVE_INT_TYPE m_portNum; // !< port number in containing object
 #if FW_OBJECT_TO_STRING == 1
-            virtual void toString(char* str, NATIVE_INT_TYPE size);
+            const char* getToStringFormatString() override; //!< Get format string for toString call
 #endif
 
         private: