RSokoban 0.73 → 0.74

data/lib/rsokoban/level.rb

@@ -5,6 +5,14 @@ module RSokoban
 	class Level
 		attr_reader :floor, :man, :crates, :storages, :title
 		
+		# Get map width of this level, in cells
+		# @return [Fixnum]
+		attr_reader :width
+		
+		# Get map height of this level, in cells
+		# @return [Fixnum]
+		attr_reader :height
+		
 		# I build the level from a RawLevel object.
 		# @example a RawLevel object
 		#   A RawLevel object have got one title and one 'picture'. A 'picture' is an array of string.
@@ -21,6 +29,7 @@ module RSokoban
 		# @param [RawLevel] rawLevel
 		def initialize rawLevel
 			@title = rawLevel.title
+			init_dimension rawLevel.map
 			@floor = init_floor rawLevel.map
 			@man = init_man rawLevel.map
 			@crates = []
@@ -55,43 +64,14 @@ module RSokoban
 			@map
 		end
 		
-		# Move the man one box up.
-		# @return [String] the move's result
-		#   ["ERROR wall"] if the player is stopped by a wall
-		#   ['ERROR wall behind crate'] si le joueur est stoppé par une caisse suivie d'un mur
-		#   ['ERROR double crate'] if the player is stopped by a crate followed by a wall
-		#   ['OK move ?'] if the move is accepted (? is replaced by the number of the move)
-		#   ['WIN move ?'] if the level is completed (? is replaced by the number of the move)
-		def moveUp
-			move :up
-		end
-		
-		# Move the man one box down.
-		# @see #moveUp for more explanation
-		def moveDown
-			move :down
-		end
-		
-		# Move the man one box left.
-		# @see #moveUp for more explanation
-		def moveLeft
-			move :left
-		end
-		
-		# Move the man one box right.
-		# @see #moveUp for more explanation
-		def moveRight
-			move :right
-		end
-		
 		# Move the man one box +direction+.
-		# @see #moveUp for more explanation
+		# @param [:up|:down|:right|:left] direction
+		# @return [MoveResult] the move's result
 		def move direction
-			return 'ERROR wall' if wall?(direction)
-			return 'ERROR wall behind crate' if wall_behind_crate?(direction)
-			return 'ERROR double crate' if double_crate?(direction)
+			return MoveResult.new(:status => :error, :message => 'wall') if wall?(direction)
+			return MoveResult.new(:status => :error, :message => 'wall behind crate') if wall_behind_crate?(direction)
+			return MoveResult.new(:status => :error, :message => 'double crate') if double_crate?(direction)
 			@move += 1
-			
 			@man.send(direction)
 			if @crates.include?(Crate.new(@man.x, @man.y))
 				i = @crates.index(Crate.new(@man.x, @man.y))
@@ -100,8 +80,31 @@ module RSokoban
 			else
 				@move_recorder.record direction
 			end
-			return "WIN move #{@move}" if win?
-			"OK move #{@move}"
+			
+			return MoveResult.new(:status => :win, :move_number => @move) if win?
+			MoveResult.new(:status => :ok, :move_number => @move)
+		end
+		
+		# Redo the last undo
+		# @since 0.74
+		def redo
+			begin
+				case @move_recorder.redo
+					when :up, :UP then direction = :up
+					when :down, :DOWN then direction = :down
+					when :left, :LEFT then direction = :left
+					when :right, :RIGHT then direction = :right
+				end
+				@man.send(direction)
+				@move += 1
+				if @crates.include?(Crate.new(@man.x, @man.y))
+					i = @crates.index(Crate.new(@man.x, @man.y))
+					@crates[i].send(direction)
+				end
+			rescue EmptyRedoError
+				# Nothing to do
+			end
+			MoveResult.new(:status => :ok, :move_number => @move)
 		end
 		
 		# Undo last move
@@ -133,7 +136,14 @@ module RSokoban
 			rescue EmptyMoveQueueError
 				# Nothing to do
 			end
-			"OK move #{@move}"
+			MoveResult.new(:status => :ok, :move_number => @move)
+		end
+		
+		# Get current move number
+		# @return [Fixnum]
+		# @since 0.74
+		def move_number
+			@move
 		end
 		
 		private
@@ -265,6 +275,13 @@ module RSokoban
 			floor
 		end
 		
+		# Initialize map width and map height of this level
+		def init_dimension map
+			@width = 0
+			map.each {|y| @width = y.size if y.size > @width }
+			@height = map.size
+		end
+		
 		# Find the man's position, at the begining of the level.
 		#
 		# @param [Map] map

data/lib/rsokoban/level_loader.rb

@@ -1,27 +1,29 @@
 module RSokoban
 
-	# Je charge le fichier contenant les niveaux du jeu. À ma création, vous m'indiquez un fichier 
-	# au format xsb contenant un ou plusieurs niveaux. 
-	# Vous pouvez ensuite me demander un niveau particulier (un objet Level).
-	# @todo translate, document and refactor
+	# I load a file containing the levels of the game. On instanciation,
+	# you tell me a file (in xsb file format) containing one or more levels.
+	#
+	# You can then ask for a particular level (a Level object). You can use me too
+	# to find the description of a level.
+	# @todo give some examples
+	# @todo document and refactor
 	class LevelLoader
-		attr_reader :level, :set
 	
-		# @param [String] filename le nom du fichier où trouver les niveaux.
-		#   Ce fichier est cherché dans le dossier data/.
-		# @raise [RSokoban::NoFileError] si le fichier n'existe pas
+		# @param [String] filename an xsb filename.
+		#   This file is searched in thedata/ folder.
+		# @raise [RSokoban::NoFileError] if filename doesn't exist
 		# @see LevelSet overview of .xsb file format
 		def initialize filename
 			filename = "#{$RSOKOBAN_DATA_PATH}/" + filename
 			raise NoFileError unless File.exist?(filename)
 			@set = LevelSet.new
 			file = open(filename)
-			@set.title = file.readline.chomp.sub(/;/, '').strip
+			@set.title = file.readline.get_xsb_info_line_chomp
 			file.readline # must be blank line
 			line = file.readline
 			desc = ''
 			while line[0] == ?; do
-				desc += line.sub(/;/, '').sub(/\s*/, '')
+				desc += line.get_xsb_info_line
 				line = file.readline
 			end
 			@set.description = desc
@@ -34,7 +36,7 @@ module RSokoban
 						raw.push line
 						line = file.readline.chomp
 					end
-					line = line.chomp.sub(/;/, '').sub(/\s*/, '')
+					line = line.get_xsb_info_line_chomp
 					@set.rawLevels.push RawLevel.new(line, raw) unless raw.empty?
 					
 					line = file.readline
@@ -48,11 +50,32 @@ module RSokoban
 			end
 		end
 		
+		# Get the level numbered +num+
+		# @param [Fixnum] num a level number in base 1
+		# @return [Level]
 		def level num
 			raise LevelNumberTooHighError if num > @set.rawLevels.size
 			Level.new @set.rawLevels[num-1]
 		end
 		
+		# Get the description field of the loaded set of levels.
+		# @return [String] possibly multi-line
+		def file_description
+			@set.description
+		end
+		
+		# Get number of levels in this set.
+		# @return [Fixnum]
+		def size
+			@set.size
+		end
+		
+		# Get title of this set.
+		# @return [String]
+		def title
+			@set.title
+		end
+		
 	end
 
 end

data/lib/rsokoban/move_recorder.rb

@@ -7,14 +7,25 @@ module RSokoban
 	
 		def initialize
 			@queue = []
+			@redo = []
 		end
 		
-		# @return [:up, :down, :left, :right]
+		# @return [:up, :down, :left, :right, :UP, :DOWN, :LEFT, :RIGHT]
 		# @raise EmptyMoveQueueError
 		# @since 0.73
 		def undo
 			raise EmptyMoveQueueError if @queue.empty?
-			@queue.pop
+			@redo << @queue.pop
+			@redo[-1]
+		end
+		
+		# @return [:up, :down, :left, :right, :UP, :DOWN, :LEFT, :RIGHT]
+		# @raise EmptyRedoError
+		# @since 0.74
+		def redo
+			raise EmptyRedoError if @redo.empty?
+			@queue << @redo.pop
+			@queue[-1]
 		end
 		
 		# Record the move +direction+
@@ -23,6 +34,7 @@ module RSokoban
 		# @since 0.73
 		def record direction, push = nil
 			raise ArgumentError unless [:up, :down, :left, :right].include?(direction)
+			@redo = []
 			if push
 				@queue.push :UP if direction == :up
 				@queue.push :DOWN if direction == :down

data/lib/rsokoban/move_result.rb

@@ -0,0 +1,37 @@
+module RSokoban
+
+	# I am the result content of a move.
+	
+	# @since 0.74
+	class MoveResult
+	
+		# @param [Hash] hash the result
+		# @option hash [Symbol] :status Could be :ok, :win or :error
+		# @option hash [Fixnum] :move_number for a status of :ok or :win
+		# @option hash [String] :message for a status of :error
+		def initialize hash
+			@hash = hash
+		end
+		
+		def [](k)
+			@hash[k]
+		end
+		
+		# @return true if move is ok
+		def ok?
+			@hash[:status] == :ok
+		end
+		
+		# @return true if move result to winning the game
+		def win?
+			@hash[:status] == :win
+		end
+		
+		# @return true if move is an error
+		def error?
+			@hash[:status] == :error
+		end
+		
+	end
+
+end

data/lib/rsokoban/ui/base_ui.rb

@@ -13,9 +13,6 @@ module RSokoban::UI
 		# my childs permit the user to do, they can only return an 
 		# ActionPlayer object.
 		# 
-		# @param [Hash] hash
-		#   :type => type of message, :win or :start or :display or :end_of_set
-		#   :map => current game map
 		# @param [Hash] hash the options passed to the UI.
 		# @option hash [:win|:start|:display|:end_of_set] :type The type of the message (always +requiered+)
 		# @option hash [Map] :map The current map of the game (always +requiered+)

data/lib/rsokoban/ui/console.rb

@@ -47,7 +47,7 @@ module RSokoban::UI
 		
 		def ask_for_next_level
 			printf "Play next level ? "
-			line = readline.chomp
+			line = gets.chomp
 			if ['yes', 'ye', 'y', 'YES', 'YE', 'Y'].include?(line)
 				PlayerAction.new(:next)
 			else
@@ -57,7 +57,7 @@ module RSokoban::UI
 		
 		def ask_player
 			printf "Your choice ? "
-			line = readline.chomp
+			line = gets.chomp
 			response = parse line
 			if response.nil?
 				puts "Error : #{line}"

data/lib/rsokoban/ui/curses_console.rb

@@ -1,5 +1,3 @@
-
-
 module RSokoban::UI
 
 	# I am a console user interface using curses library.

data/lib/rsokoban/ui/player_action.rb

@@ -18,7 +18,7 @@ module RSokoban::UI
 		
 		@@Allowed_symbols = [ :up, :down, :left, :right, :quit, :next, :retry, :undo ]
 		
-		# You can the the {class description}[PlayerAction] for an allowed list of value.
+		# You can look to {PlayerAction} for an allowed list of value.
 		# @param [Object] value optional initial action
 		# @raise ArgumentError if value is not allowed
 		def initialize value = nil
@@ -30,8 +30,8 @@ module RSokoban::UI
 		end
 		
 		# Set the player action.
-		# You can the the {class description}[PlayerAction] for an allowed list of value.
 		# @param [Object] value the player action
+		# @raise ArgumentError if value is not allowed
 		def action=(value)
 			if value.instance_of?(Symbol)
 				raise ArgumentError unless @@Allowed_symbols.include?(value)

data/lib/rsokoban/ui/tk_box.rb

@@ -0,0 +1,21 @@
+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 TkBox
+		
+		# @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
+
+end

data/lib/rsokoban/ui/tk_dialogs.rb

@@ -0,0 +1,240 @@
+module RSokoban::UI
+
+	# As dialog box, I allow the user to choose a specific level number.
+	class TkLevelDialog < TkToplevel
+	
+		# Create and show the dialog
+		# @param [TkRoot|TkToplevel] root the Tk widget I belong to
+		# @param [String] title my window title
+		def initialize(root, title)
+			super(root)
+			title(title)
+			minsize(200, 100)
+			@state = :cancel
+			grab
+			
+			@frame_north = TkFrame.new(self) do
+				grid(:row => 0, :column => 0, :columnspan => 2, :sticky => :we)
+				padx 10
+				pady 10
+			end
+			
+			$spinval = TkVariable.new
+			@spin = TkSpinbox.new(@frame_north) do
+				textvariable($spinval)
+				width 3
+				grid(:row => 0, :column => 0)
+			end
+			@spin.to(999)
+			@spin.from(1)
+			@spin.focus
+			@spin.bind 'Key-Return', proc{ ok_on_clic }
+			
+			@ok = TkButton.new(self) do
+				text 'OK'
+				grid(:row => 1, :column => 0)
+				default :active
+			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
+		
+		# @return true if user clicked the OK button
+		def ok?
+			@state == :ok
+		end
+		
+		# @return [Fixnum] level number
+		def value
+			$spinval.to_i
+		end
+		
+		private
+		
+		def ok_on_clic
+			@state = :ok
+			destroy
+		end
+		
+		def cancel_on_clic
+			@state = :cancel
+			destroy
+		end
+	end
+	
+	# As dialog box, I allow the user to choose a set name.
+	class SetDialog < TkToplevel
+		include RSokoban
+		# Create and show the dialog
+		# @param [TkRoot|TkToplevel] root the Tk widget I belong to
+		# @param [String] title my window title
+		def initialize(root, title)
+			super(root)
+			title(title)
+			width(300)
+			height(400)
+			@state = 'CANCEL'
+			grab
+			self['resizable'] = false, false
+			
+			@xsb = get_xsb
+			$listval = TkVariable.new(@xsb)
+			@value = @xsb[0]
+			
+			# A frame for the listbox
+			@frame_north = TkFrame.new(self) do
+				grid(:row => 0, :column => 0, :columnspan => 2, :sticky => :we)
+				padx 10
+				pady 10
+			end
+			
+			@list = TkListbox.new(@frame_north) do
+				width 40
+			 	height 8
+			 	listvariable $listval
+			 	grid(:row => 0, :column => 0, :sticky => :we)
+			end
+			
+			@list.bind '<ListboxSelect>', proc{ show_description }
+			@list.bind 'Double-1', proc{ ok_on_clic }
+			@list.bind 'Return', proc{ ok_on_clic }
+
+			
+			scroll = TkScrollbar.new(@frame_north) do
+				orient 'vertical'
+				grid(:row => 0, :column => 1, :sticky => :ns)
+			end
+
+			@list.yscrollcommand(proc { |*args| scroll.set(*args) })
+			scroll.command(proc { |*args| @list.yview(*args) })
+			
+			# A frame for the set description
+			@frame_desc = TkFrame.new(self) do
+				grid(:row => 1, :column => 0, :columnspan => 2, :sticky => :we)
+				padx 10
+				pady 10
+			end
+			
+			@desc = TkText.new(@frame_desc) do
+				borderwidth 1
+				font TkFont.new('times 12')
+				width 40
+				height 10
+				wrap :word
+			 	grid(:row => 0, :column => 0)
+			end
+			
+			scroll2 = TkScrollbar.new(@frame_desc) do
+				orient 'vertical'
+				grid(:row => 0, :column => 1, :sticky => :ns)
+			end
+
+			@desc.yscrollcommand(proc { |*args| scroll2.set(*args) })
+			scroll2.command(proc { |*args| @desc.yview(*args) }) 
+			
+			# The buttons
+			@ok = TkButton.new(self) do
+				text 'OK'
+				grid(:row => 2, :column => 0)
+				default :active
+			end
+			@ok.command { ok_on_clic }
+			
+			@cancel = TkButton.new(self) do
+				text 'Cancel'
+				grid(:row => 2, :column => 1)
+			end
+			@cancel.command { cancel_on_clic }
+			
+			@list.focus
+			wait_destroy
+		end
+		
+		# @return true if user clicked the OK button
+		def ok?
+			@state == 'OK'
+		end
+		
+		# @return [String] the name of the set
+		def value
+			@value
+		end
+		
+		private
+		
+		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 get_xsb
+			current = Dir.pwd
+			Dir.chdir $RSOKOBAN_DATA_PATH
+			ret = Dir.glob '*.xsb'
+			Dir.chdir current
+			ret
+		end
+		
+		def show_description
+			idx = @list.curselection
+			ll = LevelLoader.new @xsb[idx[0]]
+			@desc.delete '1.0', :end
+			@desc.insert :end, ll.file_description
+		end
+	end
+	
+	# As dialog box, I display some help.
+	class HelpDialog < TkToplevel
+		# Create and show the dialog
+		# @param [TkRoot|TkToplevel] root the Tk widget I belong to
+		# @param [String] title my window title
+		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
+	
+end