summaryrefslogtreecommitdiff
path: root/src/fs/virtfs/fsfuncs.h
blob: 36df9393439a14ff8329933f1ffaa8788711a4c8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 *  The ManaPlus Client
 *  Copyright (C) 2013-2017  The ManaPlus Developers
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef UTILS_VIRTFSFUNCS_H
#define UTILS_VIRTFSFUNCS_H

#include "fs/virtfs/rwopstypes.h"

#include "utils/stringvector.h"

#include "localconsts.h"

struct SDL_RWops;

namespace VirtFs
{

struct File;
struct FsEntry;

struct FsFuncs final
{
    FsFuncs() :
        close(nullptr),
        read(nullptr),
        write(nullptr),
        fileLength(nullptr),
        tell(nullptr),
        seek(nullptr),
        exists(nullptr),
        getRealDir(nullptr),
        enumerate(nullptr),
        getFiles(nullptr),
        getFilesWithDir(nullptr),
        getDirs(nullptr),
        isDirectory(nullptr),
        openRead(nullptr),
        openWrite(nullptr),
        openAppend(nullptr),
        eof(nullptr),
        loadFile(nullptr),
        rwops_seek(nullptr),
        rwops_read(nullptr),
        rwops_write(nullptr),
#ifdef USE_SDL2
        rwops_size(nullptr),
#endif  // USE_SDL2
        rwops_close(nullptr)
    {
    }

    A_DELETE_COPY(FsFuncs)

    int (*close) (File *restrict const file);
    int64_t (*read) (File *restrict const file,
                     void *restrict const buffer,
                     const uint32_t objSize,
                     const uint32_t objCount);
    int64_t (*write) (File *restrict const file,
                      const void *restrict const buffer,
                      const uint32_t objSize,
                      const uint32_t objCount);
    int64_t (*fileLength) (File *restrict const file);
    int64_t (*tell) (File *restrict const file);
    int (*seek) (File *restrict const file,
                 const uint64_t pos);
    bool (*exists) (FsEntry *restrict const entry,
                    std::string filename,
                    std::string dirName);
    bool (*getRealDir) (FsEntry *restrict const entry,
                        std::string filename,
                        std::string dirName,
                        std::string &realDir);
    void (*enumerate) (FsEntry *restrict const entry,
                       const std::string &dirName,
                       StringVect &names);
    void (*getFiles) (FsEntry *restrict const entry,
                      const std::string &dirName,
                      StringVect &names);
    void (*getFilesWithDir) (FsEntry *restrict const entry,
                             const std::string &dirName,
                             StringVect &names);
    void (*getDirs) (FsEntry *restrict const entry,
                     const std::string &dirName,
                     StringVect &names);
    bool (*isDirectory) (FsEntry *restrict const entry,
                         const std::string &dirName,
                         bool &isDirFlag);
    File *(*openRead) (FsEntry *restrict const entry,
                       const std::string &filename);
    File *(*openWrite) (FsEntry *restrict const entry,
                        const std::string &filename);
    File *(*openAppend) (FsEntry *restrict const entry,
                         const std::string &filename);
    int (*eof) (File *restrict const file);
    const char *(*loadFile) (FsEntry *restrict const entry,
                             const std::string &restrict fileName,
                             int &restrict fileSize);

    RWOPSINT (*rwops_seek) (SDL_RWops *const rw,
                            const RWOPSINT offset,
                            const int whence);
    RWOPSSIZE (*rwops_read) (SDL_RWops *const rw,
                             void *const ptr,
                             const RWOPSSIZE size,
                             const RWOPSSIZE maxnum);
    RWOPSSIZE (*rwops_write) (SDL_RWops *const rw,
                              const void *const ptr,
                              const RWOPSSIZE size,
                              const RWOPSSIZE num);
#ifdef USE_SDL2
    RWOPSINT (*rwops_size) (SDL_RWops *const rw);
#endif  // USE_SDL2
    int (*rwops_close) (SDL_RWops *const rw);
};

}  // namespace VirtFs

#endif  // UTILS_VIRTFSFUNCS_H