git.sesse.net Git - mlt/blob - src/framework/mlt_deque.h

   1 /**
   2  * \file mlt_deque.h
   3  * \brief double ended queue
   4  * \see mlt_deque_s
   5  *
   6  * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
   7  * \author Charles Yates <charles.yates@pandora.be>
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 #ifndef _MLT_DEQUE_H_
  25 #define _MLT_DEQUE_H_
  26
  27 #include "mlt_types.h"
  28
  29 /** The callback function used to compare items for insert sort.
  30  *
  31  * \public \memberof mlt_deque_s
  32  * \param a the first object
  33  * \param b the second object
  34  * \returns 0 if equal, < 0 if a < b, or > 0 if a > b
  35 */
  36 typedef int ( *mlt_deque_compare )( void *a, void *b );
  37
  38 extern mlt_deque mlt_deque_init( );
  39 extern int mlt_deque_count( mlt_deque self );
  40 extern int mlt_deque_push_back( mlt_deque self, void *item );
  41 extern void *mlt_deque_pop_back( mlt_deque self );
  42 extern int mlt_deque_push_front( mlt_deque self, void *item );
  43 extern void *mlt_deque_pop_front( mlt_deque self );
  44 extern void *mlt_deque_peek_back( mlt_deque self );
  45 extern void *mlt_deque_peek_front( mlt_deque self );
  46 extern void *mlt_deque_peek( mlt_deque self, int index );
  47 extern int mlt_deque_insert( mlt_deque self, void *item, mlt_deque_compare );
  48
  49 extern int mlt_deque_push_back_int( mlt_deque self, int item );
  50 extern int mlt_deque_pop_back_int( mlt_deque self );
  51 extern int mlt_deque_push_front_int( mlt_deque self, int item );
  52 extern int mlt_deque_pop_front_int( mlt_deque self );
  53 extern int mlt_deque_peek_back_int( mlt_deque self );
  54 extern int mlt_deque_peek_front_int( mlt_deque self );
  55
  56 extern int mlt_deque_push_back_double( mlt_deque self, double item );
  57 extern double mlt_deque_pop_back_double( mlt_deque self );
  58 extern int mlt_deque_push_front_double( mlt_deque self, double item );
  59 extern double mlt_deque_pop_front_double( mlt_deque self );
  60 extern double mlt_deque_peek_back_double( mlt_deque self );
  61 extern double mlt_deque_peek_front_double( mlt_deque self );
  62
  63 extern void mlt_deque_close( mlt_deque self );
  64
  65 #endif