summaryrefslogtreecommitdiff
path: root/src/fs/virtfs/virtfsdir.h
blob: e0379e06d0df348de63c8cb2ac1b9235f0a595ca (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
/*
 *  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_VIRTFSDIR_H
#define UTILS_VIRTFSDIR_H

#include "fs/virtfs/fileapi.h"

#include "utils/stringvector.h"

#include "localconsts.h"

namespace VirtFs
{

struct File;
struct FsEntry;
struct VirtFsFuncs;
struct VirtList;

namespace VirtFsDir
{
    File *openInternal(FsEntry *restrict const entry,
                       const std::string &filename,
                       const FILEMTYPE mode);
    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);
    const char *getBaseDir();
    const char *getUserDir();
    VirtFsFuncs *getFuncs();
    void init(const std::string &restrict name);
    void initFuncs(VirtFsFuncs *restrict const ptr);
    void deinit();
    bool exists(FsEntry *restrict const entry,
                const std::string &fileName,
                const std::string &dirName);
    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);
    bool isSymbolicLink(std::string name);
    void freeList(VirtList *restrict const handle);
    bool setWriteDir(std::string newDir);
    bool getRealDir(FsEntry *restrict const entry,
                    const std::string &filename,
                    const std::string &dirName,
                    std::string &realDir);
    bool mkdir(std::string dirName);
    bool remove(std::string filename);
    void permitLinks(const bool val);
    int64_t read(File *restrict const handle,
                 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);
    int close(File *restrict const file);
    int64_t fileLength(File *restrict const file);
    int64_t tell(File *restrict const file);
    int seek(File *restrict const file,
             const uint64_t pos);
    int eof(File *restrict const file);
    const char *loadFile(FsEntry *restrict const entry,
                         const std::string &restrict fileName,
                         int &restrict fileSize);
}  // namespace VirtFsDir

}  // namespace VirtFs

#endif  // UTILS_VIRTFSDIR_H