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 #include "format/Archive.h"
22 #include "process/IResourceTableConsumer.h"
23 #include "Command.h"
24 #include "Diagnostics.h"
25 #include "ResourceTable.h"
26 
27 namespace aapt {
28 
29 struct CompileOptions {
30   std::string output_path;
31   Maybe<std::string> res_dir;
32   Maybe<std::string> res_zip;
33   Maybe<std::string> generate_text_symbols_path;
34   Maybe<Visibility::Level> visibility;
35   bool pseudolocalize = false;
36   bool no_png_crunch = false;
37   bool legacy_mode = false;
38   // See comments on aapt::ResourceParserOptions.
39   bool preserve_visibility_of_styleables = false;
40   bool verbose = false;
41 };
42 
43 /** Parses flags and compiles resources to be used in linking.  */
44 class CompileCommand : public Command {
45  public:
CompileCommand(IDiagnostics * diagnostic)46   explicit CompileCommand(IDiagnostics* diagnostic) : Command("compile", "c"),
47                                                       diagnostic_(diagnostic) {
48     SetDescription("Compiles resources to be linked into an apk.");
49     AddRequiredFlag("-o", "Output path", &options_.output_path, Command::kPath);
50     AddOptionalFlag("--dir", "Directory to scan for resources", &options_.res_dir, Command::kPath);
51     AddOptionalFlag("--zip", "Zip file containing the res directory to scan for resources",
52         &options_.res_zip, Command::kPath);
53     AddOptionalFlag("--output-text-symbols",
54         "Generates a text file containing the resource symbols in the\n"
55             "specified file", &options_.generate_text_symbols_path, Command::kPath);
56     AddOptionalSwitch("--pseudo-localize", "Generate resources for pseudo-locales "
57         "(en-XA and ar-XB)", &options_.pseudolocalize);
58     AddOptionalSwitch("--no-crunch", "Disables PNG processing", &options_.no_png_crunch);
59     AddOptionalSwitch("--legacy", "Treat errors that used to be valid in AAPT as warnings",
60         &options_.legacy_mode);
61     AddOptionalSwitch("--preserve-visibility-of-styleables",
62                       "If specified, apply the same visibility rules for\n"
63                       "styleables as are used for all other resources.\n"
64                       "Otherwise, all stylesables will be made public.",
65                       &options_.preserve_visibility_of_styleables);
66     AddOptionalFlag("--visibility",
67         "Sets the visibility of the compiled resources to the specified\n"
68             "level. Accepted levels: public, private, default", &visibility_);
69     AddOptionalSwitch("-v", "Enables verbose logging", &options_.verbose);
70     AddOptionalFlag("--trace-folder", "Generate systrace json trace fragment to specified folder.",
71                     &trace_folder_);
72   }
73 
74   int Action(const std::vector<std::string>& args) override;
75 
76  private:
77   IDiagnostics* diagnostic_;
78   CompileOptions options_;
79   Maybe<std::string> visibility_;
80   Maybe<std::string> trace_folder_;
81 };
82 
83 int Compile(IAaptContext* context, io::IFileCollection* inputs, IArchiveWriter* output_writer,
84             CompileOptions& options);
85 
86 }// namespace aapt
87 
88 #endif //AAPT2_COMPILE_H
89