gfsmEnum.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmEnum.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_ENUM_H
#define _GFSM_ENUM_H

#include <gfsmMem.h>
#include <gfsmCommon.h>

/*======================================================================
 * Types
 */


typedef struct {
  GHashTable  *table;   
  guint        nxtval;  
  gfsmDupFunc  key_dup; 
} gfsmEnum;

typedef gfsmEnum gfsmDirectEnum;

extern const guint gfsmEnumNone;


/*======================================================================
 * Methods: Constructors etc.
 */


GFSM_INLINE
gfsmEnum *gfsm_enum_new_full(gfsmDupFunc key_dup_func,
                             GHashFunc   key_hash_func,
                             GEqualFunc  key_equal_func,
                             GDestroyNotify key_destroy_func);

#define gfsm_enum_new(key_hash_f) gfsm_enum_new_full(NULL,key_hash_f,NULL,NULL)

#define gfsm_direct_enum_new() gfsm_enum_new(g_direct_hash)

GFSM_INLINE
void gfsm_enum_clear(gfsmEnum *en);

GFSM_INLINE
void gfsm_enum_free(gfsmEnum *en);

/*======================================================================
 * Methods: Accessors
 */


#define gfsm_enum_next_value(en) ((en)->nxtval)

GFSM_INLINE
gboolean gfsm_enum_lookup_extended(gfsmEnum      *en,
                                   gconstpointer  lookup_key,
                                   gpointer      *stored_key,
                                   gpointer      *stored_val);

GFSM_INLINE
guint gfsm_enum_lookup(gfsmEnum *en, gconstpointer key);


GFSM_INLINE
guint gfsm_enum_insert_full(gfsmEnum *en, gpointer key, guint val);

#define gfsm_enum_insert(en,key) gfsm_enum_insert_full(en,key,gfsmEnumNone)

#define gfsm_enum_get(en,key) gfsm_enum_insert(en,key)

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

#endif /* _GFSM_ENUM_H */