redoing terminal title code
[feisty_meow.git] / scripts / core / functions.sh
index aa9c512a918cfa91703226c4f77a1efe413b85d4..1cdcac4175137ebdaed6fe0b234ad034a3d8ee72 100644 (file)
@@ -4,20 +4,23 @@
 
 # test whether we've been here before or not.
 skip_all=
-function_sentinel &>/dev/null
+type function_sentinel &>/dev/null
 if [ $? -eq 0 ]; then
   # there was no error, so we can skip the inits.
   if [ ! -z "$SHELL_DEBUG" ]; then
-    echo skipping functions.sh because already defined.
+    echo "skipping function definitions, because already defined."
   fi
   skip_all=yes
+else
+  skip_all=
 fi
 
 if [ -z "$skip_all" ]; then
+
   if [ ! -z "$SHELL_DEBUG" ]; then
-    echo function definitions begin...
+    echo "feisty meow function definitions beginning now..."
   fi
-  
+
   # a handy little method that can be used for date strings.  it was getting
   # really tiresome how many different ways the script did the date formatting.
   function date_stringer() {
@@ -32,67 +35,151 @@ if [ -z "$skip_all" ]; then
     if [ ! -d "$1" ]; then mkdir -p "$1"; fi
     cd "$1"
   }
-  
+
+  function is_array() {
+    [[ "$(declare -p $1)" =~ "declare -a" ]]
+  }
+
+  function is_alias() {
+    alias $1 &>/dev/null
+    return $?
+  }
+
+  # displays the value of a variable in bash friendly format.
+  function var() {
+    HOLDIFS="$IFS"
+    IFS=""
+    while true; do
+      local varname="$1"; shift
+      if [ -z "$varname" ]; then
+        break
+      fi
+
+      if is_alias "$varname"; then
+#echo found $varname is alias
+        local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
+        alias $varname | sed -e 's/.*=//' >$tmpfile
+        echo "alias $varname=$(cat $tmpfile)"
+        \rm $tmpfile
+      elif [ -z "${!varname}" ]; then
+        echo "$varname undefined"
+      else
+        if is_array "$varname"; then
+#echo found $varname is array var 
+          local temparray
+          eval temparray="(\${$varname[@]})"
+          echo "$varname=(${temparray[@]})"
+#hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
+# see ones that have spaces in them.
+        else
+#echo found $varname is simple
+          echo "$varname=${!varname}"
+        fi
+      fi
+    done | sort
+    IFS="$HOLDIFS"
+  }
+
+  # sets the variable in parameter 1 to the value in parameter 2, but only if
+  # that variable was undefined.
+  function set_var_if_undefined()
+  {
+    local var_name="$1"; shift
+    local var_value="$1"; shift
+    if [ -z "${!var_name}" ]; then
+      eval export $var_name="$var_value"
+    fi
+  }
+
+  function success_sound()
+  {
+    if [ ! -z "$CLAM_FINISH_SOUND" ]; then
+      bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
+    fi
+  }
+
+  function error_sound()
+  {
+    if [ ! -z "$CLAM_ERROR_SOUND" ]; then
+      bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
+    fi
+  }
+
+  # checks the result of the last command that was run, and if that failed,
+  # then this complains and exits from bash.  the function parameters are
+  # used as the message to print as a complaint.
+  function check_result()
+  {
+    if [ $? -ne 0 ]; then
+      echo -e "failed on: $*"
+      error_sound
+      exit 1
+    fi
+  }
+
   # locates a process given a search pattern to match in the process list.
+  # supports a single command line flag style parameter of "-u USERNAME";
+  # if the -u flag is found, a username is expected afterwards, and only the
+  # processes of that user are considered.
   function psfind() {
+    local -a patterns=("${@}")
+#echo ====
+#echo patterns list is: "${patterns[@]}"
+#echo ====
+
+    local user_flag
+    if [ "${patterns[0]}" == "-u" ]; then
+      user_flag="-u ${patterns[1]}" 
+#echo "found a -u parm and user=${patterns[1]}" 
+      # void the two elements with that user flag so we don't use them as patterns.
+      unset patterns[0] patterns[1]=
+    else
+      # select all users.
+      user_flag="-e"
+    fi
+
     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
-    local PIDS_SOUGHT=()
-    local patterns=($*)
+    local -a PIDS_SOUGHT
+
     if [ "$OS" == "Windows_NT" ]; then
-      # needs to be a windows format filename for 'type' to work.
-      if [ ! -d c:/tmp ]; then
-        mkdir c:/tmp
-      fi
-      # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not really there
-      # in the root of drive c: when we look for it later.  hoping to fix that problem by using a subdir, which
-      # also might be magical thinking from windows perspective.
-      tmppid=c:\\tmp\\pids.txt
-      # we have abandoned all hope of relying on ps on windows.  instead
-      # we use wmic to get full command lines for processes.
-      # this does not exist on windows home edition.  we are hosed if that's
-      # what they insist on testing on.
-      wmic /locale:ms_409 PROCESS get processid,commandline </dev/null >"$tmppid"
-      local flag='/c'
-      if [ ! -z "$(uname -a | grep "^MING" )" ]; then
-        flag='//c'
-      fi
-      # we 'type' the file to get rid of the unicode result from wmic.
-      cmd $flag type "$tmppid" >$PID_DUMP
-      \rm "$tmppid"
-      local CR='\r'  # embedded carriage return.
-      local appropriate_pattern="s/^.*  *\([0-9][0-9]*\)[ $CR]*\$/\1/p"
-      for i in "${patterns[@]}"; do
-        PIDS_SOUGHT+=$(cat $PID_DUMP \
-          | grep -i "$i" \
-          | sed -n -e "$appropriate_pattern")
-        if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
-          # we want to bail as soon as we get matches, because on the same
-          # platform, the same set of patterns should work to find all
-          # occurrences of the genesis java.
-          break;
-        fi
-      done
+      # gets cygwin's (god awful) ps to show windoze processes also.
+      local EXTRA_DOZER_FLAGS="-W"
+      # pattern to use for peeling off the process numbers.
+      local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
+
     else
-      /bin/ps $extra_flags wuax >$PID_DUMP
+      # flags which clean up the output on unixes, which apparently cygwin
+      # doesn't count as.  their crappy specialized ps doesn't support this.
+      local EXTRA_UNIX_FLAGS="-o pid,args"
       # pattern to use for peeling off the process numbers.
-      local appropriate_pattern='s/^[-a-zA-Z_0-9][-a-zA-Z_0-9]*  *\([0-9][0-9]*\).*$/\1/p'
-      # remove the first line of the file, search for the pattern the
-      # user wants to find, and just pluck the process ids out of the
-      # results.
-      for i in "${patterns[@]}"; do
-        PIDS_SOUGHT=$(cat $PID_DUMP \
-          | sed -e '1d' \
-          | grep -i "$i" \
-          | sed -n -e "$appropriate_pattern")
-        if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
-          # we want to bail as soon as we get matches, because on the same
-          # platform, the same set of patterns should work to find all
-          # occurrences of the genesis java.
-          break;
-        fi
-      done
+      local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
+    fi
+
+    /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
+#echo ====
+#echo got all this stuff in the pid dump file:
+#cat $PID_DUMP
+#echo ====
+
+    # search for the pattern the user wants to find, and just pluck the process
+    # ids out of the results.
+    local i
+    for i in "${patterns[@]}"; do
+      PIDS_SOUGHT+=($(cat $PID_DUMP \
+        | grep -i "$i" \
+        | sed -n -e "$pid_finder_pattern"))
+    done
+#echo ====
+#echo pids sought list became:
+#echo "${PIDS_SOUGHT[@]}"
+#echo ====
+
+    if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
+      local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
+      PIDS_SOUGHT=()
+      PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
+      echo ${PIDS_SOUGHT[*]}
     fi
-    if [ ! -z "$PIDS_SOUGHT" ]; then echo "$PIDS_SOUGHT"; fi
     /bin/rm $PID_DUMP
   }
   
@@ -103,13 +190,20 @@ if [ -z "$skip_all" ]; then
       echo "psa finds processes by pattern, but there was no pattern on the command line."
       return 1
     fi
-    p=$(psfind "$1")
+    local -a patterns=("${@}")
+    p=$(psfind "${patterns[@]}")
     if [ -z "$p" ]; then
       # no matches.
       return 0
     fi
+
+    if [ "${patterns[0]}" == "-u" ]; then
+      # void the two elements with that user flag so we don't use them as patterns.
+      unset patterns[0] patterns[1]=
+    fi
+
     echo ""
-    echo "Processes containing \"$1\"..."
+    echo "Processes matching ${patterns[@]}..."
     echo ""
     if [ -n "$IS_DARWIN" ]; then
       unset fuzil_sentinel
@@ -124,13 +218,11 @@ if [ -z "$skip_all" ]; then
       done
     else 
       # cases besides mac os x's darwin.
-      extra_flags=
-      if [ "$OS" = "Windows_NT" ]; then
+      if [ "$OS" == "Windows_NT" ]; then
         # special case for windows.
-        extra_flags=-W
         ps | head -1
         for curr in $p; do
-          ps $extra_flags | grep "$curr" 
+          ps -W -p $curr | tail -n +2
         done
       else
         # normal OSes can handle a nice simple query.
@@ -159,18 +251,31 @@ if [ -z "$skip_all" ]; then
   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
   function unix_to_dos_path() {
     # we usually remove dos slashes in favor of forward slashes.
+    local DOSSYHOME
+    if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
+      # fake this value for non-windows (non-cygwin) platforms.
+      DOSSYHOME="$HOME"
+    else
+      # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
+      # insists on the /home form instead of /c/cygwin/home being possible.  this is
+      # super frustrating and nightmarish.
+      DOSSYHOME="$(cygpath -am "$HOME")"
+    fi
+
     if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
       # unless this flag is set, in which case we force dos slashes.
-      echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
+      echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
     else
-      echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
+      echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
     fi
   }
   
-  # switches from an X:/ form to an /X/path form.
+  # switches from an X:/ form to a /cygdrive/X/path form.  this is only useful
+  # for the cygwin environment currently.
   function dos_to_unix_path() {
     # we always remove dos slashes in favor of forward slashes.
-    echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
+#old:    echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
+         echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
   }
 
   # returns a successful value (0) if this system is debian or ubuntu.
@@ -210,20 +315,19 @@ if [ -z "$skip_all" ]; then
       # or at least suse doesn't, which is the other one we've tested on.
       /bin/su -l $*
     fi
-  
-    # relabel the console after returning.
-    bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
   }
   
   # sudo function wraps the normal sudo by ensuring we replace the terminal
   # label if they're doing an su with the sudo.
   function sudo() {
-    local first_command="$1"
-    /usr/bin/sudo $*
-    if [ "$first_command" == "su" ]; then
-      # yep, they were doing an su, but they're back now.
-      bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
-    fi
+#    local first_command="$1"
+    save_terminal_title
+    /usr/bin/sudo "$@"
+    restore_terminal_title
+#    if [ "$first_command" == "su" ]; then
+#      # yep, they were doing an su, but they're back now.
+#      label_terminal_with_info
+#    fi
   }
   
   # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
@@ -240,7 +344,7 @@ if [ -z "$skip_all" ]; then
     if [ -z "$wheres_nechung" ]; then
       echo "The nechung oracle program cannot be found.  You may want to consider"
       echo "rebuilding the feisty meow applications with this command:"
-      echo "   bash $FEISTY_MEOW_SCRIPTS/generator/bootstrap_build.sh"
+      echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
     else
       $wheres_nechung
     fi
@@ -248,11 +352,58 @@ if [ -z "$skip_all" ]; then
   
   # recreates all the generated files that the feisty meow scripts use.
   function regenerate() {
-    bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
+    # do the bootstrapping process again.
+    echo "regenerating feisty meow script environment."
+    bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
     echo
+    # force a full reload by turning off sentinel variables and methods.
+    unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
+    unalias CORE_ALIASES_LOADED &>/dev/null
+    unset -f function_sentinel 
+    # reload feisty meow environment in current shell.
+    source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh
+    # run nechung oracle to give user a new fortune.
     nechung
   }
 
+  # copies a set of custom scripts into the proper location for feisty meow
+  # to merge their functions and aliases with the standard set.
+  function recustomize()
+  {
+    user="$1"; shift
+    if [ -z "$user" ]; then
+      # use our default example user if there was no name provided.
+      user=fred
+    fi
+    if [ ! -d "$FEISTY_MEOW_APEX/customize/$user" ]; then
+      echo "The customization folder provided for $user should be:"
+      echo "  '$FEISTY_MEOW_APEX/customize/$user'"
+      echo "but that folder does not exist.  Skipping customization."
+      return 1
+    fi
+    regenerate >/dev/null
+    pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
+    incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_APEX/customize/$user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
+    
+    #echo "the incongruous files list is: $incongruous_files"
+    # disallow a single character result, since we get "*" as result when nothing exists yet.
+    if [ ${#incongruous_files} -ge 2 ]; then
+      echo "cleaning unknown older overrides..."
+      perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
+      echo
+    fi
+    popd &>/dev/null
+    echo "copying custom overrides for $user"
+    mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
+    perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_APEX/customize/$user" "$FEISTY_MEOW_LOADING_DOCK/custom"
+    if [ -d "$FEISTY_MEOW_APEX/customize/$user/scripts" ]; then
+      echo "copying custom scripts for $user"
+      \cp -R "$FEISTY_MEOW_APEX/customize/$user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/"
+    fi
+    echo
+    regenerate
+  }
+
   # generates a random password where the first parameter is the number of characters
   # in the password (default 20) and the second parameter specifies whether to use
   # special characters (1) or not (0).
@@ -264,9 +415,281 @@ if [ -z "$skip_all" ]; then
     echo
   }
 
-  function function_sentinel() { return 0; }
+  # a wrapper for the which command that finds items on the path.  some OSes
+  # do not provide which, so we want to not be spewing errors when that
+  # happens.
+  function whichable()
+  {
+    to_find="$1"; shift
+    which which &>/dev/null
+    if [ $? -ne 0 ]; then
+      # there is no which command here.  we produce nothing due to this.
+      echo
+    fi
+    echo $(which $to_find)
+  }
+
+#hmmm: improve this by not adding the link
+# if already there, or if the drive is not valid.
+  function add_cygwin_drive_mounts() {
+    for i in c d e f g h q z ; do
+      ln -s /cygdrive/$i $i
+    done
+  }
+
+  ############################
+
+  # takes a file to modify, and then it will replace any occurrences of the
+  # pattern provided as the second parameter with the text in the third
+  # parameter.
+  function replace_pattern_in_file()
+  {
+    local file="$1"; shift
+    local pattern="$1"; shift
+    local replacement="$1"; shift
+    if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
+      echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
+      echo "text to replace that pattern with."
+      return 1
+    fi
+    sed -i -e "s%$pattern%$replacement%g" "$file"
+  }
+
+  # similar to replace_pattern_in_file, but also will add the new value
+  # when the old one did not already exist in the file.
+  function replace_if_exists_or_add()
+  {
+    local file="$1"; shift
+    local phrase="$1"; shift
+    local replacement="$1"; shift
+    if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
+      echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
+      echo "text to replace that phrase with."
+      return 1
+    fi
+    grep "$phrase" "$file" >/dev/null
+    # replace if the phrase is there, otherwise add it.
+    if [ $? -eq 0 ]; then
+      replace_pattern_in_file "$file" "$phrase" "$replacement"
+    else
+      # this had better be the complete line.
+      echo "$replacement" >>"$file"
+    fi
+  }
+
+  ############################
+
+  # finds a variable (first parameter) in a particular property file
+  # (second parameter).  the expected format for the file is:
+  # varX=valueX
+  function seek_variable()
+  {
+    local find_var="$1"; shift
+    local file="$1"; shift
+    if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
+      echo -e "seek_variable: needs two parameters, firstly a variable name, and\nsecondly a file where the variable's value will be sought." 1>&2
+      return 1
+    fi
   
-  if [ ! -z "$SHELL_DEBUG" ]; then echo function definitions end....; fi
+    while read line; do
+      if [ ${#line} -eq 0 ]; then continue; fi
+      # split the line into the variable name and value.
+      IFS='=' read -a assignment <<< "$line"
+      local var="${assignment[0]}"
+      local value="${assignment[1]}"
+      if [ "${value:0:1}" == '"' ]; then
+        # assume the entry was in quotes and remove them.
+        value="${value:1:$((${#value} - 2))}"
+      fi
+      if [ "$find_var" == "$var" ]; then
+        echo "$value"
+      fi
+    done < "$file"
+  }
+  
+  # finds a variable (first parameter) in a particular XML format file
+  # (second parameter).  the expected format for the file is:
+  # ... name="varX" value="valueX" ...
+  function seek_variable_in_xml()
+  {
+    local find_var="$1"; shift
+    local file="$1"; shift
+    if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
+      echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
+      echo "secondly an XML file where the variable's value will be sought."
+      return 1
+    fi
+  
+    while read line; do
+      if [ ${#line} -eq 0 ]; then continue; fi
+      # process the line to make it more conventional looking.
+      line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
+      # split the line into the variable name and value.
+      IFS='=' read -a assignment <<< "$line"
+      local var="${assignment[0]}"
+      local value="${assignment[1]}"
+      if [ "${value:0:1}" == '"' ]; then
+        # assume the entry was in quotes and remove them.
+        value="${value:1:$((${#value} - 2))}"
+      fi
+      if [ "$find_var" == "$var" ]; then
+        echo "$value"
+      fi
+    done < "$file"
+  }
+  
+  ############################
+
+  # goes to a particular directory passed as parameter 1, and then removes all
+  # the parameters after that from that directory.
+  function push_whack_pop()
+  {
+    local dir="$1"; shift
+    pushd "$dir" &>/dev/null
+    if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
+    rm -rf $* &>/dev/null
+    if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
+    popd &>/dev/null
+  }
+
+  function spacem()
+  {
+    while [ $# -gt 0 ]; do
+      arg="$1"; shift
+      if [ ! -f "$arg" -a ! -d "$arg" ]; then
+        echo "failure to find a file or directory named '$arg'."
+        continue
+      fi
+
+      # first we will capture the output of the character replacement operation for reporting.
+      # this is done first since some filenames can't be properly renamed in perl (e.g. if they
+      # have pipe characters apparently).
+      intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
+      local saw_intermediate_result=0
+      if [ -z "$intermediate_name" ]; then
+        # make sure we report something, if there are no further name changes.
+        intermediate_name="'$arg'"
+      else 
+        # now zap the first part of the name off (since original name isn't needed).
+        intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
+        saw_intermediate_result=1
+      fi
+
+      # first we rename the file to be lower case.
+      actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
+      final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
+      local saw_final_result=0
+      if [ -z "$final_name" ]; then
+        final_name="$intermediate_name"
+      else
+        final_name="$(echo $final_name | sed -e 's/.*=> //')"
+        saw_final_result=1
+      fi
+#echo intermed=$saw_intermediate_result 
+#echo final=$saw_final_result 
+
+      if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
+        # printout the combined operation results.
+        echo "'$arg' => $final_name"
+      fi
+    done
+  }
+
+  ##############
+
+# new breed of definer functions goes here.  still in progress.
+
+  # defines an alias and remembers that this is a new or modified definition.
+  # if the feisty meow codebase is unloaded, then so are all the aliases that
+  # were defined.
+  function define_yeti_alias()
+  {
+# if alias exists already, save old value for restore,
+# otherwise save null value for restore,
+# have to handle unaliasing if there was no prior value of one
+# we newly defined.
+# add alias name to a list of feisty defined aliases.
+
+#hmmm: first implem, just do the alias and get that working...
+alias "${@}"
+
+
+return 0
+  }
+
+  # defines a variable within the feisty meow environment and remembers that
+  # this is a new or modified definition.  if the feisty meow codebase is
+  # unloaded, then so are all the variables that were defined.
+  # this function always exports the variables it defines.
+#  function define_yeti_variable()
+#  {
+## if variable exists already, save old value for restore,
+## otherwise save null value for restore,
+## have to handle unsetting if there was no prior value of one
+## we newly defined.
+## add variable name to a list of feisty defined variables.
+#
+##hmmm: first implem just sets it up and exports the variable.
+##  i.e., this method always exports.
+#export "${@}" 
+#
+#
+#return 0
+#  }
+
+  ##############
+
+  # just shows a separator line for an 80 column console, or uses the first
+  # parameter as the number of columns to expect.
+  function separator()
+  {
+    count=$1; shift
+    if [ -z "$count" ]; then
+      count=79
+    fi
+    echo
+    local i
+    for ((i=0; i < $count - 1; i++)); do
+      echo -n "="
+    done
+    echo
+    echo
+  }
+  # alias for separator.
+  function sep()
+  {
+    separator $*
+  }
+
+  ##############
+
+  function function_sentinel()
+  {
+    return 0; 
+  }
   
+  if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
+
+  ##############
+
+  # test code for set_var_if_undefined.
+  run_test=0
+  if [ $run_test != 0 ]; then
+    echo running tests on set_var_if_undefined.
+    flagrant=petunia
+    set_var_if_undefined flagrant forknordle
+    check_result "testing if defined variable would be whacked"
+    if [ $flagrant != petunia ]; then
+      echo set_var_if_undefined failed to leave the test variable alone
+      exit 1
+    fi
+    unset bobblehead_stomper
+    set_var_if_undefined bobblehead_stomper endurance
+    if [ $bobblehead_stomper != endurance ]; then
+      echo set_var_if_undefined failed to set a variable that was not defined yet
+      exit 1
+    fi
+  fi
+
 fi