command_handler.h File Reference

#include <filesystem>
#include <map>
#include <optional>
#include <string>
#include <vector>
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/string_view.h"
#include "cli/service/resources/command_context.h"
#include "core/asar_wrapper.h"
#include "core/project.h"
#include "rom/rom.h"

Go to the source code of this file.

Classes
struct	yaze::cli::resources::CommandInvocationContext
class	yaze::cli::resources::CommandHandler
	Base class for CLI command handlers. More...
struct	yaze::cli::resources::CommandHandler::DescriptorEntry
struct	yaze::cli::resources::CommandHandler::Descriptor

Namespaces
namespace	yaze
namespace	yaze::cli
	Namespace for the command line interface.
namespace	yaze::cli::resources

Macros
#define	DEFINE_COMMAND_HANDLER(name, usage_str, validate_body, execute_body)
	Helper macro for creating simple command handlers.

Functions
absl::StatusOr< std::filesystem::path >	yaze::cli::resources::ResolveStableArtifactPath (const std::filesystem::path &path)
absl::StatusOr< bool >	yaze::cli::resources::PathsAlias (const std::filesystem::path &lhs, const std::filesystem::path &rhs)
absl::Status	yaze::cli::resources::RejectArtifactRomAliases (absl::string_view option_name, const std::filesystem::path &artifact_path, const CommandInvocationContext &invocation_context)

Macro Definition Documentation

DEFINE_COMMAND_HANDLER

#define DEFINE_COMMAND_HANDLER	(		name,
			usage_str,
			validate_body,
			execute_body )

Value:

  class name##CommandHandler : public CommandHandler {                       \
   public:                                                                   \
    std::string GetName() const override { return #name; }                   \
    std::string GetUsage() const override { return usage_str; }              \
                                                                             \
   protected:                                                                \
    absl::Status ValidateArgs(const ArgumentParser& parser) override         \
        validate_body absl::Status                                           \
        Execute(Rom* rom, const ArgumentParser& parser,                      \
                OutputFormatter& formatter) override execute_body            \
  };

Helper macro for creating simple command handlers.

Usage:

DEFINE_COMMAND_HANDLER(ResourceList,
  "agent resource-list --type <type> [--format <table|json>]",
  { return parser.RequireArgs({"type"}); },
  {
    auto type = parser.GetString("type").value();
    ResourceContextBuilder builder(rom);
    auto labels = builder.GetLabels(type);
    for (const auto& [key, value] : *labels) {
      formatter.AddField(key, value);
    }
    return absl::OkStatus();
  }
)

Definition at line 234 of file command_handler.h.