3 Play klondike and spider solitaire in your unicode terminal.
5 Supports `vi` style keybindings (hjkl), cursor keys and the mouse. Press `J` to
6 'join' a well-suited pile to the cursor. `Space` locks in a selection, and
7 `Return` pulls cards from the stack in spider solitaire. Piles can also be
8 *directly addressed* by the number below them (or 8, 9, 0 for stack, waste and
9 foundation in klondike).
10 See `$PROGNAME -h` for details.
14 For details and screenshots see the project homepage at
15 **https://gir.st/sol.htm**
19 By default the character set uses an `X` to for the 10 card. Compile with `make
20 DECIMAL_TEN=1` to display the letters `10` instead.
24 You can use, study, share and improve this software under the terms of the GNU
25 General Public License, version 3. Copyright 2019 Tobias Girstmair. For
26 licensing details, see `LICENSE`.
34 * TODO: suggest moves (`h` => hint)
35 * TODO: cleanup: in `x2y()` functions there is a lot of replication and noise
36 when calculating legal moves, top cards, etc.
38 * TODO: visbell changes: instead of screen, flash active {cursor,card} {red,twice}?
39 * TODO: differential drawing mode (at least for highlighting cards)
40 * TODO: `.` command (repeat last action)
41 * TODO: FreeCell (/u/CFWhitman) - req' algorithm for moving multiple cards around
42 for first multicardmove impl.: allow moving (n+1) cards where n is empty spaces
44 * TODO: mouse mode improvements:
45 - spider: detect how many cards to move to empty pile
46 (must find exact position despite `extreme_overlap`)
47 * TODO: scores, variants: draw 3, max. n overturns
48 * TODO: vt220 mode (problems: charset, slow baudrate and no differential drawing mode)
49 * TODO: ed(1) mode (solEDaire): playable on a line printer; ascii/ibm only?
52 * DONE: use `#ifdef`s to differentiate games (sol, spider, ed-sol, ed-spider)
53 * DONE: keyboard alias: twice same key == waste/pile -> foundation
54 * DONE: spider keyboard: `<from><to>` stacks; 1-9,0=tableu, return=draw
55 * DONE: spider: easy/medium difficulty: only deal 1/2 suits instead of 4 -> deal()
56 * DONE: patience: allow taking from 0(foundation)
57 * DONE: highlight `from` pile, so users can see at what input stage they are
58 * DONE: make piles 0-indexed in klondike as well
59 * DONE: duplicate card ♠A found in tableu: added check at start to monitor this
60 Cannot reproduce, removed check
61 * DONE: bugs in spider's t2t()
62 * once segfaulted on large column
63 * sometimes doesn't work (ERR when it should be OK)
65 * DONE: some input functions are in `x2y()` - - move them to `get_cmd()` (req.
66 for mouse, hjkl modes)
67 * DONE: sigint, sigcont handler! atexit() to avoid inconsistent term state
68 * DONE: hjkl keyboard mode
69 * DONE: more vim mode keys (first/last tableu)
70 * DONE: online (key-)help `?`, `-h`, `-v` (NOTE: implemented -h, rest deemed
72 * DONE: extreme overlapping: if we are printing a sequence or multiple face down
73 cards, only print `.overlap` lines of the ends, and `1` line for the
75 * DONE: in direct addressing 'up to' dialog: make return/space select the lowest/highest option
77 - insert append_undo() in x2y() functions
78 - to encode stack position we need to overload `f.u.n` as index.
79 (similar for foundation: overload `f.u.n` as foundation id)
80 - w2f(): have to encode both stock index and foundation id
81 don't want to add a struct field for this one case;
82 for the time being (i.e. forever) I'm ORing waste index and
83 (foundation id<<16). ugly but works :/
84 - turning over cards: this needs to be encoded, because the card might
85 be consecutive and there's no way to tell what its previous state was.
86 * indicate that a card was turned (can be at most 1) by negating u.n
87 pros: no wasted space (it's just a boolean value), negation pattern
88 already used for closed cards
89 cons: dirty C hack, less obvious than in other places, no need to
90 conserve memory this tightly
91 * DONE: screen size > stack height => rendering issues!
92 as good as it's going to get, since we can't just not draw cards at all
93 * DONE: 'join to here' command (should take longest chain available)
94 * DONE: expose deal() seed for restarting the game
95 * DONE: make portable (clang on FreeBSD)
96 makefile's `$<` refuses to work if prequisite name != target name
99 sed -i 's/^spider: sol.c/spider: spider.c/' Makefile
100 * DONE: escape sequences (for real cursor keys)
101 * DONE: inverted moves (if A->B doesn't work, try B->A)
102 * DONE: - allow dragging the mouse
103 * DONE: use `10` instead of `X` on card face (/u/Valley6660)
104 * DONE: `:help` to show keyhelp (/u/Valley6660)
105 * DONE: don't show cursor-highlight when inputting directly or with the mouse (/u/TooEarlyForMe)
106 * DONE: remove sysmlink trickery and just call sol.c explicitly
113 {stock}[waste] [4*foundation]
116 [] (tableu piles) {} {}
124 <!-- NOTE: these were written during the early stages of development and are no
125 longer 100% accurate.
127 - enum for each card (e.g. `SPADES_ACE`, `HEARTS_10`)
128 - each pile is an array holding (13 open cards + up to 6 closed)
129 [0] is the "northmost"/bottom-most card; unoccupied are NULL/NO_CARD
130 - a single card is represented in the 'cards' enum; if it is closed, it is negated.
131 - the foundation are 4 arrays of size 13
132 - the stock pile is an array holding n cards and an index to the one to display
133 when removing, decrement stack size and move all cards above index 1 over
134 - previous states array: where to move which cards to get back to the state before
136 double-linked list (follow `.prev` to undo, `.next` to redo)
137 "N cards were moved from X to Y" (do Y->X to undo)
138 allows jumping forwards in time as well (by repeating X->Y)
139 warn: when appending state, must check if `.next` was non-NULL and free rest of chain if so.
140 - multiple card sizes: schemes.h will store cards like below. if we want to draw a card
141 that has one or more other cards below it, we only draw the first `.overlap` lines,
142 otherwise if it is the last one, we draw the whole one.
143 this will give a look like in `~/solitaire-tests`
145 .grid=7, /*vertical alignment*/
162 "closed": face down card