Adding HSL colors to credits.

Author: Chad Juliano

src/biw-main.sh

@@ -5,23 +5,28 @@
 # 
 # Licensed under GNU Lesser General Public License v3.0 only. Some rights
 # reserved. See LICENSE.
+#
+# File:         biw-main.sh
+# Description:  Top-level script for panel menus.
 ##
 
 # generate errors if unset vars are used.
 set -o nounset
 
 source ${BIW_HOME}/biw-term-csi.sh
 source ${BIW_HOME}/biw-term-sgr.sh
+source ${BIW_HOME}/biw-term-hsl.sh
 source ${BIW_HOME}/biw-theme.sh
-source ${BIW_HOME}/biw-vmenu.sh
-source ${BIW_HOME}/biw-hmenu.sh
-source ${BIW_HOME}/biw-credits.sh
+source ${BIW_HOME}/biw-panel-vmenu.sh
+source ${BIW_HOME}/biw-panel-hmenu.sh
+source ${BIW_HOME}/biw-panel-credits.sh
 
+declare -r BIW_VERSION=0.9
 declare -ri BIW_ENABLE_DEBUG=0
 
 # global widget params
 declare -ri BIW_MARGIN=10
-declare -ri BIW_PANEL_HEIGHT=9
+declare -ri BIW_PANEL_HEIGHT=10
 declare -ri BIW_PANEL_WIDTH=50
 
 # max values to load for history and file lists
@@ -309,11 +314,9 @@ function fn_biw_panic()
     local _fail_line=${BASH_LINENO[0]}
     local _command=$BASH_COMMAND
 
-    # show cursor
+    # show and restore cursor
     fn_csi_op $CSI_OP_CURSOR_SHOW
-
-    # restore default colors
-    fn_sgr_set $SGR_ATTR_DEFAULT
+    fn_csi_op $CSI_OP_CURSOR_RESTORE
 
     echo
     echo "PANIC Failure at: "

src/biw-credits.sh renamed to src/biw-panel-credits.sh

@@ -4,6 +4,9 @@
 # 
 # Licensed under GNU Lesser General Public License v3.0 only. Some rights
 # reserved. See LICENSE.
+#
+# File:         biw-panel-credits.sh
+# Description:  Panel for animated credits.
 ##
 
 # constants
@@ -26,6 +29,7 @@ declare -i cred_canvas_height
 
 declare -a cred_color_map
 declare -i cred_color_map_size
+declare -i cred_color_use_216=0
 declare -a cred_alpha_map
 
 function fn_cred_show()
@@ -43,22 +47,54 @@ function fn_cred_show()
 
     cred_alpha_map[cred_canvas_width]=0
 
+    # Use one of 3 color map types:
+    fn_color_map_hsl_hue
+    #fn_color_map_hsl_saturation
+    #fn_color_map_simple
+
+    cred_color_map_size=${#cred_color_map[@]}
+
     fn_cred_blank_panel
     fn_cred_load_data
-    fn_generate_color_map
+    
     fn_cred_print_data
 
     # if animation was canceled then we get a non-zero status
     return $?
 }
 
-function fn_generate_color_map()
+function fn_cred_load_data()
+{
+    mapfile -n${cred_height} -t cred_line_data <<-EOM
+
+BIW - Bash Inline Widgets
+Version ${BIW_VERSION}
+Copyright 2017 by Chad Juliano
+[email protected]
+
+Find it at:
+https://github.com/chadj2/biw-tools
+EOM
+
+    cred_line_data_size=${#cred_line_data[*]}
+}
+
+function fn_cred_set_color()
 {
-    fn_theme_get_sgr $SGR_ATTR_FG $TATTR_TEXT
-    _sgr_text_color=$(($? - SGR_ATTR_FG))
+    local -i _sgr_color=$1
+    if((cred_color_use_216))
+    then
+        fn_sgr_color216_set $SGR_ATTR_FG $_sgr_color
+    else
+        fn_sgr_color16_set $SGR_ATTR_FG $_sgr_color
+    fi
+}
 
+function fn_color_map_simple()
+{
     cred_color_map=(
-        [1]=$_sgr_text_color
+        [0]=0
+        [1]=$SGR_COL_GREEN
         [2]=$SGR_COL_YELLOW
         [3]=$SGR_COL_YELLOW
         [4]=$SGR_COL_YELLOW
@@ -71,8 +107,63 @@ function fn_generate_color_map()
         [11]=$SGR_COL_YELLOW
         [12]=$SGR_COL_YELLOW
     )
+}
 
-    cred_color_map_size=${#cred_color_map[@]}
+function fn_color_map_hsl_hue()
+{
+    local -ir _hsl_sat=4
+    local -ir _hsl_light=5
+
+    local -i _hsl_hue
+    local -i _sgr_code
+    local -i _map_idx=0
+
+    # 0 index is reserved
+    cred_color_use_216=1
+    cred_color_map=()
+    cred_color_map[_map_idx++]=0
+
+    for((_hsl_hue = HSL_HUE_GREEN; _hsl_hue <= HSL_HUE_BLUE; _hsl_hue++))
+    do
+        fn_hsl_get $_hsl_hue $_hsl_sat $_hsl_light
+        _sgr_code=$?
+
+        for((_hsl_sat_length = 0; _hsl_sat_length <= 1; _hsl_sat_length++))
+        do
+            cred_color_map[_map_idx++]=$_sgr_code
+        done
+    done
+}
+
+function fn_color_map_hsl_saturation()
+{
+    # move through the HSL cylinder on hue=12 (120 degrees)
+    local -ir _max_hsl_hue=3
+    local -ir _min_hsl_hue=-5
+    local -ir _hsl_hue=12
+    local -ir _hsl_light=5
+
+    local -i _hsl_sat
+    local -i _sgr_code
+    local -i _map_idx=0
+
+    # 0 index is reserved
+    cred_color_use_216=1
+    cred_color_map=()
+    cred_color_map[_map_idx++]=0
+
+    # go through cylinder from the color indicated by hue to its inverse.
+    # we go from partially saturated green (sat=3) because (sat=5) is too deep.
+    for((_hsl_sat = _max_hsl_hue; _hsl_sat >= _min_hsl_hue; _hsl_sat--))
+    do
+        fn_hsl_get $_hsl_hue $_hsl_sat $_hsl_light
+        _sgr_code=$?
+
+        for((_hsl_sat_length = 0; _hsl_sat_length <= 4; _hsl_sat_length++))
+        do
+            cred_color_map[_map_idx++]=$_sgr_code
+        done
+    done
 }
 
 function fn_cred_print_data()
@@ -184,7 +275,7 @@ function fn_cred_animate_text()
     # add characters to the alpha map
     if((_char_idx < _line_width))
     then
-        cred_alpha_map[_char_idx]=${#cred_color_map[@]}
+        cred_alpha_map[_char_idx]=$((cred_color_map_size - 1))
     else
         return 1
     fi
@@ -205,7 +296,7 @@ function fn_cred_animate_cursor()
     fn_biw_set_col_pos $_cursor_pos
 
     local _sgr_color=${cred_color_map[cred_color_map_size - 1]}
-    fn_sgr_set $((SGR_ATTR_FG + _sgr_color))
+    fn_cred_set_color $_sgr_color
 
     if((_cursor_counter <= 0))
     then
@@ -271,7 +362,7 @@ function fn_cred_print_alpha()
         fi
 
         _alpha_color=${cred_color_map[_alpha_val]}
-        fn_sgr_set $((SGR_ATTR_FG + _alpha_color))
+        fn_cred_set_color $_alpha_color
 
         _char_val=${_line_val:_alpha_idx:1}
         fn_sgr_print "${_char_val}"
@@ -286,20 +377,6 @@ function fn_cred_print_alpha()
     return 0
 }
 
-function fn_cred_load_data()
-{
-    mapfile -n${cred_height} -t cred_line_data <<-EOM
-
-BIW - Bash Inline Widgets
-Copyright 2017 by Chad Juliano
-[email protected]
-
-Find it at:
-https://github.com/chadj2/biw-tools
-EOM
-
-    cred_line_data_size=${#cred_line_data[*]}
-}
 
 function fn_cred_canvas_set_cursor()
 {
@@ -309,7 +386,7 @@ function fn_cred_canvas_set_cursor()
         $((cred_canvas_row_pos + _row_pos)) \
         $((cred_canvas_col_pos + _col_pos))
 
-    fn_theme_set_bg_attr $TATTR_BG_INACTIVE
+    fn_theme_set_attr $TATTR_BG_INACTIVE
 }
 
 function fn_cred_blank_panel()
@@ -322,7 +399,7 @@ function fn_cred_blank_panel()
         fn_biw_set_cursor_pos $_row_pos 0
 
         fn_sgr_seq_start
-        fn_theme_set_bg_attr $TATTR_BG_INACTIVE
+        fn_theme_set_attr $TATTR_BG_INACTIVE
 
         if((_line_idx < cred_canvas_height))
         then

src/biw-hmenu.sh renamed to src/biw-panel-hmenu.sh

@@ -4,6 +4,9 @@
 # 
 # Licensed under GNU Lesser General Public License v3.0 only. Some rights
 # reserved. See LICENSE.
+# 
+# File:         biw-panel-hmenu.sh
+# Description:  Panel for horizontal menu.
 ##
 
 # Layout
@@ -109,7 +112,7 @@ function fn_hmenu_redraw()
 
     fn_sgr_seq_start
 
-        fn_theme_set_bg_attr $TATTR_BG_INACTIVE
+        fn_theme_set_attr $TATTR_BG_INACTIVE
         fn_sgr_set $SGR_ATTR_UNDERLINE
         fn_sgr_print "$_r_pad"
         fn_sgr_set $SGR_ATTR_DEFAULT

src/biw-vmenu.sh renamed to src/biw-panel-vmenu.sh

@@ -4,6 +4,9 @@
 # 
 # Licensed under GNU Lesser General Public License v3.0 only. Some rights
 # reserved. See LICENSE.
+#
+# File:         biw-panel-vmenu.sh
+# Description:  Display a scrollable vertical menu.
 ##
 
 # placeholder for empty data set

src/biw-bind.sh renamed to src/biw-setup.sh

@@ -4,19 +4,12 @@
 # 
 # Licensed under GNU Lesser General Public License v3.0 only. Some rights
 # reserved. See LICENSE.
+#
+# File:         biw-setup.sh
+# Description:  Setup script to be added to .bashrc.
 ##
 
-function fn_biw_init()
-{   
-    fn_check_interactive
-
-    fn_biw_set_env
-
-    # load keyboard codes
-    source ${BIW_HOME}/biw-term-csi.sh
-}
-
-function fn_choose_bind()
+function fn_biw_setup_bind()
 {
     local -r _bind_key=$1
 
@@ -25,11 +18,11 @@ function fn_choose_bind()
     local -r bind_int_char=$'"\201"'
     local -r bind_esc_char="\"\e${_bind_key}\""
 
-    bind -x ${bind_int_char}:fn_choose_show
+    bind -x ${bind_int_char}:fn_biw_setup_show
     bind ${bind_esc_char}:${bind_int_char}
 }
 
-function fn_choose_show()
+function fn_biw_setup_show()
 {
     if ! ${BIW_HOME}/biw-main.sh
     then
@@ -42,17 +35,14 @@ function fn_choose_show()
     rm $BIW_CH_RES_FILE
 }
 
-function fn_check_interactive()
+function fn_biw_setup_env()
 {
     if [[ ! "$-" =~ "i" ]]
     then
         echo "ERROR: This script must be sourced and not executed."
         exit 1
     fi
-}
 
-function fn_biw_set_env()
-{
     # file where history result will be saved
     export BIW_CH_RES_FILE=$HOME/.biw_selection
 
@@ -72,8 +62,14 @@ function fn_biw_set_env()
     export BIW_HOME=$_script_dir
 }
 
-# Activate bindings
-fn_biw_init
+# load env vars
+fn_biw_setup_env
+
+# load keyboard codes
+if ! source ${BIW_HOME}/biw-term-csi.sh
+then
+    return 1
+fi
 
 # set bind key here
-fn_choose_bind $CSI_KEY_DOWN
+fn_biw_setup_bind $CSI_KEY_DOWN

src/biw-term-csi.sh

@@ -4,6 +4,9 @@
 # 
 # Licensed under GNU Lesser General Public License v3.0 only. Some rights
 # reserved. See LICENSE.
+#
+# File:         biw-term-csi.sh
+# Description:  Send terminal control CSI sequences to manipulate the cursor.
 ##
 
 # CSI op codes used with fn_csi_op