MantisBT
Mantis Bug Tracker Workflow

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0030697Open CASCADE[OCCT] OCCT:DRAWpublic2019-05-06 23:092019-11-14 17:54
Reporterkgv 
Assigned Toosa 
PrioritynormalSeverityminor 
StatusresolvedResolutionopen 
PlatformOSOS Version
Product Version[OCCT] 6.8.0 
Target Version[OCCT] 7.5.0*Fixed in Version 
Summary0030697: Draw Harness - Draw_Printer should not be set to Message::DefaultMessenger() by default
DescriptionCurrently Draw Harness removes std::cout printer from Message::DefaultMessenger() and appends Draw_Printer instead. Draw_Printer redirects output to Tcl command result, which results in the following issues:
- DefaultMessenger() is a global callback which can be used by any OCCT code, not exactly designed for Tcl output of particular command. This might include errors, failures and warnings, so that command output might become unexpectedly broken. Example - vreadpixel command which uses a workaround clearing Tcl output to avoid breaking tests (as result, messages from TKOpenGl are discarded and might remain unnoticed).
- Feeding Tcl interpreter is not thread safe, while DefaultMessenger() can be used for emitting messages from working threads resulting in Draw Harness crash.
- Draw_Printer accumulates messages internally and prints them into console only after command execution completion. This is annoying behavior for a long process reporting some intermediate messages - so that important problems can be seen only at the very end of command.

It is proposed reverted patch making Draw_Printer as default printer ad Draw Harness start and reconsider its usage in particular commands. The origin of Draw_Printer are Data Exchange plugins, so that them should be checked carefully.
Steps To ReproduceNot required
TagsNo tags attached.
Test case number
Attached Files

- Relationships
related to 0024644closedbugmaster Draw_Printer - provide the way to control messages gravity filter 
related to 0025748assignedmsv Foundation Classes - Parallel version of progress indicator 
related to 0031036verifiedapn Foundation Classes, Message_PrinterOStream - add option printing colored text into console 

-  Notes
(0084205)
git (administrator)
2019-05-06 23:12

Branch CR30697 has been created by kgv.

SHA-1: 80145f0110178da4585ea764914f24bfef7abbac


Detailed log of new commits:

Author: kgv
Date: Mon May 6 23:05:13 2019 +0300

    0030697: Draw Harness - Draw_Printer should not be set to Message::DefaultMessenger() by default
(0088747)
git (administrator)
2019-11-06 11:30

Branch CR30697 has been updated by mzernova.

SHA-1: 9f6e5d82deb44c9cafd530d15775fb30aaf641cc


Detailed log of new commits:

Author: mzernova
Date: Thu Oct 31 16:03:29 2019 +0300

    Fixed some bugs that occurred when using the default std::cout from Message::DefaultMessenger() instead of Draw_Printer

(0088748)
kgv (developer)
2019-11-06 11:47

@@ -147,9 +147,9 @@ Standard_Boolean Draw_ProgressIndicator::Show(const Standard_Boolean force)
   }
 
   // Print textual progress info
-  if ( myTextMode )
-    Message::DefaultMessenger()->Send (text, Message_Info);
-  
+  if (myTextMode && myDraw)
+    (*(Draw_Interpretor*)myDraw) << text << "\n";

This should be a new dedicated option - only for test cases of progress indicator itself (their is a couple of them).
Default implementation of Text Mode should print into std::cout (not Messenger) so that progress will be seen during task.
(0088749)
kgv (developer)
2019-11-06 11:49

+  const Handle(Message_Messenger)& aMsgMgr = Message::DefaultMessenger();
+  if (!aMsgMgr.IsNull())
+  {
+    aMsgMgr->RemovePrinters (STANDARD_TYPE (Message_PrinterOStream));
+    aMsgMgr->RemovePrinters (STANDARD_TYPE (Draw_Printer));
+    aMsgMgr->AddPrinter (new Draw_Printer (di));
+  }

It is better copying the whole list of printers and adding them back.
(0088777)
git (administrator)
2019-11-07 16:22

Branch CR30697 has been updated by mzernova.

SHA-1: 72bc28711fb2e2ede6204eb84a8ae4b79c7abc2e


Detailed log of new commits:

Author: mzernova
Date: Thu Nov 7 14:12:31 2019 +0300

    remarks from kgv

(0088778)
git (administrator)
2019-11-07 16:22

Branch CR30697_1 has been created by mzernova.

SHA-1: b1b14ad2d234606961b0f8757c1e586ad5aedf64


Detailed log of new commits:

Author: kgv
Date: Mon May 6 23:05:13 2019 +0300

    0030697: Draw Harness - Draw_Printer should not be set to Message::DefaultMessenger() by default
    
    Fixed bugs that occurred when using the default std::cout from Message::DefaultMessenger() instead of Draw_Printer
(0088816)
git (administrator)
2019-11-08 20:12

Branch CR30697 has been updated by mzernova.

SHA-1: 14286674ea365a12d3ac873639dba2d7d243b5b5


Detailed log of new commits:

Author: mzernova
Date: Fri Nov 8 14:10:14 2019 +0300

    fixed some problems caused by changes in Draw_ProgressIndicator::Show method

(0088817)
git (administrator)
2019-11-08 20:12

Branch CR30697_1 has been updated forcibly by mzernova.

SHA-1: 2fdf1fe2aac438c62fc4c6d2f29c5c7a023e8942
(0088818)
kgv (developer)
2019-11-08 20:15

+  aProgress->SetTclMode (Standard_True);

I think "SetTclOutput" would be better than "SetTclMode".

> fixed some problems caused by changes in Draw_ProgressIndicator::Show method
> @@ -454,6 +454,7 @@ static Standard_Integer sewing (Draw_Interpretor& theDi,
> @@ -484,6 +484,7 @@ static Standard_Integer fixshape (Draw_Interpretor& di,
> @@ -312,6 +312,7 @@ static Standard_Integer createmesh
Could you please refer to test cases where this modification is necessary?
The location of these modifications looks suspicion to me.
(0088819)
git (administrator)
2019-11-08 20:21

Branch CR30697 has been updated by mzernova.

SHA-1: 1342dab2e895ec545aff0fcf48753d90d167079c


Detailed log of new commits:

Author: mzernova
Date: Fri Nov 8 20:18:54 2019 +0300

    A dedicated option was added to Draw_ProgressIndicator, for outputting data to the tcl when performing tests

(0088953)
mzernova (developer)
2019-11-14 10:41

test bugs modalg_5 bug22747
test bugs moddata_2 bug22572
test bugs moddata_2 bug22746_1
test bugs moddata_2 bug22746_2
test bugs moddata_2 bug22746_3
(0088954)
kgv (developer)
2019-11-14 10:55

These are tests for progress indicator used within the algorithm.
Expected change is modifying test case to use "XProgress -tclOutput" rather than modifying "sewing" command.
# Progress indicator in sewing algorithm
vinit
XProgress -t
set List1 [sewing result 0.1 a]
if { [string compare $List1 ""] != 0 } {
(0088962)
git (administrator)
2019-11-14 15:41

Branch CR30697 has been updated by mzernova.

SHA-1: b0eb3f1777d43168d763c7f455580a4d43c2914a


Detailed log of new commits:

Author: mzernova
Date: Thu Nov 14 15:15:10 2019 +0300

    Added -tclOutput parameter to XProgress command

(0088963)
git (administrator)
2019-11-14 15:41

Branch CR30697_1 has been updated forcibly by mzernova.

SHA-1: 05f1e2245b32b4fc69eb4bf8a6673b0b61d44fa0
(0088966)
mzernova (developer)
2019-11-14 17:39

The patch CR30697 is ready to review
(0088969)
mzernova (developer)
2019-11-14 17:44

http://vm-jenkins-test-12.nnov.opencascade.com:8080/view/CR30697_1-master-mzernova [^]
(0088970)
kgv (developer)
2019-11-14 17:46

+    if (!strcmp (argv[i], "-tclOutput"))

It is preferred used case-insensitive comparison of Tcl command arguments.
> TCollection_AsciiString anArgCase (argv[i]);
> anArgCase.LowerCase();
> if (anArgCase == "-tcloutput")

+Standard_Boolean &Draw_ProgressIndicator::DefaultTclOutput ()

Standard_Boolean& Draw_ProgressIndicator::DefaultTclOutput()

+void Draw_ProgressIndicator::SetTclOutput (const Standard_Boolean theTclOutput)
+{
...
+Standard_Boolean Draw_ProgressIndicator::GetTclOutput() const
+{
+  return myTclOutput;

Inline definition would be better.

+      (*(Draw_Interpretor*) myDraw) << aText.str().c_str() << "\n";

myDraw declaration can be improved to avoid type cast.
(0088971)
kgv (developer)
2019-11-14 17:54

@@ -136,7 +138,9 @@ void BOPTest::ReportAlerts(const Handle(Message_Report)& theReport)
       }
 
       // output message with list of shapes
-      Message::DefaultMessenger()->Send (aText, anAlertTypes[iGravity]);
+      Draw_Interpretor& aDrawInterpretor = Draw::GetInterpretor();
+      Handle(Message_Messenger) aMessenger = new Message_Messenger (new Draw_Printer (aDrawInterpretor));

+      aMessenger->Send (aText, anAlertTypes[iGravity]);

Could be just "aDrawInterpretor << aText" in this context.

--- a/src/XSDRAWIGES/XSDRAWIGES.cxx
+++ b/src/XSDRAWIGES/XSDRAWIGES.cxx
@@ -106,6 +106,7 @@ static Standard_Integer igesbrep (Draw_Interpretor& di, Standard_Integer argc, 
c
 
   // Progress indicator
   Handle(Draw_ProgressIndicator) progress = new Draw_ProgressIndicator ( di, 1 );
+  progress->SetTclOutput (Standard_True);
...
--- a/src/XSDRAWSTEP/XSDRAWSTEP.cxx
+++ b/src/XSDRAWSTEP/XSDRAWSTEP.cxx
@@ -96,6 +96,7 @@ static Standard_Integer stepread (Draw_Interpretor& di/*theCommands*/, Standard_
 
   
// Progress indicator
   Handle(Draw_ProgressIndicator) progress = new Draw_ProgressIndicator ( di, 1 );
+  progress->SetTclOutput (Standard_True);

These are unexpected - I suppose that only specific test cases should be "XProgress -tclOutput" if there are any.

- Issue History
Date Modified Username Field Change
2019-05-06 23:09 kgv New Issue
2019-05-06 23:09 kgv Assigned To => kgv
2019-05-06 23:12 git Note Added: 0084205
2019-05-06 23:14 kgv Relationship added related to 0024644
2019-05-06 23:14 kgv Product Version => 6.8.0
2019-05-12 16:46 kgv Relationship added related to 0025748
2019-09-04 15:43 abv Target Version 7.4.0 => 7.5.0*
2019-10-05 20:16 kgv Assigned To kgv => user897
2019-10-05 20:16 kgv Status new => assigned
2019-10-05 22:16 kgv Relationship added related to 0031036
2019-11-06 11:30 git Note Added: 0088747
2019-11-06 11:47 kgv Note Added: 0088748
2019-11-06 11:49 kgv Note Added: 0088749
2019-11-06 12:24 osa Assigned To user897 => mzernova
2019-11-07 16:22 git Note Added: 0088777
2019-11-07 16:22 git Note Added: 0088778
2019-11-08 20:12 git Note Added: 0088816
2019-11-08 20:12 git Note Added: 0088817
2019-11-08 20:15 kgv Note Added: 0088818
2019-11-08 20:21 git Note Added: 0088819
2019-11-14 10:41 mzernova Note Added: 0088953
2019-11-14 10:55 kgv Note Added: 0088954
2019-11-14 15:41 git Note Added: 0088962
2019-11-14 15:41 git Note Added: 0088963
2019-11-14 17:39 mzernova Note Added: 0088966
2019-11-14 17:39 mzernova Assigned To mzernova => osa
2019-11-14 17:39 mzernova Status assigned => resolved
2019-11-14 17:39 mzernova Steps to Reproduce Updated View Revisions
2019-11-14 17:44 mzernova Note Added: 0088969
2019-11-14 17:46 kgv Note Added: 0088970
2019-11-14 17:54 kgv Note Added: 0088971


Copyright © 2000 - 2019 MantisBT Team
Powered by Mantis Bugtracker