forth.h

Go to the documentation of this file.

/*
This program is distributed under the terms of the 'MIT license'. The text
of this licence follows...

Copyright (c) 2005 J.D.Medhurst (a.k.a. Tixy)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

#ifndef FORTH_H
#define FORTH_H

typedef int32_t CELL;

ASSERT_COMPILE(sizeof(CELL)>=sizeof(CELL*)); // CELL must be big enough to store pointers

typedef uint32_t UCELL;

typedef uint8_t CHAR;

#define BITS_PER_CHAR 8

#define CHARS_PER_CELL 4

ASSERT_COMPILE(CHARS_PER_CELL==sizeof(CELL)/sizeof(CHAR)); // Check CHARS_PER_CELL is defined correctly


class ForthIo
    {
public:
    virtual void ConsoleOut(const CHAR* text,UCELL textLength) = 0;

    virtual CELL ConsoleIn() = 0;
public:
    CHAR NewLine[4];
    };


class Forth
    {
public:
    static Forth* Construct(void* memoryStart,size_t memorySize,ForthIo* ioHandler);

    void Reset();

    CELL Quit();

    CELL Execute(CELL xt);

    CELL Evaluate(const CHAR* text,unsigned textLength);

    void Push(const CELL* cells, unsigned numCells);

    const CELL* Pop(unsigned numCells);

    };

 // End of group

#endif