Difference between revisions of "Tags"
Jump to navigation
Jump to search
(Swap fast-tags and lushtags) |
|||
| (16 intermediate revisions by 11 users not shown) | |||
| Line 1: | Line 1: | ||
| + | [[Category:Development tools]] |
||
| ⚫ | |||
| + | == Introduction == |
||
| + | |||
| + | "Tags" are a listing of source code definitions in a group of files, together with their precise location, often used by text editors to quickly jump around in a program. For example, they allow you in a editor that supports tags to jump to the definition of a function when you come across a use of that function. <tt>ctags</tt> (for C) was the first tag-generation program. See the [http://en.wikipedia.org/wiki/Ctags wikipedia article] for more information. |
||
There are currently a number of different ways to generate tags with |
There are currently a number of different ways to generate tags with |
||
Haskell. |
Haskell. |
||
| ⚫ | |||
| − | This page should be used to collect information on them, including information on how to use tags with common editors and what benefits they can give you. |
||
| + | |||
| + | Tag files can be produced in a number of different formats supported by different editors. The two most common formats are 'ctags', which is supported by Vim and others, and 'etags', which is supported by Emacs. Note that the default names for the file in ctags format and the file in etags format are 'tags' and 'TAGS' respectively |
||
| + | |||
| ⚫ | |||
| + | |||
| + | === GHC === |
||
| + | * [http://www.haskell.org/ghc GHC] can generate tag files from GHCi. Use either the ':ctags' or ':etags' commands to produce a tags file for the currently loaded modules. |
||
| + | |||
| + | :For example: |
||
| ⚫ | |||
| ⚫ | |||
| + | === Actively developed === |
||
| ⚫ | |||
| + | * [http://hackage.haskell.org/package/fast-tags fast-tags]: Incremental Vim tag generation. Designed to be fast. Uses its own parser. |
||
| + | * [http://hackage.haskell.org/package/hasktags Hasktags]: Can produce either a ctags or etags compatible tag file. Uses its own parser. |
||
| + | * [http://hackage.haskell.org/package/hothasktags hothasktags]: Knows about import lists and qualified imports. Vim tags only. Uses haskell-src-exts for parsing. |
||
| + | === Other === |
||
| − | Chris Ryder and Simon Thompson give a tag generator's source in |
||
| + | * [http://hackage.haskell.org/package/haskdogs haskdogs]: Wrapper script for hasktags. (last update 2013) |
||
| − | [http://www.cs.kent.ac.uk/pubs/2005/2266/content.pdf a paper] |
||
| + | * [http://hackage.haskell.org/package/lushtags lushtags]: Designed to have smooth integration with the [http://majutsushi.github.com/tagbar/ Vim Tagbar] plugin. (last update 2011) |
||
| + | * [http://kingfisher.nfshost.com/sw/gasbag/ gasbag]: Attempts to choose the best available definition for a given tag. Will notice bindings that don't have an accompanying type signature. (last update 2011) |
||
| + | * [http://hackage.haskell.org/package/htags htags]: Haskell 98 only. Uses haskell-src for parsing. (last update 2008) |
||
| + | === GHC development === |
||
| − | Norman Ramsey and Kathleen Fisher's partial hasktags implementation |
||
| + | * Use `[https://ghc.haskell.org/trac/ghc/wiki/Building/StandardTargets make tags]` in the root of the ghc source tree when [https://ghc.haskell.org/trac/ghc/wiki hacking] on GHC itself. |
||
| − | using the GHC API is [http://darcs.haskell.org/ghctags/ in darcs]. |
||
| − | There's also a [http://hackage.haskell.org/trac/ghc/ticket/946 GHC trac task] relating to it. |
||
| + | * Use `[https://ghc.haskell.org/trac/ghc/wiki/Building/StandardTargets make TAGS]` to generate Emacs tags. |
||
| ⚫ | |||
| + | You can also find the source code for a tag generator in Chris Ryder and Simon Thompson [http://www.cs.kent.ac.uk/pubs/2005/2266/content.pdf paper] on porting the Haskell Refactoring tool, HaRe, to the GHC API. |
||
| ⚫ | |||
| + | == More Information == |
||
| − | utils/hasktags from GHC. |
||
| + | === Vim === |
||
| − | = Random other bits = |
||
| + | * [http://vimdoc.sourceforge.net/htmldoc/usr_29.html#29.1 Using tags in Vim] |
||
| + | * [http://vimdoc.sourceforge.net/htmldoc/tagsrch.html#tags :help tags] |
||
| + | * [http://vimdoc.sourceforge.net/htmldoc/insert.html#ins-completion insert-mode tag completion] (ctrl-x ctrl-]) |
||
| + | *[http://vimdoc.sourceforge.net/htmldoc/windows.html#CursorHold-example :help cursorhold-example] |
||
| ⚫ | |||
| + | * [http://majutsushi.github.com/tagbar/ Another plugin]; newer's not always better, but this is still actively maintained as of 2012 |
||
| + | === Others === |
||
| ⚫ | |||
| + | * [http://www.nedit.org/help/tags.php#Finding_Declarations_(ctags) NEdit documentation for using tags] |
||
| − | <pre> |
||
| + | * Chapter 14 of the BBEdit manual covers using tags |
||
| − | vim |
||
| − | :help tags-file-format |
||
| − | :help cursorhold-example |
||
| − | </pre> |
||
Latest revision as of 05:13, 30 January 2016
Introduction
"Tags" are a listing of source code definitions in a group of files, together with their precise location, often used by text editors to quickly jump around in a program. For example, they allow you in a editor that supports tags to jump to the definition of a function when you come across a use of that function. ctags (for C) was the first tag-generation program. See the wikipedia article for more information.
There are currently a number of different ways to generate tags with Haskell.
Tags Formats
Tag files can be produced in a number of different formats supported by different editors. The two most common formats are 'ctags', which is supported by Vim and others, and 'etags', which is supported by Emacs. Note that the default names for the file in ctags format and the file in etags format are 'tags' and 'TAGS' respectively
Haskell tag generators
GHC
- GHC can generate tag files from GHCi. Use either the ':ctags' or ':etags' commands to produce a tags file for the currently loaded modules.
- For example:
- echo ":ctags" | ghci -v0 Main.hs
- echo ":etags" | ghci -v0 Main.hs
Actively developed
- fast-tags: Incremental Vim tag generation. Designed to be fast. Uses its own parser.
- Hasktags: Can produce either a ctags or etags compatible tag file. Uses its own parser.
- hothasktags: Knows about import lists and qualified imports. Vim tags only. Uses haskell-src-exts for parsing.
Other
- haskdogs: Wrapper script for hasktags. (last update 2013)
- lushtags: Designed to have smooth integration with the Vim Tagbar plugin. (last update 2011)
- gasbag: Attempts to choose the best available definition for a given tag. Will notice bindings that don't have an accompanying type signature. (last update 2011)
- htags: Haskell 98 only. Uses haskell-src for parsing. (last update 2008)
GHC development
- Use `make TAGS` to generate Emacs tags.
You can also find the source code for a tag generator in Chris Ryder and Simon Thompson paper on porting the Haskell Refactoring tool, HaRe, to the GHC API.
More Information
Vim
- Using tags in Vim
- :help tags
- insert-mode tag completion (ctrl-x ctrl-])
- :help cursorhold-example
- Vim plugin to view all tags in a window
- Another plugin; newer's not always better, but this is still actively maintained as of 2012
Others
- NEdit documentation for using tags
- Chapter 14 of the BBEdit manual covers using tags