1 /* vi: set sw=4 ts=4: */
3 * sed.c - very minimalist version of sed
5 * Copyright (C) 1999,2000,2001 by Lineo, inc. and Mark Whitley
6 * Copyright (C) 1999,2000,2001 by Mark Whitley <markw@codepoet.org>
7 * Copyright (C) 2002 Matt Kraai
8 * Copyright (C) 2003 by Glenn McGrath
9 * Copyright (C) 2003,2004 by Rob Landley <rob@landley.net>
11 * MAINTAINER: Rob Landley <rob@landley.net>
13 * Licensed under GPLv2, see file LICENSE in this source tree.
17 * Files are laid out to avoid unnecessary function declarations. So for
18 * example, every function add_cmd calls occurs before add_cmd in this file.
20 * add_cmd() is called on each line of sed command text (from a file or from
21 * the command line). It calls get_address() and parse_cmd_args(). The
22 * resulting sed_cmd_t structures are appended to a linked list
23 * (G.sed_cmd_head/G.sed_cmd_tail).
25 * process_files() does actual sedding, reading data lines from each input FILE*
26 * (which could be stdin) and applying the sed command list (sed_cmd_head) to
27 * each of the resulting lines.
29 * sed_main() is where external code calls into this, with a command line.
31 /* Supported features and commands in this version of sed:
34 * - address matching: num|/matchstr/[,num|/matchstr/|$]command
35 * - commands: (p)rint, (d)elete, (s)ubstitue (with g & I flags)
36 * - edit commands: (a)ppend, (i)nsert, (c)hange
37 * - file commands: (r)ead
38 * - backreferences in substitution expressions (\0, \1, \2...\9)
39 * - grouped commands: {cmd1;cmd2}
40 * - transliteration (y/source-chars/dest-chars/)
41 * - pattern space hold space storing / swapping (g, h, x)
42 * - labels / branching (: label, b, t, T)
44 * (Note: Specifying an address (range) to match is *optional*; commands
45 * default to the whole pattern space if no specific address match was
49 * - Create a wrapper around regex to make libc's regex conform with sed
52 * http://www.opengroup.org/onlinepubs/007904975/utilities/sed.html
53 * http://pubs.opengroup.org/onlinepubs/9699919799/utilities/sed.html
54 * http://sed.sourceforge.net/sedfaq3.html
57 //config: bool "sed (12 kb)"
60 //config: sed is used to perform text transformations on a file
61 //config: or input from a pipeline.
63 //applet:IF_SED(APPLET(sed, BB_DIR_BIN, BB_SUID_DROP))
65 //kbuild:lib-$(CONFIG_SED) += sed.o
67 //usage:#define sed_trivial_usage
68 //usage: "[-i[SFX]] [-nrE] [-f FILE]... [-e CMD]... [FILE]...\n"
69 //usage: "or: sed [-i[SFX]] [-nrE] CMD [FILE]..."
70 //usage:#define sed_full_usage "\n\n"
71 //usage: " -e CMD Add CMD to sed commands to be executed"
72 //usage: "\n -f FILE Add FILE contents to sed commands to be executed"
73 //usage: "\n -i[SFX] Edit files in-place (otherwise sends to stdout)"
74 //usage: "\n Optionally back files up, appending SFX"
75 //usage: "\n -n Suppress automatic printing of pattern space"
76 //usage: "\n -r,-E Use extended regex syntax"
78 //usage: "\nIf no -e or -f, the first non-option argument is the sed command string."
79 //usage: "\nRemaining arguments are input files (stdin if none)."
81 //usage:#define sed_example_usage
82 //usage: "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n"
86 #include "common_bufsiz.h"
90 # define dbg(...) bb_error_msg(__VA_ARGS__)
92 # define dbg(...) ((void)0)
97 OPT_in_place = 1 << 0,
100 /* Each sed command turns into one of these structures. */
101 typedef struct sed_cmd_s {
102 /* Ordered by alignment requirements: currently 36 bytes on x86 */
103 struct sed_cmd_s *next; /* Next command (linked list, NULL terminated) */
105 /* address storage */
106 regex_t *beg_match; /* sed -e '/match/cmd' */
107 regex_t *end_match; /* sed -e '/match/,/end_match/cmd' */
108 regex_t *sub_match; /* For 's/sub_match/string/' */
109 int beg_line; /* 'sed 1p' 0 == apply commands to all lines */
110 int beg_line_orig; /* copy of the above, needed for -i */
111 int end_line; /* 'sed 1,3p' 0 == one line only. -1 = last line ($). -2-N = +N */
114 FILE *sw_file; /* File (sw) command writes to, NULL for none. */
115 char *string; /* Data string for (saicytb) commands. */
117 unsigned which_match; /* (s) Which match to replace (0 for all) */
119 /* Bitfields (gcc won't group them if we don't) */
120 unsigned invert:1; /* the '!' after the address */
121 unsigned in_match:1; /* Next line also included in match? */
122 unsigned sub_p:1; /* (s) print option */
124 char sw_last_char; /* Last line written by (sw) had no '\n' */
127 char cmd; /* The command char: abcdDgGhHilnNpPqrstwxy:={} */
130 static const char semicolon_whitespace[] ALIGN1 = "; \n\r\t\v";
134 int be_quiet, regex_type;
137 char *outname, *hold_space;
140 /* list of input files */
141 int current_input_file, last_input_file;
142 char **input_file_list;
145 regmatch_t regmatch[10];
146 regex_t *previous_regex_ptr;
148 /* linked list of sed commands */
149 sed_cmd_t *sed_cmd_head, **sed_cmd_tail;
151 /* linked list of append lines */
152 llist_t *append_head;
157 char *buf; /* Space to hold string */
158 int idx; /* Space used */
159 int len; /* Space allocated */
162 #define G (*(struct globals*)bb_common_bufsiz1)
163 #define INIT_G() do { \
164 setup_common_bufsiz(); \
165 BUILD_BUG_ON(sizeof(G) > COMMON_BUFSIZE); \
166 G.sed_cmd_tail = &G.sed_cmd_head; \
170 #if ENABLE_FEATURE_CLEAN_UP
171 static void sed_free_and_close_stuff(void)
173 sed_cmd_t *sed_cmd = G.sed_cmd_head;
175 llist_free(G.append_head, free);
178 sed_cmd_t *sed_cmd_next = sed_cmd->next;
180 if (sed_cmd->sw_file)
181 fclose(sed_cmd->sw_file);
183 if (sed_cmd->beg_match) {
184 regfree(sed_cmd->beg_match);
185 free(sed_cmd->beg_match);
187 if (sed_cmd->end_match) {
188 regfree(sed_cmd->end_match);
189 free(sed_cmd->end_match);
191 if (sed_cmd->sub_match) {
192 regfree(sed_cmd->sub_match);
193 free(sed_cmd->sub_match);
195 free(sed_cmd->string);
197 sed_cmd = sed_cmd_next;
203 fclose(G.current_fp);
206 void sed_free_and_close_stuff(void);
209 /* If something bad happens during -i operation, delete temp file */
211 static void cleanup_outname(void)
213 if (G.outname) unlink(G.outname);
216 /* strcpy, replacing "\from" with 'to'. If to is NUL, replacing "\any" with 'any' */
218 static unsigned parse_escapes(char *dest, const char *string, int len, char from, char to)
224 len = strlen(string);
227 if (string[i] == '\\') {
228 if (!to || string[i+1] == from) {
229 if ((*d = to ? to : string[i+1]) == '\0')
235 i++; /* skip backslash in string[] */
237 /* fall through: copy next char verbatim */
239 if ((*d = string[i++]) == '\0')
247 static char *copy_parsing_escapes(const char *string, int len)
250 char *dest = xmalloc(len + 1);
252 /* sed recognizes \n */
253 /* GNU sed also recognizes \t and \r */
254 for (s = "\nn\tt\rr"; *s; s += 2) {
255 len = parse_escapes(dest, string, len, s[1], s[0]);
263 * index_of_next_unescaped_regexp_delim - walks left to right through a string
264 * beginning at a specified index and returns the index of the next regular
265 * expression delimiter (typically a forward slash ('/')) not preceded by
266 * a backslash ('\'). A negative delimiter disables square bracket checking.
268 static int index_of_next_unescaped_regexp_delim(int delimiter, const char *str)
277 delimiter = -delimiter;
280 for (; (ch = str[idx]) != '\0'; idx++) {
283 && !(bracket == idx - 1 || (bracket == idx - 2 && str[idx - 1] == '^'))
291 else if (bracket == -1 && ch == '[')
293 else if (ch == delimiter)
297 /* if we make it to here, we've hit the end of the string */
298 bb_error_msg_and_die("unmatched '%c'", delimiter);
302 * Returns the index of the third delimiter
304 static int parse_regex_delim(const char *cmdstr, char **match, char **replace)
306 const char *cmdstr_ptr = cmdstr;
307 unsigned char delimiter;
310 /* verify that the 's' or 'y' is followed by something. That something
311 * (typically a 'slash') is now our regexp delimiter... */
313 bb_error_msg_and_die("bad format in substitution expression");
314 delimiter = *cmdstr_ptr++;
316 /* save the match string */
317 idx = index_of_next_unescaped_regexp_delim(delimiter, cmdstr_ptr);
318 *match = copy_parsing_escapes(cmdstr_ptr, idx);
320 /* save the replacement string */
321 cmdstr_ptr += idx + 1;
322 idx = index_of_next_unescaped_regexp_delim(- (int)delimiter, cmdstr_ptr);
323 *replace = copy_parsing_escapes(cmdstr_ptr, idx);
325 return ((cmdstr_ptr - cmdstr) + idx);
329 * returns the index in the string just past where the address ends.
331 static int get_address(const char *my_str, int *linenum, regex_t ** regex)
333 const char *pos = my_str;
335 if (isdigit(*my_str)) {
336 *linenum = strtol(my_str, (char**)&pos, 10);
337 /* endstr shouldn't ever equal NULL */
338 } else if (*my_str == '$') {
341 } else if (*my_str == '/' || *my_str == '\\') {
349 next = index_of_next_unescaped_regexp_delim(delimiter, ++pos);
351 temp = copy_parsing_escapes(pos, next);
352 G.previous_regex_ptr = *regex = xzalloc(sizeof(regex_t));
353 xregcomp(*regex, temp, G.regex_type);
356 *regex = G.previous_regex_ptr;
357 if (!G.previous_regex_ptr)
358 bb_error_msg_and_die("no previous regexp");
360 /* Move position to next character after last delimiter */
366 /* Grab a filename. Whitespace at start is skipped, then goes to EOL. */
367 static int parse_file_cmd(/*sed_cmd_t *sed_cmd,*/ const char *filecmdstr, char **retval)
369 int start = 0, idx, hack = 0;
371 /* Skip whitespace, then grab filename to end of line */
372 while (isspace(filecmdstr[start]))
375 while (filecmdstr[idx] && filecmdstr[idx] != '\n')
378 /* If lines glued together, put backslash back. */
379 if (filecmdstr[idx] == '\n')
382 bb_error_msg_and_die("empty filename");
383 *retval = xstrndup(filecmdstr+start, idx-start+hack+1);
385 (*retval)[idx] = '\\';
390 static int parse_subst_cmd(sed_cmd_t *sed_cmd, const char *substr)
392 int cflags = G.regex_type;
397 * A substitution command should look something like this:
398 * s/match/replace/ #giIpw
402 idx = parse_regex_delim(substr, &match, &sed_cmd->string);
404 /* determine the number of back references in the match string */
405 /* Note: we compute this here rather than in the do_subst_command()
406 * function to save processor time, at the expense of a little more memory
407 * (4 bits) per sed_cmd */
409 /* process the flags */
411 sed_cmd->which_match = 1;
412 dbg("s flags:'%s'", substr + idx + 1);
413 while (substr[++idx]) {
414 dbg("s flag:'%c'", substr[idx]);
415 /* Parse match number */
416 if (isdigit(substr[idx])) {
417 if (match[0] != '^') {
418 /* Match 0 treated as all, multiple matches we take the last one. */
419 const char *pos = substr + idx;
420 /* FIXME: error check? */
421 sed_cmd->which_match = (unsigned)strtol(substr+idx, (char**) &pos, 10);
422 idx = pos - substr - 1;
427 if (isspace(substr[idx]))
430 switch (substr[idx]) {
431 /* Replace all occurrences */
434 sed_cmd->which_match = 0;
436 /* Print pattern space */
444 idx += parse_file_cmd(/*sed_cmd,*/ substr+idx+1, &fname);
445 sed_cmd->sw_file = xfopen_for_write(fname);
446 sed_cmd->sw_last_char = '\n';
450 /* Ignore case (gnu extension) */
457 // while (substr[++idx]) continue;
458 idx += strlen(substr + idx); // same
465 dbg("s bad flags:'%s'", substr + idx);
466 bb_error_msg_and_die("bad option in substitution expression");
470 /* compile the match string into a regex */
471 if (*match != '\0') {
472 /* If match is empty, we use last regex used at runtime */
473 sed_cmd->sub_match = xzalloc(sizeof(regex_t));
474 dbg("xregcomp('%s',%x)", match, cflags);
475 xregcomp(sed_cmd->sub_match, match, cflags);
484 * Process the commands arguments
486 static const char *parse_cmd_args(sed_cmd_t *sed_cmd, const char *cmdstr)
488 static const char cmd_letters[] ALIGN1 = "saicrw:btTydDgGhHlnNpPqx={}";
521 BUILD_BUG_ON(sizeof(cmd_letters)-1 != IDX_nul);
523 idx = strchrnul(cmd_letters, sed_cmd->cmd) - cmd_letters;
525 /* handle (s)ubstitution command */
527 cmdstr += parse_subst_cmd(sed_cmd, cmdstr);
529 /* handle edit cmds: (a)ppend, (i)nsert, and (c)hange */
530 else if (idx <= IDX_c) { /* a,i,c */
533 if (idx < IDX_c) { /* a,i */
534 if (sed_cmd->end_line || sed_cmd->end_match)
535 bb_error_msg_and_die("command '%c' uses only one address", sed_cmd->cmd);
538 if (*cmdstr == '\n' || *cmdstr == '\\') {
542 if (!isspace(*cmdstr))
546 len = strlen(cmdstr);
547 sed_cmd->string = copy_parsing_escapes(cmdstr, len);
549 /* "\anychar" -> "anychar" */
550 parse_escapes(sed_cmd->string, sed_cmd->string, -1, '\0', '\0');
552 /* handle file cmds: (r)ead */
553 else if (idx <= IDX_w) { /* r,w */
554 if (idx < IDX_w) { /* r */
555 if (sed_cmd->end_line || sed_cmd->end_match)
556 bb_error_msg_and_die("command '%c' uses only one address", sed_cmd->cmd);
558 cmdstr += parse_file_cmd(/*sed_cmd,*/ cmdstr, &sed_cmd->string);
559 if (sed_cmd->cmd == 'w') {
560 sed_cmd->sw_file = xfopen_for_write(sed_cmd->string);
561 sed_cmd->sw_last_char = '\n';
564 /* handle branch commands */
565 else if (idx <= IDX_T) { /* :,b,t,T */
568 cmdstr = skip_whitespace(cmdstr);
569 length = strcspn(cmdstr, semicolon_whitespace);
571 sed_cmd->string = xstrndup(cmdstr, length);
575 /* translation command */
576 else if (idx == IDX_y) {
577 char *match, *replace;
580 cmdstr += parse_regex_delim(cmdstr, &match, &replace)+1;
581 /* \n already parsed, but \delimiter needs unescaping. */
582 parse_escapes(match, match, -1, i, i);
583 parse_escapes(replace, replace, -1, i, i);
585 sed_cmd->string = xzalloc((strlen(match) + 1) * 2);
586 for (i = 0; match[i] && replace[i]; i++) {
587 sed_cmd->string[i*2] = match[i];
588 sed_cmd->string[i*2+1] = replace[i];
593 /* if it wasn't a single-letter command that takes no arguments
594 * then it must be an invalid command.
596 else if (idx >= IDX_nul) { /* not d,D,g,G,h,H,l,n,N,p,P,q,x,=,{,} */
597 bb_error_msg_and_die("unsupported command %c", sed_cmd->cmd);
600 /* give back whatever's left over */
605 /* Parse address+command sets, skipping comment lines. */
607 static void add_cmd(const char *cmdstr)
612 /* Append this line to any unfinished line from last time. */
613 if (G.add_cmd_line) {
614 char *tp = xasprintf("%s\n%s", G.add_cmd_line, cmdstr);
615 free(G.add_cmd_line);
616 cmdstr = G.add_cmd_line = tp;
619 /* If this line ends with unescaped backslash, request next line. */
620 n = len = strlen(cmdstr);
621 while (n && cmdstr[n-1] == '\\')
623 if ((len - n) & 1) { /* if odd number of trailing backslashes */
625 G.add_cmd_line = xstrdup(cmdstr);
626 G.add_cmd_line[len-1] = '\0';
630 /* Loop parsing all commands in this line. */
632 /* Skip leading whitespace and semicolons */
633 cmdstr += strspn(cmdstr, semicolon_whitespace);
635 /* If no more commands, exit. */
638 /* if this is a comment, jump past it and keep going */
639 if (*cmdstr == '#') {
640 /* "#n" is the same as using -n on the command line */
641 if (cmdstr[1] == 'n')
643 cmdstr = strpbrk(cmdstr, "\n\r");
649 * format is: [addr][,addr][!]cmd
654 sed_cmd = xzalloc(sizeof(sed_cmd_t));
656 /* first part (if present) is an address: either a '$', a number or a /regex/ */
657 cmdstr += get_address(cmdstr, &sed_cmd->beg_line, &sed_cmd->beg_match);
658 sed_cmd->beg_line_orig = sed_cmd->beg_line;
660 /* second part (if present) will begin with a comma */
661 if (*cmdstr == ',') {
665 if (*cmdstr == '+' && isdigit(cmdstr[1])) {
666 /* http://sed.sourceforge.net/sedfaq3.html#s3.3
667 * Under GNU sed 3.02+, ssed, and sed15+, <address2>
668 * may also be a notation of the form +num,
669 * indicating the next num lines after <address1> is
671 * GNU sed 4.2.1 accepts even "+" (meaning "+0").
672 * We don't (we check for isdigit, see above), think
673 * about the "+-3" case.
676 /* code is smaller compared to using &cmdstr here: */
677 idx = strtol(cmdstr+1, &end, 10);
678 sed_cmd->end_line = -2 - idx;
681 idx = get_address(cmdstr, &sed_cmd->end_line, &sed_cmd->end_match);
683 idx--; /* if 0, trigger error check below */
686 bb_error_msg_and_die("no address after comma");
687 sed_cmd->end_line_orig = sed_cmd->end_line;
690 /* skip whitespace before the command */
691 cmdstr = skip_whitespace(cmdstr);
693 /* Check for inversion flag */
694 if (*cmdstr == '!') {
698 /* skip whitespace before the command */
699 cmdstr = skip_whitespace(cmdstr);
702 /* last part (mandatory) will be a command */
704 bb_error_msg_and_die("missing command");
705 sed_cmd->cmd = *cmdstr++;
706 cmdstr = parse_cmd_args(sed_cmd, cmdstr);
708 /* cmdstr now points past args.
709 * GNU sed requires a separator, if there are more commands,
710 * else it complains "char N: extra characters after command".
711 * Example: "sed 'p;d'". We also allow "sed 'pd'".
714 /* Add the command to the command array */
715 *G.sed_cmd_tail = sed_cmd;
716 G.sed_cmd_tail = &sed_cmd->next;
719 /* If we glued multiple lines together, free the memory. */
720 free(G.add_cmd_line);
721 G.add_cmd_line = NULL;
724 /* Append to a string, reallocating memory as necessary. */
728 static void pipe_putc(char c)
730 if (G.pipeline.idx == G.pipeline.len) {
731 G.pipeline.buf = xrealloc(G.pipeline.buf,
732 G.pipeline.len + PIPE_GROW);
733 G.pipeline.len += PIPE_GROW;
735 G.pipeline.buf[G.pipeline.idx++] = c;
738 static void do_subst_w_backrefs(char *line, char *replace)
742 /* go through the replacement string */
743 for (i = 0; replace[i]; i++) {
744 /* if we find a backreference (\1, \2, etc.) print the backref'ed text */
745 if (replace[i] == '\\') {
746 unsigned backref = replace[++i] - '0';
748 /* print out the text held in G.regmatch[backref] */
749 if (G.regmatch[backref].rm_so != -1) {
750 j = G.regmatch[backref].rm_so;
751 while (j < G.regmatch[backref].rm_eo)
752 pipe_putc(line[j++]);
756 /* I _think_ it is impossible to get '\' to be
757 * the last char in replace string. Thus we don't check
758 * for replace[i] == NUL. (counterexample anyone?) */
759 /* if we find a backslash escaped character, print the character */
760 pipe_putc(replace[i]);
763 /* if we find an unescaped '&' print out the whole matched text. */
764 if (replace[i] == '&') {
765 j = G.regmatch[0].rm_so;
766 while (j < G.regmatch[0].rm_eo)
767 pipe_putc(line[j++]);
770 /* Otherwise just output the character. */
771 pipe_putc(replace[i]);
775 static int do_subst_command(sed_cmd_t *sed_cmd, char **line_p)
777 char *line = *line_p;
778 unsigned match_count = 0;
780 bool prev_match_empty = 1;
781 bool tried_at_eol = 0;
782 regex_t *current_regex;
784 current_regex = sed_cmd->sub_match;
785 /* Handle empty regex. */
786 if (!current_regex) {
787 current_regex = G.previous_regex_ptr;
789 bb_error_msg_and_die("no previous regexp");
791 G.previous_regex_ptr = current_regex;
793 /* Find the first match */
794 dbg("matching '%s'", line);
795 if (REG_NOMATCH == regexec(current_regex, line, 10, G.regmatch, 0)) {
801 /* Initialize temporary output buffer. */
802 G.pipeline.buf = xmalloc(PIPE_GROW);
803 G.pipeline.len = PIPE_GROW;
806 /* Now loop through, substituting for matches */
808 int start = G.regmatch[0].rm_so;
809 int end = G.regmatch[0].rm_eo;
814 /* If we aren't interested in this match, output old line to
815 * end of match and continue */
816 if (sed_cmd->which_match
817 && (sed_cmd->which_match != match_count)
819 for (i = 0; i < end; i++)
821 /* Null match? Print one more char */
822 if (start == end && *line)
827 /* Print everything before the match */
828 for (i = 0; i < start; i++)
831 /* Then print the substitution string,
832 * unless we just matched empty string after non-empty one.
833 * Example: string "cccd", pattern "c*", repl "R":
834 * result is "RdR", not "RRdR": first match "ccc",
835 * second is "" before "d", third is "" after "d".
836 * Second match is NOT replaced!
838 if (prev_match_empty || start != 0 || start != end) {
839 //dbg("%d %d %d", prev_match_empty, start, end);
840 dbg("inserting replacement at %d in '%s'", start, line);
841 do_subst_w_backrefs(line, sed_cmd->string);
842 /* Flag that something has changed */
845 dbg("NOT inserting replacement at %d in '%s'", start, line);
848 /* If matched string is empty (f.e. "c*" pattern),
849 * copy verbatim one char after it before attempting more matches
851 prev_match_empty = (start == end);
852 if (prev_match_empty) {
856 pipe_putc(line[end]);
861 /* Advance past the match */
862 dbg("line += %d", end);
865 /* if we're not doing this globally, get out now */
866 if (sed_cmd->which_match != 0)
869 /* Exit if we are at EOL and already tried matching at it */
876 //maybe (end ? REG_NOTBOL : 0) instead of unconditional REG_NOTBOL?
877 } while (regexec(current_regex, line, 10, G.regmatch, REG_NOTBOL) != REG_NOMATCH);
879 /* Copy rest of string into output pipeline */
888 *line_p = G.pipeline.buf;
892 /* Set command pointer to point to this label. (Does not handle null label.) */
893 static sed_cmd_t *branch_to(char *label)
897 for (sed_cmd = G.sed_cmd_head; sed_cmd; sed_cmd = sed_cmd->next) {
898 if (sed_cmd->cmd == ':'
900 && strcmp(sed_cmd->string, label) == 0
905 bb_error_msg_and_die("can't find label for jump to '%s'", label);
908 static void append(char *s)
910 llist_add_to_end(&G.append_head, s);
913 /* Output line of text. */
915 * The tricks with NO_EOL_CHAR and last_puts_char are there to emulate gnu sed.
916 * Without them, we had this:
920 * sed "s/i/z/" z1 z2 znull | hexdump -vC
923 * 00000000 74 68 7a 6e 67 79 0a 61 67 61 7a 6e |thzngy.agazn|
925 * 00000000 74 68 7a 6e 67 79 61 67 61 7a 6e |thzngyagazn|
931 static void puts_maybe_newline(char *s, FILE *file, char *last_puts_char, char last_gets_char)
933 char lpc = *last_puts_char;
935 /* Need to insert a '\n' between two files because first file's
936 * last line wasn't terminated? */
937 if (lpc != '\n' && lpc != '\0') {
943 /* 'x' - just something which is not '\n', '\0' or NO_EOL_CHAR */
947 /* had trailing '\0' and it was last char of file? */
948 if (last_gets_char == LAST_IS_NUL) {
952 /* had trailing '\n' or '\0'? */
953 if (last_gets_char != NO_EOL_CHAR) {
954 fputc(last_gets_char, file);
955 lpc = last_gets_char;
959 xfunc_error_retval = 4; /* It's what gnu sed exits with... */
960 bb_error_msg_and_die(bb_msg_write_error);
962 *last_puts_char = lpc;
965 static void flush_append(char *last_puts_char)
969 /* Output appended lines. */
970 while ((data = (char *)llist_pop(&G.append_head)) != NULL) {
971 /* Append command does not respect "nonterminated-ness"
972 * of last line. Try this:
973 * $ echo -n "woot" | sed -e '/woot/a woo' -
976 * (both lines are terminated with \n)
977 * Therefore we do not propagate "last_gets_char" here,
980 puts_maybe_newline(data, G.nonstdout, last_puts_char, '\n');
985 /* Get next line of input from G.input_file_list, flushing append buffer and
986 * noting if we ran out of files without a newline on the last line we read.
988 static char *get_next_line(char *gets_char, char *last_puts_char)
994 flush_append(last_puts_char);
996 /* will be returned if last line in the file
997 * doesn't end with either '\n' or '\0' */
999 for (; G.current_input_file <= G.last_input_file; G.current_input_file++) {
1000 FILE *fp = G.current_fp;
1002 const char *path = G.input_file_list[G.current_input_file];
1004 if (path != bb_msg_standard_input) {
1005 fp = fopen_or_warn(path, "r");
1007 G.exitcode = EXIT_FAILURE;
1013 /* Read line up to a newline or NUL byte, inclusive,
1014 * return malloc'ed char[]. length of the chunk read
1015 * is stored in len. NULL if EOF/error */
1016 temp = bb_get_chunk_from_file(fp, &len);
1018 /* len > 0 here, it's ok to do temp[len-1] */
1019 char c = temp[len-1];
1020 if (c == '\n' || c == '\0') {
1031 /* else we put NO_EOL_CHAR into *gets_char */
1034 /* NB: I had the idea of peeking next file(s) and returning
1035 * NO_EOL_CHAR only if it is the *last* non-empty
1036 * input file. But there is a case where this won't work:
1037 * file1: "a woo\nb woo"
1038 * file2: "c no\nd no"
1039 * sed -ne 's/woo/bang/p' input1 input2 => "a bang\nb bang"
1040 * (note: *no* newline after "b bang"!) */
1042 /* Close this file and advance to next one */
1043 fclose_if_not_stdin(fp);
1044 G.current_fp = NULL;
1050 #define sed_puts(s, n) (puts_maybe_newline(s, G.nonstdout, &last_puts_char, n))
1052 static int beg_match(sed_cmd_t *sed_cmd, const char *pattern_space)
1054 int retval = sed_cmd->beg_match && !regexec(sed_cmd->beg_match, pattern_space, 0, NULL, 0);
1056 G.previous_regex_ptr = sed_cmd->beg_match;
1060 /* Process all the lines in all the files */
1062 static void process_files(void)
1064 char *pattern_space, *next_line;
1066 char last_puts_char = '\n';
1067 char last_gets_char, next_gets_char;
1071 /* Prime the pump */
1072 next_line = get_next_line(&next_gets_char, &last_puts_char);
1074 /* Go through every line in each file */
1078 /* Advance to next line. Stop if out of lines. */
1079 pattern_space = next_line;
1082 last_gets_char = next_gets_char;
1084 /* Read one line in advance so we can act on the last line,
1085 * the '$' address */
1086 next_line = get_next_line(&next_gets_char, &last_puts_char);
1089 /* For every line, go through all the commands */
1091 for (sed_cmd = G.sed_cmd_head; sed_cmd; sed_cmd = sed_cmd->next) {
1092 int old_matched, matched;
1094 old_matched = sed_cmd->in_match;
1096 /* Determine if this command matches this line: */
1098 dbg("match1:%d", sed_cmd->in_match);
1099 dbg("match2:%d", (!sed_cmd->beg_line && !sed_cmd->end_line
1100 && !sed_cmd->beg_match && !sed_cmd->end_match));
1101 dbg("match3:%d", (sed_cmd->beg_line > 0
1102 && (sed_cmd->end_line || sed_cmd->end_match
1103 ? (sed_cmd->beg_line <= linenum)
1104 : (sed_cmd->beg_line == linenum)
1107 dbg("match4:%d", (beg_match(sed_cmd, pattern_space)));
1108 dbg("match5:%d", (sed_cmd->beg_line == -1 && next_line == NULL));
1110 /* Are we continuing a previous multi-line match? */
1111 sed_cmd->in_match = sed_cmd->in_match
1112 /* Or is no range necessary? */
1113 || (!sed_cmd->beg_line && !sed_cmd->end_line
1114 && !sed_cmd->beg_match && !sed_cmd->end_match)
1115 /* Or did we match the start of a numerical range? */
1116 || (sed_cmd->beg_line > 0
1117 && (sed_cmd->end_line || sed_cmd->end_match
1118 /* note: even if end is numeric and is < linenum too,
1119 * GNU sed matches! We match too, therefore we don't
1120 * check here that linenum <= end.
1122 * printf '1\n2\n3\n4\n' | sed -n '1{N;N;d};1p;2,3p;3p;4p'
1123 * first three input lines are deleted;
1124 * 4th line is matched and printed
1125 * by "2,3" (!) and by "4" ranges
1127 ? (sed_cmd->beg_line <= linenum) /* N,end */
1128 : (sed_cmd->beg_line == linenum) /* N */
1131 /* Or does this line match our begin address regex? */
1132 || (beg_match(sed_cmd, pattern_space))
1133 /* Or did we match last line of input? */
1134 || (sed_cmd->beg_line == -1 && next_line == NULL);
1136 /* Snapshot the value */
1137 matched = sed_cmd->in_match;
1139 dbg("cmd:'%c' matched:%d beg_line:%d end_line:%d linenum:%d",
1140 sed_cmd->cmd, matched, sed_cmd->beg_line, sed_cmd->end_line, linenum);
1142 /* Is this line the end of the current match? */
1145 if (sed_cmd->end_line <= -2) {
1146 /* address2 is +N, i.e. N lines from beg_line */
1147 sed_cmd->end_line = linenum + (-sed_cmd->end_line - 2);
1149 /* once matched, "n,xxx" range is dead, disabling it */
1150 if (sed_cmd->beg_line > 0) {
1151 sed_cmd->beg_line = -2;
1153 dbg("end1:%d", sed_cmd->end_line ? sed_cmd->end_line == -1
1154 ? !next_line : (sed_cmd->end_line <= linenum)
1155 : !sed_cmd->end_match);
1156 dbg("end2:%d", sed_cmd->end_match && old_matched
1157 && !regexec(sed_cmd->end_match,pattern_space, 0, NULL, 0));
1158 sed_cmd->in_match = !(
1159 /* has the ending line come, or is this a single address command? */
1161 ? sed_cmd->end_line == -1
1163 : (sed_cmd->end_line <= linenum)
1164 : !sed_cmd->end_match
1166 /* or does this line matches our last address regex */
1167 || (sed_cmd->end_match && old_matched
1168 && (regexec(sed_cmd->end_match,
1169 pattern_space, 0, NULL, 0) == 0)
1174 /* Skip blocks of commands we didn't match */
1175 if (sed_cmd->cmd == '{') {
1176 if (sed_cmd->invert ? matched : !matched) {
1177 unsigned nest_cnt = 0;
1179 if (sed_cmd->cmd == '{')
1181 if (sed_cmd->cmd == '}') {
1186 sed_cmd = sed_cmd->next;
1188 bb_error_msg_and_die("unterminated {");
1194 /* Okay, so did this line match? */
1195 if (sed_cmd->invert ? matched : !matched)
1198 /* Update last used regex in case a blank substitute BRE is found */
1199 if (sed_cmd->beg_match) {
1200 G.previous_regex_ptr = sed_cmd->beg_match;
1203 /* actual sedding */
1204 dbg("pattern_space:'%s' next_line:'%s' cmd:%c",
1205 pattern_space, next_line, sed_cmd->cmd);
1206 switch (sed_cmd->cmd) {
1208 /* Print line number */
1210 fprintf(G.nonstdout, "%d\n", linenum);
1213 /* Write the current pattern space up to the first newline */
1216 char *tmp = strchr(pattern_space, '\n');
1219 /* TODO: explain why '\n' below */
1220 sed_puts(pattern_space, '\n');
1227 /* Write the current pattern space to output */
1229 /* NB: we print this _before_ the last line
1230 * (of current file) is printed. Even if
1231 * that line is nonterminated, we print
1232 * '\n' here (gnu sed does the same) */
1233 sed_puts(pattern_space, '\n');
1235 /* Delete up through first newline */
1238 char *tmp = strchr(pattern_space, '\n');
1240 overlapping_strcpy(pattern_space, tmp + 1);
1244 /* discard this line. */
1248 /* Substitute with regex */
1250 if (!do_subst_command(sed_cmd, &pattern_space))
1252 dbg("do_subst_command succeeded:'%s'", pattern_space);
1255 /* handle p option */
1257 sed_puts(pattern_space, last_gets_char);
1258 /* handle w option */
1259 if (sed_cmd->sw_file)
1261 pattern_space, sed_cmd->sw_file,
1262 &sed_cmd->sw_last_char, last_gets_char);
1265 /* Append line to linked list to be printed later */
1267 append(xstrdup(sed_cmd->string));
1270 /* Insert text before this line */
1272 sed_puts(sed_cmd->string, '\n');
1275 /* Cut and paste text (replace) */
1277 /* Only triggers on last line of a matching range. */
1278 if (!sed_cmd->in_match)
1279 sed_puts(sed_cmd->string, '\n');
1282 /* Read file, append contents to output */
1286 rfile = fopen_for_read(sed_cmd->string);
1289 while ((line = xmalloc_fgetline(rfile))
1298 /* Write pattern space to file. */
1301 pattern_space, sed_cmd->sw_file,
1302 &sed_cmd->sw_last_char, last_gets_char);
1305 /* Read next line from input */
1308 sed_puts(pattern_space, last_gets_char);
1309 if (next_line == NULL) {
1310 /* If no next line, jump to end of script and exit. */
1313 free(pattern_space);
1314 pattern_space = next_line;
1315 last_gets_char = next_gets_char;
1316 next_line = get_next_line(&next_gets_char, &last_puts_char);
1321 /* Quit. End of script, end of input. */
1323 /* Exit the outer while loop */
1326 goto discard_commands;
1328 /* Append the next line to the current line */
1332 /* If no next line, jump to end of script and exit. */
1333 /* http://www.gnu.org/software/sed/manual/sed.html:
1334 * "Most versions of sed exit without printing anything
1335 * when the N command is issued on the last line of
1336 * a file. GNU sed prints pattern space before exiting
1337 * unless of course the -n command switch has been
1338 * specified. This choice is by design."
1340 if (next_line == NULL) {
1341 //goto discard_line;
1342 goto discard_commands; /* GNU behavior */
1344 /* Append next_line, read new next_line. */
1345 len = strlen(pattern_space);
1346 pattern_space = xrealloc(pattern_space, len + strlen(next_line) + 2);
1347 pattern_space[len] = '\n';
1348 strcpy(pattern_space + len+1, next_line);
1349 last_gets_char = next_gets_char;
1350 next_line = get_next_line(&next_gets_char, &last_puts_char);
1355 /* Test/branch if substitution occurred */
1357 if (!substituted) break;
1360 /* Test/branch if substitution didn't occur */
1362 if (substituted) break;
1364 /* Branch to label */
1366 if (!sed_cmd->string) goto discard_commands;
1367 else sed_cmd = branch_to(sed_cmd->string);
1369 /* Transliterate characters */
1373 for (i = 0; pattern_space[i]; i++) {
1374 for (j = 0; sed_cmd->string[j]; j += 2) {
1375 if (pattern_space[i] == sed_cmd->string[j]) {
1376 pattern_space[i] = sed_cmd->string[j + 1];
1384 case 'g': /* Replace pattern space with hold space */
1385 free(pattern_space);
1386 pattern_space = xstrdup(G.hold_space ? G.hold_space : "");
1388 case 'G': /* Append newline and hold space to pattern space */
1390 int pattern_space_size = 2;
1391 int hold_space_size = 0;
1394 pattern_space_size += strlen(pattern_space);
1396 hold_space_size = strlen(G.hold_space);
1397 pattern_space = xrealloc(pattern_space,
1398 pattern_space_size + hold_space_size);
1399 if (pattern_space_size == 2)
1400 pattern_space[0] = 0;
1401 strcat(pattern_space, "\n");
1403 strcat(pattern_space, G.hold_space);
1404 last_gets_char = '\n';
1408 case 'h': /* Replace hold space with pattern space */
1410 G.hold_space = xstrdup(pattern_space);
1412 case 'H': /* Append newline and pattern space to hold space */
1414 int hold_space_size = 2;
1415 int pattern_space_size = 0;
1418 hold_space_size += strlen(G.hold_space);
1420 pattern_space_size = strlen(pattern_space);
1421 G.hold_space = xrealloc(G.hold_space,
1422 hold_space_size + pattern_space_size);
1424 if (hold_space_size == 2)
1426 strcat(G.hold_space, "\n");
1428 strcat(G.hold_space, pattern_space);
1432 case 'x': /* Exchange hold and pattern space */
1434 char *tmp = pattern_space;
1435 pattern_space = G.hold_space ? G.hold_space : xzalloc(1);
1436 last_gets_char = '\n';
1441 } /* for each cmd */
1444 * Exit point from sedding...
1447 /* we will print the line unless we were told to be quiet ('-n')
1448 or if the line was suppressed (ala 'd'elete) */
1450 sed_puts(pattern_space, last_gets_char);
1452 /* Delete and such jump here. */
1454 flush_append(&last_puts_char /*,last_gets_char*/);
1455 free(pattern_space);
1460 /* It is possible to have a command line argument with embedded
1461 * newlines. This counts as multiple command lines.
1462 * However, newline can be escaped: 's/e/z\<newline>z/'
1463 * add_cmd() handles this.
1466 static void add_cmd_block(char *cmdstr)
1470 cmdstr = sv = xstrdup(cmdstr);
1472 eol = strchr(cmdstr, '\n');
1481 int sed_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1482 int sed_main(int argc UNUSED_PARAM, char **argv)
1485 llist_t *opt_e, *opt_f;
1488 #if ENABLE_LONG_OPTS
1489 static const char sed_longopts[] ALIGN1 =
1490 /* name has_arg short */
1491 "in-place\0" Optional_argument "i"
1492 "regexp-extended\0" No_argument "r"
1493 "quiet\0" No_argument "n"
1494 "silent\0" No_argument "n"
1495 "expression\0" Required_argument "e"
1496 "file\0" Required_argument "f";
1501 /* destroy command strings on exit */
1502 if (ENABLE_FEATURE_CLEAN_UP) atexit(sed_free_and_close_stuff);
1504 /* Lie to autoconf when it starts asking stupid questions. */
1505 if (argv[1] && strcmp(argv[1], "--version") == 0) {
1506 puts("This is not GNU sed version 4.0");
1510 /* do normal option parsing */
1511 opt_e = opt_f = NULL;
1513 /* -i must be first, to match OPT_in_place definition */
1514 /* -E is a synonym of -r:
1515 * GNU sed 4.2.1 mentions it in neither --help
1516 * nor manpage, but does recognize it.
1518 opt = getopt32long(argv, "^"
1520 "\0" "nn"/*count -n*/,
1522 &opt_i, &opt_e, &opt_f,
1523 &G.be_quiet); /* counter for -n */
1526 if (opt & OPT_in_place) { // -i
1527 die_func = cleanup_outname;
1530 G.regex_type |= REG_EXTENDED; // -r or -E
1532 // G.be_quiet++; // -n (implemented with a counter instead)
1533 while (opt_e) { // -e
1534 add_cmd_block(llist_pop(&opt_e));
1536 while (opt_f) { // -f
1539 cmdfile = xfopen_stdin(llist_pop(&opt_f));
1540 while ((line = xmalloc_fgetline(cmdfile)) != NULL) {
1544 fclose_if_not_stdin(cmdfile);
1546 /* if we didn't get a pattern from -e or -f, use argv[0] */
1547 if (!(opt & 0x30)) {
1550 add_cmd_block(*argv++);
1552 /* Flush any unfinished commands. */
1555 /* By default, we write to stdout */
1556 G.nonstdout = stdout;
1558 /* argv[0..(argc-1)] should be names of file to process. If no
1559 * files were specified or '-' was specified, take input from stdin.
1560 * Otherwise, we process all the files specified. */
1561 G.input_file_list = argv;
1563 if (opt & OPT_in_place)
1564 bb_error_msg_and_die(bb_msg_requires_arg, "-i");
1565 argv[0] = (char*)bb_msg_standard_input;
1566 /* G.last_input_file = 0; - already is */
1570 for (; *argv; argv++) {
1571 struct stat statbuf;
1575 G.last_input_file++;
1577 if (!(opt & OPT_in_place)) {
1578 if (LONE_DASH(*argv)) {
1579 *argv = (char*)bb_msg_standard_input;
1585 /* -i: process each FILE separately: */
1587 if (stat(*argv, &statbuf) != 0) {
1588 bb_simple_perror_msg(*argv);
1589 G.exitcode = EXIT_FAILURE;
1590 G.current_input_file++;
1593 G.outname = xasprintf("%sXXXXXX", *argv);
1594 nonstdoutfd = xmkstemp(G.outname);
1595 G.nonstdout = xfdopen_for_write(nonstdoutfd);
1596 /* Set permissions/owner of output file */
1597 /* chmod'ing AFTER chown would preserve suid/sgid bits,
1598 * but GNU sed 4.2.1 does not preserve them either */
1599 fchmod(nonstdoutfd, statbuf.st_mode);
1600 fchown(nonstdoutfd, statbuf.st_uid, statbuf.st_gid);
1603 fclose(G.nonstdout);
1604 G.nonstdout = stdout;
1607 char *backupname = xasprintf("%s%s", *argv, opt_i);
1608 xrename(*argv, backupname);
1611 /* else unlink(*argv); - rename below does this */
1612 xrename(G.outname, *argv); //TODO: rollback backup on error?
1616 /* Fix disabled range matches and mangled ",+N" ranges */
1617 for (sed_cmd = G.sed_cmd_head; sed_cmd; sed_cmd = sed_cmd->next) {
1618 sed_cmd->beg_line = sed_cmd->beg_line_orig;
1619 sed_cmd->end_line = sed_cmd->end_line_orig;
1622 /* Here, to handle "sed 'cmds' nonexistent_file" case we did:
1623 * if (G.current_input_file[G.current_input_file] == NULL)
1624 * return G.exitcode;
1625 * but it's not needed since process_files() works correctly
1626 * in this case too. */