flight/libraries/PyMite/vm/bytearray.h

   1 /*
   2 # This file is Copyright 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 __BYTEARRAY_H__
  17 #define __BYTEARRAY_H__
  18
  19 /**
  20  * \file
  21  * \brief Bytearray Object Type
  22  *
  23  * Bytearray object type header.
  24  */
  25
  26
  27 /**
  28  * Bytes container
  29  *
  30  * Holds actual byte payload
  31  */
  32 typedef struct PmBytes_s
  33 {
  34     /** Object descriptor */
  35     PmObjDesc_t od;
  36
  37     /** Physical number of bytes in the C array (below) */
  38     int16_t length;
  39
  40     /** C array of bytes */
  41     uint8_t val[1];
  42 } PmBytes_t,
  43  *pPmBytes_t;
  44
  45
  46 /**
  47  * Bytearray obj
  48  *
  49  * Mutable ordered sequence of bytes.  Contains ptr to chunk of bytes.
  50  */
  51 typedef struct PmBytearray_s
  52 {
  53     /** Object descriptor */
  54     PmObjDesc_t od;
  55
  56     /** Bytearray length; logical number of bytes */
  57     int16_t length;
  58
  59     /** Ptr to bytes container (may hold more bytes than length) */
  60     pPmBytes_t val;
  61 } PmBytearray_t,
  62  *pPmBytearray_t;
  63
  64
  65 PmReturn_t bytearray_new(pPmObj_t pobj, pPmObj_t *r_pobj);
  66 PmReturn_t bytearray_getItem(pPmObj_t pobj, int16_t index, pPmObj_t *r_pobj);
  67 PmReturn_t bytearray_setItem(pPmObj_t pba, int16_t index, pPmObj_t pobj);
  68 PmReturn_t bytearray_print(pPmObj_t pobj);
  69
  70 #endif /* __BYTEARRAY_H__ */