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
|
/*
* Copyright (C) 2018 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 "Command.h"
#include <iomanip>
#include <iostream>
#include <string>
#include <vector>
#include "android-base/stringprintf.h"
#include "android-base/utf8.h"
#include "androidfw/StringPiece.h"
#include "trace/TraceBuffer.h"
#include "util/Util.h"
using android::base::StringPrintf;
using android::StringPiece;
namespace aapt {
std::string GetSafePath(const StringPiece& arg) {
#ifdef _WIN32
// If the path exceeds the maximum path length for Windows, encode the path using the
// extended-length prefix
std::wstring path16;
CHECK(android::base::UTF8PathToWindowsLongPath(arg.data(), &path16))
<< "Failed to convert file path to UTF-16: file path " << arg.data();
std::string path8;
CHECK(android::base::WideToUTF8(path16, &path8))
<< "Failed to convert file path back to UTF-8: file path " << arg.data();
return path8;
#else
return arg.to_string();
#endif
}
void Command::AddRequiredFlag(const StringPiece& name, const StringPiece& description,
std::string* value, uint32_t flags) {
auto func = [value, flags](const StringPiece& arg) -> bool {
*value = (flags & Command::kPath) ? GetSafePath(arg) : arg.to_string();
return true;
};
flags_.emplace_back(Flag(name, description, /* required */ true, /* num_args */ 1, func));
}
void Command::AddRequiredFlagList(const StringPiece& name, const StringPiece& description,
std::vector<std::string>* value, uint32_t flags) {
auto func = [value, flags](const StringPiece& arg) -> bool {
value->push_back((flags & Command::kPath) ? GetSafePath(arg) : arg.to_string());
return true;
};
flags_.emplace_back(Flag(name, description, /* required */ true, /* num_args */ 1, func));
}
void Command::AddOptionalFlag(const StringPiece& name, const StringPiece& description,
Maybe<std::string>* value, uint32_t flags) {
auto func = [value, flags](const StringPiece& arg) -> bool {
*value = (flags & Command::kPath) ? GetSafePath(arg) : arg.to_string();
return true;
};
flags_.emplace_back(Flag(name, description, /* required */ false, /* num_args */ 1, func));
}
void Command::AddOptionalFlagList(const StringPiece& name, const StringPiece& description,
std::vector<std::string>* value, uint32_t flags) {
auto func = [value, flags](const StringPiece& arg) -> bool {
value->push_back((flags & Command::kPath) ? GetSafePath(arg) : arg.to_string());
return true;
};
flags_.emplace_back(Flag(name, description, /* required */ false, /* num_args */ 1, func));
}
void Command::AddOptionalFlagList(const StringPiece& name, const StringPiece& description,
std::unordered_set<std::string>* value) {
auto func = [value](const StringPiece& arg) -> bool {
value->insert(arg.to_string());
return true;
};
flags_.emplace_back(Flag(name, description, /* required */ false, /* num_args */ 1, func));
}
void Command::AddOptionalSwitch(const StringPiece& name, const StringPiece& description,
bool* value) {
auto func = [value](const StringPiece& arg) -> bool {
*value = true;
return true;
};
flags_.emplace_back(Flag(name, description, /* required */ false, /* num_args */ 0, func));
}
void Command::AddOptionalSubcommand(std::unique_ptr<Command>&& subcommand, bool experimental) {
subcommand->full_subcommand_name_ = StringPrintf("%s %s", name_.data(), subcommand->name_.data());
if (experimental) {
experimental_subcommands_.push_back(std::move(subcommand));
} else {
subcommands_.push_back(std::move(subcommand));
}
}
void Command::SetDescription(const StringPiece& description) {
description_ = description.to_string();
}
void Command::Usage(std::ostream* out) {
constexpr size_t kWidth = 50;
*out << full_subcommand_name_;
if (!subcommands_.empty()) {
*out << " [subcommand]";
}
*out << " [options]";
for (const Flag& flag : flags_) {
if (flag.is_required) {
*out << " " << flag.name << " arg";
}
}
*out << " files...\n";
if (!subcommands_.empty()) {
*out << "\nSubcommands:\n";
for (auto& subcommand : subcommands_) {
std::string argline = subcommand->name_;
// Split the description by newlines and write out the argument (which is
// empty after the first line) followed by the description line. This will make sure
// that multiline descriptions are still right justified and aligned.
for (StringPiece line : util::Tokenize(subcommand->description_, '\n')) {
*out << " " << std::setw(kWidth) << std::left << argline << line << "\n";
argline = " ";
}
}
}
*out << "\nOptions:\n";
for (const Flag& flag : flags_) {
std::string argline = flag.name;
if (flag.num_args > 0) {
argline += " arg";
}
// Split the description by newlines and write out the argument (which is
// empty after the first line) followed by the description line. This will make sure
// that multiline descriptions are still right justified and aligned.
for (StringPiece line : util::Tokenize(flag.description, '\n')) {
*out << " " << std::setw(kWidth) << std::left << argline << line << "\n";
argline = " ";
}
}
*out << " " << std::setw(kWidth) << std::left << "-h"
<< "Displays this help menu\n";
out->flush();
}
int Command::Execute(const std::vector<StringPiece>& args, std::ostream* out_error) {
TRACE_NAME_ARGS("Command::Execute", args);
std::vector<std::string> file_args;
for (size_t i = 0; i < args.size(); i++) {
const StringPiece& arg = args[i];
if (*(arg.data()) != '-') {
// Continue parsing as the subcommand if the first argument matches one of the subcommands
if (i == 0) {
for (auto& subcommand : subcommands_) {
if (arg == subcommand->name_ || (!subcommand->short_name_.empty()
&& arg == subcommand->short_name_)) {
return subcommand->Execute(
std::vector<StringPiece>(args.begin() + 1, args.end()), out_error);
}
}
for (auto& subcommand : experimental_subcommands_) {
if (arg == subcommand->name_ || (!subcommand->short_name_.empty()
&& arg == subcommand->short_name_)) {
return subcommand->Execute(
std::vector<StringPiece>(args.begin() + 1, args.end()), out_error);
}
}
}
file_args.push_back(GetSafePath(arg));
continue;
}
if (arg == "-h" || arg == "--help") {
Usage(out_error);
return 1;
}
bool match = false;
for (Flag& flag : flags_) {
if (arg == flag.name) {
if (flag.num_args > 0) {
i++;
if (i >= args.size()) {
*out_error << flag.name << " missing argument.\n\n";
Usage(out_error);
return false;
}
flag.action(args[i]);
} else {
flag.action({});
}
flag.found = true;
match = true;
break;
}
}
if (!match) {
*out_error << "unknown option '" << arg << "'.\n\n";
Usage(out_error);
return 1;
}
}
for (const Flag& flag : flags_) {
if (flag.is_required && !flag.found) {
*out_error << "missing required flag " << flag.name << "\n\n";
Usage(out_error);
return 1;
}
}
return Action(file_args);
}
} // namespace aapt
|