Files
harbour-core/harbour/include/hbxvm.h
Przemyslaw Czerpak 8bef490815 2006-08-19 01:10 UTC+0200 Przemyslaw Czerpak (druzus/at/priv.onet.pl)
* harbour/include/hbapi.h
    * moved HB_STACK_STATE declaration from hbstack.h to hbapi.h
      it's covered by _HB_API_INTERNAL_ macro so it should not
      effect 3-rd party code
    * modified hb_struSymbol structure:
         LONG stackbase
      replaced by:
         PHB_STACK_STATE stackstate
      this modification allows to keepadditional information bound with
      function call stack accessible from different HVM modules.
      Now it's used by memvars code to keep/update PRIVATE variables
      stack pointers. I plan to store in HB_STACK_STATE structure
      information additional information for classes code like super
      casting or instance variables offsets in new OOP model I'm working on.
      It can be also used by debugger code to retrieve some informations
      about executed functions without active updating by main HVM loop.
    + added hb_memvarsClear() - cleanly clears all PRIVATE and PUBLIC
      variables
    + added hb_memvarUpdatePrivatesBase() - updates PRIVATE stack base
      offset so PRIVATE variables created in current function/procedure
      will not be removed when it returns
    - removed hb_memvarsRelease() and hb_memvarValueNew()

  * harbour/include/hbstack.h
    + added hb_stackClearMevarsBase() - helper function for hb_memvarsClear()
      clears PRIVATE stack offsets in executed functions
    * changed to static offset from int to long - in different places we
      were using int or long in HVM so I cleaned the HVM code to always
      operate on the same type

  * harbour/source/vm/estack.c
    * set/restore PRIVATE stack base offset in hb_stackNewFrame()/
      hb_stackOldFrame()
    * updated for new HB_IT_SYMBOL structure

  * harbour/source/vm/hvm.c
    ! removed setting/restoring PRIVATE stack base offset in hb_vmExecute()
      It make code like:
         eval(&("{||VAR:=1}"))
      Clipper compatible
    * updated for new HB_IT_SYMBOL structure
    * changed order of execution exit procedures for clean memvars removing
      and future destructors execution. I'll describe it better when I'll
      add destructors.

  * harbour/source/vm/memvars.c
    ! fixed CLEAR MEMORY - now this function should be safe in Harbour
      It's not exactly compatible with Clipper because I intentionally
      didn't replicated some Clipper bugs like possible memory corruption.
    + added hb_memvarsClear() - cleanly clears all PRIVATE and PUBLIC
      variables
    + added hb_memvarUpdatePrivatesBase() - updates PRIVATE stack base
      offset so PRIVATE variables created in current function/procedure
      will not be removed when it returns
    ! fixed releasing PUBLIC and PRIVATE variables which were passed by
      reference and are still active on HVM stack or in codeblocks as
      detached locals (see: hb_memvarDetachDynSym())
    * modified hb_memvarFindSymbol() to be more Clipper compatible
    % optimized hb_memvarRelease() to operate or PHB_DYNS instead of
      string comparison and not make linear dynamic symbol scan for
      PUBLIC or not existing symbols
    - removed hb_memvarReleasePublic()

  * harbour/include/hbvmpub.h
  * harbour/include/hbxvm.h
  * harbour/source/compiler/gencc.c
  * harbour/source/vm/classes.c
  * harbour/source/vm/debug.c
  * harbour/source/vm/itemapi.c
  * harbour/source/vm/pcount.c
  * harbour/source/vm/proc.c
  * harbour/source/vm/pvalue.c
    * updated for the above modifications

  * harbour/source/rtl/memvarbl.prg
  * harbour/source/rtl/menuto.prg
    * use __mvEXIST( cMemvar ) instead of __mvSCOPE( cMemvar ) > HB_MV_ERROR
      __mvEXIST() is much faster function

  * harbour/source/rtl/type.c
    * execute hb_memvarUpdatePrivatesBase() after macro type checking.
      This should not be necessary but we are not Clipper compatible here
      and this is work around for difference in our TYPE() implementation.
      Clipper for:
         ? TYPE("VAR:=1")
      create PUBLIC variable VAR when [x]Harbour PRIVATE one.
      Should we try to make it Clipper compatible?

   The above should fix problems reported with memvars. We are not 100%
   Clipper compatible but unlike in Clipper we cannot break VM internals
   using some operation on references to memvars and detached locals
   and/or RELEASE.../ CLEAR MEMORY. This modifications should be intensively
   tested. If you will find any problems with current code please inform me.
   I'd like to hear your opinions about memvars created by TYPE() (see above).
   Should we change it? It may not be very easy operation - we will have to
   change macro compiler and add new PCODE for that.
2006-08-18 23:12:38 +00:00

231 lines
13 KiB
C

/*
* $Id$
*/
/*
* Harbour Project source code:
* Header file for the Internal Terminal API
*
* Copyright 2006 Przemyslaw Czerpak < druzus /at/ priv.onet.pl >
* 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.
*
*/
/* NOTE: The declaration of hb_gtSetPos(), hb_gtGetPos(), hb_gtWrite(),
hb_gtWriteAt(), hb_gtRepChar(), hb_gtBox(), hb_gtBoxS(), hb_gtBoxD()
hb_gtInit() differs in parameter types from the original CA-Cl*pper
versions. [vszakats] */
#ifndef HB_XVM_H_
#define HB_XVM_H_
#include "hbapi.h"
#include "hbapiitm.h"
#include "hbvm.h"
#include "hbstack.h"
HB_EXTERN_BEGIN
/*
* Functions below which return BOLL value can cause error handler
* executing so we have to check for break request flag. The return
* value is TRUE when break request is set.
* other functions does not execute error handler and we do not have
* to check HVM state so they are simply declared as void.
*/
extern HB_EXPORT void hb_xvmExitProc( void );
extern HB_EXPORT void hb_xvmSeqBegin( void );
extern HB_EXPORT BOOL hb_xvmSeqEnd( void );
extern HB_EXPORT BOOL hb_xvmSeqEndTest( void );
extern HB_EXPORT BOOL hb_xvmSeqRecover( void );
extern HB_EXPORT BOOL hb_xvmEnumStart( BYTE, BYTE ); /* prepare FOR EACH loop */
extern HB_EXPORT BOOL hb_xvmEnumNext( void ); /* increment FOR EACH loop counter */
extern HB_EXPORT BOOL hb_xvmEnumPrev( void ); /* decrement FOR EACH loop counter */
extern HB_EXPORT void hb_xvmEnumEnd( void ); /* rewind the stack after FOR EACH loop counter */
extern HB_EXPORT void hb_xvmWithObjectStart( void ); /* prepare WITH OBJECT statement */
extern HB_EXPORT void hb_xvmWithObjectEnd( void ); /* rewind the stack after normal WITH OBJECT */
extern HB_EXPORT void hb_xvmWithObjectMessage( PHB_SYMB ); /* send WITH OBJECT message to current WITH OBJECT control variable */
extern HB_EXPORT void hb_xvmSetLine( USHORT uiLine ); /* set .prg line number information */
extern HB_EXPORT void hb_xvmFrame( int iLocals, int iParams ); /* increases the stack pointer for the amount of locals and params suplied */
extern HB_EXPORT void hb_xvmSFrame( PHB_SYMB pSymbol );
extern HB_EXPORT void hb_xvmStatics( PHB_SYMB pSymbol, USHORT uiStatics );
extern HB_EXPORT void hb_xvmParameter( PHB_SYMB pSymbol, int iParams );
extern HB_EXPORT void hb_xvmRetValue( void ); /* pops the latest stack value into stack.Return */
extern HB_EXPORT BOOL hb_xvmDo( USHORT uiParams );
extern HB_EXPORT BOOL hb_xvmFunction( USHORT uiParams );
extern HB_EXPORT BOOL hb_xvmSend( USHORT uiParams );
extern HB_EXPORT void hb_xvmPushStatic( USHORT uiStatic );
extern HB_EXPORT void hb_xvmPushStaticByRef( USHORT uiStatic );
extern HB_EXPORT void hb_xvmPopStatic( USHORT uiStatic );
extern HB_EXPORT BOOL hb_xvmPushVariable( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPopVariable( PHB_SYMB pSymbol );
extern HB_EXPORT void hb_xvmPushBlock( const BYTE * pCode, PHB_SYMB pSymbols ); /* creates a codeblock */
extern HB_EXPORT void hb_xvmPushBlockShort( const BYTE * pCode, PHB_SYMB pSymbols ); /* creates a codeblock */
extern HB_EXPORT void hb_xvmPushSelf( void );
extern HB_EXPORT void hb_xvmPushLocal( SHORT iLocal ); /* pushes the containts of a local onto the stack */
extern HB_EXPORT void hb_xvmPushLocalByRef( SHORT iLocal ); /* pushes a local by refrence onto the stack */
extern HB_EXPORT void hb_xvmPopLocal( SHORT iLocal ); /* pops the stack latest value onto a local */
extern HB_EXPORT BOOL hb_xvmPushField( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPopField( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPushMemvar( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPushMemvarByRef( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPopMemvar( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPushAliasedField( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPopAliasedField( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPushAliasedVar( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPopAliasedVar( PHB_SYMB pSymbol );
extern HB_EXPORT BOOL hb_xvmPushAlias( void );
extern HB_EXPORT BOOL hb_xvmPopAlias( void ); /* select the workarea using a given item or a substituted value */
extern HB_EXPORT BOOL hb_xvmPopLogical( BOOL * ); /* pops the stack latest value and returns its logical value */
extern HB_EXPORT BOOL hb_xvmSwapAlias( void ); /* swaps items on the eval stack and pops the workarea number */
extern HB_EXPORT BOOL hb_xvmLocalAddInt( int iLocal, LONG lAdd ); /* add integer to given local variable */
extern HB_EXPORT BOOL hb_xvmAnd( void );
extern HB_EXPORT BOOL hb_xvmOr( void );
extern HB_EXPORT BOOL hb_xvmNot( void );
extern HB_EXPORT BOOL hb_xvmNegate( void );
extern HB_EXPORT BOOL hb_xvmPower( void );
extern HB_EXPORT void hb_xvmDuplicate( void );
extern HB_EXPORT void hb_xvmDuplTwo( void );
extern HB_EXPORT BOOL hb_xvmForTest( void );
extern HB_EXPORT void hb_xvmFuncPtr( void );
extern HB_EXPORT BOOL hb_xvmEqual( BOOL fExact ); /* checks if the two latest values on the stack are equal, removes both and leaves result */
extern HB_EXPORT BOOL hb_xvmNotEqual( void ); /* checks if the two latest values on the stack are not equal, removes both and leaves result */
extern HB_EXPORT BOOL hb_xvmLess( void ); /* checks if the latest - 1 value is less than the latest, removes both and leaves result */
extern HB_EXPORT BOOL hb_xvmLessEqual( void ); /* checks if the latest - 1 value is less than or equal the latest, removes both and leaves result */
extern HB_EXPORT BOOL hb_xvmGreater( void ); /* checks if the latest - 1 value is greater than the latest, removes both and leaves result */
extern HB_EXPORT BOOL hb_xvmGreaterEqual( void ); /* checks if the latest - 1 value is greater than or equal the latest, removes both and leaves result */
extern HB_EXPORT BOOL hb_xvmInstring( void ); /* check whether string 1 is contained in string 2 */
extern HB_EXPORT BOOL hb_xvmPlus( void ); /* sums the latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT BOOL hb_xvmPlusEq( void );
extern HB_EXPORT BOOL hb_xvmPlusEqPop( void );
extern HB_EXPORT BOOL hb_xvmMinus( void ); /* substracts the latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT BOOL hb_xvmMinusEq( void );
extern HB_EXPORT BOOL hb_xvmMinusEqPop( void );
extern HB_EXPORT BOOL hb_xvmMult( void ); /* multiplies the latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT BOOL hb_xvmMultEq( void );
extern HB_EXPORT BOOL hb_xvmMultEqPop( void );
extern HB_EXPORT BOOL hb_xvmDivide( void ); /* divides the latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT BOOL hb_xvmDivEq( void );
extern HB_EXPORT BOOL hb_xvmDivEqPop( void );
extern HB_EXPORT BOOL hb_xvmModulus( void ); /* calculates the modulus of latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT BOOL hb_xvmInc( void );
extern HB_EXPORT BOOL hb_xvmDec( void );
extern HB_EXPORT void hb_xvmArrayDim( USHORT uiDimensions ); /* generates an uiDimensions Array and initialize those dimensions from the stack values */
extern HB_EXPORT void hb_xvmArrayGen( ULONG ulElements ); /* generates an ulElements Array and fills it from the stack values */
extern HB_EXPORT BOOL hb_xvmArrayPush( void ); /* pushes an array element to the stack, removing the array and the index from the stack */
extern HB_EXPORT BOOL hb_xvmArrayPop( void ); /* pops a value from the stack */
extern HB_EXPORT void hb_xvmLocalName( USHORT uiLocal, char * szLocalName );
extern HB_EXPORT void hb_xvmStaticName( BYTE bIsGlobal, USHORT uiStatic, char * szStaticName );
extern HB_EXPORT void hb_xvmModuleName( char * szModuleName );
extern HB_EXPORT BOOL hb_xvmMacroDo( USHORT uiArgSets );
extern HB_EXPORT BOOL hb_xvmMacroFunc( USHORT uiArgSets );
extern HB_EXPORT BOOL hb_xvmMacroArrayGen( USHORT uiArgSets );
extern HB_EXPORT BOOL hb_xvmMacroPush( BYTE bFlags );
extern HB_EXPORT BOOL hb_xvmMacroPushRef( void );
extern HB_EXPORT BOOL hb_xvmMacroPushIndex( BYTE bFlags );
extern HB_EXPORT BOOL hb_xvmMacroPushArg( PHB_SYMB pSymbol, BYTE bFlags );
extern HB_EXPORT BOOL hb_xvmMacroPushList( BYTE bFlags );
extern HB_EXPORT BOOL hb_xvmMacroPushAliased( BYTE bFlags );
extern HB_EXPORT BOOL hb_xvmMacroPushPare( BYTE bFlags );
extern HB_EXPORT BOOL hb_xvmMacroPop( BYTE bFlags );
extern HB_EXPORT BOOL hb_xvmMacroPopAliased( BYTE bFlags );
extern HB_EXPORT BOOL hb_xvmMacroSymbol( void );
extern HB_EXPORT BOOL hb_xvmMacroText( void );
extern HB_EXPORT void hb_xvmPushDouble( double dNumber, int iWidth, int iDec );
#ifdef HB_LONG_LONG_OFF
extern HB_EXPORT void hb_xvmPushLongLong( double dNumber );
#else
extern HB_EXPORT void hb_xvmPushLongLong( LONGLONG llNumber );
#endif
#define hb_xvmPushLogical( f ) hb_vmPushLogical( f )
#define hb_xvmPushInteger( i ) hb_vmPushInteger( i )
#define hb_xvmPushLong( l ) hb_vmPushLong( l )
#define hb_xvmPushNil() hb_vmPushNil()
#define hb_xvmPushStringConst( psz, ul ) hb_vmPushStringPcode( psz, ul )
#define hb_xvmPushSymbol( p ) hb_vmPushSymbol( p )
#define hb_xvmPushDate( p ) hb_vmPushDate( p )
/*
* additional multi PCODE operations
*/
extern HB_EXPORT BOOL hb_xvmArrayItemPush( ULONG ulIndex );
extern HB_EXPORT BOOL hb_xvmArrayItemPop( ULONG ulIndex );
extern HB_EXPORT BOOL hb_xvmMultByInt( LONG lValue );
extern HB_EXPORT BOOL hb_xvmDivideByInt( LONG lValue );
extern HB_EXPORT BOOL hb_xvmAddInt( LONG lValue );
extern HB_EXPORT void hb_xvmLocalSetInt( int iLocal, LONG lValue );
/*extern HB_EXPORT void hb_xvmLocalSetStr( int iLocal, const char * pValue, ULONG ulLen );*/
extern HB_EXPORT void hb_xvmPushFuncSymbol( PHB_SYMB pSym );
extern HB_EXPORT BOOL hb_xvmLessThenInt( LONG lValue );
extern HB_EXPORT BOOL hb_xvmLessThenIntIs( LONG lValue, BOOL *fValue );
extern HB_EXPORT BOOL hb_xvmLessEqualThenInt( LONG lValue );
extern HB_EXPORT BOOL hb_xvmLessEqualThenIntIs( LONG lValue, BOOL *fValue );
extern HB_EXPORT BOOL hb_xvmGreaterThenInt( LONG lValue );
extern HB_EXPORT BOOL hb_xvmGreaterThenIntIs( LONG lValue, BOOL *fValue );
extern HB_EXPORT BOOL hb_xvmGreaterEqualThenInt( LONG lValue );
extern HB_EXPORT BOOL hb_xvmGreaterEqualThenIntIs( LONG lValue, BOOL *fValue );
extern HB_EXPORT BOOL hb_xvmEqualInt( LONG lValue );
extern HB_EXPORT BOOL hb_xvmEqualIntIs( LONG lValue, BOOL *fValue );
extern HB_EXPORT BOOL hb_xvmNotEqualInt( LONG lValue );
extern HB_EXPORT BOOL hb_xvmNotEqualIntIs( LONG lValue, BOOL *fValue );
extern HB_EXPORT BOOL hb_xvmLocalAdd( int iLocal );
extern HB_EXPORT BOOL hb_xvmStaticAdd( USHORT uiStatic );
extern HB_EXPORT BOOL hb_xvmMemvarAdd( PHB_SYMB pSymbol );
HB_EXTERN_END
#endif /* HB_XVM_H_ */