blob: 16418ff331d8c5dbe2c236b8da7260e67d18ac6f [file] [log] [blame]
"Robert P. J. Day"63fc1a92006-07-02 19:47:05 +00001/* vi: set sw=4 ts=4: */
Erik Andersen7ab9c7e2000-05-12 19:41:47 +00002/*
Mark Whitley807f0fd2000-08-02 18:30:11 +00003 * cut.c - minimalist version of cut
Erik Andersen7ab9c7e2000-05-12 19:41:47 +00004 *
Eric Andersen8ec10a92001-01-27 09:33:39 +00005 * Copyright (C) 1999,2000,2001 by Lineo, inc.
Eric Andersenc7bda1c2004-03-15 08:29:22 +00006 * Written by Mark Whitley <markw@codepoet.org>
Bernhard Reutner-Fischer6c4dade2008-09-25 12:13:34 +00007 * debloated by Bernhard Reutner-Fischer
Erik Andersen7ab9c7e2000-05-12 19:41:47 +00008 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02009 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
Erik Andersen7ab9c7e2000-05-12 19:41:47 +000010 */
Denys Vlasenkoaf3f4202016-11-23 14:46:56 +010011//config:config CUT
Denys Vlasenkob097a842018-12-28 03:20:17 +010012//config: bool "cut (5.8 kb)"
Denys Vlasenkoaf3f4202016-11-23 14:46:56 +010013//config: default y
14//config: help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020015//config: cut is used to print selected parts of lines from
16//config: each file to stdout.
Denys Vlasenkoaf3f4202016-11-23 14:46:56 +010017
18//applet:IF_CUT(APPLET_NOEXEC(cut, cut, BB_DIR_USR_BIN, BB_SUID_DROP, cut))
19
20//kbuild:lib-$(CONFIG_CUT) += cut.o
Erik Andersen7ab9c7e2000-05-12 19:41:47 +000021
Pere Orga34425382011-03-31 14:43:25 +020022//usage:#define cut_trivial_usage
23//usage: "[OPTIONS] [FILE]..."
24//usage:#define cut_full_usage "\n\n"
25//usage: "Print selected fields from each input FILE to stdout\n"
Pere Orga34425382011-03-31 14:43:25 +020026//usage: "\n -b LIST Output only bytes from LIST"
27//usage: "\n -c LIST Output only characters from LIST"
28//usage: "\n -d CHAR Use CHAR instead of tab as the field delimiter"
29//usage: "\n -s Output only the lines containing delimiter"
30//usage: "\n -f N Print only these fields"
31//usage: "\n -n Ignored"
32//usage:
33//usage:#define cut_example_usage
34//usage: "$ echo \"Hello world\" | cut -f 1 -d ' '\n"
35//usage: "Hello\n"
36//usage: "$ echo \"Hello world\" | cut -f 2 -d ' '\n"
37//usage: "world\n"
38
Denis Vlasenkob6adbf12007-05-26 19:00:18 +000039#include "libbb.h"
Erik Andersen7ab9c7e2000-05-12 19:41:47 +000040
Denis Vlasenko99912ca2007-04-10 15:43:37 +000041/* This is a NOEXEC applet. Be very careful! */
42
43
Mark Whitleyb6967632001-05-18 23:04:51 +000044/* option vars */
Denys Vlasenko22542ec2017-08-08 21:55:02 +020045#define OPT_STR "b:c:f:d:sn"
Denis Vlasenko3831c912007-11-23 07:26:15 +000046#define CUT_OPT_BYTE_FLGS (1 << 0)
47#define CUT_OPT_CHAR_FLGS (1 << 1)
48#define CUT_OPT_FIELDS_FLGS (1 << 2)
49#define CUT_OPT_DELIM_FLGS (1 << 3)
50#define CUT_OPT_SUPPRESS_FLGS (1 << 4)
Mark Whitleyb6967632001-05-18 23:04:51 +000051
52struct cut_list {
53 int startpos;
54 int endpos;
55};
56
Rob Landleybc68cd12006-03-10 19:22:06 +000057enum {
58 BOL = 0,
59 EOL = INT_MAX,
60 NON_RANGE = -1
61};
Mark Whitleyb6967632001-05-18 23:04:51 +000062
Mark Whitleyb6967632001-05-18 23:04:51 +000063static int cmpfunc(const void *a, const void *b)
64{
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +000065 return (((struct cut_list *) a)->startpos -
66 ((struct cut_list *) b)->startpos);
Mark Whitleyb6967632001-05-18 23:04:51 +000067}
68
Denis Vlasenko9e3a5402008-07-22 10:34:46 +000069static void cut_file(FILE *file, char delim, const struct cut_list *cut_lists, unsigned nlists)
Mark Whitley807f0fd2000-08-02 18:30:11 +000070{
Denis Vlasenko9e3a5402008-07-22 10:34:46 +000071 char *line;
72 unsigned linenum = 0; /* keep these zero-based to be consistent */
Mark Whitley807f0fd2000-08-02 18:30:11 +000073
74 /* go through every line in the file */
Denis Vlasenko8ee649a2008-03-26 20:04:27 +000075 while ((line = xmalloc_fgetline(file)) != NULL) {
Mark Whitleyb6967632001-05-18 23:04:51 +000076
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +000077 /* set up a list so we can keep track of what's been printed */
Denis Vlasenko9e3a5402008-07-22 10:34:46 +000078 int linelen = strlen(line);
Denis Vlasenko8334db12008-08-15 21:20:23 +000079 char *printed = xzalloc(linelen + 1);
Denis Vlasenko9e3a5402008-07-22 10:34:46 +000080 char *orig_line = line;
81 unsigned cl_pos = 0;
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +000082 int spos;
83
Mark Whitleyb6967632001-05-18 23:04:51 +000084 /* cut based on chars/bytes XXX: only works when sizeof(char) == byte */
Denis Vlasenko372686b2006-10-12 22:42:33 +000085 if (option_mask32 & (CUT_OPT_CHAR_FLGS | CUT_OPT_BYTE_FLGS)) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +000086 /* print the chars specified in each cut list */
87 for (; cl_pos < nlists; cl_pos++) {
88 spos = cut_lists[cl_pos].startpos;
Denis Vlasenko9e3a5402008-07-22 10:34:46 +000089 while (spos < linelen) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +000090 if (!printed[spos]) {
91 printed[spos] = 'X';
92 putchar(line[spos]);
93 }
94 spos++;
95 if (spos > cut_lists[cl_pos].endpos
Denis Vlasenko9e3a5402008-07-22 10:34:46 +000096 /* NON_RANGE is -1, so if below is true,
97 * the above was true too (spos is >= 0) */
98 /* || cut_lists[cl_pos].endpos == NON_RANGE */
99 ) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000100 break;
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000101 }
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000102 }
103 }
104 } else if (delim == '\n') { /* cut by lines */
105 spos = cut_lists[cl_pos].startpos;
Mark Whitleyb6967632001-05-18 23:04:51 +0000106
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000107 /* get out if we have no more lists to process or if the lines
108 * are lower than what we're interested in */
Denis Vlasenko77ad97f2008-05-13 02:27:31 +0000109 if (((int)linenum < spos) || (cl_pos >= nlists))
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000110 goto next_line;
111
112 /* if the line we're looking for is lower than the one we were
113 * passed, it means we displayed it already, so move on */
Denis Vlasenko77ad97f2008-05-13 02:27:31 +0000114 while (spos < (int)linenum) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000115 spos++;
116 /* go to the next list if we're at the end of this one */
117 if (spos > cut_lists[cl_pos].endpos
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000118 || cut_lists[cl_pos].endpos == NON_RANGE
119 ) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000120 cl_pos++;
121 /* get out if there's no more lists to process */
122 if (cl_pos >= nlists)
123 goto next_line;
124 spos = cut_lists[cl_pos].startpos;
125 /* get out if the current line is lower than the one
126 * we just became interested in */
Denis Vlasenko77ad97f2008-05-13 02:27:31 +0000127 if ((int)linenum < spos)
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000128 goto next_line;
129 }
130 }
131
132 /* If we made it here, it means we've found the line we're
133 * looking for, so print it */
134 puts(line);
135 goto next_line;
136 } else { /* cut by fields */
137 int ndelim = -1; /* zero-based / one-based problem */
138 int nfields_printed = 0;
139 char *field = NULL;
Denys Vlasenko043b1e52009-09-06 12:47:55 +0200140 char delimiter[2];
141
142 delimiter[0] = delim;
143 delimiter[1] = 0;
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000144
145 /* does this line contain any delimiters? */
146 if (strchr(line, delim) == NULL) {
Denis Vlasenko372686b2006-10-12 22:42:33 +0000147 if (!(option_mask32 & CUT_OPT_SUPPRESS_FLGS))
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000148 puts(line);
149 goto next_line;
150 }
151
152 /* process each list on this line, for as long as we've got
153 * a line to process */
154 for (; cl_pos < nlists && line; cl_pos++) {
155 spos = cut_lists[cl_pos].startpos;
156 do {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000157 /* find the field we're looking for */
158 while (line && ndelim < spos) {
159 field = strsep(&line, delimiter);
160 ndelim++;
161 }
162
163 /* we found it, and it hasn't been printed yet */
164 if (field && ndelim == spos && !printed[ndelim]) {
165 /* if this isn't our first time through, we need to
166 * print the delimiter after the last field that was
167 * printed */
168 if (nfields_printed > 0)
169 putchar(delim);
Ron Yorstoncad3fc72021-02-03 20:47:14 +0100170 fputs_stdout(field);
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000171 printed[ndelim] = 'X';
172 nfields_printed++; /* shouldn't overflow.. */
173 }
174
175 spos++;
176
177 /* keep going as long as we have a line to work with,
178 * this is a list, and we're not at the end of that
179 * list */
180 } while (spos <= cut_lists[cl_pos].endpos && line
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000181 && cut_lists[cl_pos].endpos != NON_RANGE);
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000182 }
Mark Whitley807f0fd2000-08-02 18:30:11 +0000183 }
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000184 /* if we printed anything at all, we need to finish it with a
185 * newline cuz we were handed a chomped line */
186 putchar('\n');
Denis Vlasenko372686b2006-10-12 22:42:33 +0000187 next_line:
Mark Whitleyb6967632001-05-18 23:04:51 +0000188 linenum++;
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000189 free(printed);
190 free(orig_line);
Mark Whitley807f0fd2000-08-02 18:30:11 +0000191 }
192}
193
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000194int cut_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000195int cut_main(int argc UNUSED_PARAM, char **argv)
Mark Whitley807f0fd2000-08-02 18:30:11 +0000196{
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000197 /* growable array holding a series of lists */
198 struct cut_list *cut_lists = NULL;
199 unsigned nlists = 0; /* number of elements in above list */
Denis Vlasenko3831c912007-11-23 07:26:15 +0000200 char delim = '\t'; /* delimiter, default is tab */
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000201 char *sopt, *ltok;
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000202 unsigned opt;
Mark Whitley807f0fd2000-08-02 18:30:11 +0000203
Denys Vlasenko22542ec2017-08-08 21:55:02 +0200204 opt = getopt32(argv, "^"
205 OPT_STR
206 "\0" "b--bcf:c--bcf:f--bcf",
207 &sopt, &sopt, &sopt, &ltok
208 );
Denis Vlasenko9f739442006-12-16 23:49:13 +0000209// argc -= optind;
210 argv += optind;
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000211 if (!(opt & (CUT_OPT_BYTE_FLGS | CUT_OPT_CHAR_FLGS | CUT_OPT_FIELDS_FLGS)))
James Byrne69374872019-07-02 11:35:03 +0200212 bb_simple_error_msg_and_die("expected a list of bytes, characters, or fields");
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000213
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000214 if (opt & CUT_OPT_DELIM_FLGS) {
Denis Vlasenko3831c912007-11-23 07:26:15 +0000215 if (ltok[0] && ltok[1]) { /* more than 1 char? */
James Byrne69374872019-07-02 11:35:03 +0200216 bb_simple_error_msg_and_die("the delimiter must be a single character");
Eric Andersenc9e70242003-06-20 09:16:00 +0000217 }
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000218 delim = ltok[0];
Mark Whitley807f0fd2000-08-02 18:30:11 +0000219 }
Mark Whitley807f0fd2000-08-02 18:30:11 +0000220
Mark Whitleyb6967632001-05-18 23:04:51 +0000221 /* non-field (char or byte) cutting has some special handling */
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000222 if (!(opt & CUT_OPT_FIELDS_FLGS)) {
Denis Vlasenko3831c912007-11-23 07:26:15 +0000223 static const char _op_on_field[] ALIGN1 = " only when operating on fields";
224
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000225 if (opt & CUT_OPT_SUPPRESS_FLGS) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000226 bb_error_msg_and_die
227 ("suppressing non-delimited lines makes sense%s",
Denys Vlasenko69675782013-01-14 01:34:48 +0100228 _op_on_field);
Mark Whitleyb6967632001-05-18 23:04:51 +0000229 }
Eric Andersen8876fb22003-06-20 09:01:58 +0000230 if (delim != '\t') {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000231 bb_error_msg_and_die
232 ("a delimiter may be specified%s", _op_on_field);
Mark Whitleyb6967632001-05-18 23:04:51 +0000233 }
Mark Whitley807f0fd2000-08-02 18:30:11 +0000234 }
235
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000236 /*
237 * parse list and put values into startpos and endpos.
238 * valid list formats: N, N-, N-M, -M
239 * more than one list can be separated by commas
240 */
241 {
242 char *ntok;
243 int s = 0, e = 0;
244
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000245 /* take apart the lists, one by one (they are separated with commas) */
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000246 while ((ltok = strsep(&sopt, ",")) != NULL) {
247
248 /* it's actually legal to pass an empty list */
Denis Vlasenko3831c912007-11-23 07:26:15 +0000249 if (!ltok[0])
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000250 continue;
251
252 /* get the start pos */
253 ntok = strsep(&ltok, "-");
Denis Vlasenko3831c912007-11-23 07:26:15 +0000254 if (!ntok[0]) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000255 s = BOL;
256 } else {
Denys Vlasenko77832482010-08-12 14:14:45 +0200257 s = xatoi_positive(ntok);
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000258 /* account for the fact that arrays are zero based, while
259 * the user expects the first char on the line to be char #1 */
260 if (s != 0)
261 s--;
262 }
263
264 /* get the end pos */
Denis Vlasenko3831c912007-11-23 07:26:15 +0000265 if (ltok == NULL) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000266 e = NON_RANGE;
Denis Vlasenko3831c912007-11-23 07:26:15 +0000267 } else if (!ltok[0]) {
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000268 e = EOL;
269 } else {
Denys Vlasenko77832482010-08-12 14:14:45 +0200270 e = xatoi_positive(ltok);
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000271 /* if the user specified and end position of 0,
272 * that means "til the end of the line" */
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000273 if (e == 0)
274 e = EOL;
275 e--; /* again, arrays are zero based, lines are 1 based */
276 if (e == s)
277 e = NON_RANGE;
278 }
279
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000280 /* add the new list */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000281 cut_lists = xrealloc_vector(cut_lists, 4, nlists);
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000282 /* NB: startpos is always >= 0,
283 * while endpos may be = NON_RANGE (-1) */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000284 cut_lists[nlists].startpos = s;
285 cut_lists[nlists].endpos = e;
286 nlists++;
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000287 }
288
289 /* make sure we got some cut positions out of all that */
290 if (nlists == 0)
James Byrne69374872019-07-02 11:35:03 +0200291 bb_simple_error_msg_and_die("missing list of positions");
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000292
293 /* now that the lists are parsed, we need to sort them to make life
294 * easier on us when it comes time to print the chars / fields / lines
295 */
Denys Vlasenko573ba4e2010-01-18 12:25:09 +0100296 qsort(cut_lists, nlists, sizeof(cut_lists[0]), cmpfunc);
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000297 }
298
Denis Vlasenko3831c912007-11-23 07:26:15 +0000299 {
300 int retval = EXIT_SUCCESS;
Denis Vlasenko3831c912007-11-23 07:26:15 +0000301
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000302 if (!*argv)
303 *--argv = (char *)"-";
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000304
Denis Vlasenko9f739442006-12-16 23:49:13 +0000305 do {
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000306 FILE *file = fopen_or_warn_stdin(*argv);
Denis Vlasenko3831c912007-11-23 07:26:15 +0000307 if (!file) {
308 retval = EXIT_FAILURE;
309 continue;
Mark Whitley807f0fd2000-08-02 18:30:11 +0000310 }
Denis Vlasenko9e3a5402008-07-22 10:34:46 +0000311 cut_file(file, delim, cut_lists, nlists);
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000312 fclose_if_not_stdin(file);
Denis Vlasenko9f739442006-12-16 23:49:13 +0000313 } while (*++argv);
Denis Vlasenko3831c912007-11-23 07:26:15 +0000314
315 if (ENABLE_FEATURE_CLEAN_UP)
316 free(cut_lists);
317 fflush_stdout_and_exit(retval);
Mark Whitley807f0fd2000-08-02 18:30:11 +0000318 }
Mark Whitley807f0fd2000-08-02 18:30:11 +0000319}