/* * Header file for the Virtual Machine API * * Copyright 1999 Antonio Linares * * 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 program; see the file LICENSE.txt. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, * Boston, MA 02110-1301 USA (or visit https://www.gnu.org/licenses/). * * 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. * */ #ifndef HB_VM_H_ #define HB_VM_H_ #include "hbapi.h" HB_EXTERN_BEGIN /* Harbour virtual machine init/exit functions */ extern HB_EXPORT void hb_vmInit( HB_BOOL bStartMainProc ); extern HB_EXPORT int hb_vmQuit( void ); /* Immediately quits the virtual machine, return ERRORLEVEL code */ /* registration AtInit, AtExit and AtQuit functions. * AtInit functions are executed just before .prg INIT procedures. * AtExit functions are executed just after .prg EXIT procedures. * AtQuit functions are executed after deallocating all HVM items and * disabling .prg destructors. They can make final cleanup at C level * but should not reenter HVM. */ extern HB_EXPORT void hb_vmAtInit( HB_INIT_FUNC pFunc, void * cargo ); extern HB_EXPORT void hb_vmAtExit( HB_INIT_FUNC pFunc, void * cargo ); extern HB_EXPORT void hb_vmAtQuit( HB_INIT_FUNC pFunc, void * cargo ); /* Harbour virtual machine functions */ extern HB_EXPORT void hb_vmExecute( const HB_BYTE * pCode, PHB_SYMB pSymbols ) HB_FLATTEN_ATTR; /* invokes the virtual machine */ extern HB_EXPORT PHB_SYMB hb_vmProcessSymbols( PHB_SYMB pSymbols, HB_USHORT uiSymbols, const char * szModuleName, HB_ULONG ulID, HB_USHORT uiPcodeVer ); /* module symbols initialization with extended information */ extern HB_EXPORT PHB_SYMB hb_vmProcessDynLibSymbols( PHB_SYMB pSymbols, HB_USHORT uiSymbols, const char * szModuleName, HB_ULONG ulID, HB_USHORT uiPcodeVer ); /* module symbols initialization with extended information */ #ifdef _HB_API_INTERNAL_ typedef struct _HB_SYMBOLS { PHB_SYMB pModuleSymbols; /* pointer to module symbol table */ HB_USHORT uiModuleSymbols; /* number of symbols on that table */ HB_USHORT uiStaticsOffset; /* offset of statics base symbol */ struct _HB_SYMBOLS * pNext; /* pointer to the next SYMBOLS structure */ HB_SYMBOLSCOPE hScope; /* scope collected from all symbols in module used to speed initialization code */ void * hDynLib; /* handler to dynamic library */ HB_BOOL fAllocated; /* the symbol table is dynamically allocated and should be freed on HVM exit */ HB_BOOL fActive; /* the symbol table is currently active */ HB_BOOL fInitStatics; /* static initialization should be executed */ char * szModuleName; /* module name */ HB_ULONG ulID; /* module unique identifier */ } HB_SYMBOLS, * PHB_SYMBOLS; /* structure to keep track of all modules symbol tables */ extern PHB_SYMBOLS hb_vmRegisterSymbols( PHB_SYMB pModuleSymbols, HB_USHORT uiSymbols, const char * szModuleName, HB_ULONG ulID, HB_BOOL fDynLib, HB_BOOL fClone, HB_BOOL fOverLoad ); extern HB_BOOL hb_vmLockModuleSymbols( void ); extern void hb_vmUnlockModuleSymbols( void ); extern void hb_vmFreeSymbols( PHB_SYMBOLS pSymbols ); extern void hb_vmBeginSymbolGroup( void * hDynLib, HB_BOOL fClone ); extern void hb_vmInitSymbolGroup( void * hNewDynLib, int argc, const char * argv[] ); extern void hb_vmExitSymbolGroup( void * hDynLib ); extern PHB_SYMB hb_vmFindFuncSym( const char * szFuncName, void * hDynLib ); extern const char * hb_vmFindModuleSymbolName( PHB_SYMB pSym ); extern HB_BOOL hb_vmFindModuleSymbols( PHB_SYMB pSym, PHB_SYMB * pSymbols, HB_USHORT * puiSymbols ); extern PHB_SYMB hb_vmGetRealFuncSym( PHB_SYMB pSym ); extern HB_EXPORT void hb_vmSetFunction( PHB_SYMB pOldSym, PHB_SYMB pNewSym ); extern HB_EXPORT void hb_vmSetDynFunc( PHB_DYNS pDynSym ); extern void hb_vmEnumRelease( PHB_ITEM pBase, PHB_ITEM pValue ); extern HB_BOOL hb_vmMsgReference( PHB_ITEM pObject, PHB_DYNS pMessage, PHB_DYNS pAccMsg ); /* create extended message reference */ extern void hb_vmUpdateAllocator( PHB_ALLOCUPDT_FUNC pFunc, int iCount ); extern void hb_vmEval( HB_USHORT uiParams ); #endif extern void hb_vmSetExceptionHandler( void ); extern void hb_vmUnsetExceptionHandler( void ); extern HB_EXPORT void hb_vmSymbolInit_RT( void ); /* initialization of runtime support symbols */ /* Harbour virtual machine escaping API */ extern HB_EXPORT void hb_vmRequestDebug( void ); extern HB_EXPORT void hb_vmRequestBreak( PHB_ITEM pItem ); extern HB_EXPORT void hb_vmRequestCancel( void ); extern HB_EXPORT void hb_vmRequestQuit( void ); extern HB_EXPORT void hb_vmRequestEndProc( void ); extern HB_EXPORT HB_USHORT hb_vmRequestQuery( void ); extern HB_EXPORT HB_BOOL hb_vmRequestReenter( void ); extern HB_EXPORT void hb_vmRequestRestore( void ); extern HB_EXPORT HB_BOOL hb_vmRequestReenterExt( void ); extern HB_EXPORT HB_BOOL hb_vmTryEval( PHB_ITEM * pResult, PHB_ITEM pItem, HB_ULONG ulPCount, ... ); extern HB_EXPORT HB_BOOL hb_vmIsActive( void ); extern HB_EXPORT HB_BOOL hb_vmIsReady( void ); extern HB_EXPORT HB_BOOL hb_vmSetKeyPool( HB_BOOL fEnable ); /* Return values of hb_vmRequestQuery() */ #define HB_QUIT_REQUESTED 1 /* immediately quit the application */ #define HB_BREAK_REQUESTED 2 /* break to nearest RECOVER/END sequence */ #define HB_ENDPROC_REQUESTED 4 /* immediately return from procedure (error handler in macro evaluation) */ #ifdef _HB_API_INTERNAL_ #define HB_VMSTACK_REQUESTED 0x100 /* internal flag to signal thread local stack */ #endif /* Public PCode functions */ /* Execution */ extern HB_EXPORT void hb_vmDo( HB_USHORT uiParams ); /* invoke the virtual machine */ extern HB_EXPORT void hb_vmProc( HB_USHORT uiParams ); /* executes a function or procedure */ extern HB_EXPORT void hb_vmFunction( HB_USHORT uiParams ); /* executes a function */ extern HB_EXPORT void hb_vmSend( HB_USHORT uiParams ); /* sends a message to an object */ extern HB_EXPORT PHB_ITEM hb_vmEvalBlock( PHB_ITEM pBlockItem ); /* executes passed codeblock with no arguments */ /* executes passed codeblock with variable number of arguments */ extern HB_EXPORT PHB_ITEM hb_vmEvalBlockV( PHB_ITEM pBlockItem, HB_ULONG ulArgCount, ... ); extern HB_EXPORT PHB_ITEM hb_vmEvalBlockOrMacro( PHB_ITEM pItem ); /* executes codeblock or macro pointed by given item */ extern HB_EXPORT void hb_vmDestroyBlockOrMacro( PHB_ITEM pItem ); /* destroy codeblock or macro in given item */ extern HB_EXPORT PHB_ITEM hb_vmCompileMacro( const char * szExpr, PHB_ITEM pDest ); /* compile given expression and return macro pointer item or NULL */ /* Push */ extern HB_EXPORT void hb_vmPush( PHB_ITEM pItem ); /* pushes a generic item onto the stack */ extern HB_EXPORT void hb_vmPushNil( void ); /* in this case it places nil at self */ extern HB_EXPORT void hb_vmPushNumber( double dNumber, int iDec ); /* pushes a number on to the stack and decides if it is integer, long or double */ extern HB_EXPORT void hb_vmPushInteger( int iNumber ); /* pushes a integer number onto the stack */ extern HB_EXPORT void hb_vmPushLong( long lNumber ); /* pushes a long number onto the stack */ extern HB_EXPORT void hb_vmPushDouble( double dNumber, int iDec ); /* pushes a double number onto the stack */ extern HB_EXPORT void hb_vmPushSize( HB_ISIZ nNumber ); /* pushes a HB_SIZE number onto the stack */ extern HB_EXPORT void hb_vmPushNumInt( HB_MAXINT nNumber ); /* pushes a number on to the stack and decides if it is integer or HB_MAXINT */ extern HB_EXPORT void hb_vmPushLogical( HB_BOOL bValue ); /* pushes a logical value onto the stack */ extern HB_EXPORT void hb_vmPushString( const char * szText, HB_SIZE length ); /* pushes a string on to the stack */ extern HB_EXPORT void hb_vmPushStringPcode( const char * szText, HB_SIZE length ); /* pushes a string from pcode on to the stack */ extern HB_EXPORT void hb_vmPushDate( long lDate ); /* pushes a long date onto the stack */ extern HB_EXPORT void hb_vmPushTimeStamp( long lJulian, long lMilliSec ); /* pushes two long value as timestamp onto the stack */ extern HB_EXPORT void hb_vmPushSymbol( PHB_SYMB pSym ); /* pushes a function pointer onto the stack */ extern HB_EXPORT void hb_vmPushDynSym( PHB_DYNS pDynSym ); /* pushes a function/method pointer onto the stack */ extern HB_EXPORT void hb_vmPushEvalSym( void ); /* pushes a codeblock eval symbol onto the stack */ extern HB_EXPORT void hb_vmPushPointer( void * pPointer ); /* push an item of HB_IT_POINTER type */ extern HB_EXPORT void hb_vmPushPointerGC( void * pPointer ); /* push an item of GC HB_IT_POINTER type */ extern HB_EXPORT void hb_vmPushItemRef( PHB_ITEM pItem ); /* push item reference */ extern HB_EXPORT HB_BOOL hb_vmIsMt( void ); /* return HB_TRUE if HVM is compiled with thread support */ extern HB_EXPORT void hb_vmLock( void ); /* lock VM blocking GC execution by other threads */ extern HB_EXPORT void hb_vmLockForce( void ); /* lock VM blocking GC execution by other threads, ignore GC request */ extern HB_EXPORT void hb_vmUnlock( void ); /* unlock VM, allow GC execution */ #ifdef _HB_API_INTERNAL_ extern HB_EXPORT HB_BOOL hb_vmSuspendThreads( HB_BOOL fWait ); /* (try to) stop all threads except current one */ extern HB_EXPORT void hb_vmResumeThreads( void ); /* unblock execution of threads stopped by hb_vmSuspendThreads() */ #endif extern HB_EXPORT HB_BOOL hb_vmThreadRegister( void * ); /* Register new thread without local thread HVM stack */ extern HB_EXPORT void hb_vmThreadRelease( void * ); /* Remove registered thread which does not have local thread HVM stack yet */ extern HB_EXPORT void hb_vmThreadInit( void * ); /* allocate local thread HVM stack */ extern HB_EXPORT void hb_vmThreadQuit( void ); /* destroy local thread HVM stack */ extern HB_EXPORT void hb_vmThreadQuitRequest( void * ); /* send QUIT request to given thread */ extern HB_EXPORT void hb_vmWaitForThreads( void ); /* wait for all threads to terminate can be called only by main HVM thread */ extern HB_EXPORT void hb_vmTerminateThreads( void ); /* send QUIT request to all threads except current one and wait for their termination, should be called only by main HVM thread */ extern HB_EXPORT HB_BOOL hb_vmThreadIsMain( void * ); /* check if given or current thread is main HVM thread */ extern HB_EXPORT PHB_ITEM hb_vmThreadStart( HB_ULONG ulAttr, PHB_CARGO_FUNC pThreadFunc, void * cargo ); /* create new thread with HVM stack */ extern HB_EXPORT void * hb_vmThreadState( void ); HB_EXTERN_END #endif /* HB_VM_H_ */