WaList.h

Go to the documentation of this file.

/*
 * This file is part of the Wave Arts VQE library.
 * Copyright (C) 2011 Wave Arts, Inc. (http://wavearts.com)
 *
 * VQE is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * VQE 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.  See the
 * GNU General Public License for more details.
 *
 * A copy of the GNU General Public License is included with VQE,
 * and can be found online at <http://www.gnu.org/licenses/>.
 *
 * If you'd like to distribute a closed-source product which uses VQE,
 * you must obtain a commercial VQE license from Wave Arts.
 */
#ifndef _LIST_H
#define _LIST_H

/*
 * ITEM starts with ptr to next element, NULL if none.
 */
typedef struct item_tag {
        struct item_tag *next;
} ITEM;

/*
 * LIST structure contains head and tail ptrs to ITEMs, NULL if no items.
 */
typedef struct {
        ITEM    *head;
        ITEM    *tail;
} LIST;

/*
 * An item containing a LIST, for making lists of lists.
 */
typedef struct list_tag {
        struct  list_tag        *next;
        LIST    list;
} LIST_ITEM;

#ifdef  __cplusplus
extern "C" {
#endif

void listInit(LIST *list);
void listEnqueue(LIST *list, ITEM *item);
ITEM *listDequeue(LIST *list);
int listDelete(LIST *list, ITEM *item);
int listReplace(LIST *list, ITEM *item, ITEM *newItem);
void listPrepend(LIST *list, ITEM *item);
void listFunc(LIST *list, void (*func)(ITEM *));
int listCount(LIST *list);
void listInsert(LIST *list, ITEM *in, int (*func)(ITEM *,ITEM *));
int listIsEmpty(LIST *list);

#ifdef  __cplusplus
}
#endif

#endif