Foxit PDF SDK
fx_stream.h
Go to the documentation of this file.
1 
15 //<<<+++OPENSOURCE
16 //<<<+++OPENSOURCE_LICENSE
17 //<<<+++OPENSOURCE_BEGIN LIC==FOXIT||LIC==GOOGLE
18 
24 //<<<+++OPENSOURCE_MUST_BEGIN
25 #ifndef _FX_STREAM_H_
26 #define _FX_STREAM_H_
27 
28 #ifndef _FX_MEMORY_H_
29  #include "fx_memory.h"
30 #endif
31 //<<<+++OPENSOURCE_MUST_END
32 
33 //*****************************************************************************
34 //* Folder access
35 //*****************************************************************************
36 #if !defined(_FPDFAPI_MINI_) || (defined(_WIN32) && !defined(_FX_NO_WINDOWS_)) || _FXM_PLATFORM_ == _FXM_PLATFORM_LINUX_ || _FX_OS_ == _FX_ANDROID_ || _FXM_PLATFORM_ == _FXM_PLATFORM_APPLE_
37 
44 void* FX_OpenFolder(FX_LPCSTR path);
52 void* FX_OpenFolder(FX_LPCWSTR path);
53 
64 FX_BOOL FX_GetNextFile(void* handle, CFX_ByteString& filename, FX_BOOL& bFolder, FX_LPCSTR absPath=NULL);
75 FX_BOOL FX_GetNextFile(void* handle, CFX_WideString& filename, FX_BOOL& bFolder, FX_LPCSTR absPath=NULL);
76 
84 void FX_CloseFolder(void* handle);
85 
92 
93 #endif
94 
95 #if _FX_OS_ != _FX_EMBEDDED_
96 //<<<+++OPENSOURCE_BEGIN LIC==FOXIT
113 
122 //<<<+++OPENSOURCE_END
123 #endif
124 
125 //*****************************************************************************
126 //* File access
127 //*****************************************************************************
130 
131  //<<<+++OPENSOURCE_MUST_BEGIN LIC==FOXIT
132  #if _FX_OS_ == _FX_WIN32_DESKTOP_ || _FX_OS_ == _FX_WIN32_MOBILE_ || _FX_OS_ == _FX_WIN64_
133  #if defined(_FX_LARGEFILE_SUPPORT_)
134 
135  #define _FX_LARGEFILE_USED_
136 
138  #define FX_FILESIZE FX_INT64
139  #define FX_GETBYTEOFFSET32(a) ((FX_BYTE)((a>>16)>>16))
140  #define FX_GETBYTEOFFSET40(a) ((FX_BYTE)(((a>>16)>>16)>>8))
141  #define FX_GETBYTEOFFSET48(a) ((FX_BYTE)(((a>>16)>>16)>>16))
142  #define FX_GETBYTEOFFSET56(a) ((FX_BYTE)((((a>>16)>>16)>>16)>>8))
143  #else
144 
145  #define FX_FILESIZE FX_INT32
146  #define FX_GETBYTEOFFSET32(a) 0
147  #define FX_GETBYTEOFFSET40(a) 0
148  #define FX_GETBYTEOFFSET48(a) 0
149  #define FX_GETBYTEOFFSET56(a) 0
150  #endif
151  #elif _FX_OS_ == _FX_LINUX_DESKTOP_ || _FX_OS_ == _FX_MACOSX_ || _FX_OS_ == _FX_IOS_ || _FX_OS_ == _FX_ANDROID_ || _FX_OS_==_FX_LINUX_EMBEDDED_
152  #if defined(_FX_LARGEFILE_SUPPORT_)
153 
154  #define _FX_LARGEFILE_USED_
155 
156  #ifndef _LARGEFILE_SOURCE
157  #define _LARGEFILE_SOURCE
158  #endif
159  #ifndef _LARGEFILE64_SOURCE
160  #define _LARGEFILE64_SOURCE
161  #endif
162  #endif
163  #if defined(_FX_LARGEFILE_SUPPORT_)
164  #define FX_GETBYTEOFFSET32(a) ((FX_BYTE)((a>>16)>>16))
165  #define FX_GETBYTEOFFSET40(a) ((FX_BYTE)(((a>>16)>>16)>>8))
166  #define FX_GETBYTEOFFSET48(a) ((FX_BYTE)(((a>>16)>>16)>>16))
167  #define FX_GETBYTEOFFSET56(a) ((FX_BYTE)((((a>>16)>>16)>>16)>>8))
168  #else
169  #define FX_GETBYTEOFFSET32(a) 0
170  #define FX_GETBYTEOFFSET40(a) 0
171  #define FX_GETBYTEOFFSET48(a) 0
172  #define FX_GETBYTEOFFSET56(a) 0
173  #endif
174  #include <fcntl.h>
175  #include <unistd.h>
176  #include <sys/stat.h>
177 
178  #ifndef O_BINARY
179  #define O_BINARY 0
180  #endif
181  #ifndef O_LARGEFILE
182  #define O_LARGEFILE 0
183  #endif
184 
186  #if defined(_FX_LARGEFILE_SUPPORT_)
187  #if _FX_OS_ == _FX_LINUX_DESKTOP_ || _FX_OS_ == _FX_LINUX_EMBEDDED_ || _FX_OS_ == _FX_ANDROID_
188  // mac and bsd are always 64 bit. use off_t
189  // linux and android uses off64_t
190 #ifndef _CHROME_PNACL_
191  #define _FX_USE_OFF64_T_
192 #endif
193  #endif
194  #endif
195  #if defined(_FX_USE_OFF64_T_)
196  #define FX_FILESIZE off64_t
197  #elif _FX_OS_ == _FX_LINUX_EMBEDDED_
198  #define FX_FILESIZE FX_INT32
199  #else
200  #ifndef _CHROME_PNACL_
201  #define FX_FILESIZE off_t
202  #else
203  #define FX_FILESIZE FX_INT32
204  #endif
205  #endif
206  #else //do not support large file.
207 
208  #define FX_FILESIZE FX_INT32
209  #define FX_GETBYTEOFFSET32(a) 0
210  #define FX_GETBYTEOFFSET40(a) 0
211  #define FX_GETBYTEOFFSET48(a) 0
212  #define FX_GETBYTEOFFSET56(a) 0
213  #endif
214  //<<<+++OPENSOURCE_MUST_END
215 
216 #define FX_GETBYTEOFFSET24(a) ((FX_BYTE)(a>>24))
217 #define FX_GETBYTEOFFSET16(a) ((FX_BYTE)(a>>16))
218 #define FX_GETBYTEOFFSET8(a) ((FX_BYTE)(a>>8))
219 #define FX_GETBYTEOFFSET0(a) ((FX_BYTE)(a))
220 
226 #define FX_FILEMODE_Write 0
227 
228 #define FX_FILEMODE_ReadOnly 1
229 
230 #define FX_FILEMODE_Truncate 2 //
231 
243 FX_HFILE FX_File_Open(FX_BSTR fileName, FX_DWORD dwMode, IFX_Allocator* pAllocator = NULL);
254 FX_HFILE FX_File_Open(FX_WSTR fileName, FX_DWORD dwMode, IFX_Allocator* pAllocator = NULL);
263 void FX_File_Close(FX_HFILE hFile, IFX_Allocator* pAllocator = NULL);
264 //<<<+++OPENSOURCE_END
265 
273 FX_FILESIZE FX_File_GetSize(FX_HFILE hFile);
281 FX_FILESIZE FX_File_GetPosition(FX_HFILE hFile);
290 FX_FILESIZE FX_File_SetPosition(FX_HFILE hFile, FX_FILESIZE pos);
300 size_t FX_File_Read(FX_HFILE hFile, void* pBuffer, size_t szBuffer);
311 size_t FX_File_ReadPos(FX_HFILE hFile, void* pBuffer, size_t szBuffer, FX_FILESIZE pos);
321 size_t FX_File_Write(FX_HFILE hFile, const void* pBuffer, size_t szBuffer);
332 size_t FX_File_WritePos(FX_HFILE hFile, const void* pBuffer, size_t szBuffer, FX_FILESIZE pos);
340 FX_BOOL FX_File_Flush(FX_HFILE hFile);
349 FX_BOOL FX_File_Truncate(FX_HFILE hFile, FX_FILESIZE szFile);
350 
358 FX_BOOL FX_File_Exist(FX_BSTR fileName);
366 FX_BOOL FX_File_Exist(FX_WSTR fileName);
374 FX_BOOL FX_File_Delete(FX_BSTR fileName);
382 FX_BOOL FX_File_Delete(FX_WSTR fileName);
391 FX_BOOL FX_File_Copy(FX_BSTR fileNameSrc, FX_BSTR fileNameDst);
400 FX_BOOL FX_File_Copy(FX_WSTR fileNameSrc, FX_WSTR fileNameDst);
409 FX_BOOL FX_File_Move(FX_BSTR fileNameSrc, FX_BSTR fileNameDst);
418 FX_BOOL FX_File_Move(FX_WSTR fileNameSrc, FX_WSTR fileNameDst);
419 
420 //*****************************************************************************
421 //* IFX_StreamWrite/IFX_FileWrite
422 //*****************************************************************************
425 {
426  public:
428  virtual void Release() = 0;
429 
438  virtual FX_BOOL WriteBlock(const void* pData, size_t size) = 0;
444  virtual FX_BOOL Flush() { return true; }
445 
446 #if !defined(__EMSCRIPTEN__) && !defined(SWIGJAVA)
447  protected:
448 #endif
449  virtual ~IFX_StreamWrite() {}
450 };
451 
454 {
455  public:
457  virtual void Release() = 0;
458 
464  virtual FX_FILESIZE GetSize() = 0;
470  virtual FX_BOOL Flush() = 0;
480  virtual FX_BOOL WriteBlock(const void* pData, FX_FILESIZE offset, size_t size) = 0;
489  virtual FX_BOOL WriteBlock(const void* pData, size_t size) {return WriteBlock(pData, GetSize(), size);}
490 
491 #if !defined(__EMSCRIPTEN__) && !defined(SWIGJAVA)
492  protected:
493 #endif
494  virtual ~IFX_FileWrite() {}
495 };
496 
507 
518 //<<<+++OPENSOURCE_END
519 
520 //*****************************************************************************
521 //* IFX_FileRead
522 //*****************************************************************************
525 {
526  public:
532  virtual void Release() = 0;
533 
539  virtual FX_BOOL IsEOF() = 0;
545  virtual FX_FILESIZE GetPosition() = 0;
554  virtual size_t ReadBlock(void* buffer, size_t size) = 0;
555 
563  virtual FX_FILESIZE SetPosition(FX_FILESIZE pos) { FXSYS_assert(false && "Unsupport"); return -1; }
564 
565  protected:
566  virtual ~IFX_StreamRead() {}
567 };
568 
571 {
572  public:
578  virtual void Release() = 0;
579 
585  virtual FX_FILESIZE GetSize() = 0;
591  virtual FX_BOOL IsEOF() {return false;}
597  virtual FX_FILESIZE GetPosition() {return 0;}
606  virtual FX_BOOL SetRange(FX_FILESIZE offset, FX_FILESIZE size) {return false;}
612  virtual void ClearRange() {}
622  virtual FX_BOOL ReadBlock(void* buffer, FX_FILESIZE offset, size_t size) = 0;
631  virtual size_t ReadBlock(void* buffer, size_t size) {return 0;}
632 
640  virtual FX_FILESIZE SetPosition(FX_FILESIZE pos) { FXSYS_assert(false && "Unsupport"); return -1; }
641 
642 #if !defined(__EMSCRIPTEN__) && !defined(SWIGJAVA)
643  protected:
644 #endif
645  virtual ~IFX_FileRead() {}
646 };
647 
657 IFX_FileRead* FX_CreateFileRead(FX_LPCSTR filename, IFX_Allocator* pAllocator = NULL);
658 
669 //<<<+++OPENSOURCE_END
670 
671 //*****************************************************************************
672 //* IFX_FileStream
673 //*****************************************************************************
676 : public IFX_FileRead, public IFX_FileWrite
677 {
678  public:
684  virtual IFX_FileStream* Retain() = 0;
690  virtual void Release() = 0;
691 
697  virtual FX_FILESIZE GetSize() = 0;
703  virtual FX_BOOL IsEOF() = 0;
709  virtual FX_FILESIZE GetPosition() = 0;
710 
720  virtual FX_BOOL ReadBlock(void* buffer, FX_FILESIZE offset, size_t size) = 0;
729  virtual size_t ReadBlock(void* buffer, size_t size) = 0;
730 
740  virtual FX_BOOL WriteBlock(const void* buffer, FX_FILESIZE offset, size_t size) = 0;
749  virtual FX_BOOL WriteBlock(const void* buffer, size_t size) {return WriteBlock(buffer, GetSize(), size);}
750 
756  virtual FX_BOOL Flush() = 0;
757 
758 #if !defined(__EMSCRIPTEN__) && !defined(SWIGJAVA)
759  protected:
760 #endif
761  virtual ~IFX_FileStream() {}
762 };
763 
774 IFX_FileStream* FX_CreateFileStream(FX_LPCSTR filename, FX_DWORD dwModes, IFX_Allocator* pAllocator = NULL);
775 
786 IFX_FileStream* FX_CreateFileStream(FX_LPCWSTR filename, FX_DWORD dwModes, IFX_Allocator* pAllocator = NULL);
787 //<<<+++OPENSOURCE_END
788 
789 //*****************************************************************************
790 //* IFX_ChunkFileStream
791 //*****************************************************************************
794 {
795  public:
801  virtual void Release() = 0;
802 
808  virtual FX_FILESIZE GetSize() = 0;
814  virtual FX_BOOL IsEOF() = 0;
820  virtual FX_FILESIZE GetPosition() = 0;
821 
831  virtual FX_BOOL ReadBlock(void* buffer, FX_FILESIZE offset, size_t size) = 0;
840  virtual size_t ReadBlock(void* buffer, size_t size) = 0;
841 
851  virtual FX_BOOL WriteBlock(const void* buffer, FX_FILESIZE offset, size_t size) = 0;
860  virtual FX_BOOL WriteBlock(const void* buffer, size_t size)
861  {
862  return WriteBlock(buffer, GetSize(), size);
863  }
864 
870  virtual FX_BOOL Flush() = 0;
871 
872  protected:
878  virtual IFX_FileStream* Retain() = 0;
879 
880  virtual ~IFX_ChunkFileStream() {}
881 
882  friend class CFX_ChunkFileStreamsManager;
883 };
884 
885 //*****************************************************************************
886 //* CFX_ChunkFileStreamsManager
887 //*****************************************************************************
889 class CFX_ChunkFileStreamsManagerImpl;
890 class CFX_ChunkFileStreamsManager : public CFX_Object
891 {
892  public:
900  CFX_ChunkFileStreamsManager(IFX_FileStream* pFileStream, size_t nChunkSize = 1024);
907  ~CFX_ChunkFileStreamsManager();
908 
915  IFX_ChunkFileStream* CreateChunkFileStream();
916 
917  private:
918  std::shared_ptr<CFX_ChunkFileStreamsManagerImpl> m_pImpl;
919 };
920 
921 //*****************************************************************************
922 //* IFX_FileAccess
923 //*****************************************************************************
926 {
927  public:
933  virtual void Release() = 0;
934 
940  virtual IFX_FileAccess* Retain() = 0;
948  virtual void GetPath(CFX_WideString& wsPath) = 0;
949 
957  virtual IFX_FileStream* CreateFileStream(FX_DWORD dwModes) = 0;
958 
959  protected:
960  virtual ~IFX_FileAccess() {}
961 };
962 
973 
974 class IFX_FileCollection
975 {
976  public:
977  virtual void Release() = 0;
978 
979  virtual FX_POSITION GetStartPos() = 0;
980  virtual IFX_FileAccess* GetNextFile(FX_POSITION& pos) = 0;
981 
982  protected:
983  virtual ~IFX_FileCollection() {}
984 };
985 //<<<+++OPENSOURCE_END
986 
987 //*****************************************************************************
988 //* Memory stream
989 //*****************************************************************************
992 {
993  public:
994  virtual ~IFX_MemoryStream() {}
995 
1001  virtual FX_BOOL IsConsecutive() const = 0;
1015  virtual void EstimateSize(size_t nInitSize, size_t nGrowSize) = 0;
1024  virtual FX_LPBYTE GetBuffer() const = 0;
1039  virtual void AttachBuffer(FX_LPBYTE pBuffer, size_t nSize, FX_BOOL bTakeOver = false) = 0;
1047  virtual void DetachBuffer() = 0;
1048 };
1062 IFX_MemoryStream* FX_CreateMemoryStream(FX_LPBYTE pBuffer, size_t nSize, FX_BOOL bTakeOver = false, IFX_Allocator* pAllocator = NULL);
1063 
1075 IFX_MemoryStream* FX_CreateMemoryStream(FX_BOOL bConsecutive = false, IFX_Allocator* pAllocator = NULL);
1076 //<<<+++OPENSOURCE_END
1077 
1078 //*****************************************************************************
1079 //* Buffer read stream
1080 //*****************************************************************************
1087 {
1088  public:
1094  virtual void Release() = 0;
1095 
1101  virtual FX_BOOL IsEOF() = 0;
1107  virtual FX_FILESIZE GetPosition() = 0;
1108 
1117  virtual size_t ReadBlock(void* buffer, size_t size) = 0;
1118 
1126  virtual FX_BOOL ReadNextBlock(FX_BOOL bRestart = false) = 0;
1132  virtual FX_LPCBYTE GetBlockBuffer() = 0;
1138  virtual size_t GetBlockSize() = 0;
1146  virtual FX_FILESIZE GetBlockOffset() = 0;
1147 
1148  protected:
1149  virtual ~IFX_BufferRead() {}
1150 };
1151 
1152 //*****************************************************************************
1153 //* Cached file read
1154 //*****************************************************************************
1155 #define FX_FILECACHE_CHUNKSIZE 32768
1156 #define FX_FILECACHE_CHUNKCOUNT 64
1157 
1159 class CFX_CachedFileRead : public IFX_FileStream, public CFX_Object
1160 {
1161  public:
1165  virtual ~CFX_CachedFileRead();
1166 
1178  FX_BOOL Init(FX_INT32 nChunkSize, FX_INT32 nChunkCount, FX_LPVOID pBuffer, IFX_Allocator* pAllocator = NULL);
1187  FX_BOOL AttachFile(IFX_FileRead* pFile, FX_BOOL bTakeOver);
1196  FX_BOOL PreCache(FX_FILESIZE offset, FX_INT32 nCacheCount);
1197 
1203  virtual FX_FILESIZE GetSize();
1209  virtual FX_BOOL IsEOF();
1215  virtual FX_FILESIZE GetPosition();
1216 
1226  virtual FX_BOOL ReadBlock(void* buffer, FX_FILESIZE offset, size_t size);
1235  virtual size_t ReadBlock(void* buffer, size_t size);
1236 
1237  protected:
1238  FXMT_LOCKOBJECT_DEFINE(m_LockObj);
1239  FX_LPVOID m_pData;
1240  FX_DWORD m_dwCount;
1241 
1242  /* @brief Create a shared instance. */
1243  virtual IFX_FileStream* Retain();
1244  /* @brief Called when to release everything */
1245  virtual void Release();
1247  virtual FX_BOOL WriteBlock(const void* buffer, FX_FILESIZE offset, size_t size) {return false;}
1249  virtual FX_BOOL Flush() {return false;}
1250 };
1251 //<<<+++OPENSOURCE_END
1252 
1253 //<<<+++OPENSOURCE_MUST_BEGIN
1254 #endif // _FX_STREAM_H_
1255 //<<<+++OPENSOURCE_MUST_END
1256 
1259 //<<<+++OPENSOURCE_END
FX_File_Truncate
FX_BOOL FX_File_Truncate(FX_HFILE hFile, FX_INT64 szFile)
Truncate file size.
IFX_FileWrite::WriteBlock
virtual FX_BOOL WriteBlock(const void *pData, size_t size)
Write a block data to the end.
Definition: fx_stream.h:489
FX_DWORD
unsigned long FX_DWORD
32-bit unsigned integer.
Definition: fx_system.h:715
IFX_FileWrite
File writing interface.
Definition: fx_stream.h:453
CFX_CachedFileRead::~CFX_CachedFileRead
virtual ~CFX_CachedFileRead()
Destructor.
IFX_ChunkFileStream
Chunk-based File stream interface, reading & writing.
Definition: fx_stream.h:793
IFX_BufferRead::Release
virtual void Release()=0
Called when to release the current instance.
CFX_CachedFileRead::Retain
virtual IFX_FileStream * Retain()
Create a shared instance.
IFX_MemoryStream::AttachBuffer
virtual void AttachBuffer(FX_LPBYTE pBuffer, size_t nSize, FX_BOOL bTakeOver=false)=0
Attach a memory buffer.
CFX_CachedFileRead::AttachFile
FX_BOOL AttachFile(IFX_FileRead *pFile, FX_BOOL bTakeOver)
Attach a file read.
FX_CreateDefaultFileAccess
IFX_FileAccess * FX_CreateDefaultFileAccess(FX_WSTR wsPath, IFX_Allocator *pAllocator=0)
Create a CRT based file I/O interface.
FX_WCHAR
wchar_t FX_WCHAR
Compiler dependant Unicode character (16-bit for Microsoft Compiler, 32-bit for gcc).
Definition: fx_system.h:721
IFX_StreamWrite::WriteBlock
virtual FX_BOOL WriteBlock(const void *pData, size_t size)=0
Write a block data.
FX_File_Read
size_t FX_File_Read(FX_HFILE hFile, void *pBuffer, size_t szBuffer)
Read data from the current file accessing position.
IFX_StreamWrite::Release
virtual void Release()=0
Called when to release everything.
FX_File_WritePos
size_t FX_File_WritePos(FX_HFILE hFile, const void *pBuffer, size_t szBuffer, FX_INT64 pos)
Write data at specified position.
IFX_StreamRead
Stream reading interface.
Definition: fx_stream.h:524
IFX_ChunkFileStream::ReadBlock
virtual FX_BOOL ReadBlock(void *buffer, FX_INT64 offset, size_t size)=0
Read a data block from stream.
FX_CreateFolder
FX_BOOL FX_CreateFolder(FX_LPCSTR path)
Create new folder.
IFX_FileStream
File stream interface, reading & writing.
Definition: fx_stream.h:675
IFX_BufferRead::IsEOF
virtual FX_BOOL IsEOF()=0
Determine whether reach the end of stream.
IFX_FileAccess::Retain
virtual IFX_FileAccess * Retain()=0
Create a shared instance.
IFX_FileRead::IsEOF
virtual FX_BOOL IsEOF()
Determine whether reach the end of stream.
Definition: fx_stream.h:591
FX_CreateFileWrite
IFX_FileWrite * FX_CreateFileWrite(FX_LPCSTR filename, IFX_Allocator *pAllocator=0)
(Available only for platforms supporting CRT file access (fopen, ...)) Create a CRT based file writin...
FX_File_Copy
FX_BOOL FX_File_Copy(FX_BSTR fileNameSrc, FX_BSTR fileNameDst)
Copy file.
IFX_FileRead
File reading interface.
Definition: fx_stream.h:570
IFX_FileStream::WriteBlock
virtual FX_BOOL WriteBlock(const void *buffer, FX_INT64 offset, size_t size)=0
Write a block data into stream.
FX_File_SetPosition
FX_INT64 FX_File_SetPosition(FX_HFILE hFile, FX_INT64 pos)
Set the current file accessing position.
FX_File_GetPosition
FX_INT64 FX_File_GetPosition(FX_HFILE hFile)
Get the current file accessing position.
IFX_ChunkFileStream::GetPosition
virtual FX_INT64 GetPosition()=0
Get the current reading position in stream.
FX_File_Write
size_t FX_File_Write(FX_HFILE hFile, const void *pBuffer, size_t szBuffer)
Write data from the current file accessing position.
IFX_BufferRead
IFX_BufferRead stream provides an optimized approach to read stream data. Usually,...
Definition: fx_stream.h:1086
IFX_FileStream::Release
virtual void Release()=0
Destroy the current instance.
FX_CreateFileRead
IFX_FileRead * FX_CreateFileRead(FX_LPCSTR filename, IFX_Allocator *pAllocator=0)
(Available only for platforms supporting CRT file access) Create a CRT based file reading interface.
IFX_BufferRead::GetBlockSize
virtual size_t GetBlockSize()=0
Get the size of data in internal buffer.
IFX_StreamRead::SetPosition
virtual FX_INT64 SetPosition(FX_INT64 pos)
Set the current file accessing position.
Definition: fx_stream.h:563
IFX_StreamRead::ReadBlock
virtual size_t ReadBlock(void *buffer, size_t size)=0
Read data block from sequential stream.
IFX_ChunkFileStream::GetSize
virtual FX_INT64 GetSize()=0
Get the current stream size, in bytes.
IFX_StreamWrite
Stream writing interface.
Definition: fx_stream.h:424
FX_LPVOID
void * FX_LPVOID
Pointer to any type.
Definition: fx_system.h:645
IFX_FileAccess::GetPath
virtual void GetPath(CFX_WideString &wsPath)=0
Get current path string.
FX_DEFINEHANDLE
#define FX_DEFINEHANDLE(name)
Macro to define a handle type.
Definition: fx_system.h:760
IFX_MemoryStream::DetachBuffer
virtual void DetachBuffer()=0
Detach the current memory buffer.
IFX_ChunkFileStream::IsEOF
virtual FX_BOOL IsEOF()=0
Determine whether reach the end of stream.
FX_OpenFolder
void * FX_OpenFolder(FX_LPCSTR path)
Open a folder for reading.
CFX_CachedFileRead::ReadBlock
virtual FX_BOOL ReadBlock(void *buffer, FX_INT64 offset, size_t size)
Read a data block from the file.
CFX_CachedFileRead::Release
virtual void Release()
Destroy the current instance.
FX_POSITION
void * FX_POSITION
A value used to denote the position of an element in a collection.
Definition: fx_system.h:649
CFX_CachedFileRead::GetPosition
virtual FX_INT64 GetPosition()
Get the current reading position in stream.
FX_INT32
int FX_INT32
32-bit signed integer.
Definition: fx_system.h:674
IFX_MemoryStream::IsConsecutive
virtual FX_BOOL IsConsecutive() const =0
Determine whether the current mode is consecutive or not.
IFX_FileStream::GetSize
virtual FX_INT64 GetSize()=0
Get the current stream size, in bytes.
FX_File_Exist
FX_BOOL FX_File_Exist(FX_BSTR fileName)
Determine whether a file exists or not.
IFX_FileRead::ReadBlock
virtual FX_BOOL ReadBlock(void *buffer, FX_INT64 offset, size_t size)=0
Read a data block from the file.
IFX_MemoryStream::EstimateSize
virtual void EstimateSize(size_t nInitSize, size_t nGrowSize)=0
Change initialize size and grow size.
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
CFX_CachedFileRead::WriteBlock
virtual FX_BOOL WriteBlock(const void *buffer, FX_INT64 offset, size_t size)
Write a block data into stream. Unsupported for reading mode, return false directly.
Definition: fx_stream.h:1247
IFX_Allocator
Foxit allocator interface.
Definition: fx_memory.h:997
IFX_StreamWrite::Flush
virtual FX_BOOL Flush()
Flush stream data.
Definition: fx_stream.h:444
fx_memory.h
Header file for Memory management related definitions and classes.
IFX_FileAccess::Release
virtual void Release()=0
Destroy the current instance.
IFX_BufferRead::GetBlockOffset
virtual FX_INT64 GetBlockOffset()=0
Get the offset of data in internal buffer.
FX_LPCWSTR
wchar_t const * FX_LPCWSTR
Pointer to constant Unicode characters.
Definition: fx_system.h:725
CFX_CachedFileRead
Cached file read interface.
Definition: fx_stream.h:1159
IFX_FileWrite::GetSize
virtual FX_INT64 GetSize()=0
Get total size of the file.
IFX_FileWrite::Flush
virtual FX_BOOL Flush()=0
Flush internal buffer of the file.
FXSYS_assert
#define FXSYS_assert
Assertion.
Definition: fx_system.h:792
FX_File_Move
FX_BOOL FX_File_Move(FX_BSTR fileNameSrc, FX_BSTR fileNameDst)
Move file.
CFX_CachedFileRead::Flush
virtual FX_BOOL Flush()
Flush internal buffer. Unsupported for reading mode, return false directly.
Definition: fx_stream.h:1249
IFX_FileStream::WriteBlock
virtual FX_BOOL WriteBlock(const void *buffer, size_t size)
Write a block data to the end of current stream.
Definition: fx_stream.h:749
IFX_MemoryStream::GetBuffer
virtual FX_LPBYTE GetBuffer() const =0
Get the current memory buffer.
IFX_FileStream::IsEOF
virtual FX_BOOL IsEOF()=0
Determine whether reach the end of stream.
FX_LPCSTR
char const * FX_LPCSTR
Pointer to constant 8-bit Windows (ANSI) characters.
Definition: fx_system.h:696
IFX_FileRead::SetPosition
virtual FX_INT64 SetPosition(FX_INT64 pos)
Set the current file accessing position.
Definition: fx_stream.h:640
FX_FILESIZE
#define FX_FILESIZE
Support large file directly.
Definition: fx_stream.h:138
FX_LPCBYTE
unsigned char const * FX_LPCBYTE
Pointer to a constant FX_BYTE.
Definition: fx_system.h:660
IFX_FileStream::Retain
virtual IFX_FileStream * Retain()=0
Create a shared instance.
IFX_BufferRead::ReadBlock
virtual size_t ReadBlock(void *buffer, size_t size)=0
Read data block from sequential stream.
IFX_BufferRead::GetBlockBuffer
virtual FX_LPCBYTE GetBlockBuffer()=0
Get internal buffer of block data.
IFX_FileAccess::CreateFileStream
virtual IFX_FileStream * CreateFileStream(FX_DWORD dwModes)=0
Create IFX_FileStream to operate file.
IFX_MemoryStream
Memory stream interface.
Definition: fx_stream.h:991
IFX_FileRead::ClearRange
virtual void ClearRange()
Clear accessing range set by function IFX_FileRead::SetRange.
Definition: fx_stream.h:612
CFX_CachedFileRead::PreCache
FX_BOOL PreCache(FX_INT64 offset, FX_INT32 nCacheCount)
Attach a file read.
IFX_BufferRead::ReadNextBlock
virtual FX_BOOL ReadNextBlock(FX_BOOL bRestart=false)=0
Read the next block in sequential stream.
FX_BSTR
const typedef CFX_ByteStringC & FX_BSTR
A reference to a constant CFX_ByteStringC object.
Definition: fx_string.h:285
FX_File_GetSize
FX_INT64 FX_File_GetSize(FX_HFILE hFile)
Get file size.
FX_File_Open
FX_HFILE FX_File_Open(FX_BSTR fileName, FX_DWORD dwMode, IFX_Allocator *pAllocator=0)
Open file with specified accessing mode.
FX_IsFilePathExist
FX_BOOL FX_IsFilePathExist(FX_LPCWSTR path)
Check if the path exists, including file path and folder path.
IFX_FileAccess
File access interface, open file.
Definition: fx_stream.h:925
CFX_CachedFileRead::Init
FX_BOOL Init(FX_INT32 nChunkSize, FX_INT32 nChunkCount, FX_LPVOID pBuffer, IFX_Allocator *pAllocator=0)
Initialize the chunk size and chunk count.
IFX_StreamRead::GetPosition
virtual FX_INT64 GetPosition()=0
Get the current reading position in stream.
IFX_FileStream::ReadBlock
virtual FX_BOOL ReadBlock(void *buffer, FX_INT64 offset, size_t size)=0
Read a data block from stream.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:780
FX_File_ReadPos
size_t FX_File_ReadPos(FX_HFILE hFile, void *pBuffer, size_t szBuffer, FX_INT64 pos)
Read data from specified position.
IFX_StreamRead::IsEOF
virtual FX_BOOL IsEOF()=0
Determine whether reach the end of stream.
IFX_FileWrite::WriteBlock
virtual FX_BOOL WriteBlock(const void *pData, FX_INT64 offset, size_t size)=0
Write a block data.
FX_BOOL
int FX_BOOL
Boolean variable (should be TRUE or FALSE).
Definition: fx_system.h:682
FX_WSTR
const typedef CFX_WideStringC & FX_WSTR
Type definition for a reference to a constant CFX_WideStringC object.
Definition: fx_string.h:1417
FX_CreateFileStream
IFX_FileStream * FX_CreateFileStream(FX_LPCSTR filename, FX_DWORD dwModes, IFX_Allocator *pAllocator=0)
(Available only for platforms supporting CRT file access) Create a CRT based file I/O interface.
FX_File_Close
void FX_File_Close(FX_HFILE hFile, IFX_Allocator *pAllocator=0)
Close file.
IFX_FileStream::GetPosition
virtual FX_INT64 GetPosition()=0
Get the current reading position in stream.
IFX_ChunkFileStream::WriteBlock
virtual FX_BOOL WriteBlock(const void *buffer, size_t size)
Write a block data to the end of current stream.
Definition: fx_stream.h:860
IFX_FileStream::Flush
virtual FX_BOOL Flush()=0
Flush internal buffer.
IFX_FileRead::GetSize
virtual FX_INT64 GetSize()=0
Get total size of the file.
FX_CloseFolder
void FX_CloseFolder(void *handle)
Close folder handle.
IFX_FileRead::SetRange
virtual FX_BOOL SetRange(FX_INT64 offset, FX_INT64 size)
Set accessing range.
Definition: fx_stream.h:606
FX_LPBYTE
unsigned char * FX_LPBYTE
Pointer to a FX_BYTE.
Definition: fx_system.h:658
FX_GetFolderSeparator
FX_WCHAR FX_GetFolderSeparator()
Get folder separator for the system. Most likely it's either /' or '\'.
FX_File_Delete
FX_BOOL FX_File_Delete(FX_BSTR fileName)
Delete file.
IFX_ChunkFileStream::Flush
virtual FX_BOOL Flush()=0
Flush internal buffer.
IFX_FileRead::GetPosition
virtual FX_INT64 GetPosition()
Get the current reading position in stream.
Definition: fx_stream.h:597
CFX_CachedFileRead::CFX_CachedFileRead
CFX_CachedFileRead()
Constructor.
IFX_StreamRead::Release
virtual void Release()=0
Called when to release everything.
CFX_CachedFileRead::IsEOF
virtual FX_BOOL IsEOF()
Determine whether reach the end of stream.
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1452
IFX_BufferRead::GetPosition
virtual FX_INT64 GetPosition()=0
Get the current reading position in stream.
IFX_FileRead::Release
virtual void Release()=0
Called when to release everything.
FX_CreateMemoryStream
IFX_MemoryStream * FX_CreateMemoryStream(FX_LPBYTE pBuffer, size_t nSize, FX_BOOL bTakeOver=false, IFX_Allocator *pAllocator=0)
Creates a stream object by a given memory buffer. This function creates a consecutive memory stream o...
CFX_CachedFileRead::GetSize
virtual FX_INT64 GetSize()
Get total size of the file.
IFX_ChunkFileStream::WriteBlock
virtual FX_BOOL WriteBlock(const void *buffer, FX_INT64 offset, size_t size)=0
Write a block data into stream.
IFX_ChunkFileStream::Retain
virtual IFX_FileStream * Retain()=0
Create a shared instance.
FX_File_Flush
FX_BOOL FX_File_Flush(FX_HFILE hFile)
Flush internal buffer if need.
IFX_FileWrite::Release
virtual void Release()=0
Called when to release everything.
IFX_ChunkFileStream::Release
virtual void Release()=0
Destroy the current instance.
FX_GetNextFile
FX_BOOL FX_GetNextFile(void *handle, CFX_ByteString &filename, FX_BOOL &bFolder, FX_LPCSTR absPath=0)
Read next entry in the folder.
IFX_FileRead::ReadBlock
virtual size_t ReadBlock(void *buffer, size_t size)
Read data block from stream.
Definition: fx_stream.h:631