xo-alloc/xo-interpreter/include/xo/interpreter/LocalEnv.hpp

93 lines
3.6 KiB
C++

/** @file LocalEnv.hpp **/
#include "Env.hpp"
#include "CVector.hpp"
#include "xo/alloc/IAlloc.hpp"
#include "xo/expression/LocalSymtab.hpp"
#include <cstddef>
#include <cstdint>
namespace xo {
namespace scm {
/** @class LocalEnv
* @brief Represent a single runtime stack frame for a Schematika function
*
* LocalEnv intended to be used for interpreted functions.
*
* Compiled functions will still likely have stack frames, but need not use the
* @ref LocalEnv class
*
* memory layout:
* ^
* +-----------------------+ |
* | vtable | |
* +-----------------------+ |
* | .parent +------/
* +------------+----------+
* | .slot_v_ | .n_ |
* | +----------+
* | | .v_ +------\
* +------------+----------+ <--/
* | .v_[0] +---------> Object(1)
* +-----------------------+
* . .. .
* +-----------------------+
* | .v_[.n_-1] +---------> Object(n)
* +-----------------------+
**/
class LocalEnv : public Env {
public:
using TaggedPtr = xo::reflect::TaggedPtr;
public:
LocalEnv(gc::IAlloc * mm, gp<LocalEnv> p, const rp<LocalSymtab> & s, std::size_t n);
/** create frame using allocator @p mm,
* with parent @p p and exactly @p n_slot object pointers.
* variable types are taken from symbol table @p s.
**/
static gp<LocalEnv> make(gc::IAlloc * mm,
gp<LocalEnv> p,
const rp<LocalSymtab> & s,
std::size_t n_slot);
/** reflect LocalEnv object representation **/
static void reflect_self();
gp<LocalEnv> parent() const { return parent_; }
std::size_t size() const { return slot_v_.size(); }
gp<Object> operator[](std::size_t i) const { return slot_v_[i]; }
gp<Object> & operator[](std::size_t i) { return slot_v_[i]; }
// inherited from Env..
virtual bool local_contains_var(const std::string & vname) const final override;
/** LocalEnv policy is that variable can be established once only.
* For example function arguments must all have distinct names
**/
virtual void establish_var(bp<Variable> v) final override;
// inherited from Object..
virtual TaggedPtr self_tp() const final override;
virtual void display(std::ostream & os) const final override;
virtual std::size_t _shallow_size() const final override;
virtual Object * _shallow_copy(gc::IAlloc * mm) const final override;
virtual std::size_t _forward_children(gc::IAlloc * /*gc*/) final override;
private:
/** parent stack frame **/
gp<LocalEnv> parent_;
/** origin symbol table. records variable names and bindings.
* for a binding path p with leaf slot index j = p.j_slot_:
* @c slot_v_[j] holds value associated with variable @c symtab_->argv_[j]
**/
rp<LocalSymtab> symtab_;
/** environment contents **/
CVector<gp<Object>> slot_v_;
};
} /*namespace scm*/
} /*namespace xo*/
/* end LocalEnv.hpp */