Home | History | Annotate | Download | only in cmd
      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   bool verbose = false;
     39 };
     40 
     41 /** Parses flags and compiles resources to be used in linking.  */
     42 class CompileCommand : public Command {
     43  public:
     44   explicit CompileCommand(IDiagnostics* diagnostic) : Command("compile", "c"),
     45                                                       diagnostic_(diagnostic) {
     46     SetDescription("Compiles resources to be linked into an apk.");
     47     AddRequiredFlag("-o", "Output path", &options_.output_path, Command::kPath);
     48     AddOptionalFlag("--dir", "Directory to scan for resources", &options_.res_dir, Command::kPath);
     49     AddOptionalFlag("--zip", "Zip file containing the res directory to scan for resources",
     50         &options_.res_zip, Command::kPath);
     51     AddOptionalFlag("--output-text-symbols",
     52         "Generates a text file containing the resource symbols in the\n"
     53             "specified file", &options_.generate_text_symbols_path, Command::kPath);
     54     AddOptionalSwitch("--pseudo-localize", "Generate resources for pseudo-locales "
     55         "(en-XA and ar-XB)", &options_.pseudolocalize);
     56     AddOptionalSwitch("--no-crunch", "Disables PNG processing", &options_.no_png_crunch);
     57     AddOptionalSwitch("--legacy", "Treat errors that used to be valid in AAPT as warnings",
     58         &options_.legacy_mode);
     59     AddOptionalFlag("--visibility",
     60         "Sets the visibility of the compiled resources to the specified\n"
     61             "level. Accepted levels: public, private, default", &visibility_);
     62     AddOptionalSwitch("-v", "Enables verbose logging", &options_.verbose);
     63     AddOptionalFlag("--trace-folder", "Generate systrace json trace fragment to specified folder.",
     64                     &trace_folder_);
     65   }
     66 
     67   int Action(const std::vector<std::string>& args) override;
     68 
     69  private:
     70   IDiagnostics* diagnostic_;
     71   CompileOptions options_;
     72   Maybe<std::string> visibility_;
     73   Maybe<std::string> trace_folder_;
     74 };
     75 
     76 int Compile(IAaptContext* context, io::IFileCollection* inputs, IArchiveWriter* output_writer,
     77             CompileOptions& options);
     78 
     79 }// namespace aapt
     80 
     81 #endif //AAPT2_COMPILE_H
     82