| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
BishBosh.UI.Command
Description
AUTHOR- Dr. Alistair Ward
DESCRIPTION- Defines the commands a user can issue.
Synopsis
- data Command
- printTag :: String
- setTag :: String
- usageMessage :: String
- readsCommand :: String -> Either String (Command, String)
- showsCommand :: Command -> ShowS
- issueCommand :: Command -> ShowS
- autoComplete :: ShowS
Types
Data-types
The sum-type of commands that a user may issue.
Constructors
| Hint | Request a move-suggestion. |
| Print PrintObject | Print the requested static data. |
| Quit | Terminate this application. |
| Report ReportObject | Report on the requested dynamic data. |
| Resign | Admit defeat. |
| Restart | Abandon the current game, & start afresh. |
| RollBack (Maybe NPlies) | Roll-back the optionally specified number of plies. |
| Save | Persist the current game-state. |
| Set SetObject | I.E. mutate something. |
| Swap | Swap options between the two sides; which causes the players to swap sides. |
Constants
usageMessage :: String Source #
A message defining the syntax of the available commands.
Functions
showsCommand :: Command -> ShowS Source #
Shows a command.
issueCommand :: Command -> ShowS Source #
Show the specified command in the format required by this application's parser.
autoComplete :: ShowS Source #
Replace the first word of the specified string with the name of a command of which it is an unambiguous case-insensitive prefix.