0029451: Information Message Alert to debug an algorithm or object functionality

- Added possibility to send stream information and transient object into Message_Messenger. Message_Printer will process it if needed. - Add Message_PrinterToReport to send messenger information into Message_Report. - Extended Message_Report to collect hierarchical alerts, to be able to collect some metrics during alerts processing. - Added Message_AlertExtended to prepare hierarchical alerts with custom attributes. One attribute for one alert. - Added Message_CompositeAlerts class to handle a container of alerts. - Added Message_Level to start a new hierarchical level by creating an instance, stop by destricting. - Added Message_Attribute and inheritors to store custom information about alert like object, stream, shape, some metrics. - Implement Message_AttributeAlert to collect start/stop information about active metrics of Message_Report. This kind of attribute is created if at least one metric is active in the report. - Add Message_MetricType enumeration with possible kinds of metrics in report. - Implement DumpJson for Message_Report to store all collected alerts into stream. - Added draw commands for Message_Report, Message_Messenger.
2025-08-09 13:22:24 +03:00 · 2020-10-02 14:17:59 +03:00
parent dba9887351
commit 6522304c17
37 changed files with 2734 additions and 81 deletions
--- a/src/Message/Message_Level.cxx
+++ b/src/Message/Message_Level.cxx
@@ -0,0 +1,110 @@
+// Copyright (c) 2019 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.
+
+#include <Message_Level.hxx>
+
+#include <Message.hxx>
+#include <Message_AlertExtended.hxx>
+#include <Message_CompositeAlerts.hxx>
+#include <Message_AttributeMeter.hxx>
+#include <Message_Messenger.hxx>
+#include <Message_Report.hxx>
+
+#include <OSD_Chronometer.hxx>
+#include <OSD_MemInfo.hxx>
+
+//=======================================================================
+//function : Constructor
+//purpose  :
+//=======================================================================
+Message_Level::Message_Level (const TCollection_AsciiString& theName)
+{
+  const Handle(Message_Report)& aDefaultReport = Message::DefaultReport();
+  if (!aDefaultReport.IsNull() && aDefaultReport->IsActiveInMessenger())
+  {
+    aDefaultReport->AddLevel (this, theName);
+  }
+}
+
+//=======================================================================
+//function : Destructor
+//purpose  :
+//=======================================================================
+Message_Level::~Message_Level()
+{
+  remove();
+}
+
+//=======================================================================
+//function : SetRootAlert
+//purpose  :
+//=======================================================================
+void Message_Level::SetRootAlert (const Handle(Message_AlertExtended)& theAlert,
+                                  const Standard_Boolean isRequiredToStart)
+{
+  myRootAlert = theAlert;
+  if (isRequiredToStart)
+  {
+    Message_AttributeMeter::StartAlert (myRootAlert);
+  }
+}
+
+//=======================================================================
+//function : AddAlert
+//purpose  :
+//=======================================================================
+Standard_Boolean Message_Level::AddAlert (const Message_Gravity theGravity,
+                                          const Handle(Message_Alert)& theAlert)
+{
+  Handle(Message_AlertExtended) anAlertExtended = Handle(Message_AlertExtended)::DownCast (theAlert);
+  if (anAlertExtended.IsNull())
+  {
+    return Standard_False;
+  }
+
+  // looking for the parent of the parameter alert to release the previous alert
+  Handle(Message_AlertExtended) aRootAlert = myRootAlert;
+  Handle(Message_CompositeAlerts) aCompositeAlert = aRootAlert->CompositeAlerts (Standard_True);
+
+  // update metrics of the previous alert
+  Message_AttributeMeter::StopAlert (myLastAlert);
+
+  myLastAlert = anAlertExtended;
+  // set start metrics of the new alert
+  Message_AttributeMeter::StartAlert (myLastAlert);
+
+  // add child alert
+  aCompositeAlert->AddAlert (theGravity, theAlert);
+
+  return Standard_True;
+}
+
+//=======================================================================
+//function : remove
+//purpose  :
+//=======================================================================
+void Message_Level::remove()
+{
+  const Handle(Message_Report)& aDefaultReport = Message::DefaultReport();
+  if (aDefaultReport.IsNull() || !aDefaultReport->IsActiveInMessenger())
+  {
+    return;
+  }
+
+  Message_AttributeMeter::StopAlert (myLastAlert);
+
+  if (!Message::DefaultReport().IsNull())
+  {
+    Message::DefaultReport()->RemoveLevel (this);
+  }
+}