# -*- shell-script -*-
# Things related to variable journaling.
#
#   Copyright (C) 2002, 2003, 2004, 2006, 2008, 2009,
#   2010, 2011 Rocky Bernstein <rocky@gnu.org>
#
#   This program is free software; you can redistribute it and/or
#   modify it under the terms of the GNU General Public License as
#   published by the Free Software Foundation; either version 2, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#   General Public License for more details.
#   
#   You should have received a copy of the GNU General Public License
#   along with this program; see the file COPYING.  If not, write to
#   the Free Software Foundation, 59 Temple Place, Suite 330, Boston,
#   MA 02111 USA.

# We use a journal file to save variable state so that we can pass
# values set in a subshell or nested shell back. This typically
# includes debugger information, e.g. breakpoints and state. This file
# is just code (usually assignment statements) that get eval'd.

# The file to save the journal information.
typeset _Dbg_journal=$(_Dbg_tempname journal)

# append a command into journal file and then run the command.
proc _Dbg_write_journal_eval {
    _Dbg_write_journal @ARGV 
    eval @ARGV
}

# append a command into journal file and then run the command.
proc _Dbg_write_journal_var {
    typeset var_name="$1"
    typeset val
    typeset val_cmd="val='\${$var_name}'"
    eval $val_cmd
    _Dbg_write_journal "${var_name}='${val}'" 
}

proc _Dbg_write_journal_avar {
    typeset decl_str; setvar decl_str = $(declare -p $1)
    typeset -a decl_a
    setvar decl_a = ''($decl_str)
    typeset -a decl_a2
    setvar decl_a2 = ${decl_a[@]:2}
    _Dbg_write_journal ${decl_a2[@]}
}

# Append a command into journal file. But we only need to do
# if we are in a subshell.
proc _Dbg_write_journal {
    if (( BASH_SUBSHELL != 0 ))  {
        echo @ARGV >> ${_Dbg_journal} 2>/dev/null
    }
    # return $?
}

# Remove all journal files.
proc _Dbg_erase_journals {
    [[ -f $_Dbg_journal ]] && rm ${_Dbg_journal} 2>/dev/null
    return $?
}

# read in or "source" in journal file which will set variables.
proc _Dbg_source_journal {

  if test -r $_Dbg_journal  { 
    source $_Dbg_journal
    (( BASH_SUBSHELL == 0 )) && _Dbg_erase_journals
  }
}

if test ! -f _Dbg_journal  { 
    typeset -i _Dbg_QUIT_LEVELS=0
    _Dbg_write_journal "_Dbg_QUIT_LEVELS=0"
}