stdlib v3.15.2

erl_anno (stdlib v3.15.2)

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(3), erl_scan(3)

Link to this section Summary

Types

anno()

A collection of annotations.

-type anno_term() :: term().

The term representing a collection of annotations. It is either a location() or a list of key-value pairs.

-type column() :: term().
-type line() :: term().
-type location() :: term().
-type text() :: term().

Functions

column/1

Returns the column of the annotations Anno.

end_location/1

Returns the end location of the text of the annotations Anno. If there is no text, undefined is returned.

file/1

Returns the filename of the annotations Anno. If there is no filename, undefined is returned.

from_term/1

Returns annotations with representation Term.

generated/1

Returns true if annotations Anno is marked as generated. The default is to return false.

is_anno/1

Returns true if Term is a collection of annotations, otherwise false.

line/1

Returns the line of the annotations Anno.

location/1

Returns the location of the annotations Anno.

new/1

Creates a new collection of annotations given a location.

set_file/2

Modifies the filename of the annotations Anno.

set_generated/2

Modifies the generated marker of the annotations Anno.

set_line/2

Modifies the line of the annotations Anno.

set_location/2

Modifies the location of the annotations Anno.

set_record/2

Modifies the record marker of the annotations Anno.

set_text/2

Modifies the text of the annotations Anno.

text/1

Returns the text of the annotations Anno. If there is no text, undefined is returned.

to_term/1

Returns the term representing the annotations Anno.

Link to this section Types

Link to this opaque

anno()

(opaque)

Specs

anno()

A collection of annotations.

Link to this type

-type anno_term() :: term().

Specs

anno_term() :: term().

The term representing a collection of annotations. It is either a location() or a list of key-value pairs.

Link to this type

-type column() :: term().

Specs

column() :: pos_integer().
Link to this type

-type line() :: term().

Specs

line() :: non_neg_integer().
Link to this type

-type location() :: term().

Specs

location() :: line() | {line(), column()}.
Link to this type

-type text() :: term().

Specs

text() :: string().

Link to this section Functions

Link to this function

column/1

(since OTP 18.0)

Specs

column(Anno) -> column() | undefined when Anno :: anno().

Returns the column of the annotations Anno.

Link to this function

end_location/1

(since OTP 18.0)

Specs

end_location(Anno) -> location() | undefined when Anno :: anno().

Returns the end location of the text of the annotations Anno. If there is no text, undefined is returned.

Link to this function

file/1

(since OTP 18.0)

Specs

file(Anno) -> filename() | undefined when Anno :: anno().

Returns the filename of the annotations Anno. If there is no filename, undefined is returned.

Link to this function

from_term/1

(since OTP 18.0)

Specs

from_term(Term) -> Anno when Term :: anno_term(), Anno :: anno().

Returns annotations with representation Term.

See also to_term().

Link to this function

generated/1

(since OTP 18.0)

Specs

generated(Anno) -> generated() when Anno :: anno().

Returns true if annotations Anno is marked as generated. The default is to return false.

Link to this function

is_anno/1

(since OTP 18.0)

Specs

is_anno(Term) -> boolean() when Term :: any().

Returns true if Term is a collection of annotations, otherwise false.

Link to this function

line/1

(since OTP 18.0)

Specs

line(Anno) -> line() when Anno :: anno().

Returns the line of the annotations Anno.

Link to this function

location/1

(since OTP 18.0)

Specs

location(Anno) -> location() when Anno :: anno().

Returns the location of the annotations Anno.

Link to this function

new/1

(since OTP 18.0)

Specs

new(Location) -> anno() when Location :: location().

Creates a new collection of annotations given a location.

Link to this function

set_file/2

(since OTP 18.0)

Specs

set_file(File, Anno) -> Anno when File :: filename(), Anno :: anno().

Modifies the filename of the annotations Anno.

Link to this function

set_generated/2

(since OTP 18.0)

Specs

set_generated(Generated, Anno) -> Anno when Generated :: generated(), Anno :: anno().

Modifies the generated marker of the annotations Anno.

Link to this function

set_line/2

(since OTP 18.0)

Specs

set_line(Line, Anno) -> Anno when Line :: line(), Anno :: anno().

Modifies the line of the annotations Anno.

Link to this function

set_location/2

(since OTP 18.0)

Specs

set_location(Location, Anno) -> Anno when Location :: location(), Anno :: anno().

Modifies the location of the annotations Anno.

Link to this function

set_record/2

(since OTP 18.0)

Specs

set_record(Record, Anno) -> Anno when Record :: record(), Anno :: anno().

Modifies the record marker of the annotations Anno.

Link to this function

set_text/2

(since OTP 18.0)

Specs

set_text(Text, Anno) -> Anno when Text :: text(), Anno :: anno().

Modifies the text of the annotations Anno.

Link to this function

text/1

(since OTP 18.0)

Specs

text(Anno) -> text() | undefined when Anno :: anno().

Returns the text of the annotations Anno. If there is no text, undefined is returned.

Link to this function

to_term/1

(since OTP 18.0)

Specs

to_term(Anno) -> anno_term() when Anno :: anno().

Returns the term representing the annotations Anno.

See also from_term().