clang-format all pdfium code.
[pdfium.git] / core / include / fxcrt / fx_stream.h
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef CORE_INCLUDE_FXCRT_FX_STREAM_H_
8 #define CORE_INCLUDE_FXCRT_FX_STREAM_H_
9
10 #include "fx_string.h"
11
12 void* FX_OpenFolder(const FX_CHAR* path);
13 void* FX_OpenFolder(const FX_WCHAR* path);
14 FX_BOOL FX_GetNextFile(void* handle,
15                        CFX_ByteString& filename,
16                        FX_BOOL& bFolder);
17 FX_BOOL FX_GetNextFile(void* handle,
18                        CFX_WideString& filename,
19                        FX_BOOL& bFolder);
20 void FX_CloseFolder(void* handle);
21 FX_WCHAR FX_GetFolderSeparator();
22 #if _FXM_PLATFORM_ == _FXM_PLATFORM_WINDOWS_
23 #define FX_FILESIZE int32_t
24 #else
25 #include <fcntl.h>
26 #include <unistd.h>
27 #include <sys/stat.h>
28 #ifndef O_BINARY
29 #define O_BINARY 0
30 #endif
31 #ifndef O_LARGEFILE
32 #define O_LARGEFILE 0
33 #endif
34 #define FX_FILESIZE off_t
35 #endif
36 #define FX_GETBYTEOFFSET32(a) 0
37 #define FX_GETBYTEOFFSET40(a) 0
38 #define FX_GETBYTEOFFSET48(a) 0
39 #define FX_GETBYTEOFFSET56(a) 0
40 #define FX_GETBYTEOFFSET24(a) ((uint8_t)(a >> 24))
41 #define FX_GETBYTEOFFSET16(a) ((uint8_t)(a >> 16))
42 #define FX_GETBYTEOFFSET8(a) ((uint8_t)(a >> 8))
43 #define FX_GETBYTEOFFSET0(a) ((uint8_t)(a))
44 #define FX_FILEMODE_Write 0
45 #define FX_FILEMODE_ReadOnly 1
46 #define FX_FILEMODE_Truncate 2
47 FX_BOOL FX_File_Exist(const CFX_ByteStringC& fileName);
48 FX_BOOL FX_File_Exist(const CFX_WideStringC& fileName);
49 FX_BOOL FX_File_Delete(const CFX_ByteStringC& fileName);
50 FX_BOOL FX_File_Delete(const CFX_WideStringC& fileName);
51 FX_BOOL FX_File_Copy(const CFX_ByteStringC& fileNameSrc,
52                      const CFX_ByteStringC& fileNameDst);
53 FX_BOOL FX_File_Copy(const CFX_WideStringC& fileNameSrc,
54                      const CFX_WideStringC& fileNameDst);
55 FX_BOOL FX_File_Move(const CFX_ByteStringC& fileNameSrc,
56                      const CFX_ByteStringC& fileNameDst);
57 FX_BOOL FX_File_Move(const CFX_WideStringC& fileNameSrc,
58                      const CFX_WideStringC& fileNameDst);
59 class IFX_StreamWrite {
60  public:
61   virtual ~IFX_StreamWrite() {}
62   virtual void Release() = 0;
63
64   virtual FX_BOOL WriteBlock(const void* pData, size_t size) = 0;
65 };
66 class IFX_FileWrite : public IFX_StreamWrite {
67  public:
68   virtual void Release() = 0;
69
70   virtual FX_FILESIZE GetSize() = 0;
71
72   virtual FX_BOOL Flush() = 0;
73
74   virtual FX_BOOL WriteBlock(const void* pData,
75                              FX_FILESIZE offset,
76                              size_t size) = 0;
77   virtual FX_BOOL WriteBlock(const void* pData, size_t size) {
78     return WriteBlock(pData, GetSize(), size);
79   }
80 };
81 IFX_FileWrite* FX_CreateFileWrite(const FX_CHAR* filename);
82 IFX_FileWrite* FX_CreateFileWrite(const FX_WCHAR* filename);
83 class IFX_StreamRead {
84  public:
85   virtual ~IFX_StreamRead() {}
86
87   virtual void Release() = 0;
88
89   virtual FX_BOOL IsEOF() = 0;
90
91   virtual FX_FILESIZE GetPosition() = 0;
92
93   virtual size_t ReadBlock(void* buffer, size_t size) = 0;
94 };
95 class IFX_FileRead : IFX_StreamRead {
96  public:
97   virtual void Release() = 0;
98
99   virtual FX_FILESIZE GetSize() = 0;
100
101   virtual FX_BOOL IsEOF() { return FALSE; }
102
103   virtual FX_FILESIZE GetPosition() { return 0; }
104
105   virtual FX_BOOL SetRange(FX_FILESIZE offset, FX_FILESIZE size) {
106     return FALSE;
107   }
108
109   virtual void ClearRange() {}
110
111   virtual FX_BOOL ReadBlock(void* buffer, FX_FILESIZE offset, size_t size) = 0;
112
113   virtual size_t ReadBlock(void* buffer, size_t size) { return 0; }
114 };
115 IFX_FileRead* FX_CreateFileRead(const FX_CHAR* filename);
116 IFX_FileRead* FX_CreateFileRead(const FX_WCHAR* filename);
117 class IFX_FileStream : public IFX_FileRead, public IFX_FileWrite {
118  public:
119   virtual IFX_FileStream* Retain() = 0;
120
121   virtual void Release() = 0;
122
123   virtual FX_FILESIZE GetSize() = 0;
124
125   virtual FX_BOOL IsEOF() = 0;
126
127   virtual FX_FILESIZE GetPosition() = 0;
128
129   virtual FX_BOOL ReadBlock(void* buffer, FX_FILESIZE offset, size_t size) = 0;
130
131   virtual size_t ReadBlock(void* buffer, size_t size) = 0;
132
133   virtual FX_BOOL WriteBlock(const void* buffer,
134                              FX_FILESIZE offset,
135                              size_t size) = 0;
136   virtual FX_BOOL WriteBlock(const void* buffer, size_t size) {
137     return WriteBlock(buffer, GetSize(), size);
138   }
139
140   virtual FX_BOOL Flush() = 0;
141 };
142 IFX_FileStream* FX_CreateFileStream(const FX_CHAR* filename, FX_DWORD dwModes);
143 IFX_FileStream* FX_CreateFileStream(const FX_WCHAR* filename, FX_DWORD dwModes);
144 class IFX_MemoryStream : public IFX_FileStream {
145  public:
146   virtual FX_BOOL IsConsecutive() const = 0;
147
148   virtual void EstimateSize(size_t nInitSize, size_t nGrowSize) = 0;
149
150   virtual uint8_t* GetBuffer() const = 0;
151
152   virtual void AttachBuffer(uint8_t* pBuffer,
153                             size_t nSize,
154                             FX_BOOL bTakeOver = FALSE) = 0;
155
156   virtual void DetachBuffer() = 0;
157 };
158 IFX_MemoryStream* FX_CreateMemoryStream(uint8_t* pBuffer,
159                                         size_t nSize,
160                                         FX_BOOL bTakeOver = FALSE);
161 IFX_MemoryStream* FX_CreateMemoryStream(FX_BOOL bConsecutive = FALSE);
162 class IFX_BufferRead : public IFX_StreamRead {
163  public:
164   virtual void Release() = 0;
165
166   virtual FX_BOOL IsEOF() = 0;
167
168   virtual FX_FILESIZE GetPosition() = 0;
169
170   virtual size_t ReadBlock(void* buffer, size_t size) = 0;
171
172   virtual FX_BOOL ReadNextBlock(FX_BOOL bRestart = FALSE) = 0;
173
174   virtual const uint8_t* GetBlockBuffer() = 0;
175
176   virtual size_t GetBlockSize() = 0;
177
178   virtual FX_FILESIZE GetBlockOffset() = 0;
179 };
180
181 #endif  // CORE_INCLUDE_FXCRT_FX_STREAM_H_