source/blender/blenlib/BLI_gsqueue.h

   1 /*
   2  * $Id$
   3  *
   4  * ***** BEGIN GPL LICENSE BLOCK *****
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  *
  20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  21  * All rights reserved.
  22  *
  23  * The Original Code is: all of this file.
  24  *
  25  * Contributor(s): none yet.
  26  *
  27  * ***** END GPL LICENSE BLOCK *****
  28  */
  29
  30 #ifndef BLI_GSQUEUE_H
  31 #define BLI_GSQUEUE_H
  32
  33 /** \file BLI_gsqueue.h
  34  *  \ingroup bli
  35  *  \brief A generic structure queue (a queue for fixed length
  36  *   (generally small) structures.
  37  */
  38
  39 typedef struct _GSQueue GSQueue;
  40
  41         /**
  42          * Create a new GSQueue.
  43          *
  44          * @param elem_size The size of the structures in the queue.
  45          * @retval The new queue
  46          */
  47 GSQueue*        BLI_gsqueue_new         (int elem_size);
  48
  49         /**
  50          * Query if the queue is empty
  51          */
  52 int                     BLI_gsqueue_is_empty(GSQueue *gq);
  53
  54         /**
  55          * Query number elements in the queue
  56          */
  57 int                     BLI_gsqueue_size(GSQueue *gq);
  58
  59         /**
  60          * Access the item at the head of the queue
  61          * without removing it.
  62          *
  63          * @param item_r A pointer to an appropriatly
  64          * sized structure (the size passed to BLI_gsqueue_new)
  65          */
  66 void            BLI_gsqueue_peek        (GSQueue *gq, void *item_r);
  67
  68         /**
  69          * Access the item at the head of the queue
  70          * and remove it.
  71          *
  72          * @param item_r A pointer to an appropriatly
  73          * sized structure (the size passed to BLI_gsqueue_new).
  74          * Can be NULL if desired.
  75          */
  76 void            BLI_gsqueue_pop         (GSQueue *gq, void *item_r);
  77
  78         /**
  79          * Push an element onto the tail of the queue.
  80          *
  81          * @param item A pointer to an appropriatly
  82          * sized structure (the size passed to BLI_gsqueue_new).
  83          */
  84 void            BLI_gsqueue_push        (GSQueue *gq, void *item);
  85
  86         /**
  87          * Push an element back onto the head of the queue (so
  88          * it would be returned from the next call to BLI_gsqueue_pop).
  89          *
  90          * @param item A pointer to an appropriatly
  91          * sized structure (the size passed to BLI_gsqueue_new).
  92          */
  93 void            BLI_gsqueue_pushback    (GSQueue *gq, void *item);
  94
  95         /**
  96          * Free the queue
  97          */
  98 void            BLI_gsqueue_free        (GSQueue *gq);
  99
 100 #endif /* BLI_GSQUEUE_H */
 101