RSokoban 0.71

data/lib/rsokoban/ui/console.rb

@@ -0,0 +1,107 @@
+
+module RSokoban::UI
+
+	# I am a portable console for the user interface.
+	# In addition to what BaseUI want from me, I offer the user
+	# an help feature.
+	# I assume 24 lines height.
+	class Console < BaseUI
+		
+		def initialize
+			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
+			else
+				# assuming type == 'WIN'
+				askForNextLevel
+			end
+		end
+		
+		private
+		
+		def display level, message
+			blankConsole = "\n" * 24 # assuming a console window of 24 lines height
+			puts blankConsole
+			puts @level_title
+			puts "--------------------"
+			puts message
+			puts ''
+			level.each {|line| puts line }
+			puts ''
+		end
+		
+		def askForNextLevel
+			printf "Play next level ? "
+			line = readline.chomp
+			if ['yes', 'ye', 'y', 'YES', 'YE', 'Y'].include?(line)
+				:next
+			else
+				:quit
+			end
+		end
+		
+		def askPlayer
+			printf "Your choice ? "
+			line = readline.chomp
+			response = parse line
+			if response.nil?
+				puts "Error : #{line}"
+				askPlayer
+			elsif response == :help
+				displayHelp
+				askPlayer
+			else
+				response
+			end
+		end
+		
+		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 '1'..'999'
+					str.to_i
+				when /\.xsb$/
+					str
+			end
+		end
+		
+		def displayHelp
+			help=<<EOS
+------------------------------
+General commands :
+
+quit         : Quit game
+help         : Display this screen
+retry        : Restart level
+1 to 999     : Play this level
+file.xsb     : Load this set of levels
+
+How to move :
+
+up (or z)    : Move up
+down (or s)  : Move down
+left (or q)  : Move left
+right (or d) : Move right
+------------------------------
+EOS
+			puts help
+		end
+		
+	end
+
+end

data/lib/rsokoban/ui/curses_console.rb

@@ -0,0 +1,123 @@
+require 'curses'
+
+module RSokoban::UI
+
+	# I am a console user interface using curses library.
+	# I assume 24 lines height.
+	class CursesConsole < BaseUI
+	
+		@@TITLE_LINE = 0
+		@@MOVES_LINE = 1
+		@@STATUS_LINE = 2
+		@@PICTURE_LINE = 4
+		
+		def initialize
+			super()
+			init_screen
+		ensure
+			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'
+				Curses.clear
+			end
+			if type == 'DISPLAY' or type == 'START'  or type == 'END_OF_SET'
+				ask_player level, message
+			else
+				# assuming type == 'WIN'
+				askForNextLevel level, message
+			end
+		end
+		
+		private
+		
+		def init_screen
+			Curses.noecho # do not show typed keys
+			Curses.init_screen
+			Curses.stdscr.keypad(true) # enable arrow keys
+			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'
+			line_num = @@PICTURE_LINE
+			level.each {|line| 
+				write line_num, 0, line
+				line_num += 1
+			}
+		end
+		
+		def write(line, column, text)
+			Curses.setpos(line, column)
+			Curses.addstr(text);
+		end
+		
+		def askForNextLevel level, message
+			display level, message
+			write @@STATUS_LINE, 0, "LEVEL COMPLETED ! Play next level ? (yes, no)        "
+			case Curses.getch
+				when ?n, ?N then :quit
+				when ?y, ?Y then :next
+				else
+					askForNextLevel level, message
+			end
+		end
+		
+		def ask_player level, message
+			display level, message
+			response = get_player_input
+			if response.nil?
+				ask_player level, message
+			else
+				response
+			end
+		end
+		
+		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 ?l, ?L then ask_level_or_set
+    		else
+    			nil
+			end
+		end
+		
+		def ask_level_or_set
+			Curses.curs_set 1
+			Curses.echo
+			Curses.clear
+			help=<<EOS
+------------------------------------------------------------
+To load a level from this set, type its number.
+To load a set of level, type its name (with .xsb).
+Int 1 : Don't forget to hit return.
+Int 2 : type any letter to cancel and restart previous level
+------------------------------------------------------------
+
+EOS
+			write 0, 0, help
+			str = Curses.getstr
+			Curses.curs_set 0
+			Curses.noecho
+			case str
+				when '1'..'999' then str.to_i
+				when /\.xsb$/ then str
+				else
+					:retry
+			end
+		end
+		
+	end
+
+end

data/lib/rsokoban/ui/ui.rb

@@ -0,0 +1,44 @@
+module RSokoban
+	
+	# Module dedicated to user interfaces.
+	module UI
+		
+		# Every concrete UI should inherits from me.
+		class BaseUI
+		
+			def initialize
+				@level_title = ''
+			end
+			
+			# Based on things found in the arguments, I display the game
+			# to the user. Then he can tell what it want to do. Whatever
+			# my childs permit the user to do, they can only return one 
+			# of the following actions.
+			#
+			# List of action I must be able to parse and return :
+			# :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
+			# a number                   to load this level number
+			# an .xsb filename           to load the set with this name
+			# 
+			# @param ['START'|'DISPLAY'|'WIN'] type the type of message
+			# @param [Array<String>] level the picture of the level
+			# @param [String] message a message to be displayed. See Level#move
+			#   to learn more about the message format and content.
+			# @return [Object] the user's action
+			# @since 0.71
+			# @todo write some examples
+			# @todo action diserves its own class
+			# @todo picture diserves its own class
+			# @todo document better +type+
+			def get_action(type, level, message)
+				raise "Please implement me !"
+			end
+			
+		end
+	
+	end
+	
+end

data/lib/rsokoban.rb

@@ -0,0 +1,29 @@
+require "rsokoban/level"
+require "rsokoban/level_loader"
+require "rsokoban/exception"
+require "rsokoban/position"
+require "rsokoban/man"
+require "rsokoban/crate"
+require "rsokoban/storage"
+require "rsokoban/game"
+require "rsokoban/option"
+require "rsokoban/level_set"
+require "rsokoban/raw_level"
+require "rsokoban/ui/ui"
+
+# I am the main module of the game.
+module RSokoban
+	# Version of the program
+	VERSION = '0.71'
+	
+	# Game elements.
+	# Those constants are used intensively.
+	MAN = '@'
+	FLOOR = ' '
+	CRATE = '$'
+	STORAGE = '.'
+	WALL = '#'
+	MAN_ON_STORAGE = '+'
+	CRATE_ON_STORAGE = '*'
+	
+end