Editing.
[kopensolaris-gnu/glibc.git] / manual / summary.awk
index 2f1edd8..aeb41f4 100644 (file)
-# awk script to create summary.out from the library texinfo files.
-
-# Copyright (C) 1992 Free Software Foundation, Inc.
+# awk script to create summary.texinfo from the library texinfo files.
+# Copyright (C) 1992, 1993, 1997, 2001 Free Software Foundation, Inc.
 # This file is part of the GNU C Library.
 
 # The GNU C Library is free software; you can redistribute it and/or
 # This file is part of the GNU C Library.
 
 # The GNU C Library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Library General Public License
-# as published by the Free Software Foundation; either version 2 of
-# the License, or (at your option) any later version.
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
 
 # The GNU C Library 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
 
 # The GNU C Library 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
-# Library General Public License for more details.
+# Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public
+# License along with the GNU C Library; if not, write to the Free
+# Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+# 02111-1307 USA.
 
 
-# You should have received a copy of the GNU Library General Public
-# License along with the GNU C Library; see the file COPYING.LIB.  If
-# not, write to the Free Software Foundation, Inc., 675 Mass Ave,
-# Cambridge, MA 02139, USA.
+# This script recognizes sequences that look like:
+#      @comment HEADER.h
+#      @comment STANDARD
+#      @def... ITEM | @item ITEM | @vindex ITEM
 
 BEGIN { header = 0;
 nameword["@defun"]=1
 
 BEGIN { header = 0;
 nameword["@defun"]=1
+nameword["@defunx"]=1
 nameword["@defmac"]=1
 nameword["@defmac"]=1
+nameword["@defmacx"]=1
 nameword["@defspec"]=1
 nameword["@defspec"]=1
+nameword["@defspecx"]=1
 nameword["@defvar"]=1
 nameword["@defvar"]=1
+nameword["@defvarx"]=1
 nameword["@defopt"]=1
 nameword["@defopt"]=1
+nameword["@defoptx"]=1
 nameword["@deffn"]=2
 nameword["@deffn"]=2
+nameword["@deffnx"]=2
 nameword["@defvr"]=2
 nameword["@defvr"]=2
+nameword["@defvrx"]=2
 nameword["@deftp"]=2
 nameword["@deftp"]=2
+nameword["@deftpx"]=2
 nameword["@deftypefun"]=2
 nameword["@deftypefun"]=2
+nameword["@deftypefunx"]=2
 nameword["@deftypevar"]=2
 nameword["@deftypevar"]=2
+nameword["@deftypevarx"]=2
 nameword["@deftypefn"]=3
 nameword["@deftypefn"]=3
+nameword["@deftypefnx"]=3
 nameword["@deftypevr"]=3
 nameword["@deftypevr"]=3
+nameword["@deftypevrx"]=3
 firstword["@defun"]=1
 firstword["@defun"]=1
+firstword["@defunx"]=1
 firstword["@defmac"]=1
 firstword["@defmac"]=1
+firstword["@defmacx"]=1
 firstword["@defspec"]=1
 firstword["@defspec"]=1
+firstword["@defspecx"]=1
 firstword["@defvar"]=1
 firstword["@defvar"]=1
+firstword["@defvarx"]=1
 firstword["@defopt"]=1
 firstword["@defopt"]=1
+firstword["@defoptx"]=1
 firstword["@deffn"]=2
 firstword["@deffn"]=2
+firstword["@deffnx"]=2
 firstword["@defvr"]=2
 firstword["@defvr"]=2
+firstword["@defvrx"]=2
 firstword["@deftp"]=2
 firstword["@deftp"]=2
+firstword["@deftpx"]=2
 firstword["@deftypefun"]=1
 firstword["@deftypefun"]=1
+firstword["@deftypefunx"]=1
 firstword["@deftypevar"]=1
 firstword["@deftypevar"]=1
+firstword["@deftypevarx"]=1
 firstword["@deftypefn"]=2
 firstword["@deftypefn"]=2
+firstword["@deftypefnx"]=2
 firstword["@deftypevr"]=2
 firstword["@deftypevr"]=2
+firstword["@deftypevrx"]=2
 nameword["@item"]=1
 firstword["@item"]=1
 nameword["@itemx"]=1
 firstword["@itemx"]=1
 nameword["@vindex"]=1
 firstword["@vindex"]=1
 nameword["@item"]=1
 firstword["@item"]=1
 nameword["@itemx"]=1
 firstword["@itemx"]=1
 nameword["@vindex"]=1
 firstword["@vindex"]=1
+
+print "@c DO NOT EDIT THIS FILE!"
+print "@c This file is generated by summary.awk from the Texinfo sources."
 }
 
 $1 == "@node" { node=$2;
                for (i = 3; i <= NF; ++i)
                 { node=node " " $i; if ( $i ~ /,/ ) break; }
 }
 
 $1 == "@node" { node=$2;
                for (i = 3; i <= NF; ++i)
                 { node=node " " $i; if ( $i ~ /,/ ) break; }
-             } 
+               sub (/,[, ]*$/, "", node);
+             }
 
 $1 == "@comment" && $2 ~ /\.h$/ { header="@file{" $2 "}";
                                  for (i = 3; i <= NF; ++i)
                                    header=header ", @file{" $i "}"
                                }
 
 
 $1 == "@comment" && $2 ~ /\.h$/ { header="@file{" $2 "}";
                                  for (i = 3; i <= NF; ++i)
                                    header=header ", @file{" $i "}"
                                }
 
+$1 == "@comment" && $2 == "(none)" { header = -1; }
+
 $1 == "@comment" && header != 0 { std=$2;
                                  for (i=3;i<=NF;++i) std=std " " $i }
 
 $1 == "@comment" && header != 0 { std=$2;
                                  for (i=3;i<=NF;++i) std=std " " $i }
 
@@ -79,6 +113,9 @@ header != 0 && $1 ~ /@def|@item|@vindex/ \
                } else
                  word=word " " $i
              }
                } else
                  word=word " " $i
              }
+             # Handle a single word in braces.
+             else if ($i ~ /^{.*}$/)
+               word=substr ($i, 2, length ($i) - 2)
              else
                word=$i
              if (!curly) {
              else
                word=$i
              if (!curly) {
@@ -90,7 +127,8 @@ header != 0 && $1 ~ /@def|@item|@vindex/ \
              }
            }
          }
              }
            }
          }
-         printf "@comment %s%c", name, 012 # FF
-         printf "@item%s%c", defn, 012
-         printf "%s (%s):  @ref{%s}.%c\n", header, std, node, 012;
+         printf "@comment %s%c", name, 12 # FF
+         printf "@item%s%c%c", defn, 12, 12
+         if (header != -1) printf "%s ", header;
+         printf "(%s):  @ref{%s}.%c\n", std, node, 12;
          header = 0 }
          header = 0 }