    module GHC.Types.IPE (
        DCMap,
        ClosureMap,
        InfoTableProvMap(..),
        emptyInfoTableProvMap,
        IpeSourceLocation
    ) where

    import GHC.Prelude

    import GHC.Types.Name
    import GHC.Data.FastString
    import GHC.Types.SrcLoc
    import GHC.Core.DataCon

    import GHC.Types.Unique.DFM
    import GHC.Core.Type
    import Data.List.NonEmpty
    import GHC.Cmm.CLabel (CLabel)
    import qualified Data.Map.Strict as Map

    -- | Position and information about an info table.
    -- For return frames these are the contents of a 'CoreSyn.SourceNote'.
    type IpeSourceLocation = (RealSrcSpan, LexicalFastString)

    -- | A map from a 'Name' to the best approximate source position that
    -- name arose from.
    type ClosureMap = UniqDFM Name  -- The binding
                              (Name, (Type, Maybe IpeSourceLocation))
                              -- The best approximate source position.
                              -- (rendered type, source position, source note
                              -- label)

    -- | A map storing all the different uses of a specific data constructor and the
    -- approximate source position that usage arose from.
    -- The 'Int' is an incrementing identifier which distinguishes each usage
    -- of a constructor in a module. It is paired with the source position
    -- the constructor was used at, if possible and a string which names
    -- the source location. This is the same information as is the payload
    -- for the 'GHC.Core.SourceNote' constructor.
    type DCMap = UniqDFM DataCon (DataCon, NonEmpty (Int, Maybe IpeSourceLocation))

    type InfoTableToSourceLocationMap = Map.Map CLabel (Maybe IpeSourceLocation)

    data InfoTableProvMap = InfoTableProvMap
                              { InfoTableProvMap -> DCMap
    provDC :: DCMap
                              , InfoTableProvMap -> ClosureMap
    provClosure :: ClosureMap
                              , InfoTableProvMap -> InfoTableToSourceLocationMap
    provInfoTables :: InfoTableToSourceLocationMap
                              }

    emptyInfoTableProvMap :: InfoTableProvMap
    emptyInfoTableProvMap :: InfoTableProvMap
    emptyInfoTableProvMap = DCMap
    -> ClosureMap -> InfoTableToSourceLocationMap -> InfoTableProvMap
    InfoTableProvMap DCMap
    forall {k} (key :: k) elt. UniqDFM key elt
    emptyUDFM ClosureMap
    forall {k} (key :: k) elt. UniqDFM key elt
    emptyUDFM InfoTableToSourceLocationMap
    forall k a. Map k a
    Map.empty