Collecting Browsing Information With sbtags

The sbtags command provides a quick and convenient method for collecting browsing information from source files, enabling you to collect minimal browsing information for programs that do not compile completely.

Understanding sbtags

The sbtags command collects a subset of the information available through compilation. The reduced information restricts some browsing functionality. A database generated by sbtags enables you to perform queries on functions and variables and to display the function call graph.

A tags database:

• Cannot issue queries about local variables

• Cannot browse classes

• Cannot graph class relationships

• Has limited ability to issue complex queries

• Has limited ability to focus queries

• Has less reliability than compiled information

Once a file has been changed, it often need not be scanned again to incorporate changes into the database.

An sbtags database is based on a lexical analysis of the source file. Though it does not always correctly identify all the language constructs, it will operate on files that will not compile and is faster than recompilation.

sbtags recognizes definitions for variables, types, and functions. It also collects information on function calls. No other information is collected (in particular, other semantic information for complex queries is not collected).

The functionality of sbtags is similar to ctags and etags, except for the Call Grapher information. You may mix direct queries to the database for definitions and graphing with pattern-matching queries.

With an sbtags generated database:

• Class Browser and Class Grapher features are not available.

• The database does not contain information on all symbols and strings. It contains information on functions, classes, types, variable definitions, and calls to functions.

• Time is saved since the sbtags program runs faster than the compiler.

• The database size is much smaller than the size of your source code.

• The database content is not guaranteed to be semantically correct because the sbtags program performs only simple syntactic and semantic analysis and may sometimes be in error.

• A database is generated even if the source code cannot be compiled because the code is incomplete or semantically incorrect.

Generating an sbtags Database

To generate a browsing database using sbtags , type sbtags , followed by the name of the file (or files) for which you want to generate the database: