Add MoveFromFoundationConfig option to KlondikeConfig (#12)

Closes #11

Reviewed-on: #12
Co-authored-by: Rhys Lloyd <krakow20@gmail.com>
Co-committed-by: Rhys Lloyd <krakow20@gmail.com>

Cargo.lock

@@ -11,8 +11,8 @@ checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c"
 [[package]]
 name = "arrayvec"
 version = "0.7.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7c02d123df017efcdfbd739ef81735b36c5ba83ec3c59c80a9d7ecc718f92e50"
+source = "sparse+https://git.aleshym.co/api/packages/Quaternions/cargo/"
+checksum = "813440870d646c57c222c1d713dc4e3ddcb2919c3801564d767d85d7bf2afee4"
 
 [[package]]
 name = "bitflags"

card_game/Cargo.toml

@@ -9,7 +9,7 @@ authors = ["Rhys Lloyd <krakow20@gmail.com>"]
 keywords = ["card", "cards", "solitaire", "klondike"]
 
 [dependencies]
-arrayvec = "0.7.6"
+arrayvec = { version = "0.7.6", registry = "Quaternions", features = ["len_u8"], default-features = false }
 
 [lints]
 workspace = true

card_game/src/lib.rs

@@ -10,7 +10,10 @@ pub trait Game {
 	type Stats;
 	type Config;
 	type Instruction;
-	fn possible_instructions(&self) -> impl Iterator<Item = Self::Instruction> + use<Self>;
+	fn possible_instructions(
+		&self,
+		config: &Self::Config,
+	) -> impl Iterator<Item = Self::Instruction> + use<Self>;
 	fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool;
 	fn process_instruction(
 		&mut self,
@@ -377,7 +380,7 @@ where
 			.process_instruction(&mut self.stats, &self.config, SessionInstruction::Undo)
 	}
 	pub fn possible_instructions(&self) -> impl Iterator<Item = G::Instruction> + use<G> {
-		self.state.state.possible_instructions()
+		self.state.state.possible_instructions(&self.config)
 	}
 	pub fn process_instruction(&mut self, instruction: G::Instruction) {
 		self.state.process_instruction(
@@ -399,9 +402,12 @@ where
 	type Stats = SessionStats<G::Stats>;
 	type Config = G::Config;
 	type Instruction = SessionInstruction<G::Instruction>;
-	fn possible_instructions(&self) -> impl Iterator<Item = Self::Instruction> + use<G> {
+	fn possible_instructions(
+		&self,
+		config: &Self::Config,
+	) -> impl Iterator<Item = Self::Instruction> + use<G> {
 		self.state
-			.possible_instructions()
+			.possible_instructions(config)
 			.map(SessionInstruction::InnerInstruction)
 	}
 	fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool {

klondike-bench/src/main.rs

@@ -9,9 +9,10 @@ fn play_to_win(rng: &mut Rng) -> Option<KlondikeStats> {
 	let mut stats = KlondikeStats::new();
 	const CONFIG: KlondikeConfig = KlondikeConfig {
 		draw_stock: klondike::DrawStockConfig::DrawOne,
+		move_from_foundation: klondike::MoveFromFoundationConfig::Allowed,
 	};
 	// play game a bit
-	while let Some(instruction) = game.get_auto_move()
+	while let Some(instruction) = game.get_auto_move(&CONFIG)
 		&& !game.is_win()
 	{
 		// quit before 250 moves

klondike-cli/src/main.rs

@@ -13,11 +13,11 @@ struct Displayed<T>(T);
 impl Display for Displayed<&Card> {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		match self.0.rank() {
-			Rank::Ace => write!(f, "A"),
-			Rank::Jack => write!(f, "J"),
-			Rank::Queen => write!(f, "Q"),
-			Rank::King => write!(f, "K"),
-			other => write!(f, "{}", other as u8),
+			Rank::Ace => write!(f, " A"),
+			Rank::Jack => write!(f, " J"),
+			Rank::Queen => write!(f, " Q"),
+			Rank::King => write!(f, " K"),
+			other => write!(f, "{:>2}", other as u8),
 		}?;
 		match self.0.suit() {
 			Suit::Spades => write!(f, "♠"),
@@ -33,7 +33,7 @@ impl Display for OptionalCard<'_> {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		match self {
 			&OptionalCard(Some(card)) => write!(f, "{}", Displayed(card)),
-			OptionalCard(None) => write!(f, "None"),
+			OptionalCard(None) => write!(f, " []"),
 		}
 	}
 }
@@ -42,16 +42,17 @@ impl Display for Displayed<&Klondike> {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		// Stock
 		let stock_count = self.0.state().stock().face_down().len();
-		writeln!(f, "Stock: {stock_count}")?;
 
 		// Hand
 		let hand = self.0.state().stock().face_up().last();
-		writeln!(f, "Hand: {}", OptionalCard(hand))?;
 
 		// Foundations
+		writeln!(f, " STOCK       F1  F2  F3  F4")?;
 		write!(
 			f,
-			"Foundations: {} {} {} {}",
+			" {:>2} {}     {} {} {} {}",
+			stock_count,
+			OptionalCard(hand),
 			OptionalCard(self.0.state().foundation1().last()),
 			OptionalCard(self.0.state().foundation2().last()),
 			OptionalCard(self.0.state().foundation3().last()),
@@ -59,28 +60,49 @@ impl Display for Displayed<&Klondike> {
 		)?;
 		writeln!(f)?;
 
-		fn write_pile<const DN: usize, const UP: usize>(
+		writeln!(f, " T1  T2  T3  T4  T5  T6  T7")?;
+
+		fn write_pile_card<const DN: usize, const UP: usize>(
 			f: &mut std::fmt::Formatter<'_>,
 			pile: &Pile<DN, UP>,
-			pile_id: usize,
+			row: usize,
 		) -> std::fmt::Result {
-			write!(f, "T{} ", pile_id)?;
-			for _ in pile.face_down() {
-				write!(f, "]")?;
+			if let Some(_card) = pile.face_down().get(row) {
+				return write!(f, " ⎾⏋"); // └┘ ⨽⨼ ⫭⫬
 			}
-			for card in pile.face_up() {
-				write!(f, "{}", Displayed(card))?;
+			let Some(row) = row.checked_sub(pile.face_down().len()) else {
+				return write!(f, "   ");
+			};
+			if let Some(card) = pile.face_up().get(row) {
+				return write!(f, "{}", Displayed(card));
 			}
-			writeln!(f)?;
-			Ok(())
+			write!(f, "   ")
+		}
+
+		fn write_row(
+			f: &mut std::fmt::Formatter<'_>,
+			game: &Klondike,
+			row: usize,
+		) -> std::fmt::Result {
+			write_pile_card(f, game.state().tableau1(), row)?;
+			write!(f, " ")?;
+			write_pile_card(f, game.state().tableau2(), row)?;
+			write!(f, " ")?;
+			write_pile_card(f, game.state().tableau3(), row)?;
+			write!(f, " ")?;
+			write_pile_card(f, game.state().tableau4(), row)?;
+			write!(f, " ")?;
+			write_pile_card(f, game.state().tableau5(), row)?;
+			write!(f, " ")?;
+			write_pile_card(f, game.state().tableau6(), row)?;
+			write!(f, " ")?;
+			write_pile_card(f, game.state().tableau7(), row)?;
+			writeln!(f)
+		}
+
+		for row in 0..7 + 13 {
+			write_row(f, self.0, row)?;
 		}
-		write_pile(f, self.0.state().tableau1(), 1)?;
-		write_pile(f, self.0.state().tableau2(), 2)?;
-		write_pile(f, self.0.state().tableau3(), 3)?;
-		write_pile(f, self.0.state().tableau4(), 4)?;
-		write_pile(f, self.0.state().tableau5(), 5)?;
-		write_pile(f, self.0.state().tableau6(), 6)?;
-		write_pile(f, self.0.state().tableau7(), 7)?;
 
 		Ok(())
 	}
@@ -252,7 +274,7 @@ fn main() -> Result<(), std::io::Error> {
 				}
 			}
 			SessionInstruction::Auto => {
-				if let Some(instruction) = session.state().get_auto_move() {
+				if let Some(instruction) = session.state().get_auto_move(session.config()) {
 					session.process_instruction(instruction);
 				} else {
 					println!("No valid moves!");

klondike/README.md

@@ -7,18 +7,19 @@ Klondike
 
 ```rust
 use card_game::Session;
-use klondike::Klondike;
+use klondike::{Klondike, KlondikeConfig};
 
 // create game session
 let game = Klondike::with_seed(123);
+let config = KlondikeConfig::default();
 let mut session = Session::new_default(game);
 
 // play game a bit
-while let Some(instruction) = session.state().get_auto_move() {
+while let Some(instruction) = session.state().get_auto_move(&config) {
 	session.process_instruction(instruction);
 
-	// quit after 1000 moves
-	if 1000 < session.stats().stats().moves() {
+	// quit after 200 moves or win
+	if session.is_win() || 200 < session.stats().stats().moves() {
 		break;
 	}
 }

klondike/src/lib.rs

@@ -14,9 +14,17 @@ pub enum DrawStockConfig {
 	DrawThree = 3,
 }
 
+#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
+pub enum MoveFromFoundationConfig {
+	#[default]
+	Allowed,
+	Disallowed,
+}
+
 #[derive(Clone, Debug, Default)]
 pub struct KlondikeConfig {
 	pub draw_stock: DrawStockConfig,
+	pub move_from_foundation: MoveFromFoundationConfig,
 }
 
 #[derive(Clone, Debug, Default)]
@@ -137,7 +145,6 @@ impl From<Foundation> for KlondikePile {
 	}
 }
 
-#[repr(u8)]
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
 pub enum SkipCards {
 	Skip0,
@@ -366,15 +373,26 @@ impl KlondikeState {
 	pub const fn tableau7(&self) -> &Pile<6, 13> {
 		&self.tableau7
 	}
-	pub fn is_tableau_face_down_empty(&self, tableau: Tableau) -> bool {
+	pub fn tableau_face_down_cards(&self, tableau: Tableau) -> &[Card] {
 		match tableau {
-			Tableau::Tableau1 => self.tableau1.face_down().is_empty(),
-			Tableau::Tableau2 => self.tableau2.face_down().is_empty(),
-			Tableau::Tableau3 => self.tableau3.face_down().is_empty(),
-			Tableau::Tableau4 => self.tableau4.face_down().is_empty(),
-			Tableau::Tableau5 => self.tableau5.face_down().is_empty(),
-			Tableau::Tableau6 => self.tableau6.face_down().is_empty(),
-			Tableau::Tableau7 => self.tableau7.face_down().is_empty(),
+			Tableau::Tableau1 => self.tableau1.face_down(),
+			Tableau::Tableau2 => self.tableau2.face_down(),
+			Tableau::Tableau3 => self.tableau3.face_down(),
+			Tableau::Tableau4 => self.tableau4.face_down(),
+			Tableau::Tableau5 => self.tableau5.face_down(),
+			Tableau::Tableau6 => self.tableau6.face_down(),
+			Tableau::Tableau7 => self.tableau7.face_down(),
+		}
+	}
+	pub fn tableau_face_up_cards(&self, tableau: Tableau) -> &[Card] {
+		match tableau {
+			Tableau::Tableau1 => self.tableau1.face_up(),
+			Tableau::Tableau2 => self.tableau2.face_up(),
+			Tableau::Tableau3 => self.tableau3.face_up(),
+			Tableau::Tableau4 => self.tableau4.face_up(),
+			Tableau::Tableau5 => self.tableau5.face_up(),
+			Tableau::Tableau6 => self.tableau6.face_up(),
+			Tableau::Tableau7 => self.tableau7.face_up(),
 		}
 	}
 	pub fn stack_bottom_card(&self, src: KlondikePileStack) -> Option<&Card> {
@@ -382,15 +400,7 @@ impl KlondikeState {
 			KlondikePileStack::Tableau(TableauStack {
 				tableau,
 				skip_cards,
-			}) => match tableau {
-				Tableau::Tableau1 => self.tableau1.face_up().get(skip_cards as usize),
-				Tableau::Tableau2 => self.tableau2.face_up().get(skip_cards as usize),
-				Tableau::Tableau3 => self.tableau3.face_up().get(skip_cards as usize),
-				Tableau::Tableau4 => self.tableau4.face_up().get(skip_cards as usize),
-				Tableau::Tableau5 => self.tableau5.face_up().get(skip_cards as usize),
-				Tableau::Tableau6 => self.tableau6.face_up().get(skip_cards as usize),
-				Tableau::Tableau7 => self.tableau7.face_up().get(skip_cards as usize),
-			},
+			}) => self.tableau_face_up_cards(tableau).get(skip_cards as usize),
 			KlondikePileStack::Foundation(foundation) => {
 				self.foundations[foundation as usize].last()
 			}
@@ -399,15 +409,7 @@ impl KlondikeState {
 	}
 	pub fn top_card<S: Into<KlondikePile>>(&self, src: S) -> Option<&Card> {
 		match src.into() {
-			KlondikePile::Tableau(tableau) => match tableau {
-				Tableau::Tableau1 => self.tableau1.face_up().last(),
-				Tableau::Tableau2 => self.tableau2.face_up().last(),
-				Tableau::Tableau3 => self.tableau3.face_up().last(),
-				Tableau::Tableau4 => self.tableau4.face_up().last(),
-				Tableau::Tableau5 => self.tableau5.face_up().last(),
-				Tableau::Tableau6 => self.tableau6.face_up().last(),
-				Tableau::Tableau7 => self.tableau7.face_up().last(),
-			},
+			KlondikePile::Tableau(tableau) => self.tableau_face_up_cards(tableau).last(),
 			KlondikePile::Foundation(foundation) => self.foundations[foundation as usize].last(),
 			KlondikePile::Stock => self.stock.face_up().last(),
 		}
@@ -465,7 +467,11 @@ impl KlondikeState {
 			Tableau::Tableau7 => self.tableau7.extend(cards),
 		}
 	}
-	pub fn is_instruction_valid(&self, instruction: KlondikeInstruction) -> bool {
+	pub fn is_instruction_valid(
+		&self,
+		config: &KlondikeConfig,
+		instruction: KlondikeInstruction,
+	) -> bool {
 		match instruction {
 			// Stock -> Stock draws a card or resets the stock
 			KlondikeInstruction::RotateStock => {
@@ -494,6 +500,11 @@ impl KlondikeState {
 			}
 			// other = move to tableau
 			KlondikeInstruction::DstTableau(dst_tableau) => {
+				if config.move_from_foundation == MoveFromFoundationConfig::Disallowed
+					&& let KlondikePileStack::Foundation(_) = dst_tableau.src
+				{
+					return false;
+				}
 				// get the cards
 				if let Some(src_card) = self.stack_bottom_card(dst_tableau.src) {
 					match self.top_card(dst_tableau.tableau) {
@@ -588,7 +599,7 @@ impl Klondike {
 	/// Check if the game should be auto-completed
 	pub fn is_win_trivial(&self) -> bool {
 		// all face down cards empty means win
-		self.state.stock.face_down().is_empty()
+		self.state.stock.is_empty()
 			&& self.state.tableau1.face_down().is_empty()
 			&& self.state.tableau2.face_down().is_empty()
 			&& self.state.tableau3.face_down().is_empty()
@@ -610,7 +621,7 @@ impl Klondike {
 				KlondikePileStack::Tableau(TableauStack {
 					tableau,
 					skip_cards: SkipCards::Skip0,
-				}) if !self.state().is_tableau_face_down_empty(tableau)
+				}) if !self.state().tableau_face_down_cards(tableau).is_empty()
 					|| self
 						.state()
 						.stack_bottom_card(dst_tableau.src)
@@ -626,15 +637,15 @@ impl Klondike {
 		}
 	}
 	/// A single move that usually makes progress towards a winning game
-	pub fn get_auto_move(&self) -> Option<KlondikeInstruction> {
-		self.possible_instructions()
+	pub fn get_auto_move(&self, config: &KlondikeConfig) -> Option<KlondikeInstruction> {
+		self.possible_instructions(config)
 			.filter(|ins| !ins.is_useless())
 			.min_by_key(|ins| self.instruction_priority(ins))
 	}
 	/// A list of possible moves with useless moves filtered out and sorted by a simple priority function
-	pub fn get_sorted_moves(&self) -> Vec<KlondikeInstruction> {
+	pub fn get_sorted_moves(&self, config: &KlondikeConfig) -> Vec<KlondikeInstruction> {
 		let mut useful_moves: Vec<_> = self
-			.possible_instructions()
+			.possible_instructions(config)
 			.filter(|ins| !ins.is_useless())
 			.collect();
 		useful_moves.sort_by_key(|ins| self.instruction_priority(ins));
@@ -646,12 +657,17 @@ impl Game for Klondike {
 	type Stats = KlondikeStats;
 	type Config = KlondikeConfig;
 	type Instruction = KlondikeInstruction;
-	fn possible_instructions(&self) -> impl Iterator<Item = Self::Instruction> + use<> {
+	fn possible_instructions(
+		&self,
+		config: &Self::Config,
+	) -> impl Iterator<Item = Self::Instruction> + use<> {
 		let state = self.state.clone();
-		KlondikeIter::new().filter(move |&instruction| state.is_instruction_valid(instruction))
+		let config = config.clone();
+		KlondikeIter::new()
+			.filter(move |&instruction| state.is_instruction_valid(&config, instruction))
 	}
-	fn is_instruction_valid(&self, _config: &Self::Config, instruction: Self::Instruction) -> bool {
-		self.state.is_instruction_valid(instruction)
+	fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool {
+		self.state.is_instruction_valid(config, instruction)
 	}
 	fn process_instruction(
 		&mut self,