gfsmIndexedIO.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmIndexedIO.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library: indexed automata: I/O
 *
 * Copyright (c) 2007 Bryan Jurish.
 *
 * For information on usage and redistribution, and for a DISCLAIMER
 * OF ALL WARRANTIES, see the file "COPYING" in this distribution.
 *
 * 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_INDEXED_IO_H
#define _GFSM_INDEXED_IO_H

#include <gfsmAutomatonIO.h>
#include <gfsmIndexed.h>

/*======================================================================
 * Types
 */
typedef struct {
  gchar              magic[16];    
  gfsmVersionInfo    version;      
  gfsmVersionInfo    version_min;  
  gfsmAutomatonFlags flags;        
  gfsmStateId        root_id;      
  gfsmStateId        n_states;     
  gfsmStateId        n_arcs;       
  guint32            srtype;       
  guint32            sort_mask;    
  guint32            reserved2;    
  guint32            reserved3;    
} gfsmIndexedAutomatonHeader;

/*======================================================================
 * Constants
 */

extern const gchar gfsm_indexed_header_magic[16];

extern const gfsmVersionInfo gfsm_indexed_version_bincompat_min_store;

extern const gfsmVersionInfo gfsm_indexed_version_bincompat_min_check;

/*======================================================================
 * Methods: Binary I/O
 */


gboolean gfsm_indexed_automaton_load_header(gfsmIndexedAutomatonHeader *hdr, gfsmIOHandle *ioh, gfsmError **errp);

gboolean gfsm_indexed_automaton_load_bin_handle(gfsmIndexedAutomaton *fsm, gfsmIOHandle *ioh, gfsmError **errp);

gboolean gfsm_indexed_automaton_load_bin_file(gfsmIndexedAutomaton *fsm, FILE *f, gfsmError **errp);

gboolean gfsm_indexed_automaton_load_bin_filename(gfsmIndexedAutomaton *fsm, const gchar *filename, gfsmError **errp);

gboolean gfsm_indexed_automaton_load_bin_gstring(gfsmIndexedAutomaton *fsm, GString *gs, gfsmError **errp);

/*--------------------------------------------------------------*/

gboolean gfsm_indexed_automaton_save_bin_handle(gfsmIndexedAutomaton *fsm, gfsmIOHandle *ioh, gfsmError **errp);

gboolean gfsm_indexed_automaton_save_bin_file(gfsmIndexedAutomaton *fsm, FILE *f, gfsmError **errp);

gboolean gfsm_indexed_automaton_save_bin_filename_nc(gfsmIndexedAutomaton *fsm, const gchar *filename, gfsmError **errp);

gboolean gfsm_indexed_automaton_save_bin_filename(gfsmIndexedAutomaton *fsm, const gchar *filename, int zlevel, gfsmError **errp);

gboolean gfsm_indexed_automaton_save_bin_gstring(gfsmIndexedAutomaton *fsm, GString *gs, gfsmError **errp);


/*======================================================================
 * Automaton Methods: Text I/O
 */


gboolean gfsm_indexed_automaton_print_handle (gfsmIndexedAutomaton *fsm,
                                              gfsmIOHandle  *ioh,
                                              gfsmAlphabet  *lo_alphabet,
                                              gfsmAlphabet  *hi_alphabet,
                                              gfsmAlphabet  *state_alphabet,
                                              gfsmError     **errp);


gboolean gfsm_indexed_automaton_print_file_full (gfsmIndexedAutomaton *fsm,
                                                 FILE          *f,
                                                 gfsmAlphabet  *lo_alphabet,
                                                 gfsmAlphabet  *hi_alphabet,
                                                 gfsmAlphabet  *state_alphabet,
                                                 int            zlevel,
                                                 gfsmError     **errp);

#define gfsm_indexed_automaton_print_file(fsm,f,errp) \
  gfsm_indexed_automaton_print_file_full(fsm,f,NULL,NULL,NULL,0,errp)

gboolean gfsm_indexed_automaton_print_filename_full (gfsmIndexedAutomaton *fsm,
                                                     const gchar   *filename,
                                                     gfsmAlphabet  *lo_alphabet,
                                                     gfsmAlphabet  *hi_alphabet,
                                                     gfsmAlphabet  *state_alphabet,
                                                     int            zlevel,
                                                     gfsmError     **errp);

#define gfsm_indexed_automaton_print_filename(fsm,f,errp) \
  gfsm_indexed_automaton_print_filename_full(fsm,f,NULL,NULL,NULL,0,errp)

gboolean gfsm_indexed_automaton_print_gstring_full (gfsmIndexedAutomaton *fsm,
                                                    GString       *gs,
                                                    gfsmAlphabet  *lo_alphabet,
                                                    gfsmAlphabet  *hi_alphabet,
                                                    gfsmAlphabet  *state_alphabet,
                                                    gfsmError     **errp);


#endif /* _GFSM_INDEXED_IO_H */