Language.Nomyx.Expression

This module containt the type definitions necessary to build a Nomic rule.

Documentation

type PlayerNumber = Int

type PlayerName = String

type RuleNumber = Int

type RuleName = String

type RuleText = String

type RuleCode = String

type EventNumber = Int

type EventName = String

type VarName = String

type GameName = String

type Code = String

Expression

data Exp a where

an Exp allows the player's rule to have access to the state of the game. | it is a compositional algebra defined with a GADT.

Constructors

NewVar :: (Typeable a, Show a, Eq a) => VarName -> a -> Exp (Maybe (V a))

DelVar :: V a -> Exp Bool

ReadVar :: (Typeable a, Show a, Eq a) => V a -> Exp (Maybe a)

WriteVar :: (Typeable a, Show a, Eq a) => V a -> a -> Exp Bool

OnEvent :: (Typeable e, Show e, Eq e) => Event e -> ((EventNumber, EventData e) -> Exp ()) -> Exp EventNumber

DelEvent :: EventNumber -> Exp Bool

DelAllEvents :: (Typeable e, Show e, Eq e) => Event e -> Exp ()

SendMessage :: (Typeable a, Show a, Eq a) => Event (Message a) -> a -> Exp ()

Output :: PlayerNumber -> String -> Exp ()

ProposeRule :: Rule -> Exp Bool

ActivateRule :: RuleNumber -> Exp Bool

RejectRule :: RuleNumber -> Exp Bool

AddRule :: Rule -> Exp Bool

DelRule :: RuleNumber -> Exp Bool

ModifyRule :: RuleNumber -> Rule -> Exp Bool

GetRules :: Exp [Rule]

SetVictory :: [PlayerNumber] -> Exp ()

GetPlayers :: Exp [PlayerInfo]

Const :: a -> Exp a

Bind :: Exp a -> (a -> Exp b) -> Exp b

CurrentTime :: Exp UTCTime

SelfRuleNumber :: Exp RuleNumber

Instances

Monad Exp

Functor Exp

Typeable1 Exp

Variables

data V a

a container for a variable name and type

Constructors

V

Fields

varName :: String

Instances

Typeable1 V

data Var

stores the variable's data

Constructors

forall a . (Typeable a, Show a, Eq a) => Var

Fields

vRuleNumber :: Int

vName :: String

vData :: a

Instances

Eq Var

Show Var

type Output = (PlayerNumber, String)

Events

data Player

events types

Constructors

Arrive

Leave

Instances

Eq Player

Show Player

Typeable Player

data RuleEvent

Constructors

Proposed

Activated

Rejected

Added

Modified

Deleted

Instances

Eq RuleEvent

Show RuleEvent

Typeable RuleEvent

data Time

Instances

Eq Time

Show Time

Typeable Time

data EvRule

Instances

Eq EvRule

Typeable EvRule

data Message m

Instances

Typeable1 Message

Eq (Message m)

Show a => Show (Message a)

data InputChoice c

Instances

Typeable1 InputChoice

Eq (InputChoice a)

Show a => Show (InputChoice a)

data InputString

Instances

Eq InputString

Show InputString

Typeable InputString

data Victory

Instances

Eq Victory

Show Victory

Typeable Victory

data Event a where

events names

Constructors

Player :: Player -> Event Player

RuleEv :: RuleEvent -> Event RuleEvent

Time :: UTCTime -> Event Time

Message :: String -> Event (Message m)

InputChoice :: (Eq c, Show c) => PlayerNumber -> String -> [c] -> c -> Event (InputChoice c)

InputString :: PlayerNumber -> String -> Event InputString

Victory :: Event Victory

Instances

Typeable1 Event

Eq e => Eq (Event e)

Show a => Show (Event a)

data EventData a where

data associated with each events

Constructors

PlayerData :: PlayerInfo -> EventData Player

Fields

playerData :: PlayerInfo

RuleData :: Rule -> EventData RuleEvent

Fields

ruleData :: Rule

TimeData :: UTCTime -> EventData Time

Fields

timeData :: UTCTime

MessageData :: Show m => m -> EventData (Message m)

Fields

messageData :: m

InputChoiceData :: Show c => c -> EventData (InputChoice c)

Fields

inputChoiceData :: c

InputStringData :: String -> EventData InputString

Fields

inputStringData :: String

VictoryData :: [PlayerInfo] -> EventData Victory

Fields

victoryData :: [PlayerInfo]

Instances

Typeable1 EventData

Show a => Show (EventData a)

data EventHandler where

Constructors

EH :: (Typeable e, Show e, Eq e) => EventNumber -> RuleNumber -> Event e -> ((EventNumber, EventData e) -> Exp ()) -> EventHandler

Fields

eventNumber :: EventNumber

ruleNumber :: RuleNumber

event :: Event e

handler :: (EventNumber, EventData e) -> Exp ()

Instances

Eq EventHandler

Ord EventHandler

Show EventHandler

Rule

type OneParamRule a = a -> Exp RuleResponse

type of rule to assess the legality of a given parameter

type NoParamRule = Exp ()

type of rule that just mofify the game state

data RuleResponse

a rule can assess the legality either immediatly of later through a messsage

Constructors

BoolResp

Fields

boolResp :: Bool

MsgResp

Fields

msgResp :: Event (Message Bool)

data RuleFunc

the different types of rules

Constructors

RuleRule

Fields

ruleRule :: OneParamRule Rule

PlayerRule

Fields

playerRule :: OneParamRule PlayerInfo

VoidRule

Fields

voidRule :: NoParamRule

Instances

Show RuleFunc

Typeable RuleFunc

data Rule

An informationnal structure about a rule:

Constructors

Rule

Fields

rNumber :: RuleNumber

rName :: RuleName

rDescription :: String

rProposedBy :: PlayerNumber

rRuleCode :: Code

rRuleFunc :: RuleFunc

rStatus :: RuleStatus

rAssessedBy :: Maybe RuleNumber

Instances

Eq Rule

Ord Rule

Show Rule

Typeable Rule

data RuleStatus

the status of a rule.

Constructors

Active

Pending

Reject

Instances

Eq RuleStatus

Show RuleStatus

Typeable RuleStatus

Player

data PlayerInfo

informations on players

Constructors

PlayerInfo

Fields

playerNumber :: PlayerNumber

playerName :: String

Instances

Eq PlayerInfo

Show PlayerInfo

Typeable PlayerInfo

Game

data Game

The state of the game:

Constructors

Game

Fields

gameName :: GameName

gameDesc :: String

rules :: [Rule]

players :: [PlayerInfo]

variables :: [Var]

events :: [EventHandler]

outputs :: [Output]

victory :: [PlayerNumber]

currentTime :: UTCTime

Instances

Eq Game

Ord Game

Show Game

Typeable Game

(===) :: (Typeable a, Typeable b, Eq b) => a -> b -> Bool

an equality that tests also the types.

replaceWith

Arguments

:: (a -> Bool)

Value to search

-> a

Value to replace it with

-> [a]

Input list

-> [a]

Output list

Replaces all instances of a value in a list by another value.