xref: /device/google/cuttlefish/host/commands/cvd/selector/arguments_separator.cpp

/*
 * Copyright (C) 2022 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 "host/commands/cvd/selector/arguments_separator.h"

#include <deque>

#include <android-base/strings.h>

#include "common/libs/utils/contains.h"

namespace cuttlefish {
namespace selector {

Result<std::unique_ptr<ArgumentsSeparator>> ArgumentsSeparator::Parse(
    const FlagsRegistration& flag_registration,
    const std::vector<std::string>& input_args) {
  LexerFlagsSpecification lexer_flag_spec{
      .known_boolean_flags = flag_registration.known_boolean_flags,
      .known_value_flags = flag_registration.known_value_flags,
  };
  auto lexer = CF_EXPECT(ArgumentsLexerBuilder::Build(lexer_flag_spec));
  CF_EXPECT(lexer != nullptr);
  ArgumentsSeparator* new_arg_separator =
      new ArgumentsSeparator(std::move(lexer), input_args, flag_registration);
  CF_EXPECT(new_arg_separator != nullptr,
            "Memory allocation failed for ArgumentSeparator");
  std::unique_ptr<ArgumentsSeparator> arg_separator{new_arg_separator};
  CF_EXPECT(arg_separator->Parse());
  return std::move(arg_separator);
}

Result<std::unique_ptr<ArgumentsSeparator>> ArgumentsSeparator::Parse(
    const FlagsRegistration& flag_registration,
    const CvdProtobufArg& input_args) {
  std::vector<std::string> input_args_vec;
  input_args_vec.reserve(input_args.size());
  for (const auto& input_arg : input_args) {
    input_args_vec.emplace_back(input_arg);
  }
  auto arg_separator = CF_EXPECT(Parse(flag_registration, input_args_vec));
  return std::move(arg_separator);
}

Result<std::unique_ptr<ArgumentsSeparator>> ArgumentsSeparator::Parse(
    const FlagsRegistration& flag_registration, const std::string& input_args,
    const std::string delim) {
  std::vector<std::string> input_args_vec =
      android::base::Tokenize(input_args, delim);
  auto arg_separator = CF_EXPECT(Parse(flag_registration, input_args_vec));
  return std::move(arg_separator);
}

ArgumentsSeparator::ArgumentsSeparator(
    std::unique_ptr<ArgumentsLexer>&& lexer,
    const std::vector<std::string>& input_args,
    const FlagsRegistration& flag_registration)
    : lexer_(std::move(lexer)),
      input_args_(input_args),
      known_boolean_flags_(flag_registration.known_boolean_flags),
      known_value_flags_(flag_registration.known_value_flags),
      valid_subcmds_(flag_registration.valid_subcommands) {}

Result<void> ArgumentsSeparator::Parse() {
  auto output = CF_EXPECT(ParseInternal());
  prog_path_ = std::move(output.prog_path);
  cvd_args_ = std::move(output.cvd_args);
  sub_cmd_ = std::move(output.sub_cmd);
  sub_cmd_args_ = std::move(output.sub_cmd_args);
  return {};
}

/*
 * prog_name, <optional cvd flags>, sub_cmd, <optional sub_cmd flags>
 *
 * -- could be included, which makes things complicated. However, if -- is
 * part of cvd flags, it's ill-formatted. If -- is among sub_cmd flags,
 * we will just forward it.
 *
 * If something like this is really needed, use the suggested alternative:
 *    original: cvd --some_flag -- --this-is-value start --subcmd_args
 * alternative: cvd --some_flag="--this-is-value" start --subcmd_args
 *
 */
Result<ArgumentsSeparator::Output> ArgumentsSeparator::ParseInternal() {
  CF_EXPECT(lexer_ != nullptr);
  CF_EXPECT(!input_args_.empty());
  Output output;

  auto tokenized = CF_EXPECT(lexer_->Tokenize(input_args_));
  std::deque<ArgToken> tokens_queue{tokenized.begin(), tokenized.end()};

  // take program path/name
  CF_EXPECT(!tokens_queue.empty() &&
            tokens_queue.front().Type() == ArgType::kPositional);
  output.prog_path = std::move(tokens_queue.front().Token());
  tokens_queue.pop_front();

  // break loop either if there is no token or
  // the subcommand token is consumed
  bool cvd_flags_mode = true;
  while (!tokens_queue.empty() && cvd_flags_mode) {
    const auto current = std::move(tokens_queue.front());
    const auto current_type = current.Type();
    const auto& current_token = current.Token();
    tokens_queue.pop_front();

    // look up next if any
    std::optional<ArgToken> next;
    if (!tokens_queue.empty()) {
      next = tokens_queue.front();
    }

    switch (current_type) {
      case ArgType::kKnownValueFlag: {
        output.cvd_args.emplace_back(current_token);
        if (next && next->Type() == ArgType::kPositional) {
          output.cvd_args.emplace_back(next->Token());
          tokens_queue.pop_front();
        }
      } break;
      case ArgType::kKnownFlagAndValue:
      case ArgType::kKnownBoolFlag:
      case ArgType::kKnownBoolNoFlag: {
        output.cvd_args.emplace_back(current_token);
      } break;
      case ArgType::kPositional: {
        output.sub_cmd = current.Token();
        CF_EXPECT(output.sub_cmd != std::nullopt);
        CF_EXPECT(Contains(valid_subcmds_, output.sub_cmd),
                  "Subcommand " << *(output.sub_cmd) << " is not valid");
        cvd_flags_mode = false;
      } break;
      case ArgType::kDoubleDash: {
        return CF_ERR("--"
                      << " is not allowed within cvd specific flags.");
      }
      case ArgType::kUnknownFlag:
      case ArgType::kError: {
        return CF_ERR(current.Token()
                      << " in cvd-specific flags is disallowed.");
      }
    }
  }
  while (!tokens_queue.empty()) {
    auto token = std::move(tokens_queue.front().Token());
    output.sub_cmd_args.emplace_back(std::move(token));
    tokens_queue.pop_front();
  }
  return output;
}

}  // namespace selector
}  // namespace cuttlefish