#include </home/runner/work/hal/hal/plugins/python_shell/include/python_shell/plugin_python_shell.h>

Inheritance diagram for hal::CliExtensionPythonShell:

Collaboration diagram for hal::CliExtensionPythonShell:

Public Member Functions
	CliExtensionPythonShell ()=default

	~CliExtensionPythonShell ()=default

ProgramOptions	get_cli_options () const override

virtual bool	handle_cli_call (Netlist *, ProgramArguments &) override

Public Member Functions inherited from hal::CliExtensionInterface
	CliExtensionInterface ()

Public Member Functions inherited from hal::AbstractExtensionInterface
	AbstractExtensionInterface ()

virtual	~AbstractExtensionInterface ()

Detailed Description

The command line interface of the Python shell plugin.

Definition at line 36 of file plugin_python_shell.h.

Constructor & Destructor Documentation

◆ CliExtensionPythonShell()

hal::CliExtensionPythonShell::CliExtensionPythonShell ( )

default

◆ ~CliExtensionPythonShell()

hal::CliExtensionPythonShell::~CliExtensionPythonShell ( )

default

Member Function Documentation

◆ get_cli_options()

ProgramOptions hal::CliExtensionPythonShell::get_cli_options ( ) const

overridevirtual

Returns command line interface options

Returns: The program options description.

Implements hal::CliExtensionInterface.

Definition at line 18 of file plugin_python_shell.cpp.

References hal::ProgramOptions::A_REQUIRED_PARAMETER, and hal::ProgramOptions::add().

◆ handle_cli_call()

virtual bool hal::CliExtensionPythonShell::handle_cli_call	(	Netlist *	,
		ProgramArguments &
	)

inlineoverridevirtual

Reports that the call was not handled, which ends HAL with an error.

CliExtensionInterface requires an implementation, but this one is never reached: the options declared above belong to a UI plugin, and main.cpp dispatches those through UIPluginInterface::exec and returns before it walks the CLI extensions.