Search documentation of stdlib

# erl_scan (stdlib v8.0.3)

Copy Markdown View Source

The Erlang token scanner.

This module contains functions for tokenizing (scanning) characters into Erlang tokens.

### Error Information

`ErrorInfo` is the standard `ErrorInfo` structure that is returned from all I/O modules. The format is as follows:

    {ErrorLocation, Module, ErrorDescriptor}

A string describing the error is obtained with the following call:

    Module:format_error(ErrorDescriptor)

### Notes

The continuation of the first call to the re-entrant input functions must be `[]`. For a complete description of how the re-entrant input scheme works, see Armstrong, Virding and Williams: 'Concurrent Programming in Erlang', Chapter 13.

### See Also

`erl_anno`, `erl_parse`, `io`

## Summary

### Types

category()
char_spec()
error_description()
error_info()
option()
options()
resword_fun()
return_cont()
symbol()
text_fun()
token()
tokens()
tokens_result()

### Functions

category(Token)

Returns the category of `Token`.

column(Token)

Returns the column of `Token`'s collection of annotations.

end_location(Token)

Returns the end location of the text of `Token`'s collection of annotations. If there is no text, `undefined` is returned.

format_error(ErrorDescriptor)

Uses an `ErrorDescriptor` and returns a string that describes the error or warning. This function is usually called implicitly when an `ErrorInfo` structure is processed (see section Error Information).

line(Token)

Returns the line of `Token`'s collection of annotations.

location(Token)

Returns the location of `Token`'s collection of annotations.

reserved_word(Atom)

Returns `true` if `Atom` is an Erlang reserved word, otherwise `false`.

string(String)

Equivalent to `string(String, 1)`.

string(String, StartLocation)

Equivalent to `string(String, StartLocation, [])`.

string(String, StartLocation, Options)

Takes the list of characters `String` and tries to scan (tokenize) them.

symbol(Token)

Returns the symbol of `Token`.

text(Token)

Returns the text of `Token`'s collection of annotations. If there is no text, `undefined` is returned.

tokens(Continuation, CharSpec, StartLocation)

Equivalent to `tokens(Continuation, CharSpec, StartLocation, [])`.

tokens(Continuation, CharSpec, StartLocation, Options)

This is the re-entrant scanner, which scans characters until either a dot ('.' followed by a white space) or `eof` is reached.

## Types

# category()

(not exported)

    -type category() :: atom().

# char_spec()

(not exported)

    -type char_spec() :: string() | eof.

# error_description()

(not exported)

    -type error_description() :: term().

# error_info()

    -type error_info() :: {erl_anno:location(), module(), error_description()}.

# option()

(not exported)

    -type option() ::
              return | return_white_spaces | return_comments | text |
              {reserved_word_fun, resword_fun()} |
              {text_fun, text_fun()} |
              {compiler_internal, [term()]}.

# options()

    -type options() :: option() | [option()].

# resword_fun()

(not exported)

    -type resword_fun() :: fun((atom()) -> boolean()).

# return_cont()

    -opaque return_cont()

# symbol()

(not exported)

    -type symbol() :: atom() | float() | integer() | string().

# text_fun()

(not exported)

    -type text_fun() :: fun((atom(), string()) -> boolean()).

# token()

    -type token() :: {category(), Anno :: erl_anno:anno(), symbol()} | {category(), Anno :: erl_anno:anno()}.

# tokens()

    -type tokens() :: [token()].

# tokens_result()

    -type tokens_result() ::
              {ok, Tokens :: tokens(), EndLocation :: erl_anno:location()} |
              {eof, EndLocation :: erl_anno:location()} |
              {error, ErrorInfo :: error_info(), EndLocation :: erl_anno:location()}.

## Functions

# category(Token)

(since OTP 18.0)

    -spec category(Token) -> category() when Token :: token().

Returns the category of `Token`.

# column(Token)

(since OTP 18.0)

    -spec column(Token) -> erl_anno:column() | undefined when Token :: token().

Returns the column of `Token`'s collection of annotations.

# end_location(Token)

(since OTP 18.0)

    -spec end_location(Token) -> erl_anno:location() | undefined when Token :: token().

Returns the end location of the text of `Token`'s collection of annotations. If there is no text, `undefined` is returned.

# format_error(ErrorDescriptor)

    -spec format_error(ErrorDescriptor) -> string() when ErrorDescriptor :: error_description().

Uses an `ErrorDescriptor` and returns a string that describes the error or warning. This function is usually called implicitly when an `ErrorInfo` structure is processed (see section Error Information).

# line(Token)

(since OTP 18.0)

    -spec line(Token) -> erl_anno:line() when Token :: token().

Returns the line of `Token`'s collection of annotations.

# location(Token)

(since OTP 18.0)

    -spec location(Token) -> erl_anno:location() when Token :: token().

Returns the location of `Token`'s collection of annotations.

# reserved_word(Atom)

    -spec reserved_word(Atom :: atom()) -> boolean().

Returns `true` if `Atom` is an Erlang reserved word, otherwise `false`.

# string(String)

    -spec string(String) -> Return
                    when
                        String :: string(),
                        Return ::
                            {ok, Tokens :: tokens(), EndLocation} |
                            {error, ErrorInfo :: error_info(), ErrorLocation},
                        EndLocation :: erl_anno:location(),
                        ErrorLocation :: erl_anno:location().

Equivalent to `string(String, 1)`.

# string(String, StartLocation)

    -spec string(String, StartLocation) -> Return
                    when
                        String :: string(),
                        Return ::
                            {ok, Tokens :: tokens(), EndLocation} |
                            {error, ErrorInfo :: error_info(), ErrorLocation},
                        StartLocation :: erl_anno:location(),
                        EndLocation :: erl_anno:location(),
                        ErrorLocation :: erl_anno:location().

Equivalent to `string(String, StartLocation, [])`.

# string(String, StartLocation, Options)

    -spec string(String, StartLocation, Options) -> Return
                    when
                        String :: string(),
                        Options :: options(),
                        Return ::
                            {ok, Tokens :: tokens(), EndLocation} |
                            {error, ErrorInfo :: error_info(), ErrorLocation},
                        StartLocation :: erl_anno:location(),
                        EndLocation :: erl_anno:location(),
                        ErrorLocation :: erl_anno:location().

Takes the list of characters `String` and tries to scan (tokenize) them.

Returns one of the following:

- `{ok, Tokens, EndLocation}` - `Tokens` are the Erlang tokens from `String`. `EndLocation` is the first location after the last token.

- `{error, ErrorInfo, ErrorLocation}` - An error occurred. `ErrorLocation` is the first location after the erroneous token.

`StartLocation` indicates the initial location when scanning starts. If `StartLocation` is a line, `Anno`, `EndLocation`, and `ErrorLocation` are lines. If `StartLocation` is a pair of a line and a column, `Anno` takes the form of an opaque compound data type, and `EndLocation` and `ErrorLocation` are pairs of a line and a column. The token annotations contain information about the column and the line where the token begins, as well as the text of the token (if option `text` is specified), all of which can be accessed by calling `column/1`, `line/1`, `location/1`, and `text/1`.

A token is a tuple containing information about syntactic category, the token annotations, and the terminal symbol. For punctuation characters (such as `;` and `|`) and reserved words, the category and the symbol coincide, and the token is represented by a two-tuple. Three-tuples have one of the following forms:

- `{atom, Anno, atom()}`
- `{char, Anno, char()}`
- `{comment, Anno, string()}`
- `{float, Anno, float()}`
- `{integer, Anno, integer()}`
- `{var, Anno, atom()}`
- `{white_space, Anno, string()}`

Valid options:

- `{reserved_word_fun, reserved_word_fun()}` - A callback function that is called when the scanner has found an unquoted atom. If the function returns `true`, the unquoted atom itself becomes the category of the token. If the function returns `false`, `atom` becomes the category of the unquoted atom.

- `return_comments` - Return comment tokens.

- `return_white_spaces` - Return white space tokens. By convention, a newline character, if present, is always the first character of the text (there cannot be more than one newline in a white space token).

- `return` - Short for `[return_comments, return_white_spaces]`.

- `text` - Include the token text in the token annotation. The text is the part of the input corresponding to the token. See also `text_fun`.

- `{text_fun, text_fun()}` - A callback function used to determine whether the full text for the token shall be included in the token annotation. Arguments of the function are the category of the token and the full token string. This is only used when `text` is not present. If neither are present the text will not be saved in the token annotation.

- `{compiler_internal, term()}` - Pass compiler-internal options to the scanner. The set of internal options understood by the scanner should be considered experimental and can thus be changed at any time without prior warning.

  The following options are currently understood:

  - `ssa_checks` - Tokenizes source code annotations used for encoding tests on the BEAM SSA code produced by the compiler.

# symbol(Token)

(since OTP 18.0)

    -spec symbol(Token) -> symbol() when Token :: token().

Returns the symbol of `Token`.

# text(Token)

(since OTP 18.0)

    -spec text(Token) -> erl_anno:text() | undefined when Token :: token().

Returns the text of `Token`'s collection of annotations. If there is no text, `undefined` is returned.

# tokens(Continuation, CharSpec, StartLocation)

    -spec tokens(Continuation, CharSpec, StartLocation) -> Return
                    when
                        Continuation :: return_cont() | [],
                        CharSpec :: char_spec(),
                        StartLocation :: erl_anno:location(),
                        Return ::
                            {done, Result :: tokens_result(), LeftOverChars :: char_spec()} |
                            {more, Continuation1 :: return_cont()}.

Equivalent to `tokens(Continuation, CharSpec, StartLocation, [])`.

# tokens(Continuation, CharSpec, StartLocation, Options)

    -spec tokens(Continuation, CharSpec, StartLocation, Options) -> Return
                    when
                        Continuation :: return_cont() | [],
                        CharSpec :: char_spec(),
                        StartLocation :: erl_anno:location(),
                        Options :: options(),
                        Return ::
                            {done, Result :: tokens_result(), LeftOverChars :: char_spec()} |
                            {more, Continuation1 :: return_cont()}.

This is the re-entrant scanner, which scans characters until either a dot ('.' followed by a white space) or `eof` is reached.

It returns:

- `{done, Result, LeftOverChars}` - Indicates that there is sufficient input data to get a result. `Result` is:

  - `{ok, Tokens, EndLocation}` - The scanning was successful. `Tokens` is the list of tokens including dot.

  - `{eof, EndLocation}` - End of file was encountered before any more tokens.

  - `{error, ErrorInfo, EndLocation}` - An error occurred. `LeftOverChars` is the remaining characters of the input data, starting from `EndLocation`.

- `{more, Continuation1}` - More data is required for building a term. `Continuation1` must be passed in a new call to `tokens/3,4` when more data is available.

The `CharSpec` `eof` signals end of file. `LeftOverChars` then takes the value `eof` as well.

For a description of the options, see `string/3`.