OLD | NEW |
| (Empty) |
1 /* | |
2 * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. | |
3 * | |
4 * Use of this source code is governed by a BSD-style license | |
5 * that can be found in the LICENSE file in the root of the source | |
6 * tree. An additional intellectual property rights grant can be found | |
7 * in the file PATENTS. All contributing project authors may | |
8 * be found in the AUTHORS file in the root of the source tree. | |
9 */ | |
10 | |
11 #ifndef WEBRTC_SYSTEM_WRAPPERS_INTERFACE_FILE_WRAPPER_H_ | |
12 #define WEBRTC_SYSTEM_WRAPPERS_INTERFACE_FILE_WRAPPER_H_ | |
13 | |
14 #include <stddef.h> | |
15 #include <stdio.h> | |
16 | |
17 #include "webrtc/common_types.h" | |
18 #include "webrtc/typedefs.h" | |
19 | |
20 // Implementation of an InStream and OutStream that can read (exclusive) or | |
21 // write from/to a file. | |
22 | |
23 namespace webrtc { | |
24 | |
25 class FileWrapper : public InStream, public OutStream { | |
26 public: | |
27 static const size_t kMaxFileNameSize = 1024; | |
28 | |
29 // Factory method. Constructor disabled. | |
30 static FileWrapper* Create(); | |
31 | |
32 // Returns true if a file has been opened. | |
33 virtual bool Open() const = 0; | |
34 | |
35 // Opens a file in read or write mode, decided by the read_only parameter. | |
36 virtual int OpenFile(const char* file_name_utf8, | |
37 bool read_only, | |
38 bool loop = false, | |
39 bool text = false) = 0; | |
40 | |
41 // Initializes the wrapper from an existing handle. |read_only| must match in | |
42 // the mode the file was opened in. If |manage_file| is true, the wrapper | |
43 // takes ownership of |handle| and closes it in CloseFile(). | |
44 virtual int OpenFromFileHandle(FILE* handle, | |
45 bool manage_file, | |
46 bool read_only, | |
47 bool loop = false) = 0; | |
48 | |
49 virtual int CloseFile() = 0; | |
50 | |
51 // Limits the file size to |bytes|. Writing will fail after the cap | |
52 // is hit. Pass zero to use an unlimited size. | |
53 virtual int SetMaxFileSize(size_t bytes) = 0; | |
54 | |
55 // Flush any pending writes. | |
56 virtual int Flush() = 0; | |
57 | |
58 // Returns the opened file's name in |file_name_utf8|. Provide the size of | |
59 // the buffer in bytes in |size|. The name will be truncated if |size| is | |
60 // too small. | |
61 virtual int FileName(char* file_name_utf8, | |
62 size_t size) const = 0; | |
63 | |
64 // Write |format| to the opened file. Arguments are taken in the same manner | |
65 // as printf. That is, supply a format string containing text and | |
66 // specifiers. Returns the number of characters written or -1 on error. | |
67 virtual int WriteText(const char* format, ...) = 0; | |
68 | |
69 // Inherited from both Instream and OutStream. | |
70 // Rewinds the file to the start. Only available when OpenFile() has been | |
71 // called with |loop| == true or |readOnly| == true. | |
72 // virtual int Rewind() = 0; | |
73 int Rewind() override; | |
74 }; | |
75 | |
76 } // namespace webrtc | |
77 | |
78 #endif // WEBRTC_SYSTEM_WRAPPERS_INTERFACE_FILE_WRAPPER_H_ | |
OLD | NEW |