Default Theme Functions

These functions are designed to be used by the default theme, but are documented here so that other themes can use these functions to reduce duplication if sections from the default theme are wanted.

Theme Functions

_lp_default_theme_activate()

Setup the defaults and static pieces of the default theme.

Uses colors:

And marks:

New in version 2.0.

_lp_default_theme_directory()

Setup the colors for the directory when the current working directory changes.

Uses colors:

And mark LP_MARK_PERM.

New in version 2.0.

_lp_default_theme_prompt()

Runs _lp_default_theme_prompt_data() then _lp_default_theme_prompt_template().

New in version 2.0.

_lp_default_theme_prompt_data()

Runs all of the below theme data functions, and writes values to the Default Theme variables. Can be used to generate all the default theme sections, then modify them before running a user template.

New in version 2.0.

_lp_default_theme_prompt_template()

If LP_PS1_FILE is set, sources it.

Then, if LP_PS1 is set, uses it as PS1. Otherwise, uses the default theme layout to construct PS1. Can be used to set different template sections than the default theme, but still use the same template engine.

New in version 2.0.

Theme Data Functions

These functions wrap Data Functions with color and/or other formatting. Their return codes are the same as the data functions they wrap unless otherwise documented.

The interface of the functions will not change between minor versions, but the specific text and formatting may change.

_lp_analog_time_color() var:lp_analog_time_color

Returns _lp_analog_time() with color from LP_COLOR_TIME.

New in version 2.0.

_lp_aws_profile_color() var:lp_aws_profile_color

Returns _lp_aws_profile() with color from LP_COLOR_AWS_PROFILE.

New in version 2.1.

_lp_battery_color() var:lp_battery_color

Returns data from _lp_battery(), colored with:

And using marks:

Adds battery value if LP_PERCENTS_ALWAYS is 1.

Changed in version 2.0: Return code matches data function. Return method changed from stdout.

_lp_container_color() var:_lp_container_color

Returns _lp_container(), surrounded by « and » colored with LP_COLOR_CONTAINER if the value is true. Returns no data if the value is false.

New in version 2.1.

_lp_dirstack_color() var:lp_dirstack_color

Returns _lp_dirstack(), prefixed with LP_MARK_DIRSTACK, all colored with LP_COLOR_DIRSTACK.

New in version 2.0.

_lp_error_color() var:lp_error_color

Returns _lp_error() with color from LP_COLOR_ERR.

New in version 2.0.

_lp_hostname_color() var:lp_hostname_color

Returns _lp_hostname(), with added data from _lp_chroot(). Color from LP_COLOR_HOST, LP_COLOR_SSH, LP_COLOR_HOST_HASH, and LP_COLOR_TELNET, depending on the output of _lp_connection().

Added color from _lp_connected_display(): either LP_COLOR_X11_ON or LP_COLOR_X11_OFF.

Return code is _lp_hostname() ORed with _lp_chroot(): both must return no data for _lp_hostname_color() to return no data.

New in version 2.0.

_lp_http_proxy_color() var:lp_http_proxy_color

Returns _lp_http_proxy() with color from LP_COLOR_PROXY.

New in version 2.0.

_lp_jobcount_color() var:lp_jobcount_color

Returns _lp_detached_sessions() with color from LP_COLOR_JOB_D and _lp_jobcount() with colors from LP_COLOR_JOB_R and LP_COLOR_JOB_Z.

Return code is _lp_detached_sessions() ORed with _lp_jobcount(): both must return no data for _lp_jobcount_color() to return no data.

Changed in version 2.0: Return code matches data function. Return method changed from stdout.

_lp_kubernetes_context_color() var:lp_kubernetes_context_color

Returns data from _lp_kubernetes_context(), colored with LP_COLOR_KUBECONTEXT and using mark LP_MARK_KUBECONTEXT.

New in version 2.1.

_lp_load_color() var:lp_load_color

Returns _lp_load() with color from LP_COLORMAP and mark from LP_MARK_LOAD.

Adds load value if LP_PERCENTS_ALWAYS is 1.

Changed in version 2.0: Return code matches data function. Return method changed from stdout.

_lp_node_env_color() var:lp_node_env_color

Returns _lp_node_env() with color from LP_COLOR_NODE_VENV.

New in version 2.1.

_lp_python_env_color() var:lp_python_env_color

Returns _lp_python_env() with color from LP_COLOR_VIRTUALENV.

New in version 2.0.

_lp_ruby_env_color() var:lp_ruby_env_color

Returns _lp_ruby_env() with color from LP_COLOR_RUBY_VENV.

New in version 2.1.

_lp_runtime_color() var:lp_runtime_color

Returns _lp_runtime_format() with color from LP_COLOR_RUNTIME.

Changed in version 2.0: Renamed from _lp_runtime. Return code matches data function. Return method changed from stdout.

_lp_shell_level_color() var:lp_shell_level_color

Returns _lp_shell_level(), prefixed with LP_MARK_SHLVL, all colored with LP_COLOR_SHLVL.

New in version 2.1.

_lp_software_collections_color() var:lp_software_collections_color

Returns _lp_software_collections() with color from LP_COLOR_VIRTUALENV.

New in version 2.0.

_lp_sudo_active_color() var:lp_sudo_active_color

Returns _lp_sudo_active() with color and marks from LP_COLOR_MARK_SUDO if sudo is active, or LP_COLOR_MARK_NO_SUDO if not.

Does not return 1 if sudo is not active, as the return string is still needed.

Changed in version 2.0: Renamed from _lp_sudo_check. Always defined instead of only when LP_ENABLE_SUDO is enabled. Return variable changed from LP_COLOR_MARK.

_lp_temperature_color() var:lp_temperature_color

Returns _lp_temperature() with color from LP_COLORMAP and mark from LP_MARK_TEMP.

Changed in version 2.0: Renamed from _lp_temperature. Return code matches data function. Return method changed from stdout.

_lp_terraform_env_color() var:lp_terraform_env_color

Returns _lp_terraform_env() with color from LP_COLOR_TERRAFORM.

New in version 2.1.

_lp_time_color() var:lp_time_color

Returns _lp_time() with color from LP_COLOR_TIME.

New in version 2.0.

_lp_vcs_details_color() var:lp_vcs_details_color

Returns data from all generic Version Control Data Functions, colored with:

And using marks:

This function should only be called when in a VCS repository; use _lp_find_vcs() or _lp_vcs_active() before.

The return code is undefined; a string should always be returned.

New in version 2.0.

_lp_wifi_signal_strength_color() var:lp_wifi_signal_strength_color

Returns _lp_wifi_signal_strength() with color from LP_COLORMAP and mark from LP_MARK_WIFI.

New in version 2.1.