TclObject.hh

Go to the documentation of this file.

#ifndef TCLOBJECT_HH
#define TCLOBJECT_HH

#include "string_ref.hh"
#include "openmsx.hh"
#include <iterator>

struct Tcl_Interp;
struct Tcl_Obj;

namespace openmsx {

class Interpreter;

class TclObject
{
public:
        TclObject(Tcl_Interp* interp, Tcl_Obj* object);
        TclObject(Tcl_Interp* interp, string_ref value);
        explicit TclObject(string_ref value);
        explicit TclObject(Tcl_Interp* interp);
        explicit TclObject(Interpreter& interp);
        TclObject(const TclObject& object);
        TclObject();
        ~TclObject();

        // assignment operator so we can use vector<TclObject>
        TclObject& operator=(const TclObject& other);

        // get associated interpreter
        Tcl_Interp* getInterpreter() const;
        // get underlying Tcl_Obj
        Tcl_Obj* getTclObject();

        // value setters
        void setString(string_ref value);
        void setInt(int value);
        void setBoolean(bool value);
        void setDouble(double value);
        void setBinary(byte* buf, unsigned length);
        void addListElement(string_ref element);
        void addListElement(int value);
        void addListElement(double value);
        void addListElement(const TclObject& element);
        template <typename ITER> void addListElements(ITER begin, ITER end);
        template <typename CONT> void addListElements(const CONT& container);

        // value getters
        string_ref getString() const;
        int getInt() const;
        bool getBoolean() const;
        double getDouble() const;
        const byte* getBinary(unsigned& length) const;
        unsigned getListLength() const;
        TclObject getListIndex(unsigned index) const;
        TclObject getDictValue(const TclObject& key) const;

        // expressions
        bool evalBool() const;

        void checkExpression() const;
        void checkCommand() const;

        std::string executeCommand(bool compile = false);

private:
        void init(Tcl_Obj* obj_);
        void throwException() const;
        void addListElement(Tcl_Obj* element);
        void parse(const char* str, int len, bool expression) const;

        Tcl_Interp* interp;
        Tcl_Obj* obj;
};

template <typename ITER>
void TclObject::addListElements(ITER begin, ITER end)
{
        for (ITER it = begin; it != end; ++it) {
                addListElement(*it);
        }
}

template <typename CONT>
void TclObject::addListElements(const CONT& container)
{
        addListElements(std::begin(container), std::end(container));
}

} // namespace openmsx

#endif