OCCT

// Copyright (c) 2020 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_PrinterToReport_HeaderFile
#define _Message_PrinterToReport_HeaderFile

#include <Message_Printer.hxx>
#include <TCollection_AsciiString.hxx>

class Message_Report;

//! Implementation of a message printer associated with Message_Report
//! Send will create a new alert of the report. If string is sent, an alert is created by Eol only.
//! The alerts are sent into set report or default report of Message.
class Message_PrinterToReport : public Message_Printer
{
  DEFINE_STANDARD_RTTIEXT(Message_PrinterToReport, Message_Printer)
public:
  //! Create printer for redirecting messages into report.
  Message_PrinterToReport() = default;

  //! Destructor
  ~Message_PrinterToReport() override = default;

  //! Returns the current or default report
  Standard_EXPORT const occ::handle<Message_Report>& Report() const;

  //! Sets the printer report
  //! @param theReport report for messages processing, if NULL, the default report is used
  void SetReport(const occ::handle<Message_Report>& theReport) { myReport = theReport; }

  //! Send a string message with specified trace level.
  //! Stream is converted to string value.
  //! Default implementation calls first method Send().
  Standard_EXPORT void SendStringStream(const Standard_SStream& theStream,
                                        const Message_Gravity   theGravity) const override;

  //! Send a string message with specified trace level.
  //! The object is converted to string in format: <object kind> : <object pointer>.
  //! The parameter theToPutEol specified whether end-of-line should be added to the end of the
  //! message. Default implementation calls first method Send().
  Standard_EXPORT void SendObject(const occ::handle<Standard_Transient>& theObject,
                                  const Message_Gravity                  theGravity) const override;

protected:
  //! Send a string message with specified trace level.
  //! This method must be redefined in descendant.
  Standard_EXPORT void send(const TCollection_AsciiString& theString,
                            const Message_Gravity          theGravity) const override;

  //! Send an alert with metrics active in the current report
  Standard_EXPORT void sendMetricAlert(const TCollection_AsciiString& theValue,
                                       const Message_Gravity          theGravity) const;

private:
  mutable TCollection_AsciiString myName;
  occ::handle<Message_Report>     myReport; //!< the report for sending alerts
};

#endif // _Message_PrinterToReport_HeaderFile