*** empty log message ***

[m17n/m17n-docs.git] / utils / mkman.rb

diff --git a/utils/mkman.rb b/utils/mkman.rb
index a503b24..f695ff1 100644 (file)
--- a/utils/mkman.rb
+++ b/utils/mkman.rb
@@ -1,23 +1,24 @@
 #! /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.
@@ -84,7 +85,7 @@ def  writedocumentation(buf, text, index)
 
 def datastructure(struct)
 
-   text = open(struct.concat(".3m"),"r").readlines
+   text = open(struct.concat($manext),"r").readlines
 
    buf = []
 
@@ -142,6 +143,8 @@ def datastructure(struct)
        nl = fdline + 1 
        writedocumentation(buf, text, nl)
    end
+   
+#   File.delete(struct) if FileTest.file?(struct)
 
 return buf
 end
@@ -159,7 +162,7 @@ end
 def documentfunc2 (dstart, title, func_text, short_text)
  #func_text¤ÎºÇ½é¤Î¹ÔÃæ¤Î´Ø¿ô̾
 
-   dstart =~ /\s([a-z_]+)\s\(/
+   dstart =~ /\s([a-z0-9_]+)\s\(/
    return if $1 == nil
    fname = $1
 
@@ -167,7 +170,7 @@ def documentfunc2 (dstart, title, func_text, short_text)
  #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
@@ -199,13 +202,6 @@ def frewrite(text)
 
   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\"/
@@ -221,7 +217,8 @@ def frewrite(text)
     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
@@ -242,6 +239,8 @@ end
 ####non-synopsys section of a function
 
 def desrewrite(text)
+  returndescribed = false 
+  errordescribed = false
 
 #removing identation
   text.grep(/^\\fB.+\\fP/){|line| 
@@ -251,17 +250,30 @@ def desrewrite(text)
 
   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/
@@ -289,6 +301,13 @@ def desrewrite(text)
 
   }
 
+unless returndescribed == true 
+       print (" return not described \n")
+end 
+unless errordescribed == true 
+       print (" errors not described \n")
+end 
+
 return text
 end
 
@@ -324,6 +343,9 @@ def orewrite(text)
 
   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/
@@ -378,16 +400,17 @@ end
 
 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   
+     #if filename =~ /\.c\./
+     #   next
+     #end   
 
      file = open(filename,"r") 
      text = file.readlines
@@ -429,7 +452,7 @@ Dir.open(".").each{|filename|
 
 #############################rewriting files
 
-Dir.chdir($dstman3m)
+Dir.chdir($dstdir)
 
 Dir.open(".").each{|f|  File.delete(f) if FileTest.file?(f)}
 
@@ -438,19 +461,23 @@ Dir.chdir($doxywork)
 Dir.open(".").each{|filename|
 unless FileTest.directory? filename
 
-   print "PROCESSING: ", filename, "\n"
+     file = open(filename,"r") 
+        text = file.readlines
 
-    file = open(filename,"r") 
-    text = file.readlines
+     if text.include?($fielddheader)
+        next 
+        end
 
- if /@function/ =~ text[0]  
-    buf = frewrite(text[1..text.size])
-    else buf = orewrite(text)
- end
+     print "PROCESSING: ", filename, "\n"
 
-  filetowrite = open($dstman3m+filename,"w")
-  filetowrite.puts(buf)
-  filetowrite.flush
+     if /@function/ =~ text[0]  
+        buf = frewrite(text[1..text.size])
+        else buf = orewrite(text)
+      end
 
+     filetowrite = open($dstdir+filename,"w")
+     filetowrite.puts(headbuf)
+     filetowrite.puts(buf)
+     filetowrite.flush
 end
 }