pm.h

Go to the documentation of this file.

/*
# This file is Copyright 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 __PM_H__
#define __PM_H__


#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdio.h>


#define PM_RELEASE 8


#define C_NULL 0

#define C_FALSE 0

#define C_TRUE (!C_FALSE)

#define C_SAME (int8_t)0

#define C_DIFFER (int8_t)-1

#define INLINE __inline__


#if __DEBUG__
#define PM_RAISE(retexn, exn) \
        do \
        { \
            retexn = (exn); \
            gVmGlobal.errFileId = __FILE_ID__; \
            gVmGlobal.errLineNum = (uint16_t)__LINE__; \
        } while (0)
#else
#define PM_RAISE(retexn, exn) \
        retexn = (exn)
#endif

#define PM_BREAK_IF_ERROR(retval) if((retval) != PM_RET_OK)break

#define PM_RETURN_IF_ERROR(retval)  if((retval) != PM_RET_OK) \
                                        return (retval)

#define PM_REPORT_IF_ERROR(retval)   if ((retval) != PM_RET_OK) \
                                        plat_reportError(retval)

#if __DEBUG__

#define C_ASSERT(boolexpr) \
    do \
    { \
        if (!((boolexpr))) \
        { \
            gVmGlobal.errFileId = __FILE_ID__; \
            gVmGlobal.errLineNum = (uint16_t)__LINE__; \
            return PM_RET_ASSERT_FAIL; \
        } \
    } \
    while (0)

#else

#define C_ASSERT(boolexpr)
#endif

#define VERBOSITY_LOW 1

#define VERBOSITY_MEDIUM 2

#define VERBOSITY_HIGH 3

#if __DEBUG__

#define VERBOSITY_OFF 0

#define DEBUG_PRINT_VERBOSITY VERBOSITY_OFF

#define C_DEBUG_PRINT(v, f, ...) \
    do \
    { \
        if (DEBUG_PRINT_VERBOSITY >= (v)) \
        { \
            printf("PM_DEBUG: " f, ## __VA_ARGS__); \
        } \
    } \
    while (0)

#else
#define C_DEBUG_PRINT(...)
#endif


typedef enum PmReturn_e
{
    /* general status return values */
    PM_RET_OK = 0,              
    PM_RET_NO = 0xFF,           
    PM_RET_ERR = 0xFE,          
    PM_RET_STUB = 0xFD,         
    PM_RET_ASSERT_FAIL = 0xFC,  
    PM_RET_FRAME_SWITCH = 0xFB, 
    /* return vals that indicate an exception occured */
    PM_RET_EX = 0xE0,           
    PM_RET_EX_EXIT = 0xE1,      
    PM_RET_EX_IO = 0xE2,        
    PM_RET_EX_ZDIV = 0xE3,      
    PM_RET_EX_ASSRT = 0xE4,     
    PM_RET_EX_ATTR = 0xE5,      
    PM_RET_EX_IMPRT = 0xE6,     
    PM_RET_EX_INDX = 0xE7,      
    PM_RET_EX_KEY = 0xE8,       
    PM_RET_EX_MEM = 0xE9,       
    PM_RET_EX_NAME = 0xEA,      
    PM_RET_EX_SYNTAX = 0xEB,    
    PM_RET_EX_SYS = 0xEC,       
    PM_RET_EX_TYPE = 0xED,      
    PM_RET_EX_VAL = 0xEE,       
    PM_RET_EX_STOP = 0xEF,      
    PM_RET_EX_WARN = 0xF0,      
} PmReturn_t;


extern volatile uint32_t pm_timerMsTicks;


/* WARNING: The order of the following includes is critical */
#include "pmfeatures.h"
#include "sli.h"
#include "mem.h"
#include "obj.h"
#include "seq.h"
#include "tuple.h"
#include "strobj.h"
#include "heap.h"
#include "int.h"
#include "seglist.h"
#include "list.h"
#include "dict.h"
#include "codeobj.h"
#include "func.h"
#include "module.h"
#include "frame.h"
#include "interp.h"
#include "img.h"
#include "global.h"
#include "class.h"
#include "thread.h"
#include "float.h"
#include "plat.h"


PmReturn_t pm_init(PmMemSpace_t memspace, uint8_t *pusrimg);

PmReturn_t pm_run(uint8_t const *modstr);

PmReturn_t pm_vmPeriodic(uint16_t usecsSinceLastCall);

#endif /* __PM_H__ */


#ifdef __cplusplus
}
#endif