#! /usr/local/bin/ruby
+# Usage: mkman.rb SRCDIR DSTDIR -*- coding: euc-jp; -*-
+
#¼Â¹Ô¤¹¤ë¤È/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+"/usr/man3m/"
-else
- $dstman3m = $currentdir+"/ja/man3m/"
-end
$sampledir="sample/man3/"
+# fixed text
+
$headfile = $currentdir+"manhead"
+$footfile = $currentdir+"manfoot"
+
headbuf = open($headfile, "r").readlines
+footbuf = open($footfile, "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 = []
### ¥Õ¥¡¥¤¥ëʬ¤±
def documentfunc(title, func_text, short_text)
+ residue = []
func_text.grep(/^\.SS/){|i|
- #¼«Ê¬¤è¤ê¸å¤í¤À¤±
- func_rest = func_text[func_text.index(i)..func_text.size]
- documentfunc2(i, title, func_rest, short_text)}
-end
+ #¼«Ê¬¤È¤½¤Î¸å¤í
+ func_rest = func_text[func_text.index(i) ..func_text.size]
+ if funclast = func_rest.index(func_rest[1 .. func_rest.size].find{|m| m =~ /^\.SS/})
+ func_desc = func_rest[0 .. funclast - 1]
+ else
+ func_desc = func_rest
+ end
-def documentfunc2 (dstart, title, func_text, short_text)
- #func_text¤ÎºÇ½é¤Î¹ÔÃæ¤Î´Ø¿ô̾
+ #fname: func_text¤ÎºÇ½é¤Î¹ÔÃæ¤Î´Ø¿ô̾
+ i =~ /\s([a-z0-9_]+)\s\(/
+ if $1 == nil
+ else
+ fname = $1
+ ffname = "\\fB".concat($1.concat("\\fP"))
+ #short_text¤Î´Ø¿ô̾¤Î£²¹Ô¸å¤¬brief¡£
+ if short_text.find{|i| i.index(ffname)}
+ brief = short_text[short_text.index(short_text.find{|i| i.index(ffname)}) + 2]
+ documentfunc2(fname, title, func_desc, brief)
+ else # obsolete function ¤Î¾ì¹ç
+ residue.push(func_desc)
+ end
+ end
+ }
+ return residue
+end
- dstart =~ /\s([a-z0-9_]+)\s\(/
- return if $1 == nil
- fname = $1
+def documentfunc2 (fname, title, func_desc, brief)
- ffname = "\\fB".concat($1.concat("\\fP"))
- #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
else file.print("\n")
end
#¥í¥ó¥°
- file.puts(func_text[0])
- for line in func_text[1 .. func_text.size]
- break if /.SS/ =~ line
- file.puts(line)
- end
+ file.puts(func_desc)
+# for line in func_desc[1 .. func_desc.size]
+# break if /.SS/ =~ line
+# file.puts(line)
+# end
file.flush
- end
+ file.close
+end
+
+# Extract documentation for each program and write out manuals.
+def documentprog (text)
+ header = text[0]
+ progtext = []
+ title = ""
+ brief = ""
+ text.each_with_index{|line,i|
+ if line =~ /^\.SH\s*\"(\S+) -- ([^\"]+)\"/
+ # Remember the title and short description. It may or may not
+ # be for a program.
+ title = $1
+ brief = $2
+ elsif line =~ /^\.SS\s*"SYNOPSIS"/
+ # Only a program has "SYNOPSIS".
+ progtext.push(header.gsub("m17nExProg",title))
+ progtext.push(".ad l\n.nh\n.SH NAME\n")
+ progtext.push(title + " - " + brief)
+ progtext.push(".SH SYNOPSIS")
+ elsif line =~ /^\.PD 0/
+ # Don't write this "inter-paragraph vertical distance" command
+ elsif line =~ /Print this message./
+ # This is always the end of description for a program.
+ if progtext.length > 0
+ file = open($doxywork+title+$manext,"w")
+ file.puts(progtext)
+ file.puts(line)
+ file.close
+ progtext = []
+ end
+ elsif progtext.length > 0
+ if line =~ /^\.SS\s*(.*)/
+ # Convert ".SS ..." to ".SH ..."
+ progtext.push(".SH " + $1)
+ else
+ progtext.push(line)
+ end
+ end
+ }
+end
####rewriting each man file
### rewriting a man file for a function
def frewrite(text)
-# let the library name appear in the header
- buf = [text[0].gsub!("\" \"", "\" \"\" \"")]
+
+ # let the library name appear in the header (for old buggy doxygen)
+ # buf = [text[0].gsub!(/\" \"/, "\" \"\" \"")]
+ buf = [text[0]]
title = text[0].split(" ")[1].chop!.reverse.chop!.reverse
buf.push(".ad l\n.nh\n.SH NAME\n")
# if @brief is given
if text[1] =~ /\"\\fI(.+)\\fP\"/
- buf.push(title.concat(" \- ").concat($1))
- else buf.push(title)
+ buf.push(title.concat(" \\- ").concat($1))
+ else buf.push(title.concat(" \\- "))
end
synopsys = text.find{|line| line =~ /\.SS/}
- buf.push("\n\n.SH SYNOPSIS").push(formatsynopsys(synopsys)).push("\n")
-
- description = text[text.index(synopsys)+2..text.size]
- if
- description == []
- print title, ": No description found\n"
- else
- descriptiontext = womanrewrite(desrewrite(description))
- buf.push("\n.SH DESCRIPTION\n").push(descriptiontext)
- end
+ buf.push("\n\n.SH SYNOPSIS").push(formatsynopsys(synopsys)).push("\n")
+
+ description = text[text.index(synopsys)+2..text.size]
+ if
+ description == []
+ print title, ": No description found\n"
+ else
+ descriptiontext = womanrewrite(desrewrite(description))
+ buf.push("\n.SH DESCRIPTION\n").push(descriptiontext)
+ end
return buf
end
ind = text.index(line)
text.delete_at(ind+1) if text[ind+1] == (".in +1c\n")}
+### letting verbatim end in place Part1
+ verbatim = false
text.each_with_index{|line,i|
-### TEST 6/24
- line.gsub!(".RS 4","")
+### TEST 2008/3/3
+ line.gsub!(/\.RS 4/,"\n.RS 4")
+# line.gsub!(/^\.RE/,"")
-### letting verbatim end in place
- line.gsub!(/^.nf/,".NF")
+### letting verbatim end in place Part2
+ if line =~ /^\.nf/
+ verbatim = true
+ end
+
+ if verbatim == true
+ if line =~ /^\.PP/
+ line.gsub!(/^\.PP/,".fi")
+ verbatim = false
+ end
+ end
#removing "More..." hyperlink
line.gsub!(/More.../,"")
# ? ad hoc
line.gsub!(/^\.TP/,"")
+
#headers
if line =~ /Return\svalue:/
returndescribed = true
end
line.gsub!(/^\\fBReturn value:\\fP/,"\n.SH RETURN VALUE\n.PP")
+ line.gsub!(/^\\fBReturn value:\s\\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!(/^\\fBSee Also:/,"\n.SH \"SEE ALSO\"\n.PP\n\\fB")
+ line.gsub!(/^\\fBExample:\\fP/,"\n.SH Example:\n.PP\n")
- line.gsub!(/^\\fB(.+)[^\)]\\fP/){"\n.SS " << $1}
+ #test 2008/3/4 is there other headers? line.gsub!(/^\\fB(.+)[^\)]\\fP/){"\n.SS " << $1}
# [^\)] in the pattern is added to avoid the first function in see also section.
#removing indentation
end end 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/
- line = line.gsub!("\" \"", "\" \"\" \"")
- end
+ ### changes the type of list, and indentation
+ # if line =~ /^.IP/
+ # line = ".TP"
+ # text[i+2] = ""
+ # end
+
+ # if line =~ /^.TP/
+ # text[i+2] = ""
+ # end
+
+ # let the library name appear in the header (for old buggy doxygen)
+ # if line =~ /^.TH/
+ # line = line.gsub!(/\" \"/, "\" \"\" \"")
+ # end
# finding structure documentations and merging into "structures"
if line =~ /^\.RI\s\"struct\s\\fB(.*)\\fP\"/
end
#removing extra "-"
- if text[i - 1] =~ /^.SH\sNAME/
- if line =~ /\\-/
- unless line =~ /\\-\s./
- line.chop!.chop!.chop!.chop!
- end
- end
- end
-
+# if text[i - 1] =~ /^.SH\sNAME/
+# if line =~ /\\-/
+# unless line =~ /\\-\s./
+# line.chop!.chop!.chop!.chop!
+# end
+# end
+# end
+
+ if text[i-2] =~ /^.SH\sNAME/ && text[i] =~ /^.PP/ && text[i+1] =~ /./
+ # Convert this line sequence:
+ # .SH NAME
+ # M-text \-
+ # .PP
+ # M-text objects and API for them.
+ # to:
+ # .SH NAME
+ # M-text \- M-text objects and API for them.
+ prevline = buf.pop.chop!.chop!.chop!.chop!.chop!.gsub(" ","_").concat(" \\- ")
+ text[i+1] = prevline.concat(text[i+1])
+ else
#removing author section
line.gsub!(/^\.SH\s\"AUTHOR\"/,"")
- line.gsub!("Generated automatically by Doxygen for m17n_test from the source code.","")
+ line.gsub!(/Generated automatically by Doxygen for m17n_test from the source code\./,"")
+
+ line.gsub!(/^\\fBSee Also:\\fP/,"\n\\fBSEE ALSO\\fp\n")
+ line.gsub!(/^\\fBReturn value:\\fP/,"\n\\fBRETURN VALUE\\fp\n")
+ line.gsub!(/More.../,"")
line.gsub!(/\\fP\s+,/,"\\fP,")
line.gsub!(/\\fP\s+\./,"\\fP.")
line.gsub!(/\\fC\\fB(\w+)\\fP\\fP/){"\\fB" << $1 << "\\fP"}
-
buf.push(line)
+ end
}
unless structures == ["\.SH \"Data Structure Documentation\"\n"]
Dir.mkdir $doxywork unless FileTest.directory? $doxywork
-Dir.chdir($srcman3)
+Dir.chdir($srcdir)
Dir.open(".").each{|filename|
-
- if FileTest.directory? filename
- next
- end
-
- #if filename =~ /\.c\./
- # next
- #end
-
- file = open(filename,"r")
- text = file.readlines
- title = text[0]
-
- if
- sfunctionstart = text.index(text.find{|i| i == $flheader})
- if sfunctionend = text.index(text[sfunctionstart+1 .. text.size].find{|i| i =~ /^\.SS|^\.SH/})
+
+ if FileTest.directory? filename
+ next
+ end
+
+ if filename =~ /\.[ch]\./
+ next
+ end
+
+ if filename =~ /\.txt\./
+ next
+ end
+
+ print "RUBY DIVIDING: ", filename, "\n"
+
+ file = open(filename,"r")
+ text = file.readlines
+ title = text[0]
+
+ if filename =~ /m17nExProg.1/
+ documentprog(text)
+ else
+
+ if sfunctionstart = text.index(text.find{|i| i == $flheader})
+ if sfunctionend = text.index(text[sfunctionstart+1 .. text.size].find{|i| i =~ /^\.SS|^\.SH/})
short_text = text[sfunctionstart .. sfunctionend - 1]
- else
+ else
short_text = text[sfunctionstart .. text.size - 1]
- end
-
- if lfunctionstart = text.index(text.find{|i| i == $fdheader})
- if lfunctionend = text.index(text[lfunctionstart+1 .. text.size].find{|i| i =~ /^\.SH/})
- func_text = text[lfunctionstart .. lfunctionend - 1]
- group_text = text[0 .. lfunctionstart - 1] + text[lfunctionend ..text.size]
- else
- func_text = text[lfunctionstart .. text.size]
- group_text = text[0 .. lfunctionstart - 1]
end
+
+ if lfunctionstart = text.index(text.find{|i| i == $fdheader})
+ if lfunctionend = text.index(text[lfunctionstart+1 .. text.size].find{|i| i =~ /^\.SH/})
+ func_text = text[lfunctionstart .. lfunctionend - 1]
+ group_text = text[0 .. lfunctionstart - 1] + text[lfunctionend ..text.size]
+ else
+ func_text = text[lfunctionstart .. text.size]
+ group_text = text[0 .. lfunctionstart - 1]
+ end
else
- func_text = []
- group_text = text
- end
-
- documentfunc(title, func_text, short_text)
+ func_text = []
+ group_text = text
+ end
+
+ residue = documentfunc(title, func_text, short_text)
+
+ if residue == []
+ else
+ group_text = group_text + [".SH \"Function Documentation\"\n.PP\n"] + residue
+ end
+
+ else
+
+ group_text = text
+
+ end
- else
-
- group_text = text
-
+ filetowrite = open($doxywork+filename,"w")
+ filetowrite.puts(group_text)
+ filetowrite.flush
+ filetowrite.close
end
-
- filetowrite = open($doxywork+filename,"w")
- filetowrite.puts(group_text)
- filetowrite.flush
+ file.close
}
#############################rewriting files
-Dir.chdir($dstman3m)
+Dir.chdir($dstdir)
Dir.open(".").each{|f| File.delete(f) if FileTest.file?(f)}
next
end
- print "PROCESSING: ", filename, "\n"
+ print "RUBY REWRINTING: ", filename, "\n"
if /@function/ =~ text[0]
buf = frewrite(text[1..text.size])
else buf = orewrite(text)
end
- filetowrite = open($dstman3m+filename,"w")
+ filetowrite = open($dstdir+filename,"w")
filetowrite.puts(headbuf)
filetowrite.puts(buf)
+ filetowrite.puts(footbuf)
filetowrite.flush
+ filetowrite.close
+ file.close
end
}
projects / m17n / m17n-docs.git / blobdiff