harbour-core/harbour/source/vm/debug.c

/*
 * $Id$
 */

/*
 * Harbour Project source code:
 * Debugging functions for LOCAL, STATIC variables and the stack
 *
 * Copyright 1999 Eddie Runia <eddie@runia.com>
 * www - http://www.harbour-project.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this software; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307 USA (or visit the web site http://www.gnu.org/).
 *
 * As a special exception, the Harbour Project gives permission for
 * additional uses of the text contained in its release of Harbour.
 *
 * The exception is that, if you link the Harbour libraries with other
 * files to produce an executable, this does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * Your use of that executable is in no way restricted on account of
 * linking the Harbour library code into it.
 *
 * This exception does not however invalidate any other reasons why
 * the executable file might be covered by the GNU General Public License.
 *
 * This exception applies only to the code released by the Harbour
 * Project under the name Harbour.  If you copy code from other
 * Harbour Project or Free Software Foundation releases into a copy of
 * Harbour, as the General Public License permits, the exception does
 * not apply to the code that you add in this way.  To avoid misleading
 * anyone as to the status of such modified files, you must delete
 * this exception notice from them.
 *
 * If you write modifications of your own for Harbour, it is your choice
 * whether to permit this exception to apply to your modifications.
 * If you do not wish that, delete this exception notice.
 *
 */

#include "hbvmopt.h"
#include "hbapi.h"
#include "hbapidbg.h"
#include "hbapiitm.h"
#include "hbapierr.h"
#include "hbstack.h"


/* Existing debug functions
 * from debug.c:
 *    __DBGVMSTKGCOUNT()
 *    __DBGVMSTKGLIST()
 *    __DBGVMSTKLCOUNT()
 *    __DBGVMPARLLIST()
 * for locals:
 *    __DBGVMVARLGET()              (debugger.prg)
 *    __DBGVMVARLSET()              (debugger.prg)
 *    hb_dbg_vmVarLGet(int,int)     (dbgentry.c)
 *
 * form classes.c:
 *    hb_dbg_objSendMessage(...)    (dbgentry.c)
 *
 * form hvm.c
 * general:
 *    __DBGINVOKEDEBUG()            (debugger.prg)
 *    __DBGPROCLEVEL()              (debugger.prg)
 *    hb_dbg_InvokeDebug(BOOL)      (dbgentry.c)
 *    hb_dbg_ProcLevel()            (dbgentry.c)
 *    hb_dbg_SetEntry(*ENTRY_FUNC)  (dbgentry.c)
 * for statics:
 *    __DBGVMVARSLIST()
 *    __DBGVMVARSLEN()
 *    __DBGVMVARSGET()              (debugger.prg)
 *    __DBGVMVARSSET()              (debugger.prg)
 *    hb_dbg_vmVarSGet(int,int)     (dbgentry.c)
 * for globals (unused):
 *    __DBGVMVARGLIST()
 *    __DBGVMVARGGET()              (debugger.prg)
 *    __DBGVMVARGSET()              (debugger.prg)
 *    hb_dbg_vmVarGCount()          (dbgentry.c)
 *    hb_dbg_vmVarGGet(int,int)     (dbgentry.c)
 *
 *
 * Information from HVM send to debugger by __DBGENTRY()
 *    HB_DBG_MODULENAME, cName
 *    HB_DBG_STATICNAME, nBase,  nIndex, cName
 *    HB_DBG_LOCALNAME,  nIndex, cName
 *    HB_DBG_SHOWLINE,   nLine
 *    HB_DBG_ENDPROC
 *    HB_DBG_GETENTRY
 *    HB_DBG_VMQUIT
 */



/* $Doc$
 * $FuncName$     AddToArray( <pItem>, <pReturn>, <uiPos> )
 * $Description$  Add <pItem> to array <pReturn> at pos <uiPos>
 * $End$ */
static void AddToArray( PHB_ITEM pItem, PHB_ITEM pReturn, ULONG ulPos )
{
   HB_TRACE(HB_TR_DEBUG, ("AddToArray(%p, %p, %lu)", pItem, pReturn, ulPos));

   if( HB_IS_SYMBOL( pItem ) )
   {                                            /* Symbol is pushed as text */
      PHB_ITEM pArrayItem = hb_arrayGetItemPtr( pReturn, ulPos );

      if( pArrayItem )
      {
         ULONG ulLen = strlen( pItem->item.asSymbol.value->szName ) + 2;
         char * szBuff = ( char * ) hb_xgrab( ulLen + 1 );

         hb_snprintf( szBuff, ulLen + 1, "[%s]", pItem->item.asSymbol.value->szName );
         hb_itemPutCLPtr( pArrayItem, szBuff, ulLen );
      }
   }
   else                                         /* Normal types             */
      hb_itemArrayPut( pReturn, ulPos, pItem );
}

/* $Doc$
 * $FuncName$     <nVars> __dbgvmStkGCount()
 * $Description$  Returns the length of the global stack
 * $End$ */
HB_FUNC( __DBGVMSTKGCOUNT )
{
   hb_retnl( hb_stackTopOffset() );
}

/* $Doc$
 * $FuncName$     <aStack> __dbgvmStkGList()
 * $Description$  Returns the global stack
 * $End$ */
HB_FUNC( __DBGVMSTKGLIST )
{
   PHB_ITEM pReturn;
   ULONG ulLen = hb_stackTopOffset();
   ULONG ulPos;

   pReturn = hb_itemArrayNew( ulLen );           /* Create a transfer array  */

   for( ulPos = 0; ulPos < ulLen; ++ulPos )
   {
      AddToArray( hb_stackItem( ulPos ), pReturn, ulPos + 1 );
   }
   hb_itemReturnRelease( pReturn );
}

/* $Doc$
 * $FuncName$     <nVars> hb_stackLen( <nProcLevel> )
 * $Description$  Returns params plus locals amount of the nProcLevel function
 * $End$ */
static LONG hb_stackLen( int iLevel )
{
   LONG lBaseOffset, lPrevOffset, lLen;

   HB_TRACE(HB_TR_DEBUG, ("hb_stackLen()"));

   lBaseOffset = hb_stackBaseOffset();
   while( --iLevel > 0 && lBaseOffset > 1 )
      lBaseOffset = hb_stackItem( lBaseOffset - 1 )->item.asSymbol.stackstate->lBaseItem + 1;

   if( lBaseOffset > 1 )
   {
      lPrevOffset = hb_stackItem( lBaseOffset - 1 )->item.asSymbol.stackstate->lBaseItem;
      lLen = lBaseOffset - lPrevOffset - 3;
   }
   else
      lLen = 0;

   return lLen;
}

/* $Doc$
 * $FuncName$     <nVars> __dbgvmStkLCount( <nProcLevel> )
 * $Description$  Returns params plus locals amount of the nProcLevel function
 * $End$ */
HB_FUNC( __DBGVMSTKLCOUNT )
{
   hb_retnl( hb_stackLen( hb_parni( 1 ) + 1 ) );
}

/* $Doc$
 * $FuncName$     <aStack> __dbgvmStkLList()
 * $Description$  Returns the stack of the calling function
 *                "[<symbol>]"  Means symbol.
 *
 *                [1]        Symbol of current function
 *                [2]        Self | NIL
 *                [3 .. x]   Parameters
 *                [x+1 .. y] Locals
 *                [y+1 ..]   Pushed data
 * $End$ */
HB_FUNC( __DBGVMSTKLLIST )
{
   PHB_ITEM pReturn;
   ULONG ulLen, ul;
   LONG lBaseOffset, lPrevOffset;

   lBaseOffset = hb_stackBaseOffset();
   lPrevOffset = hb_stackItem( lBaseOffset - 1 )->item.asSymbol.stackstate->lBaseItem;

   ulLen = lBaseOffset - lPrevOffset - 3;
   pReturn = hb_itemArrayNew( ulLen );           /* Create a transfer array  */
   for( ul = 0; ul < ulLen; ++ul )
      AddToArray( hb_stackItem( lPrevOffset + ul ), pReturn, ul + 1 );

   hb_itemReturnRelease( pReturn );
}

/* $Doc$
 * $FuncName$     <aParam> __dbgvmParLGet()
 * $Description$  Returns the passed parameters of the calling function
 * $End$ */
               /* TODO : put bLocals / bParams      */
               /* somewhere for declared parameters */
               /* and locals                        */
HB_FUNC( __DBGVMPARLLIST )
{
   hb_itemReturnRelease( hb_arrayFromParams( hb_parni( 1 ) + 1 ) );
}

PHB_ITEM hb_dbg_vmVarLGet( int iLevel, int iLocal )
{
   PHB_ITEM pLocal = NULL;
   LONG lBaseOffset;

   lBaseOffset = hb_stackBaseOffset();
   while( iLevel-- > 0 && lBaseOffset > 1 )
      lBaseOffset = hb_stackItem( lBaseOffset - 1 )->item.asSymbol.stackstate->lBaseItem + 1;

   if( iLevel < 0 )
   {
      if( iLocal > SHRT_MAX )
      {
         iLocal -= USHRT_MAX;
         iLocal--;
      }

      if( iLocal >= 0 )
      {
         PHB_ITEM pBase = hb_stackItem( lBaseOffset - 1 );

         if( pBase->item.asSymbol.paramcnt > pBase->item.asSymbol.paramdeclcnt &&
             iLocal > pBase->item.asSymbol.paramdeclcnt )
            iLocal += pBase->item.asSymbol.paramcnt - pBase->item.asSymbol.paramdeclcnt;

         pLocal = hb_stackItem( lBaseOffset + iLocal );
      }
      else
         pLocal = hb_codeblockGetRef( hb_stackItem( lBaseOffset )->item.asBlock.value, iLocal );

      if( HB_IS_BYREF( pLocal ) )
         pLocal = hb_itemUnRef( pLocal );
   }

   return pLocal;
}

HB_FUNC( __DBGVMVARLGET )
{
   int iLevel = hb_parni( 1 ) + 1;
   int iLocal = hb_parni( 2 );
   PHB_ITEM pLocal = hb_dbg_vmVarLGet( iLevel, iLocal );

   if( pLocal )
      hb_itemReturn( pLocal );
   else
      hb_errRT_BASE( EG_ARG, 6005, NULL, HB_ERR_FUNCNAME, HB_ERR_ARGS_BASEPARAMS );
}

HB_FUNC( __DBGVMVARLSET )
{
   int iLevel = hb_parni( 1 ) + 1;
   int iLocal = hb_parni( 2 );
   LONG lBaseOffset;
   PHB_ITEM pLocal;

   lBaseOffset = hb_stackBaseOffset();
   while( iLevel-- > 0 && lBaseOffset > 1 )
      lBaseOffset = hb_stackItem( lBaseOffset - 1 )->item.asSymbol.stackstate->lBaseItem + 1;

   if( iLevel < 0 )
   {
      if( iLocal > SHRT_MAX )
      {
         iLocal -= USHRT_MAX;
         iLocal--;
      }

      if( iLocal >= 0 )
      {
         PHB_ITEM pBase = hb_stackItem( lBaseOffset - 1 );

         if( pBase->item.asSymbol.paramcnt > pBase->item.asSymbol.paramdeclcnt &&
             iLocal > pBase->item.asSymbol.paramdeclcnt )
            iLocal += pBase->item.asSymbol.paramcnt - pBase->item.asSymbol.paramdeclcnt;

         pLocal = hb_stackItem( lBaseOffset + iLocal );
      }
      else
         pLocal = hb_codeblockGetRef( hb_stackItem( lBaseOffset )->item.asBlock.value, iLocal );

      hb_itemCopyToRef( pLocal, hb_stackItemFromBase( 3 ) );
   }
}