GQueue

typedef struct {
  GList *head;
  GList *tail;
  guint  length;
} GQueue;

g_queue_new ()

GQueue*             g_queue_new                         (void);

Creates a new GQueue.

g_queue_free ()

void                g_queue_free                        (GQueue *queue);

Frees the memory allocated for the GQueue. Only call this function if queue was created with g_queue_new(). If queue elements contain dynamically-allocated memory, they should be freed first.

G_QUEUE_INIT

#define G_QUEUE_INIT { NULL, NULL, 0 }

g_queue_init ()

void                g_queue_init                        (GQueue *queue);

A statically-allocated GQueue must be initialized with this function before it can be used. Alternatively you can initialize it with G_QUEUE_INIT. It is not necessary to initialize queues created with g_queue_new().

Since 2.14

g_queue_clear ()

void                g_queue_clear                       (GQueue *queue);

Removes all the elements in queue. If queue elements contain dynamically-allocated memory, they should be freed first.

Since 2.14

g_queue_is_empty ()

gboolean            g_queue_is_empty                    (GQueue *queue);

Returns TRUE if the queue is empty.

g_queue_get_length ()

guint               g_queue_get_length                  (GQueue *queue);

Returns the number of items in queue.

Since 2.4

g_queue_reverse ()

void                g_queue_reverse                     (GQueue *queue);

Reverses the order of the items in queue.

Since 2.4

g_queue_copy ()

GQueue *            g_queue_copy                        (GQueue *queue);

Copies a queue. Note that is a shallow copy. If the elements in the queue consist of pointers to data, the pointers are copied, but the actual data is not.

Since 2.4

g_queue_foreach ()

void                g_queue_foreach                     (GQueue *queue,
                                                         GFunc func,
                                                         gpointer user_data);

Calls func for each element in the queue passing user_data to the function.

Since 2.4

g_queue_find ()

GList *             g_queue_find                        (GQueue *queue,
                                                         gconstpointer data);

Finds the first link in queue which contains data.

Since 2.4

g_queue_find_custom ()

GList *             g_queue_find_custom                 (GQueue *queue,
                                                         gconstpointer data,
                                                         GCompareFunc func);

Finds an element in a GQueue, using a supplied function to find the desired element. It iterates over the queue, calling the given function which should return 0 when the desired element is found. The function takes two gconstpointer arguments, the GQueue element's data as the first argument and the given user data as the second argument.

Since 2.4

g_queue_sort ()

void                g_queue_sort                        (GQueue *queue,
                                                         GCompareDataFunc compare_func,
                                                         gpointer user_data);

Sorts queue using compare_func.

Since 2.4

g_queue_push_head ()

void                g_queue_push_head                   (GQueue *queue,
                                                         gpointer data);

Adds a new element at the head of the queue.

g_queue_push_tail ()

void                g_queue_push_tail                   (GQueue *queue,
                                                         gpointer data);

Adds a new element at the tail of the queue.

g_queue_push_nth ()

void                g_queue_push_nth                    (GQueue *queue,
                                                         gpointer data,
                                                         gint n);

Inserts a new element into queue at the given position

Since 2.4

g_queue_pop_head ()

gpointer            g_queue_pop_head                    (GQueue *queue);

Removes the first element of the queue.

g_queue_pop_tail ()

gpointer            g_queue_pop_tail                    (GQueue *queue);

Removes the last element of the queue.

g_queue_pop_nth ()

gpointer            g_queue_pop_nth                     (GQueue *queue,
                                                         guint n);

Removes the n'th element of queue.

Since 2.4

g_queue_peek_head ()

gpointer            g_queue_peek_head                   (GQueue *queue);

Returns the first element of the queue.

g_queue_peek_tail ()

gpointer            g_queue_peek_tail                   (GQueue *queue);

Returns the last element of the queue.

g_queue_peek_nth ()

gpointer            g_queue_peek_nth                    (GQueue *queue,
                                                         guint n);

Returns the n'th element of queue.

Since 2.4

g_queue_index ()

gint                g_queue_index                       (GQueue *queue,
                                                         gconstpointer data);

Returns the position of the first element in queue which contains data.

Since 2.4

g_queue_remove ()

void                g_queue_remove                      (GQueue *queue,
                                                         gconstpointer data);

Removes the first element in queue that contains data.

Since 2.4

g_queue_remove_all ()

void                g_queue_remove_all                  (GQueue *queue,
                                                         gconstpointer data);

Remove all elements whose data equals data from queue.

Since 2.4

g_queue_insert_before ()

void                g_queue_insert_before               (GQueue *queue,
                                                         GList *sibling,
                                                         gpointer data);

Inserts data into queue before sibling.

sibling must be part of queue.

Since 2.4

g_queue_insert_after ()

void                g_queue_insert_after                (GQueue *queue,
                                                         GList *sibling,
                                                         gpointer data);

Inserts data into queue after sibling

sibling must be part of queue

Since 2.4

g_queue_insert_sorted ()

void                g_queue_insert_sorted               (GQueue *queue,
                                                         gpointer data,
                                                         GCompareDataFunc func,
                                                         gpointer user_data);

Inserts data into queue using func to determine the new position.

Since 2.4

g_queue_push_head_link ()

void                g_queue_push_head_link              (GQueue *queue,
                                                         GList *link_);

Adds a new element at the head of the queue.

g_queue_push_tail_link ()

void                g_queue_push_tail_link              (GQueue *queue,
                                                         GList *link_);

Adds a new element at the tail of the queue.

g_queue_push_nth_link ()

void                g_queue_push_nth_link               (GQueue *queue,
                                                         gint n,
                                                         GList *link_);

Inserts link into queue at the given position.

Since 2.4

g_queue_pop_head_link ()

GList*              g_queue_pop_head_link               (GQueue *queue);

Removes the first element of the queue.

g_queue_pop_tail_link ()

GList*              g_queue_pop_tail_link               (GQueue *queue);

Removes the last element of the queue.

g_queue_pop_nth_link ()

GList*              g_queue_pop_nth_link                (GQueue *queue,
                                                         guint n);

Removes and returns the link at the given position.

Since 2.4

g_queue_peek_head_link ()

GList*              g_queue_peek_head_link              (GQueue *queue);

Returns the first link in queue

Since 2.4

g_queue_peek_tail_link ()

GList*              g_queue_peek_tail_link              (GQueue *queue);

Returns the last link queue.

Since 2.4

g_queue_peek_nth_link ()

GList*              g_queue_peek_nth_link               (GQueue *queue,
                                                         guint n);

Returns the link at the given position

Since 2.4

g_queue_link_index ()

gint                g_queue_link_index                  (GQueue *queue,
                                                         GList *link_);

Returns the position of link_ in queue.

Since 2.4

g_queue_unlink ()

void                g_queue_unlink                      (GQueue *queue,
                                                         GList *link_);

Unlinks link_ so that it will no longer be part of queue. The link is not freed.

link_ must be part of queue,

Since 2.4

g_queue_delete_link ()

void                g_queue_delete_link                 (GQueue *queue,
                                                         GList *link_);

Removes link_ from queue and frees it.

link_ must be part of queue.

Since 2.4