|
Rizin
unix-like reverse engineering framework and cli tools
|
|
Rizin
unix-like reverse engineering framework and cli tools
|
Go to the source code of this file.
Classes | |
| struct | rz_cmd_state_output_t |
| Represent the output state of a command handler. More... | |
| struct | rz_cmd_parsed_args_t |
| struct | rz_cmd_macro_label_t |
| struct | rz_cmd_macro_item_t |
| struct | rz_cmd_macro_t |
| struct | rz_cmd_item_t |
| struct | rz_cmd_alias_t |
| struct | rz_cmd_desc_detail_entry_t |
| A detailed entry that can be used to show additional info about a command entry. More... | |
| struct | rz_cmd_desc_detail_t |
| struct | rz_cmd_desc_arg_t |
| struct | rz_cmd_desc_help_t |
| struct | rz_cmd_desc_t |
| struct | rz_cmd_t |
| struct | rz_cmd_descriptor_t |
Macros | |
| #define | MACRO_LIMIT 1024 |
| #define | MACRO_LABELS 20 |
| #define | RZ_CMD_MAXLEN 4096 |
| #define | RZ_CMD_ARG_FLAG_LAST (1 << 0) |
| #define | RZ_CMD_ARG_FLAG_ARRAY (1 << 1) |
| #define | RZ_CMD_ARG_FLAG_OPTION (1 << 2) |
| #define RZ_CMD_ARG_FLAG_ARRAY (1 << 1) |
| #define RZ_CMD_ARG_FLAG_LAST (1 << 0) |
| #define RZ_CMD_ARG_FLAG_OPTION (1 << 2) |
| typedef struct rz_cmd_alias_t RzCmdAlias |
| typedef enum rz_cmd_arg_type_t RzCmdArgType |
Type of argument a command handler can have. This is used for visualization in help messages and for autocompletion as well.
| typedef RzCmdStatus(* RzCmdArgvCb) (RzCore *core, int argc, const char **argv) |
| typedef RzCmdStatus(* RzCmdArgvModesCb) (RzCore *core, int argc, const char **argv, RzOutputMode mode) |
| typedef RzCmdStatus(* RzCmdArgvStateCb) (RzCore *core, int argc, const char **argv, RzCmdStateOutput *state) |
| typedef struct rz_cmd_desc_t RzCmdDesc |
Command Descriptor structure. It represents a command that can be executed by the user on the shell or a part of the command help (e.g. groups of commands). Anything that appears under ? has an associated command descriptor.
| typedef struct rz_cmd_desc_arg_t RzCmdDescArg |
A description of an argument of a RzCmdDesc.
| typedef struct rz_cmd_desc_detail_t RzCmdDescDetail |
A detail section used to better describe a command.
| typedef struct rz_cmd_desc_detail_entry_t RzCmdDescDetailEntry |
A detailed entry that can be used to show additional info about a command entry.
It can contain whatever relevant information (e.g. examples, specific uses of a command, variables, etc.).
Displayed as: | <text><arg_str> # <comment>
| typedef struct rz_cmd_desc_help_t RzCmdDescHelp |
Define how the command looks like in the help.
| typedef struct rz_cmd_descriptor_t RzCmdDescriptor |
| typedef enum rz_cmd_desc_type_t RzCmdDescType |
| typedef enum rz_cmd_escape_t RzCmdEscape |
| typedef struct rz_cmd_item_t RzCmdItem |
| typedef struct rz_cmd_macro_t RzCmdMacro |
| typedef struct rz_cmd_macro_item_t RzCmdMacroItem |
| typedef struct rz_cmd_macro_label_t RzCmdMacroLabel |
| typedef struct rz_cmd_parsed_args_t RzCmdParsedArgs |
argc/argv data created from parsing the input command string.
| typedef struct rz_cmd_state_output_t RzCmdStateOutput |
Represent the output state of a command handler.
This structure is passed to commands of type RZ_CMD_DESC_TYPE_ARGV_STATE .
| typedef enum rz_cmd_status_t RzCmdStatus |
Value returned by a command handler.
| enum rz_cmd_arg_type_t |
Type of argument a command handler can have. This is used for visualization in help messages and for autocompletion as well.
Definition at line 36 of file rz_cmd.h.
| enum rz_cmd_desc_type_t |
| Enumerator | |
|---|---|
| RZ_CMD_DESC_TYPE_OLDINPUT | For old handlers that parse their own input and accept a single string. Mainly used for legacy reasons with old command handlers. |
| RZ_CMD_DESC_TYPE_ARGV | For handlers that accept argc/argv. It cannot have children. Use RZ_CMD_DESC_TYPE_GROUP if you need a command that can be both executed and has sub-commands. |
| RZ_CMD_DESC_TYPE_GROUP | For cmd descriptors that are parent of other sub-commands, even if they may also have a sub-command with the same name. For example, |
| RZ_CMD_DESC_TYPE_INNER | For cmd descriptors that are just used to group together related sub-commands. Do not use this if the command can be used by itself or if it's necessary to show its help, because this descriptor is not stored in the hashtable and cannot be retrieved except by listing the children of its parent. Most of the time you want RZ_CMD_DESC_TYPE_GROUP. |
| RZ_CMD_DESC_TYPE_FAKE | For entries that shall be shown in the help tree but that are not commands on their own. |
| RZ_CMD_DESC_TYPE_ARGV_MODES | For handlers that accept argc/argv and that provides multiple output modes (e.g. rizin commands, quiet output, json, long). It cannot have children. Use RZ_CMD_DESC_TYPE_GROUP if you need a command that can be both executed and has sub-commands. |
| RZ_CMD_DESC_TYPE_ARGV_STATE | For handlers that accept argc/argv and that provides multiple output modes (e.g. rizin commands, quiet output, json, long). It cannot have children. Use RZ_CMD_DESC_TYPE_GROUP if you need a command that can be both executed and has sub-commands. Differently from |
Definition at line 350 of file rz_cmd.h.
| enum rz_cmd_escape_t |
Definition at line 78 of file rz_cmd.h.
| enum rz_cmd_status_t |
Value returned by a command handler.
Definition at line 23 of file rz_cmd.h.
1.9.1 
