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_COMPILER_LINKER_OUTPUT_STREAM_H_
18 #define ART_COMPILER_LINKER_OUTPUT_STREAM_H_
19 
20 #include <ostream>
21 #include <string>
22 
23 #include "base/macros.h"
24 
25 namespace art {
26 namespace linker {
27 
28 enum Whence {
29   kSeekSet = SEEK_SET,
30   kSeekCurrent = SEEK_CUR,
31   kSeekEnd = SEEK_END,
32 };
33 std::ostream& operator<<(std::ostream& os, const Whence& rhs);
34 
35 class OutputStream {
36  public:
OutputStream(const std::string & location)37   explicit OutputStream(const std::string& location) : location_(location) {}
38 
~OutputStream()39   virtual ~OutputStream() {}
40 
GetLocation()41   const std::string& GetLocation() const {
42     return location_;
43   }
44 
45   virtual bool WriteFully(const void* buffer, size_t byte_count) = 0;
46 
47   virtual off_t Seek(off_t offset, Whence whence) = 0;
48 
49   /*
50    * Flushes the stream. Returns whether the operation was successful.
51    *
52    * An OutputStream may delay reporting errors from WriteFully() or
53    * Seek(). In that case, Flush() shall report any pending error.
54    */
55   virtual bool Flush() = 0;
56 
57  private:
58   const std::string location_;
59 
60   DISALLOW_COPY_AND_ASSIGN(OutputStream);
61 };
62 
63 }  // namespace linker
64 }  // namespace art
65 
66 #endif  // ART_COMPILER_LINKER_OUTPUT_STREAM_H_
67