1 This file is mapfile.def, from which is created mapfile.c.
2 It implements the builtin "mapfile" in Bash.
4 Copyright (C) 2005-2006 Rocky Bernstein for Free Software Foundation, Inc.
5 Copyright (C) 2008-2012 Free Software Foundation, Inc.
7 This file is part of GNU Bash, the Bourne Again SHell.
9 Bash is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 Bash is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with Bash. If not, see <http://www.gnu.org/licenses/>.
25 $FUNCTION mapfile_builtin
26 $SHORT_DOC mapfile [-n count] [-O origin] [-s count] [-t] [-u fd] [-C callback] [-c quantum] [array]
27 Read lines from the standard input into an indexed array variable.
29 Read lines from the standard input into the indexed array variable ARRAY, or
30 from file descriptor FD if the -u option is supplied. The variable MAPFILE
34 -n count Copy at most COUNT lines. If COUNT is 0, all lines are copied.
35 -O origin Begin assigning to ARRAY at index ORIGIN. The default index is 0.
36 -s count Discard the first COUNT lines read.
37 -t Remove a trailing newline from each line read.
38 -u fd Read lines from file descriptor FD instead of the standard input.
39 -C callback Evaluate CALLBACK each time QUANTUM lines are read.
40 -c quantum Specify the number of lines read between each call to CALLBACK.
43 ARRAY Array variable name to use for file data.
45 If -C is supplied without -c, the default quantum is 5000. When
46 CALLBACK is evaluated, it is supplied the index of the next array
47 element to be assigned and the line to be assigned to that element
48 as additional arguments.
50 If not supplied with an explicit origin, mapfile will clear ARRAY before
54 Returns success unless an invalid option is given or ARRAY is readonly or
59 $FUNCTION mapfile_builtin
60 $SHORT_DOC readarray [-n count] [-O origin] [-s count] [-t] [-u fd] [-C callback] [-c quantum] [array]
61 Read lines from a file into an array variable.
63 A synonym for `mapfile'.
69 #include "posixstat.h"
71 #if defined (HAVE_UNISTD_H)
81 #include "../bashintl.h"
84 #include "bashgetopt.h"
90 #if defined (ARRAY_VARS)
92 static int run_callback __P((const char *, unsigned int, const char *));
94 #define DEFAULT_ARRAY_NAME "MAPFILE"
95 #define DEFAULT_VARIABLE_NAME "MAPLINE" /* not used right now */
97 /* The value specifying how frequently `mapfile' calls the callback. */
98 #define DEFAULT_QUANTUM 5000
100 /* Values for FLAGS */
101 #define MAPF_CLEARARRAY 0x01
102 #define MAPF_CHOP 0x02
105 run_callback (callback, curindex, curline)
106 const char *callback;
107 unsigned int curindex;
110 unsigned int execlen;
111 char *execstr, *qline;
114 qline = sh_single_quote (curline);
115 execlen = strlen (callback) + strlen (qline) + 10;
116 /* 1 for each space between %s and %d,
117 another 1 for the last nul char for C string. */
119 execstr = xmalloc (execlen);
121 flags = SEVAL_NOHIST;
124 flags |= SEVAL_INTERACT;
126 snprintf (execstr, execlen, "%s %d %s", callback, curindex, qline);
128 return evalstring (execstr, NULL, flags);
137 length = strlen (line);
138 if (length && line[length-1] == '\n')
139 line[length-1] = '\0';
143 mapfile (fd, line_count_goal, origin, nskip, callback_quantum, callback, array_name, flags)
145 long line_count_goal, origin, nskip, callback_quantum;
146 char *callback, *array_name;
151 unsigned int array_index, line_count;
159 /* The following check should be done before reading any lines. Doing it
160 here allows us to call bind_array_element instead of bind_array_variable
161 and skip the variable lookup on every call. */
162 entry = find_or_make_array_variable (array_name, 1);
163 if (entry == 0 || readonly_p (entry) || noassign_p (entry))
165 if (entry && readonly_p (entry))
166 err_readonly (array_name);
168 return (EXECUTION_FAILURE);
170 else if (array_p (entry) == 0)
172 builtin_error (_("%s: not an indexed array"), array_name);
173 return (EXECUTION_FAILURE);
175 else if (invisible_p (entry))
176 VUNSETATTR (entry, att_invisible); /* no longer invisible */
178 if (flags & MAPF_CLEARARRAY)
179 array_flush (array_cell (entry));
182 unbuffered_read = (lseek (fd, 0L, SEEK_CUR) < 0) && (errno == ESPIPE);
189 /* Skip any lines at beginning of file? */
190 for (line_count = 0; line_count < nskip; line_count++)
191 if (zgetline (fd, &line, &line_length, unbuffered_read) < 0)
197 /* Reset the buffer for bash own stream */
198 for (array_index = origin, line_count = 1;
199 zgetline (fd, &line, &line_length, unbuffered_read) != -1;
202 /* Remove trailing newlines? */
203 if (flags & MAPF_CHOP)
206 /* Has a callback been registered and if so is it time to call it? */
207 if (callback && line_count && (line_count % callback_quantum) == 0)
209 run_callback (callback, array_index, line);
211 /* Reset the buffer for bash own stream. */
212 if (unbuffered_read == 0)
216 /* XXX - bad things can happen if the callback modifies ENTRY, e.g.,
217 unsetting it or changing it to a non-indexed-array type. */
218 bind_array_element (entry, array_index, line, 0);
220 /* Have we exceeded # of lines to store? */
222 if (line_count_goal != 0 && line_count > line_count_goal)
228 if (unbuffered_read == 0)
231 return EXECUTION_SUCCESS;
235 mapfile_builtin (list)
238 int opt, code, fd, clear_array, flags;
240 long lines, origin, nskip, callback_quantum;
241 char *array_name, *callback;
245 lines = origin = nskip = 0;
246 flags = MAPF_CLEARARRAY;
247 callback_quantum = DEFAULT_QUANTUM;
250 reset_internal_getopt ();
251 while ((opt = internal_getopt (list, "u:n:O:tC:c:s:")) != -1)
256 code = legal_number (list_optarg, &intval);
257 if (code == 0 || intval < 0 || intval != (int)intval)
259 builtin_error (_("%s: invalid file descriptor specification"), list_optarg);
260 return (EXECUTION_FAILURE);
265 if (sh_validfd (fd) == 0)
267 builtin_error (_("%d: invalid file descriptor: %s"), fd, strerror (errno));
268 return (EXECUTION_FAILURE);
273 code = legal_number (list_optarg, &intval);
274 if (code == 0 || intval < 0 || intval != (unsigned)intval)
276 builtin_error (_("%s: invalid line count"), list_optarg);
277 return (EXECUTION_FAILURE);
284 code = legal_number (list_optarg, &intval);
285 if (code == 0 || intval < 0 || intval != (unsigned)intval)
287 builtin_error (_("%s: invalid array origin"), list_optarg);
288 return (EXECUTION_FAILURE);
292 flags &= ~MAPF_CLEARARRAY;
298 callback = list_optarg;
301 code = legal_number (list_optarg, &intval);
302 if (code == 0 || intval <= 0 || intval != (unsigned)intval)
304 builtin_error (_("%s: invalid callback quantum"), list_optarg);
305 return (EXECUTION_FAILURE);
308 callback_quantum = intval;
311 code = legal_number (list_optarg, &intval);
312 if (code == 0 || intval < 0 || intval != (unsigned)intval)
314 builtin_error (_("%s: invalid line count"), list_optarg);
315 return (EXECUTION_FAILURE);
328 array_name = DEFAULT_ARRAY_NAME;
329 else if (list->word == 0 || list->word->word == 0)
331 builtin_error ("internal error: getting variable name");
332 return (EXECUTION_FAILURE);
334 else if (list->word->word[0] == '\0')
336 builtin_error (_("empty array variable name"));
340 array_name = list->word->word;
342 if (legal_identifier (array_name) == 0 && valid_array_reference (array_name) == 0)
344 sh_invalidid (array_name);
345 return (EXECUTION_FAILURE);
348 return mapfile (fd, lines, origin, nskip, callback_quantum, callback, array_name, flags);
354 mapfile_builtin (list)
357 builtin_error (_("array variable support required"));
358 return (EXECUTION_FAILURE);
361 #endif /* ARRAY_VARS */