mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-20 11:40:18 +02:00
Code Activity

* Enhance snarfing of libguile docstrings and postprocess them with makeinfo.

Browse source
This commit is contained in:
Neil Jerram 2000-09-29 20:33:13 +00:00
parent 6ec589e2a2
commit 9d29e9906e
3 changed files with 52 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

12
libguile/ChangeLog
View file

@ -1,5 +1,17 @@
2000-09-29 Neil Jerram <neil@ossau.uklinux.net>
* Makefile.am (guile-procedures.txt): Insert a new rule such that
the output from guile-snarf.awk is processed by makeinfo to
produce guile-procedures.txt.
* guile-snarf.awk.in: Modify the way we snarf docstrings such that
the output is Texinfo-compliant and suitable for post-processing
with makeinfo. (Trim leading "./" from C file name if
present; reformat procedure prototype line in @deffn format;
improve representation of args to show optional and rest args;
explicitly quote quotation marks where they are used inside an AWK
regexp.)
* net_db.c (scm_inet_ntoa): Docstring fix: missing newline
inserted.

9
libguile/Makefile.am
View file

@ -192,8 +192,13 @@ error.x: cpp_err_symbols.c
posix.x: cpp_sig_symbols.c
load.x: libpath.h
guile-procedures.txt: $(DOT_DOC_FILES) $(EXTRA_DOT_DOC_FILES)
cat *.doc > $@
guile.texi: $(DOT_DOC_FILES) $(EXTRA_DOT_DOC_FILES)
echo "@paragraphindent 0" > $@
cat *.doc >> $@
guile-procedures.txt: guile.texi
rm -f $@
makeinfo --force -o $@ $< || test -f $@
pkgdata_DATA = guile-procedures.txt

41
libguile/guile-snarf.awk.in
View file

@ -32,6 +32,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)
@ -40,29 +41,53 @@ BEGIN { FS="|";
# Now `copy' contains the nice scheme proc "prototype", e.g.
# (set-car! pair value)
# 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 " \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 " 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;
gsub(/.*SCM_SNARF_DOCSTRING_START/,"",copy);
sub(/^[ \t]*"?/,"", copy);
sub(/^[ \t]*\"?/,"", copy);
sub(/\"?[ \t]*SCM_SNARF_DOCSTRING_END.*$/,"", copy);
gsub(/\\n\\n"?/,"\n",copy);
gsub(/\\n"?[ \t]*$/,"",copy);
gsub(/\\\"[ \t]*$/,"\"",copy);
gsub(/\\n\\n\"?/,"\n",copy);
gsub(/\\n\"?[ \t]*$/,"",copy);
gsub(/\\\"/,"\"",copy);
gsub(/[ \t]*$/,"", copy);
if (copy != "") { print copy > dot_doc_file }
}
/SCM_SNARF_DOCSTRING_END[ \t]/ { print "[" 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);