WsfConsole.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2020 Infoscitex, a DCS Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSF_CONSOLE_HPP
#define WSF_CONSOLE_HPP
 
#include "wsf_export.h"
 
#include <fstream>
#include <list>
#include <map>
 
#include "UtInput.hpp"
#include "UtLogSubscriber.hpp"
#include "UtOptional.hpp"
#include "WsfScenarioExtension.hpp"
#include "WsfSimulationExtension.hpp"
 
namespace wsf
{
namespace console
{
struct OutputSettings
{
   OutputSettings();

   ut::log::TypeList mTypes;

   bool mSingleLine = false;

   bool mForceFlushing = true;
};

class WSF_EXPORT SubscriberBase : public ut::log::SubscriberBase
{
public:
   explicit SubscriberBase(const OutputSettings& aSettings) noexcept;

   void UpdateSettings(const OutputSettings& aSettings);
   OutputSettings GetSettings() const noexcept;
 
private:
   bool AddMessageP(const ut::log::Message& aMessage) noexcept final;

   bool WriteSingleLine(const ut::log::Message& aMessage, std::ostream& aStream, int aDepth = 0) const noexcept;

   virtual std::ostream& GetStream() = 0;
   virtual void FlushStream(bool aFlush) = 0;
 
   bool mSingleLine    = false;
   bool mForceFlushing = true;
};

class WSF_EXPORT ConsoleSubscriber final : public SubscriberBase
{
public:
   explicit ConsoleSubscriber(const OutputSettings& aSettings) noexcept;
 
   ~ConsoleSubscriber() noexcept override;
 
private:
   std::ostream& GetStream() override { return mStream; }
   void FlushStream(bool aFlush) override;
 
   std::ostringstream mStream;
   ut::log::TypeList mPreviousConsoleSubscriptions;
};

class WSF_EXPORT FileSubscriber final : public SubscriberBase
{
public:
   using SubscriberBase::SubscriberBase;
 
   ~FileSubscriber() noexcept override;

   void OpenFile(const std::string& aFileName);
 
private:
   std::ostream& GetStream() override { return mStream; }
   void FlushStream(bool aFlush) override;
 
   std::string   mFileName;
   std::ofstream mStream;
};

class WSF_EXPORT ScenarioExtension final : public WsfScenarioExtension
{
public:
   ScenarioExtension() = default;
 
   ScenarioExtension(const ScenarioExtension&) = delete;
   ScenarioExtension& operator=(const ScenarioExtension&) = delete;
 
   bool ProcessInput(UtInput& aInput) override;
   void SimulationCreated(WsfSimulation& aSimulation) override;
   bool Complete() override;
 
private:
   void        ProcessInputFile(UtInput& aInput);
   static void ProcessInputSettings(UtInput& aInput, OutputSettings& aSettings);
   static void ProcessInputType(UtInput& aInput, ut::log::TypeList& aTypes);
 
   OutputSettings                        mConsoleSettings;
   std::map<std::string, OutputSettings> mFileSettings;

   ut::optional<ConsoleSubscriber> mConsoleSubscriber;
   std::list<FileSubscriber>       mFileSubscribers;
};
} // namespace console
} // namespace wsf
 
#endif