origen.boot

Functions

• GetOutputFile(): Return the console object used by readline so that it can be used for printing in color.

• run_cmd(): Run an Origen command. This is the main entry method for the CLI, but it can also

origen.boot.GetOutputFile()

Return the console object used by readline so that it can be used for printing in color.

origen.boot.run_cmd(command, targets=None, verbosity=None, mode=None, files=None, output_dir=None, reference_dir=None, debug=False, args=None, **kwargs)

Run an Origen command. This is the main entry method for the CLI, but it can also be used in application commands to invoke Origen commands within the same thread instead of making system calls.

See also

• Example Application Commands

Variables

• parse_and_bind

• get_line_buffer

• insert_text

• clear_history

• read_init_file

• read_history_file

• write_history_file

• get_current_history_length

• get_history_length

• get_history_item

• set_history_length

• set_startup_hook

• set_pre_input_hook

• set_completer

• get_completer

• get_begidx

• get_endidx

• set_completer_delims

• get_completer_delims

• add_history

• callback_handler_install

• callback_handler_remove

• callback_read_char

• rl

origen.boot.parse_and_bind

Parse and execute single line of a readline init file.

origen.boot.get_line_buffer

Return the current contents of the line buffer.

origen.boot.insert_text

Insert text into the command line.

origen.boot.clear_history

Clear readline history

origen.boot.read_init_file

Parse a readline initialization file. The default filename is the last filename used.

origen.boot.read_history_file

Load a readline history file. The default filename is ~/.history.

origen.boot.write_history_file

Save a readline history file. The default filename is ~/.history.

origen.boot.get_current_history_length

Return the number of lines currently in the history. (This is different from get_history_length(), which returns the maximum number of lines that will be written to a history file.)

origen.boot.get_history_length

Return the desired length of the history file.

Negative values imply unlimited history file size.

origen.boot.get_history_item

Return the current contents of history item at index.

origen.boot.set_history_length

Set the number of lines to save in the history file.

write_history_file() uses this value to truncate the history file when saving. Negative values imply unlimited history file size.

origen.boot.set_startup_hook

Set or remove the startup_hook function.

If function is specified, it will be used as the new startup_hook function; if omitted or None, any hook function already installed is removed. The startup_hook function is called with no arguments just before readline prints the first prompt.

origen.boot.set_pre_input_hook

Set or remove the pre_input_hook function.

If function is specified, it will be used as the new pre_input_hook function; if omitted or None, any hook function already installed is removed. The pre_input_hook function is called with no arguments after the first prompt has been printed and just before readline starts reading input characters.

origen.boot.set_completer

Set or remove the completer function.

If function is specified, it will be used as the new completer function; if omitted or None, any completer function already installed is removed. The completer function is called as function(text, state), for state in 0, 1, 2, …, until it returns a non-string value. It should return the next possible completion starting with text.

origen.boot.get_completer

Get the completer function.

origen.boot.get_begidx

Get the beginning index of the readline tab-completion scope.

origen.boot.get_endidx

Get the ending index of the readline tab-completion scope.

origen.boot.set_completer_delims

Set the readline word delimiters for tab-completion.

origen.boot.get_completer_delims

Get the readline word delimiters for tab-completion.

origen.boot.add_history

Append a line to the history buffer, as if it was the last line typed.

origen.boot.callback_handler_install

bool readline_callback_handler_install ( string prompt, callback callback) Initializes the readline callback interface and terminal, prints the prompt and returns immediately

origen.boot.callback_handler_remove

Removes a previously installed callback handler and restores terminal settings

origen.boot.callback_read_char

Reads a character and informs the readline callback interface when a line is received

origen.boot.rl

Baseclass for readline based on a console