Safe Haskell	None
Language	Haskell2010

FlexTask.Types

Description

FlexTask configuration and task instance types.

Synopsis

type HtmlDict = Map Lang String
data CommonModules = CommonModules {
- taskName :: String
- globalModule :: String
- settingsModule :: String
- descriptionModule :: String
- parseModule :: String
- extraModules :: [(String, String)]
}
data FlexInst = FlexInst {
- form :: ([[Text]], HtmlDict)
- taskData :: String
- commonModules :: CommonModules
- checkModule :: String
}
data FlexConf = FlexConf {
- taskDataModule :: String
- commonModules :: CommonModules
}
delimiter :: String
parseFlexConfig :: Parser FlexConf
showFlexConfig :: FlexConf -> String
validateFlexConfig :: forall (m :: Type -> Type). OutputCapable m => FlexConf -> LangM m

Documentation

type HtmlDict = Map Lang String Source #

A map of language code and internationalized HTML value pairs.

data CommonModules Source #

Modules present in both FlexConf and FlexInst. They are propagated to the generated task instance.

Constructors

CommonModules

Fields

taskName :: String
A task identifier used as a label for file caching
globalModule :: String
Global code module available in all interpreter runs.
settingsModule :: String
Module for task configuration constants.
descriptionModule :: String
Module for producing the task description.
parseModule :: String
Module containing the Parser for the submission type.
extraModules :: [(String, String)]
User defined additional modules with format (Name,Code)

Instances

Instances details

Generic CommonModules Source #

Instance details

Defined in FlexTask.Types

Associated Types

type Rep CommonModules

Instance details

Defined in FlexTask.Types

type Rep CommonModules = D1 ('MetaData "CommonModules" "FlexTask.Types" "flex-tasks-0.1-HaEmewq37flGDHHEiCRPd3" 'False) (C1 ('MetaCons "CommonModules" 'PrefixI 'True) ((S1 ('MetaSel ('Just "taskName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "globalModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "settingsModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))) :*: (S1 ('MetaSel ('Just "descriptionModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "parseModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "extraModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, String)])))))

Methods

from :: CommonModules -> Rep CommonModules x #

to :: Rep CommonModules x -> CommonModules #

Show CommonModules Source #

Instance details

Defined in FlexTask.Types

Methods

showsPrec :: Int -> CommonModules -> ShowS #

show :: CommonModules -> String #

showList :: [CommonModules] -> ShowS #

Eq CommonModules Source #

Instance details

Defined in FlexTask.Types

Methods

(==) :: CommonModules -> CommonModules -> Bool #

(/=) :: CommonModules -> CommonModules -> Bool #

Ord CommonModules Source #

Instance details

Defined in FlexTask.Types

Methods

compare :: CommonModules -> CommonModules -> Ordering #

(<) :: CommonModules -> CommonModules -> Bool #

(<=) :: CommonModules -> CommonModules -> Bool #

(>) :: CommonModules -> CommonModules -> Bool #

(>=) :: CommonModules -> CommonModules -> Bool #

max :: CommonModules -> CommonModules -> CommonModules #

min :: CommonModules -> CommonModules -> CommonModules #

type Rep CommonModules Source #

Instance details

Defined in FlexTask.Types

type Rep CommonModules = D1 ('MetaData "CommonModules" "FlexTask.Types" "flex-tasks-0.1-HaEmewq37flGDHHEiCRPd3" 'False) (C1 ('MetaCons "CommonModules" 'PrefixI 'True) ((S1 ('MetaSel ('Just "taskName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "globalModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "settingsModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))) :*: (S1 ('MetaSel ('Just "descriptionModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "parseModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "extraModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, String)])))))

data FlexInst Source #

Concrete Task instance. Contained Haskell code is runtime interpreted to produce needed components of a task.

Constructors

FlexInst
Fields form :: ([[Text]], HtmlDict) Field IDs of input elements and Html code. taskData :: String Flexible task data used by task description and checker functions. commonModules :: CommonModules Modules shared between config and instance. checkModule :: String Module containing the Checker functions.

Instances

Instances details

Generic FlexInst Source #

Instance details

Defined in FlexTask.Types

Associated Types

type Rep FlexInst

Instance details

Defined in FlexTask.Types

type Rep FlexInst = D1 ('MetaData "FlexInst" "FlexTask.Types" "flex-tasks-0.1-HaEmewq37flGDHHEiCRPd3" 'False) (C1 ('MetaCons "FlexInst" 'PrefixI 'True) ((S1 ('MetaSel ('Just "form") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ([[Text]], HtmlDict)) :*: S1 ('MetaSel ('Just "taskData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :*: (S1 ('MetaSel ('Just "commonModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommonModules) :*: S1 ('MetaSel ('Just "checkModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

Methods

from :: FlexInst -> Rep FlexInst x #

to :: Rep FlexInst x -> FlexInst #

type Rep FlexInst Source #

Instance details

Defined in FlexTask.Types

type Rep FlexInst = D1 ('MetaData "FlexInst" "FlexTask.Types" "flex-tasks-0.1-HaEmewq37flGDHHEiCRPd3" 'False) (C1 ('MetaCons "FlexInst" 'PrefixI 'True) ((S1 ('MetaSel ('Just "form") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ([[Text]], HtmlDict)) :*: S1 ('MetaSel ('Just "taskData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :*: (S1 ('MetaSel ('Just "commonModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommonModules) :*: S1 ('MetaSel ('Just "checkModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

data FlexConf Source #

Configuration to use for random generation of concrete FlexInst. taskDataModule is interpreted upon generating an instance to produce static form data. The other Haskell modules are propagated to the generated task instance.

Constructors

FlexConf
Fields taskDataModule :: String Module for generating the form, as well as `CheckModule`. commonModules :: CommonModules Modules shared between config and instance.

Instances

Instances details

Generic FlexConf Source #

Instance details

Defined in FlexTask.Types

Associated Types

type Rep FlexConf

Instance details

Defined in FlexTask.Types

type Rep FlexConf = D1 ('MetaData "FlexConf" "FlexTask.Types" "flex-tasks-0.1-HaEmewq37flGDHHEiCRPd3" 'False) (C1 ('MetaCons "FlexConf" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskDataModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "commonModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommonModules)))

Methods

from :: FlexConf -> Rep FlexConf x #

to :: Rep FlexConf x -> FlexConf #

Show FlexConf Source #

Instance details

Defined in FlexTask.Types

Methods

showsPrec :: Int -> FlexConf -> ShowS #

show :: FlexConf -> String #

showList :: [FlexConf] -> ShowS #

Eq FlexConf Source #

Instance details

Defined in FlexTask.Types

Methods

(==) :: FlexConf -> FlexConf -> Bool #

(/=) :: FlexConf -> FlexConf -> Bool #

Ord FlexConf Source #

Instance details

Defined in FlexTask.Types

Methods

compare :: FlexConf -> FlexConf -> Ordering #

(<) :: FlexConf -> FlexConf -> Bool #

(<=) :: FlexConf -> FlexConf -> Bool #

(>) :: FlexConf -> FlexConf -> Bool #

(>=) :: FlexConf -> FlexConf -> Bool #

max :: FlexConf -> FlexConf -> FlexConf #

min :: FlexConf -> FlexConf -> FlexConf #

type Rep FlexConf Source #

Instance details

Defined in FlexTask.Types

type Rep FlexConf = D1 ('MetaData "FlexConf" "FlexTask.Types" "flex-tasks-0.1-HaEmewq37flGDHHEiCRPd3" 'False) (C1 ('MetaCons "FlexConf" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskDataModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "commonModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommonModules)))

delimiter :: String Source #

Visual module separator for configuration display.

parseFlexConfig :: Parser FlexConf Source #

Parser for FlexTask configurations. Reads five or more code modules each separated by at least three equals signs (=).

Modules starting from the sixth will be added to extraModules.

showFlexConfig :: FlexConf -> String Source #

Convert a configuration into a String. The modules are separated by lines of at least three consecutive equals signs (=). e.g.

Module1 where
...

====================

Module2 where
...

validateFlexConfig :: forall (m :: Type -> Type). OutputCapable m => FlexConf -> LangM m Source #

Check a configuration for inconsistencies