command_handler.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#pragma once
 
#include <string>
 
#include "cuttlefish/flag_parser/flag.h"
#include "cuttlefish/host/commands/cvd/cli/command_request.h"
#include "cuttlefish/host/commands/cvd/cli/help_format.h"
#include "cuttlefish/result/result.h"
 
namespace cuttlefish {
 
class CvdCommandHandler {
 public:
  virtual ~CvdCommandHandler() = default;
 
  virtual Result<void> Handle(const CommandRequest&) = 0;
  // returns the list of subcommand it can handle
  virtual std::vector<std::string> CmdList() const = 0;
  // used for command help text
  virtual std::string SummaryHelp() const = 0;
  virtual bool RequiresDeviceExists() const;
  virtual Result<std::string> DetailedHelp(const CommandRequest&);
  virtual std::vector<HelpParagraph> Description() const;
  virtual Result<std::vector<Flag>> Flags(const CommandRequest&);
 
  virtual bool RequiresHostConfiguration() const { return false; }
};
 
}  // namespace cuttlefish