RSokoban 0.74 → 0.76

data/lib/rsokoban/set_loader.rb

@@ -0,0 +1,108 @@
+module RSokoban
+
+	# I load a file containing a bunch of levels for the game. On instanciation,
+	# you give me a filename (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
+	class SetLoader
+	
+		# @param [String] filename an xsb filename.
+		#   This file is searched in the data/ folder.
+		# @raise [RSokoban::NoFileError] if filename doesn't exist
+		# @see LevelSet overview of .xsb file format
+		def initialize filename
+			@filename = filename
+			@set = LevelSet.new
+			@file = open_file
+			get_title_of_the_set
+			get_description_of_the_set
+			get_levels_of_the_set
+		end
+		
+		# @param [Fixnum] num a level number in base 1
+		# @return [Level]
+		def level num
+			raise LevelNumberTooHighError if num > @set.raw_levels.size
+			level = Level.new @set.raw_levels[num-1]
+			level.set_filename = File.basename @filename, '.xsb'
+			level.number = num
+			level
+		end
+		
+		# Get the description field from 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
+		
+		private
+		
+		# @param [String] filename an xsb file to be found in data/ folder
+		# @return [File]
+		# @raise NoFileError
+		def open_file
+			filename = "#{$RSOKOBAN_DATA_PATH}/" + @filename
+			raise NoFileError unless File.exist?(filename)
+			open(filename)
+		end
+		
+		def get_title_of_the_set
+			@set.title = @file.readline.get_xsb_info_line_chomp
+			# After the title, there must be a blank line
+			line = @file.readline 
+			raise "Must be a blank line" unless line.strip.empty?
+		end
+		
+		def get_description_of_the_set
+			line = @file.readline
+			desc = ''
+			while line[0] == ?; do
+				desc += line.get_xsb_info_line
+				line = @file.readline
+			end
+			@set.description = desc
+			# After the description, there must be a blank line
+			raise "Must be a blank line" unless line.strip.empty?
+		end
+		
+		def get_levels_of_the_set
+			loop do
+				begin
+					line = @file.readline.chomp
+					raw = []
+					while line =~ /^ *#/
+						raw.push line
+						line = @file.readline.chomp
+					end
+					line = line.get_xsb_info_line_chomp
+					@set.raw_levels.push RawLevel.new(line, Map.new(raw)) unless raw.empty?
+					
+					line = @file.readline
+					while line[0, 1] == ';'
+						line = @file.readline
+					end
+					# must be a blank line here
+					raise "Must be a blank line" unless line.strip.empty?
+				rescue EOFError
+					break
+				end
+			end
+		end
+		
+	end
+
+end

data/lib/rsokoban/ui/base_ui.rb

@@ -22,6 +22,7 @@ module RSokoban::UI
 		# @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
+		# @option hash [Fixnum] :record The record for this level
 		# @return [PlayerAction] the user's action
 		# @since 0.73
 		# @todo write some examples

data/lib/rsokoban/ui/console.rb

@@ -12,40 +12,68 @@ module RSokoban::UI
 		end
 		
 		def get_action(hash)
+			initialize_members hash
+			display hash
+			ask_player hash
+		end
+		
+		private
+		
+		def initialize_members 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'
-				ask_for_next_level
+				@record = hash[:record]
 			end
 		end
 		
-		private
-		
 		def display hash
-			blankConsole = "\n" * 24 # assuming a console window of 24 lines height
-			puts blankConsole
+			clear_screen
+			display_header
+			display_move_number hash[:move]
+			display_map hash[:map]
+		end
+		
+		# Assuming a console window of 24 lines height
+		def clear_screen
+			puts "\n" * 24 
+		end
+		
+		def display_header
 			puts "Set: #{@set_title}"
-			puts "Level: #{@level_title} (#{@level_number}/#{@set_total})"
+			puts "Level: #{@level_title} (#{@level_number}/#{@set_total}) Record: #{@record}"
 			puts "--------------------"
-			unless hash[:move].nil?
-				puts "move #{hash[:move]}"
+		end
+		
+		def display_move_number number
+			unless number.nil?
+				puts "move #{number}"
 			else
 				puts ''
 			end
+		end
+		
+		def display_map map
 			puts ''
-			hash[:map].each {|line| puts line }
+			map.each {|line| 
+				line.gsub!(/o/, ' ')
+				puts line 
+			}
 			puts ''
 		end
 		
-		def ask_for_next_level
+		def ask_player hash
+			if [:display, :start].include?(hash[:type])
+				ask_for_action
+			else
+				# assuming type == 'WIN'
+				ask_for_next_level_or_quit
+			end
+		end
+		
+		def ask_for_next_level_or_quit
 			printf "Play next level ? "
 			line = gets.chomp
 			if ['yes', 'ye', 'y', 'YES', 'YE', 'Y'].include?(line)
@@ -55,19 +83,22 @@ module RSokoban::UI
 			end
 		end
 		
-		def ask_player
-			printf "Your choice ? "
-			line = gets.chomp
-			response = parse line
+		def ask_for_action
+			response = get_playerinput
 			if response.nil?
-				puts "Error : #{line}"
-				ask_player
+				puts "Error !"
 			elsif response.instance_of?(Symbol) and response == :help
 				display_help
-				ask_player
 			else
-				response
+				return response
 			end
+			ask_for_action
+		end
+		
+		def get_playerinput
+			printf "Your choice ? "
+			line = gets.chomp
+			parse line
 		end
 		
 		def parse str
@@ -81,7 +112,7 @@ module RSokoban::UI
 				when 'd' then PlayerAction.new(:right)
 				when '1'..'999'
 					if str.to_i > @set_total
-						ask_player
+						ask_for_action
 					else
 					 	PlayerAction.new(str.to_i)
 					 end

data/lib/rsokoban/ui/curses_console.rb

@@ -4,11 +4,11 @@ module RSokoban::UI
 	# I assume 24 lines height.
 	class CursesConsole < BaseUI
 	
-		@@SET_LINE = 0
-		@@TITLE_LINE = 1
-		@@MOVES_LINE = 2
-		@@STATUS_LINE = 3
-		@@PICTURE_LINE = 5
+		SET_LINE = 0
+		TITLE_LINE = 1
+		MOVES_LINE = 2
+		STATUS_LINE = 3
+		PICTURE_LINE = 5
 		
 		def initialize
 			super()
@@ -18,13 +18,7 @@ module RSokoban::UI
 		end
 		
 		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
+			initialize_members_and_clear_screen hash
 			if [:display, :start].include?(hash[:type]) 
 				ask_player hash
 			else
@@ -35,6 +29,17 @@ module RSokoban::UI
 		
 		private
 		
+		def initialize_members_and_clear_screen hash
+			if hash[:type] == :start
+				@level_title = hash[:title]
+				@set_title = hash[:set]
+				@level_number = hash[:number]
+				@set_total = hash[:total]
+				@record = hash[:record]
+				Curses.clear
+			end
+		end
+		
 		def init_screen
 			Curses.noecho # do not show typed keys
 			Curses.init_screen
@@ -43,12 +48,21 @@ module RSokoban::UI
 		end
 		
 		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
-			hash[:map].each {|line| 
+			display_header hash[:move]
+			display_map hash[:map]
+		end
+		
+		def display_header move_number
+			write SET_LINE, 0, "Set: #{@set_title}"
+			write TITLE_LINE, 0, "Level: #{@level_title} (#{@level_number}/#{@set_total}) Record: #{@record}"
+			write MOVES_LINE, 0, "moves : #{move_number}   " unless move_number.nil?
+			write STATUS_LINE, 0, 'arrows=move (q)uit (r)etry (u)ndo (l)oad level/set'
+		end
+		
+		def display_map map
+			line_num = PICTURE_LINE
+			map.each {|line| 
+				line.gsub!(/o/, ' ')
 				write line_num, 0, line
 				line_num += 1
 			}
@@ -61,7 +75,7 @@ module RSokoban::UI
 		
 		def ask_for_next_level hash
 			display hash
-			write @@STATUS_LINE, 0, "LEVEL COMPLETED ! Play next level ? (yes, no)        "
+			write STATUS_LINE, 0, "LEVEL COMPLETED ! Play next level ? (yes, no)        "
 			case Curses.getch
 				when ?n, ?N then PlayerAction.new(:quit)
 				when ?y, ?Y then PlayerAction.new(:next)
@@ -96,8 +110,34 @@ module RSokoban::UI
 		end
 		
 		def ask_level_or_set
+			show_cursor
+			display_help
+			response = Curses.getstr
+			hide_cursor
+			case response
+				when '1'..'999'
+					if response.to_i > @set_total
+						ask_level_or_set
+					else
+						PlayerAction.new(response.to_i)
+					end
+				when /\.xsb$/ then PlayerAction.new(response)
+				else
+					PlayerAction.new(:retry)
+			end
+		end
+		
+		def show_cursor
 			Curses.curs_set 1
 			Curses.echo
+		end
+		
+		def hide_cursor
+			Curses.curs_set 0
+			Curses.noecho
+		end
+		
+		def display_help
 			Curses.clear
 			help=<<EOS
 ------------------------------------------------------------
@@ -109,20 +149,6 @@ 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'
-					if str.to_i > @set_total
-						ask_level_or_set
-					else
-						PlayerAction.new(str.to_i)
-					end
-				when /\.xsb$/ then PlayerAction.new(str)
-				else
-					PlayerAction.new(:retry)
-			end
 		end
 		
 	end

data/lib/rsokoban/ui/player_action.rb

@@ -16,7 +16,7 @@ module RSokoban::UI
 		# @param [Object] the action
 		attr_reader :action
 		
-		@@Allowed_symbols = [ :up, :down, :left, :right, :quit, :next, :retry, :undo ]
+		ALLOWED_SYMBOLS = [ :up, :down, :left, :right, :quit, :next, :retry, :undo ]
 		
 		# You can look to {PlayerAction} for an allowed list of value.
 		# @param [Object] value optional initial action
@@ -33,15 +33,21 @@ module RSokoban::UI
 		# @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)
-			end
-			if value.instance_of?(String)
-				raise ArgumentError unless value =~ /\.xsb$/
-			end
+			check_allowed_symbol(value) if value.instance_of?(Symbol)
+			check_allowed_string(value) if value.instance_of?(String)
 			@action = value
 		end
 		
+		# @raise ArgumentError if value is not an allowed symbol
+		def check_allowed_symbol symb
+			raise ArgumentError unless ALLOWED_SYMBOLS.include?(symb)
+		end
+		
+		# @raise ArgumentError if string is not an xsb filename
+		def check_allowed_string string
+			raise ArgumentError unless string =~ /\.xsb$/
+		end
+		
 		def level_number?
 			@action.instance_of?(Fixnum)
 		end

data/lib/rsokoban/ui/skin.rb

@@ -0,0 +1,105 @@
+require "yaml"
+
+module RSokoban::UI
+
+	# @since 0.76
+	class Skin
+	
+		def initialize
+			@path = File.join($RSOKOBAN_PATH, 'skins/')
+			@path_home = File.expand_path("~/.rsokoban/skins/")
+			@filenames = {}
+		end
+	
+		def list_skins
+			dir = Dir.new @path
+			ret = []
+			dir.each do |item|
+				next if ['.', '..'].include? item
+				ret.push item
+			end
+			
+			if File.exist? @path_home
+				dir = Dir.new @path_home
+				dir.each do |item|
+					next if ['.', '..'].include? item
+					ret.push item
+				end
+			end
+			
+			ret.sort
+		end
+		
+		def path_of_skin dirname
+			ret = File.join(@path, dirname)
+			return ret if File.directory? ret
+			ret = File.join(@path_home, dirname)
+			raise ArgumentError unless File.directory? ret
+			ret
+		end
+		
+		def size_of full_path_dir
+			conf = YAML.load_file File.join(full_path_dir, 'skin.conf')
+			conf['size']
+		end
+		
+		def filenames full_path_dir
+			@filenames = {}
+			get_other_filenames full_path_dir
+			get_man_filenames full_path_dir
+			get_man_on_storage_filenames full_path_dir
+			get_wall_filenames full_path_dir
+			@filenames
+		end
+		
+		private
+		
+		def get_other_filenames full_path_dir
+			images = [:crate, :floor, :store, :crate_store, :outside]
+			images.each do |image|
+				@filenames[image] = File.join(full_path_dir, image.to_s + '.bmp')
+			end
+		end
+		
+		def get_man_filenames full_path_dir
+			man_file = File.join(full_path_dir, 'man.bmp')
+			if File.exist?(man_file)				
+				@filenames[:man_up] = @filenames[:man_down] = @filenames[:man_left] = @filenames[:man_right] = man_file
+			else
+				images = [:man_up, :man_down, :man_left, :man_right]
+				images.each do |image|
+					@filenames[image] = File.join(full_path_dir, image.to_s + '.bmp')
+				end
+			end
+		end
+		
+		def get_man_on_storage_filenames full_path_dir
+			man_file = File.join(full_path_dir, 'man_store.bmp')
+			if File.exist?(man_file)
+				@filenames[:man_store_up] = @filenames[:man_store_down] = @filenames[:man_store_left] = @filenames[:man_store_right] = man_file
+			else
+				images = [:man_store_up, :man_store_down, :man_store_left, :man_store_right]
+				images.each do |image| 
+					@filenames[image] = File.join(full_path_dir, image.to_s + '.bmp')
+				end
+			end
+		end
+		
+		def get_wall_filenames full_path_dir
+			wall_test_file = File.join(full_path_dir, 'wall_d.bmp')
+			images = [:wall, :wall_d, :wall_dl, :wall_dlr, :wall_dr, :wall_l, :wall_lr, :wall_r,
+				        :wall_u, :wall_ud, :wall_udl, :wall_udlr, :wall_udr, :wall_ul, :wall_ulr, :wall_ur]
+			if File.exist?(wall_test_file)
+				images.each do |image|
+					@filenames[image] = File.join(full_path_dir, image.to_s + '.bmp')
+				end
+			else
+				images.each do |image|
+					@filenames[image] = File.join(full_path_dir, 'wall.bmp')
+				end
+			end
+		end
+		
+	end
+	
+end