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
|
%% -*- erlang-indent-level: 2 -*-
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2006-2009. All Rights Reserved.
%%
%% 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.
%%
%% %CopyrightEnd%
%%
%%===========================================================================
%% File : typer_options.erl
%% Author : Bingwen He <[email protected]>
%% Description : Handles all command-line options given to TypEr
%%===========================================================================
-module(typer_options).
-export([process/0]).
%%---------------------------------------------------------------------------
-include("typer.hrl").
%%---------------------------------------------------------------------------
%% Exported functions
%%---------------------------------------------------------------------------
-spec process() -> {#args{}, #typer_analysis{}}.
process() ->
ArgList = init:get_plain_arguments(),
%% io:format("Args is ~p\n",[Args]),
{Args, Analysis} = analyze_args(ArgList, #args{}, #typer_analysis{}),
%% if the mode has not been set, set it to the default mode (show)
{Args, case Analysis#typer_analysis.mode of
undefined -> Analysis#typer_analysis{mode = ?SHOW};
Mode when is_atom(Mode) -> Analysis
end}.
%%---------------------------------------------------------------------------
%% Internal functions
%%---------------------------------------------------------------------------
analyze_args([], Args, Analysis) ->
{Args, Analysis};
analyze_args(ArgList, Args, Analysis) ->
{Result, Rest} = cl(ArgList),
{NewArgs, NewAnalysis} = analyze_result(Result, Args, Analysis),
analyze_args(Rest, NewArgs, NewAnalysis).
cl(["-h"|_]) -> help_message();
cl(["--help"|_]) -> help_message();
cl(["-v"|_]) -> version_message();
cl(["--version"|_]) -> version_message();
cl(["--comments"|Opts]) -> {comments, Opts};
cl(["--show"|Opts]) -> {{mode, ?SHOW}, Opts};
cl(["--show_exported"|Opts]) -> {{mode, ?SHOW_EXPORTED}, Opts};
cl(["--show-exported"|Opts]) -> {{mode, ?SHOW_EXPORTED}, Opts};
cl(["--annotate"|Opts]) -> {{mode, ?ANNOTATE}, Opts};
cl(["--annotate-inc-files"|Opts]) -> {{mode, ?ANNOTATE_INC_FILES}, Opts};
cl(["--plt",Plt|Opts]) -> {{plt, Plt}, Opts};
cl(["-D"++Def|Opts]) ->
case Def of
"" -> typer:error("no variable name specified after -D");
_ ->
L = re:split(Def, "=", [{return, list}]),
DefPair = process_def_list(L),
{{def, DefPair}, Opts}
end;
cl(["-I",Dir|Opts]) -> {{inc,Dir}, Opts};
cl(["-I"++Dir|Opts]) ->
case Dir of
"" -> typer:error("no include directory specified after -I");
_ -> {{inc, Dir}, Opts}
end;
cl(["-T"|Opts]) ->
{Files, RestOpts} = dialyzer_cl_parse:collect_args(Opts),
case Files of
[] -> typer:error("no file or directory specified after -T");
[_|_] -> {{trust, Files}, RestOpts}
end;
cl(["-r"|Opts]) ->
{Files, RestOpts} = dialyzer_cl_parse:collect_args(Opts),
{{a_dir_r, Files}, RestOpts};
cl(["-"++H|_]) -> typer:error("unknown option -"++H);
cl(Opts) ->
{Args, RestOpts} = dialyzer_cl_parse:collect_args(Opts),
{{analyze, Args}, RestOpts}.
process_def_list(L) ->
case L of
[Name, Value] ->
{ok, Tokens, _} = erl_scan:string(Value ++ "."),
{ok, ErlValue} = erl_parse:parse_term(Tokens),
{list_to_atom(Name), ErlValue};
[Name] ->
{list_to_atom(Name), true}
end.
%% Get information about files that the user trusts and wants to analyze
analyze_result({analyze, Val}, Args, Analysis) ->
NewVal = Args#args.analyze ++ Val,
{Args#args{analyze = NewVal}, Analysis};
analyze_result({a_dir_r, Val}, Args, Analysis) ->
NewVal = Args#args.analyzed_dir_r ++ Val,
{Args#args{analyzed_dir_r = NewVal}, Analysis};
analyze_result({trust, Val}, Args, Analysis) ->
NewVal = Args#args.trust ++ Val,
{Args#args{trust = NewVal}, Analysis};
analyze_result(comments, Args, Analysis) ->
{Args, Analysis#typer_analysis{contracts = false}};
%% Get useful information for actual analysis
analyze_result({mode, Val}, Args, Analysis) ->
case Analysis#typer_analysis.mode of
undefined -> {Args, Analysis#typer_analysis{mode = Val}};
_ -> mode_error()
end;
analyze_result({def, Val}, Args, Analysis) ->
NewVal = Analysis#typer_analysis.macros ++ [Val],
{Args, Analysis#typer_analysis{macros = NewVal}};
analyze_result({inc, Val}, Args, Analysis) ->
NewVal = Analysis#typer_analysis.includes ++ [Val],
{Args, Analysis#typer_analysis{includes = NewVal}};
analyze_result({plt, Plt}, Args, Analysis) ->
{Args, Analysis#typer_analysis{plt = Plt}}.
%%--------------------------------------------------------------------
-spec mode_error() -> no_return().
mode_error() ->
typer:error("can not do \"show\", \"show-exported\", \"annotate\", and \"annotate-inc-files\" at the same time").
-spec version_message() -> no_return().
version_message() ->
io:format("TypEr version "++?VSN++"\n"),
erlang:halt(0).
-spec help_message() -> no_return().
help_message() ->
S = " Usage: typer [--help] [--version] [--comments] [--plt PLT]
[--show | --show-exported | --annotate | --annotate-inc-files]
[-Ddefine]* [-I include_dir]* [-T application]* [-r] file*
Options:
-r dir*
search directories recursively for .erl files below them
--show
Prints type specifications for all functions on stdout.
(this is the default behaviour; this option is not really needed)
--show-exported (or --show_exported)
Same as --show, but prints specifications for exported functions only
Specs are displayed sorted alphabetically on the function's name
--annotate
Annotates the specified files with type specifications
--annotate-inc-files
Same as --annotate but annotates all -include() files as well as
all .erl files (use this option with caution - has not been tested much)
--comments
Prints type information using Edoc comments, not type specs
--plt PLT
Use the specified dialyzer PLT file rather than the default one
-T file*
The specified file(s) already contain type specifications and these
are to be trusted in order to print specs for the rest of the files
(Multiple files or dirs, separated by spaces, can be specified.)
-Dname (or -Dname=value)
pass the defined name(s) to TypEr
(The syntax of defines is the same as that used by \"erlc\".)
-I include_dir
pass the include_dir to TypEr
(The syntax of includes is the same as that used by \"erlc\".)
--version (or -v)
prints the Typer version and exits
--help (or -h)
prints this message and exits
Note:
* denotes that multiple occurrences of these options are possible.
",
io:put_chars(S),
erlang:halt(0).
|
