ccl-list.h

Go to the documentation of this file.

/*
 * ccl-list.h -- A generic list encoded with a simple chaining.
 * 
 * This file is a part of the C Common Library (CCL) project. 
 * 
 * Copyright (C) 2010 CNRS UMR 5800 & Université Bordeaux I (see AUTHORS file).
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the AltaRica Public License that comes with this
 * package.
 * 
 * This program 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. 
 */

#ifndef __CCL_LIST_H__
# define __CCL_LIST_H__

# include <ccl/ccl-assert.h>
# include <ccl/ccl-protos.h>
# include <ccl/ccl-iterator.h>

BEGIN_C_DECLS

typedef struct ccl_list_st ccl_list;

typedef struct ccl_pair_st ccl_pair;

# ifndef IN_DOXYGEN_DOC
struct ccl_list_st {
  int size;
  ccl_pair *first;
  ccl_pair **last;
};

struct ccl_pair_st {
  void *car;
  ccl_pair *cdr;
};
# endif 

# define FIRST(l) ((l)->first)

# define CAR(p)   ((p)->car)

# define CDR(p)   ((p)->cdr)

# define CADR(p)  (CAR (CDR (p)))

# define CDDR(p)  (CDR (CDR (p)))

# define CADDR(p) (CAR (CDDR (p)))

# define CDDDR(p) (CDR (CDDR (p)))

# define CADDDR(p) (CAR (CDDDR (p)))

# define CDDDDR(p) (CDR (CDDDR (p)))

# define CADDDDR(p) (CAR (CDDDDR (p)))

# define CDDDDDR(p) (CDR (CDDDDR (p)))

# define CCL_LIST_FOREACH(p,l) for ((p)=FIRST(l); (p); (p) = CDR (p))

extern ccl_list *
ccl_list_create (void);

extern void
ccl_list_delete (ccl_list *l);

extern void
ccl_list_clear (ccl_list *l, ccl_delete_proc *del);

extern void
ccl_list_clear_and_delete (ccl_list *l, ccl_delete_proc *del);

# define ccl_list_get_size(l)   (ccl_pre ((l) != NULL), (l)->size)

# define ccl_list_get_length(l) ccl_list_get_size(l)

# define ccl_list_is_empty(l) (ccl_list_get_size (l) ==0)

extern void
ccl_list_add (ccl_list *l, void *obj);

extern int
ccl_list_has (const ccl_list *l, void *obj);

extern void
ccl_list_put_first (ccl_list *l, void *obj);

extern void *
ccl_list_take_first (ccl_list *l);

extern void
ccl_list_sort (ccl_list *l, ccl_compare_func *cmp);

extern void
ccl_list_sort_with_data (ccl_list *l, ccl_compare_with_data_func *cmp, 
                         void *data);

extern int
ccl_list_insert (ccl_list *l, void *obj, ccl_compare_func *cmp);

extern void
ccl_list_insert_before (ccl_list *l, void *obj, void *inserted);

extern void
ccl_list_insert_after (ccl_list *l, void *obj, void *inserted);

extern int
ccl_list_equals (const ccl_list *l1, const ccl_list *l2);

extern ccl_list *
ccl_list_dup (const ccl_list *l);

extern ccl_list *
ccl_list_deep_dup (const ccl_list *l, ccl_duplicate_func *dup);

extern void *
ccl_list_get_at (ccl_list *l, int index);

extern void 
ccl_list_remove (ccl_list *l, void *p);

extern void 
ccl_list_remove_filtered (ccl_list *l, int (*filter)(void *p, void *data),
                          void *filter_data, ccl_delete_proc *del);

extern void
ccl_list_sub (ccl_list *l1, const ccl_list *l2);

extern void
ccl_list_append (ccl_list *l1, const ccl_list *l2);

extern void
ccl_list_deep_append (ccl_list *l1, const ccl_list *l2, 
                      ccl_duplicate_func *dup);

extern int
ccl_list_get_index (const ccl_list *l, void *ptr, ccl_compare_func *cmp);

extern int
ccl_list_compare (const ccl_list *l1, const ccl_list *l2, 
                  ccl_compare_func *cmp);

extern unsigned int
ccl_list_hash (const ccl_list *l);

extern unsigned int
ccl_list_hash_all (const ccl_list *l, ccl_hash_func *h);

extern void **
ccl_list_to_array (const ccl_list *l, int *p_size);


extern ccl_pointer_iterator *
ccl_list_get_iterator (ccl_list *l, ccl_duplicate_func *dup, 
                       ccl_delete_proc *del);

extern ccl_list *
ccl_list_create_from_iterator (ccl_pointer_iterator *i);

extern void
ccl_list_map (const ccl_list *l, ccl_map_proc *map, void *data);

END_C_DECLS

#endif /* ! __CCL_LIST_H__ */