Code/CryEngine/CrySchematyc2/Services/Log.h

   1 // Copyright 2001-2019 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 #pragma once
   4
   5 #include <CrySchematyc2/Env/IEnvRegistry.h>
   6 #include <CrySchematyc2/Services/ILog.h>
   7 #include <CrySchematyc2/TemplateUtils/TemplateUtils_ScopedConnection.h>
   8
   9 namespace Schematyc2
  10 {
  11         struct ILogOutput;
  12
  13         DECLARE_SHARED_POINTERS(ILogOutput)
  14
  15         class CLog : public ILog
  16         {
  17         public:
  18
  19                 CLog();
  20
  21                 void Init();
  22
  23                 // ILog
  24                 virtual ELogMessageType GetMessageType(const char* szMessageType) override;
  25                 virtual const char* GetMessageTypeName(ELogMessageType messageType) override;
  26                 virtual LogStreamId CreateStream(const char* szName, const LogStreamId& staticStreamId = LogStreamId::s_invalid) override;
  27                 virtual void DestroyStream(const LogStreamId& streamId) override;
  28                 virtual LogStreamId GetStreamId(const char* szName) const override;
  29                 virtual const char* GetStreamName(const LogStreamId& streamId) const override;
  30                 virtual void VisitStreams(const LogStreamVisitor& visitor) const override;
  31                 virtual ILogOutputPtr CreateFileOutput(const char* szFileName) override;
  32                 virtual void Comment(const LogStreamId& streamId, CLogMessageMetaInfo metaInfo, const char* szFormat, ...) override;
  33                 virtual void Warning(const LogStreamId& streamId, CLogMessageMetaInfo metaInfo, const char* szFormat, ...) override;
  34                 virtual void Error(const LogStreamId& streamId, CLogMessageMetaInfo metaInfo, const char* szFormat, ...) override;
  35                 virtual ECriticalErrorStatus CriticalError(const LogStreamId& streamId, CLogMessageMetaInfo metaInfo, const char* szFormat, ...) override;
  36                 virtual void FatalError(const LogStreamId& streamId, CLogMessageMetaInfo metaInfo, const char* szFormat, ...) override;
  37                 virtual void Update() override;
  38                 virtual SLogSignals& Signals() override;
  39                 virtual bool IsLoggingEnabled() const override;
  40                 // ~ILog
  41
  42         private:
  43
  44                 struct SStream
  45                 {
  46                         SStream(const char* _szName, const LogStreamId& _id);
  47
  48                         string      name;
  49                         LogStreamId id;
  50                 };
  51
  52                 typedef std::vector<SStream>              Streams;
  53                 typedef std::vector<ILogOutputPtr>        Outputs;
  54                 typedef std::vector<string>               UserStreams;
  55                 typedef TemplateUtils::CDelegate<void ()> SettingsModifiedCallback;
  56
  57                 struct SSettings : public IEnvSettings
  58                 {
  59                         SSettings(const SettingsModifiedCallback& _modifiedCallback);
  60
  61                         // IEnvSettings
  62                         virtual void Serialize(Serialization::IArchive& archive) override;
  63                         // ~IEnvSettings
  64
  65                         UserStreams              userStreams;
  66                         SettingsModifiedCallback modifiedCallback;
  67                 };
  68
  69                 DECLARE_SHARED_POINTERS(SSettings)
  70
  71                 static const LogStreamId FIRST_DYNAMIC_STREAM_ID;
  72
  73                 void OnSettingsModified();
  74                 size_t FindStream(const char* szName) const;
  75                 size_t FindStream(const LogStreamId& streamId) const;
  76                 void GetUserStreamsFileName(stack_string& fileName) const;
  77
  78                 LogStreamId  m_nextDynamicStreamId;
  79                 Streams      m_streams;
  80                 Outputs      m_outputs;
  81                 SSettingsPtr m_pSettings;
  82                 SLogSignals  m_signals;
  83         };
  84
  85         class CLogRecorder : public ILogRecorder
  86         {
  87         public:
  88
  89                 ~CLogRecorder();
  90
  91                 // ILogRecorder
  92                 virtual void Begin() override;
  93                 virtual void End() override;
  94                 virtual void VisitMessages(const LogMessageVisitor& visitor) override;
  95                 virtual void Clear() override;
  96                 // ~ILogRecorder
  97
  98         private:
  99
 100                 // #SchematycTODO : This method of storing messages is far from optimal. If we start recording lots of messages we should think about creating pages of raw data.
 101                 struct SRecordedMessage
 102                 {
 103                         explicit SRecordedMessage(const SLogMessageData& _logMessageData);
 104
 105                         LogStreamId         streamId;
 106                         ELogMessageType     messageType;
 107                         string              message;
 108                         CLogMessageMetaInfo metaInfo;
 109                 };
 110
 111                 typedef std::vector<SRecordedMessage> SRecordedMessageVector;
 112
 113                 void OnLogMessage(const SLogMessageData& logMessageData);
 114
 115                 SRecordedMessageVector          m_recordedMessages;
 116                 TemplateUtils::CConnectionScope m_connectionScope;
 117         };
 118 }