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
|
#!/usr/bin/env escript
%% -*- erlang -*-
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2010-2011. 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 : xml_from_edoc.escript
%%
%% Created : 12 Dec 2009 by Lars Thorsen
%%----------------------------------------------------------------------
%%======================================================================
%% Records
%%======================================================================
-record(args, {suffix=".xml",
layout=docgen_edoc_xml_cb,
def=[],
includes=[],
preprocess=false,
sort_functions=true}).
%%======================================================================
%% External functions
%%======================================================================
%%----------------------------------------------------------------------
%% Function: main/1
%% Description:
%%----------------------------------------------------------------------
main(RawOpts) ->
case catch parse(RawOpts, erlref, #args{}) of
{ok, File, Type, Args} ->
case Type of
erlref ->
module(File, Args);
chapter ->
users_guide(File, Args)
end;
{error, Msg} ->
io:format("~p\n", [Msg]),
usage()
end;
main(_) ->
usage().
%%======================================================================
%% Internal functions
%%======================================================================
%%----------------------------------------------------------------------
%% Function: usage/0
%% Description:
%%----------------------------------------------------------------------
usage() ->
io:format("usage: xml_from_edoc.escript [<options>] <file> \n"),
halt(1).
%%----------------------------------------------------------------------
%% Function: module/2
%% Description:
%%----------------------------------------------------------------------
module(File, Args) ->
case filelib:is_regular(File) of
true ->
Opts = [{def, Args#args.def},
{includes, Args#args.includes},
{preprocess, Args#args.preprocess},
{sort_functions, Args#args.sort_functions},
{app_default, "OTPROOT"},
{file_suffix, Args#args.suffix},
{dir, "."},
{layout, Args#args.layout}],
edoc:file(File, Opts);
false ->
io:format("~s: not a regular file\n", [File]),
usage()
end.
%%----------------------------------------------------------------------
%% Function: users_guide/2
%% Description:
%%----------------------------------------------------------------------
users_guide(File, Args) ->
case filelib:is_regular(File) of
true ->
Opts = [{def, Args#args.def},
{app_default, "OTPROOT"},
{file_suffix, Args#args.suffix},
{layout, Args#args.layout}],
Env = edoc_lib:get_doc_env(Opts),
{ok, Tags} =
edoc_extract:file(File, overview, Env, Opts),
Data =
edoc_data:overview("Overview", Tags, Env, Opts),
F = fun(M) -> M:overview(Data, Opts) end,
Text = edoc_lib:run_layout(F, Opts),
OutFile = "chapter" ++ Args#args.suffix,
edoc_lib:write_file(Text, ".", OutFile);
false ->
io:format("~s: not a regular file\n", [File]),
usage()
end.
parse(["-xml" |RawOpts], Type, Args) ->
parse(RawOpts, Type, Args); % default, no update of record necessary
parse(["-sgml" |RawOpts], Type, Args) ->
parse(RawOpts, Type, Args#args{suffix=".sgml", layout=docgen_edoc_sgml_cb});
parse(["-chapter" |RawOpts], _Type, Args) ->
parse(RawOpts, chapter, Args);
parse(["-def", Key, Val |RawOpts], Type, Args) ->
Args2 = Args#args{def=Args#args.def++[{list_to_atom(Key), Val}]},
parse(RawOpts, Type, Args2);
parse(["-i", Dir |RawOpts], Type, Args) ->
Args2 = Args#args{includes=Args#args.includes++[Dir]},
parse(RawOpts, Type, Args2);
parse(["-preprocess", Bool |RawOpts], Type, Args) when Bool == "true";
Bool == "false" ->
parse(RawOpts, Type, Args#args{preprocess=list_to_atom(Bool)});
parse(["-sort_functions", Bool |RawOpts], Type, Args) when Bool == "true";
Bool == "false" ->
parse(RawOpts, Type, Args#args{sort_functions=list_to_atom(Bool)});
parse([File], Type, Args) ->
{ok, File, Type, Args};
parse([Opt | _RawOpts], _Type, _Args) ->
{error, io_lib:format("Bad option: ~p", [Opt])}.
|
