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 :: !FastString

  tag's name

• gtKind :: !GhcTagKind

  tag's kind

• gtIsExported :: !Bool

  True iff the term is exported

• gtFFI :: !(Maybe Text)

  ffi import

type GhcTags = [GhcTag]

data GhcTagKind

Kind of the term.

Constructors

GtkTerm

GtkFunction

GtkTypeConstructor (Maybe (HsKind GhcPs))

GtkDataConstructor

H98 data construtor

Fields

• (Located RdrName)

  type name

• [HsType GhcPs]

  fields type

GtkGADTConstructor (HsType GhcPs)

GADT constructor with its type

GtkRecordField

GtkTypeSynonym (HsType GhcPs)

GtkTypeSignature (HsWildCardBndrs GhcPs (LHsSigType GhcPs))

GtkPatternSynonym

GtkTypeClass

GtkTypeClassMember

GtkTypeClassInstance (HsType GhcPs)

GtkTypeFamily (Maybe (HsKind GhcPs))

GtkTypeFamilyInstance

GtkDataTypeFamily (Maybe (HsKind GhcPs))

GtkDataTypeFamilyInstance

GtkForeignImport

GtkForeignExport

getGhcTags :: Located (HsModule GhcPs) -> GhcTags

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

Supported identifiers:

• top level terms
• data types
• record fields
• type synonyms
• type classes
• type class members
• type class instances
• type families
• type family instances
• data type families
• data type families instances
• data type family instances constructors