mspack.h

Go to the documentation of this file.

/* libmspack -- a library for working with Microsoft compression formats.
 * (C) 2003-2016 Stuart Caie <kyzer@cabextract.org.uk>
 *
 * libmspack is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License (LGPL) version 2.1
 *
 * This program 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 program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef LIB_MSPACK_H
#define LIB_MSPACK_H 1

#ifdef __cplusplus
extern "C" {
#endif

#include <sys/types.h>
#include <stdlib.h>

#define MSPACK_SYS_SELFTEST(result)  do { \
  (result) = mspack_sys_selftest_internal(sizeof(off_t)); \
} while (0)

extern int mspack_sys_selftest_internal(int);

extern int mspack_version(int entity);

#define MSPACK_VER_LIBRARY   (0)

#define MSPACK_VER_SYSTEM    (1)

#define MSPACK_VER_MSCABD    (2)

#define MSPACK_VER_MSCABC    (3)

#define MSPACK_VER_MSCHMD    (4)

#define MSPACK_VER_MSCHMC    (5)

#define MSPACK_VER_MSLITD    (6)

#define MSPACK_VER_MSLITC    (7)

#define MSPACK_VER_MSHLPD    (8)

#define MSPACK_VER_MSHLPC    (9)

#define MSPACK_VER_MSSZDDD   (10)

#define MSPACK_VER_MSSZDDC   (11)

#define MSPACK_VER_MSKWAJD   (12)

#define MSPACK_VER_MSKWAJC   (13)

#define MSPACK_VER_MSOABD    (14)

#define MSPACK_VER_MSOABC    (15)

/* --- file I/O abstraction ------------------------------------------------ */

struct mspack_system {
  struct mspack_file * (*open)(struct mspack_system *self,
                   const char *filename,
                   int mode);

  void (*close)(struct mspack_file *file);

  int (*read)(struct mspack_file *file,
          void *buffer,
          int bytes);

  int (*write)(struct mspack_file *file,
           void *buffer,
           int bytes);

  int (*seek)(struct mspack_file *file,
          off_t offset,
          int mode);

  off_t (*tell)(struct mspack_file *file);
  
  void (*message)(struct mspack_file *file,
          const char *format,
          ...);

  void * (*alloc)(struct mspack_system *self,
          size_t bytes);
  
  void (*free)(void *ptr);

  void (*copy)(void *src,
           void *dest,
           size_t bytes);

  void *null_ptr;
};

#define MSPACK_SYS_OPEN_READ   (0)

#define MSPACK_SYS_OPEN_WRITE  (1)

#define MSPACK_SYS_OPEN_UPDATE (2)

#define MSPACK_SYS_OPEN_APPEND (3)

#define MSPACK_SYS_SEEK_START  (0)

#define MSPACK_SYS_SEEK_CUR    (1)

#define MSPACK_SYS_SEEK_END    (2)

struct mspack_file {
  int dummy;
};

/* --- error codes --------------------------------------------------------- */

#define MSPACK_ERR_OK          (0)

#define MSPACK_ERR_ARGS        (1)

#define MSPACK_ERR_OPEN        (2)

#define MSPACK_ERR_READ        (3)

#define MSPACK_ERR_WRITE       (4)

#define MSPACK_ERR_SEEK        (5)

#define MSPACK_ERR_NOMEMORY    (6)

#define MSPACK_ERR_SIGNATURE   (7)

#define MSPACK_ERR_DATAFORMAT  (8)

#define MSPACK_ERR_CHECKSUM    (9)

#define MSPACK_ERR_CRUNCH      (10)

#define MSPACK_ERR_DECRUNCH    (11)

/* --- functions available in library -------------------------------------- */

extern struct mscab_compressor *
  mspack_create_cab_compressor(struct mspack_system *sys);

extern struct mscab_decompressor *
  mspack_create_cab_decompressor(struct mspack_system *sys);

extern void mspack_destroy_cab_compressor(struct mscab_compressor *self);

extern void mspack_destroy_cab_decompressor(struct mscab_decompressor *self);


extern struct mschm_compressor *
  mspack_create_chm_compressor(struct mspack_system *sys);

extern struct mschm_decompressor *
  mspack_create_chm_decompressor(struct mspack_system *sys);

extern void mspack_destroy_chm_compressor(struct mschm_compressor *self);

extern void mspack_destroy_chm_decompressor(struct mschm_decompressor *self);


extern struct mslit_compressor *
  mspack_create_lit_compressor(struct mspack_system *sys);

extern struct mslit_decompressor *
  mspack_create_lit_decompressor(struct mspack_system *sys);

extern void mspack_destroy_lit_compressor(struct mslit_compressor *self);

extern void mspack_destroy_lit_decompressor(struct mslit_decompressor *self);


extern struct mshlp_compressor *
  mspack_create_hlp_compressor(struct mspack_system *sys);

extern struct mshlp_decompressor *
  mspack_create_hlp_decompressor(struct mspack_system *sys);

extern void mspack_destroy_hlp_compressor(struct mshlp_compressor *self);

extern void mspack_destroy_hlp_decompressor(struct mshlp_decompressor *self);


extern struct msszdd_compressor *
  mspack_create_szdd_compressor(struct mspack_system *sys);

extern struct msszdd_decompressor *
  mspack_create_szdd_decompressor(struct mspack_system *sys);

extern void mspack_destroy_szdd_compressor(struct msszdd_compressor *self);

extern void mspack_destroy_szdd_decompressor(struct msszdd_decompressor *self);


extern struct mskwaj_compressor *
  mspack_create_kwaj_compressor(struct mspack_system *sys);

extern struct mskwaj_decompressor *
  mspack_create_kwaj_decompressor(struct mspack_system *sys);