Ctags

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
Ctags (BSD)
Developer(s)Ken Arnold
Repository Edit this at Wikidata
Operating systemUnix and Unix-like
TypeProgramming tool (Specifically: Code navigation tool)
LicenseBSD

Ctags is a programming tool that generates an index (or tag) file of names found in source and header files of various programming languages to aid code comprehension. Depending on the language, functions, variables, class members, macros and so on may be indexed. These tags allow definitions to be quickly and easily located by a text editor, a code search engine, or other utility. Alternatively, there is also an output mode that generates a cross reference file, listing information about various names found in a set of language files in human-readable form.

The original Ctags was introduced in BSD Unix 3.0 and was written by Ken Arnold, with Fortran support by Jim Kleckner and Pascal support by Bill Joy. It is part of the initial release of Single Unix Specification and XPG4 of 1992.

Editors that support ctags[edit]

Tag index files are supported by many source code editors, including:

Variants of ctags[edit]

There are a few other implementations of the ctags program:

Etags[edit]

GNU Emacs comes with two ctags utilities, etags and ctags, which are compiled from the same source code. Etags generates a tag table file for Emacs, while the ctags command is used to create a similar table in a format understood by vi. They have different sets of command line options: For those options which only make sense for vi style tag files produced by the ctags command, etags could not recognize them and would ignore them.[1]

Exuberant Ctags[edit]

Exuberant Ctags, written and maintained by Darren Hiebert until 2009,[2] was initially distributed with Vim, but became a separate project upon the release of Vim 6. It includes support for Emacs and etags compatibility.[3][4]

Exuberant Ctags includes support for over 40 programming languages with the ability to add support for even more using regular expressions.

Universal Ctags[edit]

Universal Ctags is a fork of Exuberant Ctags, with the objective of continuing its development. A few parsers are rewritten to better support the languages.[5]

Language-specific[edit]

Hasktags creates ctags compatible tag files for Haskell source files.[6] It includes support for creating Emacs etags files.[7]

jsctags is a ctags-compatible code indexing solution for JavaScript.[8] It is specialized for JavaScript and uses the CommonJS packaging system. It outperforms Exuberant Ctags for JavaScript code, finding more tags than the latter.[9]

Tags file formats[edit]

There are multiple tag file formats. Some of them are described below. In the following, \x## represents the byte with hexadecimal representation ##. Every line ends with a line feed (LF, \n = \x0A).

Ctags and descendants[edit]

The original ctags and the Exuberant/Universal descendants have similar file formats:[10]

Ctags[edit]

This is the format used by vi and various clones. The tags file is normally named "tags".

The tags file is a list of lines, each line in the format:

{tagname}\t{tagfile}\t{tagaddress}

The fields are specified as follows:

  • {tagname} – Any identifier, not containing white space
  • \t – Exactly one tab (\x0b) character, although many versions of vi can handle any amount of white space.
  • {tagfile} – The name of the file where {tagname} is defined, relative to the current directory
  • {tagaddress} – An ex mode command that will take the editor to the location of the tag. For POSIX implementations of vi this may only be a search or a line number, providing added security against arbitrary command execution.

The tags file is sorted on the {tagname} field which allows for fast searching of the tags file.

Extended Ctags[edit]

This is the format used by Vim's Exuberant Ctags and Universal Ctags. These programs can generate an original ctags file format or an extended format that attempts to retain backward compatibility.

The extended tags file is a list of lines, each line in the format:

{tagname}\t{tagfile}\t{tagaddress}[;"\t{tagfield...}]

The fields up to and including {tagaddress} are the same as for ctags above.

Optional additional fields are indicated by square brackets ("[...]") and include:

  • ;" – semicolon + double quote: Ends the {tagaddress} in a way that looks like the start of a comment to vi or ex.
  • {tagfield} – extension fields: tab separated "key:value" pairs for more information.

This format is compatible with non-POSIX vi as the additional data is interpreted as a comment. POSIX implementations of vi must be changed to support it, however.[10]

Etags[edit]

This is the format used by Emacs etags. The tags file is normally named "TAGS".

The etags files consists of multiple sections—one section per input source file. Sections are plain-text with several non-printable ascii characters used for special purposes. These characters are represented as bracketed hexadecimal codes below.

A section starts with a two line header (the first two bytes make up a magic number):

\x0c
{src_file},{size_of_tag_definition_data_in_bytes}

The header is followed by tag definitions, one definition per line, with the format:

{tag_definition_text}\x7f{tagname}\x01{line_number},{byte_offset}

{tagname}\x01 can be omitted if the name of the tag can be deduced from the text at the tag definition.

Example[edit]

Given a single line test.c source code:

#define CCC(x)

The TAGS (etags) file would look like this:

\x0c
test.c,21
#define CCC(\x7fCCC\x011,0

The tags (ctags) file may look like:

CCC(	test.c	1

or more flexibly using a search:

CCC(	test.c	/^#define CCC(/

See also[edit]

References[edit]

  1. ^ etags.emacs(1) – Linux General Commands Manual
  2. ^ "Exuberant Ctags". ctags.sourceforge.net.
  3. ^ "Vim documentation: version6: ctags-gone". Retrieved 2007-04-28.
  4. ^ etags.ctags(1) – Linux General Commands Manual
  5. ^ "Universal Ctags Documentation". Retrieved 2018-08-02.
  6. ^ "GHC documentation: Other Haskell utility programs". Retrieved 2010-03-05.
  7. ^ "hasktags: Produces ctags "tags" and etags "TAGS" files for Haskell programs". Retrieved 2010-03-05.
  8. ^ "pcwalton github repository for jsctags". Archived from the original on 2010-08-22. Retrieved 2016-09-10.
  9. ^ Patrick Walton. "Introducing jsctags". Retrieved 2010-05-25.
  10. ^ a b "Proposal for extended Vi tags file format". Retrieved 2007-06-30.

External links[edit]