You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

54 lines
2.1 KiB
C++

// sprit-forth: A portable subroutine-threaded Forth.
// Copyright (C) 2024 Clyne Sullivan <clyne@bitgloo.com>
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Library General Public License as published by
// the Free Software Foundation; either version 2 of the License, or (at your
// option) any later version.
//
// This library 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 Library General Public License for
// more details.
//
// You should have received a copy of the GNU Library General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
#ifndef CORE_HPP
#define CORE_HPP
#include "executor.hpp"
#include "state.hpp"
/**
* To be implemented by the user: Adds available input to the source buffer.
* @see addkey(int k)
*/
extern void getinput();
/**
* "Function exit" word, analagous to a function's return statement.
*/
constexpr auto fexit = WordWrap<[] {
Exec.ip = reinterpret_cast<FuncList>(Forth.rpop());
}>;
void jump(FuncList ip); /** Jumps to the given instruction pointer. */
void compileliteral(); /** Compiles LITERAL into the current definition. */
bool haskey(); /** Returns true if the source buffer is not empty. */
void addkey(int k); /** Adds the given character to the source buffer. */
int key(); /** Gets the next key available from the source buffer. */
Cell *comma(Cell n); /** Stores `n` to HERE++, returns `n`'s storage. */
Addr aligned(Addr addr); /** Aligns the given address and returns it. */
void align(); /** Aligns HERE to the next Cell boundary. */
void word(); /** Definition of WORD. */
void colon(); /** Begins definition of a new word. */
void semic(); /** Ends the current word definition which becomes new LATEST. */
void tick(); /** Gets the execution token for the source buffer's next word. */
#endif // CORE_HPP