OLD | NEW |
1 // Copyright 2015 The Crashpad Authors. All rights reserved. | 1 // Copyright 2015 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_FILE_SEEKER_H_ | 15 #ifndef CRASHPAD_UTIL_FILE_FILE_SEEKER_H_ |
16 #define CRASHPAD_UTIL_FILE_FILE_SEEKER_H_ | 16 #define CRASHPAD_UTIL_FILE_FILE_SEEKER_H_ |
17 | 17 |
18 #include "util/file/file_io.h" | 18 #include "util/file/file_io.h" |
19 | 19 |
20 namespace crashpad { | 20 namespace crashpad { |
21 | 21 |
22 //! \brief An interface to seek in files and other file-like objects with | 22 //! \brief An interface to seek in files and other file-like objects with |
23 //! semantics matching the underlying platform (POSIX or Windows). | 23 //! semantics matching the underlying platform (POSIX or Windows). |
24 class FileSeekerInterface { | 24 class FileSeekerInterface { |
25 public: | 25 public: |
26 //! \brief Wraps LoggingFileSeek() or provides an alternate implementation | 26 //! \brief Wraps LoggingSeekFile() or provides an alternate implementation |
27 //! with identical semantics. | 27 //! with identical semantics. |
28 //! | 28 //! |
29 //! \return The return value of LoggingFileSeek(). `-1` on failure, | 29 //! \return The return value of LoggingSeekFile(). `-1` on failure, |
30 //! with an error message logged. | 30 //! with an error message logged. |
31 virtual FileOffset Seek(FileOffset offset, int whence) = 0; | 31 virtual FileOffset Seek(FileOffset offset, int whence) = 0; |
32 | 32 |
33 //! \brief Wraps Seek(), using `SEEK_CUR` to obtain the file’s current | 33 //! \brief Wraps Seek(), using `SEEK_CUR` to obtain the file’s current |
34 //! position. | 34 //! position. |
35 //! | 35 //! |
36 //! \return The file’s current position on success. `-1` on failure, with an | 36 //! \return The file’s current position on success. `-1` on failure, with an |
37 //! error message logged. | 37 //! error message logged. |
38 FileOffset SeekGet(); | 38 FileOffset SeekGet(); |
39 | 39 |
40 //! \brief Wraps Seek(), using `SEEK_SET`, ensuring that the seek succeeded | 40 //! \brief Wraps Seek(), using `SEEK_SET`, ensuring that the seek succeeded |
41 //! and the file is positioned as desired. | 41 //! and the file is positioned as desired. |
42 //! | 42 //! |
43 //! \return `true` if the operation succeeded, `false` if it failed, with an | 43 //! \return `true` if the operation succeeded, `false` if it failed, with an |
44 //! error message logged. A failure to reposition the file as desired is | 44 //! error message logged. A failure to reposition the file as desired is |
45 //! treated as a failure. | 45 //! treated as a failure. |
46 bool SeekSet(FileOffset offset); | 46 bool SeekSet(FileOffset offset); |
47 | 47 |
48 protected: | 48 protected: |
49 ~FileSeekerInterface() {} | 49 ~FileSeekerInterface() {} |
50 }; | 50 }; |
51 | 51 |
52 } // namespace crashpad | 52 } // namespace crashpad |
53 | 53 |
54 #endif // CRASHPAD_UTIL_FILE_FILE_SEEKER_H_ | 54 #endif // CRASHPAD_UTIL_FILE_FILE_SEEKER_H_ |
OLD | NEW |