Module
erl_anno
Module Summary
Abstract datatype for the annotations of the Erlang Compiler.
Since
Module erl_anno was introduced in OTP 18.0.
Description
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:
columnThe column where the token begins.
locationThe line and column where the token begins, or just the line if the column is unknown.
textThe token's text.
From this, the following annotation is derived:
lineThe line where the token begins.
This module also supports the following annotations, which are used by various modules:
fileA filename.
generatedA 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
Dialyzerto 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.
Data Types
A collection of annotations.
anno_term() = term()The term representing a collection of annotations. It is either a location() or a list of key-value pairs.
column() = integer() >= 1line() = integer() >= 0text() = string()Exports
column(Anno) -> column() | undefined | OTP 18.0 |
Types
Returns the column of the annotations Anno.
end_location(Anno) -> location() | undefined | OTP 18.0 |
Types
Returns the end location of the text of the annotations Anno. If there is no text, undefined is returned.
file(Anno) -> filename() | undefined | OTP 18.0 |
Types
Returns the filename of the annotations Anno. If there is no filename, undefined is returned.
from_term(Term) -> Anno | OTP 18.0 |
Types
Returns annotations with representation Term.
See also to_term().
generated(Anno) -> generated() | OTP 18.0 |
Types
Returns true if annotations Anno is marked as generated. The default is to return false.
is_anno(Term) -> boolean() | OTP 18.0 |
Types
Returns true if Term is a collection of annotations, otherwise false.
line(Anno) -> line() | OTP 18.0 |
Types
Returns the line of the annotations Anno.
location(Anno) -> location() | OTP 18.0 |
Types
Returns the location of the annotations Anno.
new(Location) -> anno() | OTP 18.0 |
Types
Creates a new collection of annotations given a location.
set_file(File, Anno) -> Anno | OTP 18.0 |
Types
Modifies the filename of the annotations Anno.
set_generated(Generated, Anno) -> Anno | OTP 18.0 |
Types
Modifies the generated marker of the annotations Anno.
set_line(Line, Anno) -> Anno | OTP 18.0 |
Types
Modifies the line of the annotations Anno.
set_location(Location, Anno) -> Anno | OTP 18.0 |
Types
Modifies the location of the annotations Anno.
set_record(Record, Anno) -> Anno | OTP 18.0 |
Types
Modifies the record marker of the annotations Anno.
set_text(Text, Anno) -> Anno | OTP 18.0 |
Types
Modifies the text of the annotations Anno.
text(Anno) -> text() | undefined | OTP 18.0 |
Types
Returns the text of the annotations Anno. If there is no text, undefined is returned.
to_term(Anno) -> anno_term() | OTP 18.0 |
Types
Returns the term representing the annotations Anno.
See also from_term().
See Also
© 2010–2020 Ericsson AB
Licensed under the Apache License, Version 2.0.