Safe Haskell	None
Language	Haskell2010

Language.ClaferT

Description

This is in a separate module from the module Language.Clafer so that other modules that require ClaferEnv can just import this module without all the parsingcompilinegenerating functionality.

Synopsis

Documentation

data ClaferEnv Source

Constructors

ClaferEnv
Fields args :: ClaferArgs modelFrags :: [String] cAst :: Maybe Module cIr :: Maybe (IModule, GEnv, Bool) frags :: [Pos] astModuleTrace :: Map Span [Ast] otherTokens :: [Token]

Instances

Show ClaferEnv Source

irModuleTrace :: ClaferEnv -> Map Span [Ir] Source

This simulates a field in the ClaferEnv that will always recompute the map, since the IR always changes and the map becomes obsolete

uidIClaferMap :: ClaferEnv -> UIDIClaferMap Source

This simulates a field in the ClaferEnv that will always recompute the map, since the IR always changes and the map becomes obsolete maps from a UID to an IClafer with the given UID

makeEnv :: ClaferArgs -> ClaferEnv Source

getAst :: Monad m => ClaferT m Module Source

getIr :: Monad m => ClaferT m (IModule, GEnv, Bool) Source

type ClaferM = ClaferT Identity Source

Monad for using Clafer.

type ClaferT m = ExceptT ClaferErrs (StateT ClaferEnv m) Source

Monad Transformer for using Clafer.

data CErr p Source

Possible errors that can occur when using Clafer | Generate errors using throwErr/throwErrs:

Constructors

ClaferErr	Generic error
Fields msg :: String
ParseErr	Error generated by the parser
Fields pos :: p Position of the error msg :: String
SemanticErr	Error generated by semantic analysis
Fields pos :: p Position of the error msg :: String

Instances

Show p => Show (CErr p) Source
ClaferErrPos p => Throwable (CErr p) Source

data CErrs p Source

Clafer keeps track of multiple errors.

Constructors

ClaferErrs
Fields errs :: [CErr p]

Instances

Show p => Show (CErrs p) Source

type ClaferErr = CErr ErrPos Source

type ClaferErrs = CErrs ErrPos Source

type ClaferSErr = CErr Span Source

type ClaferSErrs = CErrs Span Source

data ErrPos Source

Constructors

ErrPos
Fields fragId :: Int The fragment where the error occurred. fragPos :: Pos Error positions are relative to their fragments. \| For example an error at (Pos 2 3) means line 2 column 3 of the fragment, not the entire model. modelPos :: Pos The error position relative to the model.

Instances

Show ErrPos Source

data PartialErrPos Source

The full ErrPos requires lots of information that needs to be consistent. Every time we throw an error, | we need BOTH the (fragId, fragPos) AND modelPos. This makes it easier for developers using ClaferT so they | only need to provide part of the information and the rest is automatically calculated. The code using | ClaferT is more concise and less error-prone. | | modelPos <- modelPosFromFragPos fragdId fragPos | throwErr $ ParserErr (ErrPos fragId fragPos modelPos) | | vs | | throwErr $ ParseErr (ErrFragPos fragId fragPos) | | Hopefully making the error handling easier will make it more universal.

Constructors

ErrFragPos	Position relative to the start of the fragment. Will calculate model position automatically. \| fragId starts at 0 \| The position is relative to the start of the fragment.
Fields pFragId :: Int pFragPos :: Pos
ErrFragSpan
Fields pFragId :: Int pFragSpan :: Span
ErrModelPos	Position relative to the start of the complete model. Will calculate fragId and fragPos automatically. \| The position is relative to the entire complete model.
Fields pModelPos :: Pos
ErrModelSpan
Fields pModelSpan :: Span