OSDN Git Service

libiberty/
[pf3gnuchains/gcc-fork.git] / libiberty / argv.c
index 3588285..11ca549 100644 (file)
@@ -1,5 +1,5 @@
 /* Create and destroy argument vectors (argv's)
-   Copyright (C) 1992 Free Software Foundation, Inc.
+   Copyright (C) 1992, 2001 Free Software Foundation, Inc.
    Written by Fred Fish @ Cygnus Support
 
 This file is part of the libiberty library.
@@ -15,39 +15,26 @@ Library General Public License for more details.
 
 You should have received a copy of the GNU Library General Public
 License along with libiberty; see the file COPYING.LIB.  If
-not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.  */
+not, write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
+Boston, MA 02110-1301, USA.  */
 
 
 /*  Create and destroy argument vectors.  An argument vector is simply an
     array of string pointers, terminated by a NULL pointer. */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
 #include "ansidecl.h"
 #include "libiberty.h"
-
-#define ISBLANK(ch) ((ch) == ' ' || (ch) == '\t')
+#include "safe-ctype.h"
 
 /*  Routines imported from standard C runtime libraries. */
 
-#ifdef __STDC__
-
 #include <stddef.h>
 #include <string.h>
 #include <stdlib.h>
-
-#else  /* !__STDC__ */
-
-#if !defined _WIN32 || defined __GNUC__
-extern char *memcpy ();                /* Copy memory region */
-extern int strlen ();          /* Count length of string */
-extern char *malloc ();                /* Standard memory allocater */
-extern char *realloc ();       /* Standard memory reallocator */
-extern void free ();           /* Free malloc'd memory */
-extern char *strdup ();                /* Duplicate a string */
-#endif
-
-#endif /* __STDC__ */
-
+#include <stdio.h>
 
 #ifndef NULL
 #define NULL 0
@@ -62,32 +49,20 @@ extern char *strdup ();             /* Duplicate a string */
 
 /*
 
-NAME
-
-       dupargv -- duplicate an argument vector
-
-SYNOPSIS
+@deftypefn Extension char** dupargv (char **@var{vector})
 
-       char **dupargv (vector)
-       char **vector;
+Duplicate an argument vector.  Simply scans through @var{vector},
+duplicating each argument until the terminating @code{NULL} is found.
+Returns a pointer to the argument vector if successful.  Returns
+@code{NULL} if there is insufficient memory to complete building the
+argument vector.
 
-DESCRIPTION
-
-       Duplicate an argument vector.  Simply scans through the
-       vector, duplicating each argument until the
-       terminating NULL is found.
-
-RETURNS
-
-       Returns a pointer to the argument vector if
-       successful. Returns NULL if there is insufficient memory to
-       complete building the argument vector.
+@end deftypefn
 
 */
 
 char **
-dupargv (argv)
-     char **argv;
+dupargv (char **argv)
 {
   int argc;
   char **copy;
@@ -105,7 +80,7 @@ dupargv (argv)
   for (argc = 0; argv[argc] != NULL; argc++)
     {
       int len = strlen (argv[argc]);
-      copy[argc] = malloc (sizeof (char *) * (len + 1));
+      copy[argc] = (char *) malloc (len + 1);
       if (copy[argc] == NULL)
        {
          freeargv (copy);
@@ -119,29 +94,18 @@ dupargv (argv)
 
 /*
 
-NAME
-
-       freeargv -- free an argument vector
-
-SYNOPSIS
+@deftypefn Extension void freeargv (char **@var{vector})
 
-       void freeargv (vector)
-       char **vector;
+Free an argument vector that was built using @code{buildargv}.  Simply
+scans through @var{vector}, freeing the memory for each argument until
+the terminating @code{NULL} is found, and then frees @var{vector}
+itself.
 
-DESCRIPTION
-
-       Free an argument vector that was built using buildargv.  Simply scans
-       through the vector, freeing the memory for each argument until the
-       terminating NULL is found, and then frees the vector itself.
-
-RETURNS
-
-       No value.
+@end deftypefn
 
 */
 
-void freeargv (vector)
-char **vector;
+void freeargv (char **vector)
 {
   register char **scan;
 
@@ -157,53 +121,45 @@ char **vector;
 
 /*
 
-NAME
-
-       buildargv -- build an argument vector from a string
+@deftypefn Extension char** buildargv (char *@var{sp})
 
-SYNOPSIS
+Given a pointer to a string, parse the string extracting fields
+separated by whitespace and optionally enclosed within either single
+or double quotes (which are stripped off), and build a vector of
+pointers to copies of the string for each field.  The input string
+remains unchanged.  The last element of the vector is followed by a
+@code{NULL} element.
 
-       char **buildargv (sp)
-       char *sp;
+All of the memory for the pointer array and copies of the string
+is obtained from @code{malloc}.  All of the memory can be returned to the
+system with the single function call @code{freeargv}, which takes the
+returned result of @code{buildargv}, as it's argument.
 
-DESCRIPTION
+Returns a pointer to the argument vector if successful.  Returns
+@code{NULL} if @var{sp} is @code{NULL} or if there is insufficient
+memory to complete building the argument vector.
 
-       Given a pointer to a string, parse the string extracting fields
-       separated by whitespace and optionally enclosed within either single
-       or double quotes (which are stripped off), and build a vector of
-       pointers to copies of the string for each field.  The input string
-       remains unchanged.
+If the input is a null string (as opposed to a @code{NULL} pointer),
+then buildarg returns an argument vector that has one arg, a null
+string.
 
-       All of the memory for the pointer array and copies of the string
-       is obtained from malloc.  All of the memory can be returned to the
-       system with the single function call freeargv, which takes the
-       returned result of buildargv, as it's argument.
+@end deftypefn
 
-       The memory for the argv array is dynamically expanded as necessary.
+The memory for the argv array is dynamically expanded as necessary.
 
-RETURNS
+In order to provide a working buffer for extracting arguments into,
+with appropriate stripping of quotes and translation of backslash
+sequences, we allocate a working buffer at least as long as the input
+string.  This ensures that we always have enough space in which to
+work, since the extracted arg is never larger than the input string.
 
-       Returns a pointer to the argument vector if successful. Returns NULL
-       if the input string pointer is NULL or if there is insufficient
-       memory to complete building the argument vector.
+The argument vector is always kept terminated with a @code{NULL} arg
+pointer, so it can be passed to @code{freeargv} at any time, or
+returned, as appropriate.
 
-NOTES
-
-       In order to provide a working buffer for extracting arguments into,
-       with appropriate stripping of quotes and translation of backslash
-       sequences, we allocate a working buffer at least as long as the input
-       string.  This ensures that we always have enough space in which to
-       work, since the extracted arg is never larger than the input string.
-
-       If the input is a null string (as opposed to a NULL pointer), then
-       buildarg returns an argv that has one arg, a null string.
-
-       Argv is always kept terminated with a NULL arg pointer, so it can
-       be passed to freeargv at any time, or returned, as appropriate.
 */
 
-char **buildargv (input)
-char *input;
+char **buildargv (const char *input)
 {
   char *arg;
   char *copybuf;
@@ -256,7 +212,7 @@ char *input;
          arg = copybuf;
          while (*input != EOS)
            {
-             if (ISBLANK (*input) && !squote && !dquote && !bsquote)
+             if (ISSPACE (*input) && !squote && !dquote && !bsquote)
                {
                  break;
                }
@@ -322,7 +278,7 @@ char *input;
          argc++;
          argv[argc] = NULL;
 
-         while (ISBLANK (*input))
+         while (ISSPACE (*input))
            {
              input++;
            }
@@ -332,11 +288,131 @@ char *input;
   return (argv);
 }
 
+/*
+
+@deftypefn Extension void expandargv (int *@var{argcp}, char ***@var{argvp})
+
+The @var{argcp} and @code{argvp} arguments are pointers to the usual
+@code{argc} and @code{argv} arguments to @code{main}.  This function
+looks for arguments that begin with the character @samp{@@}.  Any such
+arguments are interpreted as ``response files''.  The contents of the
+response file are interpreted as additional command line options.  In
+particular, the file is separated into whitespace-separated strings;
+each such string is taken as a command-line option.  The new options
+are inserted in place of the option naming the response file, and
+@code{*argcp} and @code{*argvp} will be updated.  If the value of
+@code{*argvp} is modified by this function, then the new value has
+been dynamically allocated and can be deallocated by the caller with
+@code{freeargv}.  However, most callers will simply call
+@code{expandargv} near the beginning of @code{main} and allow the
+operating system to free the memory when the program exits.
+
+@end deftypefn
+
+*/
+
+void
+expandargv (argcp, argvp)
+     int *argcp;
+     char ***argvp;
+{
+  /* The argument we are currently processing.  */
+  int i = 0;
+  /* Non-zero if ***argvp has been dynamically allocated.  */
+  int argv_dynamic = 0;
+  /* Loop over the arguments, handling response files.  We always skip
+     ARGVP[0], as that is the name of the program being run.  */
+  while (++i < *argcp)
+    {
+      /* The name of the response file.  */
+      const char *filename;
+      /* The response file.  */
+      FILE *f;
+      /* An upper bound on the number of characters in the response
+        file.  */
+      long pos;
+      /* The number of characters in the response file, when actually
+        read.  */
+      size_t len;
+      /* A dynamically allocated buffer used to hold options read from a
+        response file.  */
+      char *buffer;
+      /* Dynamically allocated storage for the options read from the
+        response file.  */
+      char **file_argv;
+      /* The number of options read from the response file, if any.  */
+      size_t file_argc;
+      /* We are only interested in options of the form "@file".  */
+      filename = (*argvp)[i];
+      if (filename[0] != '@')
+       continue;
+      /* Read the contents of the file.  */
+      f = fopen (++filename, "r");
+      if (!f)
+       continue;
+      if (fseek (f, 0L, SEEK_END) == -1)
+       goto error;
+      pos = ftell (f);
+      if (pos == -1)
+       goto error;
+      if (fseek (f, 0L, SEEK_SET) == -1)
+       goto error;
+      buffer = (char *) xmalloc (pos * sizeof (char) + 1);
+      len = fread (buffer, sizeof (char), pos, f);
+      if (len != (size_t) pos
+         /* On Windows, fread may return a value smaller than POS,
+            due to CR/LF->CR translation when reading text files.
+            That does not in-and-of itself indicate failure.  */
+         && ferror (f))
+       goto error;
+      /* Add a NUL terminator.  */
+      buffer[len] = '\0';
+      /* Parse the string.  */
+      file_argv = buildargv (buffer);
+      /* If *ARGVP is not already dynamically allocated, copy it.  */
+      if (!argv_dynamic)
+       {
+         *argvp = dupargv (*argvp);
+         if (!*argvp)
+           {
+             fputs ("\nout of memory\n", stderr);
+             xexit (1);
+           }
+       }
+      /* Count the number of arguments.  */
+      file_argc = 0;
+      while (file_argv[file_argc] && *file_argv[file_argc])
+       ++file_argc;
+      /* Now, insert FILE_ARGV into ARGV.  The "+1" below handles the
+        NULL terminator at the end of ARGV.  */ 
+      *argvp = ((char **) 
+               xrealloc (*argvp, 
+                         (*argcp + file_argc + 1) * sizeof (char *)));
+      memmove (*argvp + i + file_argc, *argvp + i + 1, 
+              (*argcp - i) * sizeof (char *));
+      memcpy (*argvp + i, file_argv, file_argc * sizeof (char *));
+      /* The original option has been replaced by all the new
+        options.  */
+      *argcp += file_argc - 1;
+      /* Free up memory allocated to process the response file.  We do
+        not use freeargv because the individual options in FILE_ARGV
+        are now in the main ARGV.  */
+      free (file_argv);
+      free (buffer);
+      /* Rescan all of the arguments just read to support response
+        files that include other response files.  */
+      --i;
+    error:
+      /* We're all done with the file now.  */
+      fclose (f);
+    }
+}
+
 #ifdef MAIN
 
 /* Simple little test driver. */
 
-static char *tests[] =
+static const char *const tests[] =
 {
   "a simple command line",
   "arg 'foo' is single quoted",
@@ -353,10 +429,11 @@ static char *tests[] =
   NULL
 };
 
-main ()
+int
+main (void)
 {
   char **argv;
-  char **test;
+  const char *const *test;
   char **targs;
 
   for (test = tests; *test != NULL; test++)
@@ -377,6 +454,7 @@ main ()
       freeargv (argv);
     }
 
+  return 0;
 }
 
 #endif /* MAIN */