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

/*
 * $Id$
 */

/*
 * Harbour Project source code:
 * PROCNAME(), PROCLINE() and PROCFILE() functions
 *
 * Copyright 1999 Antonio Linares <alinares@fivetech.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.
 *
 */

/*
 * The following parts are Copyright of the individual authors.
 * www - http://www.harbour-project.org
 *
 * Copyright 1999-2001 Viktor Szakats <viktor.szakats@syenar.hu>
 *    PROCFILE()
 *
 * Copyright 2001 JFL (Mafact) <jfl@mafact.com>
 *    Adding the MethodName() just calling Procname()
 *    call to hb_objGetRealClsName in case of object
 *    Special treatment in case of Object and __Eval (only for methodname)
 *    skipping block and adding (b) before the method name
 *
 * See doc/license.txt for licensing terms.
 *
 */

#include "hbvmopt.h"
#include "hbapi.h"
#include "hbapicls.h"
#include "hbapiitm.h"
#include "hbstack.h"
#include "hbvm.h"

#ifdef HB_EXTENSION

HB_FUNC( HB_METHODNAME )
{
   char szName[ HB_SYMBOL_NAME_LEN + HB_SYMBOL_NAME_LEN + 2 ];

   hb_retc( hb_procname( hb_parni( 1 ) + 1, szName, TRUE ) );
}

#endif

HB_FUNC( PROCNAME )
{
   char szName[ HB_SYMBOL_NAME_LEN + HB_SYMBOL_NAME_LEN + 5 ];

   hb_retc( hb_procname( hb_parni( 1 ) + 1, szName, FALSE ) );
}

HB_FUNC( PROCLINE )
{
   long lOffset = hb_stackBaseOffset();
   int iLevel = hb_parni( 1 ) + 1;  /* we are already inside ProcName() */

   while( iLevel-- > 0 && lOffset > 1 )
      lOffset = hb_stackItem( lOffset - 1 )->item.asSymbol.stackbase + 1;

   if( iLevel < 0 )
      hb_retni( hb_stackItem( lOffset - 1 )->item.asSymbol.lineno );
   else
      hb_retni( 0 );
}

#ifdef HB_C52_UNDOC

/* NOTE: Clipper undocumented function, which always returns an empty
         string. [vszakats] */

HB_FUNC( PROCFILE )
{
   PHB_SYMB pLocalSym = NULL;
   PHB_SYMB pSym = NULL;

   if( ISSYMBOL( 1 ) )
   {
      pSym = hb_itemGetSymbol( hb_param( 1, HB_IT_SYMBOL ) );
   }
   else
   {
      long lOffset = hb_stackBaseOffset();
      int iLevel = hb_parni( 1 ) + 1;  /* we are already inside ProcFile() */

      while( iLevel-- > 0 && lOffset > 1 )
         lOffset = hb_stackItem( lOffset - 1 )->item.asSymbol.stackbase + 1;

      if( iLevel < 0 )
      {
         pSym = hb_stackItem( lOffset - 1 )->item.asSymbol.value;

         if( pSym == &hb_symEval || strcmp( pSym->szName, "EVAL" ) == 0 )
         {
            PHB_ITEM pSelf = hb_stackItem( lOffset );

            if( HB_IS_BLOCK( pSelf ) )
               pLocalSym = pSelf->item.asBlock.value->pDefSymb;
         }
      }
   }

   if( !pLocalSym && pSym )
   {
      if( ( pSym->scope.value & HB_FS_LOCAL ) != 0 )
         pLocalSym = pSym;
      else if( pSym->pDynSym &&
               ( pSym->pDynSym->pSymbol->scope.value & HB_FS_LOCAL ) != 0 )
         pLocalSym = pSym->pDynSym->pSymbol;
   }

   hb_retc( hb_vmFindModuleSymbolName( pLocalSym ) );
}

#endif

/* NOTE: szName size must be an at least:
         HB_SYMBOL_NAME_LEN + HB_SYMBOL_NAME_LEN + 5 [vszakats] */

char * hb_procname( int iLevel, char * szName, BOOL bSkipBlock )
{
   long lOffset = hb_stackBaseOffset(), lPrevOffset = 0;
   PHB_ITEM pBase, pSelf;

   while( iLevel-- > 0 && lOffset > 1 )
      lOffset = hb_stackItem( lOffset - 1 )->item.asSymbol.stackbase + 1;

   if( iLevel < 0 )
   {
      if( bSkipBlock && lOffset > 1 )
      {
         char * szTstName = hb_stackItem( lOffset - 1 )->item.asSymbol.value->szName ;
         /* Is it an inline method ? if so back one more ... */
         if( strcmp( szTstName, "__EVAL" ) == 0 )
         {
            lPrevOffset = lOffset;
            lOffset = hb_stackItem( lOffset - 1 )->item.asSymbol.stackbase + 1;
         }
      }

      pBase = hb_stackItem( lOffset - 1 );
      pSelf = hb_stackItem( lOffset );
      if( HB_IS_OBJECT( pSelf ) ) /* it is a method name */
      {
         strcpy( szName, hb_objGetRealClsName( pSelf, pBase->item.asSymbol.value->szName ) );

         if( lPrevOffset )
            strcat( szName, ":(b)" );
         else
            strcat( szName, ":" );

         strcat( szName, pBase->item.asSymbol.value->szName );
      }
      else
      {
         if( lPrevOffset ) /* Back to standart code block */
         {
            lOffset = lPrevOffset;
            pBase = hb_stackItem( lOffset - 1 );
            pSelf = hb_stackItem( lOffset );
         }

         if( strcmp( pBase->item.asSymbol.value->szName, "EVAL" ) == 0 )
         {
            strcpy( szName, "(b)" );

            if( HB_IS_BLOCK( pSelf ) )
               strcat( szName, pSelf->item.asBlock.value->pDefSymb->szName );
            else
               strcat( szName, pBase->item.asSymbol.value->szName );
         }
         else
            strcpy( szName, pBase->item.asSymbol.value->szName );
      }
   }
   else
      strcpy( szName, "" );

   return szName;
}

/* NOTE: szName size must be an at least:
 *          HB_SYMBOL_NAME_LEN + HB_SYMBOL_NAME_LEN + 5
 *       szFile szie must be an at least:
 *          _POSIX_PATH_MAX + 1
 */
BOOL hb_procinfo( int iLevel, char * szName, USHORT * puiLine, char * szFile )
{
   long lOffset = hb_stackBaseOffset();
   PHB_ITEM pBase, pSelf;
   PHB_SYMB pSym;

   while( iLevel-- > 0 && lOffset > 1 )
      lOffset = hb_stackItem( lOffset - 1 )->item.asSymbol.stackbase + 1;

   if( iLevel < 0 )
   {
      pBase = hb_stackItem( lOffset - 1 );
      pSelf = hb_stackItem( lOffset );

      pSym = pBase->item.asSymbol.value;

      if( szName )
      {
         if( HB_IS_OBJECT( pSelf ) ) /* it is a method name */
         {
            strcpy( szName, hb_objGetRealClsName( pSelf, pSym->szName ) );
            strcat( szName, ":" );
            strcat( szName, pSym->szName );
         }
         else
         {
            if( pSym == &hb_symEval || strcmp( pSym->szName, "EVAL" ) == 0 )
            {
               strcpy( szName, "(b)" );

               if( HB_IS_BLOCK( pSelf ) )
                  strcat( szName, pSelf->item.asBlock.value->pDefSymb->szName );
               else
                  strcat( szName, pSym->szName );
            }
            else
               strcpy( szName, pSym->szName );
         }
      }

      if( puiLine )
         * puiLine = pBase->item.asSymbol.lineno;

      if( szFile )
      {
         char * szModule;

         if( ( pSym == &hb_symEval || strcmp( pSym->szName, "EVAL" ) == 0 ) &&
             HB_IS_BLOCK( pSelf ) && pSelf->item.asBlock.value->pDefSymb )
            pSym = pSelf->item.asBlock.value->pDefSymb;
         else if( ( pSym->scope.value & HB_FS_LOCAL ) == 0 )
         {
            if( ( pSym->pDynSym->pSymbol->scope.value & HB_FS_LOCAL ) != 0 )
               pSym = pSym->pDynSym->pSymbol;
            else
               pSym = NULL;
         }
         szModule = hb_vmFindModuleSymbolName( pSym );
         if( szModule )
            strcpy( szFile, szModule );
         else
            szFile[ 0 ] = '\0';
      }

      return TRUE;
   }

   if( szName )
      szName[ 0 ] = '\0';
   if( puiLine )
      * puiLine = 0;
   if( szFile )
      szFile[ 0 ] = '\0';

   return FALSE;
}