file.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 #pragma once
30 
31 #include "iodevice.h"
32 #include "../System/databuffer.h"
33 
34 namespace clan
35 {
38 
40  class File : public IODevice
41  {
42  public:
44  static std::string read_text(const std::string &filename);
45 
47  static DataBuffer read_bytes(const std::string &filename);
48 
50  static void write_text(const std::string &filename, const std::string &text, bool write_bom = false);
51 
53  static void write_bytes(const std::string &filename, const DataBuffer &bytes);
54 
56 
58  {
61 
64 
67  };
68 
71  {
74 
77 
80 
83  };
84 
86  enum OpenMode
87  {
90 
93 
96 
99 
102  };
103 
105  enum Flags
106  {
111  };
112 
114  File();
115 
119  File(
120  const std::string &filename);
121 
125  File(
126  const std::string &filename,
127  OpenMode mode,
128  unsigned int access,
129  unsigned int share = share_all,
130  unsigned int flags = 0);
131 
132  ~File();
133 
137  bool open(
138  const std::string &filename);
139 
143  bool open(
144  const std::string &filename,
145  OpenMode mode,
146  unsigned int access,
147  unsigned int share = share_all,
148  unsigned int flags = 0);
149 
151  void close();
152 
153  private:
154  };
155 
157 }
Definition: clanapp.h:35
Generic write access.
Definition: file.h:63
Definition: file.h:110
void close()
Close file.
I/O Device interface.
Definition: iodevice.h:49
Generic read write access.
Definition: file.h:66
Flags
Optimization Flags.
Definition: file.h:105
Open existing file and truncate it.
Definition: file.h:95
Allow others to delete the file.
Definition: file.h:79
static DataBuffer read_bytes(const std::string &filename)
Loads an file into a byte buffer.
ShareFlags
File sharing flags.
Definition: file.h:70
Allow others to open the file for reading.
Definition: file.h:73
bool open(const std::string &filename)
Opens a file read only.
File I/O device.
Definition: file.h:40
Generic read access.
Definition: file.h:60
Create a new file. Fails if it already exists.
Definition: file.h:101
static void write_bytes(const std::string &filename, const DataBuffer &bytes)
Saves a byte buffer to file.
Open existing file. Fails if it does not exist.
Definition: file.h:92
All other sharing flags combined.
Definition: file.h:82
Definition: file.h:108
Allow others to open the file for writing.
Definition: file.h:76
Definition: file.h:109
Open file or create it if it does not exist.
Definition: file.h:89
static std::string read_text(const std::string &filename)
Loads an UTF-8 text file into a string.
File()
Constructs a file object.
OpenMode
File opening modes.
Definition: file.h:86
Create file, even if it already exists.
Definition: file.h:98
General purpose data buffer.
Definition: databuffer.h:41
Definition: file.h:107
static void write_text(const std::string &filename, const std::string &text, bool write_bom=false)
Saves an UTF-8 text string to file.
AccessFlags
Access flags.
Definition: file.h:57