Variable: ghostel-progress-function

ghostel-progress-function is a customizable variable defined in ghostel.el.

Value

ghostel-default-progress

Documentation

Function called for ConEmu OSC 9;4 progress reports.

Called with two arguments: STATE (one of the symbols remove, set, error, indeterminate, pause) and PROGRESS (an integer
0-100, or nil when not reported). Set to nil to ignore progress
reports.

When spinner.el is on the load-path at ghostel load time, the default is ghostel-spinner-progress (which animates the mode line during indeterminate progress). Otherwise it is ghostel-default-progress (a plain text indicator).

The handler runs synchronously on the VT-parser callpath because progress updates are expected to feed the mode line or similar cheap UI. A slow handler here will stall terminal output — defer expensive work via run-at-time on your own if you need it.

Source Code

;; Defined in /nix/store/1252krff0gb2kisjcpp45m50cpdskfrl-emacs-packages-deps/share/emacs/site-lisp/ghostel.el
(defcustom ghostel-progress-function
  (if (locate-library "spinner")
      #'ghostel-spinner-progress
    #'ghostel-default-progress)
  "Function called for ConEmu OSC 9;4 progress reports.
Called with two arguments: STATE (one of the symbols `remove',
`set', `error', `indeterminate', `pause') and PROGRESS (an integer
0-100, or nil when not reported).  Set to nil to ignore progress
reports.

When spinner.el is on the `load-path' at ghostel load time, the
default is `ghostel-spinner-progress' (which animates the mode
line during indeterminate progress).  Otherwise it is
`ghostel-default-progress' (a plain text indicator).

The handler runs synchronously on the VT-parser callpath because
progress updates are expected to feed the mode line or similar
cheap UI.  A slow handler here will stall terminal output — defer
expensive work via `run-at-time' on your own if you need it."
  :type '(choice (const :tag "Disabled" nil) function))