stnd_sps_io.h

/* stnd_sps_io.h */
/* $Id: stnd_sps_io.h,v 1.2 2001/04/18 14:32:04 vlad Exp $ */
#ifndef __stnd_sps_io_h
#define __stnd_sps_io_h

#include <mix/ErrCodes.h>
#include <mix/trans.h>
#include <mix/stnd_sps.h>


/***********************************************************************
 * Input/output of VSP-PC SPS file is controlled by this structure:
 ***********************************************************************/
typedef struct
{
  char      *fpath;     /* file path or device name */
  int       fildes;     /* file handle */
  char      omode;      /* operating mode: 'r' - read, 'w' - write */

  SPS_Dir   sps_dir;    /* description part */
  Char      *sps_comment;   /* comments or NULL */
  SPS_Dir2  sps_dir2;   /* additional parameters (type V) */
  union {
    char    *buf;
    Int2    *i2;
    Int4    *i4;
    Real4   *r4;
  }     sps_arg,    /* arguments (short or list format) */
        sps_par;    /* parameters: p1[0],p2[0],p1[1],p2[1],p1[2] */

  AtomType  arg_at, par_at; /* format of argument and parameters */
  int       arg_n;      /* arguments number (sps_dir.key sensitive) */

}   sps_io_t;


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


/******************************
 * Input/output               *
 ******************************/

/* Open VSP-PC SPS file for writing. */
ErrCode     sps_open_file_write (sps_io_t* io,
                     const char* szFilePath);

/* Open VSP-PC SPS file for reading. */
ErrCode     sps_open_file_read (sps_io_t* io,
                    const char* szFilePath);

/* Close VSP-PC SPS file. */
ErrCode     sps_close (sps_io_t* io);

/* Read SPS data from file. */
ErrCode     sps_read_file (sps_io_t* io);

/* Write SPS data to file. */
ErrCode     sps_write_file (sps_io_t* io);

/* Prepare short argument format for given number of lines. */
ErrCode     sps_short_arg_prepare (sps_io_t* io, int lines_n);

/* Prepare list argument format for given number of lines. */
ErrCode     sps_list_arg_prepare (sps_io_t* io, int lines_n);

/* Setup names and parameters number for given kind of SPS */
ErrCode     sps_setup_kind (sps_io_t* io, char sps_kind);


/******************************
 *   Input/Ouput buffer to    *
 *  C structure conversion.   *
 ******************************/

/* Copy SPS directory from structure to file I/O buffer. */
ErrCode     sps_copy_dir2io (void* buf, const SPS_Dir* dir);

/* Copy SPS directory from file I/O buffer to structure. */
ErrCode     sps_copy_io2dir (void* buf, SPS_Dir* dir);

/* Format convertor from I/O to AtomType. */
AtomType    sps_copy_io2f (const char* f);

/* Format convertor from AtomType to I/O. */
void        sps_copy_f2io (AtomType at, char* f);


#ifdef __cplusplus
};
#endif /* __cplusplus */



#endif /* stnd_sps_io.h */