# prmr/solitaire architecture

> Architecture diagram of the GitHub repository prmr/solitaire, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/prmr/solitaire
- Repository: https://github.com/prmr/solitaire

## Overview

This is a JavaFX Solitaire application. The main workflow is a player drawing or dragging cards, the model validating and applying moves, then notifying views to refresh; undo reverses the recorded move. The model owns deck, discard, foundations, tableau and move history. A greedy strategy can request automatic moves, and documented headless drivers exercise play without the GUI. The graph follows documented interactions and source-index references; several GUI details are not fully excerpted, so uncertain links are omitted.

Main entry points: [`src/ca/mcgill/solitaire/model/GameModel.java`](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/GameModel.java) (Game model), [`src/ca/mcgill/solitaire/auto/GreedyPlayingStrategy.java`](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/auto/GreedyPlayingStrategy.java) (Greedy strategy), [`src/ca/mcgill/solitaire/model/GameModelListener.java`](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/GameModelListener.java) (Model listeners), [`src/ca/mcgill/solitaire/gui/CardPileView.java`](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/CardPileView.java) (Pile views)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Player interface"]
  node_app["Solitaire window<br/>[Solitaire.java]"]
  node_pileviews["Pile views<br/>[CardPileView.java]"]
  node_deckview["Deck view<br/>[DeckView.java]"]
  node_discardview["Discard view"]
  node_foundationview["Foundation views<br/>[SuitStack.java]"]
  node_drag["Card drag"]
  node_images["Card images<br/>[CardImages.java]"]
end

subgraph group_game["Game rules and state"]
  node_model["Game model<br/>[GameModel.java]"]
  node_tableau["Tableau rules<br/>[Tableau.java]"]
  node_foundations["Foundation rules<br/>[Foundations.java]"]
  node_moves["Move actions<br/>[Move.java]"]
  node_gameview["Read-only game view<br/>[GameModelView.java]"]
  node_listeners["Model listeners"]
end

subgraph group_cards["Card primitives"]
  node_cardtypes["Cards and deck"]
  node_serializer["Card serialization"]
end

subgraph group_automation["Automated play"]
  node_strategy["Greedy strategy"]
  node_drivers["Headless drivers<br/>[Driver.java]"]
end

node_player(("Player"))

node_player -->|"plays"| node_app
node_app -->|"creates and configures"| node_model
node_player -->|"drags cards"| node_pileviews
node_pileviews -->|"requests moves"| node_model
node_deckview -->|"draws cards"| node_model
node_discardview -->|"reads state"| node_model
node_foundationview -->|"reads state"| node_model
node_pileviews -->|"renders cards"| node_images
node_deckview -->|"renders cards"| node_images
node_discardview -->|"renders cards"| node_images
node_foundationview -->|"renders cards"| node_images
node_drag -->|"serializes dragged card"| node_serializer
node_app -->|"configures autoplay"| node_strategy
node_model -->|"implements view"| node_gameview
node_model -->|"updates tableau"| node_tableau
node_model -->|"updates foundations"| node_foundations
node_model -->|"creates and applies"| node_moves
node_model -->|"notifies changes"| node_listeners
node_pileviews -->|"refreshes on change"| node_listeners
node_deckview -->|"refreshes on change"| node_listeners
node_discardview -->|"refreshes on change"| node_listeners
node_foundationview -->|"refreshes on change"| node_listeners
node_model -->|"manages cards"| node_cardtypes
node_tableau -->|"stores card stacks"| node_cardtypes
node_foundations -->|"stores card stacks"| node_cardtypes
node_serializer -->|"encodes cards"| node_cardtypes
node_strategy -->|"queries legal moves"| node_gameview
node_strategy -->|"returns chosen move"| node_moves
node_model -->|"requests autoplay move"| node_strategy
node_drivers -->|"runs headless game"| node_model
node_drivers -->|"uses autoplay"| node_strategy

click node_app "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/Solitaire.java"
click node_pileviews "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/CardPileView.java"
click node_deckview "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/DeckView.java"
click node_discardview "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/DiscardPileView.java"
click node_foundationview "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/SuitStack.java"
click node_drag "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/CardDragHandler.java"
click node_images "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/CardImages.java"
click node_model "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/GameModel.java"
click node_tableau "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/Tableau.java"
click node_foundations "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/Foundations.java"
click node_moves "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/Move.java"
click node_gameview "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/GameModelView.java"
click node_listeners "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/GameModelListener.java"
click node_cardtypes "https://github.com/prmr/solitaire/tree/master/src/ca/mcgill/solitaire/cards"
click node_serializer "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/cards/CardSerializer.java"
click node_strategy "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/auto/GreedyPlayingStrategy.java"
click node_drivers "https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/auto/Driver.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_pileviews,node_deckview,node_discardview,node_foundationview,node_drag,node_images toneBlue
class node_model,node_tableau,node_foundations,node_moves,node_gameview,node_listeners toneAmber
class node_cardtypes,node_serializer toneMint
class node_strategy,node_drivers toneRose
class node_player toneIndigo
```

## Components

### Player interface

- [Solitaire window](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/Solitaire.java): `src/ca/mcgill/solitaire/gui/Solitaire.java`
- [Pile views](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/CardPileView.java): `src/ca/mcgill/solitaire/gui/CardPileView.java`
- [Deck view](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/DeckView.java): `src/ca/mcgill/solitaire/gui/DeckView.java`
- [Discard view](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/DiscardPileView.java): `src/ca/mcgill/solitaire/gui/DiscardPileView.java`
- [Foundation views](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/SuitStack.java): `src/ca/mcgill/solitaire/gui/SuitStack.java`
- [Card drag](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/CardDragHandler.java): `src/ca/mcgill/solitaire/gui/CardDragHandler.java`
- [Card images](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/gui/CardImages.java): `src/ca/mcgill/solitaire/gui/CardImages.java`

### Game rules and state

- [Game model](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/GameModel.java): `src/ca/mcgill/solitaire/model/GameModel.java`
- [Tableau rules](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/Tableau.java): `src/ca/mcgill/solitaire/model/Tableau.java`
- [Foundation rules](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/Foundations.java): `src/ca/mcgill/solitaire/model/Foundations.java`
- [Move actions](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/Move.java): `src/ca/mcgill/solitaire/model/Move.java`
- [Read-only game view](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/GameModelView.java): `src/ca/mcgill/solitaire/model/GameModelView.java`
- [Model listeners](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/model/GameModelListener.java): `src/ca/mcgill/solitaire/model/GameModelListener.java`

### Card primitives

- [Cards and deck](https://github.com/prmr/solitaire/tree/master/src/ca/mcgill/solitaire/cards): `src/ca/mcgill/solitaire/cards`
- [Card serialization](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/cards/CardSerializer.java): `src/ca/mcgill/solitaire/cards/CardSerializer.java`

### Automated play

- [Greedy strategy](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/auto/GreedyPlayingStrategy.java): `src/ca/mcgill/solitaire/auto/GreedyPlayingStrategy.java`
- [Headless drivers](https://github.com/prmr/solitaire/blob/master/src/ca/mcgill/solitaire/auto/Driver.java): `src/ca/mcgill/solitaire/auto/Driver.java`

### Other components

- **Player**

## Connections

- Player → Solitaire window: plays (evidence: `README.md`)
- Solitaire window → Game model: creates and configures (evidence: `src/ca/mcgill/solitaire/gui/Solitaire.java`)
- Player → Pile views: drags cards (evidence: `README.md`)
- Pile views → Game model: requests moves (evidence: `src/ca/mcgill/solitaire/gui/CardPileView.java`)
- Deck view → Game model: draws cards (evidence: `src/ca/mcgill/solitaire/gui/DeckView.java`)
- Discard view → Game model: reads state (evidence: `src/ca/mcgill/solitaire/gui/DiscardPileView.java`)
- Foundation views → Game model: reads state (evidence: `src/ca/mcgill/solitaire/gui/SuitStack.java`)
- Pile views → Card images: renders cards (evidence: `src/ca/mcgill/solitaire/gui/CardPileView.java`)
- Deck view → Card images: renders cards (evidence: `src/ca/mcgill/solitaire/gui/DeckView.java`)
- Discard view → Card images: renders cards (evidence: `src/ca/mcgill/solitaire/gui/DiscardPileView.java`)
- Foundation views → Card images: renders cards (evidence: `src/ca/mcgill/solitaire/gui/SuitStack.java`)
- Card drag → Card serialization: serializes dragged card (evidence: `src/ca/mcgill/solitaire/gui/CardDragHandler.java`)
- Solitaire window → Greedy strategy: configures autoplay (evidence: `src/ca/mcgill/solitaire/gui/Solitaire.java`)
- Game model → Read-only game view: implements view (evidence: `src/ca/mcgill/solitaire/model/GameModel.java`)
- Game model → Tableau rules: updates tableau (evidence: `src/ca/mcgill/solitaire/model/GameModel.java`)
- Game model → Foundation rules: updates foundations (evidence: `src/ca/mcgill/solitaire/model/GameModel.java`)
- Game model → Move actions: creates and applies (evidence: `src/ca/mcgill/solitaire/model/GameModel.java`)
- Game model → Model listeners: notifies changes (evidence: `src/ca/mcgill/solitaire/model/GameModel.java`)
- Pile views → Model listeners: refreshes on change (evidence: `src/ca/mcgill/solitaire/gui/CardPileView.java`)
- Deck view → Model listeners: refreshes on change (evidence: `src/ca/mcgill/solitaire/gui/DeckView.java`)
- Discard view → Model listeners: refreshes on change (evidence: `src/ca/mcgill/solitaire/gui/DiscardPileView.java`)
- Foundation views → Model listeners: refreshes on change (evidence: `src/ca/mcgill/solitaire/gui/SuitStack.java`)
- Game model → Cards and deck: manages cards (evidence: `src/ca/mcgill/solitaire/model/GameModel.java`)
- Tableau rules → Cards and deck: stores card stacks (evidence: `src/ca/mcgill/solitaire/model/Tableau.java`)
- Foundation rules → Cards and deck: stores card stacks (evidence: `src/ca/mcgill/solitaire/model/Foundations.java`)
- Card serialization → Cards and deck: encodes cards (evidence: `src/ca/mcgill/solitaire/cards/CardSerializer.java`)
- Greedy strategy → Read-only game view: queries legal moves (evidence: `src/ca/mcgill/solitaire/auto/GreedyPlayingStrategy.java`)
- Greedy strategy → Move actions: returns chosen move (evidence: `src/ca/mcgill/solitaire/auto/GreedyPlayingStrategy.java`)
- Game model → Greedy strategy: requests autoplay move (evidence: `src/ca/mcgill/solitaire/model/GameModel.java`)
- Headless drivers → Game model: runs headless game (evidence: `src/ca/mcgill/solitaire/auto/Driver.java`)
- Headless drivers → Greedy strategy: uses autoplay (evidence: `src/ca/mcgill/solitaire/auto/Driver.java`)
