flight/libraries/PyMite/vm/int.h

   1 /*
   2 # This file is Copyright 2003, 2006, 2007, 2009, 2010 Dean Hall.
   3 #
   4 # This file is part of the PyMite VM.
   5 # The PyMite VM is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU GENERAL PUBLIC LICENSE Version 2.
   7 #
   8 # The PyMite VM is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11 # A copy of the GNU GENERAL PUBLIC LICENSE Version 2
  12 # is seen in the file COPYING in this directory.
  13 */
  14
  15
  16 #ifndef __INT_H__
  17 #define __INT_H__
  18
  19
  20 /**
  21  * \file
  22  * \brief Integer Object Type
  23  *
  24  * Integer object type header.
  25  */
  26
  27 /**
  28  * Integer obj
  29  *
  30  * 32b signed integer
  31  */
  32 typedef struct PmInt_s
  33 {
  34     /** Object descriptor */
  35     PmObjDesc_t od;
  36
  37     /** Integer value */
  38     int32_t val;
  39 } PmInt_t,
  40  *pPmInt_t;
  41
  42
  43 /**
  44  * Creates a duplicate Integer object
  45  *
  46  * Created specifically for the index value in FOR_LOOP.
  47  *
  48  * @param   pint Pointer to int obj to duplicate.
  49  * @param   r_pint Return by ref, ptr to new int
  50  * @return  Return status
  51  */
  52 PmReturn_t int_dup(pPmObj_t pint, pPmObj_t *r_pint);
  53
  54 /**
  55  * Creates a new Integer object
  56  *
  57  * @param   val Value to assign int (signed 32-bit).
  58  * @param   r_pint Return by ref, ptr to new int
  59  * @return  Return status
  60  */
  61 PmReturn_t int_new(int32_t val, pPmObj_t *r_pint);
  62
  63 /**
  64  * Implements the UNARY_POSITIVE bcode.
  65  *
  66  * Creates a new int with the same value as the given int.
  67  *
  68  * @param   pobj Pointer to integer object
  69  * @param   r_pint Return by reference, ptr to int
  70  * @return  Return status
  71  */
  72 PmReturn_t int_positive(pPmObj_t pobj, pPmObj_t *r_pint);
  73
  74 /**
  75  * Implements the UNARY_NEGATIVE bcode.
  76  *
  77  * Creates a new int with a value that is the negative of the given int.
  78  *
  79  * @param   pobj Pointer to target object
  80  * @param   r_pint Return by ref, ptr to int
  81  * @return  Return status
  82  */
  83 PmReturn_t int_negative(pPmObj_t pobj, pPmObj_t *r_pint);
  84
  85 /**
  86  * Implements the UNARY_INVERT bcode.
  87  *
  88  * Creates a new int with a value that is
  89  * the bitwise inversion of the given int.
  90  *
  91  * @param   pobj Pointer to integer to invert
  92  * @param   r_pint Return by reference; new integer
  93  * @return  Return status
  94  */
  95 PmReturn_t int_bitInvert(pPmObj_t pobj, pPmObj_t *r_pint);
  96
  97 #ifdef HAVE_PRINT
  98 /**
  99  * Sends out an integer object in decimal notation with MSB first.
 100  * The number is preceded with a "-" when necessary.
 101  *
 102  * @param pObj Ptr to int object
 103  * @return Return status
 104  */
 105 PmReturn_t int_print(pPmObj_t pint);
 106
 107 /**
 108  * Prints the byte in ascii-coded hexadecimal out the platform output
 109  *
 110  * @param b Byte to print
 111  */
 112 PmReturn_t int_printHexByte(uint8_t b);
 113
 114 /**
 115  * Prints the integer in ascii-coded hexadecimal out the platform output
 116  *
 117  * @param n Integer to print
 118  */
 119 PmReturn_t _int_printHex(intptr_t n);
 120
 121 /**
 122  * Prints the Int object in ascii-coded hexadecimal out the platform output
 123  *
 124  * @param pint Pointer to Int object
 125  */
 126 PmReturn_t int_printHex(pPmObj_t pint);
 127 #endif /* HAVE_PRINT */
 128
 129 /**
 130  * Returns by reference an integer that is x raised to the power of y.
 131  *
 132  * @param px The integer base
 133  * @param py The integer exponent
 134  * @param r_pn Return by reference; New integer with value of x ** y
 135  * @return Return status
 136  */
 137 PmReturn_t int_pow(pPmObj_t px, pPmObj_t py, pPmObj_t *r_pn);
 138
 139 #endif /* __INT_H__ */