mib17: #163025# Basic Trace functionality for debugging (inactive by default)

5 files changed, 420 insertions, 9 deletions

diff --git a/basic/source/classes/disas.cxx b/basic/source/classes/disas.cxx
index 87b4cad4e94b..a837a3dc4f24 100644
--- a/basic/source/classes/disas.cxx
+++ b/basic/source/classes/disas.cxx
@@ -35,6 +35,7 @@
 #include "sb.hxx"
 #include "iosys.hxx"
 #include "disas.hxx"
+#include "sbtrace.hxx"
 
 
 static const char* pOp1[] = {
@@ -361,6 +362,11 @@ BOOL SbiDisas::DisasLine( String& rText )
     rText.Erase();
     if( !Fetch() )
         return FALSE;
+
+#ifdef DBG_TRACE_BASIC
+    String aTraceStr_STMNT;
+#endif
+
     // New line?
     if( eOp == _STMNT && nOp1 != nLine )
     {
@@ -393,8 +399,13 @@ BOOL SbiDisas::DisasLine( String& rText )
             rText.AppendAscii( "; " );
             rText += s;
             rText.AppendAscii( _crlf() );
+
+#ifdef DBG_TRACE_BASIC
+            aTraceStr_STMNT = s;
+#endif
         }
     }
+
     // Label?
     const char* p = "";
     if( cLabels[ nPC >> 3 ] & ( 1 << ( nPC & 7 ) ) )
@@ -432,20 +443,29 @@ BOOL SbiDisas::DisasLine( String& rText )
         rText.AppendAscii( _crlf() );
     }
     snprintf( cBuf, sizeof(cBuf), pMask[ nParts ], nPC, (USHORT) eOp, nOp1, nOp2 );
-    rText.AppendAscii( cBuf );
+
+    String aPCodeStr;
+    aPCodeStr.AppendAscii( cBuf );
     int n = eOp;
     if( eOp >= SbOP2_START )
         n -= SbOP2_START;
     else if( eOp >= SbOP1_START )
         n -= SbOP1_START;
-    rText += '\t';
-    rText.AppendAscii( pOps[ nParts-1 ][ n ] );
-    rText += '\t';
+    aPCodeStr += '\t';
+    aPCodeStr.AppendAscii( pOps[ nParts-1 ][ n ] );
+    aPCodeStr += '\t';
     switch( nParts )
     {
-        case 2: (this->*( pOperand2[ n ] ) )( rText ); break;
-        case 3: (this->*( pOperand3[ n ] ) )( rText ); break;
+        case 2: (this->*( pOperand2[ n ] ) )( aPCodeStr ); break;
+        case 3: (this->*( pOperand3[ n ] ) )( aPCodeStr ); break;
     }
+
+    rText += aPCodeStr;
+
+#ifdef DBG_TRACE_BASIC
+    dbg_RegisterTraceTextForPC( pMod, nPC, aTraceStr_STMNT, aPCodeStr );
+#endif
+
     return TRUE;
 }
 
diff --git a/basic/source/classes/sbxmod.cxx b/basic/source/classes/sbxmod.cxx
index 30d856fda40e..0f52eef2d825 100644
--- a/basic/source/classes/sbxmod.cxx
+++ b/basic/source/classes/sbxmod.cxx
@@ -45,6 +45,7 @@
 #include "runtime.hxx"
 #include "token.hxx"
 #include "sbunoobj.hxx"
+#include "sbtrace.hxx"
 
 
 //#include <basic/hilight.hxx>
@@ -1044,6 +1045,9 @@ USHORT SbModule::Run( SbMethod* pMeth )
     StarBASICRef xBasic;
     if( bDelInst )
     {
+#ifdef DBG_TRACE_BASIC
+        dbg_InitTrace();
+#endif
         // #32779: Basic waehrend der Ausfuehrung festhalten
         xBasic = (StarBASIC*) GetParent();
 
@@ -1122,18 +1126,28 @@ USHORT SbModule::Run( SbMethod* pMeth )
             SbModule* pOldMod = pMOD;
             pMOD = this;
             SbiRuntime* pRt = new SbiRuntime( this, pMeth, pMeth->nStart );
+
+#ifdef DBG_TRACE_BASIC
+            dbg_traceNotifyCall( this, pMeth, pINST->nCallLvl );
+#endif
+
             pRt->pNext = pINST->pRun;
             if( pRt->pNext )
                 pRt->pNext->block();
             pINST->pRun = pRt;
             if ( mbVBACompat )
-                        {
+            {
                 pINST->EnableCompatibility( TRUE );
-                        }
+            }
             while( pRt->Step() ) {}
             if( pRt->pNext )
                 pRt->pNext->unblock();
 
+#ifdef DBG_TRACE_BASIC
+            bool bLeave = true;
+            dbg_traceNotifyCall( this, pMeth, pINST->nCallLvl, bLeave );
+#endif
+
             // #63710 Durch ein anderes Thread-Handling bei Events kann es passieren,
             // dass show-Aufruf an einem Dialog zurueckkehrt (durch schliessen des
             // Dialogs per UI), BEVOR ein per Event ausgeloester weitergehender Call,
@@ -1227,9 +1241,20 @@ void SbModule::RunInit()
         pMOD = this;
         // Der Init-Code beginnt immer hier
         SbiRuntime* pRt = new SbiRuntime( this, NULL, 0 );
+
+#ifdef DBG_TRACE_BASIC
+        dbg_traceNotifyCall( this, NULL, 0 );
+#endif
+
         pRt->pNext = pINST->pRun;
         pINST->pRun = pRt;
         while( pRt->Step() ) {}
+
+#ifdef DBG_TRACE_BASIC
+        bool bLeave = true;
+        dbg_traceNotifyCall( this, NULL, 0, bLeave );
+#endif
+
         pINST->pRun = pRt->pNext;
         delete pRt;
         pMOD = pOldMod;
diff --git a/basic/source/comp/sbcomp.cxx b/basic/source/comp/sbcomp.cxx
index faabba046c99..e6fe73177dd2 100644..100755
--- a/basic/source/comp/sbcomp.cxx
+++ b/basic/source/comp/sbcomp.cxx
@@ -31,10 +31,310 @@
 #include <basic/sbx.hxx>
 #include "sbcomp.hxx"
 #include "image.hxx"
+#include "sbtrace.hxx"
 
 
+//==========================================================================
+// Tracing, for debugging only
+
+// To activate tracing enable in sbtrace.hxx
+#ifdef DBG_TRACE_BASIC
+
+#include <hash_map>
+
+// Trace Settings
+static const char*  GpTraceFileName = "d:\\zBasic.Asm\\BasicTrace.txt";
+static const bool   GbIncludePCodes = false;
+static const int    GnIndentPerCallLevel = 4;
+static const int    GnIndentForPCode = 2;
+
+struct TraceTextData
+{
+    rtl::OString m_aTraceStr_STMNT;
+    rtl::OString m_aTraceStr_PCode;
+};
+typedef std::hash_map< sal_Int32, TraceTextData > PCToTextDataMap;
+typedef std::hash_map< ::rtl::OUString, PCToTextDataMap*, ::rtl::OUStringHash, ::std::equal_to< ::rtl::OUString > > ModuleTraceMap;
+
+ModuleTraceMap      GaModuleTraceMap;
+ModuleTraceMap&     rModuleTraceMap = GaModuleTraceMap;
+
+static void lcl_PrepareTraceForModule( SbModule* pModule )
+{
+    String aModuleName = pModule->GetName();
+    ModuleTraceMap::iterator it = rModuleTraceMap.find( aModuleName );
+    if( it != rModuleTraceMap.end() )
+    {
+        PCToTextDataMap* pInnerMap = it->second;
+        delete pInnerMap;
+        rModuleTraceMap.erase( it );
+    }
+
+    String aDisassemblyStr;
+    pModule->Disassemble( aDisassemblyStr );
+}
+
+static void lcl_lineOut( const char* pFileName, const char* pStr, const char* pPreStr = NULL )
+{
+    const char* pPrintFirst = (pPreStr != NULL) ? pPreStr : "";
+    FILE* pFile = fopen( pFileName, "a+" );
+    if( pFile != NULL )
+    {
+        fprintf( pFile, "%s%s\n", pPrintFirst, pStr );
+        fclose( pFile );
+    }
+}
+
+const char* lcl_getSpaces( int nSpaceCount )
+{
+    static sal_Char Spaces[] = "                                                                                                    "
+        "                                                                                                    "
+        "                                                                                                    ";
+    static int nAvailableSpaceCount = strlen( Spaces );
+    static sal_Char* pSpacesEnd = Spaces + nAvailableSpaceCount;
+
+    if( nSpaceCount > nAvailableSpaceCount )
+        nSpaceCount = nAvailableSpaceCount;
+
+    return pSpacesEnd - nSpaceCount;
+}
+
+static rtl::OString lcl_toOStringSkipLeadingWhites( const String& aStr )
+{
+    static sal_Char Buffer[1000];
+
+    rtl::OString aOStr = OUStringToOString( rtl::OUString( aStr ), RTL_TEXTENCODING_ASCII_US );
+    const sal_Char* pStr = aOStr.getStr();
+
+    // Skip whitespace
+    sal_Char c = *pStr;
+    while( c == ' ' || c == '\t' )
+    {
+        pStr++;
+        c = *pStr;
+    }
+
+    int nLen = strlen( pStr );
+    strncpy( Buffer, pStr, nLen );
+    Buffer[nLen] = 0;
+
+    rtl::OString aORetStr( Buffer );
+    return aORetStr;
+}
+
+String dumpMethodParameters( SbMethod* pMethod )
+{
+    String aStr;
+    if( pMethod == NULL )
+        return aStr;
+
+    SbxError eOld = SbxBase::GetError();
+
+    SbxArray* pParams = pMethod->GetParameters();
+    SbxInfo* pInfo = pMethod->GetInfo();
+    if ( pParams )
+    {
+        aStr += '(';
+        // 0 is sub itself
+        for ( USHORT nParam = 1; nParam < pParams->Count(); nParam++ )
+        {
+            SbxVariable* pVar = pParams->Get( nParam );
+            DBG_ASSERT( pVar, "Parameter?!" );
+            if ( pVar->GetName().Len() )
+                aStr += pVar->GetName();
+            else if ( pInfo )
+            {
+                const SbxParamInfo* pParam = pInfo->GetParam( nParam );
+                if ( pParam )
+                    aStr += pParam->aName;
+            }
+            aStr += '=';
+            if( pVar->GetType() & SbxARRAY )
+                aStr += String( RTL_CONSTASCII_USTRINGPARAM( "..." ) );
+            else
+                aStr += pVar->GetString();
+            if ( nParam < ( pParams->Count() - 1 ) )
+                aStr += String( RTL_CONSTASCII_USTRINGPARAM( ", " ) );
+        }
+        aStr += ')';
+    }
+
+    SbxBase::ResetError();
+    if( eOld != SbxERR_OK )
+        SbxBase::SetError( eOld );
+
+    return aStr;
+}
+
+// Public functions
+void dbg_InitTrace( void )
+{
+    FILE* pFile = fopen( GpTraceFileName, "w" );
+    if( pFile != NULL )
+        fclose( pFile );
+}
+
+void dbg_traceStep( SbModule* pModule, UINT32 nPC, INT32 nCallLvl )
+{
+    SbModule* pTraceMod = pModule;
+    if( pTraceMod->ISA(SbClassModuleObject) )
+    {
+        SbClassModuleObject* pClassModuleObj = (SbClassModuleObject*)(SbxBase*)pTraceMod;
+        pTraceMod = pClassModuleObj->getClassModule();
+    }
+
+    String aModuleName = pTraceMod->GetName();
+    ModuleTraceMap::iterator it = rModuleTraceMap.find( aModuleName );
+    if( it == rModuleTraceMap.end() )
+    {
+        const char* pModuleNameStr = OUStringToOString( rtl::OUString( aModuleName ), RTL_TEXTENCODING_ASCII_US ).getStr();
+        char Buffer[200];
+        sprintf( Buffer, "TRACE ERROR: Unknown module \"%s\"", pModuleNameStr );
+        lcl_lineOut( GpTraceFileName, Buffer );
+        return;
+    }
+
+    PCToTextDataMap* pInnerMap = it->second;
+    if( pInnerMap == NULL )
+    {
+        lcl_lineOut( GpTraceFileName, "TRACE INTERNAL ERROR: No inner map" );
+        return;
+    }
+
+    PCToTextDataMap::iterator itInner = pInnerMap->find( nPC );
+    if( itInner == pInnerMap->end() )
+    {
+        const char* pModuleNameStr = OUStringToOString( rtl::OUString( aModuleName ), RTL_TEXTENCODING_ASCII_US ).getStr();
+        char Buffer[200];
+        sprintf( Buffer, "TRACE ERROR: No info for PC = %d in module \"%s\"", nPC, pModuleNameStr );
+        lcl_lineOut( GpTraceFileName, Buffer );
+        return;
+    }
+
+    //nCallLvl--;
+    //if( nCallLvl < 0 )
+    //  nCallLvl = 0;
+    int nIndent = nCallLvl * GnIndentPerCallLevel;
+
+    const TraceTextData& rTraceTextData = itInner->second;
+    const rtl::OString& rStr_STMNT = rTraceTextData.m_aTraceStr_STMNT;
+    if( rStr_STMNT.getLength() )
+        lcl_lineOut( GpTraceFileName, rStr_STMNT.getStr(), lcl_getSpaces( nIndent ) );
+
+    if( !GbIncludePCodes )
+        return;
+
+    nIndent += GnIndentForPCode;
+    const rtl::OString& rStr_PCode = rTraceTextData.m_aTraceStr_PCode;
+    if( rStr_PCode.getLength() )
+        lcl_lineOut( GpTraceFileName, rStr_PCode.getStr(), lcl_getSpaces( nIndent ) );
+}
+
+void dbg_traceNotifyCall( SbModule* pModule, SbMethod* pMethod, INT32 nCallLvl, bool bLeave )
+{
+    static const char* pSeparator = "' ================================================================================";
+
+    SbModule* pTraceMod = pModule;
+    SbClassModuleObject* pClassModuleObj = NULL;
+    if( pTraceMod->ISA(SbClassModuleObject) )
+    {
+        pClassModuleObj = (SbClassModuleObject*)(SbxBase*)pTraceMod;
+        pTraceMod = pClassModuleObj->getClassModule();
+    }
+
+    if( nCallLvl > 0 )
+        nCallLvl--;
+    int nIndent = nCallLvl * GnIndentPerCallLevel;
+    if( !bLeave )
+    {
+        lcl_lineOut( GpTraceFileName, "" );
+        lcl_lineOut( GpTraceFileName, pSeparator, lcl_getSpaces( nIndent ) );
+    }
+
+    String aStr;
+    if( bLeave )
+    {
+        lcl_lineOut( GpTraceFileName, "}", lcl_getSpaces( nIndent ) );
+        aStr.AppendAscii( "' Leaving " );
+    }
+    else
+    {
+        aStr.AppendAscii( "Entering " );
+    }
+    String aModuleName = pModule->GetName();
+    aStr += aModuleName;
+    if( pMethod != NULL )
+    {
+        aStr.AppendAscii( "::" );
+        String aMethodName = pMethod->GetName();
+        aStr += aMethodName;
+    }
+    else
+    {
+        aStr.AppendAscii( "/RunInit" );
+    }
+
+    if( pClassModuleObj != NULL )
+    {
+        aStr.AppendAscii( "[this=" );
+        aStr += pClassModuleObj->GetName();
+        aStr.AppendAscii( "]" );
+    }
+    if( !bLeave )
+        aStr += dumpMethodParameters( pMethod );
+
+    lcl_lineOut( GpTraceFileName, OUStringToOString( rtl::OUString( aStr ), RTL_TEXTENCODING_ASCII_US ).getStr(), lcl_getSpaces( nIndent ) );
+    if( !bLeave )
+        lcl_lineOut( GpTraceFileName, "{", lcl_getSpaces( nIndent ) );
+
+    if( bLeave )
+        lcl_lineOut( GpTraceFileName, "" );
+}
+
+void dbg_traceNotifyError( SbError nTraceErr, const String& aTraceErrMsg, bool bTraceErrHandled, INT32 nCallLvl )
+{
+    rtl::OString aOTraceErrMsg = OUStringToOString( rtl::OUString( aTraceErrMsg ), RTL_TEXTENCODING_ASCII_US );
+
+    char Buffer[200];
+    const char* pHandledStr = bTraceErrHandled ? " / HANDLED" : "";
+    sprintf( Buffer, "*** ERROR%s, Id = %d, Msg = \"%s\" ***", pHandledStr, (int)nTraceErr, aOTraceErrMsg.getStr() );
+    int nIndent = nCallLvl * GnIndentPerCallLevel;
+    lcl_lineOut( GpTraceFileName, Buffer, lcl_getSpaces( nIndent ) );
+}
+
+void dbg_RegisterTraceTextForPC( SbModule* pModule, UINT32 nPC,
+    const String& aTraceStr_STMNT, const String& aTraceStr_PCode )
+{
+    String aModuleName = pModule->GetName();
+    ModuleTraceMap::iterator it = rModuleTraceMap.find( aModuleName );
+    PCToTextDataMap* pInnerMap;
+    if( it == rModuleTraceMap.end() )
+    {
+        pInnerMap = new PCToTextDataMap();
+        rModuleTraceMap[ aModuleName ] = pInnerMap;
+    }
+    else
+    {
+        pInnerMap = it->second;
+    }
+
+    TraceTextData aData;
+
+    rtl::OString aOTraceStr_STMNT = lcl_toOStringSkipLeadingWhites( aTraceStr_STMNT );
+    aData.m_aTraceStr_STMNT = aOTraceStr_STMNT;
+
+    rtl::OString aOTraceStr_PCode = lcl_toOStringSkipLeadingWhites( aTraceStr_PCode );
+    aData.m_aTraceStr_PCode = aOTraceStr_PCode;
+
+    (*pInnerMap)[nPC] = aData;
+}
+
+#endif
+
+
+//==========================================================================
 // For debugging only
-// #define DBG_SAVE_DISASSEMBLY
+//#define DBG_SAVE_DISASSEMBLY
 
 #ifdef DBG_SAVE_DISASSEMBLY
 static bool dbg_bDisassemble = true;
@@ -99,6 +399,7 @@ void dbg_SaveDisassembly( SbModule* pModule )
 }
 #endif
 
+
 // Diese Routine ist hier definiert, damit der Compiler als eigenes Segment
 // geladen werden kann.
 
@@ -155,6 +456,10 @@ BOOL SbModule::Compile()
     dbg_SaveDisassembly( this );
 #endif
 
+#ifdef DBG_TRACE_BASIC
+    lcl_PrepareTraceForModule( this );
+#endif
+
     return bRet;
 }
 
diff --git a/basic/source/inc/sbtrace.hxx b/basic/source/inc/sbtrace.hxx
new file mode 100755
index 000000000000..e8a482c2f6e9
--- /dev/null
+++ b/basic/source/inc/sbtrace.hxx
@@ -0,0 +1,42 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 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 _SBTRACE_HXX
+#define _SBTRACE_HXX
+
+// #define DBG_TRACE_BASIC
+
+#ifdef DBG_TRACE_BASIC
+void dbg_InitTrace( void );
+void dbg_traceStep( SbModule* pModule, UINT32 nPC, INT32 nCallLvl );
+void dbg_traceNotifyCall( SbModule* pModule, SbMethod* pMethod, INT32 nCallLvl, bool bLeave = false );
+void dbg_traceNotifyError( SbError nTraceErr, const String& aTraceErrMsg, bool bTraceErrHandled, INT32 nCallLvl );
+void dbg_RegisterTraceTextForPC( SbModule* pModule, UINT32 nPC,
+    const String& aTraceStr_STMNT, const String& aTraceStr_PCode );
+#endif
+
+#endif
diff --git a/basic/source/runtime/runtime.cxx b/basic/source/runtime/runtime.cxx
index c3419adbfdb3..1bb6fb82e113 100755
--- a/basic/source/runtime/runtime.cxx
+++ b/basic/source/runtime/runtime.cxx
@@ -44,6 +44,7 @@
 #include <com/sun/star/container/XEnumerationAccess.hpp>
 #include "sbunoobj.hxx"
 #include "errobject.hxx"
+#include "sbtrace.hxx"
 
 using namespace ::com::sun::star;
 
@@ -720,6 +721,12 @@ BOOL SbiRuntime::Step()
             if( pInst->IsReschedule() && bStaticGlobalEnableReschedule )
                 Application::Reschedule();
         }
+
+#ifdef DBG_TRACE_BASIC
+        UINT32 nPC = ( pCode - (const BYTE* )pImg->GetCode() );
+        dbg_traceStep( pMod, nPC, pINST->nCallLvl );
+#endif
+
         SbiOpcode eOp = (SbiOpcode ) ( *pCode++ );
         UINT32 nOp1, nOp2;
         if( eOp <= SbOP0_END )
@@ -756,6 +763,11 @@ BOOL SbiRuntime::Step()
         // (insbesondere nicht nach Compiler-Fehlern zur Laufzeit)
         if( nError && bRun )
         {
+#ifdef DBG_TRACE_BASIC
+            SbError nTraceErr = nError;
+            String aTraceErrMsg = GetSbData()->aErrMsg;
+            bool bTraceErrHandled = true;
+#endif
             SbError err = nError;
             ClearExprStack();
             nError = 0;
@@ -836,12 +848,19 @@ BOOL SbiRuntime::Step()
                 // Kein Error-Hdl gefunden -> altes Vorgehen
                 else
                 {
+#ifdef DBG_TRACE_BASIC
+                    bTraceErrHandled = false;
+#endif
                     pInst->Abort();
                 }
 
                 // ALT: Nur
                 // pInst->Abort();
             }
+
+#ifdef DBG_TRACE_BASIC
+            dbg_traceNotifyError( nTraceErr, aTraceErrMsg, bTraceErrHandled, pINST->nCallLvl );
+#endif
         }
     }
     return bRun;