Safe Haskell	None
Language	Haskell2010

Plugin.GhcTags.Tag

Contents

Tag

Synopsis

data Tag = Tag {
- tagName :: !TagName
- tagKind :: !TagKind
- tagFile :: !TagFile
- tagAddr :: !(Either Int Text)
- tagFields :: ![TagField]
}
compareTags :: Tag -> Tag -> Ordering
newtype TagName = TagName {
- getTagName :: Text
}
newtype TagFile = TagFile {
- getTagFile :: Text
}
data TagKind
- = GhcKind !GhcKind
- | CharKind !Char
- | NoKind
data GhcKind
- = TkTerm
- | TkFunction
- | TkTypeConstructor
- | TkDataConstructor
- | TkGADTConstructor
- | TkRecordField
- | TkTypeSynonym
- | TkTypeSignature
- | TkPatternSynonym
- | TkTypeClass
- | TkTypeClassMember
- | TkTypeClassInstance
- | TkTypeFamily
- | TkTypeFamilyInstance
- | TkDataTypeFamily
- | TkDataTypeFamilyInstance
- | TkForeignImport
- | TkForeignExport
charToGhcKind :: Char -> Maybe GhcKind
ghcKindToChar :: GhcKind -> Char
data TagField = TagField {
- fieldName :: Text
- fieldValue :: Text
}
ghcTagToTag :: GhcTag -> Maybe Tag
type TagsMap = Map TagFile [Tag]
mkTagsMap :: [Tag] -> TagsMap

Tag

data Tag Source #

Simple Tag record. For the moment on tag name, tag file and line numbers are supported.

TODO: expand to support column numbers and extra information.

Constructors

Tag
Fields tagName :: !TagName tagKind :: !TagKind tagFile :: !TagFile tagAddr :: !(Either Int Text) tagFields :: ![TagField]

Instances

Eq Tag Source #
Instance details Defined in Plugin.GhcTags.Tag Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Show Tag Source #
Instance details Defined in Plugin.GhcTags.Tag Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #

compareTags :: Tag -> Tag -> Ordering Source #

newtype TagName Source #

ByteString which encodes a tag name.

Constructors

TagName
Fields getTagName :: Text

Instances

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

newtype TagFile Source #

ByteString which encodes a tag file.

Constructors

TagFile
Fields getTagFile :: Text

Instances

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

data TagKind Source #

When we parse a tags file we can eithera find no kind or recognize the kind of GhcKind or we store the found character kind. This allows us to preserve information from parsed tags files which were not created by `ghc-tags-plugin'

Constructors

GhcKind !GhcKind
CharKind !Char
NoKind

Instances

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

data GhcKind Source #

ctags can generate tags kind, 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 #

charToGhcKind :: Char -> Maybe GhcKind Source #

ghcKindToChar :: GhcKind -> Char Source #

data TagField Source #

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 #

ghcTagToTag :: GhcTag -> Maybe Tag Source #

type TagsMap = Map TagFile [Tag] Source #

mkTagsMap :: [Tag] -> TagsMap Source #

Map from TagName to list of tags. This will be useful when updating tags. We will just need to merge dictionaries.