1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "AppInfo.h"
#include "Debug.h"
#include "Flags.h"
#include "Locale.h"
#include "NameMangler.h"
#include "ResourceUtils.h"
#include "compile/IdAssigner.h"
#include "filter/ConfigFilter.h"
#include "flatten/Archive.h"
#include "flatten/TableFlattener.h"
#include "flatten/XmlFlattener.h"
#include "io/FileSystem.h"
#include "io/ZipArchive.h"
#include "java/JavaClassGenerator.h"
#include "java/ManifestClassGenerator.h"
#include "java/ProguardRules.h"
#include "link/Linkers.h"
#include "link/ProductFilter.h"
#include "link/ReferenceLinker.h"
#include "link/ManifestFixer.h"
#include "link/TableMerger.h"
#include "process/IResourceTableConsumer.h"
#include "process/SymbolTable.h"
#include "proto/ProtoSerialize.h"
#include "split/TableSplitter.h"
#include "unflatten/BinaryResourceParser.h"
#include "util/Files.h"
#include "util/StringPiece.h"
#include "xml/XmlDom.h"
#include <google/protobuf/io/coded_stream.h>
#include <fstream>
#include <sys/stat.h>
#include <vector>
namespace aapt {
struct LinkOptions {
std::string outputPath;
std::string manifestPath;
std::vector<std::string> includePaths;
std::vector<std::string> overlayFiles;
Maybe<std::string> generateJavaClassPath;
Maybe<std::u16string> customJavaPackage;
std::set<std::u16string> extraJavaPackages;
Maybe<std::string> generateProguardRulesPath;
bool noAutoVersion = false;
bool noVersionVectors = false;
bool staticLib = false;
bool noStaticLibPackages = false;
bool generateNonFinalIds = false;
std::vector<std::string> javadocAnnotations;
bool outputToDirectory = false;
bool autoAddOverlay = false;
bool doNotCompressAnything = false;
std::vector<std::string> extensionsToNotCompress;
Maybe<std::u16string> privateSymbols;
ManifestFixerOptions manifestFixerOptions;
std::unordered_set<std::string> products;
TableSplitterOptions tableSplitterOptions;
};
class LinkContext : public IAaptContext {
public:
LinkContext() : mNameMangler({}) {
}
IDiagnostics* getDiagnostics() override {
return &mDiagnostics;
}
NameMangler* getNameMangler() override {
return &mNameMangler;
}
void setNameManglerPolicy(const NameManglerPolicy& policy) {
mNameMangler = NameMangler(policy);
}
const std::u16string& getCompilationPackage() override {
return mCompilationPackage;
}
void setCompilationPackage(const StringPiece16& packageName) {
mCompilationPackage = packageName.toString();
}
uint8_t getPackageId() override {
return mPackageId;
}
void setPackageId(uint8_t id) {
mPackageId = id;
}
SymbolTable* getExternalSymbols() override {
return &mSymbols;
}
bool verbose() override {
return mVerbose;
}
void setVerbose(bool val) {
mVerbose = val;
}
private:
StdErrDiagnostics mDiagnostics;
NameMangler mNameMangler;
std::u16string mCompilationPackage;
uint8_t mPackageId = 0x0;
SymbolTable mSymbols;
bool mVerbose = false;
};
static bool copyFileToArchive(io::IFile* file, const std::string& outPath,
uint32_t compressionFlags,
IArchiveWriter* writer, IAaptContext* context) {
std::unique_ptr<io::IData> data = file->openAsData();
if (!data) {
context->getDiagnostics()->error(DiagMessage(file->getSource())
<< "failed to open file");
return false;
}
const uint8_t* buffer = reinterpret_cast<const uint8_t*>(data->data());
size_t bufferSize = data->size();
// If the file ends with .flat, we must strip off the CompiledFileHeader from it.
if (util::stringEndsWith<char>(file->getSource().path, ".flat")) {
CompiledFileInputStream inputStream(data->data(), data->size());
if (!inputStream.CompiledFile()) {
context->getDiagnostics()->error(DiagMessage(file->getSource())
<< "invalid compiled file header");
return false;
}
buffer = reinterpret_cast<const uint8_t*>(inputStream.data());
bufferSize = inputStream.size();
}
if (context->verbose()) {
context->getDiagnostics()->note(DiagMessage() << "writing " << outPath << " to archive");
}
if (writer->startEntry(outPath, compressionFlags)) {
if (writer->writeEntry(buffer, bufferSize)) {
if (writer->finishEntry()) {
return true;
}
}
}
context->getDiagnostics()->error(DiagMessage() << "failed to write file " << outPath);
return false;
}
static bool flattenXml(xml::XmlResource* xmlRes, const StringPiece& path, Maybe<size_t> maxSdkLevel,
bool keepRawValues, IArchiveWriter* writer, IAaptContext* context) {
BigBuffer buffer(1024);
XmlFlattenerOptions options = {};
options.keepRawValues = keepRawValues;
options.maxSdkLevel = maxSdkLevel;
XmlFlattener flattener(&buffer, options);
if (!flattener.consume(context, xmlRes)) {
return false;
}
if (context->verbose()) {
DiagMessage msg;
msg << "writing " << path << " to archive";
if (maxSdkLevel) {
msg << " maxSdkLevel=" << maxSdkLevel.value() << " keepRawValues=" << keepRawValues;
}
context->getDiagnostics()->note(msg);
}
if (writer->startEntry(path, ArchiveEntry::kCompress)) {
if (writer->writeEntry(buffer)) {
if (writer->finishEntry()) {
return true;
}
}
}
context->getDiagnostics()->error(DiagMessage() << "failed to write " << path << " to archive");
return false;
}
/*static std::unique_ptr<ResourceTable> loadTable(const Source& source, const void* data, size_t len,
IDiagnostics* diag) {
std::unique_ptr<ResourceTable> table = util::make_unique<ResourceTable>();
BinaryResourceParser parser(diag, table.get(), source, data, len);
if (!parser.parse()) {
return {};
}
return table;
}*/
static std::unique_ptr<ResourceTable> loadTableFromPb(const Source& source,
const void* data, size_t len,
IDiagnostics* diag) {
pb::ResourceTable pbTable;
if (!pbTable.ParseFromArray(data, len)) {
diag->error(DiagMessage(source) << "invalid compiled table");
return {};
}
std::unique_ptr<ResourceTable> table = deserializeTableFromPb(pbTable, source, diag);
if (!table) {
return {};
}
return table;
}
/**
* Inflates an XML file from the source path.
*/
static std::unique_ptr<xml::XmlResource> loadXml(const std::string& path, IDiagnostics* diag) {
std::ifstream fin(path, std::ifstream::binary);
if (!fin) {
diag->error(DiagMessage(path) << strerror(errno));
return {};
}
return xml::inflate(&fin, diag, Source(path));
}
static std::unique_ptr<xml::XmlResource> loadBinaryXmlSkipFileExport(const Source& source,
const void* data, size_t len,
IDiagnostics* diag) {
CompiledFileInputStream inputStream(data, len);
if (!inputStream.CompiledFile()) {
diag->error(DiagMessage(source) << "invalid compiled file header");
return {};
}
const uint8_t* xmlData = reinterpret_cast<const uint8_t*>(inputStream.data());
const size_t xmlDataLen = inputStream.size();
std::unique_ptr<xml::XmlResource> xmlRes = xml::inflate(xmlData, xmlDataLen, diag, source);
if (!xmlRes) {
return {};
}
return xmlRes;
}
static std::unique_ptr<ResourceFile> loadFileExportHeader(const Source& source,
const void* data, size_t len,
IDiagnostics* diag) {
CompiledFileInputStream inputStream(data, len);
const pb::CompiledFile* pbFile = inputStream.CompiledFile();
if (!pbFile) {
diag->error(DiagMessage(source) << "invalid compiled file header");
return {};
}
std::unique_ptr<ResourceFile> resFile = deserializeCompiledFileFromPb(*pbFile, source, diag);
if (!resFile) {
return {};
}
return resFile;
}
struct ResourceFileFlattenerOptions {
bool noAutoVersion = false;
bool noVersionVectors = false;
bool keepRawValues = false;
bool doNotCompressAnything = false;
std::vector<std::string> extensionsToNotCompress;
};
class ResourceFileFlattener {
public:
ResourceFileFlattener(const ResourceFileFlattenerOptions& options,
IAaptContext* context, proguard::KeepSet* keepSet) :
mOptions(options), mContext(context), mKeepSet(keepSet) {
}
bool flatten(ResourceTable* table, IArchiveWriter* archiveWriter);
private:
struct FileOperation {
io::IFile* fileToCopy;
std::unique_ptr<xml::XmlResource> xmlToFlatten;
std::string dstPath;
bool skipVersion = false;
};
uint32_t getCompressionFlags(const StringPiece& str);
bool linkAndVersionXmlFile(const ResourceEntry* entry, const ResourceFile& fileDesc,
io::IFile* file, ResourceTable* table, FileOperation* outFileOp);
ResourceFileFlattenerOptions mOptions;
IAaptContext* mContext;
proguard::KeepSet* mKeepSet;
};
uint32_t ResourceFileFlattener::getCompressionFlags(const StringPiece& str) {
if (mOptions.doNotCompressAnything) {
return 0;
}
for (const std::string& extension : mOptions.extensionsToNotCompress) {
if (util::stringEndsWith<char>(str, extension)) {
return 0;
}
}
return ArchiveEntry::kCompress;
}
bool ResourceFileFlattener::linkAndVersionXmlFile(const ResourceEntry* entry,
const ResourceFile& fileDesc,
io::IFile* file,
ResourceTable* table,
FileOperation* outFileOp) {
const StringPiece srcPath = file->getSource().path;
if (mContext->verbose()) {
mContext->getDiagnostics()->note(DiagMessage() << "linking " << srcPath);
}
std::unique_ptr<io::IData> data = file->openAsData();
if (!data) {
mContext->getDiagnostics()->error(DiagMessage(file->getSource()) << "failed to open file");
return false;
}
if (util::stringEndsWith<char>(srcPath, ".flat")) {
outFileOp->xmlToFlatten = loadBinaryXmlSkipFileExport(file->getSource(),
data->data(), data->size(),
mContext->getDiagnostics());
} else {
outFileOp->xmlToFlatten = xml::inflate(data->data(), data->size(),
mContext->getDiagnostics(),
file->getSource());
}
if (!outFileOp->xmlToFlatten) {
return false;
}
// Copy the the file description header.
outFileOp->xmlToFlatten->file = fileDesc;
XmlReferenceLinker xmlLinker;
if (!xmlLinker.consume(mContext, outFileOp->xmlToFlatten.get())) {
return false;
}
if (!proguard::collectProguardRules(outFileOp->xmlToFlatten->file.source,
outFileOp->xmlToFlatten.get(), mKeepSet)) {
return false;
}
if (!mOptions.noAutoVersion) {
if (mOptions.noVersionVectors) {
// Skip this if it is a vector or animated-vector.
xml::Element* el = xml::findRootElement(outFileOp->xmlToFlatten.get());
if (el && el->namespaceUri.empty()) {
if (el->name == u"vector" || el->name == u"animated-vector") {
// We are NOT going to version this file.
outFileOp->skipVersion = true;
return true;
}
}
}
// Find the first SDK level used that is higher than this defined config and
// not superseded by a lower or equal SDK level resource.
for (int sdkLevel : xmlLinker.getSdkLevels()) {
if (sdkLevel > outFileOp->xmlToFlatten->file.config.sdkVersion) {
if (!shouldGenerateVersionedResource(entry, outFileOp->xmlToFlatten->file.config,
sdkLevel)) {
// If we shouldn't generate a versioned resource, stop checking.
break;
}
ResourceFile versionedFileDesc = outFileOp->xmlToFlatten->file;
versionedFileDesc.config.sdkVersion = (uint16_t) sdkLevel;
if (mContext->verbose()) {
mContext->getDiagnostics()->note(DiagMessage(versionedFileDesc.source)
<< "auto-versioning resource from config '"
<< outFileOp->xmlToFlatten->file.config
<< "' -> '"
<< versionedFileDesc.config << "'");
}
std::u16string genPath = util::utf8ToUtf16(ResourceUtils::buildResourceFileName(
versionedFileDesc, mContext->getNameMangler()));
bool added = table->addFileReferenceAllowMangled(versionedFileDesc.name,
versionedFileDesc.config,
versionedFileDesc.source,
genPath,
file,
mContext->getDiagnostics());
if (!added) {
return false;
}
break;
}
}
}
return true;
}
/**
* Do not insert or remove any resources while executing in this function. It will
* corrupt the iteration order.
*/
bool ResourceFileFlattener::flatten(ResourceTable* table, IArchiveWriter* archiveWriter) {
bool error = false;
std::map<std::pair<ConfigDescription, StringPiece16>, FileOperation> configSortedFiles;
for (auto& pkg : table->packages) {
for (auto& type : pkg->types) {
// Sort by config and name, so that we get better locality in the zip file.
configSortedFiles.clear();
for (auto& entry : type->entries) {
// Iterate via indices because auto generated values can be inserted ahead of
// the value being processed.
for (size_t i = 0; i < entry->values.size(); i++) {
ResourceConfigValue* configValue = entry->values[i].get();
FileReference* fileRef = valueCast<FileReference>(configValue->value.get());
if (!fileRef) {
continue;
}
io::IFile* file = fileRef->file;
if (!file) {
mContext->getDiagnostics()->error(DiagMessage(fileRef->getSource())
<< "file not found");
return false;
}
FileOperation fileOp;
fileOp.dstPath = util::utf16ToUtf8(*fileRef->path);
const StringPiece srcPath = file->getSource().path;
if (type->type != ResourceType::kRaw &&
(util::stringEndsWith<char>(srcPath, ".xml.flat") ||
util::stringEndsWith<char>(srcPath, ".xml"))) {
ResourceFile fileDesc;
fileDesc.config = configValue->config;
fileDesc.name = ResourceName(pkg->name, type->type, entry->name);
fileDesc.source = fileRef->getSource();
if (!linkAndVersionXmlFile(entry.get(), fileDesc, file, table, &fileOp)) {
error = true;
continue;
}
} else {
fileOp.fileToCopy = file;
}
// NOTE(adamlesinski): Explicitly construct a StringPiece16 here, or else
// we end up copying the string in the std::make_pair() method, then creating
// a StringPiece16 from the copy, which would cause us to end up referencing
// garbage in the map.
const StringPiece16 entryName(entry->name);
configSortedFiles[std::make_pair(configValue->config, entryName)] =
std::move(fileOp);
}
}
if (error) {
return false;
}
// Now flatten the sorted values.
for (auto& mapEntry : configSortedFiles) {
const ConfigDescription& config = mapEntry.first.first;
const FileOperation& fileOp = mapEntry.second;
if (fileOp.xmlToFlatten) {
Maybe<size_t> maxSdkLevel;
if (!mOptions.noAutoVersion && !fileOp.skipVersion) {
maxSdkLevel = std::max<size_t>(config.sdkVersion, 1u);
}
bool result = flattenXml(fileOp.xmlToFlatten.get(), fileOp.dstPath, maxSdkLevel,
mOptions.keepRawValues,
archiveWriter, mContext);
if (!result) {
error = true;
}
} else {
bool result = copyFileToArchive(fileOp.fileToCopy, fileOp.dstPath,
getCompressionFlags(fileOp.dstPath),
archiveWriter, mContext);
if (!result) {
error = true;
}
}
}
}
}
return !error;
}
class LinkCommand {
public:
LinkCommand(LinkContext* context, const LinkOptions& options) :
mOptions(options), mContext(context), mFinalTable(),
mFileCollection(util::make_unique<io::FileCollection>()) {
}
/**
* Creates a SymbolTable that loads symbols from the various APKs and caches the
* results for faster lookup.
*/
bool loadSymbolsFromIncludePaths() {
std::unique_ptr<AssetManagerSymbolSource> assetSource =
util::make_unique<AssetManagerSymbolSource>();
for (const std::string& path : mOptions.includePaths) {
if (mContext->verbose()) {
mContext->getDiagnostics()->note(DiagMessage(path) << "loading include path");
}
// First try to load the file as a static lib.
std::string errorStr;
std::unique_ptr<ResourceTable> staticInclude = loadStaticLibrary(path, &errorStr);
if (staticInclude) {
if (!mOptions.staticLib) {
// Can't include static libraries when not building a static library.
mContext->getDiagnostics()->error(
DiagMessage(path) << "can't include static library when building app");
return false;
}
// If we are using --no-static-lib-packages, we need to rename the package of this
// table to our compilation package.
if (mOptions.noStaticLibPackages) {
if (ResourceTablePackage* pkg = staticInclude->findPackageById(0x7f)) {
pkg->name = mContext->getCompilationPackage();
}
}
mContext->getExternalSymbols()->appendSource(
util::make_unique<ResourceTableSymbolSource>(staticInclude.get()));
mStaticTableIncludes.push_back(std::move(staticInclude));
} else if (!errorStr.empty()) {
// We had an error with reading, so fail.
mContext->getDiagnostics()->error(DiagMessage(path) << errorStr);
return false;
}
if (!assetSource->addAssetPath(path)) {
mContext->getDiagnostics()->error(
DiagMessage(path) << "failed to load include path");
return false;
}
}
mContext->getExternalSymbols()->appendSource(std::move(assetSource));
return true;
}
Maybe<AppInfo> extractAppInfoFromManifest(xml::XmlResource* xmlRes) {
// Make sure the first element is <manifest> with package attribute.
if (xml::Element* manifestEl = xml::findRootElement(xmlRes->root.get())) {
if (manifestEl->namespaceUri.empty() && manifestEl->name == u"manifest") {
if (xml::Attribute* packageAttr = manifestEl->findAttribute({}, u"package")) {
return AppInfo{ packageAttr->value };
}
}
}
return {};
}
/**
* Precondition: ResourceTable doesn't have any IDs assigned yet, nor is it linked.
* Postcondition: ResourceTable has only one package left. All others are stripped, or there
* is an error and false is returned.
*/
bool verifyNoExternalPackages() {
auto isExtPackageFunc = [&](const std::unique_ptr<ResourceTablePackage>& pkg) -> bool {
return mContext->getCompilationPackage() != pkg->name ||
!pkg->id ||
pkg->id.value() != mContext->getPackageId();
};
bool error = false;
for (const auto& package : mFinalTable.packages) {
if (isExtPackageFunc(package)) {
// We have a package that is not related to the one we're building!
for (const auto& type : package->types) {
for (const auto& entry : type->entries) {
ResourceNameRef resName(package->name, type->type, entry->name);
for (const auto& configValue : entry->values) {
// Special case the occurrence of an ID that is being generated for the
// 'android' package. This is due to legacy reasons.
if (valueCast<Id>(configValue->value.get()) &&
package->name == u"android") {
mContext->getDiagnostics()->warn(
DiagMessage(configValue->value->getSource())
<< "generated id '" << resName
<< "' for external package '" << package->name
<< "'");
} else {
mContext->getDiagnostics()->error(
DiagMessage(configValue->value->getSource())
<< "defined resource '" << resName
<< "' for external package '" << package->name
<< "'");
error = true;
}
}
}
}
}
}
auto newEndIter = std::remove_if(mFinalTable.packages.begin(), mFinalTable.packages.end(),
isExtPackageFunc);
mFinalTable.packages.erase(newEndIter, mFinalTable.packages.end());
return !error;
}
/**
* Returns true if no IDs have been set, false otherwise.
*/
bool verifyNoIdsSet() {
for (const auto& package : mFinalTable.packages) {
for (const auto& type : package->types) {
if (type->id) {
mContext->getDiagnostics()->error(DiagMessage() << "type " << type->type
<< " has ID " << std::hex
<< (int) type->id.value()
<< std::dec << " assigned");
return false;
}
for (const auto& entry : type->entries) {
if (entry->id) {
ResourceNameRef resName(package->name, type->type, entry->name);
mContext->getDiagnostics()->error(DiagMessage() << "entry " << resName
<< " has ID " << std::hex
<< (int) entry->id.value()
<< std::dec << " assigned");
return false;
}
}
}
}
return true;
}
std::unique_ptr<IArchiveWriter> makeArchiveWriter() {
if (mOptions.outputToDirectory) {
return createDirectoryArchiveWriter(mContext->getDiagnostics(), mOptions.outputPath);
} else {
return createZipFileArchiveWriter(mContext->getDiagnostics(), mOptions.outputPath);
}
}
bool flattenTable(ResourceTable* table, IArchiveWriter* writer) {
BigBuffer buffer(1024);
TableFlattener flattener(&buffer);
if (!flattener.consume(mContext, table)) {
return false;
}
if (writer->startEntry("resources.arsc", ArchiveEntry::kAlign)) {
if (writer->writeEntry(buffer)) {
if (writer->finishEntry()) {
return true;
}
}
}
mContext->getDiagnostics()->error(
DiagMessage() << "failed to write resources.arsc to archive");
return false;
}
bool flattenTableToPb(ResourceTable* table, IArchiveWriter* writer) {
// Create the file/zip entry.
if (!writer->startEntry("resources.arsc.flat", 0)) {
mContext->getDiagnostics()->error(DiagMessage() << "failed to open");
return false;
}
std::unique_ptr<pb::ResourceTable> pbTable = serializeTableToPb(table);
// Wrap our IArchiveWriter with an adaptor that implements the ZeroCopyOutputStream
// interface.
{
google::protobuf::io::CopyingOutputStreamAdaptor adaptor(writer);
if (!pbTable->SerializeToZeroCopyStream(&adaptor)) {
mContext->getDiagnostics()->error(DiagMessage() << "failed to write");
return false;
}
}
if (!writer->finishEntry()) {
mContext->getDiagnostics()->error(DiagMessage() << "failed to finish entry");
return false;
}
return true;
}
bool writeJavaFile(ResourceTable* table, const StringPiece16& packageNameToGenerate,
const StringPiece16& outPackage, JavaClassGeneratorOptions javaOptions) {
if (!mOptions.generateJavaClassPath) {
return true;
}
std::string outPath = mOptions.generateJavaClassPath.value();
file::appendPath(&outPath, file::packageToPath(util::utf16ToUtf8(outPackage)));
if (!file::mkdirs(outPath)) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed to create directory '" << outPath << "'");
return false;
}
file::appendPath(&outPath, "R.java");
std::ofstream fout(outPath, std::ofstream::binary);
if (!fout) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed writing to '" << outPath << "': " << strerror(errno));
return false;
}
JavaClassGenerator generator(mContext, table, javaOptions);
if (!generator.generate(packageNameToGenerate, outPackage, &fout)) {
mContext->getDiagnostics()->error(DiagMessage(outPath) << generator.getError());
return false;
}
if (!fout) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed writing to '" << outPath << "': " << strerror(errno));
}
return true;
}
bool writeManifestJavaFile(xml::XmlResource* manifestXml) {
if (!mOptions.generateJavaClassPath) {
return true;
}
std::unique_ptr<ClassDefinition> manifestClass = generateManifestClass(
mContext->getDiagnostics(), manifestXml);
if (!manifestClass) {
// Something bad happened, but we already logged it, so exit.
return false;
}
if (manifestClass->empty()) {
// Empty Manifest class, no need to generate it.
return true;
}
// Add any JavaDoc annotations to the generated class.
for (const std::string& annotation : mOptions.javadocAnnotations) {
std::string properAnnotation = "@";
properAnnotation += annotation;
manifestClass->getCommentBuilder()->appendComment(properAnnotation);
}
const std::string packageUtf8 = util::utf16ToUtf8(mContext->getCompilationPackage());
std::string outPath = mOptions.generateJavaClassPath.value();
file::appendPath(&outPath, file::packageToPath(packageUtf8));
if (!file::mkdirs(outPath)) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed to create directory '" << outPath << "'");
return false;
}
file::appendPath(&outPath, "Manifest.java");
std::ofstream fout(outPath, std::ofstream::binary);
if (!fout) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed writing to '" << outPath << "': " << strerror(errno));
return false;
}
if (!ClassDefinition::writeJavaFile(manifestClass.get(), packageUtf8, true, &fout)) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed writing to '" << outPath << "': " << strerror(errno));
return false;
}
return true;
}
bool writeProguardFile(const proguard::KeepSet& keepSet) {
if (!mOptions.generateProguardRulesPath) {
return true;
}
const std::string& outPath = mOptions.generateProguardRulesPath.value();
std::ofstream fout(outPath, std::ofstream::binary);
if (!fout) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed to open '" << outPath << "': " << strerror(errno));
return false;
}
proguard::writeKeepSet(&fout, keepSet);
if (!fout) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed writing to '" << outPath << "': " << strerror(errno));
return false;
}
return true;
}
std::unique_ptr<ResourceTable> loadStaticLibrary(const std::string& input,
std::string* outError) {
std::unique_ptr<io::ZipFileCollection> collection = io::ZipFileCollection::create(
input, outError);
if (!collection) {
return {};
}
return loadTablePbFromCollection(collection.get());
}
std::unique_ptr<ResourceTable> loadTablePbFromCollection(io::IFileCollection* collection) {
io::IFile* file = collection->findFile("resources.arsc.flat");
if (!file) {
return {};
}
std::unique_ptr<io::IData> data = file->openAsData();
return loadTableFromPb(file->getSource(), data->data(), data->size(),
mContext->getDiagnostics());
}
bool mergeStaticLibrary(const std::string& input, bool override) {
if (mContext->verbose()) {
mContext->getDiagnostics()->note(DiagMessage() << "merging static library " << input);
}
std::string errorStr;
std::unique_ptr<io::ZipFileCollection> collection =
io::ZipFileCollection::create(input, &errorStr);
if (!collection) {
mContext->getDiagnostics()->error(DiagMessage(input) << errorStr);
return false;
}
std::unique_ptr<ResourceTable> table = loadTablePbFromCollection(collection.get());
if (!table) {
mContext->getDiagnostics()->error(DiagMessage(input) << "invalid static library");
return false;
}
ResourceTablePackage* pkg = table->findPackageById(0x7f);
if (!pkg) {
mContext->getDiagnostics()->error(DiagMessage(input)
<< "static library has no package");
return false;
}
bool result;
if (mOptions.noStaticLibPackages) {
// Merge all resources as if they were in the compilation package. This is the old
// behaviour of aapt.
// Add the package to the set of --extra-packages so we emit an R.java for each
// library package.
if (!pkg->name.empty()) {
mOptions.extraJavaPackages.insert(pkg->name);
}
pkg->name = u"";
if (override) {
result = mTableMerger->mergeOverlay(Source(input), table.get(), collection.get());
} else {
result = mTableMerger->merge(Source(input), table.get(), collection.get());
}
} else {
// This is the proper way to merge libraries, where the package name is preserved
// and resource names are mangled.
result = mTableMerger->mergeAndMangle(Source(input), pkg->name, table.get(),
collection.get());
}
if (!result) {
return false;
}
// Make sure to move the collection into the set of IFileCollections.
mCollections.push_back(std::move(collection));
return true;
}
bool mergeResourceTable(io::IFile* file, bool override) {
if (mContext->verbose()) {
mContext->getDiagnostics()->note(DiagMessage() << "merging resource table "
<< file->getSource());
}
std::unique_ptr<io::IData> data = file->openAsData();
if (!data) {
mContext->getDiagnostics()->error(DiagMessage(file->getSource())
<< "failed to open file");
return false;
}
std::unique_ptr<ResourceTable> table = loadTableFromPb(file->getSource(),
data->data(), data->size(),
mContext->getDiagnostics());
if (!table) {
return false;
}
bool result = false;
if (override) {
result = mTableMerger->mergeOverlay(file->getSource(), table.get());
} else {
result = mTableMerger->merge(file->getSource(), table.get());
}
return result;
}
bool mergeCompiledFile(io::IFile* file, ResourceFile* fileDesc, bool override) {
if (mContext->verbose()) {
mContext->getDiagnostics()->note(DiagMessage() << "merging compiled file "
<< file->getSource());
}
bool result = false;
if (override) {
result = mTableMerger->mergeFileOverlay(*fileDesc, file);
} else {
result = mTableMerger->mergeFile(*fileDesc, file);
}
if (!result) {
return false;
}
// Add the exports of this file to the table.
for (SourcedResourceName& exportedSymbol : fileDesc->exportedSymbols) {
if (exportedSymbol.name.package.empty()) {
exportedSymbol.name.package = mContext->getCompilationPackage();
}
ResourceNameRef resName = exportedSymbol.name;
Maybe<ResourceName> mangledName = mContext->getNameMangler()->mangleName(
exportedSymbol.name);
if (mangledName) {
resName = mangledName.value();
}
std::unique_ptr<Id> id = util::make_unique<Id>();
id->setSource(fileDesc->source.withLine(exportedSymbol.line));
bool result = mFinalTable.addResourceAllowMangled(
resName, ConfigDescription::defaultConfig(), std::string(), std::move(id),
mContext->getDiagnostics());
if (!result) {
return false;
}
}
return true;
}
/**
* Takes a path to load as a ZIP file and merges the files within into the master ResourceTable.
* If override is true, conflicting resources are allowed to override each other, in order of
* last seen.
*
* An io::IFileCollection is created from the ZIP file and added to the set of
* io::IFileCollections that are open.
*/
bool mergeArchive(const std::string& input, bool override) {
if (mContext->verbose()) {
mContext->getDiagnostics()->note(DiagMessage() << "merging archive " << input);
}
std::string errorStr;
std::unique_ptr<io::ZipFileCollection> collection =
io::ZipFileCollection::create(input, &errorStr);
if (!collection) {
mContext->getDiagnostics()->error(DiagMessage(input) << errorStr);
return false;
}
bool error = false;
for (auto iter = collection->iterator(); iter->hasNext(); ) {
if (!mergeFile(iter->next(), override)) {
error = true;
}
}
// Make sure to move the collection into the set of IFileCollections.
mCollections.push_back(std::move(collection));
return !error;
}
/**
* Takes a path to load and merge into the master ResourceTable. If override is true,
* conflicting resources are allowed to override each other, in order of last seen.
*
* If the file path ends with .flata, .jar, .jack, or .zip the file is treated as ZIP archive
* and the files within are merged individually.
*
* Otherwise the files is processed on its own.
*/
bool mergePath(const std::string& path, bool override) {
if (util::stringEndsWith<char>(path, ".flata") ||
util::stringEndsWith<char>(path, ".jar") ||
util::stringEndsWith<char>(path, ".jack") ||
util::stringEndsWith<char>(path, ".zip")) {
return mergeArchive(path, override);
} else if (util::stringEndsWith<char>(path, ".apk")) {
return mergeStaticLibrary(path, override);
}
io::IFile* file = mFileCollection->insertFile(path);
return mergeFile(file, override);
}
/**
* Takes a file to load and merge into the master ResourceTable. If override is true,
* conflicting resources are allowed to override each other, in order of last seen.
*
* If the file ends with .arsc.flat, then it is loaded as a ResourceTable and merged into the
* master ResourceTable. If the file ends with .flat, then it is treated like a compiled file
* and the header data is read and merged into the final ResourceTable.
*
* All other file types are ignored. This is because these files could be coming from a zip,
* where we could have other files like classes.dex.
*/
bool mergeFile(io::IFile* file, bool override) {
const Source& src = file->getSource();
if (util::stringEndsWith<char>(src.path, ".arsc.flat")) {
return mergeResourceTable(file, override);
} else if (util::stringEndsWith<char>(src.path, ".flat")){
// Try opening the file and looking for an Export header.
std::unique_ptr<io::IData> data = file->openAsData();
if (!data) {
mContext->getDiagnostics()->error(DiagMessage(src) << "failed to open");
return false;
}
std::unique_ptr<ResourceFile> resourceFile = loadFileExportHeader(
src, data->data(), data->size(), mContext->getDiagnostics());
if (resourceFile) {
return mergeCompiledFile(file, resourceFile.get(), override);
}
return false;
}
// Ignore non .flat files. This could be classes.dex or something else that happens
// to be in an archive.
return true;
}
int run(const std::vector<std::string>& inputFiles) {
// Load the AndroidManifest.xml
std::unique_ptr<xml::XmlResource> manifestXml = loadXml(mOptions.manifestPath,
mContext->getDiagnostics());
if (!manifestXml) {
return 1;
}
if (Maybe<AppInfo> maybeAppInfo = extractAppInfoFromManifest(manifestXml.get())) {
mContext->setCompilationPackage(maybeAppInfo.value().package);
} else {
mContext->getDiagnostics()->error(DiagMessage(mOptions.manifestPath)
<< "no package specified in <manifest> tag");
return 1;
}
if (!util::isJavaPackageName(mContext->getCompilationPackage())) {
mContext->getDiagnostics()->error(DiagMessage(mOptions.manifestPath)
<< "invalid package name '"
<< mContext->getCompilationPackage()
<< "'");
return 1;
}
mContext->setNameManglerPolicy(NameManglerPolicy{ mContext->getCompilationPackage() });
if (mContext->getCompilationPackage() == u"android") {
mContext->setPackageId(0x01);
} else {
mContext->setPackageId(0x7f);
}
if (!loadSymbolsFromIncludePaths()) {
return 1;
}
TableMergerOptions tableMergerOptions;
tableMergerOptions.autoAddOverlay = mOptions.autoAddOverlay;
mTableMerger = util::make_unique<TableMerger>(mContext, &mFinalTable, tableMergerOptions);
if (mContext->verbose()) {
mContext->getDiagnostics()->note(
DiagMessage() << "linking package '" << mContext->getCompilationPackage()
<< "' with package ID " << std::hex
<< (int) mContext->getPackageId());
}
for (const std::string& input : inputFiles) {
if (!mergePath(input, false)) {
mContext->getDiagnostics()->error(DiagMessage() << "failed parsing input");
return 1;
}
}
for (const std::string& input : mOptions.overlayFiles) {
if (!mergePath(input, true)) {
mContext->getDiagnostics()->error(DiagMessage() << "failed parsing overlays");
return 1;
}
}
if (!verifyNoExternalPackages()) {
return 1;
}
if (!mOptions.staticLib) {
PrivateAttributeMover mover;
if (!mover.consume(mContext, &mFinalTable)) {
mContext->getDiagnostics()->error(
DiagMessage() << "failed moving private attributes");
return 1;
}
}
if (!mOptions.staticLib) {
// Assign IDs if we are building a regular app.
IdAssigner idAssigner;
if (!idAssigner.consume(mContext, &mFinalTable)) {
mContext->getDiagnostics()->error(DiagMessage() << "failed assigning IDs");
return 1;
}
} else {
// Static libs are merged with other apps, and ID collisions are bad, so verify that
// no IDs have been set.
if (!verifyNoIdsSet()) {
return 1;
}
}
// Add the names to mangle based on our source merge earlier.
mContext->setNameManglerPolicy(NameManglerPolicy{
mContext->getCompilationPackage(), mTableMerger->getMergedPackages() });
// Add our table to the symbol table.
mContext->getExternalSymbols()->prependSource(
util::make_unique<ResourceTableSymbolSource>(&mFinalTable));
{
ReferenceLinker linker;
if (!linker.consume(mContext, &mFinalTable)) {
mContext->getDiagnostics()->error(DiagMessage() << "failed linking references");
return 1;
}
if (mOptions.staticLib) {
if (!mOptions.products.empty()) {
mContext->getDiagnostics()->warn(
DiagMessage() << "can't select products when building static library");
}
if (mOptions.tableSplitterOptions.configFilter != nullptr ||
mOptions.tableSplitterOptions.preferredDensity) {
mContext->getDiagnostics()->warn(
DiagMessage() << "can't strip resources when building static library");
}
} else {
ProductFilter productFilter(mOptions.products);
if (!productFilter.consume(mContext, &mFinalTable)) {
mContext->getDiagnostics()->error(DiagMessage() << "failed stripping products");
return 1;
}
// TODO(adamlesinski): Actually pass in split constraints and handle splits at the file
// level.
TableSplitter tableSplitter({}, mOptions.tableSplitterOptions);
if (!tableSplitter.verifySplitConstraints(mContext)) {
return 1;
}
tableSplitter.splitTable(&mFinalTable);
}
}
proguard::KeepSet proguardKeepSet;
std::unique_ptr<IArchiveWriter> archiveWriter = makeArchiveWriter();
if (!archiveWriter) {
mContext->getDiagnostics()->error(DiagMessage() << "failed to create archive");
return 1;
}
bool error = false;
{
ManifestFixer manifestFixer(mOptions.manifestFixerOptions);
if (!manifestFixer.consume(mContext, manifestXml.get())) {
error = true;
}
// AndroidManifest.xml has no resource name, but the CallSite is built from the name
// (aka, which package the AndroidManifest.xml is coming from).
// So we give it a package name so it can see local resources.
manifestXml->file.name.package = mContext->getCompilationPackage();
XmlReferenceLinker manifestLinker;
if (manifestLinker.consume(mContext, manifestXml.get())) {
if (!proguard::collectProguardRulesForManifest(Source(mOptions.manifestPath),
manifestXml.get(),
&proguardKeepSet)) {
error = true;
}
if (mOptions.generateJavaClassPath) {
if (!writeManifestJavaFile(manifestXml.get())) {
error = true;
}
}
const bool keepRawValues = mOptions.staticLib;
bool result = flattenXml(manifestXml.get(), "AndroidManifest.xml", {},
keepRawValues, archiveWriter.get(), mContext);
if (!result) {
error = true;
}
} else {
error = true;
}
}
if (error) {
mContext->getDiagnostics()->error(DiagMessage() << "failed processing manifest");
return 1;
}
ResourceFileFlattenerOptions fileFlattenerOptions;
fileFlattenerOptions.keepRawValues = mOptions.staticLib;
fileFlattenerOptions.doNotCompressAnything = mOptions.doNotCompressAnything;
fileFlattenerOptions.extensionsToNotCompress = mOptions.extensionsToNotCompress;
fileFlattenerOptions.noAutoVersion = mOptions.noAutoVersion;
fileFlattenerOptions.noVersionVectors = mOptions.noVersionVectors;
ResourceFileFlattener fileFlattener(fileFlattenerOptions, mContext, &proguardKeepSet);
if (!fileFlattener.flatten(&mFinalTable, archiveWriter.get())) {
mContext->getDiagnostics()->error(DiagMessage() << "failed linking file resources");
return 1;
}
if (!mOptions.noAutoVersion) {
AutoVersioner versioner;
if (!versioner.consume(mContext, &mFinalTable)) {
mContext->getDiagnostics()->error(DiagMessage() << "failed versioning styles");
return 1;
}
}
if (mOptions.staticLib) {
if (!flattenTableToPb(&mFinalTable, archiveWriter.get())) {
mContext->getDiagnostics()->error(DiagMessage()
<< "failed to write resources.arsc.flat");
return 1;
}
} else {
if (!flattenTable(&mFinalTable, archiveWriter.get())) {
mContext->getDiagnostics()->error(DiagMessage()
<< "failed to write resources.arsc");
return 1;
}
}
if (mOptions.generateJavaClassPath) {
JavaClassGeneratorOptions options;
options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
options.javadocAnnotations = mOptions.javadocAnnotations;
if (mOptions.staticLib || mOptions.generateNonFinalIds) {
options.useFinal = false;
}
const StringPiece16 actualPackage = mContext->getCompilationPackage();
StringPiece16 outputPackage = mContext->getCompilationPackage();
if (mOptions.customJavaPackage) {
// Override the output java package to the custom one.
outputPackage = mOptions.customJavaPackage.value();
}
if (mOptions.privateSymbols) {
// If we defined a private symbols package, we only emit Public symbols
// to the original package, and private and public symbols to the private package.
options.types = JavaClassGeneratorOptions::SymbolTypes::kPublic;
if (!writeJavaFile(&mFinalTable, mContext->getCompilationPackage(),
outputPackage, options)) {
return 1;
}
options.types = JavaClassGeneratorOptions::SymbolTypes::kPublicPrivate;
outputPackage = mOptions.privateSymbols.value();
}
if (!writeJavaFile(&mFinalTable, actualPackage, outputPackage, options)) {
return 1;
}
for (const std::u16string& extraPackage : mOptions.extraJavaPackages) {
if (!writeJavaFile(&mFinalTable, actualPackage, extraPackage, options)) {
return 1;
}
}
}
if (mOptions.generateProguardRulesPath) {
if (!writeProguardFile(proguardKeepSet)) {
return 1;
}
}
if (mContext->verbose()) {
DebugPrintTableOptions debugPrintTableOptions;
debugPrintTableOptions.showSources = true;
Debug::printTable(&mFinalTable, debugPrintTableOptions);
}
return 0;
}
private:
LinkOptions mOptions;
LinkContext* mContext;
ResourceTable mFinalTable;
std::unique_ptr<TableMerger> mTableMerger;
// A pointer to the FileCollection representing the filesystem (not archives).
std::unique_ptr<io::FileCollection> mFileCollection;
// A vector of IFileCollections. This is mainly here to keep ownership of the collections.
std::vector<std::unique_ptr<io::IFileCollection>> mCollections;
// A vector of ResourceTables. This is here to retain ownership, so that the SymbolTable
// can use these.
std::vector<std::unique_ptr<ResourceTable>> mStaticTableIncludes;
};
int link(const std::vector<StringPiece>& args) {
LinkContext context;
LinkOptions options;
Maybe<std::string> privateSymbolsPackage;
Maybe<std::string> minSdkVersion, targetSdkVersion;
Maybe<std::string> renameManifestPackage, renameInstrumentationTargetPackage;
Maybe<std::string> versionCode, versionName;
Maybe<std::string> customJavaPackage;
std::vector<std::string> extraJavaPackages;
Maybe<std::string> configs;
Maybe<std::string> preferredDensity;
Maybe<std::string> productList;
bool legacyXFlag = false;
bool requireLocalization = false;
bool verbose = false;
Flags flags = Flags()
.requiredFlag("-o", "Output path", &options.outputPath)
.requiredFlag("--manifest", "Path to the Android manifest to build",
&options.manifestPath)
.optionalFlagList("-I", "Adds an Android APK to link against", &options.includePaths)
.optionalFlagList("-R", "Compilation unit to link, using `overlay` semantics.\n"
"The last conflicting resource given takes precedence.",
&options.overlayFiles)
.optionalFlag("--java", "Directory in which to generate R.java",
&options.generateJavaClassPath)
.optionalFlag("--proguard", "Output file for generated Proguard rules",
&options.generateProguardRulesPath)
.optionalSwitch("--no-auto-version",
"Disables automatic style and layout SDK versioning",
&options.noAutoVersion)
.optionalSwitch("--no-version-vectors",
"Disables automatic versioning of vector drawables. Use this only\n"
"when building with vector drawable support library",
&options.noVersionVectors)
.optionalSwitch("-x", "Legacy flag that specifies to use the package identifier 0x01",
&legacyXFlag)
.optionalSwitch("-z", "Require localization of strings marked 'suggested'",
&requireLocalization)
.optionalFlag("-c", "Comma separated list of configurations to include. The default\n"
"is all configurations", &configs)
.optionalFlag("--preferred-density",
"Selects the closest matching density and strips out all others.",
&preferredDensity)
.optionalFlag("--product", "Comma separated list of product names to keep",
&productList)
.optionalSwitch("--output-to-dir", "Outputs the APK contents to a directory specified "
"by -o",
&options.outputToDirectory)
.optionalFlag("--min-sdk-version", "Default minimum SDK version to use for "
"AndroidManifest.xml", &minSdkVersion)
.optionalFlag("--target-sdk-version", "Default target SDK version to use for "
"AndroidManifest.xml", &targetSdkVersion)
.optionalFlag("--version-code", "Version code (integer) to inject into the "
"AndroidManifest.xml if none is present", &versionCode)
.optionalFlag("--version-name", "Version name to inject into the AndroidManifest.xml "
"if none is present", &versionName)
.optionalSwitch("--static-lib", "Generate a static Android library", &options.staticLib)
.optionalSwitch("--no-static-lib-packages",
"Merge all library resources under the app's package",
&options.noStaticLibPackages)
.optionalSwitch("--non-final-ids", "Generates R.java without the final modifier.\n"
"This is implied when --static-lib is specified.",
&options.generateNonFinalIds)
.optionalFlag("--private-symbols", "Package name to use when generating R.java for "
"private symbols.\n"
"If not specified, public and private symbols will use the application's "
"package name", &privateSymbolsPackage)
.optionalFlag("--custom-package", "Custom Java package under which to generate R.java",
&customJavaPackage)
.optionalFlagList("--extra-packages", "Generate the same R.java but with different "
"package names", &extraJavaPackages)
.optionalFlagList("--add-javadoc-annotation", "Adds a JavaDoc annotation to all "
"generated Java classes", &options.javadocAnnotations)
.optionalSwitch("--auto-add-overlay", "Allows the addition of new resources in "
"overlays without <add-resource> tags", &options.autoAddOverlay)
.optionalFlag("--rename-manifest-package", "Renames the package in AndroidManifest.xml",
&renameManifestPackage)
.optionalFlag("--rename-instrumentation-target-package",
"Changes the name of the target package for instrumentation. Most useful "
"when used\nin conjunction with --rename-manifest-package",
&renameInstrumentationTargetPackage)
.optionalFlagList("-0", "File extensions not to compress",
&options.extensionsToNotCompress)
.optionalSwitch("-v", "Enables verbose logging", &verbose);
if (!flags.parse("aapt2 link", args, &std::cerr)) {
return 1;
}
// Expand all argument-files passed into the command line. These start with '@'.
std::vector<std::string> argList;
for (const std::string& arg : flags.getArgs()) {
if (util::stringStartsWith<char>(arg, "@")) {
const std::string path = arg.substr(1, arg.size() - 1);
std::string error;
if (!file::appendArgsFromFile(path, &argList, &error)) {
context.getDiagnostics()->error(DiagMessage(path) << error);
return 1;
}
} else {
argList.push_back(arg);
}
}
if (verbose) {
context.setVerbose(verbose);
}
if (privateSymbolsPackage) {
options.privateSymbols = util::utf8ToUtf16(privateSymbolsPackage.value());
}
if (minSdkVersion) {
options.manifestFixerOptions.minSdkVersionDefault =
util::utf8ToUtf16(minSdkVersion.value());
}
if (targetSdkVersion) {
options.manifestFixerOptions.targetSdkVersionDefault =
util::utf8ToUtf16(targetSdkVersion.value());
}
if (renameManifestPackage) {
options.manifestFixerOptions.renameManifestPackage =
util::utf8ToUtf16(renameManifestPackage.value());
}
if (renameInstrumentationTargetPackage) {
options.manifestFixerOptions.renameInstrumentationTargetPackage =
util::utf8ToUtf16(renameInstrumentationTargetPackage.value());
}
if (versionCode) {
options.manifestFixerOptions.versionCodeDefault = util::utf8ToUtf16(versionCode.value());
}
if (versionName) {
options.manifestFixerOptions.versionNameDefault = util::utf8ToUtf16(versionName.value());
}
if (customJavaPackage) {
options.customJavaPackage = util::utf8ToUtf16(customJavaPackage.value());
}
// Populate the set of extra packages for which to generate R.java.
for (std::string& extraPackage : extraJavaPackages) {
// A given package can actually be a colon separated list of packages.
for (StringPiece package : util::split(extraPackage, ':')) {
options.extraJavaPackages.insert(util::utf8ToUtf16(package));
}
}
if (productList) {
for (StringPiece product : util::tokenize<char>(productList.value(), ',')) {
if (product != "" && product != "default") {
options.products.insert(product.toString());
}
}
}
AxisConfigFilter filter;
if (configs) {
for (const StringPiece& configStr : util::tokenize<char>(configs.value(), ',')) {
ConfigDescription config;
LocaleValue lv;
if (lv.initFromFilterString(configStr)) {
lv.writeTo(&config);
} else if (!ConfigDescription::parse(configStr, &config)) {
context.getDiagnostics()->error(
DiagMessage() << "invalid config '" << configStr << "' for -c option");
return 1;
}
if (config.density != 0) {
context.getDiagnostics()->warn(
DiagMessage() << "ignoring density '" << config << "' for -c option");
} else {
filter.addConfig(config);
}
}
options.tableSplitterOptions.configFilter = &filter;
}
if (preferredDensity) {
ConfigDescription preferredDensityConfig;
if (!ConfigDescription::parse(preferredDensity.value(), &preferredDensityConfig)) {
context.getDiagnostics()->error(DiagMessage() << "invalid density '"
<< preferredDensity.value()
<< "' for --preferred-density option");
return 1;
}
// Clear the version that can be automatically added.
preferredDensityConfig.sdkVersion = 0;
if (preferredDensityConfig.diff(ConfigDescription::defaultConfig())
!= ConfigDescription::CONFIG_DENSITY) {
context.getDiagnostics()->error(DiagMessage() << "invalid preferred density '"
<< preferredDensity.value() << "'. "
<< "Preferred density must only be a density value");
return 1;
}
options.tableSplitterOptions.preferredDensity = preferredDensityConfig.density;
}
// Turn off auto versioning for static-libs.
if (options.staticLib) {
options.noAutoVersion = true;
options.noVersionVectors = true;
}
LinkCommand cmd(&context, options);
return cmd.run(argList);
}
} // namespace aapt
|