ScummVM API documentation
script_file.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (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, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 #ifndef AGS_ENGINE_DYNOBJ__SCRIPTFILE_H
23 #define AGS_ENGINE_DYNOBJ__SCRIPTFILE_H
24 
25 #include "ags/engine/ac/dynobj/cc_dynamic_object.h"
26 #include "ags/shared/util/file.h"
27 
28 namespace AGS3 {
29 
30 using namespace AGS; // FIXME later
31 
32 #define scFileRead 1
33 #define scFileWrite 2
34 #define scFileAppend 3
35 
36 struct sc_File final : ICCDynamicObject {
37  int32_t handle;
38 
39  static const Shared::FileOpenMode fopenModes[];
40  static const Shared::FileWorkMode fworkModes[];
41 
42  int Dispose(const char *address, bool force) override;
43 
44  const char *GetType() override;
45 
46  int Serialize(const char *address, char *buffer, int bufsize) override;
47 
48  int OpenFile(const char *filename, int mode);
49  void Close();
50 
51  sc_File();
52 
53  // Legacy support for reading and writing object values by their relative offset
54  const char *GetFieldPtr(const char *address, intptr_t offset) override;
55  void Read(const char *address, intptr_t offset, void *dest, int size) override;
56  uint8_t ReadInt8(const char *address, intptr_t offset) override;
57  int16_t ReadInt16(const char *address, intptr_t offset) override;
58  int32_t ReadInt32(const char *address, intptr_t offset) override;
59  float ReadFloat(const char *address, intptr_t offset) override;
60  void Write(const char *address, intptr_t offset, void *src, int size) override;
61  void WriteInt8(const char *address, intptr_t offset, uint8_t val) override;
62  void WriteInt16(const char *address, intptr_t offset, int16_t val) override;
63  void WriteInt32(const char *address, intptr_t offset, int32_t val) override;
64  void WriteFloat(const char *address, intptr_t offset, float val) override;
65 };
66 
67 } // namespace AGS3
68 
69 #endif
Definition: achievements_tables.h:27
Definition: script_file.h:36
Definition: cc_dynamic_object.h:51
Definition: ags.h:40