src/head.c

   1 /* head -- output first part of file(s)
   2    Copyright (C) 89, 90, 91, 1995-2001 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 /* Options: (see usage)
  19    Reads from standard input if no files are given or when a filename of
  20    ``-'' is encountered.
  21    By default, filename headers are printed only if more than one file
  22    is given.
  23    By default, prints the first 10 lines (head -n 10).
  24
  25    David MacKenzie <djm@gnu.ai.mit.edu> */
  26
  27 #include <config.h>
  28
  29 #include <stdio.h>
  30 #include <getopt.h>
  31 #include <sys/types.h>
  32 #include "system.h"
  33 #include "closeout.h"
  34 #include "error.h"
  35 #include "xstrtol.h"
  36 #include "safe-read.h"
  37
  38 /* The official name of this program (e.g., no `g' prefix).  */
  39 #define PROGRAM_NAME "head"
  40
  41 #define AUTHORS "David MacKenzie"
  42
  43 /* Number of lines/chars/blocks to head. */
  44 #define DEFAULT_NUMBER 10
  45
  46 /* Size of atomic reads. */
  47 #define BUFSIZE (512 * 8)
  48
  49 /* If nonzero, print filename headers. */
  50 static int print_headers;
  51
  52 /* When to print the filename banners. */
  53 enum header_mode
  54 {
  55   multiple_files, always, never
  56 };
  57
  58 /* The name this program was run with. */
  59 char *program_name;
  60
  61 /* Have we ever read standard input?  */
  62 static int have_read_stdin;
  63
  64 static struct option const long_options[] =
  65 {
  66   {"bytes", required_argument, NULL, 'c'},
  67   {"lines", required_argument, NULL, 'n'},
  68   {"quiet", no_argument, NULL, 'q'},
  69   {"silent", no_argument, NULL, 'q'},
  70   {"verbose", no_argument, NULL, 'v'},
  71   {GETOPT_HELP_OPTION_DECL},
  72   {GETOPT_VERSION_OPTION_DECL},
  73   {NULL, 0, NULL, 0}
  74 };
  75
  76 void
  77 usage (int status)
  78 {
  79   if (status != 0)
  80     fprintf (stderr, _("Try `%s --help' for more information.\n"),
  81              program_name);
  82   else
  83     {
  84       printf (_("\
  85 Usage: %s [OPTION]... [FILE]...\n\
  86 "),
  87               program_name);
  88       printf (_("\
  89 Print first 10 lines of each FILE to standard output.\n\
  90 With more than one FILE, precede each with a header giving the file name.\n\
  91 With no FILE, or when FILE is -, read standard input.\n\
  92 \n\
  93   -c, --bytes=SIZE         print first SIZE bytes\n\
  94   -n, --lines=NUMBER       print first NUMBER lines instead of first 10\n\
  95   -q, --quiet, --silent    never print headers giving file names\n\
  96   -v, --verbose            always print headers giving file names\n\
  97       --help               display this help and exit\n\
  98       --version            output version information and exit\n\
  99 \n\
 100 SIZE may have a multiplier suffix: b for 512, k for 1K, m for 1 Meg.\n\
 101 If -VALUE is used as first OPTION, read -c VALUE when one of\n\
 102 multipliers bkm follows concatenated, else read -n VALUE.\n\
 103 "));
 104       puts (_("\nReport bugs to <bug-textutils@gnu.org>."));
 105     }
 106   exit (status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
 107 }
 108
 109 static void
 110 write_header (const char *filename)
 111 {
 112   static int first_file = 1;
 113
 114   printf ("%s==> %s <==\n", (first_file ? "" : "\n"), filename);
 115   first_file = 0;
 116 }
 117
 118 static int
 119 head_bytes (const char *filename, int fd, uintmax_t bytes_to_write)
 120 {
 121   char buffer[BUFSIZE];
 122   int bytes_read;
 123   size_t bytes_to_read = BUFSIZE;
 124
 125   /* Need BINARY I/O for the byte counts to be accurate.  */
 126   SET_BINARY2 (fd, fileno (stdout));
 127
 128   while (bytes_to_write)
 129     {
 130       if (bytes_to_write < bytes_to_read)
 131         bytes_to_read = bytes_to_write;
 132       bytes_read = safe_read (fd, buffer, bytes_to_read);
 133       if (bytes_read < 0)
 134         {
 135           error (0, errno, "%s", filename);
 136           return 1;
 137         }
 138       if (bytes_read == 0)
 139         break;
 140       if (fwrite (buffer, 1, bytes_read, stdout) == 0)
 141         error (EXIT_FAILURE, errno, _("write error"));
 142       bytes_to_write -= bytes_read;
 143     }
 144   return 0;
 145 }
 146
 147 static int
 148 head_lines (const char *filename, int fd, uintmax_t lines_to_write)
 149 {
 150   char buffer[BUFSIZE];
 151
 152   /* Need BINARY I/O for the byte counts to be accurate.  */
 153   SET_BINARY2 (fd, fileno (stdout));
 154
 155   while (lines_to_write)
 156     {
 157       int bytes_read = safe_read (fd, buffer, BUFSIZE);
 158       int bytes_to_write = 0;
 159
 160       if (bytes_read < 0)
 161         {
 162           error (0, errno, "%s", filename);
 163           return 1;
 164         }
 165       if (bytes_read == 0)
 166         break;
 167       while (bytes_to_write < bytes_read)
 168         if (buffer[bytes_to_write++] == '\n' && --lines_to_write == 0)
 169           break;
 170       if (fwrite (buffer, 1, bytes_to_write, stdout) == 0)
 171         error (EXIT_FAILURE, errno, _("write error"));
 172     }
 173   return 0;
 174 }
 175
 176 static int
 177 head (const char *filename, int fd, uintmax_t n_units, int count_lines)
 178 {
 179   if (print_headers)
 180     write_header (filename);
 181
 182   if (count_lines)
 183     return head_lines (filename, fd, n_units);
 184   else
 185     return head_bytes (filename, fd, n_units);
 186 }
 187
 188 static int
 189 head_file (const char *filename, uintmax_t n_units, int count_lines)
 190 {
 191   int fd;
 192
 193   if (STREQ (filename, "-"))
 194     {
 195       have_read_stdin = 1;
 196       return head (_("standard input"), STDIN_FILENO, n_units, count_lines);
 197     }
 198   else
 199     {
 200       fd = open (filename, O_RDONLY);
 201       if (fd >= 0)
 202         {
 203           int errors;
 204
 205           errors = head (filename, fd, n_units, count_lines);
 206           if (close (fd) == 0)
 207             return errors;
 208         }
 209       error (0, errno, "%s", filename);
 210       return 1;
 211     }
 212 }
 213
 214 /* Convert a string of decimal digits, N_STRING, with a single, optional suffix
 215    character (b, k, or m) to an integral value.  Upon successful conversion,
 216    return that value.  If it cannot be converted, give a diagnostic and exit.
 217    COUNT_LINES indicates whether N_STRING is a number of bytes or a number
 218    of lines.  It is used solely to give a more specific diagnostic.  */
 219
 220 static uintmax_t
 221 string_to_integer (int count_lines, const char *n_string)
 222 {
 223   strtol_error s_err;
 224   uintmax_t n;
 225
 226   s_err = xstrtoumax (n_string, NULL, 10, &n, "bkm");
 227
 228   if (s_err == LONGINT_OVERFLOW)
 229     {
 230       error (EXIT_FAILURE, 0,
 231              _("%s: %s is so large that it is not representable"), n_string,
 232              count_lines ? _("number of lines") : _("number of bytes"));
 233     }
 234
 235   if (s_err != LONGINT_OK)
 236     {
 237       error (EXIT_FAILURE, 0, "%s: %s", n_string,
 238              (count_lines
 239               ? _("invalid number of lines")
 240               : _("invalid number of bytes")));
 241     }
 242
 243   return n;
 244 }
 245
 246 int
 247 main (int argc, char **argv)
 248 {
 249   enum header_mode header_mode = multiple_files;
 250   int exit_status = 0;
 251   char *n_string;
 252   int c;
 253
 254   /* Number of items to print. */
 255   uintmax_t n_units = DEFAULT_NUMBER;
 256
 257   /* If nonzero, interpret the numeric argument as the number of lines.
 258      Otherwise, interpret it as the number of bytes.  */
 259   int count_lines = 1;
 260
 261   program_name = argv[0];
 262   setlocale (LC_ALL, "");
 263   bindtextdomain (PACKAGE, LOCALEDIR);
 264   textdomain (PACKAGE);
 265
 266   atexit (close_stdout);
 267
 268   have_read_stdin = 0;
 269
 270   print_headers = 0;
 271
 272   if (argc > 1 && argv[1][0] == '-' && ISDIGIT (argv[1][1]))
 273     {
 274       char *end_n_string;
 275       char multiplier_char = 0;
 276
 277       n_string = &argv[1][1];
 278
 279       /* Old option syntax; a dash, one or more digits, and one or
 280          more option letters.  Move past the number. */
 281       for (++argv[1]; ISDIGIT (*argv[1]); ++argv[1])
 282         {
 283           /* empty */
 284         }
 285
 286       /* Pointer to the byte after the last digit.  */
 287       end_n_string = argv[1];
 288
 289       /* Parse any appended option letters. */
 290       while (*argv[1])
 291         {
 292           switch (*argv[1])
 293             {
 294             case 'c':
 295               count_lines = 0;
 296               multiplier_char = 0;
 297               break;
 298
 299             case 'b':
 300             case 'k':
 301             case 'm':
 302               count_lines = 0;
 303               multiplier_char = *argv[1];
 304               break;
 305
 306             case 'l':
 307               count_lines = 1;
 308               break;
 309
 310             case 'q':
 311               header_mode = never;
 312               break;
 313
 314             case 'v':
 315               header_mode = always;
 316               break;
 317
 318             default:
 319               error (0, 0, _("unrecognized option `-%c'"), *argv[1]);
 320               usage (1);
 321             }
 322           ++argv[1];
 323         }
 324
 325       /* Append the multiplier character (if any) onto the end of
 326          the digit string.  Then add NUL byte if necessary.  */
 327       *end_n_string = multiplier_char;
 328       if (multiplier_char)
 329         *(++end_n_string) = 0;
 330
 331       n_units = string_to_integer (count_lines, n_string);
 332
 333       /* Make the options we just parsed invisible to getopt. */
 334       argv[1] = argv[0];
 335       argv++;
 336       argc--;
 337
 338       /* FIXME: allow POSIX options if there were obsolescent ones?  */
 339
 340     }
 341
 342   while ((c = getopt_long (argc, argv, "c:n:qv", long_options, NULL)) != -1)
 343     {
 344       switch (c)
 345         {
 346         case 0:
 347           break;
 348
 349         case 'c':
 350           count_lines = 0;
 351           n_units = string_to_integer (count_lines, optarg);
 352           break;
 353
 354         case 'n':
 355           count_lines = 1;
 356           n_units = string_to_integer (count_lines, optarg);
 357           break;
 358
 359         case 'q':
 360           header_mode = never;
 361           break;
 362
 363         case 'v':
 364           header_mode = always;
 365           break;
 366
 367         case_GETOPT_HELP_CHAR;
 368
 369         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 370
 371         default:
 372           usage (1);
 373         }
 374     }
 375
 376   if (header_mode == always
 377       || (header_mode == multiple_files && optind < argc - 1))
 378     print_headers = 1;
 379
 380   if (optind == argc)
 381     exit_status |= head_file ("-", n_units, count_lines);
 382
 383   for (; optind < argc; ++optind)
 384     exit_status |= head_file (argv[optind], n_units, count_lines);
 385
 386   if (have_read_stdin && close (STDIN_FILENO) < 0)
 387     error (EXIT_FAILURE, errno, "-");
 388
 389   exit (exit_status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
 390 }