flight/libraries/PyMite/vm/seq.h

   1 /*
   2 # This file is Copyright 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 __SEQ_H__
  17 #define __SEQ_H__
  18
  19
  20 /**
  21  * \file
  22  * \brief Sequence Header
  23  */
  24
  25
  26 /**
  27  * Sequence Iterator Object
  28  *
  29  * Instances of this object are created by GET_ITER and used by FOR_ITER.
  30  * Stores a pointer to a sequence and an index int16_t.
  31  */
  32 typedef struct PmSeqIter_s
  33 {
  34     /** Object descriptor */
  35     PmObjDesc_t od;
  36
  37     /** Sequence object */
  38     pPmObj_t si_sequence;
  39
  40     /** Index value */
  41     int16_t si_index;
  42 } PmSeqIter_t,
  43  *pPmSeqIter_t;
  44
  45
  46 /**
  47  * Compares two sequences for equality
  48  *
  49  * @param   pobj1 Ptr to first sequence.
  50  * @param   pobj2 Ptr to second sequence.
  51  * @return  C_SAME if the seuqences are equivalent, C_DIFFER otherwise.
  52  */
  53 int8_t seq_compare(pPmObj_t pobj1, pPmObj_t pobj2);
  54
  55 /**
  56  * Returns the length of the sequence
  57  *
  58  * @param   pobj Ptr to  sequence.
  59  * @param   r_index Return arg, length of sequence
  60  * @return  Return status
  61  */
  62 PmReturn_t seq_getLength(pPmObj_t pobj, int16_t *r_index);
  63
  64 /**
  65  * Returns the object from sequence[index]
  66  *
  67  * @param   pobj Ptr to sequence object to get object from
  68  * @param   index Int index into the sequence
  69  * @param   r_pobj Return arg, object from sequence
  70  * @return  Return status
  71  */
  72 PmReturn_t seq_getSubscript(pPmObj_t pobj, int16_t index, pPmObj_t *r_pobj);
  73
  74 /**
  75  * Returns the next item from the sequence iterator object
  76  *
  77  * @param   pobj Ptr to sequence iterator.
  78  * @param   r_pitem Return arg, pointer to next item from sequence.
  79  * @return  Return status.
  80  */
  81 PmReturn_t seqiter_getNext(pPmObj_t pobj, pPmObj_t *r_pitem);
  82
  83
  84 /**
  85  * Returns a new sequence iterator object
  86  *
  87  * @param   pobj Ptr to sequence.
  88  * @param   r_pobj Return by reference, new sequence iterator
  89  * @return  Return status.
  90  */
  91 PmReturn_t seqiter_new(pPmObj_t pobj, pPmObj_t *r_pobj);
  92
  93 #endif /* __SEQ_H__ */