1 /* tr -- a filter to translate characters
2 Copyright (C) 91, 1995-2008 Free Software Foundation, Inc.
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 3 of the License, or
7 (at your option) any later version.
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.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* Written by Jim Meyering */
23 #include <sys/types.h>
29 #include "safe-read.h"
32 /* The official name of this program (e.g., no `g' prefix). */
33 #define PROGRAM_NAME "tr"
35 #define AUTHORS proper_name ("Jim Meyering")
37 enum { N_CHARS = UCHAR_MAX + 1 };
39 /* An unsigned integer type big enough to hold a repeat count or an
40 unsigned character. POSIX requires support for repeat counts as
41 high as 2**31 - 1. Since repeat counts might need to expand to
42 match the length of an argument string, we need at least size_t to
43 avoid arbitrary internal limits. It doesn't cost much to use
45 typedef uintmax_t count;
47 /* The value for Spec_list->state that indicates to
48 get_next that it should initialize the tail pointer.
49 Its value should be as large as possible to avoid conflict
50 a valid value for the state field -- and that may be as
51 large as any valid repeat_count. */
52 #define BEGIN_STATE (UINTMAX_MAX - 1)
54 /* The value for Spec_list->state that indicates to
55 get_next that the element pointed to by Spec_list->tail is
56 being considered for the first time on this pass through the
57 list -- it indicates that get_next should make any necessary
59 #define NEW_ELEMENT (BEGIN_STATE + 1)
61 /* The maximum possible repeat count. Due to how the states are
62 implemented, it can be as much as BEGIN_STATE. */
63 #define REPEAT_COUNT_MAXIMUM BEGIN_STATE
65 /* The following (but not CC_NO_CLASS) are indices into the array of
66 valid character class strings. */
69 CC_ALNUM = 0, CC_ALPHA = 1, CC_BLANK = 2, CC_CNTRL = 3,
70 CC_DIGIT = 4, CC_GRAPH = 5, CC_LOWER = 6, CC_PRINT = 7,
71 CC_PUNCT = 8, CC_SPACE = 9, CC_UPPER = 10, CC_XDIGIT = 11,
75 /* Character class to which a character (returned by get_next) belonged;
76 but it is set only if the construct from which the character was obtained
77 was one of the character classes [:upper:] or [:lower:]. The value
78 is used only when translating and then, only to make sure that upper
79 and lower class constructs have the same relative positions in string1
81 enum Upper_Lower_class
88 /* The type of a List_element. See build_spec_list for more details. */
89 enum Range_element_type
98 /* One construct in one of tr's argument strings.
99 For example, consider the POSIX version of the classic tr command:
100 tr -cs 'a-zA-Z_' '[\n*]'
101 String1 has 3 constructs, two of which are ranges (a-z and A-Z),
102 and a single normal character, `_'. String2 has one construct. */
105 enum Range_element_type type;
106 struct List_element *next;
109 unsigned char normal_char;
112 unsigned char first_char;
113 unsigned char last_char;
116 enum Char_class char_class;
117 unsigned char equiv_code;
120 unsigned char the_repeated_char;
128 /* Each of tr's argument strings is parsed into a form that is easier
129 to work with: a linked list of constructs (struct List_element).
130 Each Spec_list structure also encapsulates various attributes of
131 the corresponding argument string. The attributes are used mainly
132 to verify that the strings are valid in the context of any options
133 specified (like -s, -d, or -c). The main exception is the member
134 `tail', which is first used to construct the list. After construction,
135 it is used by get_next to save its state when traversing the list.
136 The member `state' serves a similar function. */
139 /* Points to the head of the list of range elements.
140 The first struct is a dummy; its members are never used. */
141 struct List_element *head;
143 /* When appending, points to the last element. When traversing via
144 get_next(), points to the element to process next. Setting
145 Spec_list.state to the value BEGIN_STATE before calling get_next
146 signals get_next to initialize tail to point to head->next. */
147 struct List_element *tail;
149 /* Used to save state between calls to get_next. */
152 /* Length, in the sense that length ('a-z[:digit:]123abc')
153 is 42 ( = 26 + 10 + 6). */
156 /* The number of [c*] and [c*0] constructs that appear in this spec. */
157 size_t n_indefinite_repeats;
159 /* If n_indefinite_repeats is nonzero, this points to the List_element
160 corresponding to the last [c*] or [c*0] construct encountered in
161 this spec. Otherwise it is undefined. */
162 struct List_element *indefinite_repeat_element;
164 /* True if this spec contains at least one equivalence
165 class construct e.g. [=c=]. */
166 bool has_equiv_class;
168 /* True if this spec contains at least one character class
169 construct. E.g. [:digit:]. */
172 /* True if this spec contains at least one of the character class
173 constructs (all but upper and lower) that aren't allowed in s2. */
174 bool has_restricted_char_class;
177 /* A representation for escaped string1 or string2. As a string is parsed,
178 any backslash-escaped characters (other than octal or \a, \b, \f, \n,
179 etc.) are marked as such in this structure by setting the corresponding
180 entry in the ESCAPED vector. */
188 /* Return nonzero if the Ith character of escaped string ES matches C
189 and is not escaped itself. */
191 es_match (struct E_string const *es, size_t i, char c)
193 return es->s[i] == c && !es->escaped[i];
196 /* The name by which this program was run. */
197 char const *program_name;
199 /* When true, each sequence in the input of a repeated character
200 (call it c) is replaced (in the output) by a single occurrence of c
201 for every c in the squeeze set. */
202 static bool squeeze_repeats = false;
204 /* When true, removes characters in the delete set from input. */
205 static bool delete = false;
207 /* Use the complement of set1 in place of set1. */
208 static bool complement = false;
210 /* When tr is performing translation and string1 is longer than string2,
211 POSIX says that the result is unspecified. That gives the implementor
212 of a POSIX conforming version of tr two reasonable choices for the
213 semantics of this case.
215 * The BSD tr pads string2 to the length of string1 by
216 repeating the last character in string2.
218 * System V tr ignores characters in string1 that have no
219 corresponding character in string2. That is, string1 is effectively
220 truncated to the length of string2.
222 When nonzero, this flag causes GNU tr to imitate the behavior
223 of System V tr when translating with string1 longer than string2.
224 The default is to emulate BSD tr. This flag is ignored in modes where
225 no translation is performed. Emulating the System V tr
226 in this exceptional case causes the relatively common BSD idiom:
228 tr -cs A-Za-z0-9 '\012'
230 to break (it would convert only zero bytes, rather than all
231 non-alphanumerics, to newlines).
233 WARNING: This switch does not provide general BSD or System V
234 compatibility. For example, it doesn't disable the interpretation
235 of the POSIX constructs [:alpha:], [=c=], and [c*10], so if by
236 some unfortunate coincidence you use such constructs in scripts
237 expecting to use some other version of tr, the scripts will break. */
238 static bool truncate_set1 = false;
240 /* An alias for (!delete && non_option_args == 2).
241 It is set in main and used there and in validate(). */
242 static bool translating;
244 static char io_buf[BUFSIZ];
246 static char const *const char_class_name[] =
248 "alnum", "alpha", "blank", "cntrl", "digit", "graph",
249 "lower", "print", "punct", "space", "upper", "xdigit"
251 enum { N_CHAR_CLASSES = sizeof char_class_name / sizeof char_class_name[0] };
253 /* Array of boolean values. A character `c' is a member of the
254 squeeze set if and only if in_squeeze_set[c] is true. The squeeze
255 set is defined by the last (possibly, the only) string argument
256 on the command line when the squeeze option is given. */
257 static bool in_squeeze_set[N_CHARS];
259 /* Array of boolean values. A character `c' is a member of the
260 delete set if and only if in_delete_set[c] is true. The delete
261 set is defined by the first (or only) string argument on the
262 command line when the delete option is given. */
263 static bool in_delete_set[N_CHARS];
265 /* Array of character values defining the translation (if any) that
266 tr is to perform. Translation is performed only when there are
267 two specification strings and the delete switch is not given. */
268 static char xlate[N_CHARS];
270 static struct option const long_options[] =
272 {"complement", no_argument, NULL, 'c'},
273 {"delete", no_argument, NULL, 'd'},
274 {"squeeze-repeats", no_argument, NULL, 's'},
275 {"truncate-set1", no_argument, NULL, 't'},
276 {GETOPT_HELP_OPTION_DECL},
277 {GETOPT_VERSION_OPTION_DECL},
284 if (status != EXIT_SUCCESS)
285 fprintf (stderr, _("Try `%s --help' for more information.\n"),
290 Usage: %s [OPTION]... SET1 [SET2]\n\
294 Translate, squeeze, and/or delete characters from standard input,\n\
295 writing to standard output.\n\
297 -c, -C, --complement first complement SET1\n\
298 -d, --delete delete characters in SET1, do not translate\n\
299 -s, --squeeze-repeats replace each input sequence of a repeated character\n\
300 that is listed in SET1 with a single occurrence\n\
302 -t, --truncate-set1 first truncate SET1 to length of SET2\n\
304 fputs (HELP_OPTION_DESCRIPTION, stdout);
305 fputs (VERSION_OPTION_DESCRIPTION, stdout);
308 SETs are specified as strings of characters. Most represent themselves.\n\
309 Interpreted sequences are:\n\
311 \\NNN character with octal value NNN (1 to 3 octal digits)\n\
318 \\t horizontal tab\n\
322 CHAR1-CHAR2 all characters from CHAR1 to CHAR2 in ascending order\n\
323 [CHAR*] in SET2, copies of CHAR until length of SET1\n\
324 [CHAR*REPEAT] REPEAT copies of CHAR, REPEAT octal if starting with 0\n\
325 [:alnum:] all letters and digits\n\
326 [:alpha:] all letters\n\
327 [:blank:] all horizontal whitespace\n\
328 [:cntrl:] all control characters\n\
329 [:digit:] all digits\n\
332 [:graph:] all printable characters, not including space\n\
333 [:lower:] all lower case letters\n\
334 [:print:] all printable characters, including space\n\
335 [:punct:] all punctuation characters\n\
336 [:space:] all horizontal or vertical whitespace\n\
337 [:upper:] all upper case letters\n\
338 [:xdigit:] all hexadecimal digits\n\
339 [=CHAR=] all characters which are equivalent to CHAR\n\
343 Translation occurs if -d is not given and both SET1 and SET2 appear.\n\
344 -t may be used only when translating. SET2 is extended to length of\n\
345 SET1 by repeating its last character as necessary. \
349 of SET2 are ignored. Only [:lower:] and [:upper:] are guaranteed to\n\
350 expand in ascending order; used in SET2 while translating, they may\n\
351 only be used in pairs to specify case conversion. \
354 -s uses SET1 if not\n\
355 translating nor deleting; else squeezing uses SET2 and occurs after\n\
356 translation or deletion.\n\
358 emit_bug_reporting_address ();
363 /* Return nonzero if the character C is a member of the
364 equivalence class containing the character EQUIV_CLASS. */
367 is_equiv_class_member (unsigned char equiv_class, unsigned char c)
369 return (equiv_class == c);
372 /* Return true if the character C is a member of the
373 character class CHAR_CLASS. */
376 is_char_class_member (enum Char_class char_class, unsigned char c)
383 result = isalnum (c);
386 result = isalpha (c);
389 result = isblank (c);
392 result = iscntrl (c);
395 result = isdigit (c);
398 result = isgraph (c);
401 result = islower (c);
404 result = isprint (c);
407 result = ispunct (c);
410 result = isspace (c);
413 result = isupper (c);
416 result = isxdigit (c);
427 es_free (struct E_string *es)
433 /* Perform the first pass over each range-spec argument S, converting all
434 \c and \ddd escapes to their one-byte representations. If an invalid
435 quote sequence is found print an error message and return false;
436 Otherwise set *ES to the resulting string and return true.
437 The resulting array of characters may contain zero-bytes;
438 however, on input, S is assumed to be null-terminated, and hence
439 cannot contain actual (non-escaped) zero bytes. */
442 unquote (char const *s, struct E_string *es)
445 size_t len = strlen (s);
447 es->s = xmalloc (len);
448 es->escaped = xcalloc (len, sizeof es->escaped[0]);
451 for (i = 0; s[i]; i++)
459 es->escaped[j] = true;
495 oct_digit = s[i + 2] - '0';
496 if (0 <= oct_digit && oct_digit <= 7)
498 c = 8 * c + oct_digit;
500 oct_digit = s[i + 2] - '0';
501 if (0 <= oct_digit && oct_digit <= 7)
503 if (8 * c + oct_digit < N_CHARS)
505 c = 8 * c + oct_digit;
510 /* A 3-digit octal number larger than \377 won't
511 fit in 8 bits. So we stop when adding the
512 next digit would put us over the limit and
513 give a warning about the ambiguity. POSIX
514 isn't clear on this, and we interpret this
515 lack of clarity as meaning the resulting behavior
516 is undefined, which means we're allowed to issue
518 error (0, 0, _("warning: the ambiguous octal escape \
519 \\%c%c%c is being\n\tinterpreted as the 2-byte sequence \\0%c%c, %c"),
520 s[i], s[i + 1], s[i + 2],
521 s[i], s[i + 1], s[i + 2]);
527 error (0, 0, _("warning: an unescaped backslash "
528 "at end of string is not portable"));
529 /* POSIX is not clear about this. */
530 es->escaped[j] = false;
550 /* If CLASS_STR is a valid character class string, return its index
551 in the global char_class_name array. Otherwise, return CC_NO_CLASS. */
553 static enum Char_class
554 look_up_char_class (char const *class_str, size_t len)
558 for (i = 0; i < N_CHAR_CLASSES; i++)
559 if (strncmp (class_str, char_class_name[i], len) == 0
560 && strlen (char_class_name[i]) == len)
565 /* Return a newly allocated string with a printable version of C.
566 This function is used solely for formatting error messages. */
569 make_printable_char (unsigned char c)
571 char *buf = xmalloc (5);
580 sprintf (buf, "\\%03o", c);
585 /* Return a newly allocated copy of S which is suitable for printing.
586 LEN is the number of characters in S. Most non-printing
587 (isprint) characters are represented by a backslash followed by
588 3 octal digits. However, the characters represented by \c escapes
589 where c is one of [abfnrtv] are represented by their 2-character \c
590 sequences. This function is used solely for printing error messages. */
593 make_printable_str (char const *s, size_t len)
595 /* Worst case is that every character expands to a backslash
596 followed by a 3-character octal escape sequence. */
597 char *printable_buf = xnmalloc (len + 1, 4);
598 char *p = printable_buf;
601 for (i = 0; i < len; i++)
604 char const *tmp = NULL;
605 unsigned char c = s[i];
640 sprintf (buf, "\\%03o", c);
646 return printable_buf;
649 /* Append a newly allocated structure representing a
650 character C to the specification list LIST. */
653 append_normal_char (struct Spec_list *list, unsigned char c)
655 struct List_element *new;
657 new = xmalloc (sizeof *new);
659 new->type = RE_NORMAL_CHAR;
660 new->u.normal_char = c;
662 list->tail->next = new;
666 /* Append a newly allocated structure representing the range
667 of characters from FIRST to LAST to the specification list LIST.
668 Return false if LAST precedes FIRST in the collating sequence,
669 true otherwise. This means that '[c-c]' is acceptable. */
672 append_range (struct Spec_list *list, unsigned char first, unsigned char last)
674 struct List_element *new;
678 char *tmp1 = make_printable_char (first);
679 char *tmp2 = make_printable_char (last);
682 _("range-endpoints of `%s-%s' are in reverse collating sequence order"),
688 new = xmalloc (sizeof *new);
690 new->type = RE_RANGE;
691 new->u.range.first_char = first;
692 new->u.range.last_char = last;
694 list->tail->next = new;
699 /* If CHAR_CLASS_STR is a valid character class string, append a
700 newly allocated structure representing that character class to the end
701 of the specification list LIST and return true. If CHAR_CLASS_STR is not
702 a valid string return false. */
705 append_char_class (struct Spec_list *list,
706 char const *char_class_str, size_t len)
708 enum Char_class char_class;
709 struct List_element *new;
711 char_class = look_up_char_class (char_class_str, len);
712 if (char_class == CC_NO_CLASS)
714 new = xmalloc (sizeof *new);
716 new->type = RE_CHAR_CLASS;
717 new->u.char_class = char_class;
719 list->tail->next = new;
724 /* Append a newly allocated structure representing a [c*n]
725 repeated character construct to the specification list LIST.
726 THE_CHAR is the single character to be repeated, and REPEAT_COUNT
727 is a non-negative repeat count. */
730 append_repeated_char (struct Spec_list *list, unsigned char the_char,
733 struct List_element *new;
735 new = xmalloc (sizeof *new);
737 new->type = RE_REPEATED_CHAR;
738 new->u.repeated_char.the_repeated_char = the_char;
739 new->u.repeated_char.repeat_count = repeat_count;
741 list->tail->next = new;
745 /* Given a string, EQUIV_CLASS_STR, from a [=str=] context and
746 the length of that string, LEN, if LEN is exactly one, append
747 a newly allocated structure representing the specified
748 equivalence class to the specification list, LIST and return true.
749 If LEN is not 1, return false. */
752 append_equiv_class (struct Spec_list *list,
753 char const *equiv_class_str, size_t len)
755 struct List_element *new;
759 new = xmalloc (sizeof *new);
761 new->type = RE_EQUIV_CLASS;
762 new->u.equiv_code = *equiv_class_str;
764 list->tail->next = new;
769 /* Search forward starting at START_IDX for the 2-char sequence
770 (PRE_BRACKET_CHAR,']') in the string P of length P_LEN. If such
771 a sequence is found, set *RESULT_IDX to the index of the first
772 character and return true. Otherwise return false. P may contain
776 find_closing_delim (const struct E_string *es, size_t start_idx,
777 char pre_bracket_char, size_t *result_idx)
781 for (i = start_idx; i < es->len - 1; i++)
782 if (es->s[i] == pre_bracket_char && es->s[i + 1] == ']'
783 && !es->escaped[i] && !es->escaped[i + 1])
791 /* Parse the bracketed repeat-char syntax. If the P_LEN characters
792 beginning with P[ START_IDX ] comprise a valid [c*n] construct,
793 then set *CHAR_TO_REPEAT, *REPEAT_COUNT, and *CLOSING_BRACKET_IDX
794 and return zero. If the second character following
795 the opening bracket is not `*' or if no closing bracket can be
796 found, return -1. If a closing bracket is found and the
797 second char is `*', but the string between the `*' and `]' isn't
798 empty, an octal number, or a decimal number, print an error message
802 find_bracketed_repeat (const struct E_string *es, size_t start_idx,
803 unsigned char *char_to_repeat, count *repeat_count,
804 size_t *closing_bracket_idx)
808 assert (start_idx + 1 < es->len);
809 if (!es_match (es, start_idx + 1, '*'))
812 for (i = start_idx + 2; i < es->len && !es->escaped[i]; i++)
816 size_t digit_str_len = i - start_idx - 2;
818 *char_to_repeat = es->s[start_idx];
819 if (digit_str_len == 0)
821 /* We've matched [c*] -- no explicit repeat count. */
826 /* Here, we have found [c*s] where s should be a string
827 of octal (if it starts with `0') or decimal digits. */
828 char const *digit_str = &es->s[start_idx + 2];
830 if ((xstrtoumax (digit_str, &d_end, *digit_str == '0' ? 8 : 10,
833 || REPEAT_COUNT_MAXIMUM < *repeat_count
834 || digit_str + digit_str_len != d_end)
836 char *tmp = make_printable_str (digit_str, digit_str_len);
838 _("invalid repeat count %s in [c*n] construct"),
844 *closing_bracket_idx = i;
848 return -1; /* No bracket found. */
851 /* Return true if the string at ES->s[IDX] matches the regular
852 expression `\*[0-9]*\]', false otherwise. The string does not
853 match if any of its characters are escaped. */
856 star_digits_closebracket (const struct E_string *es, size_t idx)
860 if (!es_match (es, idx, '*'))
863 for (i = idx + 1; i < es->len; i++)
864 if (!ISDIGIT (to_uchar (es->s[i])) || es->escaped[i])
865 return es_match (es, i, ']');
869 /* Convert string UNESCAPED_STRING (which has been preprocessed to
870 convert backslash-escape sequences) of length LEN characters into
871 a linked list of the following 5 types of constructs:
872 - [:str:] Character class where `str' is one of the 12 valid strings.
873 - [=c=] Equivalence class where `c' is any single character.
874 - [c*n] Repeat the single character `c' `n' times. n may be omitted.
875 However, if `n' is present, it must be a non-negative octal or
877 - r-s Range of characters from `r' to `s'. The second endpoint must
878 not precede the first in the current collating sequence.
879 - c Any other character is interpreted as itself. */
882 build_spec_list (const struct E_string *es, struct Spec_list *result)
889 /* The main for-loop below recognizes the 4 multi-character constructs.
890 A character that matches (in its context) none of the multi-character
891 constructs is classified as `normal'. Since all multi-character
892 constructs have at least 3 characters, any strings of length 2 or
893 less are composed solely of normal characters. Hence, the index of
894 the outer for-loop runs only as far as LEN-2. */
896 for (i = 0; i + 2 < es->len; /* empty */)
898 if (es_match (es, i, '['))
900 bool matched_multi_char_construct;
901 size_t closing_bracket_idx;
902 unsigned char char_to_repeat;
906 matched_multi_char_construct = true;
907 if (es_match (es, i + 1, ':') || es_match (es, i + 1, '='))
909 size_t closing_delim_idx;
911 if (find_closing_delim (es, i + 2, p[i + 1], &closing_delim_idx))
913 size_t opnd_str_len = closing_delim_idx - 1 - (i + 2) + 1;
914 char const *opnd_str = p + i + 2;
916 if (opnd_str_len == 0)
919 error (0, 0, _("missing character class name `[::]'"));
922 _("missing equivalence class character `[==]'"));
928 /* FIXME: big comment. */
929 if (!append_char_class (result, opnd_str, opnd_str_len))
931 if (star_digits_closebracket (es, i + 2))
932 goto try_bracketed_repeat;
935 char *tmp = make_printable_str (opnd_str,
937 error (0, 0, _("invalid character class %s"),
946 /* FIXME: big comment. */
947 if (!append_equiv_class (result, opnd_str, opnd_str_len))
949 if (star_digits_closebracket (es, i + 2))
950 goto try_bracketed_repeat;
953 char *tmp = make_printable_str (opnd_str,
956 _("%s: equivalence class operand must be a single character"),
964 i = closing_delim_idx + 2;
967 /* Else fall through. This could be [:*] or [=*]. */
970 try_bracketed_repeat:
972 /* Determine whether this is a bracketed repeat range
973 matching the RE \[.\*(dec_or_oct_number)?\]. */
974 err = find_bracketed_repeat (es, i + 1, &char_to_repeat,
976 &closing_bracket_idx);
979 append_repeated_char (result, char_to_repeat, repeat_count);
980 i = closing_bracket_idx + 1;
984 matched_multi_char_construct = false;
988 /* Found a string that looked like [c*n] but the
989 numeric part was invalid. */
993 if (matched_multi_char_construct)
996 /* We reach this point if P does not match [:str:], [=c=],
997 [c*n], or [c*]. Now, see if P looks like a range `[-c'
998 (from `[' to `c'). */
1001 /* Look ahead one char for ranges like a-z. */
1002 if (es_match (es, i + 1, '-'))
1004 if (!append_range (result, p[i], p[i + 2]))
1010 append_normal_char (result, p[i]);
1015 /* Now handle the (2 or fewer) remaining characters p[i]..p[es->len - 1]. */
1016 for (; i < es->len; i++)
1017 append_normal_char (result, p[i]);
1022 /* Advance past the current construct.
1023 S->tail must be non-NULL. */
1025 skip_construct (struct Spec_list *s)
1027 s->tail = s->tail->next;
1028 s->state = NEW_ELEMENT;
1031 /* Given a Spec_list S (with its saved state implicit in the values
1032 of its members `tail' and `state'), return the next single character
1033 in the expansion of S's constructs. If the last character of S was
1034 returned on the previous call or if S was empty, this function
1035 returns -1. For example, successive calls to get_next where S
1036 represents the spec-string 'a-d[y*3]' will return the sequence
1037 of values a, b, c, d, y, y, y, -1. Finally, if the construct from
1038 which the returned character comes is [:upper:] or [:lower:], the
1039 parameter CLASS is given a value to indicate which it was. Otherwise
1040 CLASS is set to UL_NONE. This value is used only when constructing
1041 the translation table to verify that any occurrences of upper and
1042 lower class constructs in the spec-strings appear in the same relative
1046 get_next (struct Spec_list *s, enum Upper_Lower_class *class)
1048 struct List_element *p;
1055 if (s->state == BEGIN_STATE)
1057 s->tail = s->head->next;
1058 s->state = NEW_ELEMENT;
1067 case RE_NORMAL_CHAR:
1068 return_val = p->u.normal_char;
1069 s->state = NEW_ELEMENT;
1074 if (s->state == NEW_ELEMENT)
1075 s->state = p->u.range.first_char;
1078 return_val = s->state;
1079 if (s->state == p->u.range.last_char)
1082 s->state = NEW_ELEMENT;
1089 switch (p->u.char_class)
1102 if (s->state == NEW_ELEMENT)
1104 for (i = 0; i < N_CHARS; i++)
1105 if (is_char_class_member (p->u.char_class, i))
1107 assert (i < N_CHARS);
1110 assert (is_char_class_member (p->u.char_class, s->state));
1111 return_val = s->state;
1112 for (i = s->state + 1; i < N_CHARS; i++)
1113 if (is_char_class_member (p->u.char_class, i))
1120 s->state = NEW_ELEMENT;
1124 case RE_EQUIV_CLASS:
1125 /* FIXME: this assumes that each character is alone in its own
1126 equivalence class (which appears to be correct for my
1127 LC_COLLATE. But I don't know of any function that allows
1128 one to determine a character's equivalence class. */
1130 return_val = p->u.equiv_code;
1131 s->state = NEW_ELEMENT;
1135 case RE_REPEATED_CHAR:
1136 /* Here, a repeat count of n == 0 means don't repeat at all. */
1137 if (p->u.repeated_char.repeat_count == 0)
1140 s->state = NEW_ELEMENT;
1141 return_val = get_next (s, class);
1145 if (s->state == NEW_ELEMENT)
1150 return_val = p->u.repeated_char.the_repeated_char;
1151 if (s->state == p->u.repeated_char.repeat_count)
1154 s->state = NEW_ELEMENT;
1167 /* This is a minor kludge. This function is called from
1168 get_spec_stats to determine the cardinality of a set derived
1169 from a complemented string. It's a kludge in that some of the
1170 same operations are (duplicated) performed in set_initialize. */
1173 card_of_complement (struct Spec_list *s)
1176 int cardinality = N_CHARS;
1177 bool in_set[N_CHARS] = { 0, };
1179 s->state = BEGIN_STATE;
1180 while ((c = get_next (s, NULL)) != -1)
1182 cardinality -= (!in_set[c]);
1188 /* Gather statistics about the spec-list S in preparation for the tests
1189 in validate that determine the consistency of the specs. This function
1190 is called at most twice; once for string1, and again for any string2.
1191 LEN_S1 < 0 indicates that this is the first call and that S represents
1192 string1. When LEN_S1 >= 0, it is the length of the expansion of the
1193 constructs in string1, and we can use its value to resolve any
1194 indefinite repeat construct in S (which represents string2). Hence,
1195 this function has the side-effect that it converts a valid [c*]
1196 construct in string2 to [c*n] where n is large enough (or 0) to give
1197 string2 the same length as string1. For example, with the command
1198 tr a-z 'A[\n*]Z' on the second call to get_spec_stats, LEN_S1 would
1199 be 26 and S (representing string2) would be converted to 'A[\n*24]Z'. */
1202 get_spec_stats (struct Spec_list *s)
1204 struct List_element *p;
1207 s->n_indefinite_repeats = 0;
1208 s->has_equiv_class = false;
1209 s->has_restricted_char_class = false;
1210 s->has_char_class = false;
1211 for (p = s->head->next; p; p = p->next)
1219 case RE_NORMAL_CHAR:
1224 assert (p->u.range.last_char >= p->u.range.first_char);
1225 len = p->u.range.last_char - p->u.range.first_char + 1;
1229 s->has_char_class = true;
1230 for (i = 0; i < N_CHARS; i++)
1231 if (is_char_class_member (p->u.char_class, i))
1233 switch (p->u.char_class)
1239 s->has_restricted_char_class = true;
1244 case RE_EQUIV_CLASS:
1245 for (i = 0; i < N_CHARS; i++)
1246 if (is_equiv_class_member (p->u.equiv_code, i))
1248 s->has_equiv_class = true;
1251 case RE_REPEATED_CHAR:
1252 if (p->u.repeated_char.repeat_count > 0)
1253 len = p->u.repeated_char.repeat_count;
1256 s->indefinite_repeat_element = p;
1257 ++(s->n_indefinite_repeats);
1266 /* Check for arithmetic overflow in computing length. Also, reject
1267 any length greater than the maximum repeat count, in case the
1268 length is later used to compute the repeat count for an
1269 indefinite element. */
1270 new_length = length + len;
1271 if (! (length <= new_length && new_length <= REPEAT_COUNT_MAXIMUM))
1272 error (EXIT_FAILURE, 0, _("too many characters in set"));
1273 length = new_length;
1280 get_s1_spec_stats (struct Spec_list *s1)
1282 get_spec_stats (s1);
1284 s1->length = card_of_complement (s1);
1288 get_s2_spec_stats (struct Spec_list *s2, count len_s1)
1290 get_spec_stats (s2);
1291 if (len_s1 >= s2->length && s2->n_indefinite_repeats == 1)
1293 s2->indefinite_repeat_element->u.repeated_char.repeat_count =
1294 len_s1 - s2->length;
1295 s2->length = len_s1;
1300 spec_init (struct Spec_list *spec_list)
1302 struct List_element *new = xmalloc (sizeof *new);
1303 spec_list->head = spec_list->tail = new;
1304 spec_list->head->next = NULL;
1307 /* This function makes two passes over the argument string S. The first
1308 one converts all \c and \ddd escapes to their one-byte representations.
1309 The second constructs a linked specification list, SPEC_LIST, of the
1310 characters and constructs that comprise the argument string. If either
1311 of these passes detects an error, this function returns false. */
1314 parse_str (char const *s, struct Spec_list *spec_list)
1317 bool ok = unquote (s, &es) && build_spec_list (&es, spec_list);
1322 /* Given two specification lists, S1 and S2, and assuming that
1323 S1->length > S2->length, append a single [c*n] element to S2 where c
1324 is the last character in the expansion of S2 and n is the difference
1325 between the two lengths.
1326 Upon successful completion, S2->length is set to S1->length. The only
1327 way this function can fail to make S2 as long as S1 is when S2 has
1328 zero-length, since in that case, there is no last character to repeat.
1329 So S2->length is required to be at least 1.
1331 Providing this functionality allows the user to do some pretty
1332 non-BSD (and non-portable) things: For example, the command
1333 tr -cs '[:upper:]0-9' '[:lower:]'
1334 is almost guaranteed to give results that depend on your collating
1338 string2_extend (const struct Spec_list *s1, struct Spec_list *s2)
1340 struct List_element *p;
1341 unsigned char char_to_repeat;
1344 assert (translating);
1345 assert (s1->length > s2->length);
1346 assert (s2->length > 0);
1351 case RE_NORMAL_CHAR:
1352 char_to_repeat = p->u.normal_char;
1355 char_to_repeat = p->u.range.last_char;
1358 for (i = N_CHARS - 1; i >= 0; i--)
1359 if (is_char_class_member (p->u.char_class, i))
1365 case RE_REPEATED_CHAR:
1366 char_to_repeat = p->u.repeated_char.the_repeated_char;
1369 case RE_EQUIV_CLASS:
1370 /* This shouldn't happen, because validate exits with an error
1371 if it finds an equiv class in string2 when translating. */
1380 append_repeated_char (s2, char_to_repeat, s1->length - s2->length);
1381 s2->length = s1->length;
1384 /* Return true if S is a non-empty list in which exactly one
1385 character (but potentially, many instances of it) appears.
1386 E.g., [X*] or xxxxxxxx. */
1389 homogeneous_spec_list (struct Spec_list *s)
1393 s->state = BEGIN_STATE;
1395 if ((b = get_next (s, NULL)) == -1)
1398 while ((c = get_next (s, NULL)) != -1)
1405 /* Die with an error message if S1 and S2 describe strings that
1406 are not valid with the given command line switches.
1407 A side effect of this function is that if a valid [c*] or
1408 [c*0] construct appears in string2, it is converted to [c*n]
1409 with a value for n that makes s2->length == s1->length. By
1410 the same token, if the --truncate-set1 option is not
1411 given, S2 may be extended. */
1414 validate (struct Spec_list *s1, struct Spec_list *s2)
1416 get_s1_spec_stats (s1);
1417 if (s1->n_indefinite_repeats > 0)
1419 error (EXIT_FAILURE, 0,
1420 _("the [c*] repeat construct may not appear in string1"));
1425 get_s2_spec_stats (s2, s1->length);
1427 if (s2->n_indefinite_repeats > 1)
1429 error (EXIT_FAILURE, 0,
1430 _("only one [c*] repeat construct may appear in string2"));
1435 if (s2->has_equiv_class)
1437 error (EXIT_FAILURE, 0,
1438 _("[=c=] expressions may not appear in string2 \
1439 when translating"));
1442 if (s1->length > s2->length)
1446 /* string2 must be non-empty unless --truncate-set1 is
1447 given or string1 is empty. */
1449 if (s2->length == 0)
1450 error (EXIT_FAILURE, 0,
1451 _("when not truncating set1, string2 must be non-empty"));
1452 string2_extend (s1, s2);
1456 if (complement && s1->has_char_class
1457 && ! (s2->length == s1->length && homogeneous_spec_list (s2)))
1459 error (EXIT_FAILURE, 0,
1460 _("when translating with complemented character classes,\
1461 \nstring2 must map all characters in the domain to one"));
1464 if (s2->has_restricted_char_class)
1466 error (EXIT_FAILURE, 0,
1467 _("when translating, the only character classes that may \
1468 appear in\nstring2 are `upper' and `lower'"));
1472 /* Not translating. */
1474 if (s2->n_indefinite_repeats > 0)
1475 error (EXIT_FAILURE, 0,
1476 _("the [c*] construct may appear in string2 only \
1477 when translating"));
1482 /* Read buffers of SIZE bytes via the function READER (if READER is
1483 NULL, read from stdin) until EOF. When non-NULL, READER is either
1484 read_and_delete or read_and_xlate. After each buffer is read, it is
1485 processed and written to stdout. The buffers are processed so that
1486 multiple consecutive occurrences of the same character in the input
1487 stream are replaced by a single occurrence of that character if the
1488 character is in the squeeze set. */
1491 squeeze_filter (char *buf, size_t size, size_t (*reader) (char *, size_t))
1493 /* A value distinct from any character that may have been stored in a
1494 buffer as the result of a block-read in the function squeeze_filter. */
1495 enum { NOT_A_CHAR = CHAR_MAX + 1 };
1497 int char_to_squeeze = NOT_A_CHAR;
1507 nr = reader (buf, size);
1515 if (char_to_squeeze == NOT_A_CHAR)
1518 /* Here, by being a little tricky, we can get a significant
1519 performance increase in most cases when the input is
1520 reasonably large. Since tr will modify the input only
1521 if two consecutive (and identical) input characters are
1522 in the squeeze set, we can step by two through the data
1523 when searching for a character in the squeeze set. This
1524 means there may be a little more work in a few cases and
1525 perhaps twice as much work in the worst cases where most
1526 of the input is removed by squeezing repeats. But most
1527 uses of this functionality seem to remove less than 20-30%
1529 for (; i < nr && !in_squeeze_set[to_uchar (buf[i])]; i += 2)
1532 /* There is a special case when i == nr and we've just
1533 skipped a character (the last one in buf) that is in
1535 if (i == nr && in_squeeze_set[to_uchar (buf[i - 1])])
1539 out_len = nr - begin;
1542 char_to_squeeze = buf[i];
1543 /* We're about to output buf[begin..i]. */
1544 out_len = i - begin + 1;
1546 /* But since we stepped by 2 in the loop above,
1547 out_len may be one too large. */
1548 if (i > 0 && buf[i - 1] == char_to_squeeze)
1551 /* Advance i to the index of first character to be
1552 considered when looking for a char different from
1557 && fwrite (&buf[begin], 1, out_len, stdout) != out_len)
1558 error (EXIT_FAILURE, errno, _("write error"));
1561 if (char_to_squeeze != NOT_A_CHAR)
1563 /* Advance i to index of first char != char_to_squeeze
1564 (or to nr if all the rest of the characters in this
1565 buffer are the same as char_to_squeeze). */
1566 for (; i < nr && buf[i] == char_to_squeeze; i++)
1569 char_to_squeeze = NOT_A_CHAR;
1570 /* If (i >= nr) we've squeezed the last character in this buffer.
1571 So now we have to read a new buffer and continue comparing
1572 characters against char_to_squeeze. */
1578 plain_read (char *buf, size_t size)
1580 size_t nr = safe_read (STDIN_FILENO, buf, size);
1581 if (nr == SAFE_READ_ERROR)
1582 error (EXIT_FAILURE, errno, _("read error"));
1586 /* Read buffers of SIZE bytes from stdin until one is found that
1587 contains at least one character not in the delete set. Store
1588 in the array BUF, all characters from that buffer that are not
1589 in the delete set, and return the number of characters saved
1593 read_and_delete (char *buf, size_t size)
1597 /* This enclosing do-while loop is to make sure that
1598 we don't return zero (indicating EOF) when we've
1599 just deleted all the characters in a buffer. */
1603 size_t nr = plain_read (buf, size);
1608 /* This first loop may be a waste of code, but gives much
1609 better performance when no characters are deleted in
1610 the beginning of a buffer. It just avoids the copying
1611 of buf[i] into buf[n_saved] when it would be a NOP. */
1613 for (i = 0; i < nr && !in_delete_set[to_uchar (buf[i])]; i++)
1617 for (++i; i < nr; i++)
1618 if (!in_delete_set[to_uchar (buf[i])])
1619 buf[n_saved++] = buf[i];
1621 while (n_saved == 0);
1626 /* Read at most SIZE bytes from stdin into the array BUF. Then
1627 perform the in-place and one-to-one mapping specified by the global
1628 array `xlate'. Return the number of characters read, or 0 upon EOF. */
1631 read_and_xlate (char *buf, size_t size)
1633 size_t bytes_read = plain_read (buf, size);
1636 for (i = 0; i < bytes_read; i++)
1637 buf[i] = xlate[to_uchar (buf[i])];
1642 /* Initialize a boolean membership set, IN_SET, with the character
1643 values obtained by traversing the linked list of constructs S
1644 using the function `get_next'. IN_SET is expected to have been
1645 initialized to all zeros by the caller. If COMPLEMENT_THIS_SET
1646 is true the resulting set is complemented. */
1649 set_initialize (struct Spec_list *s, bool complement_this_set, bool *in_set)
1654 s->state = BEGIN_STATE;
1655 while ((c = get_next (s, NULL)) != -1)
1657 if (complement_this_set)
1658 for (i = 0; i < N_CHARS; i++)
1659 in_set[i] = (!in_set[i]);
1663 main (int argc, char **argv)
1666 int non_option_args;
1669 struct Spec_list buf1, buf2;
1670 struct Spec_list *s1 = &buf1;
1671 struct Spec_list *s2 = &buf2;
1673 initialize_main (&argc, &argv);
1674 program_name = argv[0];
1675 setlocale (LC_ALL, "");
1676 bindtextdomain (PACKAGE, LOCALEDIR);
1677 textdomain (PACKAGE);
1679 atexit (close_stdout);
1681 while ((c = getopt_long (argc, argv, "+cCdst", long_options, NULL)) != -1)
1695 squeeze_repeats = true;
1699 truncate_set1 = true;
1702 case_GETOPT_HELP_CHAR;
1704 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1707 usage (EXIT_FAILURE);
1712 non_option_args = argc - optind;
1713 translating = (non_option_args == 2 && !delete);
1714 min_operands = 1 + (delete == squeeze_repeats);
1715 max_operands = 1 + (delete <= squeeze_repeats);
1717 if (non_option_args < min_operands)
1719 if (non_option_args == 0)
1720 error (0, 0, _("missing operand"));
1723 error (0, 0, _("missing operand after %s"), quote (argv[argc - 1]));
1724 fprintf (stderr, "%s\n",
1726 ? ("Two strings must be given when "
1727 "both deleting and squeezing repeats.")
1728 : "Two strings must be given when translating."));
1730 usage (EXIT_FAILURE);
1733 if (max_operands < non_option_args)
1735 error (0, 0, _("extra operand %s"), quote (argv[optind + max_operands]));
1736 if (non_option_args == 2)
1737 fprintf (stderr, "%s\n",
1738 _("Only one string may be given when "
1739 "deleting without squeezing repeats."));
1740 usage (EXIT_FAILURE);
1744 if (!parse_str (argv[optind], s1))
1745 exit (EXIT_FAILURE);
1747 if (non_option_args == 2)
1750 if (!parse_str (argv[optind + 1], s2))
1751 exit (EXIT_FAILURE);
1758 /* Use binary I/O, since `tr' is sometimes used to transliterate
1759 non-printable characters, or characters which are stripped away
1760 by text-mode reads (like CR and ^Z). */
1761 if (O_BINARY && ! isatty (STDIN_FILENO))
1762 freopen (NULL, "rb", stdin);
1763 if (O_BINARY && ! isatty (STDOUT_FILENO))
1764 freopen (NULL, "wb", stdout);
1766 if (squeeze_repeats && non_option_args == 1)
1768 set_initialize (s1, complement, in_squeeze_set);
1769 squeeze_filter (io_buf, sizeof io_buf, plain_read);
1771 else if (delete && non_option_args == 1)
1773 set_initialize (s1, complement, in_delete_set);
1777 size_t nr = read_and_delete (io_buf, sizeof io_buf);
1780 if (fwrite (io_buf, 1, nr, stdout) != nr)
1781 error (EXIT_FAILURE, errno, _("write error"));
1784 else if (squeeze_repeats && delete && non_option_args == 2)
1786 set_initialize (s1, complement, in_delete_set);
1787 set_initialize (s2, false, in_squeeze_set);
1788 squeeze_filter (io_buf, sizeof io_buf, read_and_delete);
1790 else if (translating)
1795 bool *in_s1 = in_delete_set;
1797 set_initialize (s1, false, in_s1);
1798 s2->state = BEGIN_STATE;
1799 for (i = 0; i < N_CHARS; i++)
1801 for (i = 0; i < N_CHARS; i++)
1805 int ch = get_next (s2, NULL);
1806 assert (ch != -1 || truncate_set1);
1809 /* This will happen when tr is invoked like e.g.
1810 tr -cs A-Za-z0-9 '\012'. */
1821 bool case_convert = false;
1822 enum Upper_Lower_class class_s1;
1823 enum Upper_Lower_class class_s2;
1825 for (i = 0; i < N_CHARS; i++)
1827 s1->state = BEGIN_STATE;
1828 s2->state = BEGIN_STATE;
1831 /* When the previous pair identified case-converting classes,
1832 advance S1 and S2 so that each points to the following
1836 skip_construct (s1);
1837 skip_construct (s2);
1838 case_convert = false;
1841 c1 = get_next (s1, &class_s1);
1842 c2 = get_next (s2, &class_s2);
1844 /* When translating and there is an [:upper:] or [:lower:]
1845 class in SET2, then there must be a corresponding [:lower:]
1846 or [:upper:] class in SET1. */
1847 if (class_s1 == UL_NONE
1848 && (class_s2 == UL_LOWER || class_s2 == UL_UPPER))
1849 error (EXIT_FAILURE, 0,
1850 _("misaligned [:upper:] and/or [:lower:] construct"));
1852 if (class_s1 == UL_LOWER && class_s2 == UL_UPPER)
1854 case_convert = true;
1855 for (i = 0; i < N_CHARS; i++)
1857 xlate[i] = toupper (i);
1859 else if (class_s1 == UL_UPPER && class_s2 == UL_LOWER)
1861 case_convert = true;
1862 for (i = 0; i < N_CHARS; i++)
1864 xlate[i] = tolower (i);
1866 else if ((class_s1 == UL_LOWER && class_s2 == UL_LOWER)
1867 || (class_s1 == UL_UPPER && class_s2 == UL_UPPER))
1869 /* POSIX says the behavior of `tr "[:upper:]" "[:upper:]"'
1870 is undefined. Treat it as a no-op. */
1874 /* The following should have been checked by validate... */
1875 if (c1 == -1 || c2 == -1)
1880 assert (c1 == -1 || truncate_set1);
1882 if (squeeze_repeats)
1884 set_initialize (s2, false, in_squeeze_set);
1885 squeeze_filter (io_buf, sizeof io_buf, read_and_xlate);
1891 size_t bytes_read = read_and_xlate (io_buf, sizeof io_buf);
1892 if (bytes_read == 0)
1894 if (fwrite (io_buf, 1, bytes_read, stdout) != bytes_read)
1895 error (EXIT_FAILURE, errno, _("write error"));
1900 if (close (STDIN_FILENO) != 0)
1901 error (EXIT_FAILURE, errno, _("standard input"));
1903 exit (EXIT_SUCCESS);