nsz Git - libfirm/blob - include/libfirm/adt/pqueue.h

   1 /*
   2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @date    18.04.2007
  23  * @author  Christian Wuerdig
  24  * @brief   Implementation of a priority queue. This is the ported version of
  25             the original Java implementation by Matthias Braun.
  26  */
  27 #ifndef FIRM_ADT_PQUEUE_H
  28 #define FIRM_ADT_PQUEUE_H
  29
  30 #include "../begin.h"
  31
  32 typedef struct pqueue_t pqueue_t;
  33
  34 /**
  35  * Creates a new priority queue.
  36  * @return A priority queue of initial length 0.
  37  */
  38 FIRM_API pqueue_t *new_pqueue(void);
  39
  40 /**
  41  * Frees all memory allocated by the priority queue.
  42  * @param q   The priority queue to destroy.
  43  */
  44 FIRM_API void del_pqueue(pqueue_t *q);
  45
  46 /**
  47  * Inserts a new element into a priority queue.
  48  * @param q         The priority queue the element should be inserted to.
  49  * @param data      The actual data which should be stored in the queue.
  50  * @param priority  The priority for the data.
  51  */
  52 FIRM_API void pqueue_put(pqueue_t *q, void *data, int priority);
  53
  54 /**
  55  * Returns and removes the first element, ie. that one with the highest priority, from the queue.
  56  * @param q   The priority queue.
  57  * @return The first element of the queue. Asserts if queue is empty.
  58  */
  59 FIRM_API void *pqueue_pop_front(pqueue_t *q);
  60
  61 /**
  62  * Get the length of the priority queue.
  63  * @param q   The priority queue.
  64  * @return The length of the queue.
  65  */
  66 FIRM_API size_t pqueue_length(const pqueue_t *q);
  67
  68 /**
  69  * Returns true if queue is empty.
  70  * @param q   The priority queue.
  71  * @return 1 if the queue is empty, 0 otherwise.
  72  */
  73 FIRM_API int pqueue_empty(const pqueue_t *q);
  74
  75 #include "../end.h"
  76
  77 #endif