xref: /aosp_15_r20/frameworks/base/tools/aapt2/io/Util.h (revision d57664e9bc4670b3ecf6748a746a57c557b6bc9e)
1*d57664e9SAndroid Build Coastguard Worker /*
2*d57664e9SAndroid Build Coastguard Worker  * Copyright (C) 2017 The Android Open Source Project
3*d57664e9SAndroid Build Coastguard Worker  *
4*d57664e9SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*d57664e9SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*d57664e9SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*d57664e9SAndroid Build Coastguard Worker  *
8*d57664e9SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*d57664e9SAndroid Build Coastguard Worker  *
10*d57664e9SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*d57664e9SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*d57664e9SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*d57664e9SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*d57664e9SAndroid Build Coastguard Worker  * limitations under the License.
15*d57664e9SAndroid Build Coastguard Worker  */
16*d57664e9SAndroid Build Coastguard Worker 
17*d57664e9SAndroid Build Coastguard Worker #ifndef AAPT_IO_UTIL_H
18*d57664e9SAndroid Build Coastguard Worker #define AAPT_IO_UTIL_H
19*d57664e9SAndroid Build Coastguard Worker 
20*d57664e9SAndroid Build Coastguard Worker #include <string_view>
21*d57664e9SAndroid Build Coastguard Worker 
22*d57664e9SAndroid Build Coastguard Worker #include "androidfw/Streams.h"
23*d57664e9SAndroid Build Coastguard Worker #include "format/Archive.h"
24*d57664e9SAndroid Build Coastguard Worker #include "google/protobuf/io/coded_stream.h"
25*d57664e9SAndroid Build Coastguard Worker #include "google/protobuf/message.h"
26*d57664e9SAndroid Build Coastguard Worker #include "io/File.h"
27*d57664e9SAndroid Build Coastguard Worker #include "process/IResourceTableConsumer.h"
28*d57664e9SAndroid Build Coastguard Worker 
29*d57664e9SAndroid Build Coastguard Worker namespace aapt {
30*d57664e9SAndroid Build Coastguard Worker namespace io {
31*d57664e9SAndroid Build Coastguard Worker 
32*d57664e9SAndroid Build Coastguard Worker bool CopyInputStreamToArchive(IAaptContext* context, android::InputStream* in,
33*d57664e9SAndroid Build Coastguard Worker                               std::string_view out_path, uint32_t compression_flags,
34*d57664e9SAndroid Build Coastguard Worker                               IArchiveWriter* writer);
35*d57664e9SAndroid Build Coastguard Worker 
36*d57664e9SAndroid Build Coastguard Worker bool CopyFileToArchive(IAaptContext* context, IFile* file, std::string_view out_path,
37*d57664e9SAndroid Build Coastguard Worker                        uint32_t compression_flags, IArchiveWriter* writer);
38*d57664e9SAndroid Build Coastguard Worker 
39*d57664e9SAndroid Build Coastguard Worker bool CopyFileToArchivePreserveCompression(IAaptContext* context, IFile* file,
40*d57664e9SAndroid Build Coastguard Worker                                           std::string_view out_path, IArchiveWriter* writer);
41*d57664e9SAndroid Build Coastguard Worker 
42*d57664e9SAndroid Build Coastguard Worker bool CopyProtoToArchive(IAaptContext* context, ::google::protobuf::Message* proto_msg,
43*d57664e9SAndroid Build Coastguard Worker                         std::string_view out_path, uint32_t compression_flags,
44*d57664e9SAndroid Build Coastguard Worker                         IArchiveWriter* writer);
45*d57664e9SAndroid Build Coastguard Worker 
46*d57664e9SAndroid Build Coastguard Worker // Copies the data from in to out. Returns false if there was an error.
47*d57664e9SAndroid Build Coastguard Worker // If there was an error, check the individual streams' HadError/GetError methods.
48*d57664e9SAndroid Build Coastguard Worker bool Copy(android::OutputStream* out, android::InputStream* in);
49*d57664e9SAndroid Build Coastguard Worker bool Copy(android::OutputStream* out, android::StringPiece in);
50*d57664e9SAndroid Build Coastguard Worker bool Copy(::google::protobuf::io::ZeroCopyOutputStream* out, android::InputStream* in);
51*d57664e9SAndroid Build Coastguard Worker 
52*d57664e9SAndroid Build Coastguard Worker class OutputStreamAdaptor : public android::OutputStream {
53*d57664e9SAndroid Build Coastguard Worker  public:
OutputStreamAdaptor(::google::protobuf::io::ZeroCopyOutputStream * out)54*d57664e9SAndroid Build Coastguard Worker   explicit OutputStreamAdaptor(::google::protobuf::io::ZeroCopyOutputStream* out) : out_(out) {
55*d57664e9SAndroid Build Coastguard Worker   }
56*d57664e9SAndroid Build Coastguard Worker 
Next(void ** data,size_t * size)57*d57664e9SAndroid Build Coastguard Worker   bool Next(void** data, size_t* size) override {
58*d57664e9SAndroid Build Coastguard Worker     int out_size;
59*d57664e9SAndroid Build Coastguard Worker     bool result = out_->Next(data, &out_size);
60*d57664e9SAndroid Build Coastguard Worker     *size = static_cast<size_t>(out_size);
61*d57664e9SAndroid Build Coastguard Worker     if (!result) {
62*d57664e9SAndroid Build Coastguard Worker       error_ocurred_ = true;
63*d57664e9SAndroid Build Coastguard Worker     }
64*d57664e9SAndroid Build Coastguard Worker     return result;
65*d57664e9SAndroid Build Coastguard Worker   }
66*d57664e9SAndroid Build Coastguard Worker 
BackUp(size_t count)67*d57664e9SAndroid Build Coastguard Worker   void BackUp(size_t count) override {
68*d57664e9SAndroid Build Coastguard Worker     out_->BackUp(static_cast<int>(count));
69*d57664e9SAndroid Build Coastguard Worker   }
70*d57664e9SAndroid Build Coastguard Worker 
ByteCount()71*d57664e9SAndroid Build Coastguard Worker   size_t ByteCount() const override {
72*d57664e9SAndroid Build Coastguard Worker     return static_cast<size_t>(out_->ByteCount());
73*d57664e9SAndroid Build Coastguard Worker   }
74*d57664e9SAndroid Build Coastguard Worker 
HadError()75*d57664e9SAndroid Build Coastguard Worker   bool HadError() const override {
76*d57664e9SAndroid Build Coastguard Worker     return error_ocurred_;
77*d57664e9SAndroid Build Coastguard Worker   }
78*d57664e9SAndroid Build Coastguard Worker 
79*d57664e9SAndroid Build Coastguard Worker  private:
80*d57664e9SAndroid Build Coastguard Worker   DISALLOW_COPY_AND_ASSIGN(OutputStreamAdaptor);
81*d57664e9SAndroid Build Coastguard Worker 
82*d57664e9SAndroid Build Coastguard Worker   ::google::protobuf::io::ZeroCopyOutputStream* out_;
83*d57664e9SAndroid Build Coastguard Worker   bool error_ocurred_ = false;
84*d57664e9SAndroid Build Coastguard Worker };
85*d57664e9SAndroid Build Coastguard Worker 
86*d57664e9SAndroid Build Coastguard Worker class ZeroCopyInputAdaptor : public ::google::protobuf::io::ZeroCopyInputStream {
87*d57664e9SAndroid Build Coastguard Worker  public:
ZeroCopyInputAdaptor(android::InputStream * in)88*d57664e9SAndroid Build Coastguard Worker   explicit ZeroCopyInputAdaptor(android::InputStream* in) : in_(in) {
89*d57664e9SAndroid Build Coastguard Worker   }
90*d57664e9SAndroid Build Coastguard Worker 
Next(const void ** data,int * size)91*d57664e9SAndroid Build Coastguard Worker   bool Next(const void** data, int* size) override {
92*d57664e9SAndroid Build Coastguard Worker     size_t out_size;
93*d57664e9SAndroid Build Coastguard Worker     bool result = in_->Next(data, &out_size);
94*d57664e9SAndroid Build Coastguard Worker     *size = static_cast<int>(out_size);
95*d57664e9SAndroid Build Coastguard Worker     return result;
96*d57664e9SAndroid Build Coastguard Worker   }
97*d57664e9SAndroid Build Coastguard Worker 
BackUp(int count)98*d57664e9SAndroid Build Coastguard Worker   void BackUp(int count) override {
99*d57664e9SAndroid Build Coastguard Worker     in_->BackUp(static_cast<size_t>(count));
100*d57664e9SAndroid Build Coastguard Worker   }
101*d57664e9SAndroid Build Coastguard Worker 
Skip(int count)102*d57664e9SAndroid Build Coastguard Worker   bool Skip(int count) override {
103*d57664e9SAndroid Build Coastguard Worker     const void* data;
104*d57664e9SAndroid Build Coastguard Worker     int size;
105*d57664e9SAndroid Build Coastguard Worker     while (Next(&data, &size)) {
106*d57664e9SAndroid Build Coastguard Worker       if (size > count) {
107*d57664e9SAndroid Build Coastguard Worker         BackUp(size - count);
108*d57664e9SAndroid Build Coastguard Worker         return true;
109*d57664e9SAndroid Build Coastguard Worker       } else {
110*d57664e9SAndroid Build Coastguard Worker         count -= size;
111*d57664e9SAndroid Build Coastguard Worker       }
112*d57664e9SAndroid Build Coastguard Worker     }
113*d57664e9SAndroid Build Coastguard Worker     return false;
114*d57664e9SAndroid Build Coastguard Worker   }
115*d57664e9SAndroid Build Coastguard Worker 
ByteCount()116*d57664e9SAndroid Build Coastguard Worker   ::google::protobuf::int64 ByteCount() const override {
117*d57664e9SAndroid Build Coastguard Worker     return static_cast<::google::protobuf::int64>(in_->ByteCount());
118*d57664e9SAndroid Build Coastguard Worker   }
119*d57664e9SAndroid Build Coastguard Worker 
120*d57664e9SAndroid Build Coastguard Worker  private:
121*d57664e9SAndroid Build Coastguard Worker   DISALLOW_COPY_AND_ASSIGN(ZeroCopyInputAdaptor);
122*d57664e9SAndroid Build Coastguard Worker 
123*d57664e9SAndroid Build Coastguard Worker   android::InputStream* in_;
124*d57664e9SAndroid Build Coastguard Worker };
125*d57664e9SAndroid Build Coastguard Worker 
126*d57664e9SAndroid Build Coastguard Worker class ProtoInputStreamReader {
127*d57664e9SAndroid Build Coastguard Worker  public:
ProtoInputStreamReader(android::InputStream * in)128*d57664e9SAndroid Build Coastguard Worker   explicit ProtoInputStreamReader(android::InputStream* in) : in_(in) {
129*d57664e9SAndroid Build Coastguard Worker   }
130*d57664e9SAndroid Build Coastguard Worker 
131*d57664e9SAndroid Build Coastguard Worker   /** Deserializes a Message proto from the current position in the input stream.*/
ReadMessage(T * message)132*d57664e9SAndroid Build Coastguard Worker   template <typename T> bool ReadMessage(T *message) {
133*d57664e9SAndroid Build Coastguard Worker     ZeroCopyInputAdaptor adapter(in_);
134*d57664e9SAndroid Build Coastguard Worker     google::protobuf::io::CodedInputStream coded_stream(&adapter);
135*d57664e9SAndroid Build Coastguard Worker     coded_stream.SetTotalBytesLimit(std::numeric_limits<int32_t>::max());
136*d57664e9SAndroid Build Coastguard Worker     return message->ParseFromCodedStream(&coded_stream);
137*d57664e9SAndroid Build Coastguard Worker   }
138*d57664e9SAndroid Build Coastguard Worker 
139*d57664e9SAndroid Build Coastguard Worker  private:
140*d57664e9SAndroid Build Coastguard Worker   android::InputStream* in_;
141*d57664e9SAndroid Build Coastguard Worker };
142*d57664e9SAndroid Build Coastguard Worker 
143*d57664e9SAndroid Build Coastguard Worker }  // namespace io
144*d57664e9SAndroid Build Coastguard Worker }  // namespace aapt
145*d57664e9SAndroid Build Coastguard Worker 
146*d57664e9SAndroid Build Coastguard Worker #endif /* AAPT_IO_UTIL_H */
147