Yi.Tag

A module for CTags integration. Note that this reads the ‘tags’ file produced by hasktags, not the ‘TAGS’ file which uses a different format (etags).

Documentation

lookupTag :: Tag -> TagTable -> [(FilePath, Int)]

Find the location of a tag using the tag table. Returns a full path and line number

importTagTable :: FilePath -> IO TagTable

Read in a tag file from the system

hintTags :: TagTable -> Text -> [Text]

Gives all the possible expanded tags that could match a given prefix

completeTag :: TagTable -> Text -> Text

Extends the string to the longest certain length

newtype Tag

Constructors

Tag

Fields

• _unTag :: Text

Instances

Eq Tag

Methods

(==) :: Tag -> Tag -> Bool

(/=) :: Tag -> Tag -> Bool

Ord Tag

Methods

compare :: Tag -> Tag -> Ordering

(<) :: Tag -> Tag -> Bool

(<=) :: Tag -> Tag -> Bool

(>) :: Tag -> Tag -> Bool

(>=) :: Tag -> Tag -> Bool

max :: Tag -> Tag -> Tag

min :: Tag -> Tag -> Tag

Show Tag

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

Binary Tag

Methods

put :: Tag -> Put

get :: Get Tag

putList :: [Tag] -> Put

unTag' :: Tag -> Text

data TagTable

Constructors

TagTable

Fields

• tagFileName :: FilePath

  local name of the tag file TODO: reload if this file is changed

• tagBaseDir :: FilePath

  path to the tag file directory tags are relative to this path

• tagFileMap :: Map Tag [(FilePath, Int)]

  map from tags to files

• tagCompletionTree :: CompletionTree Text

  trie to speed up tag hinting

Instances

Generic TagTable

Associated Types

type Rep TagTable :: * -> *

Methods

from :: TagTable -> Rep TagTable x

to :: Rep TagTable x -> TagTable

Binary TagTable

Methods

put :: TagTable -> Put

get :: Get TagTable

putList :: [TagTable] -> Put

type Rep TagTable

type Rep TagTable = D1 (MetaData "TagTable" "Yi.Tag" "yi-core-0.14.1-9lgXhugm03NJMcLAsQSRZp" False) (C1 (MetaCons "TagTable" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "tagFileName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) (S1 (MetaSel (Just Symbol "tagBaseDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))) ((:*:) (S1 (MetaSel (Just Symbol "tagFileMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Tag [(FilePath, Int)]))) (S1 (MetaSel (Just Symbol "tagCompletionTree") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (CompletionTree Text))))))

getTags :: EditorM (Maybe TagTable)

Get the currently registered tag table

setTags :: TagTable -> EditorM ()

Set a new TagTable

resetTags :: EditorM ()

Reset the TagTable

tagsFileList :: Field [FilePath]

readCTags :: Text -> Map Tag [(FilePath, Int)]

Super simple parsing CTag format 1 parsing algorithm TODO: support search patterns in addition to lineno