Diligent Engine  v.2.4.g
AndroidFileSystem.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 2019-2021 Diligent Graphics LLC
3  * Copyright 2015-2019 Egor Yusov
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * In no event and under no legal theory, whether in tort (including negligence),
18  * contract, or otherwise, unless required by applicable law (such as deliberate
19  * and grossly negligent acts) or agreed to in writing, shall any Contributor be
20  * liable for any damages, including any direct, indirect, special, incidental,
21  * or consequential damages of any character arising as a result of this License or
22  * out of the use or inability to use the software (including but not limited to damages
23  * for loss of goodwill, work stoppage, computer failure or malfunction, or any and
24  * all other commercial damages or losses), even if such Contributor has been advised
25  * of the possibility of such damages.
26  */
27 
28 #pragma once
29 
30 #include <memory>
31 #include <vector>
32 #include <fstream>
33 #include <android/asset_manager.h>
34 
35 #include "../../Basic/interface/BasicFileSystem.hpp"
36 #include "../../../Primitives/interface/DataBlob.h"
37 
38 struct ANativeActivity;
39 struct AAssetManager;
40 
41 class AndroidFile : public BasicFile
42 {
43 public:
44  AndroidFile(const FileOpenAttribs& OpenAttribs);
45  ~AndroidFile();
46 
47  void Read(Diligent::IDataBlob* pData);
48 
49  bool Read(void* Data, size_t BufferSize);
50 
51  bool Write(const void* Data, size_t BufferSize);
52 
53  size_t GetSize() { return m_Size; }
54 
55  size_t GetPos();
56 
57  void SetPos(size_t Offset, FilePosOrigin Origin);
58 
59  static bool Open(const char* FileName, std::ifstream& IFS, AAsset*& AssetFile, size_t& Size);
60 
61 private:
62  std::ifstream m_IFS;
63  AAsset* m_AssetFile = nullptr;
64  size_t m_Size = 0;
65 };
66 
67 
70 {
71 public:
73 
83  static void Init(struct ANativeActivity* NativeActivity,
84  const char* NativeActivityClassName,
85  struct AAssetManager* AssetManager);
86 
87 
88  static AndroidFile* OpenFile(const FileOpenAttribs& OpenAttribs);
89  static inline Diligent::Char GetSlashSymbol() { return '/'; }
90 
91  static bool FileExists(const Diligent::Char* strFilePath);
92  static bool PathExists(const Diligent::Char* strPath);
93 
94  static bool CreateDirectory(const Diligent::Char* strPath);
95  static void ClearDirectory(const Diligent::Char* strPath);
96  static void DeleteFile(const Diligent::Char* strPath);
97 
98  static std::vector<std::unique_ptr<FindFileData>> Search(const Diligent::Char* SearchPattern);
99 };
AndroidFile::SetPos
void SetPos(size_t Offset, FilePosOrigin Origin)
Definition: AndroidFileSystem.cpp:288
AndroidFile::Read
void Read(Diligent::IDataBlob *pData)
Definition: AndroidFileSystem.cpp:241
Diligent::Char
char Char
Definition: BasicTypes.h:64
AndroidFile
Definition: AndroidFileSystem.hpp:41
FileOpenAttribs
Definition: BasicFileSystem.hpp:48
Diligent::IDataBlob
Base interface for a file stream.
Definition: DataBlob.h:52
AndroidFile::Open
static bool Open(const char *FileName, std::ifstream &IFS, AAsset *&AssetFile, size_t &Size)
Definition: AndroidFileSystem.cpp:217
AndroidFileSystem::FileExists
static bool FileExists(const Diligent::Char *strFilePath)
Definition: AndroidFileSystem.cpp:314
FilePosOrigin
FilePosOrigin
Definition: BasicFileSystem.hpp:40
AndroidFile::AndroidFile
AndroidFile(const FileOpenAttribs &OpenAttribs)
Definition: AndroidFileSystem.cpp:222
AndroidFile::Write
bool Write(const void *Data, size_t BufferSize)
Definition: AndroidFileSystem.cpp:274
AndroidFileSystem::PathExists
static bool PathExists(const Diligent::Char *strPath)
Definition: AndroidFileSystem.cpp:333
AndroidFile::GetPos
size_t GetPos()
Definition: AndroidFileSystem.cpp:281
AndroidFile::GetSize
size_t GetSize()
Definition: AndroidFileSystem.hpp:53
BasicFileSystem
Definition: BasicFileSystem.hpp:82
AndroidFileSystem::OpenFile
static AndroidFile * OpenFile(const FileOpenAttribs &OpenAttribs)
Definition: AndroidFileSystem.cpp:299
AndroidFile::~AndroidFile
~AndroidFile()
Definition: AndroidFileSystem.cpp:232
AndroidFileSystem
Android file system implementation.
Definition: AndroidFileSystem.hpp:69
BasicFile
Definition: BasicFileSystem.hpp:59
AndroidFileSystem::ClearDirectory
static void ClearDirectory(const Diligent::Char *strPath)
Definition: AndroidFileSystem.cpp:345
AndroidFileSystem::DeleteFile
static void DeleteFile(const Diligent::Char *strPath)
Definition: AndroidFileSystem.cpp:350
AndroidFileSystem::CreateDirectory
static bool CreateDirectory(const Diligent::Char *strPath)
Definition: AndroidFileSystem.cpp:339
AndroidFileSystem::Search
static std::vector< std::unique_ptr< FindFileData > > Search(const Diligent::Char *SearchPattern)
Definition: AndroidFileSystem.cpp:355
AndroidFileSystem::Init
static void Init(struct ANativeActivity *NativeActivity, const char *NativeActivityClassName, struct AAssetManager *AssetManager)
Initializes the file system.
Definition: AndroidFileSystem.cpp:294
AndroidFileSystem::GetSlashSymbol
static Diligent::Char GetSlashSymbol()
Definition: AndroidFileSystem.hpp:89