#! /usr/local/bin/ruby
+# Usage: mkman.rb SRCDIR DSTDIR
+
#¼Â¹Ô¤¹¤ë¤È/tmp/doxyman¤ò¤Ä¤«¤Ã¤Æ¥Õ¥¡¥¤¥ë¤òʬ¤±¡¢
#¤â¤È¤Îdirectory¤Ë¤«¤¤Ê¤ª¤¹¡£
# see also ¤ÎÃæ¿È¤ò woman ¸þ¤±¤Ë½ñ¤´¹¤¨¤ë¡£
-usr_or_ja=$*[0]
+$manext="."+$*[0]
#
# Setting up directory names.
#
$currentdir = Dir.pwd+"/"
+$srcdir=$currentdir+$*[1]+"/"
+$dstdir=$currentdir+$*[2]+"/"
$doxywork = $currentdir+"doxywork/"
-$srcman3 = $currentdir+usr_or_ja+"/man/man3/"
-if usr_or_ja == "usr"
- $dstman3m = $currentdir+"/man/man3m/"
-else
- $dstman3m = $currentdir+"/man/ja/man3m/"
-end
$sampledir="sample/man3/"
+$headfile = $currentdir+"manhead"
+
+headbuf = open($headfile, "r").readlines
#
# Extra information about header strings Doxygen generates in a man file.
def datastructure(struct)
- text = open(struct.concat(".3m"),"r").readlines
+ text = open(struct.concat($manext),"r").readlines
buf = []
#short_text¤Î´Ø¿ô̾¤Î£²¹Ô¸å¤¬brief¡£
brief = short_text[short_text.index(short_text.find{|i| i.index(ffname)}) + 2]
#´Ø¿ô¤´¤È¤Î¥Õ¥¡¥¤¥ë¤òºî¤ë¡£
- file = open($doxywork+fname+".3m", "w")
+ file = open($doxywork+fname+$manext, "w")
file.puts("@function")
#¥Ø¥Ã¥À
/^\.TH \"([^"]*)\"\s/ =~ title
title = text[0].split(" ")[1].chop!.reverse.chop!.reverse
- if text.index("\\fBReturns: \\fP\n") == nil
- print title, ": Returns not described\n"
- end
- if text.index("\\fBErrors: \\fP\n") == nil
- print title, ": Errors not described\n"
- end
-
buf.push(".ad l\n.nh\n.SH NAME\n")
# if @brief is given
if text[1] =~ /\"\\fI(.+)\\fP\"/
description == []
print title, ": No description found\n"
else
- buf.push("\n.SH DESCRIPTION\n").push(womanrewrite(desrewrite(description)))
+ descriptiontext = womanrewrite(desrewrite(description))
+ buf.push("\n.SH DESCRIPTION\n").push(descriptiontext)
end
return buf
end
####non-synopsys section of a function
def desrewrite(text)
+ returndescribed = false
+ errordescribed = false
#removing identation
text.grep(/^\\fB.+\\fP/){|line|
text.each_with_index{|line,i|
+### TEST 6/24
+ line.gsub!(".RS 4","")
+
+### letting verbatim end in place
+ line.gsub!(/^.nf/,".NF")
+
#removing "More..." hyperlink
line.gsub!(/More.../,"")
# ? ad hoc
line.gsub!(/^\.TP/,"")
#headers
- line.gsub!(/^\\fBReturn value:\\fP/,"\n.SH RETURNS\n.PP")
- line.gsub!(/^\\fBSee Also:\\fP/,"\n.SH \"SEE ALSO\"\n.PP")
+ if line =~ /Return\svalue:/
+ returndescribed = true
+ end
+ line.gsub!(/^\\fBReturn value:\\fP/,"\n.SH RETURN VALUE\n.PP")
+ if line =~ /Errors:/
+ errordescribed = true
+ end
line.gsub!(/^\\fBErrors:\\fP/,"\n.SH ERRORS\n.PP")
+ line.gsub!(/^\\fBSee Also:\\fP/,"\n.SH \"SEE ALSO\"\n.PP")
- line.gsub!(/^\\fB(.+)\\fP/){"\n.SS " << $1}
+ line.gsub!(/^\\fB(.+)[^\)]\\fP/){"\n.SS " << $1}
+ # [^\)] in the pattern is added to avoid the first function in see also section.
#removing indentation
if text[i - 1] =~ /^.PP/
}
+unless returndescribed == true
+ print (" return not described \n")
+end
+unless errordescribed == true
+ print (" errors not described \n")
+end
+
return text
end
text.each_with_index{|line,i|
line.gsub!(/More.../,"")
+
+ ### let verbatim end in place
+ line.gsub!(/^.nf/,".NF")
# let the library name appear in the header
if line =~ /^.TH/
Dir.mkdir $doxywork unless FileTest.directory? $doxywork
-Dir.chdir($srcman3)
+Dir.chdir($srcdir)
Dir.open(".").each{|filename|
+
if FileTest.directory? filename
next
end
#############################rewriting files
-Dir.chdir($dstman3m)
+Dir.chdir($dstdir)
Dir.open(".").each{|f| File.delete(f) if FileTest.file?(f)}
else buf = orewrite(text)
end
- filetowrite = open($dstman3m+filename,"w")
+ filetowrite = open($dstdir+filename,"w")
+ filetowrite.puts(headbuf)
filetowrite.puts(buf)
filetowrite.flush
end