rzshell_which Namespace Reference

Functions
def	get_yaml_files (basedir)
def	find_entry (commands, rzcommand)
def	get_c_handler_name_from_entry (e)
def	find_c_name_handler (basedir, rzcommand)
def	format_shell_command (args)
def	main ()

Variables
	current_path = os.path.dirname(os.path.realpath(__file__))
	shell_finder_py
	check

Function Documentation

find_c_name_handler()

def rzshell_which.find_c_name_handler	(		basedir,
			rzcommand
	)

Definition at line 48 of file rzshell_which.py.

def find_c_name_handler(basedir, rzcommand):
    for f in get_yaml_files(basedir):
        with open(f, "r", encoding="utf8") as of:
            y = yaml.safe_load(of)
            e = find_entry(y["commands"], rzcommand)
            if e is not None:
                cname = e.get("cname", compute_cname(e["name"]))
                return get_handler_cname(
                    e.get("type", None), e.get("handler", None), cname
                )
 
    return None
 
 

References cmd_descs_util.compute_cname(), find_entry(), cmd_descs_util.get_handler_cname(), and get_yaml_files().

Referenced by main().

find_entry()

def rzshell_which.find_entry	(		commands,
			rzcommand
	)

Definition at line 20 of file rzshell_which.py.

def find_entry(commands, rzcommand):
    for c in commands:
        if "subcommands" in c and isinstance(c["subcommands"], list):
            e = find_entry(c["subcommands"], rzcommand)
            if e is not None:
                return e
        if "subcommands" in c and isinstance(c["subcommands"], str):
            # This cd is only a group pointing to another file,
            # the handler cname will be fetched from there.
            return None
 
        if c["name"] == rzcommand:
            return c
 
    return None
 
 

Referenced by find_c_name_handler().

format_shell_command()

def rzshell_which.format_shell_command

(

args

)

Definition at line 62 of file rzshell_which.py.

def format_shell_command(args):
    return " ".join(
        [arg if '"' not in arg and "*" not in arg else f"'{arg}'" for arg in args]
    )
 
 

get_c_handler_name_from_entry()

def rzshell_which.get_c_handler_name_from_entry

(

e

)

Definition at line 37 of file rzshell_which.py.

def get_c_handler_name_from_entry(e):
    name = e["cname"]
    if "handler" in e and e["handler"]:
        name = e["handler"]
 
    if "type" in e and e["type"] == CD_TYPE_OLDINPUT:
        return f"rz_{name}"
 
    return f"rz_{name}_handler"
 
 

get_yaml_files()

def rzshell_which.get_yaml_files

(

basedir

)

Definition at line 15 of file rzshell_which.py.

def get_yaml_files(basedir):
    for file in glob.glob(os.path.join(basedir, "*.yaml")):
        yield file
 
 

Referenced by find_c_name_handler().

main()

def rzshell_which.main

(

void

)

Definition at line 68 of file rzshell_which.py.

def main():
    parser = argparse.ArgumentParser(
        description="Find the C handler of a rizin command"
    )
    parser.add_argument(
        "--cmddescs-dir",
        default=os.path.join("librz", "core", "cmd_descs"),
        type=str,
        help="Path to the cmd_descs directory containing the *.yaml files",
    )
    parser.add_argument(
        "-g",
        "--grep",
        action="store_true",
        help="Run the grep command directly instead of just showing it",
    )
    parser.add_argument("rzcommand", type=str, help="Name of the rizin command")
 
    args = parser.parse_args()
    c_name = find_c_name_handler(args.cmddescs_dir, args.rzcommand)
    CRED = "\033[91m"
    CEND = "\033[0m"
    if c_name is None:
        print(
            f"Command {args.rzcommand} does not exist or it is not converted to rzshell yet."
        )
        grep_cmd = ["git", "grep", "-n", f'"{args.rzcommand}"', "librz/core/cmd"]
        print(
            f"Some old commands may be found like this: {CRED}{format_shell_command(grep_cmd)}{CEND}"
        )
    else:
        print(f"Rizin Command: {CRED}{args.rzcommand}{CEND}")
        print(f"C handler: {CRED}{c_name}{CEND}")
        grep_cmd = ["git", "grep", "-nWG", f"^[^[:blank:]].*{c_name}(", "*.c"]
        print(f"Git command to get it: {CRED}{format_shell_command(grep_cmd)}{CEND}")
 
    if args.grep:
        print("--------")
        sys.exit(subprocess.run(grep_cmd, check=False).returncode)
 
 

References find_c_name_handler().

Variable Documentation

check

rzshell_which.check

Definition at line 14 of file rzshell_which.py.

current_path

rzshell_which.current_path = os.path.dirname(os.path.realpath(__file__))

Definition at line 9 of file rzshell_which.py.

shell_finder_py

rzshell_which.shell_finder_py

Initial value:

=  os.path.join(
    current_path, "..", "librz", "core", "cmd_descs", "rzshell_which.py"
)

Definition at line 10 of file rzshell_which.py.