mirror of
https://bitbucket.org/librepilot/librepilot.git
synced 2024-11-30 08:24:11 +01:00
1e78cc7a30
git-svn-id: svn://svn.openpilot.org/OpenPilot/trunk@2364 ebee16cc-31ac-478f-84a7-5cbb03baadba
94 lines
2.3 KiB
C
94 lines
2.3 KiB
C
/*
|
|
# This file is Copyright 2006, 2007, 2009, 2010 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 __SEQ_H__
|
|
#define __SEQ_H__
|
|
|
|
|
|
/**
|
|
* \file
|
|
* \brief Sequence Header
|
|
*/
|
|
|
|
|
|
/**
|
|
* Sequence Iterator Object
|
|
*
|
|
* Instances of this object are created by GET_ITER and used by FOR_ITER.
|
|
* Stores a pointer to a sequence and an index int16_t.
|
|
*/
|
|
typedef struct PmSeqIter_s
|
|
{
|
|
/** Object descriptor */
|
|
PmObjDesc_t od;
|
|
|
|
/** Sequence object */
|
|
pPmObj_t si_sequence;
|
|
|
|
/** Index value */
|
|
int16_t si_index;
|
|
} PmSeqIter_t,
|
|
*pPmSeqIter_t;
|
|
|
|
|
|
/**
|
|
* Compares two sequences for equality
|
|
*
|
|
* @param pobj1 Ptr to first sequence.
|
|
* @param pobj2 Ptr to second sequence.
|
|
* @return C_SAME if the seuqences are equivalent, C_DIFFER otherwise.
|
|
*/
|
|
int8_t seq_compare(pPmObj_t pobj1, pPmObj_t pobj2);
|
|
|
|
/**
|
|
* Returns the length of the sequence
|
|
*
|
|
* @param pobj Ptr to sequence.
|
|
* @param r_index Return arg, length of sequence
|
|
* @return Return status
|
|
*/
|
|
PmReturn_t seq_getLength(pPmObj_t pobj, int16_t *r_index);
|
|
|
|
/**
|
|
* Returns the object from sequence[index]
|
|
*
|
|
* @param pobj Ptr to sequence object to get object from
|
|
* @param index Int index into the sequence
|
|
* @param r_pobj Return arg, object from sequence
|
|
* @return Return status
|
|
*/
|
|
PmReturn_t seq_getSubscript(pPmObj_t pobj, int16_t index, pPmObj_t *r_pobj);
|
|
|
|
/**
|
|
* Returns the next item from the sequence iterator object
|
|
*
|
|
* @param pobj Ptr to sequence iterator.
|
|
* @param r_pitem Return arg, pointer to next item from sequence.
|
|
* @return Return status.
|
|
*/
|
|
PmReturn_t seqiter_getNext(pPmObj_t pobj, pPmObj_t *r_pitem);
|
|
|
|
|
|
/**
|
|
* Returns a new sequence iterator object
|
|
*
|
|
* @param pobj Ptr to sequence.
|
|
* @param r_pobj Return by reference, new sequence iterator
|
|
* @return Return status.
|
|
*/
|
|
PmReturn_t seqiter_new(pPmObj_t pobj, pPmObj_t *r_pobj);
|
|
|
|
#endif /* __SEQ_H__ */
|