From 2f93254d2c929d0563c2ab8152da62ee0a91ea10 Mon Sep 17 00:00:00 2001
From: Hans Bolinder <hasse@erlang.org>
Date: Thu, 8 Jul 2010 13:20:32 +0200
Subject: Prepare erl_docgen for using Dialyzer specs and types

Support for using Dialyzer specifications and types has been added.
This is an experimental release; changes are expected before the new
functionality is used when building the OTP documentation.
---
 lib/erl_docgen/priv/bin/xref_mod_app.escript | 107 +++++++++++++++++++++++++++
 1 file changed, 107 insertions(+)
 create mode 100755 lib/erl_docgen/priv/bin/xref_mod_app.escript

(limited to 'lib/erl_docgen/priv/bin/xref_mod_app.escript')

diff --git a/lib/erl_docgen/priv/bin/xref_mod_app.escript b/lib/erl_docgen/priv/bin/xref_mod_app.escript
new file mode 100755
index 0000000000..fcc3a96ada
--- /dev/null
+++ b/lib/erl_docgen/priv/bin/xref_mod_app.escript
@@ -0,0 +1,107 @@
+#!/usr/bin/env escript
+%% -*- erlang -*-
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 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%
+
+%%% Find all applications and all modules given a root directory.
+%%% Output an XML file that can be used for finding which application
+%%% a given module belongs to.
+%%%
+%%% Options:
+%%%
+%%%  "-topdir <D>"  Applications are found under D/lib/.
+%%%                 The default value is $ERL_TOP.
+%%%
+%%%  "-outfile <F>" Output is written onto F.
+%%%                 The default value is "mod2app.xml".
+%%%
+%%% The output file has the following format:
+%%%
+%%% <?xml version="1.0"?>
+%%% <mod2app>
+%%%    <module name="ModName1">AppName1</module>
+%%%    ...
+%%% <mod2app>
+%%%
+%%% meaning that module ModName1 resides in application AppName1.
+
+main(Args) ->
+    case catch parse(Args, os:getenv("ERL_TOP"), "mod2app.xml") of
+        {ok, TopDir, OutFile} ->
+            case modapp(TopDir) of
+                [] ->
+                    io:format("no applications found\n"),
+                    halt(3);
+                MA ->
+                    Layout = layout(MA),
+                    XML = xmerl:export_simple(Layout, xmerl_xml),
+                    write_file(XML, OutFile)
+            end;
+        {error, Msg} ->
+	    io:format("~s\n", [Msg]),
+	    usage()
+    end.
+
+parse(["-topdir", TopDir | Opts], _, OutFile) ->
+    parse(Opts, TopDir, OutFile);
+parse(["-outfile", OutFile | Opts], TopDir, _) ->
+    parse(Opts, TopDir, OutFile);
+parse([], TopDir, OutFile) ->
+    {ok, TopDir, OutFile};
+parse([Opt | _], _, _) ->
+    {error, io_lib:format("Bad option: ~p", [Opt])}.
+
+usage() ->
+    io:format("usage:  ~s [-topdir <dir>] [-outfile <file>]\n",
+             [escript:script_name()]),
+    halt(1).
+
+modapp(TopDir) ->
+    AppDirs = filelib:wildcard(filename:join([TopDir,"lib","*"])),
+    AM = [appmods(D) || D <- AppDirs],
+    lists:keysort(1, [{M,A} || {A,Ms} <- AM, M <- Ms]).
+
+%% It's OK if too much data is generated as long as all applications
+%% and all modules are mentioned.
+appmods(D) ->
+    ErlFiles = filelib:wildcard(filename:join([D,"src","*.erl"])),
+    AppV = filename:basename(D),
+    App = case string:rstr(AppV, "-") of
+              0 -> AppV;
+              P -> string:sub_string(AppV, 1, P-1)
+          end,
+    {App, [filename:basename(EF, ".erl") || EF <- ErlFiles]}.
+
+-include_lib("xmerl/include/xmerl.hrl").
+
+-define(IND(N), lists:duplicate(N, $\s)).
+-define(NL, "\n").
+
+layout(MAL) ->
+    ML = lists:append([[?IND(2),{module,[{name,M}],[A]},?NL] || {M,A} <- MAL]),
+    [?NL,{mod2app,[?NL|ML]},?NL].
+
+write_file(Text, File) ->
+    case file:open(File, [write]) of
+	{ok, FD} ->
+	    io:put_chars(FD, Text),
+	    ok = file:close(FD);
+	{error, R} ->
+	    R1 = file:format_error(R),
+	    io:format("could not write file '~s': ~s\n", [File, R1]),
+	    halt(2)
+    end.
-- 
cgit v1.2.3