mirror of
https://github.com/nestriness/cdc-file-transfer.git
synced 2026-01-30 12:25:35 +02:00
f0539226a2
Adds start and stop commands to asset_stream_manager. asset_stream_manager will be renamed to cdc_stream next.
93 lines
3.2 KiB
C++
93 lines
3.2 KiB
C++
/*
|
|
* Copyright 2022 Google LLC
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef ASSET_STREAM_MANAGER_BASE_COMMAND_H_
|
|
#define ASSET_STREAM_MANAGER_BASE_COMMAND_H_
|
|
|
|
#include <string>
|
|
|
|
#include "absl/status/status.h"
|
|
|
|
namespace lyra {
|
|
class cli;
|
|
class command;
|
|
class group;
|
|
} // namespace lyra
|
|
|
|
namespace cdc_ft {
|
|
|
|
// Base class for commands that wraps Lyra commands to reduce common
|
|
// boilerplate like help text display, invalid args and return values from
|
|
// command execution.
|
|
class BaseCommand {
|
|
public:
|
|
// Creates a new command with given |name| and |help| text. After the command
|
|
// ran, the status code as returned by Run() is written to |exit_code|.
|
|
BaseCommand(std::string name, std::string help, int* exit_code);
|
|
~BaseCommand();
|
|
|
|
// Registers the command with Lyra. Must be called before parsing args.
|
|
void Register(lyra::cli& cli);
|
|
|
|
// Jedec parser for Lyra options. Usage:
|
|
// lyra::opt(JedecParser("size-flag", &size_bytes), "bytes"))
|
|
// Automatically reports a parse failure on error.
|
|
std::function<void(const std::string&)> JedecParser(const char* flag_name,
|
|
uint64_t* bytes);
|
|
|
|
// Validator that should be used for all positional arguments. Lyra interprets
|
|
// -u, --unknown_flag as positional argument. This validator makes sure that
|
|
// a positional argument starting with - is reported as an error. Otherwise,
|
|
// writes the value to |str|.
|
|
std::function<void(const std::string&)> PosArgValidator(std::string* str);
|
|
|
|
protected:
|
|
// Adds all optional and required arguments used by the command.
|
|
// Called by Register().
|
|
virtual void RegisterCommandLineFlags(lyra::command& cmd) = 0;
|
|
|
|
// Runs the command. Called by lyra::cli::parse() when this command is
|
|
// actually triggered and all flags have been parsed successfully.
|
|
virtual absl::Status Run() = 0;
|
|
|
|
private:
|
|
// Called by lyra::cli::parse() after successfully parsing arguments. Catches
|
|
// unknown arguments (Lyra interprets those as positional args, not as an
|
|
// error!), and displays the help text if appropriate, otherwise calls Run().
|
|
void CommandHandler(const lyra::group& g);
|
|
|
|
std::string name_;
|
|
std::string help_;
|
|
int* exit_code_ = nullptr;
|
|
|
|
bool show_help_ = false;
|
|
|
|
// Workaround for invalid args. Lyra doesn't interpret --invalid as invalid
|
|
// argument, but as positional argument "--invalid".
|
|
std::string invalid_arg_;
|
|
|
|
// Extraneous positional args. Gets reported as error if present.
|
|
std::string extra_positional_arg_;
|
|
|
|
// Errors from parsing JEDEC sizes.
|
|
// Works around Lyra not accepting errors from parsers.
|
|
std::string jedec_parse_error_;
|
|
};
|
|
|
|
} // namespace cdc_ft
|
|
|
|
#endif // ASSET_STREAM_MANAGER_BASE_COMMAND_H_
|