Add documentation.

Author: samuel-williams-shopify

bake/ruby/gdb.rb

@@ -6,88 +6,130 @@
 require "ruby/gdb"
 require "fileutils"
 
-# Install GDB Python extensions to XDG data directory or custom prefix
-# @parameter prefix [String] Optional installation prefix (defaults to XDG_DATA_HOME)
-def install(prefix: nil)
-	install_path = Ruby::GDB.install_path(prefix: prefix)
-	
-	puts "Installing Ruby GDB extensions to: #{install_path}"
-	
-	# Create installation directory
-	FileUtils.mkdir_p(install_path)
-	
-	# Copy Python scripts
-	scripts = [
-		Ruby::GDB.object_script_path,
-		Ruby::GDB.fiber_script_path
-	]
-	
-	scripts.each do |script|
-		if File.exist?(script)
-			dest = File.join(install_path, File.basename(script))
-			puts "  Installing #{File.basename(script)}..."
-			FileUtils.cp(script, dest)
-		else
-			warn "  Warning: #{script} not found"
+# Install GDB extensions by adding source line to ~/.gdbinit
+# @parameter gdbinit [String] Optional path to .gdbinit (defaults to ~/.gdbinit)
+def install(gdbinit: nil)
+	gdbinit_path = gdbinit || File.join(Dir.home, ".gdbinit")
+	init_py_path = Ruby::GDB.init_script_path
+	source_line = "source #{init_py_path}"
+	marker_comment = "# Ruby GDB Extensions (ruby-gdb gem)"
+	
+	puts "Installing Ruby GDB extensions..."
+	puts "  Extensions: #{File.dirname(init_py_path)}"
+	puts "  Config: #{gdbinit_path}"
+	
+	# Read existing .gdbinit or create empty array
+	lines = File.exist?(gdbinit_path) ? File.readlines(gdbinit_path) : []
+	
+	# Check if already installed (look for marker comment)
+	marker_index = lines.index{|line| line.strip == marker_comment}
+	
+	if marker_index
+		# Already installed - update the source line in case path changed
+		source_index = marker_index + 1
+		if source_index < lines.size && lines[source_index].strip.start_with?("source")
+			old_source = lines[source_index].strip
+			if old_source == source_line
+				puts "\n✓ Already installed in #{gdbinit_path}"
+				puts "  #{source_line}"
+				return
+			else
+				# Path changed - update it
+				lines[source_index] = "#{source_line}\n"
+				File.write(gdbinit_path, lines.join)
+				puts "\n✓ Updated installation in #{gdbinit_path}"
+				puts "  Old: #{old_source}"
+				puts "  New: #{source_line}"
+				return
+			end
 		end
 	end
 
-	# Create a loader script that sources both extensions
-	loader_path = File.join(install_path, "init.gdb")
-	puts "  Creating loader script: #{File.basename(loader_path)}"
-	
-	File.write(loader_path, <<~GDB)
-		# Ruby GDB Extensions Loader
-		# This file loads Ruby debugging extensions for GDB
-		
-		python
-		import sys
-		import os
-		
-		# Add the Ruby GDB extensions directory to Python path
-		ruby_gdb_dir = os.path.dirname(__file__)
-		if ruby_gdb_dir not in sys.path:
-		    sys.path.insert(0, ruby_gdb_dir)
-		
-		# Load Ruby object printing extensions
-		exec(open(os.path.join(ruby_gdb_dir, 'object.py')).read())
-		
-		# Load Ruby fiber debugging extensions
-		exec(open(os.path.join(ruby_gdb_dir, 'fiber.py')).read())
-		
-		print("Ruby GDB extensions loaded successfully!")
-		print("Use 'help rb-' to see available commands.")
-		end
-	GDB
+	# Not installed - add it
+	File.open(gdbinit_path, "a") do |f|
+		f.puts unless lines.last&.strip&.empty?
+		f.puts marker_comment
+		f.puts source_line
+	end
 
-	puts "\nInstallation complete!"
-	puts "\nTo use these extensions, add the following to your ~/.gdbinit:"
-	puts "  source #{loader_path}"
-	puts "\nOr load them manually in GDB with:"
-	puts "  (gdb) source #{loader_path}"
+	puts "\n✓ Installation complete!"
+	puts "\nAdded to #{gdbinit_path}:"
+	puts "  #{source_line}"
+	puts "\nExtensions will load automatically when you start GDB."
 end
 
-# Uninstall GDB Python extensions
-# @parameter prefix [String] Optional installation prefix (defaults to XDG_DATA_HOME)
-def uninstall(prefix: nil)
-	install_path = Ruby::GDB.install_path(prefix: prefix)
-	
-	if Dir.exist?(install_path)
-		puts "Removing Ruby GDB extensions from: #{install_path}"
-		FileUtils.rm_rf(install_path)
-		puts "Uninstallation complete!"
-	else
-		puts "No installation found at: #{install_path}"
+# Uninstall GDB extensions by removing source line from ~/.gdbinit
+# @parameter gdbinit [String] Optional path to .gdbinit (defaults to ~/.gdbinit)
+def uninstall(gdbinit: nil)
+	gdbinit_path = gdbinit || File.join(Dir.home, ".gdbinit")
+	marker_comment = "# Ruby GDB Extensions (ruby-gdb gem)"
+	
+	puts "Uninstalling Ruby GDB extensions..."
+	
+	unless File.exist?(gdbinit_path)
+		puts "No ~/.gdbinit file found - nothing to uninstall."
+		return
+	end
+	
+	lines = File.readlines(gdbinit_path)
+	marker_index = lines.index{|line| line.strip == marker_comment}
+	
+	unless marker_index
+		puts "Extensions were not found in #{gdbinit_path}"
+		return
+	end
+	
+	# Remove the marker comment and the source line after it
+	lines.delete_at(marker_index)  # Remove comment
+	if marker_index < lines.size && lines[marker_index].strip.start_with?("source")
+		removed_line = lines.delete_at(marker_index).strip  # Remove source line
+		puts "  Removed: #{removed_line}"
 	end
+	
+	# Clean up empty line before marker if it exists
+	if marker_index > 0 && lines[marker_index - 1].strip.empty?
+		lines.delete_at(marker_index - 1)
+	end
+	
+	File.write(gdbinit_path, lines.join)
+	puts "✓ Removed Ruby GDB extensions from #{gdbinit_path}"
 end
 
 # Show installation information
-def info
+# @parameter gdbinit [String] Optional path to .gdbinit (defaults to ~/.gdbinit)
+def info(gdbinit: nil)
+	gdbinit_path = gdbinit || File.join(Dir.home, ".gdbinit")
+	init_py_path = Ruby::GDB.init_script_path
+	marker_comment = "# Ruby GDB Extensions (ruby-gdb gem)"
+	
 	puts "Ruby GDB Extensions v#{Ruby::GDB::VERSION}"
-	puts "\nData directory: #{Ruby::GDB.data_path}"
-	puts "Default install path: #{Ruby::GDB.install_path}"
-	puts "\nAvailable scripts:"
-	puts "  - object.py (rb-object-print command)"
-	puts "  - fiber.py (rb-scan-fibers, rb-fiber-bt, and more)"
+	puts "\nGem data directory: #{Ruby::GDB.data_path}"
+	puts "Init script: #{init_py_path}"
+	
+	# Check installation status by looking for marker comment
+	installed = false
+	current_source = nil
+	
+	if File.exist?(gdbinit_path)
+		lines = File.readlines(gdbinit_path)
+		marker_index = lines.index{|line| line.strip == marker_comment}
+		if marker_index
+			installed = true
+			source_index = marker_index + 1
+			if source_index < lines.size
+				current_source = lines[source_index].strip
+			end
+		end
+	end
+	
+	puts "\nGDB config: #{gdbinit_path}"
+	if installed
+		puts "Status: ✓ Installed"
+		if current_source
+			puts "  #{current_source}"
+		end
+	else
+		puts "Status: ✗ Not installed"
+		puts "\nRun: bake ruby:gdb:install"
+	end
 end
-