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.
_lp_default_theme_activate()
Setup the defaults and static pieces of the default theme.
Uses colors:
LP_COLOR_IN_MULTIPLEXER
LP_COLOR_MARK
LP_COLOR_MARK_ROOT
LP_COLOR_PATH_ROOT
LP_COLOR_USER_ALT
LP_COLOR_USER_LOGGED
LP_COLOR_USER_ROOT
And marks:
LP_MARK_BRACKET_OPEN
LP_MARK_BRACKET_CLOSE
LP_MARK_DEFAULT
2.0
_lp_default_theme_directory()
Setup the colors for the directory when the current working directory changes.
Uses colors:
LP_COLOR_NOWRITE
LP_COLOR_PATH
LP_COLOR_WRITE
And mark LP_MARK_PERM
.
2.0
_lp_default_theme_prompt()
Runs _lp_default_theme_prompt_data
then _lp_default_theme_prompt_template
.
2.0
_lp_default_theme_prompt_data()
Runs all of the below theme data functions, and writes values to the ../theme/default
variables. Can be used to generate all the default theme sections, then modify them before running a user template.
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.
2.0
These functions wrap data
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
.
2.0
_lp_aws_profile_color() -> var:lp_aws_profile_color
Returns _lp_aws_profile
with color from LP_COLOR_AWS_PROFILE
.
2.1
2.2 No longer include squared brackets, superseded by LP_MARK_DEV_OPEN
, LP_MARK_DEV_MID
and LP_MARK_DEV_CLOSE
.
_lp_battery_color() -> var:lp_battery_color
Returns data from _lp_battery
, colored with:
LP_COLOR_CHARGING_ABOVE
LP_COLOR_CHARGING_UNDER
LP_COLOR_DISCHARGING_ABOVE
LP_COLOR_DISCHARGING_UNDER
LP_COLORMAP
And using marks:
LP_MARK_ADAPTER
LP_MARK_BATTERY
Adds battery value if LP_PERCENTS_ALWAYS
is 1
.
2.0 Return code matches data function. Return method changed from stdout.
_lp_cmake_color() -> var:lp_cmake_color
Returns data from _lp_cmake
. lp_cmake_compiler and lp_cmake_generator are colored according to their hash (see _lp_hash_color
). lp_cmake_buildtype has as configurable color, depending on its value:
- Debug, colored with
LP_COLOR_CMAKE_DEBUG
(magenta, by default), - RelWithDebInfo, colored with
LP_COLOR_CMAKE_RWDI
(blue, by default), - Release, colored with
LP_COLOR_CMAKE_RELEASE
(cyan, by default), - any other value would be colored according to its hash.
2.2
_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.
2.1
2.2 No longer include squared brackets, superseded by LP_MARK_DEV_OPEN
, LP_MARK_DEV_MID
and LP_MARK_DEV_CLOSE
.
_lp_dev_env_color() -> var:lp_dev_env_color
Assemble data related to development environment and returns a single string. The returned string starts with LP_MARK_DEV_OPEN
and ends with LP_MARK_DEV_CLOSE
, with each section separated by LP_MARK_DEV_MID
.
Data are collected from:
LP_SCLS
LP_AWS_PROFILE
LP_CONTAINER
LP_VENV
LP_NODE_VENV
LP_PERL_VENV
LP_RUBY_VENV
LP_TFSPACE
LP_KUBECONTEXT
LP_CMAKE
2.2
_lp_dirstack_color() -> var:lp_dirstack_color
Returns _lp_dirstack
, prefixed with LP_MARK_DIRSTACK
, all colored with LP_COLOR_DIRSTACK
.
2.0
_lp_disk_color() -> var:lp_disk_color
Returns information about available space of the hard drive hosting the current directory.
If LP_ALWAYS_DISPLAY_VALUES
is false
, displays a colored mark (using LP_MARK_DISK
), if the available disk space goes below LP_DISK_THRESHOLD
or LP_DISK_THRESHOLD_PERC
. If it is true
, displays the corresponding value, either as a percentage (if LP_DISPLAY_VALUES_AS_PERCENTS
is true
) or as a human-readable quantity (if LP_DISPLAY_VALUES_AS_PERCENTS
is false
).
The mark and the value itself are colored with LP_COLOR_DISK
, while the unit is colored with LP_COLOR_DISK_UNITS
.
2.2
_lp_env_vars_color() -> var:lp_env_vars_color
Returns the elements of the array set by _lp_env_vars
, joined with the LP_MARK_ENV_VARS_SEP
marker, and surrounded by LP_MARK_ENV_VARS_OPEN
and LP_MARK_ENV_VARS_CLOSE
.
If a matching environment variable is set, it is colored with LP_COLOR_ENV_VARS_SET
, if it is unset, it is colored with LP_COLOR_ENV_VARS_UNSET
.
See also LP_ENV_VARS
.
2.2
_lp_error_color() -> var:lp_error_color
Returns _lp_error
with color from LP_COLOR_ERR
.
2.0
_lp_error_meaning_color() -> var:lp_error_meaning_color
Returns _lp_error_meaning
with color from LP_COLOR_ERR
and surrounded by parentheses.
2.2
_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.
2.0
_lp_http_proxy_color() -> var:lp_http_proxy_color
Returns _lp_http_proxy
with color from LP_COLOR_PROXY
.
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.
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
.
2.1
2.2 No longer include squared brackets, superseded by LP_MARK_DEV_OPEN
, LP_MARK_DEV_MID
and LP_MARK_DEV_CLOSE
.
_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
.
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
.
2.1
2.2 No longer include squared brackets, superseded by LP_MARK_DEV_OPEN
, LP_MARK_DEV_MID
and LP_MARK_DEV_CLOSE
.
_lp_os_color() -> var:lp_os_color
Gather information about the Operating System.
Any string encountered in the process may be replaced by a user-defined counterpart, using the LP_MARK_OS
configuration array.
If the string was not replaced, it is colored with a random color depending on its hash (see _lp_hash_color
).
All fields gathered via the _lp_os
function are joined with the LP_MARK_OS_SEP
string, in the following order: arch, family, kernel, distribution, codename. The corresponding data are returned as a single string via the lp_os_color
variable.
The function returns 2
if the user disabled the feature with LP_ENABLE_OS
, 1
if no field was filled in with data, and true
otherwise.
2.2
_lp_python_env_color() -> var:lp_python_env_color
Returns _lp_python_env
with color from LP_COLOR_VIRTUALENV
.
2.0
2.2 No longer include squared brackets, superseded by LP_MARK_DEV_OPEN
, LP_MARK_DEV_MID
and LP_MARK_DEV_CLOSE
.
_lp_ram_color() -> var:lp_ram_color
Returns information about available RAM.
If LP_ALWAYS_DISPLAY_VALUES
is false
, displays a colored mark (using LP_MARK_RAM
), if the available ram goes below LP_RAM_THRESHOLD
or LP_RAM_THRESHOLD_PERC
. If it is true
, displays the corresponding value, either as a percentage (if LP_DISPLAY_VALUES_AS_PERCENTS
is true
) or as a human-readable quantity (if LP_DISPLAY_VALUES_AS_PERCENTS
is false
).
The mark and the value itself are colored with LP_COLOR_RAM
, while the unit is colored with LP_COLOR_RAM_UNITS
.
2.2
_lp_perl_env_color() -> var:lp_perl_env_color
Returns _lp_perl_env
with color from LP_COLOR_PERL_VENV
.
2.2
_lp_ruby_env_color() -> var:lp_ruby_env_color
Returns _lp_ruby_env
with color from LP_COLOR_RUBY_VENV
.
2.1
2.2 No longer include squared brackets, superseded by LP_MARK_DEV_OPEN
, LP_MARK_DEV_MID
and LP_MARK_DEV_CLOSE
.
_lp_runtime_color() -> var:lp_runtime_color
Returns _lp_runtime_format
with color from LP_COLOR_RUNTIME
.
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
.
2.1
_lp_software_collections_color() -> var:lp_software_collections_color
Returns _lp_software_collections
with color from LP_COLOR_VIRTUALENV
.
2.0
2.2 No longer include squared brackets, superseded by LP_MARK_DEV_OPEN
, LP_MARK_DEV_MID
and LP_MARK_DEV_CLOSE
.
_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.
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
.
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
.
2.1
2.2 No longer include squared brackets, superseded by LP_MARK_DEV_OPEN
, LP_MARK_DEV_MID
and LP_MARK_DEV_CLOSE
.
_lp_time_color() -> var:lp_time_color
Returns _lp_time
with color from LP_COLOR_TIME
.
2.0
_lp_vcs_details_color() -> var:lp_vcs_details_color
Returns data from all generic data/vcs
, colored with:
LP_COLOR_CHANGES
LP_COLOR_COMMITS
LP_COLOR_COMMITS_BEHIND
LP_COLOR_DIFF
LP_COLOR_UP
And using marks:
LP_MARK_STASH
LP_MARK_UNTRACKED
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.
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
.
2.1