yi-0.6.2.3: The Haskell-Scriptable Editor Source code Contents Index

Yi.Tag

Description

A module for CTags integration

Synopsis

lookupTag :: Tag -> TagTable -> Maybe (FilePath, Int) importTagTable :: FilePath -> IO TagTable hintTags :: TagTable -> String -> [String] completeTag :: TagTable -> String -> String type Tag = String data TagTable = TagTable { tagFileName :: FilePath tagBaseDir :: FilePath tagFileMap :: Map Tag (FilePath, Int) tagTrie :: Trie } getTags :: EditorM (Maybe TagTable) setTags :: TagTable -> EditorM () resetTags :: EditorM () getTagsFileList :: EditorM [FilePath] setTagsFileList :: String -> EditorM ()

Documentation

lookupTag :: Tag -> TagTable -> Maybe (FilePath, Int) Source

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

importTagTable :: FilePath -> IO TagTable Source

Read in a tag file from the system

hintTags :: TagTable -> String -> [String] Source

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

completeTag :: TagTable -> String -> String Source

Extends the string to the longest certain length

type Tag = String Source

data TagTable Source

Constructors TagTable 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 tagTrie :: Trie trie to speed up tag hinting Instances Typeable TagTable

getTags :: EditorM (Maybe TagTable) Source

Get the currently registered tag table

setTags :: TagTable -> EditorM () Source

Set a new TagTable

resetTags :: EditorM () Source

Reset the TagTable

getTagsFileList :: EditorM [FilePath] Source

setTagsFileList :: String -> EditorM () Source

Produced by Haddock version 2.6.1