File: erl_id_trans.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (34 lines) | stat: -rw-r--r-- 1,128 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.TH erl_id_trans 3 "stdlib  1.15.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
erl_id_trans \- An Identity Parse Transform
.SH DESCRIPTION
.LP
This module performs an identity parse transformation of Erlang code\&. It is included as an example for users who may wish to write their own parse transformers\&. If the option \fI{parse_transform, Module}\fR is passed to the compiler, a user written function \fIparse_transform/2\fR is called by the compiler before the code is checked for errors\&.

.SH EXPORTS
.LP
.B
parse_transform(Forms, Options) -> Forms
.br
.RS
.TP
Types
Forms = [erlang_form()]
.br
Options = [compiler_options()]
.br
.RE
.RS
.LP
Performs an identity transformation on Erlang forms, as an example\&.
.RE
.SH PARSE TRANSFORMATIONS
.LP
Parse transformations are used if a programmer wants to use Erlang syntax, but with different semantics\&. The original Erlang code is then transformed into other Erlang code\&. 
.SS Note:
.LP
Programmers are strongly advised not to engage in parse transformations and no support is offered for problems encountered\&.

.SH SEE ALSO
.LP
erl_parse(3), compile(3)\&.