include/pelib/map.h

Go to the documentation of this file.

/*
 * map.h
 *
 *  Created on: 5 Sep 2011
 *  Copyright 2011 Nicolas Melot
 *
 * This file is part of pelib.
 * 
 *     pelib 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 3 of the License, or
 *     (at your option) any later version.
 * 
 *     pelib 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.
 * 
 *     You should have received a copy of the GNU General Public License
 *     along with pelib. If not, see <http://www.gnu.org/licenses/>.
 * 
 */

#include <pelib/template.h>
#if PELIB_CONCAT_4(DONE_map_, MAP_KEY_T, _, MAP_VALUE_T) == 0
#define map(key, value) PELIB_CONCAT_4(map_, key, _, value)
#define map_t(key, value) PELIB_CONCAT_2(map(key, value), _t)
#define map_iterator(key, value) PELIB_CONCAT_2(map_, iterator(pair_t(key, value)))
#define map_iterator_t(key, value) PELIB_CONCAT_2(map_iterator(key, value), _t)

/*
#define PAIR_KEY_T MAP_KEY_T
#define PAIR_VALUE_T MAP_VALUE_T
#include <pelib/pair.h>
*/

/*
#define ITERATOR_T pair_t(MAP_KEY_T, MAP_VALUE_T)
#include <pelib/iterator.h>
*/

#define pelib_map_begin(key, value) PELIB_CONCAT_3(pelib_, map(key, value), _begin)
#define pelib_map_end(key, value) PELIB_CONCAT_3(pelib_, map(key, value), _end)
#define pelib_map_next(key, value) PELIB_CONCAT_3(pelib_, map(key, value), _next)
#define pelib_map_read(key, value) PELIB_CONCAT_3(pelib_, map(key, value), _read)
#define pelib_map_insert(key, value) PELIB_CONCAT_3(pelib_, map(key, value), _insert)
#define pelib_map_find(key, value) PELIB_CONCAT_3(pelib_, map(key, value), _find)
#define pelib_map_compare(key, value) PELIB_CONCAT_3(pelib_, map(key, value), _compare)
#define pelib_map_size(key, value) PELIB_CONCAT_3(pelib_, map(key, value), _size)

struct map(MAP_KEY_T, MAP_VALUE_T)
{
        iterator_t(pair_t(MAP_KEY_T, MAP_VALUE_T)) *first, *last, *middle; 
};
typedef struct map(MAP_KEY_T, MAP_VALUE_T) map_t(MAP_KEY_T, MAP_VALUE_T);
typedef struct iterator(pair_t(MAP_KEY_T, MAP_VALUE_T)) map_iterator_t(MAP_KEY_T, MAP_VALUE_T);

#define STRUCT_T map_t(MAP_KEY_T, MAP_VALUE_T)
#include <pelib/structure.h>

/* Returns the first element in map */
iterator_t(pair_t(MAP_KEY_T, MAP_VALUE_T))*
pelib_map_begin(MAP_KEY_T, MAP_VALUE_T)(map_t(MAP_KEY_T, MAP_VALUE_T)*);

/* Returns the first element in map */
iterator_t(pair_t(MAP_KEY_T, MAP_VALUE_T))*
pelib_map_end(MAP_KEY_T, MAP_VALUE_T)(map_t(MAP_KEY_T, MAP_VALUE_T)*);

/* Places an element in map */
int
pelib_map_insert(MAP_KEY_T, MAP_VALUE_T)(map_t(MAP_KEY_T, MAP_VALUE_T)*, pair_t(MAP_KEY_T, MAP_VALUE_T));

/* Find an element in map */
iterator_t(pair_t(MAP_KEY_T, MAP_VALUE_T))*
pelib_map_find(MAP_KEY_T, MAP_VALUE_T)(map_t(MAP_KEY_T, MAP_VALUE_T)*, MAP_KEY_T);

int
pelib_map_compare(MAP_KEY_T, MAP_VALUE_T)(map_t(MAP_KEY_T, MAP_VALUE_T)* a1, map_t(MAP_KEY_T, MAP_VALUE_T)* a2);

iterator_t(pair_t(MAP_KEY_T, MAP_VALUE_T))*
pelib_map_next(MAP_KEY_T, MAP_VALUE_T)(iterator_t(pair_t(MAP_KEY_T, MAP_VALUE_T))*);

pair_t(MAP_KEY_T, MAP_VALUE_T)
pelib_map_read(MAP_KEY_T, MAP_VALUE_T)(iterator_t(pair_t(MAP_KEY_T, MAP_VALUE_T))*);

size_t
pelib_map_size(MAP_KEY_T, MAP_VALUE_T)(map_t(MAP_KEY_T, MAP_VALUE_T)*);

#endif

// Make sure the symbol does not propagate any further
#undef MAP_KEY_T 
#undef MAP_VALUE_T