Google Git
Sign in
android / platform / frameworks / base / a5eb01054b44472d32bda00066dc6ffceb9123d1 / . / tools / aapt2 / LoadedApk.h
blob: 5b6f45ebb38d2b397fa9c132d36bbfa2f76185a9 [file] [log] [blame]
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]1/*
2 * Copyright (C) 2016 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_LOADEDAPK_H
18#define AAPT_LOADEDAPK_H
19
20#include "androidfw/StringPiece.h"
21
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]22#include "ResourceTable.h"
Shane Farmer57669432017-06-19 12:52:04 -0700[diff] [blame]23#include "filter/Filter.h"
Adam Lesinski46708052017-09-29 14:49:15 -0700[diff] [blame]24#include "format/Archive.h"
25#include "format/binary/BinaryResourceParser.h"
26#include "format/binary/TableFlattener.h"
Pierre Lecesne2599aa42017-02-01 22:47:03 +0000[diff] [blame]27#include "io/ZipArchive.h"
Shane Farmer3edd4722017-09-01 14:34:22 -0700[diff] [blame]28#include "xml/XmlDom.h"
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]29
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]30namespace aapt {
31
Adam Lesinski8780eb62017-10-31 17:44:39 -0700[diff] [blame]32constexpr static const char kApkResourceTablePath[] = "resources.arsc";
33constexpr static const char kProtoResourceTablePath[] = "resources.pb";
34constexpr static const char kAndroidManifestPath[] = "AndroidManifest.xml";
35
Pierre Lecesnef267a402017-12-01 11:39:01 +0000[diff] [blame]36enum ApkFormat {
37 kUnknown,
38 kBinary,
39 kProto,
40};
41
Adam Lesinski46708052017-09-29 14:49:15 -0700[diff] [blame]42// Info about an APK loaded in memory.
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]43class LoadedApk {
44 public:
Yi Kong0556f332018-01-09 22:31:45 -0800[diff] [blame]45 virtual ~LoadedApk() = default;
46
Adam Lesinski8780eb62017-10-31 17:44:39 -0700[diff] [blame]47 // Loads both binary and proto APKs from disk.
48 static std::unique_ptr<LoadedApk> LoadApkFromPath(const ::android::StringPiece& path,
49 IDiagnostics* diag);
50
51 // Loads a proto APK from the given file collection.
52 static std::unique_ptr<LoadedApk> LoadProtoApkFromFileCollection(
53 const Source& source, std::unique_ptr<io::IFileCollection> collection, IDiagnostics* diag);
54
55 // Loads a binary APK from the given file collection.
56 static std::unique_ptr<LoadedApk> LoadBinaryApkFromFileCollection(
57 const Source& source, std::unique_ptr<io::IFileCollection> collection, IDiagnostics* diag);
58
59 LoadedApk(const Source& source, std::unique_ptr<io::IFileCollection> apk,
[email protected]f7db43e2018-03-13 12:04:10 -0400[diff] [blame]60 std::unique_ptr<ResourceTable> table, std::unique_ptr<xml::XmlResource> manifest,
61 const ApkFormat& format)
Adam Lesinski8780eb62017-10-31 17:44:39 -0700[diff] [blame]62 : source_(source),
63 apk_(std::move(apk)),
64 table_(std::move(table)),
[email protected]f7db43e2018-03-13 12:04:10 -0400[diff] [blame]65 manifest_(std::move(manifest)),
66 format_(format) {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700[diff] [blame]67 }
Adam Lesinski46708052017-09-29 14:49:15 -0700[diff] [blame]68
69 io::IFileCollection* GetFileCollection() {
70 return apk_.get();
Shane Farmer3edd4722017-09-01 14:34:22 -0700[diff] [blame]71 }
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]72
Ryan Mitchell5d275512018-07-19 14:29:00 -0700[diff] [blame]73 ApkFormat GetApkFormat() {
74 return format_;
75 }
76
Adam Lesinski8780eb62017-10-31 17:44:39 -0700[diff] [blame]77 const ResourceTable* GetResourceTable() const {
78 return table_.get();
79 }
80
Adam Lesinski46708052017-09-29 14:49:15 -0700[diff] [blame]81 ResourceTable* GetResourceTable() {
82 return table_.get();
83 }
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]84
Adam Lesinski46708052017-09-29 14:49:15 -0700[diff] [blame]85 const Source& GetSource() {
86 return source_;
87 }
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]88
Adam Lesinski8780eb62017-10-31 17:44:39 -0700[diff] [blame]89 const xml::XmlResource* GetManifest() const {
90 return manifest_.get();
91 }
92
Pierre Lecesne2599aa42017-02-01 22:47:03 +0000[diff] [blame]93 /**
94 * Writes the APK on disk at the given path, while also removing the resource
95 * files that are not referenced in the resource table.
96 */
Shane Farmer0a5b2012017-06-22 12:24:12 -0700[diff] [blame]97 virtual bool WriteToArchive(IAaptContext* context, const TableFlattenerOptions& options,
98 IArchiveWriter* writer);
Pierre Lecesne2599aa42017-02-01 22:47:03 +0000[diff] [blame]99
Shane Farmer57669432017-06-19 12:52:04 -0700[diff] [blame]100 /**
Shane Farmer3edd4722017-09-01 14:34:22 -0700[diff] [blame]101 * Writes the APK on disk at the given path, while also removing the resource files that are not
102 * referenced in the resource table. The provided filter chain is applied to each entry in the APK
103 * file.
104 *
105 * If the manifest is also provided, it will be written to the new APK file, otherwise the
106 * original manifest will be written. The manifest is only required if the contents of the new APK
107 * have been modified in a way that require the AndroidManifest.xml to also be modified.
Shane Farmer57669432017-06-19 12:52:04 -0700[diff] [blame]108 */
Shane Farmer0a5b2012017-06-22 12:24:12 -0700[diff] [blame]109 virtual bool WriteToArchive(IAaptContext* context, ResourceTable* split_table,
110 const TableFlattenerOptions& options, FilterChain* filters,
Shane Farmer3edd4722017-09-01 14:34:22 -0700[diff] [blame]111 IArchiveWriter* writer, xml::XmlResource* manifest = nullptr);
112
Ryan Mitchell5d275512018-07-19 14:29:00 -0700[diff] [blame]113 /** Loads the file as an xml document. */
Ryan Mitchellfc225b22018-08-21 14:52:51 -0700[diff] [blame]114 std::unique_ptr<xml::XmlResource> LoadXml(const std::string& file_path, IDiagnostics* diag) const;
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]115
116 private:
Adam Lesinski46708052017-09-29 14:49:15 -0700[diff] [blame]117 DISALLOW_COPY_AND_ASSIGN(LoadedApk);
118
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]119 Source source_;
120 std::unique_ptr<io::IFileCollection> apk_;
121 std::unique_ptr<ResourceTable> table_;
Adam Lesinski8780eb62017-10-31 17:44:39 -0700[diff] [blame]122 std::unique_ptr<xml::XmlResource> manifest_;
[email protected]f7db43e2018-03-13 12:04:10 -0400[diff] [blame]123 ApkFormat format_;
Pierre Lecesneff759e62017-02-01 00:29:25 +0000[diff] [blame]124};
125
126} // namespace aapt
127
128#endif /* AAPT_LOADEDAPK_H */