DDC.Build.Interface.Store

Documentation

data Store

Abstract API to a collection of module interfaces.

This lives in IO land because in future we want to demand-load the inferface files as needed, rather than loading the full dependency tree. Keeping it in IO means that callers must also be in IO.

new :: IO Store

An empty interface store.

wrap :: Store -> InterfaceAA -> IO ()

Add a pre-loaded interface file to the store.

load :: FilePath -> IO (Either Error InterfaceAA)

Load a new interface from a file.

data Meta

Metadata for interfaces currently loaded into the store.

Constructors

Meta

Fields

• metaFilePath :: FilePath
• metaTimeStamp :: UTCTime
• metaModuleName :: ModuleName

Instances

Show Meta

Methods

showsPrec :: Int -> Meta -> ShowS

show :: Meta -> String

showList :: [Meta] -> ShowS

Pretty Meta

Associated Types

data PrettyMode Meta :: *

Methods

pprDefaultMode :: PrettyMode Meta

ppr :: Meta -> Doc

pprPrec :: Int -> Meta -> Doc

pprModePrec :: PrettyMode Meta -> Int -> Meta -> Doc

getMeta :: Store -> IO [Meta]

Get metadata of interfaces currently in the store.

getModuleNames :: Store -> IO [ModuleName]

Get names of the modules currently in the store.

getInterfaces :: Store -> IO [InterfaceAA]

Get the fully loaded interfaces.

data Super

Interface for some top-level super.

Constructors

Super

Fields

• superName :: Name

  Name of the super.

• superModuleName :: ModuleName

  Where the super was imported from.

  This is the module that the name was resolved from. If that module re-exported an imported name then this may not be the module the super was actually defined in.

• superTetraType :: Type Name

  Tetra type for the super.

• superSaltType :: Type Name

  Salt type for the super.

• superImportValue :: ImportValue Name (Type Name)

  Import source for the super.

  This can be used to refer to the super from a client module.

findSuper

Arguments

:: Store

-> Name

Name of desired super.

-> [ModuleName]

Names of modules to search.

-> IO [Super]

See if a super is defined in any of the given modules, and if so return the module name and super type.

NOTE: This function returns an IO [Super] in preparation for the case where we load data from interface files on demand. We want to ensure that the caller is also in IO, to make the refactoring easier later.