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
|
%% ``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 via the world wide web at http://www.erlang.org/.
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either expressed 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 Utvecklings AB.
%% Portions created by Ericsson are Copyright 1999-2000, Ericsson
%% Utvecklings AB. All Rights Reserved.''
%%
%% $Id$
%%
-module(docb_transform).
-export([file/1, file/2]).
-deprecated([{file,1,next_major_release},
{file,2,next_major_release}]).
%% file(File) -> ok | {error, Reason}
%% file(File, Opts) -> ok | {error, Reason}
%% File = string(), file name with or without ".xml" extension
%% Opts = [Opt]
%% Reason = badfile | {badopt, Term}
file(File0) ->
file(File0, []).
file(File0, RawOpts) ->
File = filename:rootname(File0), % without extension
Ext = case filename:extension(File0) of
".xml" -> ".xml";
".sgml" -> ".sgml";
"" ->
%% If the file is given without extension, we try to
%% infer if the source file is XML or SGML.
%% SGML is supported *internally within OTP* for
%% backwards compatibility reasons.
case filelib:is_regular(File++".xml") of
true -> ".xml";
false -> ".sgml"
end;
_Ext0 -> % this is probably an error...
".xml"
end,
case filelib:is_regular(File++Ext) of
true ->
case parse(RawOpts) of
{ok, Opts0} ->
{ok, Cwd} = file:get_cwd(),
Opts = [{src_type,Ext},
{src_dir,Cwd},
{src_file,File},
{{local_defs,term},[]},
{{local_defs,cite},[]} | Opts0],
case docb_main:process(File, Opts) of
errors -> error;
ok -> ok
end;
Error -> % {error, {badopt,Term}}
Error
end;
false ->
{error, badfile}
end.
parse(RawOpts) ->
parse(RawOpts, []).
%% Officially supported options
parse([{html_mod,Module} | RawOpts], Opts) when is_atom(Module) ->
parse(RawOpts, [{html_mod,Module} | Opts]);
parse([{outdir,Dir} | RawOpts], Opts) when is_list(Dir) ->
parse(RawOpts, [{outdir,Dir} | Opts]);
parse([{number,N} | RawOpts], Opts) when is_integer(N) ->
parse(RawOpts, [{number,integer_to_list(N)} | Opts]);
parse([{number,Nstr} | RawOpts], Opts) -> % list when called from script
parse(RawOpts, [{number,Nstr} | Opts]);
parse([{ptype,Type} | RawOpts], Opts) when Type==unix;
Type==windows ->
parse(RawOpts, [{ptype,atom_to_list(Type)} | Opts]);
parse([{ptype,Type} | RawOpts], Opts) -> % list when called from script
parse(RawOpts, [{ptype,Type} | Opts]);
parse([silent | RawOpts], Opts) ->
put(option_silent, true),
parse(RawOpts, [silent | Opts]);
parse([{top,Index} | RawOpts], Opts) when is_list(Index) ->
parse(RawOpts, [{top,Index} | Opts]);
parse([{vsn,Vsn} | RawOpts], Opts) when is_list(Vsn) ->
parse(RawOpts, [{vsn,Vsn} | Opts]);
parse([{term_defs,File} | RawOpts], Opts) when is_list(File) ->
Opts2 = get_defs(term, File, Opts),
parse(RawOpts, Opts2);
parse([{cite_defs,File} | RawOpts], Opts) when is_list(File) ->
Opts2 = get_defs(cite, File, Opts),
parse(RawOpts, Opts2);
%% OTP internal options (SGML and PDF support etc.)
parse([html | RawOpts], Opts) ->
parse(RawOpts, [html | Opts]);
parse([latex | RawOpts], Opts) ->
parse(RawOpts, [latex | Opts]);
parse([{man,Level} | RawOpts], Opts) -> % Level = 1..9
parse(RawOpts, [{man,Level} | Opts]);
parse([{booksty,StyFile} | RawOpts], Opts) -> % "otpA4" | "otpBOOK"
parse(RawOpts, [{booksty,StyFile} | Opts]);
parse([{includepath,Dir} | RawOpts], Opts) ->
parse(RawOpts, [{includepath,Dir} | Opts]);
parse([showpaths | RawOpts], Opts) ->
parse(RawOpts, [showpaths | Opts]);
parse([straight | RawOpts], Opts) ->
parse(RawOpts, [straight | Opts]);
parse([{ent,Ent} | RawOpts], Opts) ->
parse(RawOpts, [{ent,Ent} | Opts]);
%% Undocumented options
parse([{name, Name} | RawOpts], Opts) ->
parse(RawOpts, [{name, Name} | Opts]);
parse([framework_only | RawOpts], Opts) ->
parse(RawOpts, [framework_only | Opts]);
parse([kwicindex_only | RawOpts], Opts) ->
parse(RawOpts, [kwicindex_only | Opts]);
parse([], Opts) ->
{ok, Opts};
parse([Opt | _RawOpts], _Opts) ->
{error, {badopt, Opt}}.
%% Type = term | cite
get_defs(Type, File, Opts) ->
Key = {defs,Type},
{PrevDefs, Opts2} =
case lists:keyfind(Key, 1, Opts) of
{_, Defs0} ->
{Defs0, lists:keydelete(Key, 1, Opts)};
false ->
{[], Opts}
end,
NewDefs = case file:consult(File) of
{ok, [DefL]} when is_list(DefL) ->
DefL;
{ok, _Terms} ->
docb_util:message(error,
"Skipping defs file ~s, does "
"not contain one list", [File]),
[];
{error, Error} ->
Expl = lists:flatten(file:format_error(Error)),
docb_util:message(error,
"Skipping defs file ~s, ~s",
[File, Expl]),
[]
end,
[{Key,PrevDefs++NewDefs} | Opts2].
|
