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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
%%% This is an -*- Erlang -*- file.
%%%
%%% Licensed under the Apache License, Version 2.0 (the "License");
%%% you may not use this file except in compliance with the License.
%%% You may obtain a copy of the License at
%%%
%%% http://www.apache.org/licenses/LICENSE-2.0
%%%
%%% Unless required by applicable law or agreed to in writing, software
%%% distributed under the License is distributed on an "AS IS" BASIS,
%%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%%% See the License for the specific language governing permissions and
%%% limitations under the License.
%%%
%%%-------------------------------------------------------------------
%%% File : dialyzer.hrl
%%% Author : Tobias Lindahl <tobiasl@it.uu.se>
%%% Kostis Sagonas <kostis@it.uu.se>
%%% Description : Header file for Dialyzer.
%%%
%%% Created : 1 Oct 2004 by Kostis Sagonas <kostis@it.uu.se>
%%%-------------------------------------------------------------------
-define(RET_NOTHING_SUSPICIOUS, 0).
-define(RET_INTERNAL_ERROR, 1).
-define(RET_DISCREPANCIES, 2).
-type dial_ret() :: ?RET_NOTHING_SUSPICIOUS
| ?RET_INTERNAL_ERROR
| ?RET_DISCREPANCIES.
%%--------------------------------------------------------------------
%% Warning classification
%%--------------------------------------------------------------------
-define(WARN_BEHAVIOUR, warn_behaviour).
-define(WARN_BIN_CONSTRUCTION, warn_bin_construction).
-define(WARN_CALLGRAPH, warn_callgraph).
-define(WARN_CONTRACT_EXTRA_RETURN, warn_contract_extra_return).
-define(WARN_CONTRACT_MISSING_RETURN, warn_contract_missing_return).
-define(WARN_CONTRACT_NOT_EQUAL, warn_contract_not_equal).
-define(WARN_CONTRACT_RANGE, warn_contract_range).
-define(WARN_CONTRACT_SUBTYPE, warn_contract_subtype).
-define(WARN_CONTRACT_SUPERTYPE, warn_contract_supertype).
-define(WARN_CONTRACT_SYNTAX, warn_contract_syntax).
-define(WARN_CONTRACT_TYPES, warn_contract_types).
-define(WARN_FAILING_CALL, warn_failing_call).
-define(WARN_FUN_APP, warn_fun_app).
-define(WARN_MAP_CONSTRUCTION, warn_map_construction).
-define(WARN_MATCHING, warn_matching).
-define(WARN_NON_PROPER_LIST, warn_non_proper_list).
-define(WARN_NOT_CALLED, warn_not_called).
-define(WARN_OPAQUE, warn_opaque).
-define(WARN_OVERLAPPING_CONTRACT, warn_overlapping_contract).
-define(WARN_RETURN_NO_RETURN, warn_return_no_exit).
-define(WARN_RETURN_ONLY_EXIT, warn_return_only_exit).
-define(WARN_UNDEFINED_CALLBACK, warn_undefined_callbacks).
-define(WARN_UNKNOWN, warn_unknown).
-define(WARN_UNMATCHED_RETURN, warn_umatched_return).
%%
%% The following type has double role:
%% 1. It is the set of warnings that will be collected.
%% 2. It is also the set of tags for warnings that will be returned.
%%
-type dial_warn_tag() :: ?WARN_BEHAVIOUR | ?WARN_BIN_CONSTRUCTION
| ?WARN_CALLGRAPH | ?WARN_CONTRACT_EXTRA_RETURN
| ?WARN_CONTRACT_MISSING_RETURN | ?WARN_CONTRACT_NOT_EQUAL
| ?WARN_CONTRACT_RANGE | ?WARN_CONTRACT_SUBTYPE
| ?WARN_CONTRACT_SUPERTYPE | ?WARN_CONTRACT_SYNTAX
| ?WARN_CONTRACT_TYPES | ?WARN_FAILING_CALL
| ?WARN_FUN_APP | ?WARN_MAP_CONSTRUCTION
| ?WARN_MATCHING | ?WARN_NON_PROPER_LIST
| ?WARN_NOT_CALLED | ?WARN_OPAQUE
| ?WARN_OVERLAPPING_CONTRACT | ?WARN_RETURN_NO_RETURN
| ?WARN_RETURN_ONLY_EXIT | ?WARN_UNDEFINED_CALLBACK
| ?WARN_UNKNOWN | ?WARN_UNMATCHED_RETURN.
%%
%% This is the representation of each warning as they will be returned
%% to dialyzer's callers
%%
-type file_location() :: {File :: file:filename(),
Location :: erl_anno:location()}.
-type dial_warning() :: {Tag :: dial_warn_tag(),
Id :: file_location(),
Msg :: {atom(), [term()]}}.
%%
%% This is the representation of each warning before suppressions have
%% been applied
%%
-type m_or_mfa() :: module() % warnings not associated with any function
| mfa().
-type warning_info() :: {File :: file:filename(),
Location :: erl_anno:location(),
ModuleOrMFA :: m_or_mfa()}.
-type raw_warning() :: {Tag :: dial_warn_tag(),
Id :: warning_info(),
Msg :: {atom(), [term()]}}.
%%
%% This is the representation of dialyzer's internal errors
%%
-type dial_error() :: any(). %% XXX: underspecified
%%--------------------------------------------------------------------
%% Basic types used either in the record definitions below or in other
%% parts of the application
%%--------------------------------------------------------------------
-type anal_type() :: 'succ_typings' | 'plt_build'.
-type anal_type1() :: anal_type() | 'plt_add' | 'plt_check' | 'plt_remove' | 'incremental'.
-type contr_constr() :: {'subtype', erl_types:erl_type(), erl_types:erl_type()}.
-type contract_pair() :: {erl_types:erl_type(), [contr_constr()]}.
-type dial_define() :: {atom(), term()}.
-type warn_option() :: 'error_handling'
| 'no_behaviours'
| 'no_contracts'
| 'no_fail_call'
| 'no_fun_app'
| 'no_improper_lists'
| 'no_match'
| 'no_missing_calls'
| 'no_opaque'
| 'no_return'
| 'no_undefined_callbacks'
| 'no_underspecs'
| 'no_unknown'
| 'no_unused'
| 'underspecs'
| 'unknown'
| 'unmatched_returns'
| 'overspecs'
| 'specdiffs'
| 'extra_return'
| 'no_extra_return'
| 'missing_return'
| 'no_missing_return'.
-type dial_option() :: {'files', [FileName :: file:filename()]}
| {'files_rec', [DirName :: file:filename()]}
| {'defines', [{Macro :: atom(), Value :: term()}]}
| {'from', 'src_code' | 'byte_code'}
| {'init_plt', FileName :: file:filename()}
| {'plts', [FileName :: file:filename()]}
| {'include_dirs', [DirName :: file:filename()]}
| {'output_file', FileName :: file:filename()}
| {'metrics_file', FileName :: file:filename()}
| {'module_lookup_file', FileName :: file:filename()}
| {'output_plt', FileName :: file:filename()}
| {'check_plt', boolean()}
| {'analysis_type', 'succ_typings' |
'plt_add' |
'plt_build' |
'plt_check' |
'plt_remove' |
'incremental'}
| {'warnings', [warn_option()]}
| {'get_warnings', boolean()}
| {'use_spec', boolean()}
| {'filename_opt', filename_opt()}
| {'callgraph_file', file:filename()}
| {'mod_deps_file', file:filename()}
| {'warning_files_rec', [DirName :: file:filename()]}
| {'error_location', error_location()}.
-type dial_options() :: [dial_option()].
-type filename_opt() :: 'basename' | 'fullpath'.
-type error_location():: 'column' | 'line'.
-type format() :: 'formatted' | 'raw'.
-type iopt() :: boolean().
-type label() :: non_neg_integer().
-type dial_warn_tags():: ordsets:ordset(dial_warn_tag()).
-type rep_mode() :: 'quiet' | 'normal' | 'verbose'.
-type start_from() :: 'byte_code' | 'src_code'.
-type mfa_or_funlbl() :: label() | mfa().
-type solver() :: 'v1' | 'v2'.
%%--------------------------------------------------------------------
%% Record declarations used by various files
%%--------------------------------------------------------------------
-define(INDENT_OPT, true).
-define(ERROR_LOCATION, column).
-type doc_plt() :: 'undefined' | dialyzer_plt:plt().
-record(plt_info, {files :: [dialyzer_cplt:file_md5()],
mod_deps = dict:new() :: dialyzer_callgraph:mod_deps()}).
-record(iplt_info, {files :: [dialyzer_iplt:module_md5()],
mod_deps = dict:new() :: dialyzer_callgraph:mod_deps(),
warning_map = none :: 'none' | dialyzer_iplt:warning_map(),
legal_warnings = none :: none | dial_warn_tags()}).
-record(plt, {info :: ets:tid(), %% {mfa() | integer(), ret_args_types()}
types :: ets:tid(), %% {module(), erl_types:type_table()}
contracts :: ets:tid(), %% {mfa(), #contract{}}
callbacks :: ets:tid(), %% {module(),
%% [{mfa(),
%% dialyzer_contracts:file_contract()}]
exported_types :: ets:tid() %% {module(), sets:set()}
}).
-record(analysis, {analysis_pid :: pid() | 'undefined',
type = succ_typings :: anal_type(),
defines = [] :: [dial_define()],
doc_plt :: doc_plt(),
files = [] :: [file:filename()],
include_dirs = [] :: [file:filename()],
start_from = byte_code :: start_from(),
plt :: dialyzer_plt:plt(),
use_contracts = true :: boolean(),
behaviours_chk = false :: boolean(),
timing = false :: boolean() | 'debug',
timing_server = none :: dialyzer_timing:timing_server(),
callgraph_file = "" :: file:filename(),
mod_deps_file = "" :: file:filename(),
solvers :: [solver()]}).
-record(options, {files = [] :: [file:filename()],
files_rec = [] :: [file:filename()],
warning_files = [] :: [file:filename()],
warning_files_rec = [] :: [file:filename()],
analysis_type = succ_typings :: anal_type1(),
timing = false :: boolean() | 'debug',
defines = [] :: [dial_define()],
from = byte_code :: start_from(),
get_warnings = 'maybe' :: boolean() | 'maybe',
init_plts = [] :: [file:filename()],
include_dirs = [] :: [file:filename()],
output_plt = none :: 'none' | file:filename(),
legal_warnings = ordsets:new() :: dial_warn_tags(),
report_mode = normal :: rep_mode(),
erlang_mode = false :: boolean(),
use_contracts = true :: boolean(),
output_file = none :: 'none' | file:filename(),
output_format = formatted :: format(),
filename_opt = basename :: filename_opt(),
indent_opt = ?INDENT_OPT :: iopt(),
callgraph_file = "" :: file:filename(),
mod_deps_file = "" :: file:filename(),
check_plt = true :: boolean(),
error_location = ?ERROR_LOCATION :: error_location(),
metrics_file = none :: none | file:filename(),
module_lookup_file = none :: none | file:filename(),
solvers = [] :: [solver()]}).
-record(contract, {contracts = [] :: [contract_pair()],
args = [] :: [erl_types:erl_type()],
forms = [] :: [{_, _}]}).
%%--------------------------------------------------------------------
-define(timing(Server, Msg, Var, Expr),
begin
dialyzer_timing:start_stamp(Server, Msg),
Var = Expr,
dialyzer_timing:end_stamp(Server),
Var
end).
-define(timing(Server, Msg, Expr), ?timing(Server, Msg, _T, Expr)).
|
