Object.h

/*
    Copyright (c) 2019-2023 Javier Pimás, Jan Vrany, Labware. 
    See (MIT) license in root directory.
 */

#ifndef _OBJECT_H_
#define _OBJECT_H_

#include "Util.h"

#include <string>

namespace Egg {

struct HeapObject;
struct SmallInteger;

/**
 * Class `Object` represents an opaque object. It is meant to always
 * be used as a pointer, as it provides no direct access to its 
 * contents.
 * It could refer to an object heap or to an immediate object, and
 * must be cast to a particular type to use its actual value.
 */
struct Object
{

    /**
     * Return `true` if this object is a SmallInteger instance,
     * `false` otherwise.
     */
    bool isSmallInteger() { return (uintptr_t)this & 1 ? true : false; }

    /**
     * Cast into SmallInteger type
     */
    operator SmallInteger*()
    {
    	ASSERT(isSmallInteger());

    	return (SmallInteger*)(void*)this;
    }

    /**
     * Cast into SmallInteger type
     */
    SmallInteger* asSmallInteger() {return (SmallInteger*)this;}    

    /**
     * Cast into a HeapObject type
     */
    operator HeapObject*()
    {
    	ASSERT(!isSmallInteger());

    	return (HeapObject*)(void*)this;
    }

    /**
     * Cast into a HeapObject type
     */
    HeapObject* asHeapObject() {return (HeapObject*)this;}    

    // debugging
    std::string printString();
	std::string printContents();
};

} // namespace Egg

#endif /* _OBJECT_H_ */