gfsmSet.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmSet.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library
 *
 * Copyright (c) 2004-2007 Bryan Jurish.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *=============================================================================*/

#ifndef _GFSM_SET_H
#define _GFSM_SET_H

#include <gfsmMem.h>

/*======================================================================
 * Types
 */
typedef GTree gfsmSet;


/*======================================================================
 * Constructors etc.
 */


GFSM_INLINE
gfsmSet *gfsm_set_new_full(GCompareDataFunc key_cmp_func, gpointer key_cmp_data, GDestroyNotify key_free_func);

GFSM_INLINE
gfsmSet *gfsm_set_new(GCompareFunc key_cmp_func);

GFSM_INLINE
gfsmSet *gfsm_set_copy(gfsmSet *dst, gfsmSet *src);

gboolean gfsm_set_copy_foreach_func(gpointer key, gpointer value, gfsmSet *dst);

void gfsm_set_clear(gfsmSet *set);

#define gfsm_set_free g_tree_destroy



/*======================================================================
 * Accessors
 */


#define gfsm_set_contains(set,key) g_tree_lookup(set,key)

#define gfsm_set_insert(set,key) g_tree_insert(set,key,(gpointer)1)

#define gfsm_set_size(set) g_tree_nnodes(set)

#define gfsm_set_remove(set,key) g_tree_remove(set,key)

#define gfsm_set_foreach(set,func,data) g_tree_foreach(set,func,data)


/*======================================================================
 * set: Algebra
 */


GFSM_INLINE
gfsmSet *gfsm_set_union(gfsmSet *set1, gfsmSet *set2, gfsmDupFunc dupfunc);

GFSM_INLINE
gfsmSet *gfsm_set_difference(gfsmSet *set1, gfsmSet *set2);

gfsmSet *gfsm_set_intersection(gfsmSet *set1, gfsmSet *set2);



/*======================================================================
 * Converters
 */


GFSM_INLINE
GSList *gfsm_set_to_slist(gfsmSet *set);

gboolean gfsm_set_to_slist_foreach_func(gpointer key, gpointer value, GSList **dst);

GFSM_INLINE
void gfsm_set_to_ptr_array(gfsmSet *set, GPtrArray *array);

gboolean gfsm_set_to_ptr_array_foreach_func(gpointer key, gpointer value, GPtrArray *dst);

/*======================================================================
 * Debugging
 */
#ifdef GFSM_DEBUG_ENABLED
#include <stdio.h>



void gfsm_set_print_uint(gfsmSet *set, FILE *f);

#endif /* GFSM_DEBUG_ENABLED */

//-- inline definitions
#ifdef GFSM_INLINE_ENABLED
# include <gfsmSet.hi>
#endif

#endif /* _GFSM_SET_H */