1 /* 2 * Copyright (C) 2018 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 AAPT2_COMPILE_H 18 #define AAPT2_COMPILE_H 19 20 #include <androidfw/StringPiece.h> 21 22 #include <optional> 23 24 #include "Command.h" 25 #include "ResourceTable.h" 26 #include "androidfw/IDiagnostics.h" 27 #include "format/Archive.h" 28 #include "process/IResourceTableConsumer.h" 29 30 namespace aapt { 31 32 struct CompileOptions { 33 std::string output_path; 34 std::optional<std::string> source_path; 35 std::optional<std::string> res_dir; 36 std::optional<std::string> res_zip; 37 std::optional<std::string> generate_text_symbols_path; 38 std::optional<std::string> pseudo_localize_gender_values; 39 std::optional<std::string> pseudo_localize_gender_ratio; 40 std::optional<Visibility::Level> visibility; 41 bool pseudolocalize = false; 42 bool no_png_crunch = false; 43 bool legacy_mode = false; 44 // See comments on aapt::ResourceParserOptions. 45 bool preserve_visibility_of_styleables = false; 46 bool verbose = false; 47 std::optional<std::string> product_; 48 }; 49 50 /** Parses flags and compiles resources to be used in linking. */ 51 class CompileCommand : public Command { 52 public: CompileCommand(android::IDiagnostics * diagnostic)53 explicit CompileCommand(android::IDiagnostics* diagnostic) 54 : Command("compile", "c"), diagnostic_(diagnostic) { 55 SetDescription("Compiles resources to be linked into an apk."); 56 AddRequiredFlag("-o", "Output path", &options_.output_path, Command::kPath); 57 AddOptionalFlag("--dir", "Directory to scan for resources", &options_.res_dir, Command::kPath); 58 AddOptionalFlag("--zip", "Zip file containing the res directory to scan for resources", 59 &options_.res_zip, Command::kPath); 60 AddOptionalFlag("--output-text-symbols", 61 "Generates a text file containing the resource symbols in the\n" 62 "specified file", &options_.generate_text_symbols_path, Command::kPath); 63 AddOptionalSwitch("--pseudo-localize", "Generate resources for pseudo-locales " 64 "(en-XA and ar-XB)", &options_.pseudolocalize); 65 AddOptionalSwitch("--no-crunch", "Disables PNG processing", &options_.no_png_crunch); 66 AddOptionalSwitch("--legacy", "Treat errors that used to be valid in AAPT as warnings", 67 &options_.legacy_mode); 68 AddOptionalSwitch("--preserve-visibility-of-styleables", 69 "If specified, apply the same visibility rules for\n" 70 "styleables as are used for all other resources.\n" 71 "Otherwise, all stylesables will be made public.", 72 &options_.preserve_visibility_of_styleables); 73 AddOptionalFlag("--visibility", 74 "Sets the visibility of the compiled resources to the specified\n" 75 "level. Accepted levels: public, private, default", &visibility_); 76 AddOptionalSwitch("-v", "Enables verbose logging", &options_.verbose); 77 AddOptionalFlag("--trace-folder", "Generate systrace json trace fragment to specified folder.", 78 &trace_folder_); 79 AddOptionalFlag("--source-path", 80 "Sets the compiled resource file source file path to the given string.", 81 &options_.source_path); 82 AddOptionalFlag("--pseudo-localize-gender-values", 83 "Sets the gender values to pick up for generating grammatical gender strings, " 84 "gender values should be f, m, or n, which are shortcuts for feminine, " 85 "masculine and neuter, and split with comma.", 86 &options_.pseudo_localize_gender_values); 87 AddOptionalFlag("--pseudo-localize-gender-ratio", 88 "Sets the ratio of resources to generate grammatical gender strings for. The " 89 "ratio has to be a float number between 0 and 1.", 90 &options_.pseudo_localize_gender_ratio); 91 AddOptionalFlag("--filter-product", 92 "Leave only resources specific to the given product. All " 93 "other resources (including defaults) are removed.", 94 &options_.product_); 95 } 96 97 int Action(const std::vector<std::string>& args) override; 98 99 private: 100 android::IDiagnostics* diagnostic_; 101 CompileOptions options_; 102 std::optional<std::string> visibility_; 103 std::optional<std::string> trace_folder_; 104 }; 105 106 int Compile(IAaptContext* context, io::IFileCollection* inputs, IArchiveWriter* output_writer, 107 CompileOptions& options); 108 109 }// namespace aapt 110 111 #endif //AAPT2_COMPILE_H 112