blob: 56c74e326e6c8813c220bf31cc4b75beaaade9eb [file] [log] [blame]
Adam Lesinskia40e9722015-11-24 19:11:46 -08001/*
2 * Copyright (C) 2015 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 AAPT_IO_ZIPARCHIVE_H
18#define AAPT_IO_ZIPARCHIVE_H
19
Adam Lesinskice5e56e2016-10-21 17:56:45 -070020#include "ziparchive/zip_archive.h"
21
22#include <map>
23
Adam Lesinskid5083f62017-01-16 15:07:21 -080024#include "androidfw/StringPiece.h"
25
Adam Lesinskia40e9722015-11-24 19:11:46 -080026#include "io/File.h"
Adam Lesinskia40e9722015-11-24 19:11:46 -080027
Adam Lesinskia40e9722015-11-24 19:11:46 -080028namespace aapt {
29namespace io {
30
31/**
Adam Lesinskicacb28f2016-10-19 12:18:14 -070032 * An IFile representing a file within a ZIP archive. If the file is compressed,
33 * it is uncompressed
34 * and copied into memory when opened. Otherwise it is mmapped from the ZIP
35 * archive.
Adam Lesinskia40e9722015-11-24 19:11:46 -080036 */
37class ZipFile : public IFile {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070038 public:
39 ZipFile(ZipArchiveHandle handle, const ZipEntry& entry, const Source& source);
Adam Lesinskia40e9722015-11-24 19:11:46 -080040
Adam Lesinskice5e56e2016-10-21 17:56:45 -070041 std::unique_ptr<IData> OpenAsData() override;
42 const Source& GetSource() const override;
Pierre Lecesne970732d2017-02-02 23:13:58 +000043 bool WasCompressed() override;
Adam Lesinskia40e9722015-11-24 19:11:46 -080044
Adam Lesinskicacb28f2016-10-19 12:18:14 -070045 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -070046 ZipArchiveHandle zip_handle_;
47 ZipEntry zip_entry_;
48 Source source_;
Adam Lesinskia40e9722015-11-24 19:11:46 -080049};
50
Adam Lesinskia6fe3452015-12-09 15:20:52 -080051class ZipFileCollection;
52
53class ZipFileCollectionIterator : public IFileCollectionIterator {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070054 public:
55 explicit ZipFileCollectionIterator(ZipFileCollection* collection);
Adam Lesinskia6fe3452015-12-09 15:20:52 -080056
Adam Lesinskice5e56e2016-10-21 17:56:45 -070057 bool HasNext() override;
58 io::IFile* Next() override;
Adam Lesinskia6fe3452015-12-09 15:20:52 -080059
Adam Lesinskicacb28f2016-10-19 12:18:14 -070060 private:
Pierre Lecesne880d65b2017-02-02 22:33:17 +000061 std::vector<std::unique_ptr<IFile>>::const_iterator current_, end_;
Adam Lesinskia6fe3452015-12-09 15:20:52 -080062};
63
Adam Lesinskia40e9722015-11-24 19:11:46 -080064/**
65 * An IFileCollection that represents a ZIP archive and the entries within it.
66 */
67class ZipFileCollection : public IFileCollection {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070068 public:
Adam Lesinskid5083f62017-01-16 15:07:21 -080069 static std::unique_ptr<ZipFileCollection> Create(const android::StringPiece& path,
Adam Lesinskicacb28f2016-10-19 12:18:14 -070070 std::string* outError);
Adam Lesinskia40e9722015-11-24 19:11:46 -080071
Adam Lesinskid5083f62017-01-16 15:07:21 -080072 io::IFile* FindFile(const android::StringPiece& path) override;
Adam Lesinskice5e56e2016-10-21 17:56:45 -070073 std::unique_ptr<IFileCollectionIterator> Iterator() override;
Adam Lesinskia40e9722015-11-24 19:11:46 -080074
Adam Lesinskicacb28f2016-10-19 12:18:14 -070075 ~ZipFileCollection() override;
Adam Lesinskia40e9722015-11-24 19:11:46 -080076
Adam Lesinskicacb28f2016-10-19 12:18:14 -070077 private:
78 friend class ZipFileCollectionIterator;
79 ZipFileCollection();
Adam Lesinskia40e9722015-11-24 19:11:46 -080080
Adam Lesinskice5e56e2016-10-21 17:56:45 -070081 ZipArchiveHandle handle_;
Pierre Lecesne880d65b2017-02-02 22:33:17 +000082 std::vector<std::unique_ptr<IFile>> files_;
83 std::map<std::string, IFile*> files_by_name_;
Adam Lesinskia40e9722015-11-24 19:11:46 -080084};
85
Adam Lesinskicacb28f2016-10-19 12:18:14 -070086} // namespace io
87} // namespace aapt
Adam Lesinskia40e9722015-11-24 19:11:46 -080088
89#endif /* AAPT_IO_ZIPARCHIVE_H */