system.c File Reference

#include <system.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>

Go to the source code of this file.

Classes
struct	mspack_file_p

Functions
int	mspack_version (int entity)
int	mspack_sys_selftest_internal (int offt_size)
int	mspack_valid_system (struct mspack_system *sys)
int	mspack_sys_filelen (struct mspack_system *system, struct mspack_file *file, off_t *length)
static struct mspack_file *	msp_open (struct mspack_system *self, const char *filename, int mode)
static void	msp_close (struct mspack_file *file)
static int	msp_read (struct mspack_file *file, void *buffer, int bytes)
static int	msp_write (struct mspack_file *file, void *buffer, int bytes)
static int	msp_seek (struct mspack_file *file, off_t offset, int mode)
static off_t	msp_tell (struct mspack_file *file)
static void	msp_msg (struct mspack_file *file, const char *format,...)
static void *	msp_alloc (struct mspack_system *self, size_t bytes)
static void	msp_free (void *buffer)
static void	msp_copy (void *src, void *dest, size_t bytes)

Variables
static struct mspack_system	msp_system
struct mspack_system *	mspack_default_system = &msp_system

Function Documentation

msp_alloc()

static void* msp_alloc ( struct mspack_system *  self, size_t  bytes  )

static

Definition at line 201 of file system.c.

                                                                 {
#if DEBUG
  /* make uninitialised data obvious */
  char *buf = malloc(bytes + 8);
  if (buf) memset(buf, 0xDC, bytes);
  *((size_t *)buf) = bytes;
  return &buf[8];
#else
  return malloc(bytes);
#endif
}

References bytes, malloc(), and memset().

msp_close()

static void msp_close ( struct mspack_file *  file )

static

Definition at line 138 of file system.c.

                                                {
  struct mspack_file_p *self = (struct mspack_file_p *) file;
  if (self) {
    fclose(self->fh);
    free(self);
  }
}

References free().

msp_copy()

static void msp_copy ( void *  src, void *  dest, size_t  bytes  )

static

Definition at line 229 of file system.c.

                                                          {
  memcpy(dest, src, bytes);
}

References bytes, dest, memcpy(), and src.

msp_free()

static void msp_free ( void *  buffer )

static

Definition at line 213 of file system.c.

                                   {
#if DEBUG
  char *buf = buffer;
  size_t bytes;
  if (buf) {
    buf -= 8;
    bytes = *((size_t *)buf);
    /* make freed data obvious */
    memset(buf, 0xED, bytes);
    free(buf);
  }
#else
  free(buffer);
#endif
}

References bytes, free(), and memset().

msp_msg()

static void msp_msg ( struct mspack_file *  file, const char *  format,   ...  )

static

Definition at line 191 of file system.c.

                                                                       {
  va_list ap;
  if (file) fprintf(stderr, "%s: ", ((struct mspack_file_p *) file)->name);
  va_start(ap, format);
  vfprintf(stderr, format, ap);
  va_end(ap);
  fputc((int) '\n', stderr);
  fflush(stderr);
}

msp_open()

static struct mspack_file* msp_open ( struct mspack_system *  self, const char *  filename, int  mode  )

static

Definition at line 116 of file system.c.

{
  struct mspack_file_p *fh;
  const char *fmode;
 
  switch (mode) {
  case MSPACK_SYS_OPEN_READ:   fmode = "rb";  break;
  case MSPACK_SYS_OPEN_WRITE:  fmode = "wb";  break;
  case MSPACK_SYS_OPEN_UPDATE: fmode = "r+b"; break;
  case MSPACK_SYS_OPEN_APPEND: fmode = "ab";  break;
  default: return NULL;
  }
 
  if ((fh = (struct mspack_file_p *) malloc(sizeof(struct mspack_file_p)))) {
    fh->name = filename;
    if ((fh->fh = fopen(filename, fmode))) return (struct mspack_file *) fh;
    free(fh);
  }
  return NULL;
}

References fh, free(), malloc(), MSPACK_SYS_OPEN_APPEND, MSPACK_SYS_OPEN_READ, MSPACK_SYS_OPEN_UPDATE, MSPACK_SYS_OPEN_WRITE, and NULL.

msp_read()

static int msp_read ( struct mspack_file *  file, void *  buffer, int  bytes  )

static

Definition at line 146 of file system.c.

                                                                       {
  struct mspack_file_p *self = (struct mspack_file_p *) file;
  if (self && buffer && bytes >= 0) {
    size_t count = fread(buffer, 1, (size_t) bytes, self->fh);
    if (!ferror(self->fh)) return (int) count;
  }
  return -1;
}

References bytes, and count.

msp_seek()

static int msp_seek ( struct mspack_file *  file, off_t  offset, int  mode  )

static

Definition at line 164 of file system.c.

                                                                      {
  struct mspack_file_p *self = (struct mspack_file_p *) file;
  if (self) {
    switch (mode) {
    case MSPACK_SYS_SEEK_START: mode = SEEK_SET; break;
    case MSPACK_SYS_SEEK_CUR:   mode = SEEK_CUR; break;
    case MSPACK_SYS_SEEK_END:   mode = SEEK_END; break;
    default: return -1;
    }
#if HAVE_FSEEKO
    return fseeko(self->fh, offset, mode);
#else
    return fseek(self->fh, offset, mode);
#endif
  }
  return -1;
}

References fseeko, MSPACK_SYS_SEEK_CUR, MSPACK_SYS_SEEK_END, MSPACK_SYS_SEEK_START, SEEK_CUR, SEEK_END, and SEEK_SET.

msp_tell()

static off_t msp_tell ( struct mspack_file *  file )

static

Definition at line 182 of file system.c.

                                                {
  struct mspack_file_p *self = (struct mspack_file_p *) file;
#if HAVE_FSEEKO
  return (self) ? (off_t) ftello(self->fh) : 0;
#else
  return (self) ? (off_t) ftell(self->fh) : 0;
#endif
}

References ftello.

msp_write()

static int msp_write ( struct mspack_file *  file, void *  buffer, int  bytes  )

static

Definition at line 155 of file system.c.

                                                                        {
  struct mspack_file_p *self = (struct mspack_file_p *) file;
  if (self && buffer && bytes >= 0) {
    size_t count = fwrite(buffer, 1, (size_t) bytes, self->fh);
    if (!ferror(self->fh)) return (int) count;
  }
  return -1;
}

References bytes, and count.

mspack_sys_filelen()

int mspack_sys_filelen	(	struct mspack_system *	system,
		struct mspack_file *	file,
		off_t *	length
	)

Definition at line 66 of file system.c.

{
  off_t current;
 
  if (!system || !file || !length) return MSPACK_ERR_OPEN;
 
  /* get current offset */
  current = system->tell(file);
 
  /* seek to end of file */
  if (system->seek(file, (off_t) 0, MSPACK_SYS_SEEK_END)) {
    return MSPACK_ERR_SEEK;
  }
 
  /* get offset of end of file */
  *length = system->tell(file);
 
  /* seek back to original offset */
  if (system->seek(file, current, MSPACK_SYS_SEEK_START)) {
    return MSPACK_ERR_SEEK;
  }
 
  return MSPACK_ERR_OK;
}

References length, MSPACK_ERR_OK, MSPACK_ERR_OPEN, MSPACK_ERR_SEEK, MSPACK_SYS_SEEK_END, MSPACK_SYS_SEEK_START, mspack_system::seek, and mspack_system::tell.

Referenced by cabd_search().

mspack_sys_selftest_internal()

int mspack_sys_selftest_internal

(

int

offt_size

)

Part of the MSPACK_SYS_SELFTEST() macro, must not be used directly.

Definition at line 53 of file system.c.

                                                {
  return (sizeof(off_t) == offt_size) ? MSPACK_ERR_OK : MSPACK_ERR_SEEK;
}

mspack_valid_system()

int mspack_valid_system

(

struct mspack_system *

sys

)

Definition at line 58 of file system.c.

                                                   {
  return (sys != NULL) && (sys->open != NULL) && (sys->close != NULL) &&
    (sys->read != NULL) && (sys->write != NULL) && (sys->seek != NULL) &&
    (sys->tell != NULL) && (sys->message != NULL) && (sys->alloc != NULL) &&
    (sys->free != NULL) && (sys->copy != NULL) && (sys->null_ptr == NULL);
}

References mspack_system::alloc, mspack_system::close, mspack_system::copy, mspack_system::free, mspack_system::message, NULL, mspack_system::null_ptr, mspack_system::open, mspack_system::read, mspack_system::seek, mspack_system::tell, and mspack_system::write.

Referenced by mspack_create_cab_decompressor(), mspack_create_chm_decompressor(), mspack_create_kwaj_decompressor(), mspack_create_oab_decompressor(), and mspack_create_szdd_decompressor().

mspack_version()

int mspack_version

(

int

entity

)

Enquire about the binary compatibility version of a specific interface in the library. Currently, the following interfaces are defined:

• MSPACK_VER_LIBRARY: the overall library
• MSPACK_VER_SYSTEM: the mspack_system interface
• MSPACK_VER_MSCABD: the mscab_decompressor interface
• MSPACK_VER_MSCABC: the mscab_compressor interface
• MSPACK_VER_MSCHMD: the mschm_decompressor interface
• MSPACK_VER_MSCHMC: the mschm_compressor interface
• MSPACK_VER_MSLITD: the mslit_decompressor interface
• MSPACK_VER_MSLITC: the mslit_compressor interface
• MSPACK_VER_MSHLPD: the mshlp_decompressor interface
• MSPACK_VER_MSHLPC: the mshlp_compressor interface
• MSPACK_VER_MSSZDDD: the msszdd_decompressor interface
• MSPACK_VER_MSSZDDC: the msszdd_compressor interface
• MSPACK_VER_MSKWAJD: the mskwaj_decompressor interface
• MSPACK_VER_MSKWAJC: the mskwaj_compressor interface
• MSPACK_VER_MSOABD: the msoab_decompressor interface
• MSPACK_VER_MSOABC: the msoab_compressor interface

The result of the function should be interpreted as follows:

• -1: this interface is completely unknown to the library
• 0: this interface is known, but non-functioning
• 1: this interface has all basic functionality
• 2, 3, ...: this interface has additional functionality, clearly marked in the documentation as "version 2", "version 3" and so on.

Parameters

entity

the interface to request current version of

Returns

the version of the requested interface

Definition at line 16 of file system.c.

                               {
  switch (entity) {
   /* CHM decoder version 1 -> 2 changes:
    * - added mschmd_sec_mscompressed::spaninfo
    * - added mschmd_header::first_pmgl
    * - added mschmd_header::last_pmgl
    * - added mschmd_header::chunk_cache;
    */
  case MSPACK_VER_MSCHMD:
  /* CAB decoder version 1 -> 2 changes:
   * - added MSCABD_PARAM_SALVAGE
   */
  case MSPACK_VER_MSCABD:
  /* OAB decoder version  1 -> 2 changes:
   * - added msoab_decompressor::set_param and MSOABD_PARAM_DECOMPBUF
   */
  case MSPACK_VER_MSOABD:
    return 2;
  case MSPACK_VER_LIBRARY:
  case MSPACK_VER_SYSTEM:
  case MSPACK_VER_MSSZDDD:
  case MSPACK_VER_MSKWAJD:
    return 1;
  case MSPACK_VER_MSCABC:
  case MSPACK_VER_MSCHMC:
  case MSPACK_VER_MSLITD:
  case MSPACK_VER_MSLITC:
  case MSPACK_VER_MSHLPD:
  case MSPACK_VER_MSHLPC:
  case MSPACK_VER_MSSZDDC:
  case MSPACK_VER_MSKWAJC:
  case MSPACK_VER_MSOABC:
    return 0;
  }
  return -1;
}

Variable Documentation

msp_system

struct mspack_system msp_system

static

Initial value:

= {
  &msp_open, &msp_close, &msp_read,  &msp_write, &msp_seek,
  &msp_tell, &msp_msg, &msp_alloc, &msp_free, &msp_copy, NULL
}

Definition at line 229 of file system.c.

mspack_default_system

struct mspack_system* mspack_default_system = &msp_system

Definition at line 238 of file system.c.

Referenced by mspack_create_cab_decompressor(), mspack_create_chm_decompressor(), mspack_create_kwaj_decompressor(), mspack_create_oab_decompressor(), and mspack_create_szdd_decompressor().