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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>1996</year>
<year>2007</year>
<holder>Ericsson AB, All Rights Reserved</holder>
</copyright>
<legalnotice>
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
The Initial Developer of the Original Code is Ericsson AB.
</legalnotice>
<title>erl_internal</title>
<prepared>Robert Virding</prepared>
<responsible>Bjarne Däcker</responsible>
<docno>1</docno>
<approved>Bjarne Däcker</approved>
<checked></checked>
<date>97-01-21</date>
<rev>B</rev>
<file>erl_internal.sgml</file>
</header>
<module>erl_internal</module>
<modulesummary>Internal Erlang Definitions</modulesummary>
<description>
<p>This module defines Erlang BIFs, guard tests and operators.
This module is only of interest to programmers who
manipulate Erlang code.</p>
</description>
<funcs>
<func>
<name>bif(Name, Arity) -> bool()</name>
<fsummary>Test for an Erlang BIF</fsummary>
<type>
<v>Name = atom()</v>
<v>Arity = integer()</v>
</type>
<desc>
<p>Returns <c>true</c> if <c>Name/Arity</c> is an Erlang BIF
which is automatically recognized by the compiler, otherwise
<c>false</c>.</p>
</desc>
</func>
<func>
<name>guard_bif(Name, Arity) -> bool()</name>
<fsummary>Test for an Erlang BIF allowed in guards</fsummary>
<type>
<v>Name = atom()</v>
<v>Arity = integer()</v>
</type>
<desc>
<p>Returns <c>true</c> if <c>Name/Arity</c> is an Erlang BIF
which is allowed in guards, otherwise <c>false</c>.</p>
</desc>
</func>
<func>
<name>type_test(Name, Arity) -> bool()</name>
<fsummary>Test for a valid type test</fsummary>
<type>
<v>Name = atom()</v>
<v>Arity = integer()</v>
</type>
<desc>
<p>Returns <c>true</c> if <c>Name/Arity</c> is a valid Erlang
type test, otherwise <c>false</c>.</p>
</desc>
</func>
<func>
<name>arith_op(OpName, Arity) -> bool()</name>
<fsummary>Test for an arithmetic operator</fsummary>
<type>
<v>OpName = atom()</v>
<v>Arity = integer()</v>
</type>
<desc>
<p>Returns <c>true</c> if <c>OpName/Arity</c> is an arithmetic
operator, otherwise <c>false</c>.</p>
</desc>
</func>
<func>
<name>bool_op(OpName, Arity) -> bool()</name>
<fsummary>Test for a Boolean operator</fsummary>
<type>
<v>OpName = atom()</v>
<v>Arity = integer()</v>
</type>
<desc>
<p>Returns <c>true</c> if <c>OpName/Arity</c> is a Boolean
operator, otherwise <c>false</c>.</p>
</desc>
</func>
<func>
<name>comp_op(OpName, Arity) -> bool()</name>
<fsummary>Test for a comparison operator</fsummary>
<type>
<v>OpName = atom()</v>
<v>Arity = integer()</v>
</type>
<desc>
<p>Returns <c>true</c> if <c>OpName/Arity</c> is a comparison
operator, otherwise <c>false</c>.</p>
</desc>
</func>
<func>
<name>list_op(OpName, Arity) -> bool()</name>
<fsummary>Test for a list operator</fsummary>
<type>
<v>OpName = atom()</v>
<v>Arity = integer()</v>
</type>
<desc>
<p>Returns <c>true</c> if <c>OpName/Arity</c> is a list
operator, otherwise <c>false</c>.</p>
</desc>
</func>
<func>
<name>send_op(OpName, Arity) -> bool()</name>
<fsummary>Test for a send operator</fsummary>
<type>
<v>OpName = atom()</v>
<v>Arity = integer()</v>
</type>
<desc>
<p>Returns <c>true</c> if <c>OpName/Arity</c> is a send
operator, otherwise <c>false</c>.</p>
</desc>
</func>
<func>
<name>op_type(OpName, Arity) -> Type</name>
<fsummary>Return operator type</fsummary>
<type>
<v>OpName = atom()</v>
<v>Arity = integer()</v>
<v>Type = arith | bool | comp | list | send</v>
</type>
<desc>
<p>Returns the <c>Type</c> of operator that <c>OpName/Arity</c>
belongs to,
or generates a <c>function_clause</c> error if it is not an
operator at all.</p>
</desc>
</func>
</funcs>
</erlref>
|
