doc: clarify when dd iflag=fullblock is useful
[coreutils.git] / src / basename.c
blob353ff084fc6d4bb880c7d8fee75f367f74d762ae
1 /* basename -- strip directory and suffix from file names
2 Copyright (C) 1990-2012 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 #include <config.h>
18 #include <getopt.h>
19 #include <stdio.h>
20 #include <sys/types.h>
22 #include "system.h"
23 #include "error.h"
24 #include "quote.h"
26 /* The official name of this program (e.g., no 'g' prefix). */
27 #define PROGRAM_NAME "basename"
29 #define AUTHORS proper_name ("David MacKenzie")
31 static struct option const longopts[] =
33 {"multiple", no_argument, NULL, 'a'},
34 {"suffix", required_argument, NULL, 's'},
35 {"zero", no_argument, NULL, 'z'},
36 {GETOPT_HELP_OPTION_DECL},
37 {GETOPT_VERSION_OPTION_DECL},
38 {NULL, 0, NULL, 0}
41 void
42 usage (int status)
44 if (status != EXIT_SUCCESS)
45 emit_try_help ();
46 else
48 printf (_("\
49 Usage: %s NAME [SUFFIX]\n\
50 or: %s OPTION... NAME...\n\
51 "),
52 program_name, program_name);
53 fputs (_("\
54 Print NAME with any leading directory components removed.\n\
55 If specified, also remove a trailing SUFFIX.\n\
56 \n\
57 "), stdout);
59 fputs (_("\
60 -a, --multiple support multiple arguments and treat each as a NAME\n\
61 -s, --suffix=SUFFIX remove a trailing SUFFIX\n\
62 -z, --zero separate output with NUL rather than newline\n\
63 "), stdout);
64 fputs (HELP_OPTION_DESCRIPTION, stdout);
65 fputs (VERSION_OPTION_DESCRIPTION, stdout);
66 printf (_("\
67 \n\
68 Examples:\n\
69 %s /usr/bin/sort -> \"sort\"\n\
70 %s include/stdio.h .h -> \"stdio\"\n\
71 %s -s .h include/stdio.h -> \"stdio\"\n\
72 %s -a any/str1 any/str2 -> \"str1\" followed by \"str2\"\n\
73 "),
74 program_name, program_name, program_name, program_name);
75 emit_ancillary_info ();
77 exit (status);
80 /* Remove SUFFIX from the end of NAME if it is there, unless NAME
81 consists entirely of SUFFIX. */
83 static void
84 remove_suffix (char *name, const char *suffix)
86 char *np;
87 const char *sp;
89 np = name + strlen (name);
90 sp = suffix + strlen (suffix);
92 while (np > name && sp > suffix)
93 if (*--np != *--sp)
94 return;
95 if (np > name)
96 *np = '\0';
99 /* Perform the basename operation on STRING. If SUFFIX is non-NULL, remove
100 the trailing SUFFIX. Finally, output the result string. */
102 static void
103 perform_basename (const char *string, const char *suffix, bool use_nuls)
105 char *name = base_name (string);
106 strip_trailing_slashes (name);
108 /* Per POSIX, 'basename // /' must return '//' on platforms with
109 distinct //. On platforms with drive letters, this generalizes
110 to making 'basename c: :' return 'c:'. This rule is captured by
111 skipping suffix stripping if base_name returned an absolute path
112 or a drive letter (only possible if name is a file-system
113 root). */
114 if (suffix && IS_RELATIVE_FILE_NAME (name) && ! FILE_SYSTEM_PREFIX_LEN (name))
115 remove_suffix (name, suffix);
117 fputs (name, stdout);
118 putchar (use_nuls ? '\0' : '\n');
119 free (name);
123 main (int argc, char **argv)
125 bool multiple_names = false;
126 bool use_nuls = false;
127 const char *suffix = NULL;
129 initialize_main (&argc, &argv);
130 set_program_name (argv[0]);
131 setlocale (LC_ALL, "");
132 bindtextdomain (PACKAGE, LOCALEDIR);
133 textdomain (PACKAGE);
135 atexit (close_stdout);
137 while (true)
139 int c = getopt_long (argc, argv, "+as:z", longopts, NULL);
141 if (c == -1)
142 break;
144 switch (c)
146 case 's':
147 suffix = optarg;
149 case 'a':
150 multiple_names = true;
151 break;
153 case 'z':
154 use_nuls = true;
155 break;
157 case_GETOPT_HELP_CHAR;
158 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
160 default:
161 usage (EXIT_FAILURE);
165 if (argc < optind + 1)
167 error (0, 0, _("missing operand"));
168 usage (EXIT_FAILURE);
171 if (!multiple_names && optind + 2 < argc)
173 error (0, 0, _("extra operand %s"), quote (argv[optind + 2]));
174 usage (EXIT_FAILURE);
177 if (multiple_names)
179 for (; optind < argc; optind++)
180 perform_basename (argv[optind], suffix, use_nuls);
182 else
183 perform_basename (argv[optind],
184 optind + 2 == argc ? argv[optind + 1] : NULL, use_nuls);
186 exit (EXIT_SUCCESS);