path: root/types.h

#ifndef TYPES_H
#define TYPES_H

#include "model.h"

#include <string>
#include <list>
#include <map>
#include <vector>
#include <set>
#include <gmpxx.h>

using std::string;

const int CLS_PROM_OBJ = 1 << 9;
const int CLS_SYM_OBJ = 1 << 2;
const int CLS_NUM_OBJ = 1 << 4;
const int CLS_BOOL_OBJ = 1 << 5;
const int CLS_CHAR_OBJ = 1 << 6;
const int CLS_STR_OBJ = 1 << 7;
const int CLS_VECT_OBJ = 1 << 8;

const int CLS_OPT_OBJ = 1 << 3;
const int CLS_CONT_OBJ = 1 << 9;
const int CLS_ENVT_OBJ = 1 << 10;

static const int NUM_LVL_COMP = 0;
static const int NUM_LVL_REAL = 1;
static const int NUM_LVL_RAT = 2;
static const int NUM_LVL_INT = 3;

typedef std::vector<EvalObj*> EvalObjVec;
typedef std::map<string, EvalObj*> Str2EvalObj;
typedef EvalObj* (*BuiltinProc)(Pair *, const string &);

class PairReprCons;
/** @class Pair
 * Pair construct, which can be used to represent a list, or further
 * more, a syntax tree
 * (car . cdr) in Scheme
 */
class Pair : public Container {/*{{{*/
    public:
        EvalObj *car;                   /**< car (as in Scheme) */
        EvalObj *cdr;                   /**< cdr (as in Scheme) */
        /** The next branch in effect (make sense only in evaluation) */
        Pair* next;

        Pair(EvalObj *car, EvalObj *cdr);   /**< Create a Pair (car . cdr) */
        ~Pair();                            /**< The destructor */
        ReprCons *get_repr_cons();
        void gc_decrement();
        void gc_trigger(EvalObj ** &tail);
};/*}}}*/

/** @class EmptyList
 * The empty list (special situation of a list)
 */
class EmptyList: public Pair {/*{{{*/
    public:
        EmptyList();        /**< The constructor */
        ReprCons *get_repr_cons();
};/*}}}*/

/** @class ReprCons
 * The abstraction class to represent a representation construction, which is
 * used as stack frame in `ext_repr`.
 */
class ReprCons {/*{{{*/
    public:
        EvalObj *ori;           /**< Reflexive pointer to the obj */
        bool prim;             /**< true if no further expansion is needed */
        /** The finally generated external represenation of the EvalObj */
        string repr;
        /** The constructor */
        ReprCons(bool prim, EvalObj *ori = NULL);
        /** This function is called to get the next component in a complex
         * EvalObj
         * @param prev Feed the string form of the previous component */
        virtual EvalObj *next(const string &prev) = 0;
};/*}}}*/

/** @class ReprStr
 * Used to store the generated external representation.
 */
class ReprStr : public ReprCons {/*{{{*/
    public:
        /** The constructor */
        ReprStr(string repr);
        EvalObj *next(const string &prev);
};/*}}}*/

/** @class PairReprCons
 * The ReprCons implementation of Pair
 */
class PairReprCons : public ReprCons {/*{{{*/
    private:
        int state;
        EvalObj *ptr;
    public:
        /** The constructor */
        PairReprCons(Pair *ptr, EvalObj *ori);
        EvalObj *next(const string &prev);
};/*}}}*/

class VecObj;

/** @class VectReprCons
 * The ReprCons implementation of VecObj
 */
class VectReprCons : public ReprCons {/*{{{*/
    private:
        VecObj *ptr;
        size_t idx;
    public:
        /** The constructor */
        VectReprCons(VecObj *ptr, EvalObj *ori);
        EvalObj *next(const string &prev);
};/*}}}*/


/** @class UnspecObj
 * The "unspecified" value returned by some builtin procedures
 */
class UnspecObj: public EvalObj {/*{{{*/
    public:
        UnspecObj();
        ReprCons *get_repr_cons();
};/*}}}*/

/** @class SymObj
 * Symbols
 */
class SymObj: public EvalObj {/*{{{*/
    public:
        /** Storage implementation: string */
        string val;
        /** The constructor */
        SymObj(const string &);
        ReprCons *get_repr_cons();
};/*}}}*/

class Environment;
class Continuation;

/** @class OptObj
 * "Operators" in general sense
 */
class OptObj: public Container {/*{{{*/
    public:

        /** The constructor */
        OptObj(int otype = 0);
        /**
         * The function is called when an operation is needed.
         * @param args The argument list (the first one is the opt itself)
         * @param envt The current environment (may be modified)
         * @param cont The current continuation (may be modified)
         * @param top_ptr Pointing to the top of the stack (may be modified)
         * @param pc Pointing to the entry of the call in AST
         * @return New value for pc register
         */
        virtual Pair *call(Pair *args, Environment * &envt,
                            Continuation * &cont, EvalObj ** &top_ptr, Pair *pc) = 0;
        virtual void gc_decrement();
        virtual void gc_trigger(EvalObj ** &tail);

};/*}}}*/

/** @class ProcObj
 * User-defined procedures
 */
class ProcObj: public OptObj {/*{{{*/
    public:
        /** The procedure body, a list of expressions to be evaluated */
        Pair *body;
        /** The arguments: \<list\> | var_1 ... | var_1 var_2 ... . var_n */
        EvalObj *params;
        /** Pointer to the environment */
        Environment *envt;

        /** Conctructs a ProcObj */
        ProcObj(Pair *body, Environment *envt, EvalObj *params);
        ~ProcObj();
        Pair *call(Pair *args, Environment * &envt,
                    Continuation * &cont, EvalObj ** &top_ptr, Pair *pc);
        ReprCons *get_repr_cons();

        void gc_decrement();
        void gc_trigger(EvalObj ** &tail);
};/*}}}*/

/** @class SpecialOptObj
 * Special builtin syntax (`if`, `define`, `lambda`, etc.)
 */
class SpecialOptObj: public OptObj {/*{{{*/
    protected:
        /** The name of this operator */
        string name;
    public:
        /** The constructor */
        SpecialOptObj(string name);
        ReprCons *get_repr_cons();
};/*}}}*/

/** @class BuiltinProcObj
 * Wrapping class for builtin procedures (arithmetic operators, etc.)
 */
class BuiltinProcObj: public OptObj {/*{{{*/
    private:
        /** The function that tackle the inputs in effect */
        BuiltinProc handler;
        string name;
    public:
        /**
         * Make a BuiltinProcObj which invokes proc when called
         * @param proc the actual handler
         * @param name the name of this built-in procedure
         */
        BuiltinProcObj(BuiltinProc proc, string name);
        Pair *call(Pair *args, Environment * &envt,
                    Continuation * &cont, EvalObj ** &top_ptr, Pair *pc);
        ReprCons *get_repr_cons();
};/*}}}*/

/** @class BoolObj
 * Booleans
 */
class BoolObj: public EvalObj {/*{{{*/
    public:
        bool val;                       /**< true for \#t, false for \#f */
        BoolObj(bool);                  /**< Converts a C bool value to a BoolObj*/
        bool is_true();                 /**< Override EvalObj `is_true()` */
        ReprCons *get_repr_cons();
        /** Try to construct an BoolObj object
         * @return NULL if failed
         */
        static BoolObj *from_string(string repr);
};/*}}}*/

/** @class NumObj
 * The top level abstract of numbers
 */
class NumObj: public EvalObj {/*{{{*/
    protected:
        /** True if the number is of exact value */
        bool exactness;
    public:
        /** The level of the specific number. The smaller the level
         * is, the more generic that number is.
         */
        NumLvl level;

        /**
         * Construct a general Numeric object
         */
        NumObj(NumLvl level, bool _exactness);
        /** Deep-copy a NumObj */
        virtual NumObj *clone() const = 0;
        /** @return true if it's an exact numeric value */
        bool is_exact();
        /** Upper convert a NumObj `r` to the same type as `this` */
        virtual NumObj *convert(NumObj *r) = 0;
        virtual void add(NumObj *r) = 0;    /**< Addition */
        virtual void sub(NumObj *r) = 0;    /**< Substraction */
        virtual void mul(NumObj *r) = 0;    /**< Multiplication */
        virtual void div(NumObj *r) = 0;    /**< Division */
        virtual void abs();                 /**< Absolute function */

        virtual bool lt(NumObj *r);