Abstract datatype for the annotations of the Erlang Compiler.

This module provides an abstract type that is used by the Erlang Compiler and its helper modules for holding data such as column, line number, and text. The data type is a collection of annotations as described in the following.

The Erlang Token Scanner returns tokens with a subset of the following annotations, depending on the options:

• column - The column where the token begins.

• location - The line and column where the token begins, or just the line if the column is unknown.

• text - The token's text.

From this, the following annotation is derived:

• line - The line where the token begins.

This module also supports the following annotations, which are used by various modules:

• file - A filename.

• generated - A Boolean indicating if the abstract code is compiler-generated. The Erlang Compiler does not emit warnings for such code.

• record - A Boolean indicating if the origin of the abstract code is a record. Used by Dialyzer to assign types to tuple elements.

The functions column(), end_location(), line(), location(), and text() in the erl_scan module can be used for inspecting annotations in tokens.

The functions anno_from_term(), anno_to_term(), fold_anno(), map_anno(), mapfold_anno(), and new_anno(), in the erl_parse module can be used for manipulating annotations in abstract code.

See Also

erl_parse, erl_scan