1 /* Create and destroy argument vectors (argv's)
2 Copyright (C) 1992, 2001, 2010 Free Software Foundation, Inc.
3 Written by Fred Fish @ Cygnus Support
5 This file is part of the libiberty library.
6 Libiberty is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
11 Libiberty is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
16 You should have received a copy of the GNU Library General Public
17 License along with libiberty; see the file COPYING.LIB. If
18 not, write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
19 Boston, MA 02110-1301, USA. */
22 /* Create and destroy argument vectors. An argument vector is simply an
23 array of string pointers, terminated by a NULL pointer. */
29 #include "libiberty.h"
30 #include "safe-ctype.h"
32 /* Routines imported from standard C runtime libraries. */
47 #define INITIAL_MAXARGC 8 /* Number of args + NULL in initial argv */
52 @deftypefn Extension char** dupargv (char **@var{vector})
54 Duplicate an argument vector. Simply scans through @var{vector},
55 duplicating each argument until the terminating @code{NULL} is found.
56 Returns a pointer to the argument vector if successful. Returns
57 @code{NULL} if there is insufficient memory to complete building the
74 for (argc
= 0; argv
[argc
] != NULL
; argc
++);
75 copy
= (char **) malloc ((argc
+ 1) * sizeof (char *));
80 for (argc
= 0; argv
[argc
] != NULL
; argc
++)
82 int len
= strlen (argv
[argc
]);
83 copy
[argc
] = (char *) malloc (len
+ 1);
84 if (copy
[argc
] == NULL
)
89 strcpy (copy
[argc
], argv
[argc
]);
97 @deftypefn Extension void freeargv (char **@var{vector})
99 Free an argument vector that was built using @code{buildargv}. Simply
100 scans through @var{vector}, freeing the memory for each argument until
101 the terminating @code{NULL} is found, and then frees @var{vector}
108 void freeargv (char **vector
)
110 register char **scan
;
114 for (scan
= vector
; *scan
!= NULL
; scan
++)
123 consume_whitespace (const char **input
)
125 while (ISSPACE (**input
))
132 only_whitespace (const char* input
)
134 while (*input
!= EOS
&& ISSPACE (*input
))
137 return (*input
== EOS
);
142 @deftypefn Extension char** buildargv (char *@var{sp})
144 Given a pointer to a string, parse the string extracting fields
145 separated by whitespace and optionally enclosed within either single
146 or double quotes (which are stripped off), and build a vector of
147 pointers to copies of the string for each field. The input string
148 remains unchanged. The last element of the vector is followed by a
151 All of the memory for the pointer array and copies of the string
152 is obtained from @code{malloc}. All of the memory can be returned to the
153 system with the single function call @code{freeargv}, which takes the
154 returned result of @code{buildargv}, as it's argument.
156 Returns a pointer to the argument vector if successful. Returns
157 @code{NULL} if @var{sp} is @code{NULL} or if there is insufficient
158 memory to complete building the argument vector.
160 If the input is a null string (as opposed to a @code{NULL} pointer),
161 then buildarg returns an argument vector that has one arg, a null
166 The memory for the argv array is dynamically expanded as necessary.
168 In order to provide a working buffer for extracting arguments into,
169 with appropriate stripping of quotes and translation of backslash
170 sequences, we allocate a working buffer at least as long as the input
171 string. This ensures that we always have enough space in which to
172 work, since the extracted arg is never larger than the input string.
174 The argument vector is always kept terminated with a @code{NULL} arg
175 pointer, so it can be passed to @code{freeargv} at any time, or
176 returned, as appropriate.
180 char **buildargv (const char *input
)
194 copybuf
= (char *) alloca (strlen (input
) + 1);
195 /* Is a do{}while to always execute the loop once. Always return an
196 argv, even for null strings. See NOTES above, test case below. */
199 /* Pick off argv[argc] */
200 consume_whitespace (&input
);
202 if ((maxargc
== 0) || (argc
>= (maxargc
- 1)))
204 /* argv needs initialization, or expansion */
207 maxargc
= INITIAL_MAXARGC
;
208 nargv
= (char **) malloc (maxargc
* sizeof (char *));
213 nargv
= (char **) realloc (argv
, maxargc
* sizeof (char *));
227 /* Begin scanning arg */
229 while (*input
!= EOS
)
231 if (ISSPACE (*input
) && !squote
&& !dquote
&& !bsquote
)
242 else if (*input
== '\\')
274 else if (*input
== '"')
287 argv
[argc
] = strdup (copybuf
);
288 if (argv
[argc
] == NULL
)
297 consume_whitespace (&input
);
299 while (*input
!= EOS
);
306 @deftypefn Extension int writeargv (const char **@var{argv}, FILE *@var{file})
308 Write each member of ARGV, handling all necessary quoting, to the file
309 named by FILE, separated by whitespace. Return 0 on success, non-zero
310 if an error occurred while writing to FILE.
317 writeargv (char **argv
, FILE *f
)
324 while (*argv
!= NULL
)
326 const char *arg
= *argv
;
332 if (ISSPACE(c
) || c
== '\\' || c
== '\'' || c
== '"')
333 if (EOF
== fputc ('\\', f
))
339 if (EOF
== fputc (c
, f
))
347 if (EOF
== fputc ('\n', f
))
361 @deftypefn Extension void expandargv (int *@var{argcp}, char ***@var{argvp})
363 The @var{argcp} and @code{argvp} arguments are pointers to the usual
364 @code{argc} and @code{argv} arguments to @code{main}. This function
365 looks for arguments that begin with the character @samp{@@}. Any such
366 arguments are interpreted as ``response files''. The contents of the
367 response file are interpreted as additional command line options. In
368 particular, the file is separated into whitespace-separated strings;
369 each such string is taken as a command-line option. The new options
370 are inserted in place of the option naming the response file, and
371 @code{*argcp} and @code{*argvp} will be updated. If the value of
372 @code{*argvp} is modified by this function, then the new value has
373 been dynamically allocated and can be deallocated by the caller with
374 @code{freeargv}. However, most callers will simply call
375 @code{expandargv} near the beginning of @code{main} and allow the
376 operating system to free the memory when the program exits.
383 expandargv (int *argcp
, char ***argvp
)
385 /* The argument we are currently processing. */
387 /* Non-zero if ***argvp has been dynamically allocated. */
388 int argv_dynamic
= 0;
389 /* Limit the number of response files that we parse in order
390 to prevent infinite recursion. */
391 unsigned int iteration_limit
= 2000;
392 /* Loop over the arguments, handling response files. We always skip
393 ARGVP[0], as that is the name of the program being run. */
396 /* The name of the response file. */
397 const char *filename
;
398 /* The response file. */
400 /* An upper bound on the number of characters in the response
403 /* The number of characters in the response file, when actually
406 /* A dynamically allocated buffer used to hold options read from a
409 /* Dynamically allocated storage for the options read from the
412 /* The number of options read from the response file, if any. */
414 /* We are only interested in options of the form "@file". */
415 filename
= (*argvp
)[i
];
416 if (filename
[0] != '@')
418 /* If we have iterated too many times then stop. */
419 if (-- iteration_limit
== 0)
421 fprintf (stderr
, "%s: error: too many @-files encountered\n", (*argvp
)[0]);
424 /* Read the contents of the file. */
425 f
= fopen (++filename
, "r");
428 if (fseek (f
, 0L, SEEK_END
) == -1)
433 if (fseek (f
, 0L, SEEK_SET
) == -1)
435 buffer
= (char *) xmalloc (pos
* sizeof (char) + 1);
436 len
= fread (buffer
, sizeof (char), pos
, f
);
437 if (len
!= (size_t) pos
438 /* On Windows, fread may return a value smaller than POS,
439 due to CR/LF->CR translation when reading text files.
440 That does not in-and-of itself indicate failure. */
443 /* Add a NUL terminator. */
445 /* If the file is empty or contains only whitespace, buildargv would
446 return a single empty argument. In this context we want no arguments,
448 if (only_whitespace (buffer
))
450 file_argv
= (char **) xmalloc (sizeof (char *));
454 /* Parse the string. */
455 file_argv
= buildargv (buffer
);
456 /* If *ARGVP is not already dynamically allocated, copy it. */
459 *argvp
= dupargv (*argvp
);
462 fputs ("\nout of memory\n", stderr
);
466 /* Count the number of arguments. */
468 while (file_argv
[file_argc
])
470 /* Now, insert FILE_ARGV into ARGV. The "+1" below handles the
471 NULL terminator at the end of ARGV. */
474 (*argcp
+ file_argc
+ 1) * sizeof (char *)));
475 memmove (*argvp
+ i
+ file_argc
, *argvp
+ i
+ 1,
476 (*argcp
- i
) * sizeof (char *));
477 memcpy (*argvp
+ i
, file_argv
, file_argc
* sizeof (char *));
478 /* The original option has been replaced by all the new
480 *argcp
+= file_argc
- 1;
481 /* Free up memory allocated to process the response file. We do
482 not use freeargv because the individual options in FILE_ARGV
483 are now in the main ARGV. */
486 /* Rescan all of the arguments just read to support response
487 files that include other response files. */
490 /* We're all done with the file now. */
497 /* Simple little test driver. */
499 static const char *const tests
[] =
501 "a simple command line",
502 "arg 'foo' is single quoted",
503 "arg \"bar\" is double quoted",
504 "arg \"foo bar\" has embedded whitespace",
505 "arg 'Jack said \\'hi\\'' has single quotes",
506 "arg 'Jack said \\\"hi\\\"' has double quotes",
507 "a b c d e f g h i j k l m n o p q r s t u v w x y z 1 2 3 4 5 6 7 8 9",
509 /* This should be expanded into only one argument. */
510 "trailing-whitespace ",
520 const char *const *test
;
523 for (test
= tests
; *test
!= NULL
; test
++)
525 printf ("buildargv(\"%s\")\n", *test
);
526 if ((argv
= buildargv (*test
)) == NULL
)
528 printf ("failed!\n\n");
532 for (targs
= argv
; *targs
!= NULL
; targs
++)
534 printf ("\t\"%s\"\n", *targs
);
This page took 0.04116 seconds and 4 git commands to generate.