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
|
%%--------------------------------------------------------------------
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2009-2010. 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: erlresolvelinks.erl
%%
%% Description:
%% This file generates the javascript that resolves documentation links.
%%
%%-----------------------------------------------------------------
-module(erlresolvelinks).
-export([make/0, make/1]).
-include_lib("kernel/include/file.hrl").
-define(JAVASCRIPT_NAME, "erlresolvelinks.js").
make() ->
case os:getenv("ERL_TOP") of
false ->
io:format("Variable ERL_TOP is required\n",[]);
Value ->
make_from_src(Value, ".")
end.
make([RootDir, DestDir]) ->
do_make(RootDir, DestDir);
make(RootDir) when is_atom(RootDir) ->
DestDir = filename:join(RootDir, "doc"),
do_make(RootDir, DestDir).
do_make(_RootDir, _DestDir) ->
ok.
make_from_src(RootDir, DestDir) ->
%% doc/Dir
%% erts-Vsn
%% lib/App-Vsn
Name = ?JAVASCRIPT_NAME,
DocDirs0 = get_dirs(filename:join([RootDir, "system/doc"])),
DocDirs = lists:map(fun({Dir, _DirPath}) ->
D = filename:join(["doc", Dir]),
{D, D} end, DocDirs0),
ErtsDirs = latest_app_dirs(RootDir, ""),
AppDirs = latest_app_dirs(RootDir, "lib"),
AllAppDirs =
lists:map(
fun({App, AppVsn}) -> {App, filename:join([AppVsn, "doc", "html"])}
end, ErtsDirs ++ AppDirs),
AllDirs = DocDirs ++ AllAppDirs,
{ok, Fd} = file:open(filename:join([DestDir, Name]), [write]),
UTC = calendar:universal_time(),
io:fwrite(Fd, "/* Generated by ~s at ~w UTC */\n",
[atom_to_list(?MODULE), UTC]),
io:fwrite(Fd, "function erlhref(ups, app, rest) {\n", []),
io:fwrite(Fd, " switch(app) {\n", []),
lists:foreach(
fun({Tag, Dir}) ->
io:fwrite(Fd, " case ~p:\n", [Tag]),
io:fwrite(Fd, " location.href=ups + \"~s/\" + rest;\n",
[Dir]),
io:fwrite(Fd, " break;\n", [])
end, AllDirs),
io:fwrite(Fd, " default:\n", []),
io:fwrite(Fd, " location.href=ups + \"Unresolved\";\n", []),
io:fwrite(Fd, " }\n", []),
io:fwrite(Fd, "}\n", []),
file:close(Fd),
ok.
get_dirs(Dir) ->
{ok, Files} = file:list_dir(Dir),
AFiles =
lists:map(fun(File) -> {File, filename:join([Dir, File])} end, Files),
lists:zf(fun is_dir/1, AFiles).
is_dir({File, AFile}) ->
{ok, FileInfo} = file:read_file_info(AFile),
case FileInfo#file_info.type of
directory ->
{true, {File, AFile}};
_ ->
false
end.
latest_app_dirs(RootDir, Dir) ->
ADir = filename:join(RootDir, Dir),
RDirs0 = get_dirs(ADir),
RDirs1 = lists:filter(fun is_app_dir/1, RDirs0),
SDirs0 =
lists:map(fun({App, Dir1}) ->
File = filename:join(Dir1, "vsn.mk"),
case file:read_file(File) of
{ok, Bin} ->
case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of
{match, [VsnStr]} ->
VsnNumList = vsnstr_to_numlist(VsnStr),
{{App, VsnNumList}, App++"-"++VsnStr};
nomatch ->
io:format("No VSN variable found in ~s\n", [File]),
error
end;
{error, Reason} ->
io:format("~p : ~s\n", [Reason, File]),
error
end
end,
RDirs1),
SDirs1 = lists:keysort(1, SDirs0),
App2Dirs = lists:foldr(fun({{App, _VsnNumList}, AppVsn}, Acc) ->
case lists:keymember(App, 1, Acc) of
true ->
Acc;
false ->
[{App, AppVsn}| Acc]
end
end, [], SDirs1),
lists:map(fun({App, AppVsn}) -> {App, filename:join([Dir, AppVsn])} end,
App2Dirs).
is_app_dir({_Dir, DirPath}) ->
case file:read_file_info(filename:join(DirPath, "vsn.mk")) of
{ok, FileInfo} ->
case FileInfo#file_info.type of
regular ->
true;
_ ->
false
end;
{error, _Reason} ->
false
end.
%% is_vsnstr(Str) ->
%% case string:tokens(Str, ".") of
%% [_] ->
%% false;
%% Toks ->
%% lists:all(fun is_numstr/1, Toks)
%% end.
%% is_numstr(Cs) ->
%% lists:all(fun(C) when $0 =< C, C =< $9 ->
%% true;
%% (_) ->
%% false
%% end, Cs).
%% We know:
vsnstr_to_numlist(VsnStr) ->
lists:map(fun(NumStr) -> list_to_integer(NumStr) end,
string:tokens(VsnStr, ".")).
|
