Visualization Library 2.1.0

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
DiskFile.hpp
Go to the documentation of this file.
1 /**************************************************************************************/
2 /* */
3 /* Visualization Library */
4 /* http://visualizationlibrary.org */
5 /* */
6 /* Copyright (c) 2005-2020, Michele Bosi */
7 /* All rights reserved. */
8 /* */
9 /* Redistribution and use in source and binary forms, with or without modification, */
10 /* are permitted provided that the following conditions are met: */
11 /* */
12 /* - Redistributions of source code must retain the above copyright notice, this */
13 /* list of conditions and the following disclaimer. */
14 /* */
15 /* - Redistributions in binary form must reproduce the above copyright notice, this */
16 /* list of conditions and the following disclaimer in the documentation and/or */
17 /* other materials provided with the distribution. */
18 /* */
19 /* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED */
21 /* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE */
22 /* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR */
23 /* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES */
24 /* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; */
25 /* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON */
26 /* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT */
27 /* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS */
28 /* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
29 /* */
30 /**************************************************************************************/
31 
32 #ifndef DiskFile_INCLUDE_ONCE
33 #define DiskFile_INCLUDE_ONCE
34 
35 #include <vlCore/VirtualFile.hpp>
36 #include <vlCore/DiskDirectory.hpp>
37 
38 #if defined(VL_PLATFORM_LINUX) || defined(VL_PLATFORM_MACOSX)
39  #include <sys/types.h>
40  #include <sys/stat.h>
41  #include <unistd.h>
42 #endif
43 
44 namespace vl
45 {
46  class DiskDirectory;
47 //---------------------------------------------------------------------------
48 // DiskFile
49 //---------------------------------------------------------------------------
65  {
67 
68  friend class DiskDirectory;
69  protected:
70  DiskFile(const DiskFile& other): VirtualFile(other) {}
71 
72  public:
73  DiskFile(const String& path = String());
74 
75  ~DiskFile();
76 
78  bool open(const String& path, EOpenMode mode);
79 
80  virtual bool open(EOpenMode mode);
81 
82  virtual bool isOpen() const;
83 
84  virtual void close();
85 
87  virtual long long size() const;
88 
89  virtual bool exists() const;
90 
91  DiskFile& operator=(const DiskFile& other) { close(); super::operator=(other); return *this; }
92 
93  virtual ref<VirtualFile> clone() const;
94 
95  protected:
96  virtual long long read_Implementation(void* buffer, long long byte_count);
97 
98  virtual long long write_Implementation(const void* buffer, long long byte_count);
99 
100  virtual long long position_Implementation() const;
101 
102  virtual bool seekSet_Implementation(long long offset);
103 
104  protected:
105  #if defined(VL_PLATFORM_WINDOWS)
106  HANDLE mHandle;
107  #else
108  FILE* mHandle;
109  #endif
110 
111  protected:
112  };
113 
114 }
115 
116 #endif
FILE * mHandle
Definition: DiskFile.hpp:108
An abstract class representing a file.
Definition: VirtualFile.hpp:60
The String class implements an advanced UTF16 (Unicode BMP) string manipulation engine.
Definition: String.hpp:62
A VirtualDirectory that operates on reguar disk directories.
#define VL_INSTRUMENT_CLASS(ClassName, BaseClass)
Definition: TypeInfo.hpp:122
DiskFile & operator=(const DiskFile &other)
Definition: DiskFile.hpp:91
Visualization Library main namespace.
A VirtualFile that operates on regular disk files.
Definition: DiskFile.hpp:64
The ref<> class is used to reference-count an Object.
Definition: Object.hpp:55