erl_anno

模块

ERL[医]安诺

模块摘要

Erlang编译器注释的抽象数据类型。

描述

该模块提供了一个抽象类型，Erlang编译器及其助手模块用于保存数据，如列、行号和文本。数据类型是注解如下所述。

Erlang令牌扫描程序根据选项返回带有以下注释子集的令牌：

column

标记开始的列。

location

标记开始的行和列，如果列未知，则只显示行。

text

令牌的文本。

由此导出以下注释：

line

标记开始的行。

该模块还支持以下注释，各个模块都使用这些注释：

file

文件名。

generated

指示抽象代码是否由编译器生成的布尔值。Erlang编译器不会对此类代码发出警告。

record

指示抽象代码的起源是否为记录的布尔值。被Dialyzer将类型分配给元组元素。

功能column()，end_location()，line()，location()，和text()中erl_scan模块能够用于在令牌检查注释。

功能anno_from_term()，anno_to_term()，fold_anno()，map_anno()，mapfold_anno()，和new_anno()，在所述erl_parse模块可用于在抽象代码操纵注释。

数据类型

anno()

注释的集合。

anno_term() = term()

表示注释集合的术语。它要么是location()或者是键值对的列表。

column() = integer() >= 1

line() = integer() >= 0

location() =line()| {line(),column()}

text() = string()

输出

column(Anno) -> column() | undefined

类型

返回注释Anno的列。

end_location(Anno) -> location() | undefined

类型

返回注释Anno文本的结束位置。如果没有文字，undefined则被返回。

file(Anno) -> filename() | undefined

类型

返回注释Anno的文件名。如果没有文件名，undefined会被返回。

from_term(Term) -> Anno

类型

返回带有表示项的注释。

另见to_term()...

generated(Anno) -> generated()

类型

如果注释Anno被标记为生成，则返回true。默认是返回false。

是[医]Anno%28 Term%29->boole%28%29

类型

回报true如果术语是注释的集合，则为false...

line(Anno) -> line()

类型

返回注释的行，Anno。

location(Anno) -> location()

类型

返回注释Anno的位置。

new(Location) -> anno()

类型

创建给定位置的注释的新集合。

set_file(File, Anno) -> Anno

类型

修改注释Anno的文件名。

set_generated(Generated, Anno) -> Anno

类型

修改注释的生成标记Anno。

set_line(Line, Anno) -> Anno

类型

修改注释的行，Anno。

set_location(Location, Anno) -> Anno

类型

修改注释Anno的位置。

set_record(Record, Anno) -> Anno

类型

修改注释Anno的记录标记。

set_text(Text, Anno) -> Anno

类型

修改注释的文本，Anno。

ext(Anno) -> text() | undefined

类型

返回注释Anno的文本。如果没有短信，undefined会被返回。

to_term(Anno) -> anno_term()

类型

返回表示注释Anno的术语。

另见from_term()...

另见

erl_parse(3)，erl_scan(3)