ccl-iterator.h

Go to the documentation of this file.

/*
 * ccl-iterator.h -- A generic iterator interface
 * 
 * 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_ITERATOR_H__
# define __CCL_ITERATOR_H__

# include <ccl/ccl-common.h>
# include <ccl/ccl-protos.h>

# define CCL_ITERATOR_TYPEDEF(_typename_,_eltype_) \
typedef struct ccl_iterator_ ## _typename_ ## _st _typename_; \
struct ccl_iterator_ ## _typename_ ## _st { \
  int (*has_more_elements) (const _typename_ *i); \
  _eltype_ (*next_element) (_typename_ *i); \
  void  (*delete_iterator) (_typename_ *i); \
}

CCL_ITERATOR_TYPEDEF (ccl_pointer_iterator, void *);

CCL_ITERATOR_TYPEDEF (ccl_int_iterator, int);

# define ccl_iterator_has_more_elements(i) ((i)->has_more_elements (i))

# define ccl_iterator_next_element(i) ((i)->next_element (i))

# define ccl_iterator_delete(i) ((i)->delete_iterator (i))

BEGIN_C_DECLS

extern ccl_pointer_iterator *
ccl_iterator_crt_filter (ccl_pointer_iterator *base, 
                         int (*accept) (void *obj, void *data), 
                         void *data,
                         ccl_delete_proc *del);

extern ccl_pointer_iterator *
ccl_iterator_crt_concat (ccl_pointer_iterator *i1, ccl_pointer_iterator *i2);

extern ccl_pointer_iterator *
ccl_iterator_crt_sequence (int nb_iterators, ccl_pointer_iterator **iterators);

extern ccl_pointer_iterator *
ccl_iterator_crt_dup (ccl_pointer_iterator *iterators,
                      ccl_duplicate_func *dup);

END_C_DECLS

#endif /* ! __CCL_ITERATOR_H__ */