WSYS_RAMFile.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /*
  2. ** Command & Conquer Generals Zero Hour(tm)
  3. ** Copyright 2025 Electronic Arts Inc.
  4. **
  5. ** This program is free software: you can redistribute it and/or modify
  6. ** it under the terms of the GNU General Public License as published by
  7. ** the Free Software Foundation, either version 3 of the License, or
  8. ** (at your option) any later version.
  9. **
  10. ** This program is distributed in the hope that it will be useful,
  11. ** but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. ** GNU General Public License for more details.
  14. **
  15. ** You should have received a copy of the GNU General Public License
  16. ** along with this program. If not, see <http://www.gnu.org/licenses/>.
  17. */
  18. //----------------------------------------------------------------------------=
  19. //
  20. // Westwood Studios Pacific.
  21. //
  22. // Confidential Information
  23. // Copyright(C) 2001 - All Rights Reserved
  24. //
  25. //----------------------------------------------------------------------------
  26. //
  27. // Project: WSYS Library
  28. //
  29. // Module: IO
  30. //
  31. // File name: wsys/RAMFile.h
  32. //
  33. // Created: 11/08/01
  34. //
  35. //----------------------------------------------------------------------------
  36. #pragma once
  37. #ifndef __WSYS_RAMFILE_H
  38. #define __WSYS_RAMFILE_H
  39. //----------------------------------------------------------------------------
  40. // Includes
  41. //----------------------------------------------------------------------------
  42. #include "wsys_File.h"
  43. //----------------------------------------------------------------------------
  44. // Forward References
  45. //----------------------------------------------------------------------------
  46. //----------------------------------------------------------------------------
  47. // Type Defines
  48. //----------------------------------------------------------------------------
  49. //===============================
  50. // RAMFile
  51. //===============================
  52. /**
  53. * File abstraction for standard C file operators: open, close, lseek, read, write
  54. */
  55. //===============================
  56. class RAMFile : public File
  57. {
  58. protected:
  59. Char *m_data; ///< File data in memory
  60. Int m_pos; ///< current read position
  61. Int m_size; ///< size of file in memory
  62. public:
  63. RAMFile();
  64. virtual ~RAMFile();
  65. virtual Bool open( const Char *filename, Int access = 0 ); ///< Open a file for access
  66. virtual void close( void ); ///< Close the file
  67. virtual Int read( void *buffer, Int bytes ); ///< Read the specified number of bytes in to buffer: See File::read
  68. virtual Int write( void *buffer, Int bytes ); ///< Write the specified number of bytes from the buffer: See File::write
  69. virtual Int seek( Int new_pos, seekMode mode = CURRENT ); ///< Set file position: See File::seek
  70. Bool open( File *file ); ///< Open file for fast RAM access
  71. };
  72. //----------------------------------------------------------------------------
  73. // Inlining
  74. //----------------------------------------------------------------------------
  75. #endif // __WSYS_RAMFILE_H