RSokoban 0.73 → 0.74

data/lib/rsokoban/ui/tk_ui.rb

@@ -1,256 +1,148 @@
-#require 'tk'
-#require 'tkextlib/tkimg'
-
 module RSokoban::UI
-
-	# I am an image of the game who knows how to display itself on an array
-	# of TkLabel items.
-	# @since 0.73
-	class Image
-		
-		# @param [String] file path of image file
-		# @param [Array<Array<TkLabel>>] output an array to display myself
-		def initialize file, output
-			@box = TkPhotoImage.new('file' => file, 'height' => 0, 'width' => 0)
-			@output = output
-		end
-		
-		# Display myself at x,y coordinate
-		def display_at x, y
-			@output[y][x].configure('image' => @box)
-		end
-		
-	end
-	
-	class LevelDialog < TkToplevel
-		def initialize(root, title)
-			super(root)
-			title(title)
-			minsize(200, 100)
-			@state = 'CANCEL'
-			grab
-			
-			$spinval = TkVariable.new
-			@spin = TkSpinbox.new(self) do
-				textvariable($spinval)
-				grid('row'=>0, 'column'=>0)
-			end
-			@spin.to(999)
-			@spin.from(1)
-			
-			@ok = TkButton.new(self) do
-				text 'OK'
-				grid('row'=>1, 'column'=>0)
-			end
-			@ok.command { ok_on_clic }
-			
-			@cancel = TkButton.new(self) do
-				text 'Cancel'
-				grid('row'=>1, 'column'=>1)
-			end
-			@cancel.command { cancel_on_clic }
-			
-			wait_destroy
-		end
-		
-		def ok_on_clic
-			@state = 'OK'
-			destroy
-		end
-		
-		def cancel_on_clic
-			@state = 'CANCEL'
-			destroy
-		end
-		
-		def ok?
-			@state == 'OK'
-		end
-		
-		def value
-			$spinval.to_i
-		end
-	end
-	
-	class SetDialog < TkToplevel
-		def initialize(root, title)
-			super(root)
-			title(title)
-			minsize(200, 100)
-			@state = 'CANCEL'
-			grab
-			
-			@value = nil
-			@xsb = get_xsb
-			$listval = TkVariable.new(@xsb)
-
-			@list = TkListbox.new(self) do
-				width 20
-			 	height 8
-			 	listvariable $listval
-			 	grid('row'=>0, 'column'=>0)
-			end
-			
-			@ok = TkButton.new(self) do
-				text 'OK'
-				grid('row'=>1, 'column'=>0)
-			end
-			@ok.command { ok_on_clic }
-			
-			@cancel = TkButton.new(self) do
-				text 'Cancel'
-				grid('row'=>1, 'column'=>1)
-			end
-			@cancel.command { cancel_on_clic }
-			
-			wait_destroy
-		end
-		
-		def ok_on_clic
-			@state = 'OK'
-			idx = @list.curselection
-			unless idx.empty?
-				@value = @xsb[idx[0]]
-			end
-			destroy
-		end
-		
-		def cancel_on_clic
-			@state = 'CANCEL'
-			destroy
-		end
-		
-		def ok?
-			@state == 'OK'
-		end
-		
-		def value
-			@value
-		end
-		
-		def get_xsb
-			current = Dir.pwd
-			Dir.chdir $RSOKOBAN_DATA_PATH
-			ret = Dir.glob '*.xsb'
-			Dir.chdir current
-			ret
-		end
-	end
-	
-	class HelpDialog < TkToplevel
-		def initialize(root, title)
-			super(root)
-			title(title)
-			minsize(200, 100)
-
-			text = TkText.new(self) do
-				borderwidth 1
-				font TkFont.new('times 12 bold')
-				grid('row' => 0, 'column' => 0)
-			end
-			
-			help=<<EOS
-Welcome to RSokoban !
-
-Goal of Sokoban game is to place each crate on a storage location.
-Move the man using the arrow keys.
-For a more comprehensive help, please visit the wiki at https://github.com/lkdjiin/RSokoban/wiki.
-EOS
-			
-			text.insert 'end', help
-
-			@ok = TkButton.new(self) do
-				text 'OK'
-				grid('row'=>1, 'column'=>0)
-			end
-			@ok.command { ok_on_clic }
-		end
-		
-		def ok_on_clic
-			destroy
-		end
-	end
 	
 	# I am a GUI using tk library.
 	# @note I need the tk-img extension library.
 	# @since 0.73
-	# @todo a lot of refactoring is needed. There is a lot of duplicated code with Game,
-	#   and maybe Level and BaseUI.
-	# @todo need some more documentation
+	# @todo need some examples and more documentation for private methods
 	class TkUI
-	
-		def initialize
-			@level_loader = RSokoban::LevelLoader.new "microban.xsb"
-			@level_number = 1
-			@level = @level_loader.level(@level_number)
-			@move = 0
+		include RSokoban
+		
+		# Build and initialize a GUI with the Tk tool kit.
+		# @param [Game] game Where we get the logic.
+		def initialize game
+			@game = game
 			@last_move = :up
 			@tk_map = []
 			init_gui
-			display
+			start_level
+		end
+		
+		# Start the event loop.
+		# @since 0.74
+		def run
 			Tk.mainloop 
 		end
 		
 		private
 		
 		def next_level
-			@level_number += 1
-			start_level
+			begin
+				@game.next_level
+				init_level
+			rescue LevelNumberTooHighError
+				Tk::messageBox :message => "Sorry, no level ##{@game.level_number} in this set."
+			end
 		end
 		
 		def start_level
 			begin
-				@level = @level_loader.level(@level_number)
-				@move = 0
-				reset_labels
-				reset_map
-				display
-			rescue RSokoban::LevelNumberTooHighError
-				Tk::messageBox :message => "Sorry, no level ##{@level_number} in this set."
+				@game.start_level
+				init_level
+			rescue LevelNumberTooHighError
+				Tk::messageBox :message => "Sorry, no level ##{@game.level_number} in this set."
 			end
 		end
 		
 		def load_level
-			d =  LevelDialog.new(@tk_root, "Load a level")
-			if d.ok?
-				@level_number = d.value
-				start_level
+			d =  TkLevelDialog.new(@tk_root, "Load a level")
+			return unless d.ok?
+			begin
+				@game.load_level d.value
+				init_level
+			rescue LevelNumberTooHighError
+				Tk::messageBox :message => "Sorry, no level ##{@game.level_number} in this set."
 			end
 		end
 		
 		def load_set
 			d =  SetDialog.new(@tk_root, "Load a set")
-			new_set = d.value
-			if d.ok? and new_set != nil
-				@level_loader = RSokoban::LevelLoader.new new_set
-				@level_number = 1
-				start_level
+			return unless d.ok?
+			return if d.value.nil?
+			@game.load_a_new_set d.value
+			init_level
+		end
+		
+		# For now, map size is restricted to 19x16 on screen.
+		def init_level
+			if @game.level_width > 19 or @game.level_height > 16
+				Tk::messageBox :message => "Sorry, level '#{@game.level_title}' is too big to be displayed."
+				@game.restart_set
+			end
+			reset_labels
+			reset_map
+			display_initial
+		end
+		
+		# Update map rendering. We need only to update man's location and north, south, west
+		# and east of him. And because there walls all around the map, there is no needs to check
+		# for limits.
+		def display_update
+			x = @game.man_x
+			y = @game.man_y
+			update_array = [[x,y], [x+1,y], [x-1,y], [x,y+1], [x,y-1]]
+			update_array.each do |x, y|
+				case @game.map[y][x].chr
+					when WALL then @wall.display_at x, y
+					when FLOOR then @floor.display_at x, y
+					when CRATE then @crate.display_at x, y
+					when STORAGE then @store.display_at x, y
+					when MAN then display_man_at x, y
+					when MAN_ON_STORAGE then display_man_on_storage_at x, y
+					when CRATE_ON_STORAGE then @crate_store.display_at x, y
+				end
+			end
+		end
+		
+		def display_update_after_undo
+			x = @game.man_x
+			y = @game.man_y
+			update_array = [[x,y], [x+1,y], [x+2,y], [x-1,y], [x-2,y], [x,y+1], [x,y+2], [x,y-1], [x,y-2]]
+			update_array.each do |x, y|
+				next if x < 0 or y < 0
+				next if @game.map[y].nil? or @game.map[y][x].nil?
+				display_cell_taking_care_of_outside @game.map[y][x].chr, x, y
 			end
 		end
 		
-		# Display the current map (current state of the level) on screen.
-		def display
+		# Display the initial map on screen.
+		def display_initial
 			y = 0
-			@level.map.each do |row|
+			@game.map.each do |row|
 				# find first wall
 				x = row.index(RSokoban::WALL)
 				line = row.strip
 				line.each_char do |char|
-					case char
-						when RSokoban::WALL then @wall.display_at x, y
-						when RSokoban::FLOOR then @floor.display_at x, y
-						when RSokoban::CRATE then @crate.display_at x, y
-						when RSokoban::STORAGE then @store.display_at x, y
-						when RSokoban::MAN then display_man_at x, y
-						when RSokoban::MAN_ON_STORAGE then display_man_on_storage_at x, y
-						when RSokoban::CRATE_ON_STORAGE then @crate_store.display_at x, y
-					end
+					display_cell_taking_care_of_outside char, x, y
 					x += 1
 				end
 				y += 1
 			end
 		end
 		
+		def display_cell_taking_care_of_outside char, x, y
+			case char
+				when WALL then @wall.display_at x, y
+				when FLOOR then display_floor_at x, y
+				when CRATE then @crate.display_at x, y
+				when STORAGE then @store.display_at x, y
+				when MAN then display_man_at x, y
+				when MAN_ON_STORAGE then display_man_on_storage_at x, y
+				when CRATE_ON_STORAGE then @crate_store.display_at x, y
+			end
+		end
+		
+		def display_floor_at x, y
+			return if y == 0
+			height = y - 1
+			height.downto(0).each {|row|
+				break if @game.map[row][x].nil?
+				if [WALL, FLOOR, CRATE, STORAGE].include?(@game.map[row][x].chr)
+					@floor.display_at x, y
+					break
+				end
+			}
+		end
+		
 		def display_man_at x, y
 			case @last_move
 				when :up then @man_up.display_at x, y
@@ -302,8 +194,10 @@ EOS
 			file.add :command, :label => 'Load level', :command => proc{load_level}, :accelerator => 'Ctrl+L'
 			file.add :command, :label => 'Load set', :command => proc{load_set}
 			file.add :separator
-			file.add :command, :label => 'Undo', :command => proc{undo}, :accelerator => 'Ctrl+U'
+			file.add :command, :label => 'Undo', :command => proc{undo}, :accelerator => 'Ctrl+Z'
+			file.add :command, :label => 'Redo', :command => proc{my_redo}, :accelerator => 'Ctrl+Y'
 			file.add :command, :label => 'Restart level', :command => proc{start_level}, :accelerator => 'Ctrl+R'
+			file.add :command, :label => 'Next level', :command => proc{next_level}, :accelerator => 'Ctrl+N'
 			file.add :separator
 			file.add :command, :label => 'Quit', :command => proc{exit}
 			
@@ -313,33 +207,33 @@ EOS
 		end
 		
 		def init_labels
-			@tk_label_set = TkLabel.new(@tk_root) do
-			 	grid('row' => 0, 'column' => 0, 'columnspan' => 19, 'sticky' => 'w')
+			@tk_frame_label = TkFrame.new(@tk_root) do
+				grid('row' => 0, 'column' => 0, 'columnspan' => 19, 'sticky' => 'w')
+				padx 5
+				pady 5
 			end
-			@tk_label_level = TkLabel.new(@tk_root) do
-				grid('row'=>1, 'column'=>0, 'columnspan' => 19, 'sticky' => 'w')
+			@tk_label_set = TkLabel.new(@tk_frame_label) do
+			 	grid('row' => 0, 'column' => 0, 'sticky' => 'w')
 			end
-			@tk_label_move = TkLabel.new(@tk_root) do
-				grid('row'=>2, 'column'=>0, 'columnspan' => 19, 'sticky' => 'w')
+			@tk_label_level = TkLabel.new(@tk_frame_label) do
+				grid('row'=>1, 'column'=> 0, 'sticky' => 'w')
 			end
-			@tk_label_separator = TkLabel.new(@tk_root) do
-				text("")
-				grid('row'=>4, 'column'=>0, 'columnspan' => 19)
+			@tk_label_move = TkLabel.new(@tk_frame_label) do
+				grid('row'=>2, 'column'=>0, 'sticky' => 'w')
 			end
-			reset_labels
 		end
 		
 		def reset_labels
-			@tk_label_set.configure('text' => "Set: #{@level_loader.set.title}")
-			@tk_label_level.configure('text' => "Level: #{@level.title} (#{@level_number}/#{@level_loader.set.size})")
+			@tk_label_set.configure('text' => "Set: #{@game.set_title}")
+			@tk_label_level.configure('text' => "Level: #{@game.level_title} (#{@game.level_number}/#{@game.set_size})")
 			update_move_information
 		end
 		
 		def update_move_information
-			@tk_label_move.configure('text' => "Move: #{@move}")
+			@tk_label_move.configure('text' => "Move: #{@game.move_number}")
 		end
 		
-		# Build the map of labels. Images of the game will be displayed on those labels.
+		# Build the map of labels. TkBoxs of the game will be displayed on those labels.
 		def init_map
 			row_in_grid = 5
 			(0...16).each {|row_index|
@@ -367,24 +261,33 @@ EOS
 		end
 		
 		def init_buttons
-			@tk_undo_button = TkButton.new(@tk_root) do
+			@tk_frame_button = TkFrame.new(@tk_root) do
+				grid('row' => 1, 'column' => 0, 'columnspan' => 19, 'sticky' => 'w')
+				padx 5
+				pady 5
+			end
+			@tk_undo_button = TkButton.new(@tk_frame_button) do
 				text 'Undo'
-				grid('row'=>3, 'column'=>0, 'columnspan' => 3)
+				grid('row'=> 0, 'column'=> 0)
+			end
+			@tk_redo_button = TkButton.new(@tk_frame_button) do
+				text 'Redo'
+				grid('row'=> 0, 'column'=> 1)
 			end
 			
-			@tk_retry_button = TkButton.new(@tk_root) do
+			@tk_retry_button = TkButton.new(@tk_frame_button) do
 				text 'Retry'
-				grid('row'=>3, 'column'=>3, 'columnspan' => 3)
+				grid('row'=> 0, 'column'=> 2)
 			end
 			
-			@tk_level_button = TkButton.new(@tk_root) do
+			@tk_level_button = TkButton.new(@tk_frame_button) do
 				text 'Level'
-				grid('row'=>3, 'column'=>6, 'columnspan' => 3)
+				grid('row'=> 0, 'column'=> 3)
 			end
 			
-			@tk_set_button = TkButton.new(@tk_root) do
-				text 'Set'
-				grid('row'=>3, 'column'=>9, 'columnspan' => 3)
+			@tk_next_level_button = TkButton.new(@tk_frame_button) do
+				text 'Next'
+				grid('row'=> 0, 'column'=> 4)
 			end
 		end
 		
@@ -394,36 +297,41 @@ EOS
 			@tk_root.bind('Down') { move :down }
 			@tk_root.bind('Left') { move :left }
 			@tk_root.bind('Right') { move :right }
-			@tk_root.bind('Control-u') { undo }
+			@tk_root.bind('Control-z') { undo }
+			@tk_root.bind('Control-y') { my_redo }
 			@tk_root.bind('Control-r') { start_level }
 			@tk_root.bind('Control-l') { load_level }
+			@tk_root.bind('Control-n') { next_level }
 			@tk_root.bind('F1') { help }
 			@tk_undo_button.command { undo }
+			@tk_redo_button.command { my_redo }
 			@tk_retry_button.command { start_level }
 			@tk_level_button.command { load_level }
-			@tk_set_button.command { load_set }
+			@tk_next_level_button.command { next_level }
 		end
 		
 		def undo
-			result = @level.undo
-			@move = get_move_number_from_result_of_last_move result
+			result = @game.undo
 			update_move_information
-			display
+			display_update_after_undo
+		end
+		
+		def my_redo
+			result = @game.redo
+			update_move_information
+			display_update_after_undo
 		end
 		
 		# Send the move to Level and process response.
-		# @todo the last move is recorded here to permit the display of the man
-		#   in the 4 direction. This is a bad thing ! Level#move should returns a hash
-		#   with all needed information (status, move number, last move, error message, etc.)
+		# @param [:ip, :down, :left, :right]
 		def move symb
 			@last_move = symb
-			result = @level.move symb
-			unless result.start_with?('ERROR')
-				@move = get_move_number_from_result_of_last_move result
+			result = @game.move symb
+			unless result.error?
 				update_move_information
-				display
+				display_update
 			end
-			if result.start_with?('WIN')
+			if result.win?
 				response = Tk::messageBox :type => 'yesno', :message => "Level completed !\nPlay next level ?", 
 	    						:icon => 'question', :title => 'You win !', :parent => @tk_root, :default => 'yes'
 	    	next_level if response == 'yes'
@@ -431,29 +339,22 @@ EOS
 			end
 		end
 		
-		# Assuming that result start with 'OK' or 'WIN'
-		# @return [Fixnum] current move number
-		def get_move_number_from_result_of_last_move result
-			move_index = result =~ /\d+/
-			result[move_index..-1].to_i
-		end
-		
 		def preload_images
 			dir = $RSOKOBAN_PATH + '/skins/default/'
-			@wall = Image.new(dir + 'wall.bmp', @tk_map)
-			@crate = Image.new(dir + 'crate.bmp', @tk_map)
-			@floor = Image.new(dir + 'floor.bmp', @tk_map)
-			@store = Image.new(dir + 'store.bmp', @tk_map)
-			@man_up = Image.new(dir + 'man_up.bmp', @tk_map)
-			@man_down = Image.new(dir + 'man_down.bmp', @tk_map)
-			@man_left = Image.new(dir + 'man_left.bmp', @tk_map)
-			@man_right = Image.new(dir + 'man_right.bmp', @tk_map)
-			@crate_store = Image.new(dir + 'crate_store.bmp', @tk_map)
-			@man_store_up = Image.new(dir + 'man_store_up.bmp', @tk_map)
-			@man_store_down = Image.new(dir + 'man_store_down.bmp', @tk_map)
-			@man_store_left = Image.new(dir + 'man_store_left.bmp', @tk_map)
-			@man_store_right = Image.new(dir + 'man_store_right.bmp', @tk_map)
-			@outside = Image.new(dir + 'outside.bmp', @tk_map)
+			@wall = TkBox.new(dir + 'wall.bmp', @tk_map)
+			@crate = TkBox.new(dir + 'crate.bmp', @tk_map)
+			@floor = TkBox.new(dir + 'floor.bmp', @tk_map)
+			@store = TkBox.new(dir + 'store.bmp', @tk_map)
+			@man_up = TkBox.new(dir + 'man_up.bmp', @tk_map)
+			@man_down = TkBox.new(dir + 'man_down.bmp', @tk_map)
+			@man_left = TkBox.new(dir + 'man_left.bmp', @tk_map)
+			@man_right = TkBox.new(dir + 'man_right.bmp', @tk_map)
+			@crate_store = TkBox.new(dir + 'crate_store.bmp', @tk_map)
+			@man_store_up = TkBox.new(dir + 'man_store_up.bmp', @tk_map)
+			@man_store_down = TkBox.new(dir + 'man_store_down.bmp', @tk_map)
+			@man_store_left = TkBox.new(dir + 'man_store_left.bmp', @tk_map)
+			@man_store_right = TkBox.new(dir + 'man_store_right.bmp', @tk_map)
+			@outside = TkBox.new(dir + 'outside.bmp', @tk_map)
 		end
 		
 		def help