Safe Haskell	None

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] irModuleTrace :: Map Span [Ir] astModuleTrace :: Map Span [Ast]

Instances

Show ClaferEnv

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 = ErrorT 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)
Error (CErr p)
ClaferErrPos p => Throwable (CErr p)

data CErrs p Source

Clafer keeps track of multiple errors.

Constructors

ClaferErrs
Fields errs :: [CErr p]

Instances

Show p => Show (CErrs p)
Error (CErrs p)

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

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

Instances

Show PartialErrPos

throwErrs :: (Monad m, Throwable t) => [t] -> ClaferT m aSource

Throw many errors.

throwErr :: (Monad m, Throwable t) => t -> ClaferT m aSource

Throw one error.

catchErrs :: Monad m => ClaferT m a -> ([ClaferErr] -> ClaferT m a) -> ClaferT m aSource

Catch errors

getEnv :: Monad m => ClaferT m ClaferEnv Source

Get the ClaferEnv

getsEnv :: Monad m => (ClaferEnv -> a) -> ClaferT m aSource

modifyEnv :: Monad m => (ClaferEnv -> ClaferEnv) -> ClaferT m ()Source

Modify the ClaferEnv

putEnv :: Monad m => ClaferEnv -> ClaferT m ()Source

Set the ClaferEnv. Remember to set the env after every change.

runClafer :: ClaferArgs -> ClaferM a -> Either [ClaferErr] aSource

Convenience

runClaferT :: Monad m => ClaferArgs -> ClaferT m a -> m (Either [ClaferErr] a)Source

Uses the ErrorT convention: | Left is for error (a string containing the error message) | Right is for success (with the result)

class Throwable t whereSource

Methods

toErr :: t -> Monad m => ClaferT m ClaferErr Source

Instances

ClaferErrPos p => Throwable (CErr p)

data Span Source

Constructors

Span Pos Pos
PosSpan Span Pos Pos

Instances

Eq Span
Ord Span
Show Span
Print Span

data Pos Source

Constructors

Pos Integer Integer
PosPos Span Integer Integer

Instances

Eq Pos
Ord Pos
Show Pos
Print Pos