Diligent Engine  v.2.4.g
StandardFile.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 <stdio.h>
31 
32 #include "../../../Primitives/interface/DataBlob.h"
33 #include "BasicFileSystem.hpp"
34 
35 class StandardFile : public BasicFile
36 {
37 public:
38  StandardFile(const FileOpenAttribs& OpenAttribs, Diligent::Char SlashSymbol);
39  virtual ~StandardFile() override;
40 
41  void Read(Diligent::IDataBlob* pData);
42 
43  bool Read(void* Data, size_t Size);
44 
45  bool Write(const void* Data, size_t Size);
46 
47  size_t GetSize();
48 
49  size_t GetPos();
50 
51  void SetPos(size_t Offset, FilePosOrigin Origin);
52 
53 protected:
54  FILE* m_pFile = nullptr;
55 };
Diligent::Char
char Char
Definition: BasicTypes.h:64
FileOpenAttribs
Definition: BasicFileSystem.hpp:48
Diligent::IDataBlob
Base interface for a file stream.
Definition: DataBlob.h:52
StandardFile::GetPos
size_t GetPos()
Definition: StandardFile.cpp:96
StandardFile::SetPos
void SetPos(size_t Offset, FilePosOrigin Origin)
Definition: StandardFile.cpp:105
StandardFile
Definition: StandardFile.hpp:35
FilePosOrigin
FilePosOrigin
Definition: BasicFileSystem.hpp:40
StandardFile::Write
bool Write(const void *Data, size_t Size)
Definition: StandardFile.cpp:76
StandardFile::~StandardFile
virtual ~StandardFile() override
Definition: StandardFile.cpp:47
StandardFile::StandardFile
StandardFile(const FileOpenAttribs &OpenAttribs, Diligent::Char SlashSymbol)
Definition: StandardFile.cpp:32
StandardFile::Read
void Read(Diligent::IDataBlob *pData)
Definition: StandardFile.cpp:56
BasicFileSystem.hpp
StandardFile::m_pFile
FILE * m_pFile
Definition: StandardFile.hpp:54
BasicFile
Definition: BasicFileSystem.hpp:59
StandardFile::GetSize
size_t GetSize()
Definition: StandardFile.cpp:86