Safe Haskell	None
Language	Haskell2010

HieDb.Types

Contents

Orphan instances

Synopsis

newtype HieDb = HieDb {
- getConn :: Connection
}
data HieDbException = IncompatibleSchemaVersion {
- expectedVersion :: Integer
- gotVersion :: Integer
}
setHieTrace :: HieDb -> Maybe (Text -> IO ()) -> IO ()
data SourceFile
- = RealFile FilePath
- | FakeFile (Maybe FilePath)
data ModuleInfo = ModuleInfo {
- modInfoName :: ModuleName
- modInfoUnit :: UnitId
- modInfoIsBoot :: Bool
- modInfoSrcFile :: Maybe FilePath
- modInfoIsReal :: Bool
- modInfoHash :: Fingerprint
}
type Res a = a :. ModuleInfo
toNsChar :: NameSpace -> Char
fromNsChar :: Char -> Maybe NameSpace
data HieModuleRow = HieModuleRow {
- hieModuleHieFile :: FilePath
- hieModInfo :: ModuleInfo
}
data RefRow = RefRow {
- refSrc :: FilePath
- refNameOcc :: OccName
- refNameMod :: ModuleName
- refNameUnit :: UnitId
- refSLine :: Int
- refSCol :: Int
- refELine :: Int
- refECol :: Int
}
data DeclRow = DeclRow {
- declSrc :: FilePath
- declNameOcc :: OccName
- declSLine :: Int
- declSCol :: Int
- declELine :: Int
- declECol :: Int
- declRoot :: Bool
}
data TypeName = TypeName {
- typeName :: OccName
- typeMod :: ModuleName
- typeUnit :: UnitId
}
data TypeRef = TypeRef {
- typeRefOccId :: Int64
- typeRefHieFile :: FilePath
- typeRefDepth :: Int
- typeRefSLine :: Int
- typeRefSCol :: Int
- typeRefELine :: Int
- typeRefECol :: Int
}
data DefRow = DefRow {
- defSrc :: FilePath
- defNameOcc :: OccName
- defSLine :: Int
- defSCol :: Int
- defELine :: Int
- defECol :: Int
}
class Monad m => NameCacheMonad m where
- getNcUpdater :: m NameCacheUpdater
newtype DbMonadT m a = DbMonadT {
- runDbMonad :: ReaderT (IORef NameCache) m a
}
type DbMonad = DbMonadT IO
runDbM :: IORef NameCache -> DbMonad a -> IO a
data HieDbErr
- = NotIndexed ModuleName (Maybe UnitId)
- | AmbiguousUnitId (NonEmpty ModuleInfo)
- | NameNotFound OccName (Maybe ModuleName) (Maybe UnitId)
- | NoNameAtPoint HieTarget (Int, Int)
- | NameUnhelpfulSpan Name String
data Symbol = Symbol {
- symName :: !OccName
- symModule :: !Module
}
readNameSpace :: ReadP NameSpace
readColon :: ReadP ()
readSymbol :: ReadP Symbol
newtype LibDir = LibDir FilePath
type HieTarget = Either FilePath (ModuleName, Maybe UnitId)

Documentation

newtype HieDb Source #

Constructors

HieDb
Fields getConn :: Connection

data HieDbException Source #

Constructors

IncompatibleSchemaVersion
Fields expectedVersion :: Integer gotVersion :: Integer

Instances

Instances details

Eq HieDbException Source #
Instance details Defined in HieDb.Types Methods (==) :: HieDbException -> HieDbException -> Bool # (/=) :: HieDbException -> HieDbException -> Bool #
Ord HieDbException Source #
Instance details Defined in HieDb.Types Methods compare :: HieDbException -> HieDbException -> Ordering # (<) :: HieDbException -> HieDbException -> Bool # (<=) :: HieDbException -> HieDbException -> Bool # (>) :: HieDbException -> HieDbException -> Bool # (>=) :: HieDbException -> HieDbException -> Bool # max :: HieDbException -> HieDbException -> HieDbException # min :: HieDbException -> HieDbException -> HieDbException #
Show HieDbException Source #
Instance details Defined in HieDb.Types Methods showsPrec :: Int -> HieDbException -> ShowS # show :: HieDbException -> String # showList :: [HieDbException] -> ShowS #
Exception HieDbException Source #
Instance details Defined in HieDb.Types Methods toException :: HieDbException -> SomeException # fromException :: SomeException -> Maybe HieDbException # displayException :: HieDbException -> String #

setHieTrace :: HieDb -> Maybe (Text -> IO ()) -> IO () Source #

data SourceFile Source #

Encodes the original haskell source file of a module, along with whether it is "real" or not A file is "real" if it comes from the user project, as opposed to a dependency

Constructors

RealFile FilePath
FakeFile (Maybe FilePath)

data ModuleInfo Source #

Constructors

ModuleInfo

Fields

modInfoName :: ModuleName
modInfoUnit :: UnitId
Identifies the package this module is part of
modInfoIsBoot :: Bool
True, when this ModuleInfo was created by indexing .hie-boot file; False when it was created from .hie file
modInfoSrcFile :: Maybe FilePath
The path to the haskell source file, from which the .hie file was created
modInfoIsReal :: Bool
Is this a real source file? I.e. does it come from user's project (as opposed to from project's dependency)?
modInfoHash :: Fingerprint
The hash of the .hie file from which this ModuleInfo was created

Instances

Instances details

Eq ModuleInfo Source #
Instance details Defined in HieDb.Types Methods (==) :: ModuleInfo -> ModuleInfo -> Bool # (/=) :: ModuleInfo -> ModuleInfo -> Bool #
Show ModuleInfo Source #
Instance details Defined in HieDb.Types Methods showsPrec :: Int -> ModuleInfo -> ShowS # show :: ModuleInfo -> String # showList :: [ModuleInfo] -> ShowS #
FromRow ModuleInfo Source #
Instance details Defined in HieDb.Types Methods fromRow :: RowParser ModuleInfo #
ToRow ModuleInfo Source #
Instance details Defined in HieDb.Types Methods toRow :: ModuleInfo -> [SQLData] #

type Res a = a :. ModuleInfo Source #

toNsChar :: NameSpace -> Char Source #

fromNsChar :: Char -> Maybe NameSpace Source #

data HieModuleRow Source #

Constructors

HieModuleRow
Fields hieModuleHieFile :: FilePath Full path to `.hie` file based on which this row was created hieModInfo :: ModuleInfo

Instances

Instances details

Eq HieModuleRow Source #
Instance details Defined in HieDb.Types Methods (==) :: HieModuleRow -> HieModuleRow -> Bool # (/=) :: HieModuleRow -> HieModuleRow -> Bool #
Show HieModuleRow Source #
Instance details Defined in HieDb.Types Methods showsPrec :: Int -> HieModuleRow -> ShowS # show :: HieModuleRow -> String # showList :: [HieModuleRow] -> ShowS #
FromRow HieModuleRow Source #
Instance details Defined in HieDb.Types Methods fromRow :: RowParser HieModuleRow #
ToRow HieModuleRow Source #
Instance details Defined in HieDb.Types Methods toRow :: HieModuleRow -> [SQLData] #

data RefRow Source #

Constructors

RefRow
Fields refSrc :: FilePath refNameOcc :: OccName refNameMod :: ModuleName refNameUnit :: UnitId refSLine :: Int refSCol :: Int refELine :: Int refECol :: Int

Instances

Instances details

FromRow RefRow Source #
Instance details Defined in HieDb.Types Methods fromRow :: RowParser RefRow #
ToRow RefRow Source #
Instance details Defined in HieDb.Types Methods toRow :: RefRow -> [SQLData] #

data DeclRow Source #

Constructors

DeclRow
Fields declSrc :: FilePath declNameOcc :: OccName declSLine :: Int declSCol :: Int declELine :: Int declECol :: Int declRoot :: Bool

Instances

Instances details

FromRow DeclRow Source #
Instance details Defined in HieDb.Types Methods fromRow :: RowParser DeclRow #
ToRow DeclRow Source #
Instance details Defined in HieDb.Types Methods toRow :: DeclRow -> [SQLData] #

data TypeName Source #

Constructors

TypeName
Fields typeName :: OccName typeMod :: ModuleName typeUnit :: UnitId

data TypeRef Source #

Constructors

TypeRef
Fields typeRefOccId :: Int64 typeRefHieFile :: FilePath typeRefDepth :: Int typeRefSLine :: Int typeRefSCol :: Int typeRefELine :: Int typeRefECol :: Int

Instances

Instances details

FromRow TypeRef Source #
Instance details Defined in HieDb.Types Methods fromRow :: RowParser TypeRef #
ToRow TypeRef Source #
Instance details Defined in HieDb.Types Methods toRow :: TypeRef -> [SQLData] #

data DefRow Source #

Constructors

DefRow
Fields defSrc :: FilePath defNameOcc :: OccName defSLine :: Int defSCol :: Int defELine :: Int defECol :: Int

Instances

Instances details

FromRow DefRow Source #
Instance details Defined in HieDb.Types Methods fromRow :: RowParser DefRow #
ToRow DefRow Source #
Instance details Defined in HieDb.Types Methods toRow :: DefRow -> [SQLData] #

class Monad m => NameCacheMonad m where Source #

Monad with access to NameCacheUpdater, which is needed to deserialize .hie files

Methods

getNcUpdater :: m NameCacheUpdater Source #

Instances

Instances details

MonadIO m => NameCacheMonad (DbMonadT m) Source #
Instance details Defined in HieDb.Types Methods getNcUpdater :: DbMonadT m NameCacheUpdater Source #

newtype DbMonadT m a Source #

Constructors

DbMonadT
Fields runDbMonad :: ReaderT (IORef NameCache) m a

Instances

Instances details

MonadTrans DbMonadT Source #
Instance details Defined in HieDb.Types Methods lift :: Monad m => m a -> DbMonadT m a #
Monad m => Monad (DbMonadT m) Source #
Instance details Defined in HieDb.Types Methods (>>=) :: DbMonadT m a -> (a -> DbMonadT m b) -> DbMonadT m b # (>>) :: DbMonadT m a -> DbMonadT m b -> DbMonadT m b # return :: a -> DbMonadT m a #
Monad m => Functor (DbMonadT m) Source #
Instance details Defined in HieDb.Types Methods fmap :: (a -> b) -> DbMonadT m a -> DbMonadT m b # (<$) :: a -> DbMonadT m b -> DbMonadT m a #
Monad m => Applicative (DbMonadT m) Source #
Instance details Defined in HieDb.Types Methods pure :: a -> DbMonadT m a # (<>) :: DbMonadT m (a -> b) -> DbMonadT m a -> DbMonadT m b # liftA2 :: (a -> b -> c) -> DbMonadT m a -> DbMonadT m b -> DbMonadT m c # (>) :: DbMonadT m a -> DbMonadT m b -> DbMonadT m b # (<*) :: DbMonadT m a -> DbMonadT m b -> DbMonadT m a #
MonadIO m => MonadIO (DbMonadT m) Source #
Instance details Defined in HieDb.Types Methods liftIO :: IO a -> DbMonadT m a #
MonadIO m => NameCacheMonad (DbMonadT m) Source #
Instance details Defined in HieDb.Types Methods getNcUpdater :: DbMonadT m NameCacheUpdater Source #

type DbMonad = DbMonadT IO Source #

runDbM :: IORef NameCache -> DbMonad a -> IO a Source #

data HieDbErr Source #

Constructors

NotIndexed ModuleName (Maybe UnitId)
AmbiguousUnitId (NonEmpty ModuleInfo)
NameNotFound OccName (Maybe ModuleName) (Maybe UnitId)
NoNameAtPoint HieTarget (Int, Int)
NameUnhelpfulSpan Name String

data Symbol Source #

Constructors

Symbol
Fields symName :: !OccName symModule :: !Module

Instances

Instances details

Eq Symbol Source #
Instance details Defined in HieDb.Types Methods (==) :: Symbol -> Symbol -> Bool # (/=) :: Symbol -> Symbol -> Bool #
Ord Symbol Source #
Instance details Defined in HieDb.Types Methods compare :: Symbol -> Symbol -> Ordering # (<) :: Symbol -> Symbol -> Bool # (<=) :: Symbol -> Symbol -> Bool # (>) :: Symbol -> Symbol -> Bool # (>=) :: Symbol -> Symbol -> Bool # max :: Symbol -> Symbol -> Symbol # min :: Symbol -> Symbol -> Symbol #
Read Symbol Source #
Instance details Defined in HieDb.Types Methods readsPrec :: Int -> ReadS Symbol # readList :: ReadS [Symbol] # readPrec :: ReadPrec Symbol # readListPrec :: ReadPrec [Symbol] #
Show Symbol Source #
Instance details Defined in HieDb.Types Methods showsPrec :: Int -> Symbol -> ShowS # show :: Symbol -> String # showList :: [Symbol] -> ShowS #

readNameSpace :: ReadP NameSpace Source #

readColon :: ReadP () Source #

readSymbol :: ReadP Symbol Source #

newtype LibDir Source #

GHC Library Directory. Typically you'll want to use libdir from ghc-paths

Constructors

LibDir FilePath

type HieTarget = Either FilePath (ModuleName, Maybe UnitId) Source #

A way to specify which HieFile to operate on. Either the path to .hie file is given in the Left Or ModuleName (with optional UnitId) is given in the Right

Orphan instances

FromField Fingerprint Source #
Instance details Methods fromField :: FieldParser Fingerprint #
FromField ModuleName Source #
Instance details Methods fromField :: FieldParser ModuleName #
FromField UnitId Source #
Instance details Methods fromField :: FieldParser UnitId #
FromField OccName Source #
Instance details Methods fromField :: FieldParser OccName #
ToField Fingerprint Source #
Instance details Methods toField :: Fingerprint -> SQLData #
ToField ModuleName Source #
Instance details Methods toField :: ModuleName -> SQLData #
ToField UnitId Source #
Instance details Methods toField :: UnitId -> SQLData #
ToField OccName Source #
Instance details Methods toField :: OccName -> SQLData #