OCCT

// Created on: 2017-06-26
// Created by: Andrey Betenev
// Copyright (c) 2017 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Message_Report_HeaderFile
#define _Message_Report_HeaderFile

#include <Message_Level.hxx>
#include <Message_Alert.hxx>
#include <NCollection_List.hxx>
#include <Message_MetricType.hxx>
#include <NCollection_IndexedMap.hxx>
#include <NCollection_Sequence.hxx>

#include <mutex>

class Message_CompositeAlerts;
class Message_Messenger;

//! Container for alert messages, sorted according to their gravity.
//!
//! For each gravity level, alerts are stored in simple list.
//! If alert being added can be merged with another alert of the same
//! type already in the list, it is merged and not added to the list.
//!
//! This class is intended to be used as follows:
//!
//! - In the process of execution, algorithm fills report by alert objects
//!   using methods AddAlert()
//!
//! - The result can be queried for presence of particular alert using
//!   methods HasAlert()
//!
//! - The reports produced by nested or sequentially executed algorithms
//!   can be collected in one using method Merge()
//!
//! - The report can be shown to the user either as plain text with method
//!   Dump() or in more advanced way, by iterating over lists returned by GetAlerts()
//!
//! - Report can be cleared by methods Clear() (usually after reporting)
//!
//! Message_PrinterToReport is a printer in Messenger to convert data sent to messenger into report
class Message_Report : public Standard_Transient
{
public:
  //! Empty constructor
  Standard_EXPORT Message_Report();

  //! Add alert with specified gravity.
  //! This method is thread-safe, i.e. alerts can be added from parallel threads safely.
  Standard_EXPORT void AddAlert(Message_Gravity                   theGravity,
                                const occ::handle<Message_Alert>& theAlert);

  //! Returns list of collected alerts with specified gravity
  Standard_EXPORT const NCollection_List<occ::handle<Message_Alert>>& GetAlerts(
    Message_Gravity theGravity) const;

  //! Returns true if specific type of alert is recorded
  Standard_EXPORT bool HasAlert(const occ::handle<Standard_Type>& theType);

  //! Returns true if specific type of alert is recorded with specified gravity
  Standard_EXPORT bool HasAlert(const occ::handle<Standard_Type>& theType,
                                Message_Gravity                   theGravity);

  //! Returns true if a report printer for the current report is registered in the messenger
  //! @param theMessenger the messenger. If it's NULL, the default messenger is used
  Standard_EXPORT bool IsActiveInMessenger(
    const occ::handle<Message_Messenger>& theMessenger = nullptr) const;

  //! Creates an instance of Message_PrinterToReport with the current report and register it in
  //! messenger
  //! @param toActivate if true, activated else deactivated
  //! @param theMessenger the messenger. If it's NULL, the default messenger is used
  Standard_EXPORT void ActivateInMessenger(
    const bool                            toActivate,
    const occ::handle<Message_Messenger>& theMessenger = nullptr);

  //! Updates internal flag IsActiveInMessenger.
  //! It becomes true if messenger contains at least one instance of Message_PrinterToReport.
  //! @param theMessenger the messenger. If it's NULL, the default messenger is used
  Standard_EXPORT void UpdateActiveInMessenger(
    const occ::handle<Message_Messenger>& theMessenger = nullptr);

  //! Add new level of alerts
  //! @param theLevel a level
  Standard_EXPORT void AddLevel(Message_Level* theLevel, const TCollection_AsciiString& theName);

  //! Remove level of alerts
  Standard_EXPORT void RemoveLevel(Message_Level* theLevel);

  //! Clears all collected alerts
  Standard_EXPORT void Clear();

  //! Clears collected alerts with specified gravity
  Standard_EXPORT void Clear(Message_Gravity theGravity);

  //! Clears collected alerts with specified type
  Standard_EXPORT void Clear(const occ::handle<Standard_Type>& theType);

  //! Returns computed metrics when alerts are performed
  const NCollection_IndexedMap<Message_MetricType>& ActiveMetrics() const
  {
    return myActiveMetrics;
  }

  //! Sets metrics to compute when alerts are performed
  //! @param theMetrics container of metrics
  Standard_EXPORT void SetActiveMetric(const Message_MetricType theMetricType,
                                       const bool               theActivate);

  //! Removes all activated metrics
  void ClearMetrics() { myActiveMetrics.Clear(); }

  //! Returns maximum number of collecting alerts. If the limit is achieved,
  //! first alert is removed, the new alert is added in the container.
  //! @return the limit value
  int Limit() const { return myLimit; }

  //! Sets maximum number of collecting alerts.
  //! @param theLimit limit value
  void SetLimit(const int theLimit) { myLimit = theLimit; }

  //! Dumps all collected alerts to stream
  Standard_EXPORT void Dump(Standard_OStream& theOS);

  //! Dumps collected alerts with specified gravity to stream
  Standard_EXPORT void Dump(Standard_OStream& theOS, Message_Gravity theGravity);

  //! Sends all collected alerts to messenger.
  Standard_EXPORT virtual void SendMessages(const occ::handle<Message_Messenger>& theMessenger);

  //! Dumps collected alerts with specified gravity to messenger.
  //! Default implementation creates Message_Msg object with a message
  //! key returned by alert, and sends it in the messenger.
  Standard_EXPORT virtual void SendMessages(const occ::handle<Message_Messenger>& theMessenger,
                                            Message_Gravity                       theGravity);

  //! Merges data from theOther report into this
  Standard_EXPORT void Merge(const occ::handle<Message_Report>& theOther);

  //! Merges alerts with specified gravity from theOther report into this
  Standard_EXPORT void Merge(const occ::handle<Message_Report>& theOther,
                             Message_Gravity                    theGravity);

  //! Dumps the content of me into the stream
  Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const;

  // OCCT RTTI
  DEFINE_STANDARD_RTTIEXT(Message_Report, Standard_Transient)

protected:
  //! Returns class provided hierarchy of alerts if created or create if the parameter is true
  //! @param isCreate if composite alert has not been created for this alert, it should be created
  //! @return instance or NULL
  Standard_EXPORT const occ::handle<Message_CompositeAlerts>& compositeAlerts(
    const bool isCreate = false);

  //! Sends alerts to messenger
  Standard_EXPORT void sendMessages(const occ::handle<Message_Messenger>&       theMessenger,
                                    Message_Gravity                             theGravity,
                                    const occ::handle<Message_CompositeAlerts>& theCompositeAlert);

  //! Dumps collected alerts with specified gravity to stream
  Standard_EXPORT void dumpMessages(Standard_OStream&                           theOS,
                                    Message_Gravity                             theGravity,
                                    const occ::handle<Message_CompositeAlerts>& theCompositeAlert);

protected:
  std::mutex myMutex;

  occ::handle<Message_CompositeAlerts> myCompositAlerts; //!< container of alerts

  // clang-format off
  NCollection_Sequence<Message_Level*> myAlertLevels;   //!< container of active levels, new alerts are added below the latest level
  // clang-format on
  NCollection_IndexedMap<Message_MetricType> myActiveMetrics; //!< metrics to compute on alerts

  int  myLimit;               //!< Maximum number of collected alerts on the top level
  bool myIsActiveInMessenger; //! state whether the report is activated in messenger
};

#endif // _Message_Report_HeaderFile