erl_docgen: Add ghlink step for all non-generated doc xml files

In order to get line numbers into the ghlink we have to add a post
processing step for all xml files.

4 files changed, 61 insertions, 2 deletions

diff --git a/lib/erl_docgen/priv/bin/github_link.escript b/lib/erl_docgen/priv/bin/github_link.escript
new file mode 100755
index 0000000000..1b36fca202
--- /dev/null
+++ b/lib/erl_docgen/priv/bin/github_link.escript
@@ -0,0 +1,51 @@
+#!/usr/bin/env escript
+%% -*- erlang -*-
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2010-2016. All Rights Reserved.
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%
+%% %CopyrightEnd%
+%%----------------------------------------------------------------------
+%% File    : github_link.escript
+%%
+%% Created : 12 Dec 2017 by Lukas Larsson
+%%----------------------------------------------------------------------
+
+main([In, Filename, Sha, Out]) ->
+    {ok, Bin} = file:read_file(In),
+
+    TagsToAnnotate = ["description", "func", "datatype", "section"],
+
+    Subs = subs(TagsToAnnotate, Filename, Sha, re:split(Bin,[$\n])),
+
+    file:write_file(Out, Subs).
+
+subs([], _, _, Bin) ->
+    lists:join("\n", Bin);
+subs([Pat|Pats], Fn, Sha, Bin) ->
+    subs(Pats, Fn, Sha, sub(Bin, Pat, Fn, Sha)).
+
+sub(Bin, Pat, Fn, Sha) ->
+    sub(Bin, Pat, Fn, Sha, 1).
+sub([], _Pat, _Fn, _Sha, _Cnt) ->
+    [];
+sub([H|T], Pat, Fn, Sha, Cnt) ->
+    %% We use the maint branch here, it is not as exact as the tag,
+    %% but it is the best we can do as github does not allow doing
+    %% pullrequests on anything but branches.
+    [re:replace(H,["<",Pat,">"],
+                    ["<",Pat," ghlink=\"maint/",Fn,"#L",
+                     integer_to_list(Cnt),"\">"],[{return,list}]) |
+     sub(T, Pat, Fn, Sha, Cnt+1)].
diff --git a/lib/erl_docgen/priv/bin/xml_from_edoc.escript b/lib/erl_docgen/priv/bin/xml_from_edoc.escript
index b930ae3818..b0e3764fae 100755
--- a/lib/erl_docgen/priv/bin/xml_from_edoc.escript
+++ b/lib/erl_docgen/priv/bin/xml_from_edoc.escript
@@ -28,6 +28,7 @@
 %% Records 
 %%======================================================================
 -record(args, {suffix=".xml",
+               dir=".",
 	       layout=docgen_edoc_xml_cb,
 	       def=[],
 	       includes=[],
@@ -85,7 +86,7 @@ module(File, Args) ->
 		    
 		    {app_default, "OTPROOT"},
 		    {file_suffix, Args#args.suffix},
-		    {dir,         "."},
+		    {dir,         Args#args.dir},
 		    {layout,      Args#args.layout}],
 	    edoc:file(File, Opts);
 	false ->
@@ -118,7 +119,7 @@ users_guide(File, Args) ->
 	    Text = edoc_lib:run_layout(F, Opts),
 	    
 	    OutFile = "chapter" ++ Args#args.suffix,
-	    edoc_lib:write_file(Text, ".", OutFile, Encoding);
+	    edoc_lib:write_file(Text, Args#args.dir, OutFile, Encoding);
 	false ->
 	    io:format("~s: not a regular file\n", [File]),
 	    usage()
@@ -139,6 +140,8 @@ parse(["-def", Key, Val |RawOpts], Type, Args) ->
 parse(["-i", Dir |RawOpts], Type, Args) ->
     Args2 = Args#args{includes=Args#args.includes++[Dir]},
     parse(RawOpts, Type, Args2);
+parse(["-dir", Dir |RawOpts], Type, Args) ->
+    parse(RawOpts, Type, Args#args{dir=Dir});
 parse(["-preprocess", Bool |RawOpts], Type, Args) when Bool == "true";
 						       Bool == "false" ->
     parse(RawOpts, Type, Args#args{preprocess=list_to_atom(Bool)});
diff --git a/lib/erl_docgen/priv/dtd/chapter.dtd b/lib/erl_docgen/priv/dtd/chapter.dtd
index 8d940b90f7..3e9113d798 100644
--- a/lib/erl_docgen/priv/dtd/chapter.dtd
+++ b/lib/erl_docgen/priv/dtd/chapter.dtd
@@ -35,3 +35,4 @@
 <!ELEMENT section             (marker*,title,
                                (%block;|quote|warning|note|dont|do|br|image|marker|
                                 table|section)*) >
+<!ATTLIST section              ghlink CDATA #IMPLIED>
diff --git a/lib/erl_docgen/priv/dtd/common.refs.dtd b/lib/erl_docgen/priv/dtd/common.refs.dtd
index 172cd16ad4..07c876a17f 100644
--- a/lib/erl_docgen/priv/dtd/common.refs.dtd
+++ b/lib/erl_docgen/priv/dtd/common.refs.dtd
@@ -26,8 +26,10 @@
 %common.header;
 
 <!ELEMENT description         (%block;|quote|br|marker|warning|note|dont|do)* >
+<!ATTLIST description          ghlink CDATA #IMPLIED>
 <!ELEMENT funcs               (func)+ >
 <!ELEMENT func                (name+,fsummary,(type|type_desc)*,desc?) >
+<!ATTLIST func                 ghlink CDATA #IMPLIED>
 <!-- ELEMENT name is defined in each ref dtd -->
 <!ELEMENT fsummary            (#PCDATA|c|i|em|anno)* >
 <!ELEMENT type                (v,d?)* >
@@ -42,9 +44,11 @@
 <!ELEMENT email               (#PCDATA) >
 <!ELEMENT section             (marker*,title,(%block;|quote|br|marker|
                                warning|note|dont|do|section)*) >
+<!ATTLIST section              ghlink CDATA #IMPLIED>
 <!ELEMENT datatypes           (datatype_title?,datatype)+ >
 <!ELEMENT datatype_title      (#PCDATA) >
 <!ELEMENT datatype            (name+,desc?) >
+<!ATTLIST datatype             ghlink CDATA #IMPLIED>
 <!ELEMENT type_desc           (#PCDATA|anno|c|seealso)* >
 <!ATTLIST type_desc            variable CDATA #IMPLIED
                                name CDATA #IMPLIED>