gfsmArcIter.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmArcIter.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library: arc iterators
 *
 * Copyright (c) 2004-2011 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_ARCITER_H
#define _GFSM_ARCITER_H

#include <gfsmAutomaton.h>

/*======================================================================
 * Types: Arc iterators
 */
typedef struct {
  gfsmAutomaton *fsm;    
  gfsmState     *state;  
  gfsmArcList   *arcs;   
} gfsmArcIter;

/*======================================================================
 * Methods: Arc iterators: open/close
 */


GFSM_INLINE
void gfsm_arciter_open(gfsmArcIter *aip, gfsmAutomaton *fsm, gfsmStateId stateid);

GFSM_INLINE
void gfsm_arciter_open_ptr(gfsmArcIter *aip, gfsmAutomaton *fsm, gfsmState *stateptr);

GFSM_INLINE
void gfsm_arciter_close(gfsmArcIter *aip);

GFSM_INLINE
gfsmArcIter *gfsm_arciter_copy(gfsmArcIter *dst, const gfsmArcIter *src);

/* Create and return a new (shallow) copy of a ::gfsmArcIter.
 * \param src The ::gfsmArcIter whose positional data is to be duplicated.
 * \note
 *  \li Only the position pointed to should be copied by this method,
 *      and not the underlying data.
 *  \li If you use this method to copy ::gfsmArcIter positions,
 *      you should subsequently call gfsm_arciter_close() on only
 *      \e one of them!
 */
GFSM_INLINE
gfsmArcIter *gfsm_arciter_clone(const gfsmArcIter *src);


/*======================================================================
 * Methods: Arc iterators: Accessors
 */


GFSM_INLINE
gboolean gfsm_arciter_ok(const gfsmArcIter *aip);

GFSM_INLINE
void gfsm_arciter_next(gfsmArcIter *aip);

GFSM_INLINE
void gfsm_arciter_reset(gfsmArcIter *aip);

GFSM_INLINE
gfsmArc *gfsm_arciter_arc(const gfsmArcIter *aip);

GFSM_INLINE
void gfsm_arciter_remove(gfsmArcIter *aip);


void gfsm_arciter_seek_lower(gfsmArcIter *aip, gfsmLabelVal lo);

void gfsm_arciter_seek_upper(gfsmArcIter *aip, gfsmLabelVal hi);

void gfsm_arciter_seek_both(gfsmArcIter *aip, gfsmLabelVal lo, gfsmLabelVal hi);

void gfsm_arciter_seek_all(gfsmArcIter *aip, gfsmLabelVal lo, gfsmLabelVal hi, gfsmStateId dst);

typedef gboolean (*gfsmArcIterSeekFunc) (gfsmArcIter *aip, gpointer data);

void gfsm_arciter_seek_user(gfsmArcIter *aip,
                            gfsmArcIterSeekFunc seekfunc,
                            gpointer data);



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

#endif /* _GFSM_ARCITER_H */