Project rename

Author: Chad Juliano

LICENSE.md

@@ -1,4 +1,4 @@
-BIW-TOOLS - Bash Inline Widgets
+BASH-UI - Bash User Interface Tools
 Copyright 2017 by Chad Juliano
 
 @license LGPL-3.0 <https://spdx.org/licenses/LGPL-3.0>

README.md

@@ -1,4 +1,4 @@
-# BIW-TOOLS - Bash Inline Widgets
+# BASH-UI - Bash User Interface
 
 This is still a work in progress.
 

src/biw-main.sh renamed to src/bui-main.sh

@@ -1,84 +1,84 @@
 ###!/bin/bash
 ##
-# BIW-TOOLS - Bash Inline Widget Tools
+# BASH-UI - Bash User Interface Tools
 # Copyright 2017 by Chad Juliano
 # 
 # Licensed under GNU Lesser General Public License v3.0 only. Some rights
 # reserved. See LICENSE.
 #
-# File:         biw-main.sh
+# File:         bui-main.sh
 # Description:  Top-level script for panel menus.
 ##
 
 # generate errors if unset vars are used.
 set -o nounset
 
-source ${BIW_HOME}/biw-util.sh
-source ${BIW_HOME}/biw-theme-mgr.sh
-source ${BIW_HOME}/biw-panel-hmenu.sh
-source ${BIW_HOME}/biw-panel-vmenu.sh
-source ${BIW_HOME}/biw-panel-browse.sh
-source ${BIW_HOME}/biw-panel-credits.sh
-source ${BIW_HOME}/biw-panel-slider.sh
+source ${BUI_HOME}/bui-util.sh
+source ${BUI_HOME}/bui-theme-mgr.sh
+source ${BUI_HOME}/bui-panel-hmenu.sh
+source ${BUI_HOME}/bui-panel-vmenu.sh
+source ${BUI_HOME}/bui-panel-browse.sh
+source ${BUI_HOME}/bui-panel-credits.sh
+source ${BUI_HOME}/bui-panel-slider.sh
 
-declare -r BIW_VERSION=0.9
+declare -r BUI_VERSION=0.9
 
 # a controller can set a result here when it is closed.
-declare biw_selection_result
+declare bui_selection_result
 
-function fn_biw_main()
+function fn_bui_main()
 {
     # remove any existing result file.
-    rm -f $BIW_RESULT_FILE
+    rm -f $BUI_RESULT_FILE
 
     fn_util_panel_open
     fn_theme_init
 
     # show the panel
-    fn_biw_controller_hmenu_top
+    fn_bui_controller_hmenu_top
 
     fn_util_panel_close
 
-    if [ -n "$biw_selection_result" ]
+    if [ -n "$bui_selection_result" ]
     then
         # save to temporary file
-        echo "$biw_selection_result" > $BIW_RESULT_FILE
+        echo "$bui_selection_result" > $BUI_RESULT_FILE
     fi
 }
 
 # Entires in H-Menu
-declare -r BIW_MENU_HISTORY='History'
-declare -r BIW_MENU_BROWSE='File'
-declare -r BIW_MENU_THEME='Theme'
-declare -r BIW_MENU_HOTKEY='Hotkey'
-declare -r BIW_MENU_CREDITS='Credits'
-declare -r BIW_MENU_DIMENSIONS='Dims'
-declare -r BIW_MENU_CONFIG='Config'
-#declare -r BIW_MENU_DEFAULT='Default'
-
-# BIW_DISPATCH_MAP: 
+declare -r BUI_MENU_HISTORY='History'
+declare -r BUI_MENU_BROWSE='File'
+declare -r BUI_MENU_THEME='Theme'
+declare -r BUI_MENU_HOTKEY='Hotkey'
+declare -r BUI_MENU_CREDITS='Credits'
+declare -r BUI_MENU_DIMENSIONS='Dims'
+declare -r BUI_MENU_CONFIG='Config'
+#declare -r BUI_MENU_DEFAULT='Default'
+
+# BUI_DISPATCH_MAP: 
 # This determines what controller is invoked when an H-Menu entry is 
 # selected.
 #
 # A controller can also invoke a second-level H-Menu but regardless
 # of the level, it uses this map to determine what its menu entries
 # invoke.
-declare -A BIW_DISPATCH_MAP=(
-    [$BIW_MENU_HISTORY]=fn_biw_controller_history
-    [$BIW_MENU_BROWSE]=fn_biw_controller_browse
-    [$BIW_MENU_CREDITS]=fn_biw_controller_credits
-    [$BIW_MENU_CONFIG]=fn_biw_controller_cfg_hmenu
-    [$BIW_MENU_THEME]=fn_biw_controller_cfg_theme
-    [$BIW_MENU_HOTKEY]=fn_biw_controller_cfg_hotkey
-    [$BIW_MENU_DIMENSIONS]=fn_biw_controller_cfg_dims)
-
-function fn_biw_controller_hmenu_top()
+declare -A BUI_DISPATCH_MAP=(
+    [$BUI_MENU_HISTORY]=fn_bui_controller_history
+    [$BUI_MENU_BROWSE]=fn_bui_controller_browse
+    [$BUI_MENU_CREDITS]=fn_bui_controller_credits
+    [$BUI_MENU_CONFIG]=fn_bui_controller_cfg_hmenu
+    [$BUI_MENU_THEME]=fn_bui_controller_cfg_theme
+    [$BUI_MENU_HOTKEY]=fn_bui_controller_cfg_hotkey
+    [$BUI_MENU_DIMENSIONS]=fn_bui_controller_cfg_dims)
+
+function fn_bui_controller_hmenu_top()
 {
     local -a _top_menu=(
-        $BIW_MENU_HISTORY
-        $BIW_MENU_BROWSE
-        $BIW_MENU_CONFIG
-        $BIW_MENU_CREDITS)
+        $BUI_MENU_HISTORY
+        $BUI_MENU_BROWSE
+        $BUI_MENU_CONFIG
+        $BUI_MENU_CREDITS)
 
     # setup the H-Menu
     fn_hmenu_init '_top_menu[@]'
@@ -88,19 +88,19 @@ function fn_biw_controller_hmenu_top()
     fn_util_dispatcher
 }
 
-function fn_biw_controller_cfg_hmenu()
+function fn_bui_controller_cfg_hmenu()
 {
     # If we are at this point then it means:
     #   1. The user selected the "Config" entry in the H-Menu.
     #   2. The dispatcher looked up the associated controller 
-    #      in BIW_DISPATCH_MAP.
+    #      in BUI_DISPATCH_MAP.
     #   3. The dispatcher invoked this controller and is expecting
     #      it to return when done.
 
     local -a _config_menu=(
-        $BIW_MENU_THEME
-        $BIW_MENU_DIMENSIONS
-        $BIW_MENU_HOTKEY)
+        $BUI_MENU_THEME
+        $BUI_MENU_DIMENSIONS
+        $BUI_MENU_HOTKEY)
 
     # Call the dispatcher that will handle actions 
     # for a second-level menu
@@ -121,7 +121,7 @@ function fn_biw_controller_cfg_hmenu()
 # Controller: Hotkey configuration panel.
 ##
 
-function fn_biw_controller_cfg_hotkey()
+function fn_bui_controller_cfg_hotkey()
 {
     local -A _bind_selections=(
         ['Arrow-Up']=$CSI_KEY_UP
@@ -141,7 +141,7 @@ function fn_biw_controller_cfg_hotkey()
     mapfile -t _key_descr_list < <(echo "${!_bind_selections[*]}" | sort)
 
     fn_vmenu_init _key_descr_list[@]
-    fn_biw_cfg_hotkey_load
+    fn_bui_cfg_hotkey_load
     vmenu_idx_selected=$?
 
     fn_vmenu_set_message "Choose activation hotkey"
@@ -155,14 +155,14 @@ function fn_biw_controller_cfg_hotkey()
 
         case "$_key" in
             $CSI_KEY_ENTER|$CSI_KEY_SPC) 
-                fn_biw_cfg_hotkey_save
+                fn_bui_cfg_hotkey_save
                 fn_vmenu_redraw
                 ;;
         esac
     done
 }
 
-function fn_biw_cfg_hotkey_load()
+function fn_bui_cfg_hotkey_load()
 {
     # create lookups
     local -A _bind_desc_lookup=()
@@ -177,22 +177,22 @@ function fn_biw_cfg_hotkey_load()
         _bind_desc_lookup+=( ["$_key_code"]=$_bind_idx )
     done
 
-    fn_settings_get_param $BIW_BIND_PARAM_NAME '_selected_bind_key' $BIW_DEFAULT_BIND_KEY
+    fn_settings_get_param $BUI_BIND_PARAM_NAME '_selected_bind_key' $BUI_DEFAULT_BIND_KEY
 
     local _selected_bind_key
     fn_settings_get_hotkey '_selected_bind_key'
 
     local -i _selected_bind_idx=${_bind_desc_lookup["$_selected_bind_key"]:--1}
     if((_selected_bind_idx < 0))
     then
-        local -i _default_bind_idx=${_bind_desc_lookup[$BIW_DEFAULT_BIND_KEY]}
+        local -i _default_bind_idx=${_bind_desc_lookup[$BUI_DEFAULT_BIND_KEY]}
         return $_default_bind_idx
     fi
 
     return $_selected_bind_idx
 }
 
-function fn_biw_cfg_hotkey_save()
+function fn_bui_cfg_hotkey_save()
 {
     local _selected_bind_desc
     fn_vmenu_get_current_val '_selected_bind_desc'
@@ -208,7 +208,7 @@ function fn_biw_cfg_hotkey_save()
 # Controller: Credits Animation panel
 ##
 
-function fn_biw_controller_credits()
+function fn_bui_controller_credits()
 {
     # change to matrix theme
     local -i _theme_idx=${theme_id_lookup[THEME_TYPE_MATRIX]}
@@ -227,15 +227,15 @@ function fn_biw_controller_credits()
 ##
 
 # max values to load for history and file lists
-declare -ri BIW_LIST_MAX=50
+declare -ri BUI_LIST_MAX=50
 
-function fn_biw_controller_history()
+function fn_bui_controller_history()
 {
-    local _panel_command="fc -lnr -$BIW_LIST_MAX"
+    local _panel_command="fc -lnr -$BUI_LIST_MAX"
     local -a _values
 
     # read command into _values
-    mapfile -t -n $BIW_LIST_MAX _values < <($_panel_command)
+    mapfile -t -n $BUI_LIST_MAX _values < <($_panel_command)
 
     # remove first 2 leading blanks for history case
     _values=("${_values[@]#[[:blank:]][[:blank:]]}")
@@ -252,7 +252,7 @@ function fn_biw_controller_history()
         case "$_key" in
             $CSI_KEY_ENTER) 
                 # we got the enter key so close the menu
-                fn_vmenu_get_current_val "biw_selection_result"
+                fn_vmenu_get_current_val "bui_selection_result"
                 util_exit_dispatcher=1
                 break
                 ;;
@@ -264,7 +264,7 @@ function fn_biw_controller_history()
 # Controller: Theme configuration panel.
 ##
 
-function fn_biw_controller_cfg_theme()
+function fn_bui_controller_cfg_theme()
 {
     # load theme data into menu
     fn_vmenu_init "theme_desc_lookup[@]" $theme_active_idx
@@ -286,7 +286,7 @@ function fn_biw_controller_cfg_theme()
 
         case "$_key" in
             $CSI_KEY_ENTER|$CSI_KEY_SPC) 
-                fn_biw_cfg_theme_save
+                fn_bui_cfg_theme_save
                 fn_vmenu_redraw
                 ;;
         esac
@@ -295,7 +295,7 @@ function fn_biw_controller_cfg_theme()
     fn_theme_load
 }
 
-function fn_biw_cfg_theme_save()
+function fn_bui_cfg_theme_save()
 {
     local _saved_theme=${THEME_LIST[$theme_active_idx]}
     fn_settings_set_param $THEME_PARAM_NAME $_saved_theme
@@ -308,24 +308,24 @@ function fn_biw_cfg_theme_save()
 # Controller: Dimensions Configuration
 ##
 
-declare -i biw_dims_save_pending
+declare -i bui_dims_save_pending
 
-function fn_biw_controller_cfg_dims()
+function fn_bui_controller_cfg_dims()
 {
-    biw_dims_save_pending=0
+    bui_dims_save_pending=0
 
     declare -a slider_ctl_width=(
         [$SLIDER_CTL_ATTR_LABEL]='Width'
         [$SLIDER_CTL_ATTR_MIN]=40
         [$SLIDER_CTL_ATTR_MAX]=80
-        [$SLIDER_CTL_ATTR_VAL]=$biw_panel_col_size
+        [$SLIDER_CTL_ATTR_VAL]=$bui_panel_col_size
         )
 
     declare -a slider_ctl_height=(
         [$SLIDER_CTL_ATTR_LABEL]='Height'
         [$SLIDER_CTL_ATTR_MIN]=8
         [$SLIDER_CTL_ATTR_MAX]=40
-        [$SLIDER_CTL_ATTR_VAL]=$biw_panel_row_size
+        [$SLIDER_CTL_ATTR_VAL]=$bui_panel_row_size
         )
 
     local -a _slider_list=(
@@ -346,25 +346,25 @@ function fn_biw_controller_cfg_dims()
         if [ $? == $UTIL_ACT_CHANGED ]
         then
             # action handled so get next key
-            if((!biw_dims_save_pending))
+            if((!bui_dims_save_pending))
             then
                 fn_util_draw_footer 'Hit [Enter] or [Space] to save; [ESC] to cancel.'
-                biw_dims_save_pending=1
+                bui_dims_save_pending=1
             fi
             continue
         fi
 
         case "$_key" in
             $CSI_KEY_ENTER|$CSI_KEY_SPC)
-                fn_biw_cfg_dims_save
+                fn_bui_cfg_dims_save
                 ;;
         esac
     done
 }
 
-function fn_biw_cfg_dims_save()
+function fn_bui_cfg_dims_save()
 {
-    if((!biw_dims_save_pending))
+    if((!bui_dims_save_pending))
     then
         return
     fi
@@ -377,8 +377,8 @@ function fn_biw_cfg_dims_save()
     fn_slider_redraw
     fn_util_draw_footer 'Changes saved to settings file.'
 
-    biw_dims_save_pending=0
+    bui_dims_save_pending=0
 }
 
 # entry point
-fn_biw_main
+fn_bui_main