v2.2.0

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ### master
 
+### v2.2.0, 2015-02-12
+- bugfix: zoomed windows related regression
+- export save and restore script paths so that 'tmux-resurrect-save' plugin can
+  use them
+- enable "quiet" saving (used by 'tmux-resurrect-save' plugin)
+
+### v2.1.0, 2015-02-12
+- if restore is started when there's only **1 pane in the whole tmux server**,
+  assume the users wants the "full restore" and overrwrite that pane.
+
 ### v2.0.0, 2015-02-10
 - add link to the wiki page for "first pane/window issue" to the README as well
   as other tweaks

README.md

@@ -51,15 +51,10 @@ This plugin goes to great lengths to save and restore all the details from your
 Requirements / dependencies: `tmux 1.9` or higher, `bash`.
 
 `tmux-resurrect` is idempotent! It will not try to restore panes or windows that
-already exist.
-
-### FAQ
-
-> I have a problem: first pane/window is not restoring!
-
-Check out
-[this wiki page](https://github.com/tmux-plugins/tmux-resurrect/wiki/Help:-issues-with-the-first-window)
-for the explanation and problem solution.
+already exist.<br/>
+The single exception to this is when tmux is started with only 1 pane in order
+to restore previous tmux env. In this case only will this single pane be
+overwritten.
 
 ### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
 

resurrect.tmux

@@ -25,9 +25,15 @@ set_default_strategies() {
 	tmux set-option -g "${restore_process_strategy_option}irb" "default_strategy"
 }
 
+set_script_path_options() {
+	tmux set-option -g "$save_path_option" "$CURRENT_DIR/scripts/save.sh"
+	tmux set-option -g "$restore_path_option" "$CURRENT_DIR/scripts/restore.sh"
+}
+
 main() {
 	set_save_bindings
 	set_restore_bindings
 	set_default_strategies
+	set_script_path_options
 }
 main

scripts/helpers.sh

@@ -66,6 +66,13 @@ is_session_grouped() {
 	[[ "$GROUPED_SESSIONS" == *"${d}${session_name}${d}"* ]]
 }
 
+restore_zoomed_windows() {
+	awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $6 ~ /Z/ && $9 == 1 { print $2, $3; }' $(last_resurrect_file) |
+		while IFS=$d read session_name window_number; do
+			tmux resize-pane -t "${session_name}:${window_number}" -Z
+		done
+}
+
 # path helpers
 
 resurrect_dir() {
@@ -85,10 +92,3 @@ resurrect_history_file() {
 	local pane_id="$1"
 	echo "$(resurrect_dir)/bash_history-${pane_id}"
 }
-
-restore_zoomed_windows() {
-	awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $6 ~ /Z/ && $9 == 1 { print $2, $3; }' $(last_resurrect_file) |
-		while IFS=$d read session_name window_number; do
-			tmux resize-pane -t "${session_name}:${window_number}" -Z
-		done
-}

scripts/restore.sh

@@ -16,6 +16,8 @@ d=$'\t'
 # is also not restored. That makes the restoration process more idempotent.
 EXISTING_PANES_VAR=""
 
+RESTORING_FROM_SCRATCH="false"
+
 is_line_type() {
 	local line_type="$1"
 	local line="$2"
@@ -56,6 +58,14 @@ is_pane_registered_as_existing() {
 	[[ "$EXISTING_PANES_VAR" =~ "$pane_custom_id" ]]
 }
 
+restore_from_scratch_true() {
+	RESTORING_FROM_SCRATCH="true"
+}
+
+is_restoring_from_scratch() {
+	[ "$RESTORING_FROM_SCRATCH" == "true" ]
+}
+
 window_exists() {
 	local session_name="$1"
 	local window_number="$2"
@@ -114,9 +124,17 @@ restore_pane() {
 		window_name="$(remove_first_char "$window_name")"
 		pane_full_command="$(remove_first_char "$pane_full_command")"
 		if pane_exists "$session_name" "$window_number" "$pane_index"; then
-			# Pane exists, no need to create it!
-			# Pane existence is registered. Later, it's process also isn't restored.
-			register_existing_pane "$session_name" "$window_number" "$pane_index"
+			if is_restoring_from_scratch; then
+				# overwrite the pane
+				# happens only for the first pane if it's the only registered pane for the whole tmux server
+				local pane_id="$(tmux display-message -p -F "#{pane_id}" -t "$session_name:$window_number")"
+				new_pane "$session_name" "$window_number" "$window_name" "$dir"
+				tmux kill-pane -t "$pane_id"
+			else
+				# Pane exists, no need to create it!
+				# Pane existence is registered. Later, its process also won't be restored.
+				register_existing_pane "$session_name" "$window_number" "$pane_index"
+			fi
 		elif window_exists "$session_name" "$window_number"; then
 			new_pane "$session_name" "$window_number" "$window_name" "$dir"
 		elif session_exists "$session_name"; then
@@ -136,7 +154,48 @@ restore_state() {
 	done
 }
 
+restore_grouped_session() {
+	local grouped_session="$1"
+	echo "$grouped_session" |
+	while IFS=$d read line_type grouped_session original_session alternate_window active_window; do
+		TMUX="" tmux -S "$(tmux_socket)" new-session -d -s "$grouped_session" -t "$original_session"
+	done
+}
+
+restore_active_and_alternate_windows_for_grouped_sessions() {
+	local grouped_session="$1"
+	echo "$grouped_session" |
+	while IFS=$d read line_type grouped_session original_session alternate_window_index active_window_index; do
+		alternate_window_index="$(remove_first_char "$alternate_window_index")"
+		active_window_index="$(remove_first_char "$active_window_index")"
+		if [ -n "$alternate_window_index" ]; then
+			tmux switch-client -t "${grouped_session}:${alternate_window_index}"
+		fi
+		if [ -n "$active_window_index" ]; then
+			tmux switch-client -t "${grouped_session}:${active_window_index}"
+		fi
+	done
+}
+
+never_ever_overwrite() {
+	local overwrite_option_value="$(get_tmux_option "$overwrite_option" "")"
+	[ -n "$overwrite_option_value" ]
+}
+
+detect_if_restoring_from_scratch() {
+	if never_ever_overwrite; then
+		return
+	fi
+	local total_number_of_panes="$(tmux list-panes -a | wc -l | sed 's/ //g')"
+	if [ "$total_number_of_panes" -eq 1 ]; then
+		restore_from_scratch_true
+	fi
+}
+
+# functions called from main (ordered)
+
 restore_all_panes() {
+	detect_if_restoring_from_scratch
 	while read line; do
 		if is_line_type "pane" "$line"; then
 			restore_pane "$line"
@@ -144,6 +203,13 @@ restore_all_panes() {
 	done < $(last_resurrect_file)
 }
 
+restore_pane_layout_for_each_window() {
+	\grep '^window' $(last_resurrect_file) |
+		while IFS=$d read line_type session_name window_number window_active window_flags window_layout; do
+			tmux select-layout -t "${session_name}:${window_number}" "$window_layout"
+		done
+}
+
 restore_shell_history() {
 	awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ { print $2, $3, $7, $10; }' $(last_resurrect_file) |
 		while IFS=$d read session_name window_number pane_index pane_command; do
@@ -171,13 +237,6 @@ restore_all_pane_processes() {
 	fi
 }
 
-restore_pane_layout_for_each_window() {
-	\grep '^window' $(last_resurrect_file) |
-		while IFS=$d read line_type session_name window_number window_active window_flags window_layout; do
-			tmux select-layout -t "${session_name}:${window_number}" "$window_layout"
-		done
-}
-
 restore_active_pane_for_each_window() {
 	awk 'BEGIN { FS="\t"; OFS="\t" } /^pane/ && $9 == 1 { print $2, $3, $7; }' $(last_resurrect_file) |
 		while IFS=$d read session_name window_number active_pane; do
@@ -186,29 +245,6 @@ restore_active_pane_for_each_window() {
 		done
 }
 
-restore_grouped_session() {
-	local grouped_session="$1"
-	echo "$grouped_session" |
-	while IFS=$d read line_type grouped_session original_session alternate_window active_window; do
-		TMUX="" tmux -S "$(tmux_socket)" new-session -d -s "$grouped_session" -t "$original_session"
-	done
-}
-
-restore_active_and_alternate_windows_for_grouped_sessions() {
-	local grouped_session="$1"
-	echo "$grouped_session" |
-	while IFS=$d read line_type grouped_session original_session alternate_window_index active_window_index; do
-		alternate_window_index="$(remove_first_char "$alternate_window_index")"
-		active_window_index="$(remove_first_char "$active_window_index")"
-		if [ -n "$alternate_window_index" ]; then
-			tmux switch-client -t "${grouped_session}:${alternate_window_index}"
-		fi
-		if [ -n "$active_window_index" ]; then
-			tmux switch-client -t "${grouped_session}:${active_window_index}"
-		fi
-	done
-}
-
 restore_grouped_sessions() {
 	while read line; do
 		if is_line_type "grouped_session" "$line"; then

scripts/save.sh

@@ -10,6 +10,9 @@ source "$CURRENT_DIR/spinner_helpers.sh"
 d=$'\t'
 delimiter=$'\t'
 
+# if "quiet" script produces no output
+SCRIPT_OUTPUT="$1"
+
 grouped_sessions_format() {
 	local format
 	format+="#{session_grouped}"
@@ -210,12 +213,20 @@ save_all() {
 	restore_zoomed_windows
 }
 
+show_output() {
+	[ "$SCRIPT_OUTPUT" != "quiet" ]
+}
+
 main() {
 	if supported_tmux_version_ok; then
-		start_spinner "Saving..." "Tmux environment saved!"
+		if show_output; then
+			start_spinner "Saving..." "Tmux environment saved!"
+		fi
 		save_all
-		stop_spinner
-		display_message "Tmux environment saved!"
+		if show_output; then
+			stop_spinner
+			display_message "Tmux environment saved!"
+		fi
 	fi
 }
 main

scripts/variables.sh

@@ -1,9 +1,11 @@
 # key bindings
 default_save_key="C-s"
 save_option="@resurrect-save"
+save_path_option="@resurrect-save-script-path"
 
 default_restore_key="C-r"
 restore_option="@resurrect-restore"
+restore_path_option="@resurrect-restore-script-path"
 
 # default processes that are restored
 default_proc_list_option="@resurrect-default-processes"
@@ -28,3 +30,6 @@ save_command_strategy_option="@resurrect-save-command-strategy"
 default_save_command_strategy="ps"
 
 bash_history_option="@resurrect-save-bash-history"
+
+# set to 'on' to ensure panes are never ever overwritten
+overwrite_option="@resurrect-never-overwrite"