mfile.h

Go to the documentation of this file.

 
#ifndef MFILE_H
#define MFILE_H
 
#if !defined( MFILE_MMAP ) && !defined( RETROFLAT_API_WINCE )
#  include <sys/stat.h>
#endif /* !MFILE_MMAP */
 
/* TODO: async file_open() call that kicks off download to mem buffer that can
 *       be checked with looped check function.
 */
 
#ifndef MAUG_PATH_MAX
#  define MAUG_PATH_MAX 256
#endif /* !MAUG_PATH_MAX */
 
#define MFILE_CADDY_TYPE_FILE 0x01
 
#define MFILE_CADDY_TYPE_MEM_BUFFER 0x80
 
 /* maug_mfile_types */
 
#define MFILE_FLAG_READ_ONLY     0x01
 
#define MFILE_READ_FLAG_LSBF     0x01
 
#ifndef MFILE_TRACE_LVL
#  define MFILE_TRACE_LVL 0
#endif /* !MFILE_TRACE_LVL */
 
struct MFILE_CADDY;
 
typedef MERROR_RETVAL (*mfile_seek_t)( struct MFILE_CADDY* p_file, off_t pos );
typedef MERROR_RETVAL (*mfile_read_int_t)(
   struct MFILE_CADDY* p_file, uint8_t* buf, size_t buf_sz, uint8_t flags );
typedef MERROR_RETVAL (*mfile_read_line_t)(
   struct MFILE_CADDY* p_file, char* buf, off_t buf_sz, uint8_t flags );
 
union MFILE_HANDLE {
#ifdef MAUG_API_WIN32
   HANDLE handle;
#else
   FILE* file;
#endif /* !MAUG_API_WIN32 */
   MAUG_MHANDLE mem;
};
 
struct MFILE_CADDY {
   uint8_t type;
   union MFILE_HANDLE h;
   off_t sz;
   off_t last_read;
   off_t mem_cursor;
   uint8_t* mem_buffer;
   uint8_t flags;
   mfile_seek_t seek;
   mfile_read_int_t read_int;
   mfile_read_line_t read_line;
};
 
typedef struct MFILE_CADDY mfile_t;
 
#define mfile_check_lock( p_file ) (NULL != (p_file)->mem_buffer)
 
#define mfile_default_case( p_file ) \
   default: \
      error_printf( "unknown file type: %d", (p_file)->type ); \
      break;
 
#ifdef MAUG_API_WIN32
#  define mfile_has_bytes( p_file ) \
      ((MFILE_CADDY_TYPE_FILE == ((p_file)->type) ? \
         (off_t)SetFilePointer( (p_file)->h.handle, 0, NULL, FILE_CURRENT ) : \
         (p_file)->mem_cursor) < (p_file)->sz)
#else
#  define mfile_has_bytes( p_file ) \
      ((MFILE_CADDY_TYPE_FILE == ((p_file)->type) ? \
         (off_t)ftell( (p_file)->h.file ) : \
         (p_file)->mem_cursor) < (p_file)->sz)
#endif /* MAUG_NO_FILE */
 
#ifdef MFILE_LEGACY_MACROS
 
#define mfile_seek( p_file, idx ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      fseek( (p_file)->h.file, idx, SEEK_SET ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      (p_file)->mem_cursor = idx; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#define mfile_cread( p_file, p_c ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      (p_file)->last_read = fread( p_c, 1, 1, (p_file)->h.file ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      ((uint8_t*)(p_c))[0] = (p_file)->mem_buffer[(p_file)->mem_cursor++]; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#define mfile_cread_at( p_file, p_c, idx ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      fseek( (p_file)->h.file, idx, SEEK_SET ); \
      (p_file)->last_read = fread( p_c, 1, 1, (p_file)->h.file ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      *p_c = (p_file)->mem_buffer[idx]; \
      (p_file)->mem_cursor += 1; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#define mfile_u16read_at( p_file, p_u16, idx ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      fseek( (p_file)->h.file, idx, SEEK_SET ); \
      (p_file)->last_read = \
         fread( (((uint8_t*)p_u16) + 1), 1, 1, (p_file)->h.file ); \
      (p_file)->last_read += \
         fread( ((uint8_t*)p_u16), 1, 1, (p_file)->h.file ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      ((uint8_t*)(p_u16))[0] = (p_file)->mem_buffer[idx]; \
      ((uint8_t*)(p_u16))[1] = (p_file)->mem_buffer[idx + 1]; \
      (p_file)->mem_cursor += 2; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#define mfile_u16read_lsbf_at( p_file, p_u16, idx ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      fseek( (p_file)->h.file, idx, SEEK_SET ); \
      (p_file)->last_read = fread( p_u16, 1, 2, (p_file)->h.file ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      ((uint8_t*)(p_u16))[0] = (p_file)->mem_buffer[idx + 1]; \
      ((uint8_t*)(p_u16))[1] = (p_file)->mem_buffer[idx]; \
      (p_file)->mem_cursor += 2; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#define mfile_u32read_at( p_file, p_u32, idx ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      fseek( (p_file)->h.file, idx, SEEK_SET ); \
      (p_file)->last_read = \
         fread( (((uint8_t*)p_u32) + 3), 1, 1, (p_file)->h.file ); \
      (p_file)->last_read += \
         fread( (((uint8_t*)p_u32) + 2), 1, 1, (p_file)->h.file ); \
      (p_file)->last_read += \
         fread( (((uint8_t*)p_u32) + 1), 1, 1, (p_file)->h.file ); \
      (p_file)->last_read += \
         fread( ((uint8_t*)p_u32), 1, 1, (p_file)->h.file ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      ((uint8_t*)(p_u32))[0] = (p_file)->mem_buffer[idx]; \
      ((uint8_t*)(p_u32))[1] = (p_file)->mem_buffer[idx + 1]; \
      ((uint8_t*)(p_u32))[2] = (p_file)->mem_buffer[idx + 2]; \
      ((uint8_t*)(p_u32))[3] = (p_file)->mem_buffer[idx + 3]; \
      (p_file)->mem_cursor += 4; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#define mfile_u32read_lsbf( p_file, p_u32 ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      (p_file)->last_read = fread( p_u32, 1, 4, (p_file)->h.file ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      ((uint8_t*)(p_u32))[3] = (p_file)->mem_buffer[(p_file)->mem_cursor]; \
      ((uint8_t*)(p_u32))[2] = (p_file)->mem_buffer[(p_file)->mem_cursor + 1]; \
      ((uint8_t*)(p_u32))[1] = (p_file)->mem_buffer[(p_file)->mem_cursor + 2]; \
      ((uint8_t*)(p_u32))[0] = (p_file)->mem_buffer[(p_file)->mem_cursor + 3]; \
      (p_file)->mem_cursor += 4; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#define mfile_u32read_lsbf_at( p_file, p_u32, idx ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      fseek( (p_file)->h.file, idx, SEEK_SET ); \
      (p_file)->last_read = fread( p_u32, 1, 4, (p_file)->h.file ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      ((uint8_t*)(p_u32))[3] = (p_file)->mem_buffer[idx]; \
      ((uint8_t*)(p_u32))[2] = (p_file)->mem_buffer[idx + 1]; \
      ((uint8_t*)(p_u32))[1] = (p_file)->mem_buffer[idx + 2]; \
      ((uint8_t*)(p_u32))[0] = (p_file)->mem_buffer[idx + 3]; \
      (p_file)->mem_cursor += 4; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#define mfile_reset( p_file ) \
   switch( (p_file)->type ) { \
   case MFILE_CADDY_TYPE_FILE: \
      fseek( (p_file)->h.file, 0, SEEK_SET ); \
      break; \
   case MFILE_CADDY_TYPE_MEM_BUFFER: \
      (p_file)->mem_cursor = 0; \
      break; \
   mfile_default_case( p_file ); \
   }
 
#endif /* MFILE_LEGACY_MACROS */
 
#define mfile_get_sz( p_file ) ((p_file)->sz)
 
MERROR_RETVAL mfile_lock_buffer( MAUG_MHANDLE, off_t, mfile_t* p_file );
 
MERROR_RETVAL mfile_open_read( const char* filename, mfile_t* p_file );
 
void mfile_close( mfile_t* p_file );
 
#ifdef MFILE_C
 
#ifdef MVFS_ENABLED
#  include <mvfs.h>
#endif /* MVFS_ENABLED */
 
#ifdef MFILE_MMAP
#  include <sys/mman.h> /* mmap() */
#  include <unistd.h> /* close() */
#  include <fcntl.h> /* open() */
#  include <sys/stat.h> /* fstat() */
#endif /* RETROFLAT_OS_UNIX */
 
/* === */
 
#ifdef MAUG_API_WIN32
 
MERROR_RETVAL mfile_file_read_int(
   struct MFILE_CADDY* p_f, uint8_t* buf, size_t buf_sz, uint8_t flags
) {
   MERROR_RETVAL retval = MERROR_OK;
   DWORD last_read = 0;
   BOOL read_ok = 0;
 
   assert( MFILE_CADDY_TYPE_FILE == p_f->type );
 
   if( MFILE_READ_FLAG_LSBF == (MFILE_READ_FLAG_LSBF & flags) ) {
      /* Shrink the buffer moving right and read into it. */
      read_ok = ReadFile( p_f->h.handle, buf, buf_sz, &last_read, NULL );
      if( !read_ok || buf_sz > last_read ) {
         error_printf( "unable to read from file!" );
         retval = MERROR_FILE;
         goto cleanup;
      }
   
   } else {
      /* Move to the end of the output buffer and read backwards. */
      while( 0 < buf_sz ) {
         read_ok = ReadFile(
            p_f->h.handle, (buf + (buf_sz - 1)) , 1, &last_read, NULL );
         if( !read_ok || buf_sz > last_read ) {
            error_printf( "unable to read from file!" );
            retval = MERROR_FILE;
            goto cleanup;
         }
         buf_sz--;
      }
   }
 
cleanup:
 
   return retval;
}
 
MERROR_RETVAL mfile_file_seek( struct MFILE_CADDY* p_file, off_t pos ) {
   MERROR_RETVAL retval = MERROR_OK;
 
   SetFilePointer( (p_file)->h.handle, pos, NULL, FILE_BEGIN );
 
   return retval;
}
 
#define MFILE_READ_LINE_BUF_SZ 4096
 
MERROR_RETVAL mfile_file_read_line(
   struct MFILE_CADDY* p_f, char* buffer, off_t buffer_sz, uint8_t flags
) {
   MERROR_RETVAL retval = MERROR_OK;
   DWORD start = 0;
   DWORD chunk_bytes_read = 0;
   DWORD line_bytes_read = 0;
   int32_t newline_diff = 0;
   char line_buf[MFILE_READ_LINE_BUF_SZ + 1];
   char* newline_ptr = NULL;
 
   assert( MFILE_CADDY_TYPE_FILE == p_f->type );
 
   start = SetFilePointer( p_f->h.handle, 0, NULL, FILE_CURRENT );
 
   while( ReadFile(
      p_f->h.handle, line_buf, MFILE_READ_LINE_BUF_SZ, &chunk_bytes_read, NULL
   ) ) {
      /* debug_printf( 1, "---" );
      debug_printf( 1, "chunk read: %u bytes: %s", chunk_bytes_read, line_buf ); */
      line_buf[chunk_bytes_read] = '\0';
      newline_ptr = maug_strchr( line_buf, '\n' );
      if( NULL != newline_ptr ) {
         /* Move the read counter back in the chunk to the newline. */
         newline_diff = (newline_ptr - line_buf) + 1;
         *newline_ptr = '\0';
         /* debug_printf( 1, "len to newline is: %u bytes...", newline_diff ); */
         /* Back up the file pointer to the end of the line we just read and
          * continue with the length of that line.
          */
         SetFilePointer(
            p_f->h.handle,
            (chunk_bytes_read - newline_diff) * -1, NULL, FILE_CURRENT );
         /* debug_printf( 1, "backing up file ptr by %u bytes (sfp: %d)...",
            chunk_bytes_read - newline_diff, sfp ); */
         chunk_bytes_read = newline_diff;
      }
      debug_printf( 1, "line buffer (%u): %s", chunk_bytes_read, line_buf );
      if( line_bytes_read + chunk_bytes_read > buffer_sz ) {
         error_printf( "line buffer exceeded!" );
         retval = MERROR_FILE;
         goto cleanup;
      }
      strncpy(
         &(buffer[line_bytes_read]), line_buf, chunk_bytes_read );
      if( NULL != newline_ptr ) {
         /* Line was completed. */
         break;
      }
   }
 
cleanup:
 
   return retval;
}
 
#else
 
MERROR_RETVAL mfile_file_read_int(
   struct MFILE_CADDY* p_file, uint8_t* buf, size_t buf_sz, uint8_t flags
) {
   MERROR_RETVAL retval = MERROR_OK;
   ssize_t last_read = 0;
 
   assert( MFILE_CADDY_TYPE_FILE == p_file->type );
 
   if( MFILE_READ_FLAG_LSBF == (MFILE_READ_FLAG_LSBF & flags) ) {
      /* Shrink the buffer moving right and read into it. */
      last_read = fread( buf, 1, buf_sz, p_file->h.file );
      if( buf_sz > last_read ) {
         error_printf( "unable to read from file!" );
         retval = MERROR_FILE;
         goto cleanup;
      }
   
   } else {
      /* Move to the end of the output buffer and read backwards. */
      while( 0 < buf_sz ) {
         last_read = fread( (buf + (buf_sz - 1)), 1, 1, p_file->h.file );
         if( 0 >= last_read ) {
            error_printf( "unable to read from file!" );
            retval = MERROR_FILE;
            goto cleanup;
         }
         buf_sz--;
      }
   }
 
cleanup:
 
   return retval;
}
 
/* === */
 
MERROR_RETVAL mfile_file_seek( struct MFILE_CADDY* p_file, off_t pos ) {
   MERROR_RETVAL retval = MERROR_OK;
 
   assert( MFILE_CADDY_TYPE_FILE == p_file->type );
 
   if( fseek( p_file->h.file, pos, SEEK_SET ) ) {
      error_printf( "unable to seek file!" );
      retval = MERROR_FILE;
   }
 
   return retval;
}
 
/* === */
 
MERROR_RETVAL mfile_file_read_line(
   struct MFILE_CADDY* p_f, char* buffer, off_t buffer_sz, uint8_t flags
) {
   MERROR_RETVAL retval = MERROR_OK;
 
   assert( MFILE_CADDY_TYPE_FILE == p_f->type );
 
   /* Trivial case; use a native function. Much faster! */
   if( NULL == fgets( buffer, buffer_sz - 1, p_f->h.file ) ) {
      error_printf( "error while reading line from file!" );
      retval = MERROR_FILE;
   }
 
   return retval;
}
 
#endif /* !MAUG_API_WIN32 */
 
/* === */
 
MERROR_RETVAL mfile_mem_read_int(
   struct MFILE_CADDY* p_file, uint8_t* buf, size_t buf_sz, uint8_t flags
) {
   MERROR_RETVAL retval = MERROR_OK;
 
   assert( MFILE_CADDY_TYPE_MEM_BUFFER == p_file->type );
 
   if( MFILE_READ_FLAG_LSBF != (MFILE_READ_FLAG_LSBF & flags) ) {
      /* Shrink the buffer moving right and read into it. */
      while( 0 < buf_sz ) {
         /* Check for EOF. */
         if( p_file->mem_cursor >= p_file->sz ) {
            retval = MERROR_FILE;
            error_printf(
               "cursor " OFF_T_FMT " beyond end of buffer " OFF_T_FMT "!",
               p_file->mem_cursor, p_file->sz );
            goto cleanup;
         }
 
         buf[buf_sz - 1] = p_file->mem_buffer[p_file->mem_cursor];
         debug_printf( MFILE_TRACE_LVL, "byte #" SIZE_T_FMT " = # " OFF_T_FMT,
            buf_sz - 1, p_file->mem_cursor );
         buf_sz--;
         p_file->mem_cursor++;
      }
   
   } else {
      /* Move to the end of the output buffer and read backwards. */
      while( 0 < buf_sz ) {
         /* Check for EOF. */
         if( p_file->mem_cursor >= p_file->sz ) {
            retval = MERROR_FILE;
            error_printf(
               "cursor " OFF_T_FMT " beyond end of buffer " OFF_T_FMT "!",
               p_file->mem_cursor, p_file->sz );
            goto cleanup;
         }
 
         buf[buf_sz - 1] = p_file->mem_buffer[p_file->mem_cursor];
         debug_printf( MFILE_TRACE_LVL, "byte #" SIZE_T_FMT " = # " OFF_T_FMT,
            buf_sz - 1, p_file->mem_cursor );
         buf_sz--;
         buf++;
         p_file->mem_cursor++;
      }
   }
 
cleanup:
 
   return retval;
}
 
/* === */
 
MERROR_RETVAL mfile_mem_seek( struct MFILE_CADDY* p_file, off_t pos ) {
   MERROR_RETVAL retval = MERROR_OK;
 
   assert( MFILE_CADDY_TYPE_MEM_BUFFER == p_file->type );
 
   p_file->mem_cursor = pos;
 
   debug_printf( 1,
      "seeking memory buffer to position " OFF_T_FMT " (" OFF_T_FMT ")",
      pos, p_file->mem_cursor );
 
   return retval;
}
 
/* === */
 
MERROR_RETVAL mfile_mem_read_line(
   struct MFILE_CADDY* p_f, char* buffer, off_t buffer_sz, uint8_t flags
) {
   MERROR_RETVAL retval = MERROR_OK;
   off_t i = 0;
 
   assert( MFILE_CADDY_TYPE_MEM_BUFFER == p_f->type );
 
   while( i < buffer_sz - 1 && mfile_has_bytes( p_f ) ) {
      /* Check for potential overflow. */
      if( i + 1 >= buffer_sz ) {
         error_printf( "overflow reading string from file!" );
         retval = MERROR_FILE;
         break;
      }
 
      p_f->read_int( p_f, (uint8_t*)&(buffer[i]), 1, 0 );
      if( '\n' == buffer[i] ) {
         /* Break on newline and overwrite it below. */
         break;
      }
      i++;
   }
 
   assert( i < buffer_sz ); /* while() above stops before buffer_sz! */
 
   /* Append a null terminator. */
   buffer[i] = '\0';
 
   return retval;
}
 
/* === */
 
MERROR_RETVAL mfile_lock_buffer(
   MAUG_MHANDLE handle, off_t handle_sz,  mfile_t* p_file
) {
   MERROR_RETVAL retval = MERROR_OK;
 
   debug_printf( 1,
      "locking handle %p as file %p (" OFF_T_FMT " bytes)...",
      handle, p_file, handle_sz );
 
   maug_mzero( p_file, sizeof( struct MFILE_CADDY ) );
   maug_mlock( handle, p_file->mem_buffer );
   p_file->type = MFILE_CADDY_TYPE_MEM_BUFFER;
 
   p_file->read_int = mfile_mem_read_int;
   p_file->seek = mfile_mem_seek;
   p_file->read_line = mfile_mem_read_line;
 
   p_file->sz = handle_sz;
 
   return retval;
}
 
/* === */
 
MERROR_RETVAL mfile_open_read( const char* filename, mfile_t* p_file ) {
   MERROR_RETVAL retval = MERROR_OK;
#  if defined( MVFS_ENABLED )
   size_t i = 0;
#  elif defined( MFILE_MMAP )
   uint8_t* bytes_ptr = NULL;
   struct stat st;
   int in_file = 0;
#  elif defined( RETROFLAT_API_WINCE )
   STATSTG file_stat;
#  else
   struct stat file_stat;
#  endif /* MFILE_MMAP */
#  ifdef MAUG_WCHAR
   wchar_t filename_w[MAUG_PATH_MAX + 1] = { 0 };
#  endif /* MAUG_WCHAR */
 
   /* MAUG_MHANDLE* p_bytes_ptr_h, off_t* p_bytes_sz */
 
#  if defined( MVFS_ENABLED )
 
   while( NULL != gc_mvfs_data[i] ) {
      if( 0 == strcmp( filename, gc_mvfs_filenames[i] ) ) {
         debug_printf( 1, "found file \"%s\" at VFS index: " SIZE_T_FMT
         " (size: " OFF_T_FMT " bytes)",
            filename, i, *(gc_mvfs_lens[i]) );
         break;
      }
      i++;
   }
 
   if( NULL == gc_mvfs_data[i] ) {
      retval = MERROR_FILE;
      error_printf( "file \"%s\" not found in VFS!", filename );
      goto cleanup;
   }
 
   p_file->type = MFILE_CADDY_TYPE_MEM_BUFFER;
   p_file->read_int = mfile_mem_read_int;
   p_file->seek = mfile_mem_seek;
   p_file->read_line = mfile_mem_read_line;
   p_file->flags = MFILE_FLAG_READ_ONLY;
   p_file->mem_buffer = gc_mvfs_data[i];
   p_file->sz = *(gc_mvfs_lens[i]);
   p_file->mem_cursor = 0;
 
cleanup:
 
#  elif defined( MFILE_MMAP )
 
   in_file = open( filename, O_RDONLY );
   if( 0 >= in_file ) {
      error_printf( "could not open file: %s", filename );
      retval = MERROR_FILE;
      goto cleanup;
   }
 
   fstat( in_file, &st );
 
   *p_bytes_ptr_h = 
      mmap( (caddr_t)0, st.st_size, PROT_READ, MAP_SHARED,  in_file, 0 );
   maug_cleanup_if_null_alloc( uint8_t*, *p_bytes_ptr_h );
   *p_bytes_sz = st.st_size;
 
cleanup:
 
   if( 0 < in_file ) {
      close( in_file );
   }
 
#  elif defined( MAUG_API_WIN32 )
 
   /* TODO: Wide chars. */
 
#     ifdef MAUG_WCHAR
   if( 0 == MultiByteToWideChar(
      CP_ACP, MB_PRECOMPOSED, filename, -1, filename_w, MAUG_PATH_MAX
   ) ) {
      error_printf( "could not create wide filename path!" );
      retval = MERROR_FILE;
      goto cleanup;
   }
#     endif /* MAUG_WCHAR */
 
   /* Actually open the file. */
   p_file->h.handle = CreateFile( 
#     ifdef MAUG_WCHAR
      filename_w,
#     else
      filename,
#     endif /* MAUG_WCHAR */
      GENERIC_READ,
      FILE_SHARE_READ,
      NULL,
      OPEN_EXISTING,
      FILE_ATTRIBUTE_NORMAL,
      NULL );
 
   if( INVALID_HANDLE_VALUE == p_file->h.handle ) {
      error_printf( "could not open file: %s", filename );
   }
 
   p_file->sz = GetFileSize( p_file->h.handle, NULL );
 
   debug_printf( 1, "opened file %s (" OFF_T_FMT " bytes)...",
      filename, p_file->sz );
 
   p_file->type = MFILE_CADDY_TYPE_FILE;
 
   p_file->read_int = mfile_file_read_int;
   p_file->seek = mfile_file_seek;
   p_file->read_line = mfile_file_read_line;
   p_file->flags = MFILE_FLAG_READ_ONLY;
 
cleanup:
 
#  else
 
#     ifndef MAUG_NO_STAT
   /* Get the file size from the OS. */
   stat( filename, &file_stat );
   p_file->sz = file_stat.st_size;
#     endif /* !MAUG_NO_STAT */
 
   /* Open the permanent file handle. */
   p_file->h.file = fopen( filename, "rb" );
   if( NULL == p_file->h.file ) {
      error_printf( "could not open file: %s", filename );
      retval = MERROR_FILE;
      goto cleanup;
   }
 
#     ifdef MAUG_NO_STAT
   /* The standard is not required to support SEEK_END, among other issues.
    * This is probably the worst way to get file size.
    */
   debug_printf( 2, "falling back to seek file size..." );
   fseek( p_file->h.file, 0, SEEK_END );
   p_file->sz = ftell( p_file->h.file );
   fseek( p_file->h.file, 0, SEEK_SET );
#     endif /* MAUG_NO_STAT */
 
   debug_printf( 1, "opened file %s (" OFF_T_FMT " bytes)...",
      filename, p_file->sz );
 
   p_file->type = MFILE_CADDY_TYPE_FILE;
 
   p_file->read_int = mfile_file_read_int;
   p_file->seek = mfile_file_seek;
   p_file->read_line = mfile_file_read_line;
   p_file->flags = MFILE_FLAG_READ_ONLY;
 
cleanup:
 
#  endif /* MFILE_MMAP */
 
   return retval;
}
 
/* === */
 
void mfile_close( mfile_t* p_file ) {
#  ifdef MFILE_MMAP
   munmap( bytes_ptr_h, bytes_sz );
#  else
   /* maug_mfree( bytes_ptr_h ); */
   switch( p_file->type ) {
   case 0:
      /* Do nothing silently. */
      break;
 
   case MFILE_CADDY_TYPE_FILE:
#ifdef MAUG_API_WIN32
      CloseHandle( p_file->h.handle );
#else
      fclose( p_file->h.file );
#endif /* !MAUG_NO_FILE */
      p_file->type = 0;
      break;
 
   case MFILE_CADDY_TYPE_MEM_BUFFER:
      if( NULL != p_file->mem_buffer ) {
         maug_munlock( p_file->h.mem, p_file->mem_buffer );
         debug_printf( 1, "unlocked handle %p from file %p...",
            p_file->h.mem, p_file );
         p_file->type = 0;
      }
      break;
      
   mfile_default_case( p_file );
   }
#  endif /* MFILE_MMAP */
}
 
#endif /* MFILE_C */
 
 /* maug_mfile */
 
#endif /* !MFILE_H */