*** empty log message ***
[m17n/m17n-docs.git] / utils / mkman.rb
index 303fc78..78b857f 100644 (file)
@@ -1,25 +1,23 @@
 #! /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
 
 #
@@ -87,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 = []
 
@@ -155,24 +153,38 @@ end
 ### ¥Õ¥¡¥¤¥ëʬ¤±
 
 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
@@ -187,20 +199,22 @@ def documentfunc2 (dstart, title, func_text, short_text)
      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
 
 ####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!("\" \"", "\" \"\" \"")]
+  buf = [text[0].gsub!(/\" \"/, "\" \"\" \"")]
 
   title =  text[0].split(" ")[1].chop!.reverse.chop!.reverse
 
@@ -212,16 +226,16 @@ def frewrite(text)
   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
 
@@ -249,17 +263,32 @@ def desrewrite(text)
                      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","")
+  line.gsub!(/^\.RS 4/,"")
+
+### 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
@@ -342,10 +371,24 @@ def orewrite(text)
 
   text.each_with_index{|line,i|
              line.gsub!(/More.../,"")
+     
+     ### let verbatim end in place
+        line.gsub!(/^.nf/,".NF")
+
+     ### test1/16/2004   changes the type of list, and indentation
+        if line =~ /^.IP/
+           line = ".TP"
+          text[i+2] = ""
+          end
+
+        if line =~ /^.TP/
+          text[i+2] = ""
+          end
+     ### end of test1/20/2004
 
      # let the library name appear in the header 
               if line =~ /^.TH/
-                 line = line.gsub!("\" \"", "\" \"\" \"")
+                 line = line.gsub!(/\" \"/, "\" \"\" \"")
              end
 
      # finding structure documentations and merging into "structures"
@@ -371,7 +414,7 @@ def orewrite(text)
 
      #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!(/\\fP\s+,/,"\\fP,")
              line.gsub!(/\\fP\s+\./,"\\fP.")
@@ -396,7 +439,7 @@ end
 
 Dir.mkdir $doxywork unless FileTest.directory? $doxywork
 
-Dir.chdir($srcman3)
+Dir.chdir($srcdir)
 
 Dir.open(".").each{|filename|
 
@@ -404,9 +447,15 @@ Dir.open(".").each{|filename|
        next
      end   
 
-     #if filename =~ /\.c\./
-     #   next
-     #end   
+     if filename =~ /\.[ch]\./
+        next
+     end   
+
+     if filename =~ /\.txt\./
+        next
+     end   
+
+     print "RUBY DIVIDING: ", filename, "\n"
 
      file = open(filename,"r") 
      text = file.readlines
@@ -420,20 +469,25 @@ Dir.open(".").each{|filename|
         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/})
+    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 
+        else 
          func_text = text[lfunctionstart .. text.size]
          group_text = text[0 .. lfunctionstart - 1]
-      end
+       end
       else 
        func_text = [] 
        group_text = text  
-   end
+    end
+
+  residue = documentfunc(title, func_text, short_text)
 
-   documentfunc(title, func_text, short_text)
+  if residue == []
+     else 
+     group_text = group_text + [".SH \"Function Documentation\"\n.PP\n"] + residue
+  end
 
   else
   
@@ -448,7 +502,7 @@ Dir.open(".").each{|filename|
 
 #############################rewriting files
 
-Dir.chdir($dstman3m)
+Dir.chdir($dstdir)
 
 Dir.open(".").each{|f|  File.delete(f) if FileTest.file?(f)}
 
@@ -464,14 +518,14 @@ unless FileTest.directory? filename
         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.flush