(usage): Include one- or two-line synopsis in --help output.
[platform/upstream/coreutils.git] / src / sum.c
1 /* sum -- checksum and count the blocks in a file
2    Copyright (C) 1986, 1989, 1991, 1995 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
16    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
17
18 /* Like BSD sum or SysV sum -r, except like SysV sum if -s option is given. */
19
20 /* Written by Kayvan Aghaiepour and David MacKenzie. */
21
22 #include <config.h>
23
24 #include <stdio.h>
25 #include <sys/types.h>
26 #include <getopt.h>
27 #include "system.h"
28 #include "version.h"
29 #include "error.h"
30
31 static int bsd_sum_file ();
32 static int sysv_sum_file ();
33
34 int safe_read ();
35
36 /* The name this program was run with. */
37 char *program_name;
38
39 /* Nonzero if any of the files read were the standard input. */
40 static int have_read_stdin;
41
42 /* Right-rotate 32-bit integer variable C. */
43 #define ROTATE_RIGHT(c) if ((c) & 01) (c) = ((c) >>1) + 0x8000; else (c) >>= 1;
44
45 /* If non-zero, display usage information and exit.  */
46 static int show_help;
47
48 /* If non-zero, print the version on standard output then exit.  */
49 static int show_version;
50
51 static struct option const longopts[] =
52 {
53   {"sysv", no_argument, NULL, 's'},
54   {"help", no_argument, &show_help, 1},
55   {"version", no_argument, &show_version, 1},
56   {NULL, 0, NULL, 0}
57 };
58
59 static void
60 usage (status)
61      int status;
62 {
63   if (status != 0)
64     fprintf (stderr, "Try `%s --help' for more information.\n",
65              program_name);
66   else
67     {
68       printf ("\
69 Usage: %s [OPTION]... [FILE]...\n\
70 ",
71               program_name);
72       printf ("\
73 Print checksum and block counts for each FILE.\n\
74 \n\
75   -r              defeat -s, use BSD sum algorithm, use 1K blocks\n\
76   -s, --sysv      use System V sum algorithm, use 512 bytes blocks\n\
77       --help      display this help and exit\n\
78       --version   output version information and exit\n\
79 \n\
80 With no FILE, or when FILE is -, read standard input.\n\
81 ");
82     }
83   exit (status);
84 }
85
86 void
87 main (argc, argv)
88      int argc;
89      char **argv;
90 {
91   int errors = 0;
92   int optc;
93   int files_given;
94   int (*sum_func) () = bsd_sum_file;
95
96   program_name = argv[0];
97   have_read_stdin = 0;
98
99   while ((optc = getopt_long (argc, argv, "rs", longopts, (int *) 0)) != -1)
100     {
101       switch (optc)
102         {
103         case 0:
104           break;
105
106         case 'r':               /* For SysV compatibility. */
107           sum_func = bsd_sum_file;
108           break;
109
110         case 's':
111           sum_func = sysv_sum_file;
112           break;
113
114         default:
115           usage (1);
116         }
117     }
118
119   if (show_version)
120     {
121       printf ("sum - %s\n", version_string);
122       exit (0);
123     }
124
125   if (show_help)
126     usage (0);
127
128   files_given = argc - optind;
129   if (files_given == 0)
130     {
131       if ((*sum_func) ("-", files_given) < 0)
132         errors = 1;
133     }
134   else
135     for (; optind < argc; optind++)
136       if ((*sum_func) (argv[optind], files_given) < 0)
137         errors = 1;
138
139   if (have_read_stdin && fclose (stdin) == EOF)
140     error (1, errno, "-");
141   exit (errors);
142 }
143
144 /* Calculate and print the rotated checksum and the size in 1K blocks
145    of file FILE, or of the standard input if FILE is "-".
146    If PRINT_NAME is >1, print FILE next to the checksum and size.
147    The checksum varies depending on sizeof(int).
148    Return 0 if successful, -1 if an error occurs. */
149
150 static int
151 bsd_sum_file (file, print_name)
152      char *file;
153      int print_name;
154 {
155   register FILE *fp;
156   register unsigned long checksum = 0; /* The checksum mod 2^16. */
157   register long total_bytes = 0; /* The number of bytes. */
158   register int ch;              /* Each character read. */
159
160   if (!strcmp (file, "-"))
161     {
162       fp = stdin;
163       have_read_stdin = 1;
164     }
165   else
166     {
167       fp = fopen (file, "r");
168       if (fp == NULL)
169         {
170           error (0, errno, "%s", file);
171           return -1;
172         }
173     }
174
175   /* This algorithm seems to depend on sign extension in `ch' in order to
176      give the right results.  Ick.  */
177   while ((ch = getc (fp)) != EOF)
178     {
179       total_bytes++;
180       ROTATE_RIGHT (checksum);
181       checksum += ch;
182       checksum &= 0xffff;       /* Keep it within bounds. */
183     }
184
185   if (ferror (fp))
186     {
187       error (0, errno, "%s", file);
188       if (strcmp (file, "-"))
189         fclose (fp);
190       return -1;
191     }
192
193   if (strcmp (file, "-") && fclose (fp) == EOF)
194     {
195       error (0, errno, "%s", file);
196       return -1;
197     }
198
199   printf ("%05lu %5ld", checksum, (total_bytes + 1024 - 1) / 1024);
200   if (print_name > 1)
201     printf (" %s", file);
202   putchar ('\n');
203
204   return 0;
205 }
206
207 /* Calculate and print the checksum and the size in 512-byte blocks
208    of file FILE, or of the standard input if FILE is "-".
209    If PRINT_NAME is >0, print FILE next to the checksum and size.
210    Return 0 if successful, -1 if an error occurs. */
211
212 static int
213 sysv_sum_file (file, print_name)
214      char *file;
215      int print_name;
216 {
217   int fd;
218   unsigned char buf[8192];
219   register int bytes_read;
220   register unsigned long checksum = 0;
221   long total_bytes = 0;
222
223   if (!strcmp (file, "-"))
224     {
225       fd = 0;
226       have_read_stdin = 1;
227     }
228   else
229     {
230       fd = open (file, O_RDONLY);
231       if (fd == -1)
232         {
233           error (0, errno, "%s", file);
234           return -1;
235         }
236     }
237
238   while ((bytes_read = safe_read (fd, buf, sizeof buf)) > 0)
239     {
240       register int i;
241
242       for (i = 0; i < bytes_read; i++)
243         checksum += buf[i];
244       total_bytes += bytes_read;
245     }
246
247   if (bytes_read < 0)
248     {
249       error (0, errno, "%s", file);
250       if (strcmp (file, "-"))
251         close (fd);
252       return -1;
253     }
254
255   if (strcmp (file, "-") && close (fd) == -1)
256     {
257       error (0, errno, "%s", file);
258       return -1;
259     }
260
261   printf ("%lu %ld", checksum % 0xffff, (total_bytes + 512 - 1) / 512);
262   if (print_name)
263     printf (" %s", file);
264   putchar ('\n');
265
266   return 0;
267 }