V25 with 64-bit support

[pforth] / csrc / pforth.h

/* @(#) pforth.h 98/01/26 1.2 */\r
#ifndef _pforth_h\r
#define _pforth_h\r
\r
/***************************************************************\r
** Include file for pForth, a portable Forth based on 'C'\r
**\r
** This file is included in any application that uses pForth as a tool.\r
**\r
** Author: Phil Burk\r
** Copyright 1994 3DO, Phil Burk, Larry Polansky, David Rosenboom\r
**\r
** The pForth software code is dedicated to the public domain,\r
** and any third party may reproduce, distribute and modify\r
** the pForth software code or any derivative works thereof\r
** without any compensation or license.  The pForth software\r
** code is provided on an "as is" basis without any warranty\r
** of any kind, including, without limitation, the implied\r
** warranties of merchantability and fitness for a particular\r
** purpose and their equivalents under the laws of any jurisdiction.\r
**\r
**\r
***************************************************************/\r
\r
/* Define stubs for data types so we can pass pointers but not touch inside. */\r
typedef void *PForthTask;\r
typedef void *PForthDictionary;\r
\r
#include <stdint.h>\r
/* Integer types for Forth cells, signed and unsigned: */\r
typedef intptr_t cell_t;\r
typedef uintptr_t ucell_t;\r
\r
typedef ucell_t ExecToken;              /* Execution Token */\r
typedef cell_t ThrowCode;\r
\r
#ifdef __cplusplus\r
extern "C" {\r
#endif\r
\r
/* Main entry point to pForth. */\r
cell_t pfDoForth( const char *DicName, const char *SourceName, cell_t IfInit );\r
\r
/* Turn off messages. */\r
void  pfSetQuiet( cell_t IfQuiet );\r
\r
/* Query message status. */\r
cell_t  pfQueryQuiet( void );\r
\r
/* Send a message using low level I/O of pForth */\r
void  pfMessage( const char *CString );\r
\r
/* Create a task used to maintain context of execution. */\r
PForthTask pfCreateTask( cell_t UserStackDepth, cell_t ReturnStackDepth );\r
\r
/* Establish this task as the current task. */\r
void  pfSetCurrentTask( PForthTask task );\r
\r
/* Delete task created by pfCreateTask */\r
void  pfDeleteTask( PForthTask task );\r
\r
/* Build a dictionary with all the basic kernel words. */\r
PForthDictionary pfBuildDictionary( cell_t HeaderSize, cell_t CodeSize );\r
\r
/* Create an empty dictionary. */\r
PForthDictionary pfCreateDictionary( cell_t HeaderSize, cell_t CodeSize );\r
\r
/* Load dictionary from a file. */\r
PForthDictionary pfLoadDictionary( const char *FileName, ExecToken *EntryPointPtr );\r
\r
/* Load dictionary from static array in "pfdicdat.h". */\r
PForthDictionary pfLoadStaticDictionary( void );\r
\r
/* Delete dictionary data. */\r
void  pfDeleteDictionary( PForthDictionary dict );\r
\r
/* Execute the pForth interpreter. Yes, QUIT is an odd name but it has historical meaning. */\r
ThrowCode pfQuit( void );\r
\r
/* Execute a single execution token in the current task and return 0 or an error code. */\r
int pfCatch( ExecToken XT );\r
 \r
/* Include the given pForth source code file. */\r
ThrowCode pfIncludeFile( const char *FileName );\r
\r
/* Execute a Forth word by name. */\r
ThrowCode  pfExecIfDefined( const char *CString );\r
\r
#ifdef __cplusplus\r
}   \r
#endif\r
\r
#endif  /* _pforth_h */\r