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_H_ | 15 #ifndef CRASHPAD_UTIL_FILE_STRING_FILE_H_ |
16 #define CRASHPAD_UTIL_FILE_STRING_FILE_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_io.h" |
24 #include "util/file/file_reader.h" | 25 #include "util/file/file_reader.h" |
25 #include "util/file/file_writer.h" | 26 #include "util/file/file_writer.h" |
26 | 27 |
27 namespace crashpad { | 28 namespace crashpad { |
28 | 29 |
29 //! \brief A file reader and writer backed by a virtual file, as opposed to a | 30 //! \brief A file reader and writer backed by a virtual file, as opposed to a |
30 //! file on disk or other operating system file descriptor-based file. | 31 //! file on disk or other operating system file descriptor-based file. |
31 //! | 32 //! |
32 //! The virtual file is a buffer in memory. This class is convenient for use | 33 //! The virtual file is a buffer in memory. This class is convenient for use |
33 //! with other code that normally expects to read or write files, when it is | 34 //! with other code that normally expects to read or write files, when it is |
34 //! impractical or inconvenient to read or write a file. It is expected that | 35 //! impractical or inconvenient to read or write a file. It is expected that |
35 //! tests, in particular, will benefit from using this class. | 36 //! tests, in particular, will benefit from using this class. |
36 class StringFile : public FileReaderInterface, public FileWriterInterface { | 37 class StringFile : public FileReaderInterface, public FileWriterInterface { |
37 public: | 38 public: |
38 StringFile(); | 39 StringFile(); |
39 ~StringFile() override; | 40 ~StringFile() override; |
40 | 41 |
41 //! \brief Returns a string containing the virtual file’s contents. | 42 //! \brief Returns a string containing the virtual file’s contents. |
42 const std::string& string() const { return string_; } | 43 const std::string& string() const { return string_; } |
43 | 44 |
44 //! \brief Sets the virtual file’s contents to \a string, and resets its file | 45 //! \brief Sets the virtual file’s contents to \a string, and resets its file |
45 //! position to `0`. | 46 //! position to `0`. |
46 void SetString(const std::string& string); | 47 void SetString(const std::string& string); |
47 | 48 |
48 //! \brief Resets the virtual file’s contents to be empty, and resets its file | 49 //! \brief Resets the virtual file’s contents to be empty, and resets its file |
49 //! position to `0`. | 50 //! position to `0`. |
50 void Reset(); | 51 void Reset(); |
51 | 52 |
52 // FileReaderInterface: | 53 // FileReaderInterface: |
53 ssize_t Read(void* data, size_t size) override; | 54 FileOperationResult Read(void* data, size_t size) override; |
54 | 55 |
55 // FileWriterInterface: | 56 // FileWriterInterface: |
56 bool Write(const void* data, size_t size) override; | 57 bool Write(const void* data, size_t size) override; |
57 bool WriteIoVec(std::vector<WritableIoVec>* iovecs) override; | 58 bool WriteIoVec(std::vector<WritableIoVec>* iovecs) override; |
58 | 59 |
59 // FileSeekerInterface: | 60 // FileSeekerInterface: |
60 FileOffset Seek(FileOffset offset, int whence) override; | 61 FileOffset Seek(FileOffset offset, int whence) override; |
61 | 62 |
62 private: | 63 private: |
63 //! \brief The virtual file’s contents. | 64 //! \brief The virtual file’s contents. |
64 std::string string_; | 65 std::string string_; |
65 | 66 |
66 //! \brief The file offset of the virtual file. | 67 //! \brief The file offset of the virtual file. |
67 //! | 68 //! |
68 //! \note This is stored in a `size_t` to match the characteristics of | 69 //! \note This is stored in a `size_t` to match the characteristics of |
69 //! #string_, the `std::string` used to store the virtual file’s contents. | 70 //! #string_, the `std::string` used to store the virtual file’s contents. |
70 //! This type will have different characteristics than the `off_t` used to | 71 //! This type will have different characteristics than the `off_t` used to |
71 //! report file offsets. The implementation must take care when converting | 72 //! report file offsets. The implementation must take care when converting |
72 //! between these distinct types. | 73 //! between these distinct types. |
73 base::CheckedNumeric<size_t> offset_; | 74 base::CheckedNumeric<size_t> offset_; |
74 | 75 |
75 DISALLOW_COPY_AND_ASSIGN(StringFile); | 76 DISALLOW_COPY_AND_ASSIGN(StringFile); |
76 }; | 77 }; |
77 | 78 |
78 } // namespace crashpad | 79 } // namespace crashpad |
79 | 80 |
80 #endif // CRASHPAD_UTIL_FILE_STRING_FILE_H_ | 81 #endif // CRASHPAD_UTIL_FILE_STRING_FILE_H_ |
OLD | NEW |