Extending ctags with a parser written in C

This chapter describes how to add a parser in C and the internal API of Universal Ctags.

Before you start writing a parser in C, consider using optlib parser. Universal Ctags extends the functionality so extensively that it can implement most of functionality for the parser. See ctags-optlib(7) and Extending ctags with Regex parser (optlib) for details.

optlib parser is also suitable for prototyping of a parser in C.

• Writing a parser in C
  • Registering a parser
  • Reading input file stream
  • Parsing
  • Adding a tag to the tag file
  • Adding the parser to ctags
  • Misc.
• ctags Internal API
  • Input text stream
    • inputFile type and the functions of input group
    • The functions of bypass group
    • The functions of raw group
    • promise API
      • Background and Idea
      • Usage
      • Internal design
  • Automatic parser guessing
  • Managing regular expression parsers
  • Parser written in C
    • tokenInfo API
  • Output tag stream
    • cork API
      • Background and Idea
      • How to use
      • Automatic full qualified tag generation
  • PackCC compiler-compiler
• Running multiple parsers on an input file
  • Applying a parser to specified areas of input file (guest/host)
    • Examples of guest/host combinations
      • {CSS,JavaScript}/HTML parser combination
      • C/Yacc parser combination
      • Pod/Perl parser combination
    • API for running a parser in an area
    • Running guest parsers from an optlib based host parser
  • Tagging definitions of higher (upper) level language (sub/base)
    • Background
    • Terms
      • Base parser and subparser
      • Top down parser choice and bottom up parser choice
      • Exclusive subparser and coexisting subparser
    • API for making a combination of base parser and subparsers
      • Outline
      • Details
    • Examples of sub/base combinations
      • Automake/Make parser combination
      • Autoconf/M4 parser combination