obj.h

Go to the documentation of this file.

/*
# This file is Copyright 2003, 2006, 2007, 2009 Dean Hall.
#
# This file is part of the PyMite VM.
# The PyMite VM is free software: you can redistribute it and/or modify
# it under the terms of the GNU GENERAL PUBLIC LICENSE Version 2.
#
# The PyMite VM 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.
# A copy of the GNU GENERAL PUBLIC LICENSE Version 2
# is seen in the file COPYING in this directory.
*/


#ifndef __OBJ_H__
#define __OBJ_H__


#define OD_MARK_SHIFT 14
#define OD_FREE_SHIFT 15
#define OD_MARK_BIT (uint16_t)(1 << OD_MARK_SHIFT)
#define OD_FREE_BIT (uint16_t)(1 << OD_FREE_SHIFT)
#define OD_SIZE_MASK (uint16_t)(0x01FF)
#define OD_TYPE_MASK (uint16_t)(0x3E00)
#define OD_TYPE_SHIFT 9

#define HD_SIZE_MASK (uint16_t)(0x3FFF)


#define OBJ_GET_FREE(pobj) \
    ((((pPmObj_t)pobj)->od >> OD_FREE_SHIFT) & (uint8_t)1)

#define OBJ_SET_FREE(pobj, free) \
    do \
    { \
        ((pPmObj_t)pobj)->od = ((uint8_t)free) \
                               ? ((pPmObj_t)pobj)->od | OD_FREE_BIT \
                               : ((pPmObj_t)pobj)->od & ~OD_FREE_BIT;\
    } \
    while (0)

/*
 * #99: od_size bits are shifted because size is a scaled value
 * True size is always a multiple of 4, so the lower two bits are ignored
 * and two more significant bits are gained.
 */
#define OBJ_GET_SIZE(pobj) \
    ((((pPmObj_t)pobj)->od & OD_FREE_BIT) \
     ? ((((pPmObj_t)pobj)->od & HD_SIZE_MASK) << 2) \
     : ((((pPmObj_t)pobj)->od & OD_SIZE_MASK) << 2))

#define OBJ_SET_SIZE(pobj, size) \
    do \
    { \
        if (((pPmObj_t)pobj)->od & OD_FREE_BIT) \
        { \
            ((pPmObj_t)pobj)->od &= ~HD_SIZE_MASK; \
            ((pPmObj_t)pobj)->od |= (((size) >> 2) & HD_SIZE_MASK); \
        } \
        else \
        { \
            ((pPmObj_t)pobj)->od &= ~OD_SIZE_MASK; \
            ((pPmObj_t)pobj)->od |= (((size) >> 2) & OD_SIZE_MASK); \
        } \
    } \
    while (0)

#define OBJ_GET_TYPE(pobj) \
    (((((pPmObj_t)pobj)->od) & OD_TYPE_MASK) >> OD_TYPE_SHIFT)

#define OBJ_SET_TYPE(pobj, type) \
    do \
    { \
        ((pPmObj_t)pobj)->od &= ~OD_TYPE_MASK; \
        ((pPmObj_t)pobj)->od |= (((type) << OD_TYPE_SHIFT) & OD_TYPE_MASK); \
    } \
    while (0)


typedef enum PmType_e
{
    OBJ_TYPE_HASHABLE_MIN = 0x00,

    OBJ_TYPE_NON = 0x00,

    OBJ_TYPE_INT = 0x01,

    OBJ_TYPE_FLT = 0x02,

    OBJ_TYPE_STR = 0x03,

    OBJ_TYPE_TUP = 0x04,

    OBJ_TYPE_COB = 0x05,

    OBJ_TYPE_MOD = 0x06,

    OBJ_TYPE_CLO = 0x07,

    OBJ_TYPE_FXN = 0x08,

    OBJ_TYPE_CLI = 0x09,

    OBJ_TYPE_CIM = 0x0A,

    OBJ_TYPE_NIM = 0x0B,

    OBJ_TYPE_NOB = 0x0C,

    OBJ_TYPE_THR = 0x0D,

    OBJ_TYPE_BOOL = 0x0F,

    OBJ_TYPE_CIO = 0x10,
  
    OBJ_TYPE_MTH = 0x11,
    
    /* All types after this are not hashable */
    OBJ_TYPE_HASHABLE_MAX = 0x11,

    OBJ_TYPE_LST = 0x12,

    OBJ_TYPE_DIC = 0x13,

    /* All types after this are not accessible to the user */
    OBJ_TYPE_ACCESSIBLE_MAX = 0x19,

    OBJ_TYPE_FRM = 0x19,

    OBJ_TYPE_BLK = 0x1A,

    OBJ_TYPE_SEG = 0x1B,

    OBJ_TYPE_SGL = 0x1C,

    OBJ_TYPE_SQI = 0x1D,

    OBJ_TYPE_NFM = 0x1E,
} PmType_t, *pPmType_t;


typedef uint16_t PmObjDesc_t,
 *pPmObjDesc_t;

typedef struct PmObj_s
{
    PmObjDesc_t od;
} PmObj_t,
 *pPmObj_t;

typedef struct PmBoolean_s
{
    PmObjDesc_t od;

    int32_t val;
}
PmBoolean_t, *pPmBoolean_t;


PmReturn_t obj_loadFromImg(PmMemSpace_t memspace,
                           uint8_t const **paddr, pPmObj_t *r_pobj);

PmReturn_t obj_loadFromImgObj(pPmObj_t pimg, pPmObj_t *r_pobj);

int8_t obj_isFalse(pPmObj_t pobj);

PmReturn_t obj_isIn(pPmObj_t pobj, pPmObj_t pitem);

int8_t obj_compare(pPmObj_t pobj1, pPmObj_t pobj2);

PmReturn_t obj_print(pPmObj_t pobj, uint8_t marshallString);

#ifdef HAVE_BACKTICK

PmReturn_t obj_repr(pPmObj_t pobj, pPmObj_t *r_pstr);
#endif /* HAVE_BACKTICK */

#endif /* __OBJ_H__ */