GhcTags.Ghc

Generate tags from HsModule GhcPs representation.

Documentation

data GhcTag

We can read names from using fields of type IdP (a type family) which for 'Parsed resolved to RdrName

Constructors

GhcTag

Fields

• gtSrcSpan :: !SrcSpan

  term location

• gtTag :: !ByteString

  utf8 encoded tag's name

• gtKind :: !GhcTagKind

  tag's kind

• gtIsExported :: !Bool

  True iff the term is exported

• gtFFI :: !(Maybe String)

  ffi import

type GhcTags = [GhcTag]

data GhcTagKind

Kind of the term.

Constructors

GtkModule

GtkTerm

GtkFunction

GtkTypeConstructor (Maybe (HsKind GhcPs))

GtkDataConstructor (ConDecl GhcPs)

H98 data constructor

GtkGADTConstructor (ConDecl GhcPs)

GADT constructor with its type

GtkRecordField

GtkTypeSynonym (HsType GhcPs)

GtkTypeSignature (HsWildCardBndrs GhcPs (LHsSigType GhcPs))

GtkTypeKindSignature (LHsSigType GhcPs)

GtkPatternSynonym

GtkTypeClass

GtkTypeClassMember (HsType GhcPs)

GtkTypeClassInstance (HsType GhcPs)

GtkTypeClassInstanceMember (HsType GhcPs)

GtkTypeFamily (Maybe ([GhcPsHsTyVarBndr], Either (HsKind GhcPs) GhcPsHsTyVarBndr))

GtkTypeFamilyInstance (Maybe (TyFamInstDecl GhcPs))

GtkDataTypeFamily (Maybe ([GhcPsHsTyVarBndr], Either (HsKind GhcPs) GhcPsHsTyVarBndr))

GtkDataTypeFamilyInstance (Maybe (HsKind GhcPs))

GtkForeignImport

GtkForeignExport

getGhcTags :: Located GhcPsModule -> GhcTags

Generate tags for a module - simple walk over the syntax tree.

Supported identifiers:

• module name
• top level terms
• local bindings
• data types
• record fields
• type synonyms
• type classes
• type class members
• type class instances
• type class instance members
• type families
• type family instances
• data type families
• data type families instances
• data type family instances constructors

hsDeclsToGhcTags :: Maybe [IE GhcPs] -> [LHsDecl GhcPs] -> GhcTags