From 6afaa55914bda745a1e7926c7045d9caa17f9be5 Mon Sep 17 00:00:00 2001
From: Leroy Hopson <git@leroy.geek.nz>
Date: Tue, 13 Jul 2021 08:16:34 +0700
Subject: [PATCH] Move bell to main terminal

---
 addons/godot_xterm/nodes/terminal/terminal.gd | 30 ++++++++++++++++++-
 examples/terminal/terminal.gd                 | 25 ----------------
 examples/terminal/terminal.tscn               |  5 ----
 3 files changed, 29 insertions(+), 31 deletions(-)

diff --git a/addons/godot_xterm/nodes/terminal/terminal.gd b/addons/godot_xterm/nodes/terminal/terminal.gd
index edf7480..d9fe285 100644
--- a/addons/godot_xterm/nodes/terminal/terminal.gd
+++ b/addons/godot_xterm/nodes/terminal/terminal.gd
@@ -34,10 +34,22 @@ var rows = 2
 # If true, text in the terminal will be copied to the clipboard when selected.
 export (bool) var copy_on_selection
 
+# Bell
+# If enabled, bell_sound will play when the ASCII BELL "\u0007" character is printed.
+export var bell_enabled := true
+export var bell_sound: AudioStream = preload("../../themes/audio/bell.wav")
+# Number of milliseconds that must pass before emitting a new bell sound.
+# This important in cases where the bell character is being printed frequently
+# such as `while true; do echo -e "\a"; done`, as adding additional AudioStreamPlayer
+# nodes too frequently has a negative performance impact.
+export var bell_cooldown_msec: int = 100
+
 var _viewport: Viewport = preload("./viewport.tscn").instance()
 var _native_terminal: Control = _viewport.get_node("Terminal")
 var _screen := TextureRect.new()
 
+var _bell_timer := Timer.new()
+
 var _selecting := false
 var _selecting_mode: int = SelectionMode.NONE
 var _selection_timer := Timer.new()
@@ -96,7 +108,6 @@ func _ready():
 	_native_terminal.connect("data_sent", self, "_on_data_sent")
 	_native_terminal.connect("key_pressed", self, "_on_key_pressed")
 	_native_terminal.connect("size_changed", self, "_on_size_changed")
-	_native_terminal.connect("bell", self, "_on_bell")
 
 	_viewport.size = rect_size
 	_viewport.render_target_update_mode = Viewport.UPDATE_ALWAYS
@@ -104,6 +115,10 @@ func _ready():
 	_screen.set_anchors_preset(PRESET_WIDE)
 	_screen.texture = _viewport.get_texture()
 
+	_native_terminal.connect("bell", self, "_on_bell")
+	_bell_timer.one_shot = true
+	add_child(_bell_timer)
+
 	_selection_timer.wait_time = 0.05
 	_selection_timer.connect("timeout", self, "_on_selection_held")
 
@@ -214,9 +229,22 @@ func _on_size_changed(new_size: Vector2):
 
 
 func _on_bell():
+	if bell_enabled and bell_sound and _bell_timer.time_left == 0:
+		var player := AudioStreamPlayer.new()
+		player.stream = bell_sound
+		player.autoplay = true
+		player.playing = true
+		player.connect("finished", self, "_on_player_finished", [player])
+		add_child(player)
+		_bell_timer.start(0.001 * bell_cooldown_msec)
+
 	emit_signal("bell")
 
 
+func _on_player_finished(player: AudioStreamPlayer):
+	player.queue_free()
+
+
 func _mouse_to_cell(pos: Vector2) -> Vector2:
 	return Vector2(pos / _native_terminal.cell_size)
 
diff --git a/examples/terminal/terminal.gd b/examples/terminal/terminal.gd
index c877d50..901567a 100644
--- a/examples/terminal/terminal.gd
+++ b/examples/terminal/terminal.gd
@@ -2,31 +2,6 @@ extends "res://addons/godot_xterm/nodes/terminal/terminal.gd"
 
 onready var pty = $PTY
 
-var _next_bell := true
-
 
 func _ready():
 	pty.fork(OS.get_environment("SHELL"))
-
-
-func _on_Terminal_bell():
-	# Limit the rate at which bells can be rung in case the user does something crazy such as
-	# `while true; do echo -e "\a"; done`
-	# which causes a real mess if we keep adding AudioStreamPlayers.
-	if not _next_bell:
-		return
-
-	var player := AudioStreamPlayer.new()
-	player.stream = preload("res://addons/godot_xterm/themes/audio/bell.wav")
-	player.autoplay = true
-	player.connect("finished", self, "_on_player_finished", [player])
-	add_child(player)
-	_next_bell = false
-
-
-func _on_player_finished(player: AudioStreamPlayer):
-	player.queue_free()
-
-
-func _on_Timer_timeout():
-	_next_bell = true
diff --git a/examples/terminal/terminal.tscn b/examples/terminal/terminal.tscn
index c9da576..622fc4a 100644
--- a/examples/terminal/terminal.tscn
+++ b/examples/terminal/terminal.tscn
@@ -21,9 +21,4 @@ env = {
 "TERM": "xterm-256color"
 }
 
-[node name="Timer" type="Timer" parent="."]
-wait_time = 0.1
-autostart = true
-
 [connection signal="bell" from="." to="." method="_on_Terminal_bell"]
-[connection signal="timeout" from="Timer" to="." method="_on_Timer_timeout"]