Notes on portability, and on when #include <linux/blah> is appropriate.
[oweals/busybox.git] / findutils / grep.c
index e26a8d5ad8872837ac2607746f79593b6e2cccc2..e5b5e3242dfd6b23419c67926ac3f8d989e299ac 100644 (file)
+/* vi: set sw=4 ts=4: */
 /*
  * Mini grep implementation for busybox using libc regex.
  *
  * Copyright (C) 1999,2000,2001 by Lineo, inc. and Mark Whitley
- * Copyright (C) 1999,2000,2001 by Mark Whitley <markw@codepoet.org> 
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program 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
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Copyright (C) 1999,2000,2001 by Mark Whitley <markw@codepoet.org>
  *
+ * Licensed under the GPL v2, see the file LICENSE in this tarball.
  */
+/* BB_AUDIT SUSv3 defects - unsupported option -x.  */
+/* BB_AUDIT GNU defects - always acts as -a.  */
+/* http://www.opengroup.org/onlinepubs/007904975/utilities/grep.html */
+/*
+ * 2004,2006 (C) Vladimir Oleynik <dzo@simtreas.ru> -
+ * correction "-e pattern1 -e pattern2" logic and more optimizations.
+ * precompiled regex
+*/
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <getopt.h>
-#include <regex.h>
-#include <string.h> /* for strerror() */
+#include <string.h>
 #include <errno.h>
 #include "busybox.h"
+#include "xregex.h"
 
 
-extern int optind; /* in unistd.h */
-extern void xregcomp(regex_t *preg, const char *regex, int cflags); /* in busybox.h */
-
 /* options */
-static int reflags            = REG_NOSUB; 
-static int print_filename     = 0;
-static int print_line_num     = 0;
-static int print_match_counts = 0;
-static int be_quiet           = 0;
-static int invert_search      = 0;
-static int suppress_err_msgs  = 0;
-static int print_files_with_matches  = 0;
-static int fgrep_flag           = 0;
-
-#ifdef CONFIG_FEATURE_GREP_CONTEXT
-extern char *optarg; /* in getopt.h */
-static int lines_before      = 0;
-static int lines_after       = 0;
-static char **before_buf     = NULL;
-static int last_line_printed = 0;
-#endif /* CONFIG_FEATURE_GREP_CONTEXT */
+static unsigned long opt;
+#define GREP_OPTS "lnqvscFiHhe:f:L"
+#define GREP_OPT_l (1<<0)
+#define PRINT_FILES_WITH_MATCHES (opt & GREP_OPT_l)
+#define GREP_OPT_n (1<<1)
+#define PRINT_LINE_NUM (opt & GREP_OPT_n)
+#define GREP_OPT_q (1<<2)
+#define BE_QUIET (opt & GREP_OPT_q)
+#define GREP_OPT_v (1<<3)
+typedef char invert_search_t;
+static invert_search_t invert_search;
+#define GREP_OPT_s (1<<4)
+#define SUPPRESS_ERR_MSGS (opt & GREP_OPT_s)
+#define GREP_OPT_c (1<<5)
+#define PRINT_MATCH_COUNTS (opt & GREP_OPT_c)
+#define GREP_OPT_F (1<<6)
+#define FGREP_FLAG (opt & GREP_OPT_F)
+#define GREP_OPT_i (1<<7)
+#define GREP_OPT_H (1<<8)
+#define GREP_OPT_h (1<<9)
+#define GREP_OPT_e (1<<10)
+#define GREP_OPT_f (1<<11)
+#define GREP_OPT_L (1<<12)
+#define PRINT_FILES_WITHOUT_MATCHES ((opt & GREP_OPT_L) != 0)
+#if ENABLE_FEATURE_GREP_CONTEXT
+#define GREP_OPT_CONTEXT "A:B:C"
+#define GREP_OPT_A (1<<13)
+#define GREP_OPT_B (1<<14)
+#define GREP_OPT_C (1<<15)
+#define GREP_OPT_E (1<<16)
+#else
+#define GREP_OPT_CONTEXT ""
+#define GREP_OPT_A (0)
+#define GREP_OPT_B (0)
+#define GREP_OPT_C (0)
+#define GREP_OPT_E (1<<13)
+#endif
+#if ENABLE_FEATURE_GREP_EGREP_ALIAS
+# define OPT_EGREP "E"
+#else
+# define OPT_EGREP ""
+#endif
+
+static int reflags;
+static int print_filename;
+
+#if ENABLE_FEATURE_GREP_CONTEXT
+static int lines_before;
+static int lines_after;
+static char **before_buf;
+static int last_line_printed;
+#endif /* ENABLE_FEATURE_GREP_CONTEXT */
 
 /* globals used internally */
-static llist_t *pattern_head = NULL; /* growable list of patterns to match */
-static int matched; /* keeps track of whether we ever matched */
-static char *cur_file = NULL; /* the current file we are reading */
+static llist_t *pattern_head;   /* growable list of patterns to match */
+static char *cur_file;          /* the current file we are reading */
 
+typedef struct GREP_LIST_DATA {
+       char *pattern;
+       regex_t preg;
+#define PATTERN_MEM_A 1
+#define COMPILED 2
+       int flg_mem_alocated_compiled;
+} grep_list_data_t;
 
 static void print_line(const char *line, int linenum, char decoration)
 {
-#ifdef CONFIG_FEATURE_GREP_CONTEXT
-       /* possibly print the little '--' seperator */
+#if ENABLE_FEATURE_GREP_CONTEXT
+       /* possibly print the little '--' separator */
        if ((lines_before || lines_after) && last_line_printed &&
                        last_line_printed < linenum - 1) {
                puts("--");
        }
        last_line_printed = linenum;
 #endif
-       if (print_filename)
+       if (print_filename > 0)
                printf("%s%c", cur_file, decoration);
-       if (print_line_num)
+       if (PRINT_LINE_NUM)
                printf("%i%c", linenum, decoration);
        puts(line);
 }
 
 
-static void grep_file(FILE *file)
+static int grep_file(FILE *file)
 {
-       char *line = NULL;
-       int ret;
+       char *line;
+       invert_search_t ret;
        int linenum = 0;
        int nmatches = 0;
-#ifdef CONFIG_FEATURE_GREP_CONTEXT
+#if ENABLE_FEATURE_GREP_CONTEXT
        int print_n_lines_after = 0;
        int curpos = 0; /* track where we are in the circular 'before' buffer */
        int idx = 0; /* used for iteration through the circular buffer */
-#endif /* CONFIG_FEATURE_GREP_CONTEXT */ 
+#endif /* ENABLE_FEATURE_GREP_CONTEXT */
 
        while ((line = bb_get_chomped_line_from_file(file)) != NULL) {
                llist_t *pattern_ptr = pattern_head;
+               grep_list_data_t * gl;
 
                linenum++;
-
+               ret = 0;
                while (pattern_ptr) {
-                       if (fgrep_flag) {
-                               if (strstr(line, pattern_ptr->data)) {
-                                       /* Match found */
-                                       ret = 0;
-                               } else {
-                                       ret = 1;
-                               }
+                       gl = (grep_list_data_t *)pattern_ptr->data;
+                       if (FGREP_FLAG) {
+                               ret = strstr(line, gl->pattern) != NULL;
                        } else {
                                /*
                                 * test for a postitive-assertion match (regexec returns success (0)
@@ -107,28 +138,34 @@ static void grep_file(FILE *file)
                                 * match (regexec returns failure (REG_NOMATCH) and the user specified
                                 * invert search)
                                 */
-                               regex_t regex;
-                               xregcomp(&regex, pattern_ptr->data, reflags);
-                               ret = regexec(&regex, line, 0, NULL, 0);
-                               regfree(&regex);
+                               if(!(gl->flg_mem_alocated_compiled & COMPILED)) {
+                                       gl->flg_mem_alocated_compiled |= COMPILED;
+                                       xregcomp(&(gl->preg), gl->pattern, reflags);
+                               }
+                               ret |= regexec(&(gl->preg), line, 0, NULL, 0) == 0;
                        }
-                       if ((ret == 0 && !invert_search) || (ret == REG_NOMATCH && invert_search)) {
+                       pattern_ptr = pattern_ptr->link;
+               } /* while (pattern_ptr) */
+
+               if ((ret ^ invert_search)) {
 
-                               /* if we found a match but were told to be quiet, stop here and
-                                * return success */
-                               if (be_quiet)
-                                       exit(0);
+                       if (PRINT_FILES_WITH_MATCHES || BE_QUIET)
+                               free(line);
+
+                       /* if we found a match but were told to be quiet, stop here */
+                       if (BE_QUIET || PRINT_FILES_WITHOUT_MATCHES)
+                               return -1;
 
                                /* keep track of matches */
                                nmatches++;
 
                                /* if we're just printing filenames, we stop after the first match */
-                               if (print_files_with_matches)
+                               if (PRINT_FILES_WITH_MATCHES)
                                        break;
 
                                /* print the matched line */
-                               if (print_match_counts == 0) {
-#ifdef CONFIG_FEATURE_GREP_CONTEXT
+                               if (PRINT_MATCH_COUNTS == 0) {
+#if ENABLE_FEATURE_GREP_CONTEXT
                                        int prevpos = (curpos == 0) ? lines_before - 1 : curpos - 1;
 
                                        /* if we were told to print 'before' lines and there is at least
@@ -157,11 +194,11 @@ static void grep_file(FILE *file)
 
                                        /* make a note that we need to print 'after' lines */
                                        print_n_lines_after = lines_after;
-#endif /* CONFIG_FEATURE_GREP_CONTEXT */ 
+#endif
                                        print_line(line, linenum, ':');
                                }
                        }
-#ifdef CONFIG_FEATURE_GREP_CONTEXT
+#if ENABLE_FEATURE_GREP_CONTEXT
                        else { /* no match */
                                /* Add the line to the circular 'before' buffer */
                                if(lines_before) {
@@ -176,9 +213,7 @@ static void grep_file(FILE *file)
                                print_line(line, linenum, '-');
                                print_n_lines_after--;
                        }
-#endif /* CONFIG_FEATURE_GREP_CONTEXT */ 
-                       pattern_ptr = pattern_ptr->link;
-               } /* for */
+#endif /* ENABLE_FEATURE_GREP_CONTEXT */
                free(line);
        }
 
@@ -187,202 +222,217 @@ static void grep_file(FILE *file)
         * matches, just filenames and possibly match counts */
 
        /* grep -c: print [filename:]count, even if count is zero */
-       if (print_match_counts) {
-               if (print_filename)
+       if (PRINT_MATCH_COUNTS) {
+               if (print_filename > 0)
                        printf("%s:", cur_file);
-               if (print_files_with_matches && nmatches > 0)
-                       printf("1\n");
-               else
                    printf("%d\n", nmatches);
        }
 
        /* grep -l: print just the filename, but only if we grepped the line in the file  */
-       if (print_files_with_matches && nmatches > 0) {
+       if (PRINT_FILES_WITH_MATCHES && nmatches > 0) {
                puts(cur_file);
        }
 
+       /* grep -L: print just the filename, but only if we didn't grep the line in the file  */
+       if (PRINT_FILES_WITHOUT_MATCHES && nmatches == 0) {
+               puts(cur_file);
+       }
 
-       /* remember if we matched */
-       if (nmatches != 0)
-               matched = 1;
+       return nmatches;
 }
 
-#if 0
-static void add_pattern(char *restr)
+#if ENABLE_FEATURE_CLEAN_UP
+#define new_grep_list_data(p, m) add_grep_list_data(p, m)
+static char * add_grep_list_data(char *pattern, int flg_used_mem)
+#else
+#define new_grep_list_data(p, m) add_grep_list_data(p)
+static char * add_grep_list_data(char *pattern)
+#endif
 {
-//     regexes = xrealloc(regexes, sizeof(regex_t) * (++nregexes));
-//     xregcomp(&regexes[nregexes-1], restr, reflags);
-       pattern_head = llist_add_to(pattern_head, restr);
-}
+       grep_list_data_t *gl = xmalloc(sizeof(grep_list_data_t));
+       gl->pattern = pattern;
+#if ENABLE_FEATURE_CLEAN_UP
+       gl->flg_mem_alocated_compiled = flg_used_mem;
+#else
+       gl->flg_mem_alocated_compiled = 0;
 #endif
+       return (char *)gl;
+}
+
 
-static void    load_regexes_from_file(const char *filename)
+static void load_regexes_from_file(llist_t *fopt)
 {
        char *line;
-       FILE *f = bb_xfopen(filename, "r");
-       while ((line = bb_get_chomped_line_from_file(f)) != NULL) {
-               pattern_head = llist_add_to(pattern_head, line);
+       FILE *f;
+
+       while(fopt) {
+               llist_t *cur = fopt;
+               char *ffile = cur->data;
+
+               fopt = cur->link;
+               free(cur);
+               f = bb_xfopen(ffile, "r");
+               while ((line = bb_get_chomped_line_from_file(f)) != NULL) {
+                       pattern_head = llist_add_to(pattern_head,
+                               new_grep_list_data(line, PATTERN_MEM_A));
+               }
        }
 }
 
 
-#ifdef CONFIG_FEATURE_CLEAN_UP
-static void destroy_regexes(void)
+int grep_main(int argc, char **argv)
 {
-       llist_t *pattern_head_ptr;
-
-       if (pattern_head == NULL)
-               return;
+       FILE *file;
+       int matched;
+       llist_t *fopt = NULL;
+       int error_open_count = 0;
 
-       /* destroy all the elments in the pattern list */
-       while (pattern_head) {
-               pattern_head_ptr = pattern_head;
-               pattern_head = pattern_head->link;
-               free(pattern_head_ptr->data);
-               free(pattern_head_ptr);         
+       /* do normal option parsing */
+#if ENABLE_FEATURE_GREP_CONTEXT
+  {
+       char *junk;
+       char *slines_after;
+       char *slines_before;
+       char *Copt;
+
+       bb_opt_complementally = "H-h:e::f::C-AB";
+       opt = bb_getopt_ulflags(argc, argv,
+               GREP_OPTS GREP_OPT_CONTEXT OPT_EGREP,
+               &pattern_head, &fopt,
+               &slines_after, &slines_before, &Copt);
+
+       if(opt & GREP_OPT_C) {
+               /* C option unseted A and B options, but next -A or -B
+                  may be ovewrite own option */
+               if(!(opt & GREP_OPT_A))         /* not overwtited */
+                       slines_after = Copt;
+               if(!(opt & GREP_OPT_B))         /* not overwtited */
+                       slines_before = Copt;
+               opt |= GREP_OPT_A|GREP_OPT_B;   /* set for parse now */
        }
-}
+       if(opt & GREP_OPT_A) {
+               lines_after = strtoul(slines_after, &junk, 10);
+               if(*junk != '\0')
+                       bb_error_msg_and_die("invalid context length argument");
+       }
+       if(opt & GREP_OPT_B) {
+               lines_before = strtoul(slines_before, &junk, 10);
+               if(*junk != '\0')
+                       bb_error_msg_and_die("invalid context length argument");
+       }
+       /* sanity checks after parse may be invalid numbers ;-) */
+       if ((opt & (GREP_OPT_c|GREP_OPT_q|GREP_OPT_l|GREP_OPT_L))) {
+               opt &= ~GREP_OPT_n;
+               lines_before = 0;
+               lines_after = 0;
+       } else if(lines_before > 0)
+               before_buf = (char **)xcalloc(lines_before, sizeof(char *));
+  }
+#else
+       /* with auto sanity checks */
+       bb_opt_complementally = "H-h:e::f::c-n:q-n:l-n";
+       opt = bb_getopt_ulflags(argc, argv, GREP_OPTS OPT_EGREP,
+               &pattern_head, &fopt);
 #endif
+       invert_search = (opt & GREP_OPT_v) != 0;        /* 0 | 1 */
 
+       if(opt & GREP_OPT_H)
+               print_filename++;
+       if(opt & GREP_OPT_h)
+               print_filename--;
+       if (pattern_head != NULL) {
+               /* convert char *argv[] to grep_list_data_t */
+               llist_t *cur;
+
+               for(cur = pattern_head; cur; cur = cur->link)
+                       cur->data = new_grep_list_data(cur->data, 0);
+       }
+       if(opt & GREP_OPT_f)
+               load_regexes_from_file(fopt);
 
-extern int grep_main(int argc, char **argv)
-{
-       int opt;
-#if defined (CONFIG_FEATURE_GREP_CONTEXT)
-       char *junk;
-#endif
+       if(ENABLE_FEATURE_GREP_FGREP_ALIAS && bb_applet_name[0] == 'f')
+               opt |= GREP_OPT_F;
 
-#ifdef CONFIG_FEATURE_CLEAN_UP
-       /* destroy command strings on exit */
-       atexit(destroy_regexes);
-#endif
+       if(ENABLE_FEATURE_GREP_EGREP_ALIAS &&
+                       (bb_applet_name[0] == 'e' || (opt & GREP_OPT_E)))
+               reflags = REG_EXTENDED | REG_NOSUB;
+       else
+               reflags = REG_NOSUB;
 
-#ifdef CONFIG_FEATURE_GREP_EGREP_ALIAS
-       if (strcmp(bb_get_last_path_component(argv[0]), "egrep") == 0)
-               reflags |= REG_EXTENDED;
-#endif
+       if(opt & GREP_OPT_i)
+               reflags |= REG_ICASE;
 
-       /* do normal option parsing */
-       while ((opt = getopt(argc, argv, "iHhlnqvsce:f:F"
-#ifdef CONFIG_FEATURE_GREP_CONTEXT
-"A:B:C:"
-#endif
-#ifdef CONFIG_FEATURE_GREP_EGREP_ALIAS
-"E"
-#endif
-)) > 0) {
-               switch (opt) {
-                       case 'i':
-                               reflags |= REG_ICASE;
-                               break;
-                       case 'l':
-                               print_files_with_matches++;
-                               break;
-                       case 'H':
-                               print_filename++;
-                               break;
-                       case 'h':
-                               print_filename--;
-                               break;
-                       case 'n':
-                               print_line_num++;
-                               break;
-                       case 'q':
-                               be_quiet++;
-                               break;
-                       case 'v':
-                               invert_search++;
-                               break;
-                       case 's':
-                               suppress_err_msgs++;
-                               break;
-                       case 'c':
-                               print_match_counts++;
-                               break;
-                       case 'e':
-                               pattern_head = llist_add_to(pattern_head, strdup(optarg));
-                               break;
-#ifdef CONFIG_FEATURE_GREP_EGREP_ALIAS
-                       case 'E':
-                               reflags |= REG_EXTENDED;
-                               break;
-#endif
-                       case 'F':
-                               fgrep_flag = 1;
-                               break;
-                       case 'f':
-                               load_regexes_from_file(optarg);
-                               break;
-#ifdef CONFIG_FEATURE_GREP_CONTEXT
-                       case 'A':
-                               lines_after = strtoul(optarg, &junk, 10);
-                               if(*junk != '\0')
-                                       bb_error_msg_and_die("invalid context length argument");
-                               break;
-                       case 'B':
-                               lines_before = strtoul(optarg, &junk, 10);
-                               if(*junk != '\0')
-                                       bb_error_msg_and_die("invalid context length argument");
-                               before_buf = (char **)xcalloc(lines_before, sizeof(char *));
-                               break;
-                       case 'C':
-                               lines_after = lines_before = strtoul(optarg, &junk, 10);
-                               if(*junk != '\0')
-                                       bb_error_msg_and_die("invalid context length argument");
-                               before_buf = (char **)xcalloc(lines_before, sizeof(char *));
-                               break;
-#endif /* CONFIG_FEATURE_GREP_CONTEXT */
-                       default:
-                               bb_show_usage();
-               }
-       }
+       argv += optind;
+       argc -= optind;
 
        /* if we didn't get a pattern from a -e and no command file was specified,
         * argv[optind] should be the pattern. no pattern, no worky */
        if (pattern_head == NULL) {
-               if (argv[optind] == NULL)
+               if (*argv == NULL)
                        bb_show_usage();
                else {
-                       pattern_head = llist_add_to(pattern_head, strdup(argv[optind]));
-                       optind++;
-               }
-       }
+                       char *pattern = new_grep_list_data(*argv++, 0);
 
-       /* sanity checks */
-       if (print_match_counts || be_quiet || print_files_with_matches) {
-               print_line_num = 0;
-#ifdef CONFIG_FEATURE_GREP_CONTEXT
-               lines_before = 0;
-               lines_after = 0;
-#endif
+                       pattern_head = llist_add_to(pattern_head, pattern);
+                       argc--;
+               }
        }
 
        /* argv[(optind)..(argc-1)] should be names of file to grep through. If
         * there is more than one file to grep, we will print the filenames */
-       if ((argc-1) - (optind) > 0)
+       if (argc > 1) {
                print_filename++;
 
        /* If no files were specified, or '-' was specified, take input from
         * stdin. Otherwise, we grep through all the files specified. */
-       if (argv[optind] == NULL || (strcmp(argv[optind], "-") == 0)) {
-               grep_file(stdin);
+       } else if (argc == 0) {
+               argc++;
        }
-       else {
-               int i;
-               FILE *file;
-               for (i = optind; i < argc; i++) {
-                       cur_file = argv[i];
+       matched = 0;
+       while (argc--) {
+               cur_file = *argv++;
+               if(!cur_file || (*cur_file == '-' && !cur_file[1])) {
+                       cur_file = "(standard input)";
+                       file = stdin;
+               } else {
                        file = fopen(cur_file, "r");
-                       if (file == NULL) {
-                               if (!suppress_err_msgs)
-                                       bb_perror_msg("%s", cur_file);
-                       }
-                       else {
-                               grep_file(file);
-                               fclose(file);
+               }
+               if (file == NULL) {
+                       if (!SUPPRESS_ERR_MSGS)
+                               bb_perror_msg("%s", cur_file);
+                       error_open_count++;
+               } else {
+                       matched += grep_file(file);
+                       if(matched < 0) {
+                               /* we found a match but were told to be quiet, stop here and
+                               * return success */
+                               break;
                        }
+                       fclose(file);
                }
        }
 
+       /* destroy all the elments in the pattern list */
+       if (ENABLE_FEATURE_CLEAN_UP) {
+               while (pattern_head) {
+                       llist_t *pattern_head_ptr = pattern_head;
+                       grep_list_data_t *gl =
+                               (grep_list_data_t *)pattern_head_ptr->data;
+
+                       pattern_head = pattern_head->link;
+                       if((gl->flg_mem_alocated_compiled & PATTERN_MEM_A))
+                               free(gl->pattern);
+                       if((gl->flg_mem_alocated_compiled & COMPILED))
+                               regfree(&(gl->preg));
+                       free(pattern_head_ptr);
+               }
+       }
+       /* 0 = success, 1 = failed, 2 = error */
+       /* If the -q option is specified, the exit status shall be zero
+        * if an input line is selected, even if an error was detected.  */
+       if(BE_QUIET && matched)
+               return 0;
+       if(error_open_count)
+               return 2;
        return !matched; /* invert return value 0 = success, 1 = failed */
 }