debuglevels: #i116845# introduce CaptureAssertions, to forward assertions raised during Basic script execution to a user-defined function

6 files changed, 173 insertions, 1 deletions

diff --git a/basic/source/classes/sbxmod.cxx b/basic/source/classes/sbxmod.cxx
index 0f807db7cf8f..51eeb61c9625 100755
--- a/basic/source/classes/sbxmod.cxx
+++ b/basic/source/classes/sbxmod.cxx
@@ -36,6 +36,7 @@
 #include <svl/brdcst.hxx>
 #include <tools/shl.hxx>
 #include <basic/sbx.hxx>
+#include "sbdiagnose.hxx"
 #include "sb.hxx"
 #include <sbjsmeth.hxx>
 #include "sbjsmod.hxx"
@@ -1180,6 +1181,8 @@ USHORT SbModule::Run( SbMethod* pMeth )
 
                 GlobalRunDeInit();
 
+                ResetCapturedAssertions();
+
                 // VBA always ensures screenupdating is enabled after completing
                 if ( mbVBACompat )
                     VBAUnlockControllers( PTR_CAST( StarBASIC, GetParent() ) );
diff --git a/basic/source/inc/sbdiagnose.hxx b/basic/source/inc/sbdiagnose.hxx
new file mode 100644
index 000000000000..065efdb183e1
--- /dev/null
+++ b/basic/source/inc/sbdiagnose.hxx
@@ -0,0 +1,34 @@
+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2011 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef BASIC_SBDIAGNOSE_HXX
+#define BASIC_SBDIAGNOSE_HXX
+
+#ifdef DBG_UTIL
+void    ResetCapturedAssertions();
+#endif
+
+#endif // BASIC_SBDIAGNOSE_HXX
diff --git a/basic/source/runtime/makefile.mk b/basic/source/runtime/makefile.mk
index 8ca052aaae1a..329448c67e75 100644
--- a/basic/source/runtime/makefile.mk
+++ b/basic/source/runtime/makefile.mk
@@ -54,7 +54,8 @@ SLOFILES=	\
     $(SLO)$/methods1.obj	\
     $(SLO)$/props.obj	\
     $(SLO)$/ddectrl.obj	\
-    $(SLO)$/dllmgr.obj
+    $(SLO)$/dllmgr.obj \
+    $(SLO)$/sbdiagnose.obj
 
 .IF "$(GUI)$(COM)$(CPU)" == "WNTMSCI"
 SLOFILES+=	$(SLO)$/wnt.obj
diff --git a/basic/source/runtime/rtlproto.hxx b/basic/source/runtime/rtlproto.hxx
index ba7af48c8472..aa5946fb304f 100644
--- a/basic/source/runtime/rtlproto.hxx
+++ b/basic/source/runtime/rtlproto.hxx
@@ -344,6 +344,7 @@ extern RTLFUNC(CDateToIso);
 extern RTLFUNC(CDateFromIso);
 extern RTLFUNC(CompatibilityMode);
 extern RTLFUNC(CDec);
+extern RTLFUNC(CaptureAssertions);
 
 extern RTLFUNC(Partition); // Fong
 
diff --git a/basic/source/runtime/sbdiagnose.cxx b/basic/source/runtime/sbdiagnose.cxx
new file mode 100644
index 000000000000..d779fe17e254
--- /dev/null
+++ b/basic/source/runtime/sbdiagnose.cxx
@@ -0,0 +1,131 @@
+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2011 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#include "precompiled_basic.hxx"
+
+#include "rtlproto.hxx"
+#include "sbdiagnose.hxx"
+
+#include "basic/sbstar.hxx"
+
+#include <tools/debug.hxx>
+#include <comphelper/flagguard.hxx>
+
+#ifdef DBG_UTIL
+
+static DbgChannelId nRestoreChannelId = 0;
+static DbgChannelId nAssertionChannelId = 0;
+static StarBASICRef xAssertionChannelBasic;
+static String sCaptureFunctionName;
+static bool bReportingAssertion = false;
+
+void ResetCapturedAssertions()
+{
+    DBG_INSTOUTERROR( nRestoreChannelId != 0 ? nRestoreChannelId : DBG_OUT_NULL );
+    nRestoreChannelId = 0;
+    xAssertionChannelBasic = NULL;
+    sCaptureFunctionName = String();
+    bReportingAssertion = false;
+}
+
+void DbgReportAssertion( const sal_Char* i_assertionMessage )
+{
+    if ( !xAssertionChannelBasic )
+    {
+        ResetCapturedAssertions();
+        return;
+    }
+
+    // prevent infinite recursion
+    if ( bReportingAssertion )
+        return;
+    ::comphelper::FlagRestorationGuard aGuard( bReportingAssertion, true );
+
+    SbxArrayRef const xArguments( new SbxArray( SbxVARIANT ) );
+    SbxVariableRef const xMessageText = new SbxVariable( SbxSTRING );
+    xMessageText->PutString( String::CreateFromAscii( i_assertionMessage ) );
+    xArguments->Put( xMessageText, 1 );
+
+    ErrCode const nError = xAssertionChannelBasic->Call( sCaptureFunctionName, xArguments );
+    if ( ( nError & SbERR_METHOD_NOT_FOUND ) != 0 )
+        ResetCapturedAssertions();
+}
+
+#endif
+
+/// capture assertions, route them to the given given Basic function
+RTLFUNC(CaptureAssertions)
+{
+    (void)bWrite;
+
+    // need exactly one argument
+    if ( rPar.Count() != 2 )
+    {
+        StarBASIC::Error( SbERR_BAD_ARGUMENT );
+        return;
+    }
+
+#ifdef DBG_UTIL
+    DBG_TESTSOLARMUTEX();
+
+    String const sFunctionName = rPar.Get(1)->GetString();
+    if ( sFunctionName.Len() == 0 )
+    {
+        ResetCapturedAssertions();
+        return;
+    }
+
+    if ( nAssertionChannelId == 0 )
+    {
+        // TODO: should we register a named channel at the VCL API, instead of an unnamed channel at the tools API?
+        // A named channel would mean it would appear in the nonpro-debug-options dialog
+        nAssertionChannelId = DbgRegisterUserChannel( &DbgReportAssertion );
+    }
+
+    DbgChannelId const nCurrentChannelId = (DbgChannelId)DbgGetErrorOut();
+    if ( nCurrentChannelId != nAssertionChannelId )
+    {
+        // remember the current channel
+        nRestoreChannelId = nCurrentChannelId;
+
+        // set the new channel
+        DBG_INSTOUTERROR( nAssertionChannelId );
+
+        // ensure OSL assertions are captured, too
+        DbgData aData( *DbgGetData() );
+        aData.bHookOSLAssert = TRUE;
+        DbgUpdateOslHook( &aData );
+    }
+
+    xAssertionChannelBasic = pBasic;
+    sCaptureFunctionName = sFunctionName;
+#else
+    (void)pBasic;
+    (void)rPar;
+    (void)bWrite;
+#endif
+}
+
diff --git a/basic/source/runtime/stdobj.cxx b/basic/source/runtime/stdobj.cxx
index 39f92afdea4a..863c12f29288 100644
--- a/basic/source/runtime/stdobj.cxx
+++ b/basic/source/runtime/stdobj.cxx
@@ -147,6 +147,8 @@ static Methods aMethods[] = {
   { "number",       SbxDOUBLE, 0,NULL,0 },
 { "CreateObject",   SbxOBJECT,    1 | _FUNCTION, RTLNAME( CreateObject ),0  },
   { "class",        SbxSTRING, 0,NULL,0 },
+{ "CaptureAssertions",  SbxNULL, 1 | _FUNCTION, RTLNAME(CaptureAssertions), 0 },
+  { "methodName",   SbxSTRING, 0, NULL, 0 },
 { "CreateUnoListener",SbxOBJECT,   1 | _FUNCTION, RTLNAME( CreateUnoListener ),0 },
   { "prefix",  SbxSTRING, 0,NULL,0 },
   { "typename",  SbxSTRING, 0,NULL,0 },