src/libha.h

   1 /***********************************************************************
   2  * This file is part of HA, a general purpose file archiver.
   3  * Copyright (C) 1995 Harri Hirvola
   4  * Modified by Ketmar // Invisible Vector
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  ***********************************************************************/
  20 #ifndef LIBHA_H
  21 #define LIBHA_H
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27
  28 /******************************************************************************/
  29 enum {
  30   LIBHA_ERR_OK = 0,
  31   LIBHA_ERR_READ = -1,
  32   LIBHA_ERR_WRITE = -2,
  33   LIBHA_ERR_MEMORY = -3,
  34   LIBHA_ERR_OTHER = -4
  35 };
  36
  37
  38 /******************************************************************************/
  39 enum {
  40   LIBHA_FOK = 0,
  41   LIBHA_FEOF = -1,
  42   LIBHA_FERR = -2
  43 };
  44
  45
  46 typedef struct libha_io_s {
  47   int (*bread) (void *buf, int buf_len, void *udata); /* return number of bytes read; 0: EOF; <0: error */
  48   int (*bwrite) (const void *buf, int buf_len, void *udata); /* result != buf_len: error */
  49 } libha_io_t;
  50
  51
  52 /******************************************************************************/
  53 typedef struct asc_s *asc_t;
  54
  55
  56 extern asc_t asc_alloc (const libha_io_t *iot, void *udata);
  57 extern void asc_free (asc_t asc);
  58
  59 extern const libha_io_t *asc_get_iot (asc_t asc);
  60 extern int asc_set_iot (asc_t asc, const libha_io_t *iot); /* <0: error; 0: ok */
  61
  62 extern void *asc_get_udata (asc_t asc);
  63 extern int asc_set_udata (asc_t asc, void *udata); /* <0: error; 0: ok */
  64
  65 /* there is no real need to call asc_cleanup() except if you longjmp()ed from i/o handler */
  66 extern void asc_cleanup (asc_t asc);
  67
  68 /* you need to set i/o structure before calling pack or unpack */
  69 extern int asc_pack (asc_t asc); /* LIBHA_ERR_xxx */
  70 extern int asc_unpack (asc_t asc); /* LIBHA_ERR_xxx */
  71
  72
  73 #ifdef __cplusplus
  74 }
  75 #endif
  76 #endif