RSokoban 0.71

data/data/test.xsb

@@ -0,0 +1,30 @@
+; another test file
+
+; 6 levels
+; blablabla
+; bla
+
+#####
+#.$@#
+#####
+; 1
+; blabla
+
+######
+#. $@#
+######
+; 2
+
+#####
+#   #
+#$  #
+#. @#
+#####
+; 3
+
+######
+#.$  #
+#.$  #
+#.$ @#
+######
+; 4

data/lib/rsokoban/crate.rb

@@ -0,0 +1,16 @@
+require "rsokoban/moveable"
+
+module RSokoban
+
+	# I am a moveable crate.
+	class Crate < Position
+		include RSokoban::Moveable
+		
+		# @param [Fixnum] x la coordonnée x
+		# @param [Fixnum] y la coordonnée y
+		def initialize x, y
+			super(x, y)
+		end
+	end
+	
+end

data/lib/rsokoban/exception.rb

@@ -0,0 +1,7 @@
+module RSokoban
+	class NoFileError < ArgumentError
+	end
+	
+	class LevelNumberTooHighError < ArgumentError
+	end
+end

data/lib/rsokoban/game.rb

@@ -0,0 +1,105 @@
+module RSokoban
+
+	# I am mostly the game loop.
+	class Game
+
+		# Construct a new game that you can later run.
+		# @param [:curses|:portable] ui_as_symbol the user interface for the game
+		def initialize ui_as_symbol
+			@levelLoader = LevelLoader.new "original.xsb"
+			@levelNumber = 1
+			case ui_as_symbol
+				when :curses
+					require "rsokoban/ui/curses_console"
+					@ui = UI::CursesConsole.new
+				when :portable
+					require "rsokoban/ui/console"
+					@ui = UI::Console.new
+			end
+		end
+		
+		# I am the game loop.
+		def run
+			action = start_level
+			loop do
+				if action.is_a?(Fixnum)
+					action = load_level action
+					next
+				elsif action.instance_of?(String)
+					# Assuming we recieve a filename of level's set to load
+					action = load_a_new_set action
+					next
+				elsif action == :quit
+					break
+				elsif action == :next
+					action = next_level
+					next
+				elsif action == :retry
+					action = try_again
+					next
+				elsif [:down, :up, :left, :right].include?(action)
+					result = @level.move(action)
+				end
+				
+				if result.start_with?('WIN')
+					action = @ui.get_action('WIN', @level.picture, result)
+				else
+					action = @ui.get_action('DISPLAY', @level.picture, result)
+				end
+			end
+		end
+		
+		private
+	
+		# Load and start the next level of the set
+		# @return [Object] the user's {action}[Console#get_action]
+		def next_level
+			@levelNumber += 1
+			start_level
+		end
+		
+		# Restart the current level
+		# @return [Object] the user's {action}[Console#get_action]
+		def try_again
+			start_level
+		end
+		
+		# Load a new set of levels and start its first level.
+		# @param [String] setname the name of the set (with .xsb extension)
+		# @return [Object] the user's {action}[Console#get_action]
+		def load_a_new_set setname 
+			begin
+				@levelLoader = LevelLoader.new setname
+				@levelNumber = 1
+				@level = @levelLoader.level(@levelNumber)
+				message = "Level : #{@level.title}"
+			rescue NoFileError
+				message = "Error, no such file : #{setname}"
+			end
+			@ui.get_action('START', @level.picture, message)
+		end
+		
+		# Load a level from the current set.
+		# @param [Fixnum] num the number of the set (base 1)
+		# @return [Object] the user's {action}[Console#get_action]
+		def load_level num
+			@levelNumber = num
+			start_level
+		end
+		
+		# Start a level, according to some instance members.
+		# @return [Object] the user's {action}[Console#get_action]
+		def start_level
+			begin
+				@level = @levelLoader.level(@levelNumber)
+				@ui.get_action('START', @level.picture, "Level : #{@level.title}")
+			rescue LevelNumberTooHighError
+				@ui.get_action('END_OF_SET', ['####'], "No more levels in this set")
+			end
+		end
+		
+	end
+	
+	
+
+end

data/lib/rsokoban/level.rb

@@ -0,0 +1,269 @@
+module RSokoban
+
+	# I am a level of the game.
+	# To complete a level, place each crate ('$') on a storage location ('.').
+	class Level
+		attr_reader :floor, :man, :crates, :storages, :title
+		
+		# 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.
+		#   Each string contain one line of the level map.
+		#	  'Level 1', ['#####', '#.o@#', '#####']
+		# 
+		# * '#' is a wal
+		# * '.' is a storage location
+		# * '$' is a crate
+		# * '*' is a crate on storage location
+		# * '@' is the man
+		# * ' ' is an empty floor
+		#
+		# @param [RawLevel] rawLevel
+		def initialize rawLevel
+			@title = rawLevel.title
+			@floor = init_floor rawLevel.picture
+			@man = init_man rawLevel.picture
+			@crates = []
+			@storages = []
+			init_crates_and_storages rawLevel.picture
+			@move = 0
+			@picture = nil
+		end
+		
+		# Two Level objects are equals if their @title, @floor, @man, @crates and @storages are equals.
+		# @param [Object] obj
+		# @return [false|true]
+		def ==(obj)
+			return false unless obj.kind_of?(Level)
+			@floor == obj.floor and @man == obj.man and @crates == obj.crates and @storages == obj.storages and @title == obj.title
+		end
+		
+		# Synonym of #==
+		# @see #==
+		def eql?(obj)
+			self == obj
+		end
+		
+		# Get an instant picture of the game.
+		# @return [Array<String>] the picture, after X turns of game.
+		def picture
+			@picture = init_floor @floor
+			draw_crates
+			draw_storages
+			draw_man
+			@picture
+		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
+		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)
+			@move += 1
+			@man.send(direction)
+			if @crates.include?(Crate.new(@man.x, @man.y))
+				i = @crates.index(Crate.new(@man.x, @man.y))
+				@crates[i].send(direction)
+			end
+			return "WIN move #{@move}" if win?
+			"OK move #{@move}"
+		end
+		
+		private
+		
+		# @return true if all crates are on a storage location
+		def win?
+			return false if @crates.size == 0 # needed for testing purpose.
+			@crates.each {|c|
+				return false unless @storages.include?(c)
+			}
+			true
+		end
+		
+		# Is there a wall near the man, in the direction pointed to by +direction+ ?
+		# @param [:up|:down|:left|:right] direction
+		# @return [true|false]
+		def wall? direction
+			case direction
+				when :up
+					box = what_is_on(@man.x, @man.y-1)
+				when :down
+					box = what_is_on(@man.x, @man.y+1)
+				when :left
+					box = what_is_on(@man.x-1, @man.y)
+				when :right
+					box = what_is_on(@man.x+1, @man.y)
+			end
+			return(box == WALL)
+		end
+		
+		# Is there a crate followed by a wall near the man, in the direction pointed to by +direction+ ?
+		# @param [:up|:down|:left|:right] direction
+		# @return [true|false]
+		def wall_behind_crate?(direction)
+			case direction
+				when :up
+					near = crate?(@man.x, @man.y-1)
+					boxBehind = what_is_on(@man.x, @man.y-2)
+				when :down
+					near = crate?(@man.x, @man.y+1)
+					boxBehind = what_is_on(@man.x, @man.y+2)
+				when :left
+					near = crate?(@man.x-1, @man.y)
+					boxBehind = what_is_on(@man.x-2, @man.y)
+				when :right
+					near = crate?(@man.x+1, @man.y)
+					boxBehind = what_is_on(@man.x+2, @man.y)
+			end
+			return(near and boxBehind == WALL)
+		end
+		
+		# Is there a crate followed by a crate near the man, in the direction pointed to by +direction+ ?
+		# @param [:up|:down|:left|:right] direction
+		# @return [true|nil]
+		def double_crate?(direction)
+			case direction
+				when :up
+					true if crate?(@man.x, @man.y-1) and crate?(@man.x, @man.y-2)
+				when :down
+					true if crate?(@man.x, @man.y+1) and crate?(@man.x, @man.y+2)
+				when :left
+					true if crate?(@man.x-1, @man.y) and crate?(@man.x-2, @man.y)
+				when :right
+					true if crate?(@man.x+1, @man.y) and crate?(@man.x+2, @man.y)
+			end
+		end
+		
+		# Is there a crate ('o' or '*') in the box pointed to by x, y ?
+		# @param [Fixnum] x x coordinate in the map
+		# @param [Fixnum] y y coordinate in the map
+		# @return [true|false]
+		def crate?(x, y)
+			box = what_is_on(x, y)
+			box == CRATE or box == CRATE_ON_STORAGE
+		end
+		
+		# Draw the man for @picture output
+		def draw_man
+			box = what_is_on @man.x, @man.y
+			put_man_in_picture if box == FLOOR
+			put_man_on_storage_in_picture if box == STORAGE
+		end
+		
+		def put_man_in_picture
+			@picture[@man.y][@man.x] = MAN
+		end
+		
+		def put_man_on_storage_in_picture
+			@picture[@man.y][@man.x] = MAN_ON_STORAGE
+		end
+		
+		# Draw the crates for @picture output
+		def draw_crates
+			@crates.each {|crate| @picture[crate.y][crate.x] = what_is_on(crate.x, crate.y) }
+		end
+		
+		# Draw the storages location for @picture output
+		def draw_storages
+			@storages.each {|st| @picture[st.y][st.x] = what_is_on(st.x, st.y) }
+		end
+
+		# Get the content of box x, y
+		# @param [Fixnum] x x coordinate in the map
+		# @param [Fixnum] y y coordinate in the map
+		# @return [' ' | '#' | '.' | 'o' | '*']
+		def what_is_on x, y
+			box = (@floor[y][x]).chr
+			if box == FLOOR
+				s = Storage.new(x, y)
+				c = Crate.new(x, y)
+				if @storages.include?(s) and @crates.include?(c)
+					box = CRATE_ON_STORAGE 
+				elsif @storages.include?(s)
+					box = STORAGE
+				elsif @crates.include?(c)
+					box = CRATE
+				end
+			end
+			box
+		end
+		
+		# Removes all storages locations, all crates and the man, leaving only walls and floor.
+		#
+		# @param [Array<String>] picture 
+		# @return [Array<String>] picture with only walls and floor
+		def init_floor picture
+			floor = []
+			picture.each {|x| floor.push x.tr("#{STORAGE}#{CRATE}#{MAN}#{CRATE_ON_STORAGE}", FLOOR) }
+			floor
+		end
+		
+		# Find the man's position, at the begining of the level.
+		#
+		# @param [Array<String>] picture
+		# @return [Man] an initialised man
+		def init_man picture
+			x = y = 0
+			picture.each {|line| 
+				if line.include?(MAN)
+					x = line.index(MAN)
+					break
+				end
+				y += 1
+			}
+			Man.new x, y
+		end
+		
+		# Find position of crates and storages, at the begining of the level.
+		#
+		# @param [Array<String>] picture
+		def init_crates_and_storages picture
+			y = 0
+			picture.each do |line| 
+				count = 0
+				line.each_char do |c| 
+					@crates.push Crate.new(count, y) if c == CRATE
+					@storages.push Storage.new(count, y) if c == STORAGE
+					if c == CRATE_ON_STORAGE
+						@crates.push Crate.new(count, y)
+						@storages.push Storage.new(count, y)
+					end
+					count += 1
+				end
+				y += 1
+			end
+		end
+		
+	end
+
+end

data/lib/rsokoban/level_loader.rb

@@ -0,0 +1,58 @@
+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
+	class LevelLoader
+		attr_reader :level, :set
+	
+		# @filename [String] le nom du fichier où trouver les niveaux.
+		#   Ce fichier est cherché dans le dossier data/.
+		# @throws [RSokoban::NoFileError] si le fichier n'existe pas
+		# @see LevelSet for an 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
+			file.readline # must be blank line
+			line = file.readline
+			desc = ''
+			while line[0] == ?; do
+				desc += line.sub(/;/, '').sub(/\s*/, '')
+				line = file.readline
+			end
+			@set.description = desc
+			
+			loop do
+				begin
+					line = file.readline.chomp
+					raw = []
+					while line =~ /^ *#/
+						raw.push line
+						line = file.readline.chomp
+					end
+					line = line.chomp.sub(/;/, '').sub(/\s*/, '')
+					@set.rawLevels.push RawLevel.new(line, raw)
+					
+					line = file.readline
+					while line[0, 1] == ';'
+						line = file.readline
+					end
+					# must be a blank line here
+				rescue EOFError
+					break
+				end
+			end
+		end
+		
+		def level num
+			raise LevelNumberTooHighError if num > @set.rawLevels.size
+			Level.new @set.rawLevels[num-1]
+		end
+		
+	end
+
+end

data/lib/rsokoban/level_set.rb

@@ -0,0 +1,31 @@
+module RSokoban
+
+	# I am a set of sokoban levels.
+	# Level set are found in .xsb files.
+	#
+	# =xsb file format
+	# 
+	# Info lines begins with semi-colon (;)
+	# Map lines begins with a # (that's a wall !)
+	# 
+	# 1: First info is title of the set
+	# 2: Blank line
+	# 3: List of info lines : description
+	# 4: Blank line
+	# 5: Level map
+	# 6: info title of this level
+	# 7: List of info lines : blabla about this level
+	#
+	# From 4 to 7 again for each supplementary level
+	class LevelSet
+		attr_accessor :title, :description, :rawLevels
+		
+		def initialize
+			@title = 'Unknown set title'
+			@description = 'Empty description'
+			@rawLevels = []
+		end
+		
+	end
+	
+end

data/lib/rsokoban/man.rb

@@ -0,0 +1,17 @@
+require "rsokoban/moveable"
+
+module RSokoban
+
+	# Je suis le bonhomme qui pousse les caisses...
+	class Man < Position
+		include RSokoban::Moveable
+		
+		# @param [Fixnum] x la coordonnée x
+		# @param [Fixnum] y la coordonnée y
+		def initialize x, y
+			super(x, y)
+		end
+		
+	end
+
+end

data/lib/rsokoban/moveable.rb

@@ -0,0 +1,22 @@
+module RSokoban
+
+	# Permits to move one box in all 4 directions.
+	module Moveable
+		def up
+			@y -= 1
+		end
+		
+		def down
+			@y += 1
+		end
+		
+		def left
+			@x -= 1
+		end
+		
+		def right
+			@x += 1
+		end
+	end
+
+end

data/lib/rsokoban/option.rb

@@ -0,0 +1,93 @@
+require 'optparse'
+
+# I parse the command line.
+class Option
+
+	# Here is a list of command line options :
+	# * --curses
+	# * --version
+	# * --license
+	# * --help
+	# * --help-output
+	# * --portable
+	# @todo refactoring
+	def initialize
+		@options = {:ui => :curses}
+		
+		optparse = OptionParser.new do|opts|
+		 	opts.banner = "Usage: #{$0} [options]"
+   		
+   		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
+   		end
+   		
+   		@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
+   		
+   		opts.on( '-h', '--help', 'Display this screen' ) do
+     		puts opts
+     		exit
+   		end
+		end
+		
+		begin
+			optparse.parse!
+		rescue OptionParser::InvalidOption => e
+			puts e.to_s
+			exit 1
+		end
+		
+		print_version if @options[:version]
+		print_license if @options[:license]
+		print_help_output if @options[:help_output]
+	end
+	
+	def [](k)
+		@options[k]
+	end
+	
+private
+
+	def print_version
+		puts RSokoban::VERSION
+		exit
+	end
+	
+	def print_license
+		puts "RSokoban is licensed under the GPL 3. See the COPYING's file."
+		exit
+	end
+	
+	def print_help_output
+		help=<<EOS
+
+RSokoban can use 2 user interfaces :
+
+  --curses
+    This is the default UI. It uses the curses library in a console window.
+    It works on Linux. I don't know if it works on Windows or OSX.
+    
+  --portable
+    It uses a plain console window. This UI is boring but should work
+    everywhere.
+EOS
+		puts help
+		exit
+	end
+end

data/lib/rsokoban/position.rb

@@ -0,0 +1,24 @@
+module RSokoban
+
+	# I represent an x,y coordinate.
+	# @todo document
+	class Position
+		attr_reader :x, :y
+		
+		def initialize x = 0, y = 0
+			@x = x
+			@y = y
+		end
+		
+		def ==(obj)
+			return false unless obj.kind_of?(Position)
+			@x == obj.x and @y == obj.y
+		end
+		
+		def eql?(obj)
+			self == obj
+		end
+		
+	end
+
+end

data/lib/rsokoban/raw_level.rb

@@ -0,0 +1,16 @@
+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.
+	# @todo document and give some examples
+	class RawLevel
+		attr_accessor :title, :picture
+		
+		def initialize title = 'Unknown level title', picture = []
+			@title = title
+			@picture = picture
+		end
+		
+	end
+
+end

data/lib/rsokoban/storage.rb

@@ -0,0 +1,14 @@
+module RSokoban
+
+	# Je suis un emplacement de stockage, c'est à dire un endroit où il faut placer une caisse
+	# pour gagner le niveau.
+	class Storage < Position
+	
+		# @param [Fixnum] x la coordonnée x
+		# @param [Fixnum] y la coordonnée y
+		def initialize x, y
+			super(x, y)
+		end
+	end
+	
+end