Doxygen

Doxygen's Internals

### Doxygen's internals

Note that this section is still under construction!

The following picture shows how source files are processed by doxygen.

Data flow overview

The following sections explain the steps above in more detail.

### Config parser

The configuration file that controls the settings of a project is parsed and the settings are stored in the singleton class `Config` in `src/config.h`. The parser itself is written using `flex` and can be found in `src/config.l`. This parser is also used directly by `doxywizard`, so it is put in a separate library.

Each configuration option has one of 5 possible types: `String`, `List`, `Enum`, `Int`, or `Bool`. The values of these options are available through the global functions `Config_getXXX()`, where `XXX` is the type of the option. The argument of these function is a string naming the option as it appears in the configuration file. For instance: `Config_getBool`("GENERATE_TESTLIST") returns a reference to a boolean value that is `TRUE` if the test list was enabled in the configuration file.

The function `readConfiguration()` in `src/doxygen.cpp` reads the command line options and then calls the configuration parser.

### C Preprocessor

The input files mentioned in the configuration file are (by default) fed to the C Preprocessor (after being piped through a user defined filter if available).

The way the preprocessor works differs somewhat from a standard C Preprocessor. By default it does not do macro expansion, although it can be configured to expand all macros. Typical usage is to only expand a user specified set of macros. This is to allow macro names to appear in the type of function parameters for instance.

Another difference is that the preprocessor parses, but not actually includes code when it encounters a `#include` (with the exception of `#include` found inside { ... } blocks). The reasons behind this deviation from the standard is to prevent feeding multiple definitions of the same functions/classes to doxygen's parser. If all source files would include a common header file for instance, the class and type definitions (and their documentation) would be present in each translation unit.

The preprocessor is written using `flex` and can be found in `src/pre.l`. For condition blocks (`#if`) evaluation of constant expressions is needed. For this a `yacc` based parser is used, which can be found in `src/constexp.y` and `src/constexp.l`.

The preprocessor is invoked for each file using the `preprocessFile()` function declared in `src/pre.h`, and will append the preprocessed result to a character buffer. The format of the character buffer is

    0x06 file name 1
    0x06 preprocessed contents of file 1
    ...
    0x06 file name n
    0x06 preprocessed contents of file n

### Language parser

The preprocessed input buffer is fed to the language parser, which is implemented as a big state machine using `flex`. It can be found in the file `src/scanner.l`. There is one parser for all languages (C/C++/Java/IDL). The state variables `insideIDL` and `insideJava` are uses at some places for language specific choices.

The task of the parser is to convert the input buffer into a tree of entries (basically an abstract syntax tree). An entry is defined in `src/entry.h` and is a blob of loosely structured information. The most important field is `section` which specifies the kind of information contained in the entry.

Possible improvements for future versions:

- Use one scanner/parser per language instead of one big scanner.
- Move the first pass parsing of documentation blocks to a separate module.
- Parse defines (these are currently gathered by the preprocessor, and ignored by the language parser).

### Data organizer

This step consists of many smaller steps, that build dictionaries of the extracted classes, files, namespaces, variables, functions, packages, pages, and groups. Besides building dictionaries, during this step relations (such as inheritance relations), between the extracted entities are computed.

Each step has a function defined in `src/doxygen.cpp`, which operates on the tree of entries, built during language parsing. Look at the "Gathering information" part of `parseInput()` for details.

The result of this step is a number of dictionaries, which can be found in the doxygen "namespace" defined in `src/doxygen.h`. Most elements of these dictionaries are derived from the class `Definition`; The class `MemberDef`, for instance, holds all information for a member. An instance of such a class can be part of a file ( class `FileDef` ), a class ( class `ClassDef` ), a namespace ( class `NamespaceDef` ), a group ( class `GroupDef` ), or a Java package ( class `PackageDef` ).

### Tag file parser

If tag files are specified in the configuration file, these are parsed by a SAX based XML parser, which can be found in `src/tagreader.cpp`. The result of parsing a tag file is the insertion of `Entry` objects in the entry tree. The field `Entry::tagInfo` is used to mark the entry as external, and holds information about the tag file.

### Documentation parser

Special comment blocks are stored as strings in the entities that they document. There is a string for the brief description and a string for the detailed description. The documentation parser reads these strings and executes the commands it finds in it (this is the second pass in parsing the documentation). It writes the result directly to the output generators.

The parser is written in C++ and can be found in `src/docparser.cpp`. The tokens that are eaten by the parser come from `src/doctokenizer.l`. Code fragments found in the comment blocks are passed on to the source parser.

The main entry point for the documentation parser is `validatingParseDoc()` declared in `src/docparser.h`. For simple texts with special commands `validatingParseText()` is used.

### Source parser

If source browsing is enabled or if code fragments are encountered in the documentation, the source parser is invoked.

The code parser tries to cross-reference to source code it parses with documented entities. It also does syntax highlighting of the sources. The output is directly written to the output generators.

The main entry point for the code parser is `parseCode()` declared in `src/code.h`.

### Output generators

After data is gathered and cross-referenced, doxygen generates output in various formats. For this it uses the methods provided by the abstract class `OutputGenerator`. In order to generate output for multiple formats at once, the methods of `OutputList` are called instead. This class maintains a list of concrete output generators, where each method called is delegated to all generators in the list.

To allow small deviations in what is written to the output for each concrete output generator, it is possible to temporarily disable certain generators. The OutputList class contains various `disable()` and `enable()` methods for this. The methods `OutputList::pushGeneratorState()` and `OutputList::popGeneratorState()` are used to temporarily save the set of enabled/disabled output generators on a stack.

The XML is generated directly from the gathered data structures. In the future XML will be used as an intermediate language (IL). The output generators will then use this IL as a starting point to generate the specific output formats. The advantage of having an IL is that various independently developed tools written in various languages, could extract information from the XML output. Possible tools could be:

- an interactive source browser
- a class diagram generator
- computing code metrics.

### Debugging

Since doxygen uses a lot of `flex` code it is important to understand how `flex` works (for this one should read the `man` page) and to understand what it is doing when `flex` is parsing some input. Fortunately, when `flex` is used with the `-d` option it outputs what rules matched. This makes it quite easy to follow what is going on for a particular input fragment.

To make it easier to toggle debug information for a given `flex` file I wrote the following `perl` script, which automatically adds or removes `-d` from the correct line in the `Makefile:`

    #!/usr/bin/perl

    $file = shift @ARGV;
    print "Toggle debugging mode for $file\n";
    if (!-e "../src/${file}.l")
    {
      print STDERR "Error: file ../src/${file}.l does not exist!\n";
      exit 1;
    }
    system("touch ../src/${file}.l");
    unless (rename "src/CMakeFiles/doxymain.dir/build.make","src/CMakeFiles/doxymain.dir/build.make.old") {
      print STDERR "Error: cannot rename src/CMakeFiles/doxymain.dir/build.make!\n";
      exit 1;
    }
    if (open(F,"<src/CMakeFiles/doxymain.dir/build.make.old")) {
      unless (open(G,">src/CMakeFiles/doxymain.dir/build.make")) {
        print STDERR "Error: opening file build.make for writing\n";
        exit 1;
      }
      print "Processing build.make...\n";
      while (<F>) {
        if ( s/flex \$\‍(LEX_FLAGS\‍) -d(.*) ${file}.l/flex \$(LEX_FLAGS)$1 ${file}.l/ ) {
          print "Disabling debug info for $file\n";
        }
        elsif ( s/flex \$\‍(LEX_FLAGS\‍)(.*) ${file}.l$/flex \$(LEX_FLAGS) -d$1 ${file}.l/ ) {
          print "Enabling debug info for $file.l\n";
        }
        print G "$_";
      }
      close F;
      unlink "src/CMakeFiles/doxymain.dir/build.make.old";
    }
    else {
      print STDERR "Warning file src/CMakeFiles/doxymain.dir/build.make does not exist!\n";
    }

    # touch the file
    $now = time;
    utime $now, $now, $file;

Another way to get rules matching / debugging information from the `flex` code is setting `LEX_FLAGS` with `make` (`make LEX_FLAGS=-d`).

Note that by running doxygen with `-d lex` you get information about which `flex codefile` is used.

### Testing

Doxygen has a small set of tests available to test, some, code integrity. The tests can be run by means of the command `make tests`. When only one or a few tests are required one can set the variable `TEST_FLAGS` when running the test e.g. `make TEST_FLAGS="--id 5" tests` or for multiple tests `make TEST_FLAGS="--id 5 --id 7" tests`. For a full set of possibilities give the command `make TEST_FLAGS="--help" tests`. It is also possible to specify the `TEST_FLAGS` as an environment variable (works also for testing through Visual Studio projects), e.g. `setenv TEST_FLAGS "--id 5 --id 7"` and `make tests`.

### Doxyfile differences

In case one has to communicate through e.g. a forum the configuration settings that are different from the standard doxygen configuration file settings one can run the doxygen command: with the `-x` option and the name of the configuration file (default is `Doxyfile`). The output will be a list of the not default settings (in `Doxyfile` format). Alternatively also `-x_noenv` is possible which is identical to the `-x` option but without replacing the environment variables and the CMake type replacement variables.

Return to the index.