RSokoban 0.71 → 0.73

data/lib/rsokoban/move_recorder.rb

@@ -0,0 +1,38 @@
+module RSokoban
+
+	# I can record the moves of a game and restitute them one by one, 
+	# started from the last one. I am very usefull to implement an
+	# undo feature.
+	class MoveRecorder
+	
+		def initialize
+			@queue = []
+		end
+		
+		# @return [:up, :down, :left, :right]
+		# @raise EmptyMoveQueueError
+		# @since 0.73
+		def undo
+			raise EmptyMoveQueueError if @queue.empty?
+			@queue.pop
+		end
+		
+		# Record the move +direction+
+		# @param [:up, :down, :left, :right] direction
+		# @raise ArgumentError if +direction+ is not included in [:up, :down, :left, :right]
+		# @since 0.73
+		def record direction, push = nil
+			raise ArgumentError unless [:up, :down, :left, :right].include?(direction)
+			if push
+				@queue.push :UP if direction == :up
+				@queue.push :DOWN if direction == :down
+				@queue.push :LEFT if direction == :left
+				@queue.push :RIGHT if direction == :right
+			else
+				@queue.push direction
+			end
+		end
+		
+	end
+
+end

data/lib/rsokoban/option.rb

@@ -5,41 +5,50 @@ class Option
 
 	# Here is a list of command line options :
 	# * --curses
-	# * --version
-	# * --license
 	# * --help
 	# * --help-output
+	# * --license
 	# * --portable
+	# * --tk
+	# * --version
 	# @todo refactoring
 	def initialize
-		@options = {:ui => :curses}
+		# Default option(s)
+		@options = {:ui => :tk}
 		
 		optparse = OptionParser.new do|opts|
 		 	opts.banner = "Usage: #{$0} [options]"
    		
+   		# Options that define the UI
    		opts.on( '-c', '--curses', 'Use curses console for user interface (default)' ) do
      		@options[:ui] = :curses
    		end
    		
-   		@options[:help_output] = false
-   		opts.on( '-o', '--help-output', 'Print help on output options and exit' ) do
-     		@options[:help_output] = true
+   		opts.on( '-p', '--portable', 'Use standard console for user interface' ) do
+     		@options[:ui] = :portable
    		end
    		
+   		opts.on( '-t', '--tk', 'Make use of Tk library for a graphical user interface' ) do
+     		@options[:ui] = :tk
+   		end
+   		
+   		# Options that display a few information
    		@options[:license] = false
    		opts.on( '-l', '--license', 'Print program\'s license and exit' ) do
      		@options[:license] = true
    		end
    		
-   		opts.on( '-p', '--portable', 'Use standard console for user interface' ) do
-     		@options[:ui] = :portable
-   		end
-   		
    		@options[:version] = false
    		opts.on( '-v', '--version', 'Print version number and exit' ) do
      		@options[:version] = true
    		end
    		
+   		# Options that display some help
+   		@options[:help_output] = false
+   		opts.on( '-o', '--help-output', 'Print help on output options and exit' ) do
+     		@options[:help_output] = true
+   		end
+   		
    		opts.on( '-h', '--help', 'Display this screen' ) do
      		puts opts
      		exit
@@ -62,10 +71,14 @@ class Option
 		@options[k]
 	end
 	
+	def interface=(k)
+		@options[:ui] = k
+	end
+	
 private
 
 	def print_version
-		puts RSokoban::VERSION
+		puts File.read($RSOKOBAN_PATH + '/VERSION').strip
 		exit
 	end
 	
@@ -77,7 +90,7 @@ private
 	def print_help_output
 		help=<<EOS
 
-RSokoban can use 2 user interfaces :
+RSokoban can use 3 user interfaces :
 
   --curses
     This is the default UI. It uses the curses library in a console window.
@@ -86,6 +99,10 @@ RSokoban can use 2 user interfaces :
   --portable
     It uses a plain console window. This UI is boring but should work
     everywhere.
+    
+  --tk
+    The only graphical UI for now. Make sure tk is installed on your computer
+    along with the libtk-img extension library.
 EOS
 		puts help
 		exit

data/lib/rsokoban/raw_level.rb

@@ -1,14 +1,25 @@
 module RSokoban
 
 	# I figure out a level in a very simple format.
-	# I have a title and an array of string (named +picture+), representing the map.
+	# I have a title and a map.
 	# @todo document and give some examples
 	class RawLevel
-		attr_accessor :title, :picture
+		attr_reader :map
+		attr_accessor :title
 		
-		def initialize title = 'Unknown level title', picture = []
+		def initialize title = 'Unknown level title', map = Map.new
 			@title = title
-			@picture = picture
+			@map = map
+		end
+		
+		def map=(val)
+			if val.kind_of?(Map)
+				@map = val
+			elsif val.kind_of?(Array)
+				@map = Map.new val
+			else 
+				raise ArgumentError
+			end
 		end
 		
 	end

data/lib/rsokoban/ui/base_ui.rb

@@ -0,0 +1,37 @@
+module RSokoban::UI
+		
+	# Every concrete UI should inherits from me.
+	# @abstract Subclass and override {#get_action} to implement a working UI.
+	class BaseUI
+	
+		def initialize
+			@level_title = ''
+		end
+		
+		# Based on things found in the +hash+ argument, I display the game
+		# to the user. Then he can tell what he wants to do. Whatever
+		# 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+)
+		# @option hash [String] :title The level's title (requiered if type==:start)
+		# @option hash [String] :set The set's title (requiered if type==:start)
+		# @option hash [Fixnum] :number The level's number (requiered if type==:start)
+		# @option hash [Fixnum] :total Number of level in this set (requiered if type==:start)
+		# @option hash [Fixnum] :move The move's number (requiered when type is :display or :win)
+		# @option hash [String] :error An error message. Could happen when type is :display or :start
+		# @return [PlayerAction] the user's action
+		# @since 0.73
+		# @todo write some examples
+		def get_action(hash)
+			raise "Please implement me !"
+		end
+		
+	end
+	
+end

data/lib/rsokoban/ui/console.rb

@@ -11,51 +11,60 @@ module RSokoban::UI
 			super()
 		end
 		
-		def get_action(type, level, message)
-			@level_title = message if type == 'START'
-			message = 'OK move 0' if type == 'START'
-			display level, message
-			if type == 'DISPLAY' or type == 'START'
-				askPlayer
+		def get_action(hash)
+			if hash[:type] == :start
+				@level_title = hash[:title] 
+				@set_title = hash[:set]
+				@level_number = hash[:number]
+				@set_total = hash[:total]
+			end
+			display hash
+			if [:display, :start].include?(hash[:type])
+				ask_player
 			else
 				# assuming type == 'WIN'
-				askForNextLevel
+				ask_for_next_level
 			end
 		end
 		
 		private
 		
-		def display level, message
+		def display hash
 			blankConsole = "\n" * 24 # assuming a console window of 24 lines height
 			puts blankConsole
-			puts @level_title
+			puts "Set: #{@set_title}"
+			puts "Level: #{@level_title} (#{@level_number}/#{@set_total})"
 			puts "--------------------"
-			puts message
+			unless hash[:move].nil?
+				puts "move #{hash[:move]}"
+			else
+				puts ''
+			end
 			puts ''
-			level.each {|line| puts line }
+			hash[:map].each {|line| puts line }
 			puts ''
 		end
 		
-		def askForNextLevel
+		def ask_for_next_level
 			printf "Play next level ? "
 			line = readline.chomp
 			if ['yes', 'ye', 'y', 'YES', 'YE', 'Y'].include?(line)
-				:next
+				PlayerAction.new(:next)
 			else
-				:quit
+				PlayerAction.new(:quit)
 			end
 		end
 		
-		def askPlayer
+		def ask_player
 			printf "Your choice ? "
 			line = readline.chomp
 			response = parse line
 			if response.nil?
 				puts "Error : #{line}"
-				askPlayer
-			elsif response == :help
-				displayHelp
-				askPlayer
+				ask_player
+			elsif response.instance_of?(Symbol) and response == :help
+				display_help
+				ask_player
 			else
 				response
 			end
@@ -63,24 +72,24 @@ module RSokoban::UI
 		
 		def parse str
 			case str
-				when 'quit', 'up', 'down', 'right', 'left', 'retry', 'help'
-					str.to_sym
-				when 'z'
-					:up
-				when 's'
-					:down
-				when 'q'
-					:left
-				when 'd'
-					:right
+				when 'quit', 'up', 'down', 'right', 'left', 'retry', 'undo'
+					PlayerAction.new(str.to_sym)
+				when 'help' then :help
+				when 'z' then PlayerAction.new(:up)
+				when 's' then PlayerAction.new(:down)
+				when 'q' then PlayerAction.new(:left)
+				when 'd' then PlayerAction.new(:right)
 				when '1'..'999'
-					str.to_i
-				when /\.xsb$/
-					str
+					if str.to_i > @set_total
+						ask_player
+					else
+					 	PlayerAction.new(str.to_i)
+					 end
+				when /\.xsb$/ then PlayerAction.new(str)
 			end
 		end
 		
-		def displayHelp
+		def display_help
 			help=<<EOS
 ------------------------------
 General commands :
@@ -88,6 +97,7 @@ General commands :
 quit         : Quit game
 help         : Display this screen
 retry        : Restart level
+undo         : Undo last move
 1 to 999     : Play this level
 file.xsb     : Load this set of levels
 

data/lib/rsokoban/ui/curses_console.rb

@@ -1,4 +1,4 @@
-require 'curses'
+
 
 module RSokoban::UI
 
@@ -6,10 +6,11 @@ module RSokoban::UI
 	# I assume 24 lines height.
 	class CursesConsole < BaseUI
 	
-		@@TITLE_LINE = 0
-		@@MOVES_LINE = 1
-		@@STATUS_LINE = 2
-		@@PICTURE_LINE = 4
+		@@SET_LINE = 0
+		@@TITLE_LINE = 1
+		@@MOVES_LINE = 2
+		@@STATUS_LINE = 3
+		@@PICTURE_LINE = 5
 		
 		def initialize
 			super()
@@ -18,17 +19,19 @@ module RSokoban::UI
 			Curses.close_screen
 		end
 		
-		def get_action(type, level, message)
-			if type == 'START' or type == 'END_OF_SET'
-				@level_title = message 
-				message = 'OK move 0'
+		def get_action(hash)
+			if hash[:type] == :start
+				@level_title = hash[:title]
+				@set_title = hash[:set]
+				@level_number = hash[:number]
+				@set_total = hash[:total]
 				Curses.clear
 			end
-			if type == 'DISPLAY' or type == 'START'  or type == 'END_OF_SET'
-				ask_player level, message
+			if [:display, :start].include?(hash[:type]) 
+				ask_player hash
 			else
-				# assuming type == 'WIN'
-				askForNextLevel level, message
+				# assuming :win
+				ask_for_next_level hash
 			end
 		end
 		
@@ -41,13 +44,13 @@ module RSokoban::UI
 			Curses.curs_set 0
 		end
 		
-		def display level, message
-			write @@TITLE_LINE, 0, @level_title
-			move_index = message =~ /\d+/
-			write @@MOVES_LINE, 0, 'moves : ' + message[move_index..-1] if move_index
-			write @@STATUS_LINE, 0, 'arrows=move (q)uit (r)etry (l)oad level/set'
+		def display hash
+			write @@SET_LINE, 0, "Set: #{@set_title}"
+			write @@TITLE_LINE, 0, "Level: #{@level_title} (#{@level_number}/#{@set_total})"
+			write @@MOVES_LINE, 0, "moves : #{hash[:move].to_s}   " unless hash[:move].nil?
+			write @@STATUS_LINE, 0, 'arrows=move (q)uit (r)etry (u)ndo (l)oad level/set'
 			line_num = @@PICTURE_LINE
-			level.each {|line| 
+			hash[:map].each {|line| 
 				write line_num, 0, line
 				line_num += 1
 			}
@@ -58,22 +61,22 @@ module RSokoban::UI
 			Curses.addstr(text);
 		end
 		
-		def askForNextLevel level, message
-			display level, message
+		def ask_for_next_level hash
+			display hash
 			write @@STATUS_LINE, 0, "LEVEL COMPLETED ! Play next level ? (yes, no)        "
 			case Curses.getch
-				when ?n, ?N then :quit
-				when ?y, ?Y then :next
+				when ?n, ?N then PlayerAction.new(:quit)
+				when ?y, ?Y then PlayerAction.new(:next)
 				else
-					askForNextLevel level, message
+					ask_for_next_level hash
 			end
 		end
 		
-		def ask_player level, message
-			display level, message
+		def ask_player hash
+			display hash
 			response = get_player_input
 			if response.nil?
-				ask_player level, message
+				ask_player hash
 			else
 				response
 			end
@@ -81,13 +84,14 @@ module RSokoban::UI
 		
 		def get_player_input
 			case Curses.getch
-				when Curses::Key::UP then :up
-    		when Curses::Key::DOWN then :down
-    		when Curses::Key::LEFT then :left
-    		when Curses::Key::RIGHT then :right
-    		when ?q, ?Q then :quit
-    		when ?r, ?R then :retry
+				when Curses::Key::UP then PlayerAction.new(:up)
+    		when Curses::Key::DOWN then PlayerAction.new(:down)
+    		when Curses::Key::LEFT then PlayerAction.new(:left)
+    		when Curses::Key::RIGHT then PlayerAction.new(:right)
+    		when ?q, ?Q then PlayerAction.new(:quit)
+    		when ?r, ?R then PlayerAction.new(:retry)
     		when ?l, ?L then ask_level_or_set
+    		when ?u, ?U then PlayerAction.new(:undo)
     		else
     			nil
 			end
@@ -111,10 +115,15 @@ EOS
 			Curses.curs_set 0
 			Curses.noecho
 			case str
-				when '1'..'999' then str.to_i
-				when /\.xsb$/ then str
+				when '1'..'999'
+					if str.to_i > @set_total
+						ask_level_or_set
+					else
+						PlayerAction.new(str.to_i)
+					end
+				when /\.xsb$/ then PlayerAction.new(str)
 				else
-					:retry
+					PlayerAction.new(:retry)
 			end
 		end
 		

data/lib/rsokoban/ui/player_action.rb

@@ -0,0 +1,74 @@
+module RSokoban::UI
+
+	# I am an action from the player.
+	#
+	# List of possible actions :
+	# [:quit]                      to quit game
+	# [:next]                      to load and play next level
+	# [:retry]                     to restart the current level
+	# [:up, :down, :left, :right]  to move the man
+	# [:undo]                      to undo a move
+	# [a number]                   to load this level number
+	# [an .xsb filename]           to load the set with this name
+	#
+	# @since 0.73
+	class PlayerAction
+		# @param [Object] the action
+		attr_reader :action
+		
+		@@Allowed_symbols = [ :up, :down, :left, :right, :quit, :next, :retry, :undo ]
+		
+		# You can the the {class description}[PlayerAction] for an allowed list of value.
+		# @param [Object] value optional initial action
+		# @raise ArgumentError if value is not allowed
+		def initialize value = nil
+			self.action = value unless value.nil?
+		end
+		
+		def ==(obj)
+			@action == obj.action
+		end
+		
+		# Set the player action.
+		# You can the the {class description}[PlayerAction] for an allowed list of value.
+		# @param [Object] value the player action
+		def action=(value)
+			if value.instance_of?(Symbol)
+				raise ArgumentError unless @@Allowed_symbols.include?(value)
+			end
+			if value.instance_of?(String)
+				raise ArgumentError unless value =~ /\.xsb$/
+			end
+			@action = value
+		end
+		
+		def level_number?
+			@action.instance_of?(Fixnum)
+		end
+		
+		def set_name?
+			@action.instance_of?(String)
+		end
+		
+		def quit?
+			(not @action.nil?) and @action == :quit
+		end
+		
+		def next?
+			(not @action.nil?) and @action == :next
+		end
+		
+		def retry?
+			(not @action.nil?) and @action == :retry
+		end
+		
+		def move?
+			(not @action.nil?) and [:down, :up, :left, :right].include?(@action)
+		end
+		
+		def undo?
+			(not @action.nil?) and @action == :undo
+		end
+	end
+
+end