Language.Fortran.Model.Translate

Provides translation from a subset of the dynamically typed Fortran syntax (Language.Fortran.AST) to the strongly typed expression language (Language.Fortran.Model).

Types

Fortran Expressions

type FortranExpr = HFree CoreOp FortranVar

The type of strongly-typed Fortran expressions.

Existentials

data Some f where

An existential type containing f a for some type a.

Constructors

Some :: f a -> Some f

Instances

Pretty1 f => Show (Some f)

Defined in Camfort.Helpers.TypeLevel

Methods

showsPrec :: Int -> Some f -> ShowS

show :: Some f -> String

showList :: [Some f] -> ShowS

Pretty1 f => Pretty (Some f)

Defined in Camfort.Helpers.TypeLevel

Methods

pretty :: Some f -> String

prettysPrec :: Int -> Some f -> ShowS

type SomeVar = Some FortranVar

A Fortran variable with an existential type.

type SomeExpr = Some (PairOf D FortranExpr)

A Fortran expression with an existential type.

type SomeType = Some D

An existential Fortran type.

Semantics

newtype KindSelector

A function mapping numeric kind annotations from Fortran programs to actual precision, for a particular basic type bt.

Constructors

KindSelector

Fields

• selectKind :: Integer -> Maybe Precision

data FortranSemantics

A (currently very incomplete) specification of the semantics of a particular version of Fortran, needed when translating.

Constructors

FortranSemantics

Fields

• _fsIntegerKinds :: KindSelector
• _fsRealKinds :: KindSelector
• _fsCharacterKinds :: KindSelector
• _fsLogicalKinds :: KindSelector
• _fsDoublePrecisionKinds :: Maybe KindSelector

defaultSemantics :: FortranSemantics

Kinds

The default semantics has sensible defaults for kind 0 (unspecified). Otherwise, the kind is the number of bytes used for the type's representation. Only power-of-two values up to 8 are valid. Characters only allow single byte precision. Reals only allow 4- or 8-byte precision.

Translation Monad

Environment

data TranslateEnv

In order to translate Fortran expressions, we require some information about the environment. That information is capture in this record.

Constructors

TranslateEnv

Fields

• _teImplicitVars :: Bool

  Are implicit variable types enabled? (TODO: this currently does nothing)

• _teVarsInScope :: Map UniqueName SomeVar

  A map of the variables in scope, including their types

• _teSemantics :: FortranSemantics

  The version of Fortran's semantics to use when translating code.

Instances

Monad m => MonadReader TranslateEnv (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

ask :: TranslateT m TranslateEnv

local :: (TranslateEnv -> TranslateEnv) -> TranslateT m a -> TranslateT m a

reader :: (TranslateEnv -> a) -> TranslateT m a

defaultTranslateEnv :: TranslateEnv

Errors

data TranslateError

Constructors

ErrUnsupportedItem Text

Tried to translate a part of the language that is not (yet) supported.

ErrBadLiteral

Found a literal value that we didn't know how to translate. May or may not be valid Fortran.

ErrUnexpectedType Text SomeType SomeType

ErrUnexpectedType message expected actual: tried to translate a Fortran language part into the wrong expression type, and it wasn't coercible to the correct type.

ErrInvalidOpApplication (Some (Rec D))

Tried to apply an operator to arguments with the wrong types.

ErrVarNotInScope Name

Reference to a variable that's not currently in scope

ErrInvalidKind Text Integer

ErrInvalidKind baseTypeName givenKind: tried to interpret a type with the given kind which is not valid under the semantics.

Instances

Describe TranslateError

Defined in Language.Fortran.Model.Translate

Methods

describe :: TranslateError -> Text

describeBuilder :: TranslateError -> Builder

Monad m => MonadError TranslateError (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

throwError :: TranslateError -> TranslateT m a

catchError :: TranslateT m a -> (TranslateError -> TranslateT m a) -> TranslateT m a

Monad

newtype TranslateT m a

Constructors

TranslateT

Fields

• getTranslateT :: ReaderT TranslateEnv (ExceptT TranslateError m) a

Instances

MonadLogger e w m => MonadLogger e w (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

setDefaultSourceFile :: FilePath -> TranslateT m ()

getDefaultSourceFile :: TranslateT m FilePath

recordLogMessage :: SomeMessage e w -> TranslateT m ()

logError :: Origin -> e -> TranslateT m ()

logError' :: Spanned a => a -> e -> TranslateT m ()

logWarn :: Origin -> w -> TranslateT m ()

logWarn' :: Spanned a => a -> w -> TranslateT m ()

logInfo :: Origin -> Text -> TranslateT m ()

logInfo' :: Spanned a => a -> Text -> TranslateT m ()

logInfoNoOrigin :: Text -> TranslateT m ()

logDebug :: Origin -> Text -> TranslateT m ()

logDebug' :: Spanned a => a -> Text -> TranslateT m ()

Monad m => MonadReader TranslateEnv (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

ask :: TranslateT m TranslateEnv

local :: (TranslateEnv -> TranslateEnv) -> TranslateT m a -> TranslateT m a

reader :: (TranslateEnv -> a) -> TranslateT m a

Monad m => MonadError TranslateError (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

throwError :: TranslateError -> TranslateT m a

catchError :: TranslateT m a -> (TranslateError -> TranslateT m a) -> TranslateT m a

Monad m => Monad (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

(>>=) :: TranslateT m a -> (a -> TranslateT m b) -> TranslateT m b

(>>) :: TranslateT m a -> TranslateT m b -> TranslateT m b

return :: a -> TranslateT m a

Functor m => Functor (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

fmap :: (a -> b) -> TranslateT m a -> TranslateT m b

(<$) :: a -> TranslateT m b -> TranslateT m a

MonadFail m => MonadFail (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

fail :: String -> TranslateT m a

Monad m => Applicative (TranslateT m)

Defined in Language.Fortran.Model.Translate

Methods

pure :: a -> TranslateT m a

(<*>) :: TranslateT m (a -> b) -> TranslateT m a -> TranslateT m b

liftA2 :: (a -> b -> c) -> TranslateT m a -> TranslateT m b -> TranslateT m c

(*>) :: TranslateT m a -> TranslateT m b -> TranslateT m b

(<*) :: TranslateT m a -> TranslateT m b -> TranslateT m a

runTranslateT :: (Monad m, MonadFail m) => TranslateT m a -> TranslateEnv -> m (Either TranslateError a)

Translating Expressions

translateExpression :: (Monad m, MonadFail m) => Expression (Analysis ann) -> TranslateT m SomeExpr

Translate an expression with an unknown type. The return value existentially captures the type of the result.

translateExpression' :: (Monad m, MonadFail m) => D a -> Expression (Analysis ann) -> TranslateT m (FortranExpr a)

Translate an expression with a known type. Fails if the actual type does not match.

translateCoerceExpression :: (Monad m, MonadFail m) => D a -> Expression (Analysis ann) -> TranslateT m (HFree MetaOp FortranExpr a)

Translate an expression and try to coerce it to a particular type. Fails if the actual type cannot be coerced to the given type.

Translating Types

TypeInfo

data TypeInfo ann

The different ways of specifying Fortran types are complicated. This record contains information about all the different things that might contribute to a type.

Instances

Functor TypeInfo

Defined in Language.Fortran.Model.Translate

Methods

fmap :: (a -> b) -> TypeInfo a -> TypeInfo b

(<$) :: a -> TypeInfo b -> TypeInfo a

Show ann => Show (TypeInfo ann)

Defined in Language.Fortran.Model.Translate

Methods

showsPrec :: Int -> TypeInfo ann -> ShowS

show :: TypeInfo ann -> String

showList :: [TypeInfo ann] -> ShowS

Spanned (TypeInfo ann)

Defined in Language.Fortran.Model.Translate

Methods

getSpan :: TypeInfo ann -> SrcSpan

setSpan :: SrcSpan -> TypeInfo ann -> TypeInfo ann

typeInfo :: TypeSpec ann -> TypeInfo ann

Create a simple TypeInfo from an TypeSpec. Many use cases will need to add more information to fully specify the type.

Translation

translateTypeInfo :: (Monad m, MonadFail m, Show ann) => TypeInfo ann -> TranslateT m SomeType

Convert a TypeInfo to its corresponding strong type.

Lenses

FortranSemantics

fsIntegerKinds :: Lens' FortranSemantics KindSelector

fsRealKinds :: Lens' FortranSemantics KindSelector

fsLogicalKinds :: Lens' FortranSemantics KindSelector

fsCharacterKinds :: Lens' FortranSemantics KindSelector

fsDoublePrecisionKinds :: Lens' FortranSemantics (Maybe KindSelector)

TranslateEnv

teVarsInScope :: Lens' TranslateEnv (Map UniqueName SomeVar)

teImplicitVars :: Lens' TranslateEnv Bool

teSemantics :: Lens' TranslateEnv FortranSemantics

TypeInfo

tiSrcSpan :: forall ann. Lens' (TypeInfo ann) SrcSpan

tiBaseType :: forall ann. Lens' (TypeInfo ann) BaseType

tiSelectorLength :: forall ann. Lens' (TypeInfo ann) (Maybe (Expression ann))

tiSelectorKind :: forall ann. Lens' (TypeInfo ann) (Maybe (Expression ann))

tiDeclaratorLength :: forall ann. Lens' (TypeInfo ann) (Maybe (Expression ann))

tiDimensionDeclarators :: forall ann. Lens' (TypeInfo ann) (Maybe (AList DimensionDeclarator ann))

tiAttributes :: forall ann. Lens' (TypeInfo ann) (Maybe (AList Attribute ann))