Reify bytevector? in the correct module

[bpt/guile.git] / libguile / guile-snarf.awk.in

diff --git a/libguile/guile-snarf.awk.in b/libguile/guile-snarf.awk.in
index 9fa44aa..8a720a0 100644 (file)
--- a/libguile/guile-snarf.awk.in
+++ b/libguile/guile-snarf.awk.in
@@ -1,3 +1,20 @@
+#  Copyright (C) 1999, 2000, 2001, 2006 Free Software Foundation, Inc.
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation; either version 3, or (at
+# your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public
+# License along with this software; see the file COPYING.LESSER.  If
+# not, write to the Free Software Foundation, Inc., 51 Franklin
+# Street, Fifth Floor, Boston, MA 02110-1301 USA
+#
 # Written by Greg J. Badros, <gjb@cs.washington.edu>
 # 12-Dec-1999
 
@@ -32,6 +49,7 @@ BEGIN { FS="|";
                 sub(/^[ \t]*/,"",location);
                 sub(/[ \t]*$/,"",location);
                 sub(/: /,":",location);
+                sub(/^\.\//,"",location);
                 # Now whittle copy down to just the $1 field
                 #   (but do not use $1, since it hasn't been
                  #    altered by the above regexps)
@@ -39,30 +57,77 @@ BEGIN { FS="|";
                 sub(/ \)/,")",copy);
                 # Now `copy' contains the nice scheme proc "prototype", e.g.
                 # (set-car! pair value)
+                 # Since this is destined to become Texinfo source,
+                 # quote any `@'s that occur in the prototype.
+                 gsub(/\@/,"@@",copy);
                 # print copy > "/dev/stderr";  # for debugging
+                sub(/^\(/,"",copy);
+                sub(/\)[ \t]*$/,"",copy);
                 proc_and_args = copy;
                 curr_function_proto = copy;
+                proc_name = copy;
+                sub(/ .*$/,"",proc_name);
                 sub(/[^ \n]* /,"",proc_and_args);
-                sub(/\)[ \t]*/,"",proc_and_args);
                 split(proc_and_args,args," ");
                 # now args is an array of the arguments
                 # args[1] is the formal name of the first argument, etc.
                 if (numargs != numactuals && !registering) 
-                  { print location ":*** `" copy "' is improperly registered as having " numactuals " arguments" > std_err; }
-                print "\f\n" copy (registering?")":"") > dot_doc_file ; }
+                  { print location ":*** `" curr_function_proto "' is improperly registered as having " numactuals " arguments" > std_err; }
+                # Build a nicer function prototype than curr_function_proto
+                # that shows optional and rest arguments.
+                nicer_function_proto = proc_name;
+                if (!registering) {
+                  optional_args_tail = "";
+                  for (i = 1; i <= $2; i++) {
+                    nicer_function_proto = nicer_function_proto " " args[i];
+                  }
+                  for (; i <= $2 + $3; i++) {
+                    nicer_function_proto = nicer_function_proto " [" args[i];
+                    optional_args_tail = optional_args_tail "]";
+                  }
+                  nicer_function_proto = nicer_function_proto optional_args_tail;
+                  if ($4 != 0) {
+                    nicer_function_proto = nicer_function_proto " . " args[i];
+                  }
+                 }
+                # Now produce Texinfo format output.
+                print "\n\f" proc_name > dot_doc_file;
+                print "@c snarfed from " location > dot_doc_file;
+                print "@deffn primitive " nicer_function_proto > dot_doc_file;
+}
+
+/SCM_SNARF_DOCSTRING_START/,/SCM_SNARF_DOCSTRING_END.*$/ { copy = $0;
+
+                 # Trim everything up to and including
+                 # SCM_SNARF_DOCSTRING_START marker.
+                 gsub(/.*SCM_SNARF_DOCSTRING_START/,"",copy); 
+                
+                # Trim leading whitespace and opening quote.
+                sub(/^[ \t]*\"?/,"", copy);
+                
+                # Trim closing quote and trailing whitespace, or
+                 # closing quote and whitespace followed by the
+                 # SCM_SNARF_DOCSTRING_END marker.
+                 sub(/[ \t]*\"?[ \t]*$/,"", copy);
+                sub(/[ \t]*\"?[ \t]*SCM_SNARF_DOCSTRING_END.*$/,"", copy);
+                
+                # Replace escaped characters.
+                gsub(/\\n/,"\n",copy);
+                 gsub(/\\\"/,"\"",copy);
+                 gsub(/\\\\/,"\\",copy);
 
-/SCM_SNARF_DOCSTRING_START/,/SCM_SNARF_DOCSTRING_END.*$/ { copy = $0; 
-                      gsub(/.*SCM_SNARF_DOCSTRING_START/,"",copy); 
-                     sub(/^[ \t]*"?/,"", copy);
-                     sub(/\"?[ \t]*SCM_SNARF_DOCSTRING_END.*$/,"", copy);
-                      gsub(/\\n\\n"?/,"\n",copy);
-                      gsub(/\\n"?[ \t]*$/,"",copy);
-                      gsub(/\\\"[ \t]*$/,"\"",copy);
-                      gsub(/[ \t]*$/,"", copy);
-                      if (copy != "") { print copy > dot_doc_file }
+                # Some docstrings end each line with "\n", while
+                 # others don't.  Therefore we always strip off one "\n"
+                 # if present at the end of the line.  Docstrings must
+                # therefore always use "\n\n" to indicate a blank line.
+                 if (copy != "")
+                  {
+                    sub(/[ \t]*\n$/, "", copy);
+                    print copy > dot_doc_file;
+                  }
                 }
 
-/SCM_SNARF_DOCSTRING_END[ \t]/ { print "\ 1[" location "]" >> dot_doc_file; }
+/SCM_SNARF_DOCSTRING_END[ \t]*/ { print "@end deffn" >> dot_doc_file; }
 
 /\*&\*&\*&\*SCM_ARG_BETTER_BE_IN_POSITION/ { copy = $0;
          sub(/.*\*&\*&\*&\*SCM_ARG_BETTER_BE_IN_POSITION\([ \t]*/,"",copy);