1 /*
2  * Copyright (C) 2013 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_LIBELFFILE_STREAM_OUTPUT_STREAM_H_
18 #define ART_LIBELFFILE_STREAM_OUTPUT_STREAM_H_
19 
20 #include <ostream>
21 #include <string>
22 
23 #include "base/macros.h"
24 
25 namespace art {
26 
27 enum Whence {
28   kSeekSet = SEEK_SET,
29   kSeekCurrent = SEEK_CUR,
30   kSeekEnd = SEEK_END,
31 };
32 std::ostream& operator<<(std::ostream& os, const Whence& rhs);
33 
34 class OutputStream {
35  public:
OutputStream(const std::string & location)36   explicit OutputStream(const std::string& location) : location_(location) {}
37 
~OutputStream()38   virtual ~OutputStream() {}
39 
GetLocation()40   const std::string& GetLocation() const {
41     return location_;
42   }
43 
44   virtual bool WriteFully(const void* buffer, size_t byte_count) = 0;
45 
46   virtual off_t Seek(off_t offset, Whence whence) = 0;
47 
48   /*
49    * Flushes the stream. Returns whether the operation was successful.
50    *
51    * An OutputStream may delay reporting errors from WriteFully() or
52    * Seek(). In that case, Flush() shall report any pending error.
53    */
54   virtual bool Flush() = 0;
55 
56  private:
57   const std::string location_;
58 
59   DISALLOW_COPY_AND_ASSIGN(OutputStream);
60 };
61 
62 }  // namespace art
63 
64 #endif  // ART_LIBELFFILE_STREAM_OUTPUT_STREAM_H_
65