Console.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/Console.hpp
// \brief common function definitions for Os::Console
// ======================================================================
#ifndef Os_Console_hpp_
#define Os_Console_hpp_

#include <FpConfig.hpp>
#include <Fw/Logger/Logger.hpp>
#include <Os/Console.hpp>
#include <Os/Os.hpp>

namespace Os {
    struct ConsoleHandle {
    };

    // \brief Interface defining the properties of the console
    class ConsoleInterface {
      public:
        ConsoleInterface() = default;

        virtual ~ConsoleInterface() = default;

        virtual void writeMessage(const CHAR *message, const FwSizeType size) = 0;

        virtual ConsoleHandle *getHandle() = 0;

        static ConsoleInterface* getDelegate(ConsoleHandleStorage& aligned_placement_new_memory, const ConsoleInterface* to_copy=nullptr);
    };

    class Console : public ConsoleInterface, public Fw::Logger {
      public:
        Console();

        ~Console();

        Console(const Console& other);

        Console& operator=(const Console& other);

        void writeMessage(const CHAR *message, const FwSizeType size) override;

        void writeMessage(const Fw::StringBase& message) override;

        ConsoleHandle *getHandle() override;

        static void write(const Fw::StringBase& message);

        static void write(const CHAR *message, const FwSizeType size);

        static void init();

        static Console& getSingleton();

      private:
        // This section is used to store the implementation-defined console handle. To Os::Console and fprime, this type
        // is opaque and thus normal allocation cannot be done. Instead, we allow the implementor to store then handle
        // in the byte-array here and set `handle` to that address for storage.
        alignas(FW_HANDLE_ALIGNMENT) ConsoleHandleStorage m_handle_storage; // Storage for the delegate
        ConsoleInterface &m_delegate; 
    };
}

#endif