epp

%% coding: utf-8

%% For this file we have chosen encoding = Latin-1

%% -*- coding: latin-1 -*-

close(Epp) -> ok

Types

Closes the preprocessing of a file.

default_encoding() -> source_encoding()

OTP R16B

Returns the default encoding of Erlang source files.

encoding_to_string(Encoding) -> string()

OTP R16B

Types

Returns a string representation of an encoding. The string is recognized by read_encoding/1,2, read_encoding_from_binary/1,2, and set_encoding/1,2 as a valid encoding.

format_error(ErrorDescriptor) -> io_lib:chars()

OTP R14B03

Types

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

open(Options) -> {ok, Epp} | {ok, Epp, Extra} | {error, ErrorDescriptor}

OTP 17.0

Types

Opens a file for preprocessing.

If you want to change the file name of the implicit -file() attributes inserted during preprocessing, you can do with {source_name, SourceName}. If unset it will default to the name of the opened file.

If extra is specified in Options, the return value is {ok, Epp, Extra} instead of {ok, Epp}.

open(FileName, IncludePath) -> {ok, Epp} | {error, ErrorDescriptor}

Types

Equivalent to epp:open([{name, FileName}, {includes, IncludePath}]).

open(FileName, IncludePath, PredefMacros) -> {ok, Epp} | {error, ErrorDescriptor}

Types

Equivalent to epp:open([{name, FileName}, {includes, IncludePath}, {macros, PredefMacros}]).

parse_erl_form(Epp) -> {ok, AbsForm} | {error, ErrorInfo} | {warning, WarningInfo} | {eof, Line}

Types

Returns the next Erlang form from the opened Erlang source file. Tuple {eof, Line} is returned at the end of the file. The first form corresponds to an implicit attribute -file(File,1)., where File is the file name.

parse_file(FileName, Options) -> {ok, [Form]} | {ok, [Form], Extra} | {error, OpenError}

OTP 17.0

Types

Preprocesses and parses an Erlang source file. Notice that tuple {eof, Line} returned at the end of the file is included as a "form".

If you want to change the file name of the implicit -file() attributes inserted during preprocessing, you can do with {source_name, SourceName}. If unset it will default to the name of the opened file.

If extra is specified in Options, the return value is {ok, [Form], Extra} instead of {ok, [Form]}.

parse_file(FileName, IncludePath, PredefMacros) -> {ok, [Form]} | {error, OpenError}

Types

Equivalent to epp:parse_file(FileName, [{includes, IncludePath}, {macros, PredefMacros}]).

read_encoding(FileName) -> source_encoding() | none

OTP R16B

read_encoding(FileName, Options) -> source_encoding() | none

OTP R16B

Types

Read the encoding from a file. Returns the read encoding, or none if no valid encoding is found.

Option in_comment_only is true by default, which is correct for Erlang source files. If set to false, the encoding string does not necessarily have to occur in a comment.

read_encoding_from_binary(Binary) -> source_encoding() | none

OTP R16B

read_encoding_from_binary(Binary, Options) -> source_encoding() | none

OTP R16B

Types

Read the encoding from a binary. Returns the read encoding, or none if no valid encoding is found.

Option in_comment_only is true by default, which is correct for Erlang source files. If set to false, the encoding string does not necessarily have to occur in a comment.

set_encoding(File) -> source_encoding() | none

OTP R16B

Types

Reads the encoding from an I/O device and sets the encoding of the device accordingly. The position of the I/O device referenced by File is not affected. If no valid encoding can be read from the I/O device, the encoding of the I/O device is set to the default encoding.

Returns the read encoding, or none if no valid encoding is found.

set_encoding(File, Default) -> source_encoding() | none

OTP 17.0

Types

Reads the encoding from an I/O device and sets the encoding of the device accordingly. The position of the I/O device referenced by File is not affected. If no valid encoding can be read from the I/O device, the encoding of the I/O device is set to the encoding specified by Default.

Returns the read encoding, or none if no valid encoding is found.

{ErrorLine, Module, ErrorDescriptor}

Module:format_error(ErrorDescriptor)