save

Author: Vasiliy Polyakov

README.md

@@ -25,4 +25,5 @@
 ## Links
 
 - [GNU Bash Manual](https://www.gnu.org/software/bash/manual/)
+- [Advanced Bash-Scripting Guide](https://tldp.org/LDP/abs/html/)
 - [Google Shell Style Guide](https://google.github.io/styleguide/shell.xml)

lib.bash

@@ -1,15 +1,15 @@
 ## @file    $XDG_DATA_HOME/bash/lib.bash
 ## @brief   Bash scripting library.
 ## @author  Vasiliy Polyakov
-## @date    2016-2019
+## @date    2016-2020
 ## @pre     bash>=4.0  (GNU Bourne again shell).
 ## @pre     coreutils  (@c dirname, @c realpath).
 ## @pre     doxygen    (for API reference, optional).
 
 ####  Source guard  #######################################################@{1
-[ x"$BASH_VERSION" = x ] && return 1  # Current shell is not Bash
-[[ -n $BASH_LIB ]] && return 0  # Library was already sourced
-(( BASH_VERSINFO[0] < 4 )) && return 2  # Bash version is not supported
+[ x"$BASH_VERSION" = x ] && return 1              # Current shell is not Bash
+[[ -n $BASH_LIB ]] && return 0                    # Library was already sourced
+(( BASH_VERSINFO[0] < 4 )) && return 2            # Bash version is not supported
 type -p dirname realpath &>/dev/null || return 3  # Coreutils are not installed
 
 # shellcheck disable=SC2155
@@ -35,7 +35,7 @@ _lib::init() {
 ## @retval    1  Library was already imported.
 ## @retval  125  This library was not imported correctly.
 ## @retval  126  Bash lib was not initialized correctly.
-## @retval  127  'library: command not found' (returned by Bash itself).
+## @retval  127  'bash_lib: command not found' (returned by Bash itself).
 bash_lib() {
   [ x"$BASH_LIB" = x ] && return 126
 
@@ -70,9 +70,9 @@ import() {
   # Try to add a filename suffix
   [[ ! -f "$lib" ]] && lib+='.sh'
 
-  [[ -r $lib ]] || return 2
+  [[ -r "$lib" ]] || return 2
 
-  # shellcheck source=lib/*.sh
+  # shellcheck source=/dev/null
   source "$lib" "$@"
 }
 

lib/colors.sh

@@ -43,7 +43,7 @@ SGR() {
   local OPT OPTARG E='-e' P0='' P1=''
   local -i OPTIND
   local -a A C C8 C16 C256
-  
+
   while getopts ':Ep' OPT; do
     case $OPT in
       E) E='' ;;
@@ -67,21 +67,21 @@ SGR() {
       bold|b) A+=(1) ;;
       dim) A+=(2) ;;
       italics|i) A+=(3) ;;
-      underline|undescore|uline|ul|u) A+=(4) ;;
+      underline|underscore|uline|ul|u) A+=(4) ;;
       blink) A+=(5) ;;
       reverse|inverse) A+=(7) ;;
       normal|n) A+=(22) ;;
       +([0-9])) A+=($1)
     esac; shift
   done
-  
+
   local -n c="C$COLORS"
   if (( ${#c[@]} )); then
     A+=("${c[@]}")
   else
     A+=("${C[@]}")
   fi
-  
+
   if (( ${#A[@]} )); then
     local IFS=';'
     echo -n $E "$P0\e[${A[*]}m$P1"

lib/exceptions.sh

@@ -10,9 +10,10 @@ bash_lib || return $(($?-1))
 import sysexits
 
 ####  Private functions  ##################################################@{1
+# shellcheck disable=SC1004
 _exceptions::init() {
-  ## Throw exception if there is non-zero status.
-  declare -gi EXCEPTIONS_ERREXIT="${1:-0}"
+  # shellcheck disable=SC2034
+  declare -gi EXCEPTIONS_ERREXIT="${1:-0}"  ##< Throw exception if there is non-zero status.
 
   declare -gA _error  ##< Error info. Set by ERR trap handler.
   _error[code]=0      ##< Exit/return code (0..255) (@see sysexits.bash).
@@ -79,11 +80,11 @@ _exceptions::match() {
 
   local n c conditions=0  # Sic! It's a zero here. Don't touch!
 
-  for n in ${1//*([ \t]);*([ \t])/ }; do
+  for n in ${1//*([ 	]);*([ 	])/ }; do
     case $n in
       $EX_NAMES) c="(_exc[code]==${EX[$n]})" ;;
       +([0-9]))  c="(_exc[code]==$n)"        ;;
-      +([0-9])*([ \t])-*([ \t])+([0-9]))
+      +([0-9])*([ 	])-*([ 	])+([0-9]))
         c="(_exc[code]>=${n%%*([ \t])-*([ \t])+([0-9])}&&"
         c+="_exc[code]<=${n##+([0-9])*([ \t])-*([ \t])})"
         ;;
@@ -118,6 +119,7 @@ _exceptions::handler() {
   return 0
 }
 
+# shellcheck disable=SC2034
 _exceptions::try() {
   (( _try_level++ ))
   _try_source[_try_level]="${BASH_SOURCE[1]}"
@@ -130,9 +132,9 @@ _exceptions::try() {
 }
 
 _exceptions::end_try() {
-  (( _try_level )) || return ${EX[SOFTWARE]}
+  (( _try_level )) || return "${EX[SOFTWARE]}"
 
-  unset _try_source[_try_level] _try_func[_try_level] _try_line[_try_level]
+  unset '_try_source[_try_level]' '_try_func[_try_level]' '_try_line[_try_level]'
   (( _try_level-- ))
 
   _exc_patterns=() _exc_handlers=()
@@ -146,9 +148,9 @@ alias end_try='break; done; _exceptions::end_try '
 
 catch() {
   if (( _try_level == 0 )); then
-    return ${EX[SOFTWARE]}
+    return "${EX[SOFTWARE]}"
   elif [[ -z $1 || -z $2 ]]; then
-    return ${EX[USAGE]}
+    return "${EX[USAGE]}"
   fi
 
   _exc_patterns+=("$1"); shift
@@ -158,12 +160,12 @@ catch() {
 }
 
 throw() {
-  local -- OPT OPTARG k r=
-  local -i OPTIND depth=1 i
+  local -- OPT OPTARG r=
+  local -i OPTIND OPTERR=0 depth=1 i
 
   # Default values for exception parameters
   _exc[code]=1 _exc[continue]=0 _exc[handled]=0
-  _exc[msg]= _exc[arg]= _exc[source]= _exc[func]= _exc[line]=
+  _exc[msg]='' _exc[arg]='' _exc[source]='' _exc[func]='' _exc[line]=''
   _exc_callstack=()
 
   # Process options
@@ -184,9 +186,9 @@ throw() {
   (( OPTIND > 1 )) && shift $(( OPTIND - 1 ))
 
   if (( depth >= 1 )); then
-    : ${_exc[source]:=${BASH_SOURCE[depth]}}
-    : ${_exc[func]:=${FUNCNAME[depth]}}
-    : ${_exc[line]:=${BASH_LINENO[depth-1]}}
+    : "${_exc[source]:=${BASH_SOURCE[depth]}}"
+    : "${_exc[func]:=${FUNCNAME[depth]}}"
+    : "${_exc[line]:=${BASH_LINENO[depth-1]}}"
   fi
 
   # Error message (format string).
@@ -212,13 +214,14 @@ throw() {
 perror() {
   (( _exc[code] )) || return 0
 
-  local source= msg
+  local source='' msg
 
   if [[ $1 == '-s' ]]; then
     source=" <${_exc[code]}> at '$(relpath "${_exc[source]}")':${_exc[line]}"
     shift
   fi
 
+  # shellcheck disable=SC2059
   msg="$(printf "${_exc[msg]}" "${_exc_args[@]}")"
   echo -e "${1:+$1: }$msg$source" >&2
 
@@ -228,7 +231,7 @@ perror() {
 confess() {
   (( _exc[code] )) || return 0
 
-  local func caller s=
+  local func caller s=''
 
   perror -s "$1"
   for func in "${_exc_callstack[@]}"; do

lib/git.sh

@@ -1,7 +1,7 @@
 ## @file    $XDG_DATA_HOME/bash/lib/git.sh
 ## @brief   Bash functions for Git.
 ## @author  Vasiliy Polyakov
-## @date    2019
+## @date    2019-2020
 ## @pre     lib.bash  (Bash scripting library).
 ## @pre     Git       (Git VCS).
 
@@ -15,15 +15,15 @@ git::in_work_tree() {
 git::in_git_dir() {
   local inside="$(git rev-parse --is-inside-git-dir 2>/dev/null)"
   [[ $inside == 'true' ]]
-
 }
 
 git::dir() {
   git rev-parse --git-dir 2>/dev/null
 }
 
 git::branch() {
-  git rev-parse --abbrev-ref --symbolic-full-name @
+  local branch="$(git rev-parse --abbrev-ref --symbolic-full-name @ 2>/dev/null)"
+  [[ $branch == '@' ]] && echo "$(_ "<no commits>")" || echo "$branch"
 }
 
 git::remote() {

lib/prompt.sh

@@ -73,38 +73,41 @@ prompt::vcs() {
 prompt::cmd() {
   history -a
 
-  if [[ -n $MC_SID ]]; then
-    # In Midnight Commander
+  if [[ -n $MC_SID ]]; then # in Midnight Commander
     PS1='\u@\h:\w\$ '
     return
   fi
 
-  local R="\[$SGR0\]" TSL='\[\e]2;' FSL='\e\\\]' x u='user'
+  local R="\[$SGR0\]" TSL='\[\e]2;' FSL='\e\\\]' u='user'
   local user at host dir venv char title chroot
-  (( EUID )) || u='root'  # Superuser
+  (( EUID )) || u='root' # Superuser
 
   # Set prompt fragments
   user="${PROMPT_COLOR[$u]}\u$R"
   at="${PROMPT_CHAR[at]}"
   host="${PROMPT_COLOR[host]}\h$R"
   dir="${PROMPT_COLOR[dir]}\w$R"
   char="${PROMPT_COLOR[$u]}${PROMPT_CHAR[$u]}$R"
+  title="$PROMPT_TITLE"
 
-  if [[ -n $SSH_TTY ]]; then
-    # Connected over SSH
+  if [[ -n $SSH_TTY ]]; then # connected over SSH
     at="${PROMPT_COLOR[ssh]}${PROMPT_CHAR[at]}$R"
-    [[ -n $PROMPT_TITLE ]] && PROMPT_TITLE="[SSH] $PROMPT_TITLE"
+    [[ -n $title ]] && title="[SSH] $title"
   fi
-  if [[ -n $VIRTUAL_ENV ]]; then
-    # Python virtual environment is activated
+  if [[ -n $VIRTUAL_ENV ]]; then # in Python virtual environment
     venv=" (${PROMPT_COLOR[venv]}$(relpath "$VIRTUAL_ENV")$R)"
   fi
 
-  title="${PROMPT_TITLE:+$TSL$PROMPT_TITLE$FSL}"
+  title="${title:+$TSL$title$FSL}"
   chroot="${debian_chroot:+($debian_chroot) }"
 
   # Set prompt
   PS1="$title╭$chroot$user$at$host:$dir$(prompt::vcs)$venv\n╰$char "
 
-  echo -en '\e[6n' && read -sdR x && (( ${x##*;} > 1 )) && echo
+  local stty column
+  stty="$(stty -g)" && stty raw -echo min 0 \
+  && echo -en '\e[6n' && read -sdR column \
+  && stty "$stty" && (( ${column##*;} > 1 )) && echo
 }
+
+# vim: set et sw=2 ts=2: