Safe Haskell	None
Language	Haskell2010

Plugin.GhcTags.Generate

Description

Interface for generating tags for a parsed module.

Synopsis

data GhcTag = GhcTag {
- gtSrcSpan :: !SrcSpan
- gtTag :: !FastString
- gtKind :: !GhcKind
- gtFields :: ![TagField]
}
type GhcTags = [GhcTag]
data GhcKind
- = TkTerm
- | TkFunction
- | TkTypeConstructor
- | TkDataConstructor
- | TkGADTConstructor
- | TkRecordField
- | TkTypeSynonym
- | TkTypeSignature
- | TkPatternSynonym
- | TkTypeClass
- | TkTypeClassMember
- | TkTypeClassInstance
- | TkTypeFamily
- | TkTypeFamilyInstance
- | TkDataTypeFamily
- | TkDataTypeFamilyInstance
- | TkForeignImport
- | TkForeignExport
data TagField = TagField {
- fieldName :: Text
- fieldValue :: Text
}
ghcKindToChar :: GhcKind -> Char
charToGhcKind :: Char -> Maybe GhcKind
getGhcTags :: Located (HsModule GhcPs) -> GhcTags

Documentation

data GhcTag Source #

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

Constructors

GhcTag
Fields gtSrcSpan :: !SrcSpan gtTag :: !FastString gtKind :: !GhcKind gtFields :: ![TagField]

Instances

Show GhcTag Source #
Instance details Defined in Plugin.GhcTags.Generate Methods showsPrec :: Int -> GhcTag -> ShowS # show :: GhcTag -> String # showList :: [GhcTag] -> ShowS #

type GhcTags = [GhcTag] Source #

data GhcKind Source #

ctags can generate tags kinds, so do we.

Constructors

TkTerm
TkFunction
TkTypeConstructor
TkDataConstructor
TkGADTConstructor
TkRecordField
TkTypeSynonym
TkTypeSignature
TkPatternSynonym
TkTypeClass
TkTypeClassMember
TkTypeClassInstance
TkTypeFamily
TkTypeFamilyInstance
TkDataTypeFamily
TkDataTypeFamilyInstance
TkForeignImport
TkForeignExport

Instances

Eq GhcKind Source #
Instance details Defined in Plugin.GhcTags.Generate Methods (==) :: GhcKind -> GhcKind -> Bool # (/=) :: GhcKind -> GhcKind -> Bool #
Ord GhcKind Source #
Instance details Defined in Plugin.GhcTags.Generate Methods compare :: GhcKind -> GhcKind -> Ordering # (<) :: GhcKind -> GhcKind -> Bool # (<=) :: GhcKind -> GhcKind -> Bool # (>) :: GhcKind -> GhcKind -> Bool # (>=) :: GhcKind -> GhcKind -> Bool # max :: GhcKind -> GhcKind -> GhcKind # min :: GhcKind -> GhcKind -> GhcKind #
Show GhcKind Source #
Instance details Defined in Plugin.GhcTags.Generate Methods showsPrec :: Int -> GhcKind -> ShowS # show :: GhcKind -> String # showList :: [GhcKind] -> ShowS #

data TagField Source #

Unit of data associated with a tag. Vim natively supports `file:` and `kind:` tags but it can display any other tags too.

Constructors

TagField
Fields fieldName :: Text fieldValue :: Text

Instances

Eq TagField Source #
Instance details Defined in Plugin.GhcTags.Generate Methods (==) :: TagField -> TagField -> Bool # (/=) :: TagField -> TagField -> Bool #
Ord TagField Source #
Instance details Defined in Plugin.GhcTags.Generate Methods compare :: TagField -> TagField -> Ordering # (<) :: TagField -> TagField -> Bool # (<=) :: TagField -> TagField -> Bool # (>) :: TagField -> TagField -> Bool # (>=) :: TagField -> TagField -> Bool # max :: TagField -> TagField -> TagField # min :: TagField -> TagField -> TagField #
Show TagField Source #
Instance details Defined in Plugin.GhcTags.Generate Methods showsPrec :: Int -> TagField -> ShowS # show :: TagField -> String # showList :: [TagField] -> ShowS #

ghcKindToChar :: GhcKind -> Char Source #

charToGhcKind :: Char -> Maybe GhcKind Source #

getGhcTags :: Located (HsModule GhcPs) -> GhcTags Source #

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