libfirm/adt/plist.h

Go to the documentation of this file.

/*
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

#ifndef FIRM_ADT_PLIST_H
#define FIRM_ADT_PLIST_H

#include <stddef.h>
#include "obst.h"

#include "../begin.h"

typedef struct plist_element plist_element_t;
typedef struct plist plist_t;

struct plist {
    struct obstack *obst;

    unsigned foreign_obstack : 1;

    plist_element_t *first_element;

    plist_element_t *last_element;

    int element_count;

    plist_element_t* first_free_element;
};

struct plist_element {
    plist_element_t *next; 
    plist_element_t *prev; 
    void            *data; 
};

FIRM_API plist_t *plist_new(void);

FIRM_API plist_t *plist_obstack_new(struct obstack *obst);

FIRM_API void plist_free(plist_t *list);

#define plist_count(list) \
    ((list)->element_count)

FIRM_API void plist_insert_back(plist_t *list, void *value);

FIRM_API void plist_insert_front(plist_t *list, void *value);

FIRM_API void plist_insert_before(plist_t *list, plist_element_t *element, void *value);

FIRM_API void plist_insert_after(plist_t *list, plist_element_t *element, void *value);

FIRM_API int plist_has_value(plist_t *list, void *value);

FIRM_API plist_element_t *plist_find_value(plist_t *list, void *value);

FIRM_API void plist_erase(plist_t *list, plist_element_t *element);

FIRM_API void plist_clear(plist_t *list);

#define plist_first(list) \
    ((list)->first_element)

#define plist_last(list) \
    ((list)->last_element)

#define plist_element_has_next(element) \
    ((element)->next != NULL)

#define plist_element_has_prev(element) \
    ((element)->prev != NULL)

#define plist_element_get_next(element) \
    ((element)->next)

#define plist_element_get_prev(element) \
    ((element)->prev)

#define plist_element_get_value(element) \
    ((element)->data)

#define foreach_plist(list, el) \
    for (el = plist_first(list); el; el = plist_element_get_next(el))

#include "../end.h"

#endif