src/w_file.h

   1 // Emacs style mode select   -*- C++ -*-
   2 //-----------------------------------------------------------------------------
   3 //
   4 // Copyright(C) 1993-1996 Id Software, Inc.
   5 // Copyright(C) 2008 Simon Howard
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License
   9 // as published by the Free Software Foundation; either version 2
  10 // of the License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20 // 02111-1307, USA.
  21 //
  22 // DESCRIPTION:
  23 //      WAD I/O functions.
  24 //
  25 //-----------------------------------------------------------------------------
  26
  27
  28 #ifndef __W_FILE__
  29 #define __W_FILE__
  30
  31 #include <stdio.h>
  32 #include "doomtype.h"
  33
  34 typedef struct _wad_file_s wad_file_t;
  35
  36 typedef struct
  37 {
  38     // Open a file for reading.
  39
  40     wad_file_t *(*OpenFile)(char *path);
  41
  42     // Close the specified file.
  43
  44     void (*CloseFile)(wad_file_t *file);
  45
  46     // Read data from the specified position in the file into the
  47     // provided buffer.  Returns the number of bytes read.
  48
  49     size_t (*Read)(wad_file_t *file, unsigned int offset,
  50                    void *buffer, size_t buffer_len);
  51
  52 } wad_file_class_t;
  53
  54 struct _wad_file_s
  55 {
  56     // Class of this file.
  57
  58     wad_file_class_t *file_class;
  59
  60     // If this is NULL, the file cannot be mapped into memory.  If this
  61     // is non-NULL, it is a pointer to the mapped file.
  62
  63     byte *mapped;
  64
  65     // Length of the file, in bytes.
  66
  67     unsigned int length;
  68 };
  69
  70 // Open the specified file. Returns a pointer to a new wad_file_t
  71 // handle for the WAD file, or NULL if it could not be opened.
  72
  73 wad_file_t *W_OpenFile(char *path);
  74
  75 // Close the specified WAD file.
  76
  77 void W_CloseFile(wad_file_t *wad);
  78
  79 // Read data from the specified file into the provided buffer.  The
  80 // data is read from the specified offset from the start of the file.
  81 // Returns the number of bytes read.
  82
  83 size_t W_Read(wad_file_t *wad, unsigned int offset,
  84               void *buffer, size_t buffer_len);
  85
  86 #endif /* #ifndef __W_FILE__ */