OLD | NEW |
1 // Copyright 2014 The Crashpad Authors. All rights reserved. | 1 // Copyright 2014 The Crashpad Authors. All rights reserved. |
2 // | 2 // |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
4 // you may not use this file except in compliance with the License. | 4 // you may not use this file except in compliance with the License. |
5 // You may obtain a copy of the License at | 5 // You may obtain a copy of the License at |
6 // | 6 // |
7 // http://www.apache.org/licenses/LICENSE-2.0 | 7 // http://www.apache.org/licenses/LICENSE-2.0 |
8 // | 8 // |
9 // Unless required by applicable law or agreed to in writing, software | 9 // Unless required by applicable law or agreed to in writing, software |
10 // distributed under the License is distributed on an "AS IS" BASIS, | 10 // distributed under the License is distributed on an "AS IS" BASIS, |
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
12 // See the License for the specific language governing permissions and | 12 // See the License for the specific language governing permissions and |
13 // limitations under the License. | 13 // limitations under the License. |
14 | 14 |
15 #ifndef CRASHPAD_UTIL_FILE_STRING_FILE_WRITER_H_ | 15 #ifndef CRASHPAD_UTIL_FILE_STRING_FILE_H_ |
16 #define CRASHPAD_UTIL_FILE_STRING_FILE_WRITER_H_ | 16 #define CRASHPAD_UTIL_FILE_STRING_FILE_H_ |
17 | 17 |
18 #include <sys/types.h> | 18 #include <sys/types.h> |
19 | 19 |
20 #include <string> | 20 #include <string> |
21 | 21 |
22 #include "base/basictypes.h" | 22 #include "base/basictypes.h" |
23 #include "base/numerics/safe_math.h" | 23 #include "base/numerics/safe_math.h" |
| 24 #include "util/file/file_reader.h" |
24 #include "util/file/file_writer.h" | 25 #include "util/file/file_writer.h" |
25 | 26 |
26 namespace crashpad { | 27 namespace crashpad { |
27 | 28 |
28 //! \brief A file writer backed by a virtual file, as opposed to a file on disk | 29 //! \brief A file reader and writer backed by a virtual file, as opposed to a |
29 //! or other operating system file descriptor-based file. | 30 //! file on disk or other operating system file descriptor-based file. |
30 //! | 31 //! |
31 //! The virtual file is a buffer in memory. This class is convenient for use | 32 //! The virtual file is a buffer in memory. This class is convenient for use |
32 //! with other code that normally expects to write files, when it is impractical | 33 //! with other code that normally expects to read or write files, when it is |
33 //! or inconvenient to write a file. It is expected that tests, in particular, | 34 //! impractical or inconvenient to read or write a file. It is expected that |
34 //! will benefit from using this class. | 35 //! tests, in particular, will benefit from using this class. |
35 class StringFileWriter : public FileWriterInterface { | 36 class StringFile : public FileReaderInterface, public FileWriterInterface { |
36 public: | 37 public: |
37 StringFileWriter(); | 38 StringFile(); |
38 ~StringFileWriter(); | 39 ~StringFile(); |
39 | 40 |
40 //! \brief Returns a string containing the virtual file’s contents. | 41 //! \brief Returns a string containing the virtual file’s contents. |
41 const std::string& string() const { return string_; } | 42 const std::string& string() const { return string_; } |
42 | 43 |
| 44 //! \brief Sets the virtual file’s contents to \a string, and resets its file |
| 45 //! position to `0`. |
| 46 void SetString(const std::string& string); |
| 47 |
43 //! \brief Resets the virtual file’s contents to be empty, and resets its file | 48 //! \brief Resets the virtual file’s contents to be empty, and resets its file |
44 //! position to `0`. | 49 //! position to `0`. |
45 void Reset(); | 50 void Reset(); |
46 | 51 |
| 52 // FileReaderInterface: |
| 53 ssize_t Read(void* data, size_t size) override; |
| 54 |
47 // FileWriterInterface: | 55 // FileWriterInterface: |
48 bool Write(const void* data, size_t size) override; | 56 bool Write(const void* data, size_t size) override; |
49 bool WriteIoVec(std::vector<WritableIoVec>* iovecs) override; | 57 bool WriteIoVec(std::vector<WritableIoVec>* iovecs) override; |
| 58 |
| 59 // FileSeekerInterface: |
50 FileOffset Seek(FileOffset offset, int whence) override; | 60 FileOffset Seek(FileOffset offset, int whence) override; |
51 | 61 |
52 private: | 62 private: |
53 //! \brief The virtual file’s contents. | 63 //! \brief The virtual file’s contents. |
54 std::string string_; | 64 std::string string_; |
55 | 65 |
56 //! \brief The file offset of the virtual file. | 66 //! \brief The file offset of the virtual file. |
57 //! | 67 //! |
58 //! \note This is stored in a `size_t` to match the characteristics of | 68 //! \note This is stored in a `size_t` to match the characteristics of |
59 //! #string_, the `std::string` used to store the virtual file’s contents. | 69 //! #string_, the `std::string` used to store the virtual file’s contents. |
60 //! This type will have different characteristics than the `off_t` used to | 70 //! This type will have different characteristics than the `off_t` used to |
61 //! report file offsets. The implementation must take care when converting | 71 //! report file offsets. The implementation must take care when converting |
62 //! between these distinct types. | 72 //! between these distinct types. |
63 base::CheckedNumeric<size_t> offset_; | 73 base::CheckedNumeric<size_t> offset_; |
64 | 74 |
65 DISALLOW_COPY_AND_ASSIGN(StringFileWriter); | 75 DISALLOW_COPY_AND_ASSIGN(StringFile); |
66 }; | 76 }; |
67 | 77 |
68 } // namespace crashpad | 78 } // namespace crashpad |
69 | 79 |
70 #endif // CRASHPAD_UTIL_FILE_STRING_FILE_WRITER_H_ | 80 #endif // CRASHPAD_UTIL_FILE_STRING_FILE_H_ |
OLD | NEW |