Swarm.Game.Exception

Runtime exceptions for the Swarm language interpreter.

Documentation

data Exn

The type of exceptions that can be thrown by robot programs.

Constructors

Fatal Text

Something went very wrong. This is a bug in Swarm and cannot be caught by a try block (but at least it will not crash the entire UI).

InfiniteLoop

An infinite loop was detected via a blackhole. This cannot be caught by a try block.

Incapable IncapableFix Requirements Term

A robot tried to do something for which it does not have some of the required capabilities. This cannot be caught by a try block. Also contains the missing requirements, the term that caused the problem, and a suggestion for how to fix things.

CmdFailed Const Text (Maybe GameplayAchievement)

A command failed in some "normal" way (e.g. a Move command could not move, or a Grab command found nothing to grab, etc.). Can be caught by a try block.

User Text

The user program explicitly called Undefined or Fail. Can be caught by a try block.

Instances

FromJSON Exn

Defined in Swarm.Game.Exception

Methods

parseJSON :: Value -> Parser Exn

parseJSONList :: Value -> Parser [Exn]

ToJSON Exn

Defined in Swarm.Game.Exception

Methods

toJSON :: Exn -> Value

toEncoding :: Exn -> Encoding

toJSONList :: [Exn] -> Value

toEncodingList :: [Exn] -> Encoding

Generic Exn

Defined in Swarm.Game.Exception

Associated Types

type Rep Exn :: Type -> Type

Methods

from :: Exn -> Rep Exn x

to :: Rep Exn x -> Exn

Show Exn

Defined in Swarm.Game.Exception

Methods

showsPrec :: Int -> Exn -> ShowS

show :: Exn -> String

showList :: [Exn] -> ShowS

Eq Exn

Defined in Swarm.Game.Exception

Methods

(==) :: Exn -> Exn -> Bool

(/=) :: Exn -> Exn -> Bool

type Rep Exn

Defined in Swarm.Game.Exception

type Rep Exn = D1 ('MetaData "Exn" "Swarm.Game.Exception" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) ((C1 ('MetaCons "Fatal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "InfiniteLoop" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Incapable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IncapableFix) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Requirements) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Term))) :+: (C1 ('MetaCons "CmdFailed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Const) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameplayAchievement)))) :+: C1 ('MetaCons "User" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

data IncapableFix

Suggested way to fix things when a robot does not meet the requirements to run a command.

Constructors

FixByEquip

Equip the missing device on yourself/target

FixByObtain

Add the missing device to your inventory

Instances

FromJSON IncapableFix

Defined in Swarm.Game.Exception

Methods

parseJSON :: Value -> Parser IncapableFix

parseJSONList :: Value -> Parser [IncapableFix]

ToJSON IncapableFix

Defined in Swarm.Game.Exception

Methods

toJSON :: IncapableFix -> Value

toEncoding :: IncapableFix -> Encoding

toJSONList :: [IncapableFix] -> Value

toEncodingList :: [IncapableFix] -> Encoding

Generic IncapableFix

Defined in Swarm.Game.Exception

Associated Types

type Rep IncapableFix :: Type -> Type

Methods

from :: IncapableFix -> Rep IncapableFix x

to :: Rep IncapableFix x -> IncapableFix

Show IncapableFix

Defined in Swarm.Game.Exception

Methods

showsPrec :: Int -> IncapableFix -> ShowS

show :: IncapableFix -> String

showList :: [IncapableFix] -> ShowS

Eq IncapableFix

Defined in Swarm.Game.Exception

Methods

(==) :: IncapableFix -> IncapableFix -> Bool

(/=) :: IncapableFix -> IncapableFix -> Bool

type Rep IncapableFix

Defined in Swarm.Game.Exception

type Rep IncapableFix = D1 ('MetaData "IncapableFix" "Swarm.Game.Exception" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "FixByEquip" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FixByObtain" 'PrefixI 'False) (U1 :: Type -> Type))

formatExn :: EntityMap -> Exn -> Text

Pretty-print an exception for displaying to the player.

Helper functions

formatIncapable :: EntityMap -> IncapableFix -> Requirements -> Term -> Text

Pretty print the incapable exception with an actionable suggestion on how to fix it.

>>> import Data.Either (fromRight)
>>> import Control.Carrier.Throw.Either (runThrow)
>>> import Control.Algebra (run)
>>> import Swarm.Game.Failure (LoadingFailure)
>>> :set -XTypeApplications
>>> w = mkEntity (defaultEntityDisplay 'l') "magic wand" mempty mempty [CAppear]
>>> r = mkEntity (defaultEntityDisplay 'o') "the one ring" mempty mempty [CAppear]
>>> m = fromRight mempty . run . runThrow @LoadingFailure $ buildEntityMap [w,r]
>>> incapableError cs t = putStr . unpack $ formatIncapable m FixByEquip cs t

>>> incapableError (R.singletonCap CGod) (TConst As)
Thou shalt not utter such blasphemy:
  'as'
  If God in troth thou wantest to play, try thou a Creative game.

>>> incapableError (R.singletonCap CAppear) (TConst Appear)
You do not have the devices required for:
  'appear'
  Please equip:
  - the one ring or magic wand

>>> incapableError (R.singletonCap CRandom) (TConst Random)
Missing the random capability for:
  'random'
  but no device yet provides it. See
  https://github.com/swarm-game/swarm/issues/26

>>> incapableError (R.singletonInv 3 "tree") (TConst Noop)
You are missing required inventory for:
  'noop'
  Please obtain:
  - tree (3)

formatIncapableFix :: IncapableFix -> Text

Pretty-print an IncapableFix: either "equip" or "obtain".