maint: avoid new syntax-check failure
[coreutils/ericb.git] / src / ls.c
blob680a7c315898da8f0dac06d3bf8d25e7d659e5ed
1 /* `dir', `vdir' and `ls' directory listing programs for GNU.
2 Copyright (C) 1985, 1988, 1990-1991, 1995-2011 Free Software Foundation,
3 Inc.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 /* If ls_mode is LS_MULTI_COL,
19 the multi-column format is the default regardless
20 of the type of output device.
21 This is for the `dir' program.
23 If ls_mode is LS_LONG_FORMAT,
24 the long format is the default regardless of the
25 type of output device.
26 This is for the `vdir' program.
28 If ls_mode is LS_LS,
29 the output format depends on whether the output
30 device is a terminal.
31 This is for the `ls' program. */
33 /* Written by Richard Stallman and David MacKenzie. */
35 /* Color support by Peter Anvin <Peter.Anvin@linux.org> and Dennis
36 Flaherty <dennisf@denix.elk.miles.com> based on original patches by
37 Greg Lee <lee@uhunix.uhcc.hawaii.edu>. */
39 #include <config.h>
40 #include <sys/types.h>
42 #include <termios.h>
43 #if HAVE_STROPTS_H
44 # include <stropts.h>
45 #endif
46 #include <sys/ioctl.h>
48 #ifdef WINSIZE_IN_PTEM
49 # include <sys/stream.h>
50 # include <sys/ptem.h>
51 #endif
53 #include <stdio.h>
54 #include <assert.h>
55 #include <setjmp.h>
56 #include <pwd.h>
57 #include <getopt.h>
58 #include <signal.h>
59 #include <selinux/selinux.h>
60 #include <wchar.h>
62 #if HAVE_LANGINFO_CODESET
63 # include <langinfo.h>
64 #endif
66 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
67 present. */
68 #ifndef SA_NOCLDSTOP
69 # define SA_NOCLDSTOP 0
70 # define sigprocmask(How, Set, Oset) /* empty */
71 # define sigset_t int
72 # if ! HAVE_SIGINTERRUPT
73 # define siginterrupt(sig, flag) /* empty */
74 # endif
75 #endif
77 /* NonStop circa 2011 lacks both SA_RESTART and siginterrupt, so don't
78 restart syscalls after a signal handler fires. This may cause
79 colors to get messed up on the screen if 'ls' is interrupted, but
80 that's the best we can do on such a platform. */
81 #ifndef SA_RESTART
82 # define SA_RESTART 0
83 #endif
85 #include "system.h"
86 #include <fnmatch.h>
88 #include "acl.h"
89 #include "argmatch.h"
90 #include "dev-ino.h"
91 #include "error.h"
92 #include "filenamecat.h"
93 #include "hard-locale.h"
94 #include "hash.h"
95 #include "human.h"
96 #include "filemode.h"
97 #include "filevercmp.h"
98 #include "idcache.h"
99 #include "ls.h"
100 #include "mbswidth.h"
101 #include "mpsort.h"
102 #include "obstack.h"
103 #include "quote.h"
104 #include "quotearg.h"
105 #include "stat-size.h"
106 #include "stat-time.h"
107 #include "strftime.h"
108 #include "xstrtol.h"
109 #include "areadlink.h"
110 #include "mbsalign.h"
112 /* Include <sys/capability.h> last to avoid a clash of <sys/types.h>
113 include guards with some premature versions of libcap.
114 For more details, see <http://bugzilla.redhat.com/483548>. */
115 #ifdef HAVE_CAP
116 # include <sys/capability.h>
117 #endif
119 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
120 : (ls_mode == LS_MULTI_COL \
121 ? "dir" : "vdir"))
123 #define AUTHORS \
124 proper_name ("Richard M. Stallman"), \
125 proper_name ("David MacKenzie")
127 #define obstack_chunk_alloc malloc
128 #define obstack_chunk_free free
130 /* Return an int indicating the result of comparing two integers.
131 Subtracting doesn't always work, due to overflow. */
132 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
134 /* Unix-based readdir implementations have historically returned a dirent.d_ino
135 value that is sometimes not equal to the stat-obtained st_ino value for
136 that same entry. This error occurs for a readdir entry that refers
137 to a mount point. readdir's error is to return the inode number of
138 the underlying directory -- one that typically cannot be stat'ed, as
139 long as a file system is mounted on that directory. RELIABLE_D_INO
140 encapsulates whether we can use the more efficient approach of relying
141 on readdir-supplied d_ino values, or whether we must incur the cost of
142 calling stat or lstat to obtain each guaranteed-valid inode number. */
144 #ifndef READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
145 # define READDIR_LIES_ABOUT_MOUNTPOINT_D_INO 1
146 #endif
148 #if READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
149 # define RELIABLE_D_INO(dp) NOT_AN_INODE_NUMBER
150 #else
151 # define RELIABLE_D_INO(dp) D_INO (dp)
152 #endif
154 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
155 # define st_author st_uid
156 #endif
158 enum filetype
160 unknown,
161 fifo,
162 chardev,
163 directory,
164 blockdev,
165 normal,
166 symbolic_link,
167 sock,
168 whiteout,
169 arg_directory
172 /* Display letters and indicators for each filetype.
173 Keep these in sync with enum filetype. */
174 static char const filetype_letter[] = "?pcdb-lswd";
176 /* Ensure that filetype and filetype_letter have the same
177 number of elements. */
178 verify (sizeof filetype_letter - 1 == arg_directory + 1);
180 #define FILETYPE_INDICATORS \
182 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
183 C_LINK, C_SOCK, C_FILE, C_DIR \
186 enum acl_type
188 ACL_T_NONE,
189 ACL_T_SELINUX_ONLY,
190 ACL_T_YES
193 struct fileinfo
195 /* The file name. */
196 char *name;
198 /* For symbolic link, name of the file linked to, otherwise zero. */
199 char *linkname;
201 struct stat stat;
203 enum filetype filetype;
205 /* For symbolic link and long listing, st_mode of file linked to, otherwise
206 zero. */
207 mode_t linkmode;
209 /* SELinux security context. */
210 security_context_t scontext;
212 bool stat_ok;
214 /* For symbolic link and color printing, true if linked-to file
215 exists, otherwise false. */
216 bool linkok;
218 /* For long listings, true if the file has an access control list,
219 or an SELinux security context. */
220 enum acl_type acl_type;
222 /* For color listings, true if a regular file has capability info. */
223 bool has_capability;
226 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
228 /* Null is a valid character in a color indicator (think about Epson
229 printers, for example) so we have to use a length/buffer string
230 type. */
232 struct bin_str
234 size_t len; /* Number of bytes */
235 const char *string; /* Pointer to the same */
238 #if ! HAVE_TCGETPGRP
239 # define tcgetpgrp(Fd) 0
240 #endif
242 static size_t quote_name (FILE *out, const char *name,
243 struct quoting_options const *options,
244 size_t *width);
245 static char *make_link_name (char const *name, char const *linkname);
246 static int decode_switches (int argc, char **argv);
247 static bool file_ignored (char const *name);
248 static uintmax_t gobble_file (char const *name, enum filetype type,
249 ino_t inode, bool command_line_arg,
250 char const *dirname);
251 static bool print_color_indicator (const struct fileinfo *f,
252 bool symlink_target);
253 static void put_indicator (const struct bin_str *ind);
254 static void add_ignore_pattern (const char *pattern);
255 static void attach (char *dest, const char *dirname, const char *name);
256 static void clear_files (void);
257 static void extract_dirs_from_files (char const *dirname,
258 bool command_line_arg);
259 static void get_link_name (char const *filename, struct fileinfo *f,
260 bool command_line_arg);
261 static void indent (size_t from, size_t to);
262 static size_t calculate_columns (bool by_columns);
263 static void print_current_files (void);
264 static void print_dir (char const *name, char const *realname,
265 bool command_line_arg);
266 static size_t print_file_name_and_frills (const struct fileinfo *f,
267 size_t start_col);
268 static void print_horizontal (void);
269 static int format_user_width (uid_t u);
270 static int format_group_width (gid_t g);
271 static void print_long_format (const struct fileinfo *f);
272 static void print_many_per_line (void);
273 static size_t print_name_with_quoting (const struct fileinfo *f,
274 bool symlink_target,
275 struct obstack *stack,
276 size_t start_col);
277 static void prep_non_filename_text (void);
278 static bool print_type_indicator (bool stat_ok, mode_t mode,
279 enum filetype type);
280 static void print_with_commas (void);
281 static void queue_directory (char const *name, char const *realname,
282 bool command_line_arg);
283 static void sort_files (void);
284 static void parse_ls_color (void);
285 void usage (int status);
287 /* Initial size of hash table.
288 Most hierarchies are likely to be shallower than this. */
289 #define INITIAL_TABLE_SIZE 30
291 /* The set of `active' directories, from the current command-line argument
292 to the level in the hierarchy at which files are being listed.
293 A directory is represented by its device and inode numbers (struct dev_ino).
294 A directory is added to this set when ls begins listing it or its
295 entries, and it is removed from the set just after ls has finished
296 processing it. This set is used solely to detect loops, e.g., with
297 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
298 static Hash_table *active_dir_set;
300 #define LOOP_DETECT (!!active_dir_set)
302 /* The table of files in the current directory:
304 `cwd_file' points to a vector of `struct fileinfo', one per file.
305 `cwd_n_alloc' is the number of elements space has been allocated for.
306 `cwd_n_used' is the number actually in use. */
308 /* Address of block containing the files that are described. */
309 static struct fileinfo *cwd_file;
311 /* Length of block that `cwd_file' points to, measured in files. */
312 static size_t cwd_n_alloc;
314 /* Index of first unused slot in `cwd_file'. */
315 static size_t cwd_n_used;
317 /* Vector of pointers to files, in proper sorted order, and the number
318 of entries allocated for it. */
319 static void **sorted_file;
320 static size_t sorted_file_alloc;
322 /* When true, in a color listing, color each symlink name according to the
323 type of file it points to. Otherwise, color them according to the `ln'
324 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
325 regardless. This is set when `ln=target' appears in LS_COLORS. */
327 static bool color_symlink_as_referent;
329 /* mode of appropriate file for colorization */
330 #define FILE_OR_LINK_MODE(File) \
331 ((color_symlink_as_referent && (File)->linkok) \
332 ? (File)->linkmode : (File)->stat.st_mode)
335 /* Record of one pending directory waiting to be listed. */
337 struct pending
339 char *name;
340 /* If the directory is actually the file pointed to by a symbolic link we
341 were told to list, `realname' will contain the name of the symbolic
342 link, otherwise zero. */
343 char *realname;
344 bool command_line_arg;
345 struct pending *next;
348 static struct pending *pending_dirs;
350 /* Current time in seconds and nanoseconds since 1970, updated as
351 needed when deciding whether a file is recent. */
353 static struct timespec current_time;
355 static bool print_scontext;
356 static char UNKNOWN_SECURITY_CONTEXT[] = "?";
358 /* Whether any of the files has an ACL. This affects the width of the
359 mode column. */
361 static bool any_has_acl;
363 /* The number of columns to use for columns containing inode numbers,
364 block sizes, link counts, owners, groups, authors, major device
365 numbers, minor device numbers, and file sizes, respectively. */
367 static int inode_number_width;
368 static int block_size_width;
369 static int nlink_width;
370 static int scontext_width;
371 static int owner_width;
372 static int group_width;
373 static int author_width;
374 static int major_device_number_width;
375 static int minor_device_number_width;
376 static int file_size_width;
378 /* Option flags */
380 /* long_format for lots of info, one per line.
381 one_per_line for just names, one per line.
382 many_per_line for just names, many per line, sorted vertically.
383 horizontal for just names, many per line, sorted horizontally.
384 with_commas for just names, many per line, separated by commas.
386 -l (and other options that imply -l), -1, -C, -x and -m control
387 this parameter. */
389 enum format
391 long_format, /* -l and other options that imply -l */
392 one_per_line, /* -1 */
393 many_per_line, /* -C */
394 horizontal, /* -x */
395 with_commas /* -m */
398 static enum format format;
400 /* `full-iso' uses full ISO-style dates and times. `long-iso' uses longer
401 ISO-style time stamps, though shorter than `full-iso'. `iso' uses shorter
402 ISO-style time stamps. `locale' uses locale-dependent time stamps. */
403 enum time_style
405 full_iso_time_style, /* --time-style=full-iso */
406 long_iso_time_style, /* --time-style=long-iso */
407 iso_time_style, /* --time-style=iso */
408 locale_time_style /* --time-style=locale */
411 static char const *const time_style_args[] =
413 "full-iso", "long-iso", "iso", "locale", NULL
415 static enum time_style const time_style_types[] =
417 full_iso_time_style, long_iso_time_style, iso_time_style,
418 locale_time_style
420 ARGMATCH_VERIFY (time_style_args, time_style_types);
422 /* Type of time to print or sort by. Controlled by -c and -u.
423 The values of each item of this enum are important since they are
424 used as indices in the sort functions array (see sort_files()). */
426 enum time_type
428 time_mtime, /* default */
429 time_ctime, /* -c */
430 time_atime, /* -u */
431 time_numtypes /* the number of elements of this enum */
434 static enum time_type time_type;
436 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
437 The values of each item of this enum are important since they are
438 used as indices in the sort functions array (see sort_files()). */
440 enum sort_type
442 sort_none = -1, /* -U */
443 sort_name, /* default */
444 sort_extension, /* -X */
445 sort_size, /* -S */
446 sort_version, /* -v */
447 sort_time, /* -t */
448 sort_numtypes /* the number of elements of this enum */
451 static enum sort_type sort_type;
453 /* Direction of sort.
454 false means highest first if numeric,
455 lowest first if alphabetic;
456 these are the defaults.
457 true means the opposite order in each case. -r */
459 static bool sort_reverse;
461 /* True means to display owner information. -g turns this off. */
463 static bool print_owner = true;
465 /* True means to display author information. */
467 static bool print_author;
469 /* True means to display group information. -G and -o turn this off. */
471 static bool print_group = true;
473 /* True means print the user and group id's as numbers rather
474 than as names. -n */
476 static bool numeric_ids;
478 /* True means mention the size in blocks of each file. -s */
480 static bool print_block_size;
482 /* Human-readable options for output. */
483 static int human_output_opts;
485 /* The units to use when printing sizes other than file sizes. */
486 static uintmax_t output_block_size;
488 /* Likewise, but for file sizes. */
489 static uintmax_t file_output_block_size = 1;
491 /* Follow the output with a special string. Using this format,
492 Emacs' dired mode starts up twice as fast, and can handle all
493 strange characters in file names. */
494 static bool dired;
496 /* `none' means don't mention the type of files.
497 `slash' means mention directories only, with a '/'.
498 `file_type' means mention file types.
499 `classify' means mention file types and mark executables.
501 Controlled by -F, -p, and --indicator-style. */
503 enum indicator_style
505 none, /* --indicator-style=none */
506 slash, /* -p, --indicator-style=slash */
507 file_type, /* --indicator-style=file-type */
508 classify /* -F, --indicator-style=classify */
511 static enum indicator_style indicator_style;
513 /* Names of indicator styles. */
514 static char const *const indicator_style_args[] =
516 "none", "slash", "file-type", "classify", NULL
518 static enum indicator_style const indicator_style_types[] =
520 none, slash, file_type, classify
522 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
524 /* True means use colors to mark types. Also define the different
525 colors as well as the stuff for the LS_COLORS environment variable.
526 The LS_COLORS variable is now in a termcap-like format. */
528 static bool print_with_color;
530 /* Whether we used any colors in the output so far. If so, we will
531 need to restore the default color later. If not, we will need to
532 call prep_non_filename_text before using color for the first time. */
534 static bool used_color = false;
536 enum color_type
538 color_never, /* 0: default or --color=never */
539 color_always, /* 1: --color=always */
540 color_if_tty /* 2: --color=tty */
543 enum Dereference_symlink
545 DEREF_UNDEFINED = 1,
546 DEREF_NEVER,
547 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
548 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
549 DEREF_ALWAYS /* -L */
552 enum indicator_no
554 C_LEFT, C_RIGHT, C_END, C_RESET, C_NORM, C_FILE, C_DIR, C_LINK,
555 C_FIFO, C_SOCK,
556 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
557 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE, C_CAP, C_MULTIHARDLINK,
558 C_CLR_TO_EOL
561 static const char *const indicator_name[]=
563 "lc", "rc", "ec", "rs", "no", "fi", "di", "ln", "pi", "so",
564 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
565 "ow", "tw", "ca", "mh", "cl", NULL
568 struct color_ext_type
570 struct bin_str ext; /* The extension we're looking for */
571 struct bin_str seq; /* The sequence to output when we do */
572 struct color_ext_type *next; /* Next in list */
575 static struct bin_str color_indicator[] =
577 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
578 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
579 { 0, NULL }, /* ec: End color (replaces lc+no+rc) */
580 { LEN_STR_PAIR ("0") }, /* rs: Reset to ordinary colors */
581 { 0, NULL }, /* no: Normal */
582 { 0, NULL }, /* fi: File: default */
583 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
584 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
585 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
586 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
587 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
588 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
589 { 0, NULL }, /* mi: Missing file: undefined */
590 { 0, NULL }, /* or: Orphaned symlink: undefined */
591 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
592 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
593 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
594 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
595 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
596 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
597 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
598 { LEN_STR_PAIR ("30;41") }, /* ca: black on red */
599 { 0, NULL }, /* mh: disabled by default */
600 { LEN_STR_PAIR ("\033[K") }, /* cl: clear to end of line */
603 /* FIXME: comment */
604 static struct color_ext_type *color_ext_list = NULL;
606 /* Buffer for color sequences */
607 static char *color_buf;
609 /* True means to check for orphaned symbolic link, for displaying
610 colors. */
612 static bool check_symlink_color;
614 /* True means mention the inode number of each file. -i */
616 static bool print_inode;
618 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
619 other options that imply -l), and -L. */
621 static enum Dereference_symlink dereference;
623 /* True means when a directory is found, display info on its
624 contents. -R */
626 static bool recursive;
628 /* True means when an argument is a directory name, display info
629 on it itself. -d */
631 static bool immediate_dirs;
633 /* True means that directories are grouped before files. */
635 static bool directories_first;
637 /* Which files to ignore. */
639 static enum
641 /* Ignore files whose names start with `.', and files specified by
642 --hide and --ignore. */
643 IGNORE_DEFAULT,
645 /* Ignore `.', `..', and files specified by --ignore. */
646 IGNORE_DOT_AND_DOTDOT,
648 /* Ignore only files specified by --ignore. */
649 IGNORE_MINIMAL
650 } ignore_mode;
652 /* A linked list of shell-style globbing patterns. If a non-argument
653 file name matches any of these patterns, it is ignored.
654 Controlled by -I. Multiple -I options accumulate.
655 The -B option adds `*~' and `.*~' to this list. */
657 struct ignore_pattern
659 const char *pattern;
660 struct ignore_pattern *next;
663 static struct ignore_pattern *ignore_patterns;
665 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
666 variable itself to be ignored. */
667 static struct ignore_pattern *hide_patterns;
669 /* True means output nongraphic chars in file names as `?'.
670 (-q, --hide-control-chars)
671 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
672 independent. The algorithm is: first, obey the quoting style to get a
673 string representing the file name; then, if qmark_funny_chars is set,
674 replace all nonprintable chars in that string with `?'. It's necessary
675 to replace nonprintable chars even in quoted strings, because we don't
676 want to mess up the terminal if control chars get sent to it, and some
677 quoting methods pass through control chars as-is. */
678 static bool qmark_funny_chars;
680 /* Quoting options for file and dir name output. */
682 static struct quoting_options *filename_quoting_options;
683 static struct quoting_options *dirname_quoting_options;
685 /* The number of chars per hardware tab stop. Setting this to zero
686 inhibits the use of TAB characters for separating columns. -T */
687 static size_t tabsize;
689 /* True means print each directory name before listing it. */
691 static bool print_dir_name;
693 /* The line length to use for breaking lines in many-per-line format.
694 Can be set with -w. */
696 static size_t line_length;
698 /* If true, the file listing format requires that stat be called on
699 each file. */
701 static bool format_needs_stat;
703 /* Similar to `format_needs_stat', but set if only the file type is
704 needed. */
706 static bool format_needs_type;
708 /* An arbitrary limit on the number of bytes in a printed time stamp.
709 This is set to a relatively small value to avoid the need to worry
710 about denial-of-service attacks on servers that run "ls" on behalf
711 of remote clients. 1000 bytes should be enough for any practical
712 time stamp format. */
714 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
716 /* strftime formats for non-recent and recent files, respectively, in
717 -l output. */
719 static char const *long_time_format[2] =
721 /* strftime format for non-recent files (older than 6 months), in
722 -l output. This should contain the year, month and day (at
723 least), in an order that is understood by people in your
724 locale's territory. Please try to keep the number of used
725 screen columns small, because many people work in windows with
726 only 80 columns. But make this as wide as the other string
727 below, for recent files. */
728 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
729 so be wary of using variable width fields from the locale.
730 Note %b is handled specially by ls and aligned correctly.
731 Note also that specifying a width as in %5b is erroneous as strftime
732 will count bytes rather than characters in multibyte locales. */
733 N_("%b %e %Y"),
734 /* strftime format for recent files (younger than 6 months), in -l
735 output. This should contain the month, day and time (at
736 least), in an order that is understood by people in your
737 locale's territory. Please try to keep the number of used
738 screen columns small, because many people work in windows with
739 only 80 columns. But make this as wide as the other string
740 above, for non-recent files. */
741 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
742 so be wary of using variable width fields from the locale.
743 Note %b is handled specially by ls and aligned correctly.
744 Note also that specifying a width as in %5b is erroneous as strftime
745 will count bytes rather than characters in multibyte locales. */
746 N_("%b %e %H:%M")
749 /* The set of signals that are caught. */
751 static sigset_t caught_signals;
753 /* If nonzero, the value of the pending fatal signal. */
755 static sig_atomic_t volatile interrupt_signal;
757 /* A count of the number of pending stop signals that have been received. */
759 static sig_atomic_t volatile stop_signal_count;
761 /* Desired exit status. */
763 static int exit_status;
765 /* Exit statuses. */
766 enum
768 /* "ls" had a minor problem. E.g., while processing a directory,
769 ls obtained the name of an entry via readdir, yet was later
770 unable to stat that name. This happens when listing a directory
771 in which entries are actively being removed or renamed. */
772 LS_MINOR_PROBLEM = 1,
774 /* "ls" had more serious trouble (e.g., memory exhausted, invalid
775 option or failure to stat a command line argument. */
776 LS_FAILURE = 2
779 /* For long options that have no equivalent short option, use a
780 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
781 enum
783 AUTHOR_OPTION = CHAR_MAX + 1,
784 BLOCK_SIZE_OPTION,
785 COLOR_OPTION,
786 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
787 FILE_TYPE_INDICATOR_OPTION,
788 FORMAT_OPTION,
789 FULL_TIME_OPTION,
790 GROUP_DIRECTORIES_FIRST_OPTION,
791 HIDE_OPTION,
792 INDICATOR_STYLE_OPTION,
793 QUOTING_STYLE_OPTION,
794 SHOW_CONTROL_CHARS_OPTION,
795 SI_OPTION,
796 SORT_OPTION,
797 TIME_OPTION,
798 TIME_STYLE_OPTION
801 static struct option const long_options[] =
803 {"all", no_argument, NULL, 'a'},
804 {"escape", no_argument, NULL, 'b'},
805 {"directory", no_argument, NULL, 'd'},
806 {"dired", no_argument, NULL, 'D'},
807 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
808 {"group-directories-first", no_argument, NULL,
809 GROUP_DIRECTORIES_FIRST_OPTION},
810 {"human-readable", no_argument, NULL, 'h'},
811 {"inode", no_argument, NULL, 'i'},
812 {"numeric-uid-gid", no_argument, NULL, 'n'},
813 {"no-group", no_argument, NULL, 'G'},
814 {"hide-control-chars", no_argument, NULL, 'q'},
815 {"reverse", no_argument, NULL, 'r'},
816 {"size", no_argument, NULL, 's'},
817 {"width", required_argument, NULL, 'w'},
818 {"almost-all", no_argument, NULL, 'A'},
819 {"ignore-backups", no_argument, NULL, 'B'},
820 {"classify", no_argument, NULL, 'F'},
821 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
822 {"si", no_argument, NULL, SI_OPTION},
823 {"dereference-command-line", no_argument, NULL, 'H'},
824 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
825 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
826 {"hide", required_argument, NULL, HIDE_OPTION},
827 {"ignore", required_argument, NULL, 'I'},
828 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
829 {"dereference", no_argument, NULL, 'L'},
830 {"literal", no_argument, NULL, 'N'},
831 {"quote-name", no_argument, NULL, 'Q'},
832 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
833 {"recursive", no_argument, NULL, 'R'},
834 {"format", required_argument, NULL, FORMAT_OPTION},
835 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
836 {"sort", required_argument, NULL, SORT_OPTION},
837 {"tabsize", required_argument, NULL, 'T'},
838 {"time", required_argument, NULL, TIME_OPTION},
839 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
840 {"color", optional_argument, NULL, COLOR_OPTION},
841 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
842 {"context", no_argument, 0, 'Z'},
843 {"author", no_argument, NULL, AUTHOR_OPTION},
844 {GETOPT_HELP_OPTION_DECL},
845 {GETOPT_VERSION_OPTION_DECL},
846 {NULL, 0, NULL, 0}
849 static char const *const format_args[] =
851 "verbose", "long", "commas", "horizontal", "across",
852 "vertical", "single-column", NULL
854 static enum format const format_types[] =
856 long_format, long_format, with_commas, horizontal, horizontal,
857 many_per_line, one_per_line
859 ARGMATCH_VERIFY (format_args, format_types);
861 static char const *const sort_args[] =
863 "none", "time", "size", "extension", "version", NULL
865 static enum sort_type const sort_types[] =
867 sort_none, sort_time, sort_size, sort_extension, sort_version
869 ARGMATCH_VERIFY (sort_args, sort_types);
871 static char const *const time_args[] =
873 "atime", "access", "use", "ctime", "status", NULL
875 static enum time_type const time_types[] =
877 time_atime, time_atime, time_atime, time_ctime, time_ctime
879 ARGMATCH_VERIFY (time_args, time_types);
881 static char const *const color_args[] =
883 /* force and none are for compatibility with another color-ls version */
884 "always", "yes", "force",
885 "never", "no", "none",
886 "auto", "tty", "if-tty", NULL
888 static enum color_type const color_types[] =
890 color_always, color_always, color_always,
891 color_never, color_never, color_never,
892 color_if_tty, color_if_tty, color_if_tty
894 ARGMATCH_VERIFY (color_args, color_types);
896 /* Information about filling a column. */
897 struct column_info
899 bool valid_len;
900 size_t line_len;
901 size_t *col_arr;
904 /* Array with information about column filledness. */
905 static struct column_info *column_info;
907 /* Maximum number of columns ever possible for this display. */
908 static size_t max_idx;
910 /* The minimum width of a column is 3: 1 character for the name and 2
911 for the separating white space. */
912 #define MIN_COLUMN_WIDTH 3
915 /* This zero-based index is used solely with the --dired option.
916 When that option is in effect, this counter is incremented for each
917 byte of output generated by this program so that the beginning
918 and ending indices (in that output) of every file name can be recorded
919 and later output themselves. */
920 static size_t dired_pos;
922 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
924 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
925 #define DIRED_FPUTS(s, stream, s_len) \
926 do {fputs (s, stream); dired_pos += s_len;} while (0)
928 /* Like DIRED_FPUTS, but for use when S is a literal string. */
929 #define DIRED_FPUTS_LITERAL(s, stream) \
930 do {fputs (s, stream); dired_pos += sizeof (s) - 1;} while (0)
932 #define DIRED_INDENT() \
933 do \
935 if (dired) \
936 DIRED_FPUTS_LITERAL (" ", stdout); \
938 while (0)
940 /* With --dired, store pairs of beginning and ending indices of filenames. */
941 static struct obstack dired_obstack;
943 /* With --dired, store pairs of beginning and ending indices of any
944 directory names that appear as headers (just before `total' line)
945 for lists of directory entries. Such directory names are seen when
946 listing hierarchies using -R and when a directory is listed with at
947 least one other command line argument. */
948 static struct obstack subdired_obstack;
950 /* Save the current index on the specified obstack, OBS. */
951 #define PUSH_CURRENT_DIRED_POS(obs) \
952 do \
954 if (dired) \
955 obstack_grow (obs, &dired_pos, sizeof (dired_pos)); \
957 while (0)
959 /* With -R, this stack is used to help detect directory cycles.
960 The device/inode pairs on this stack mirror the pairs in the
961 active_dir_set hash table. */
962 static struct obstack dev_ino_obstack;
964 /* Push a pair onto the device/inode stack. */
965 #define DEV_INO_PUSH(Dev, Ino) \
966 do \
968 struct dev_ino *di; \
969 obstack_blank (&dev_ino_obstack, sizeof (struct dev_ino)); \
970 di = -1 + (struct dev_ino *) obstack_next_free (&dev_ino_obstack); \
971 di->st_dev = (Dev); \
972 di->st_ino = (Ino); \
974 while (0)
976 /* Pop a dev/ino struct off the global dev_ino_obstack
977 and return that struct. */
978 static struct dev_ino
979 dev_ino_pop (void)
981 assert (sizeof (struct dev_ino) <= obstack_object_size (&dev_ino_obstack));
982 obstack_blank (&dev_ino_obstack, -(int) (sizeof (struct dev_ino)));
983 return *(struct dev_ino *) obstack_next_free (&dev_ino_obstack);
986 /* Note the use commented out below:
987 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
988 do \
990 struct stat sb; \
991 assert (Name); \
992 assert (0 <= stat (Name, &sb)); \
993 assert (sb.st_dev == Di.st_dev); \
994 assert (sb.st_ino == Di.st_ino); \
996 while (0)
999 /* Write to standard output PREFIX, followed by the quoting style and
1000 a space-separated list of the integers stored in OS all on one line. */
1002 static void
1003 dired_dump_obstack (const char *prefix, struct obstack *os)
1005 size_t n_pos;
1007 n_pos = obstack_object_size (os) / sizeof (dired_pos);
1008 if (n_pos > 0)
1010 size_t i;
1011 size_t *pos;
1013 pos = (size_t *) obstack_finish (os);
1014 fputs (prefix, stdout);
1015 for (i = 0; i < n_pos; i++)
1016 printf (" %lu", (unsigned long int) pos[i]);
1017 putchar ('\n');
1021 /* Read the abbreviated month names from the locale, to align them
1022 and to determine the max width of the field and to truncate names
1023 greater than our max allowed.
1024 Note even though this handles multibyte locales correctly
1025 it's not restricted to them as single byte locales can have
1026 variable width abbreviated months and also precomputing/caching
1027 the names was seen to increase the performance of ls significantly. */
1029 /* max number of display cells to use */
1030 enum { MAX_MON_WIDTH = 5 };
1031 /* In the unlikely event that the abmon[] storage is not big enough
1032 an error message will be displayed, and we revert to using
1033 unmodified abbreviated month names from the locale database. */
1034 static char abmon[12][MAX_MON_WIDTH * 2 * MB_LEN_MAX + 1];
1035 /* minimum width needed to align %b, 0 => don't use precomputed values. */
1036 static size_t required_mon_width;
1038 static size_t
1039 abmon_init (void)
1041 #ifdef HAVE_NL_LANGINFO
1042 required_mon_width = MAX_MON_WIDTH;
1043 size_t curr_max_width;
1046 curr_max_width = required_mon_width;
1047 required_mon_width = 0;
1048 for (int i = 0; i < 12; i++)
1050 size_t width = curr_max_width;
1052 size_t req = mbsalign (nl_langinfo (ABMON_1 + i),
1053 abmon[i], sizeof (abmon[i]),
1054 &width, MBS_ALIGN_LEFT, 0);
1056 if (req == (size_t) -1 || req >= sizeof (abmon[i]))
1058 required_mon_width = 0; /* ignore precomputed strings. */
1059 return required_mon_width;
1062 required_mon_width = MAX (required_mon_width, width);
1065 while (curr_max_width > required_mon_width);
1066 #endif
1068 return required_mon_width;
1071 static size_t
1072 dev_ino_hash (void const *x, size_t table_size)
1074 struct dev_ino const *p = x;
1075 return (uintmax_t) p->st_ino % table_size;
1078 static bool
1079 dev_ino_compare (void const *x, void const *y)
1081 struct dev_ino const *a = x;
1082 struct dev_ino const *b = y;
1083 return SAME_INODE (*a, *b) ? true : false;
1086 static void
1087 dev_ino_free (void *x)
1089 free (x);
1092 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
1093 active directories. Return true if there is already a matching
1094 entry in the table. */
1096 static bool
1097 visit_dir (dev_t dev, ino_t ino)
1099 struct dev_ino *ent;
1100 struct dev_ino *ent_from_table;
1101 bool found_match;
1103 ent = xmalloc (sizeof *ent);
1104 ent->st_ino = ino;
1105 ent->st_dev = dev;
1107 /* Attempt to insert this entry into the table. */
1108 ent_from_table = hash_insert (active_dir_set, ent);
1110 if (ent_from_table == NULL)
1112 /* Insertion failed due to lack of memory. */
1113 xalloc_die ();
1116 found_match = (ent_from_table != ent);
1118 if (found_match)
1120 /* ent was not inserted, so free it. */
1121 free (ent);
1124 return found_match;
1127 static void
1128 free_pending_ent (struct pending *p)
1130 free (p->name);
1131 free (p->realname);
1132 free (p);
1135 static bool
1136 is_colored (enum indicator_no type)
1138 size_t len = color_indicator[type].len;
1139 char const *s = color_indicator[type].string;
1140 return ! (len == 0
1141 || (len == 1 && STRNCMP_LIT (s, "0") == 0)
1142 || (len == 2 && STRNCMP_LIT (s, "00") == 0));
1145 static void
1146 restore_default_color (void)
1148 put_indicator (&color_indicator[C_LEFT]);
1149 put_indicator (&color_indicator[C_RIGHT]);
1152 static void
1153 set_normal_color (void)
1155 if (print_with_color && is_colored (C_NORM))
1157 put_indicator (&color_indicator[C_LEFT]);
1158 put_indicator (&color_indicator[C_NORM]);
1159 put_indicator (&color_indicator[C_RIGHT]);
1163 /* An ordinary signal was received; arrange for the program to exit. */
1165 static void
1166 sighandler (int sig)
1168 if (! SA_NOCLDSTOP)
1169 signal (sig, SIG_IGN);
1170 if (! interrupt_signal)
1171 interrupt_signal = sig;
1174 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1176 static void
1177 stophandler (int sig)
1179 if (! SA_NOCLDSTOP)
1180 signal (sig, stophandler);
1181 if (! interrupt_signal)
1182 stop_signal_count++;
1185 /* Process any pending signals. If signals are caught, this function
1186 should be called periodically. Ideally there should never be an
1187 unbounded amount of time when signals are not being processed.
1188 Signal handling can restore the default colors, so callers must
1189 immediately change colors after invoking this function. */
1191 static void
1192 process_signals (void)
1194 while (interrupt_signal || stop_signal_count)
1196 int sig;
1197 int stops;
1198 sigset_t oldset;
1200 if (used_color)
1201 restore_default_color ();
1202 fflush (stdout);
1204 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1206 /* Reload interrupt_signal and stop_signal_count, in case a new
1207 signal was handled before sigprocmask took effect. */
1208 sig = interrupt_signal;
1209 stops = stop_signal_count;
1211 /* SIGTSTP is special, since the application can receive that signal
1212 more than once. In this case, don't set the signal handler to the
1213 default. Instead, just raise the uncatchable SIGSTOP. */
1214 if (stops)
1216 stop_signal_count = stops - 1;
1217 sig = SIGSTOP;
1219 else
1220 signal (sig, SIG_DFL);
1222 /* Exit or suspend the program. */
1223 raise (sig);
1224 sigprocmask (SIG_SETMASK, &oldset, NULL);
1226 /* If execution reaches here, then the program has been
1227 continued (after being suspended). */
1232 main (int argc, char **argv)
1234 int i;
1235 struct pending *thispend;
1236 int n_files;
1238 /* The signals that are trapped, and the number of such signals. */
1239 static int const sig[] =
1241 /* This one is handled specially. */
1242 SIGTSTP,
1244 /* The usual suspects. */
1245 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1246 #ifdef SIGPOLL
1247 SIGPOLL,
1248 #endif
1249 #ifdef SIGPROF
1250 SIGPROF,
1251 #endif
1252 #ifdef SIGVTALRM
1253 SIGVTALRM,
1254 #endif
1255 #ifdef SIGXCPU
1256 SIGXCPU,
1257 #endif
1258 #ifdef SIGXFSZ
1259 SIGXFSZ,
1260 #endif
1262 enum { nsigs = ARRAY_CARDINALITY (sig) };
1264 #if ! SA_NOCLDSTOP
1265 bool caught_sig[nsigs];
1266 #endif
1268 initialize_main (&argc, &argv);
1269 set_program_name (argv[0]);
1270 setlocale (LC_ALL, "");
1271 bindtextdomain (PACKAGE, LOCALEDIR);
1272 textdomain (PACKAGE);
1274 initialize_exit_failure (LS_FAILURE);
1275 atexit (close_stdout);
1277 assert (ARRAY_CARDINALITY (color_indicator) + 1
1278 == ARRAY_CARDINALITY (indicator_name));
1280 exit_status = EXIT_SUCCESS;
1281 print_dir_name = true;
1282 pending_dirs = NULL;
1284 current_time.tv_sec = TYPE_MINIMUM (time_t);
1285 current_time.tv_nsec = -1;
1287 i = decode_switches (argc, argv);
1289 if (print_with_color)
1290 parse_ls_color ();
1292 /* Test print_with_color again, because the call to parse_ls_color
1293 may have just reset it -- e.g., if LS_COLORS is invalid. */
1294 if (print_with_color)
1296 /* Avoid following symbolic links when possible. */
1297 if (is_colored (C_ORPHAN)
1298 || (is_colored (C_EXEC) && color_symlink_as_referent)
1299 || (is_colored (C_MISSING) && format == long_format))
1300 check_symlink_color = true;
1302 /* If the standard output is a controlling terminal, watch out
1303 for signals, so that the colors can be restored to the
1304 default state if "ls" is suspended or interrupted. */
1306 if (0 <= tcgetpgrp (STDOUT_FILENO))
1308 int j;
1309 #if SA_NOCLDSTOP
1310 struct sigaction act;
1312 sigemptyset (&caught_signals);
1313 for (j = 0; j < nsigs; j++)
1315 sigaction (sig[j], NULL, &act);
1316 if (act.sa_handler != SIG_IGN)
1317 sigaddset (&caught_signals, sig[j]);
1320 act.sa_mask = caught_signals;
1321 act.sa_flags = SA_RESTART;
1323 for (j = 0; j < nsigs; j++)
1324 if (sigismember (&caught_signals, sig[j]))
1326 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1327 sigaction (sig[j], &act, NULL);
1329 #else
1330 for (j = 0; j < nsigs; j++)
1332 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1333 if (caught_sig[j])
1335 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1336 siginterrupt (sig[j], 0);
1339 #endif
1343 if (dereference == DEREF_UNDEFINED)
1344 dereference = ((immediate_dirs
1345 || indicator_style == classify
1346 || format == long_format)
1347 ? DEREF_NEVER
1348 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1350 /* When using -R, initialize a data structure we'll use to
1351 detect any directory cycles. */
1352 if (recursive)
1354 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, NULL,
1355 dev_ino_hash,
1356 dev_ino_compare,
1357 dev_ino_free);
1358 if (active_dir_set == NULL)
1359 xalloc_die ();
1361 obstack_init (&dev_ino_obstack);
1364 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1365 || format == long_format
1366 || print_scontext
1367 || print_block_size;
1368 format_needs_type = (! format_needs_stat
1369 && (recursive
1370 || print_with_color
1371 || indicator_style != none
1372 || directories_first));
1374 if (dired)
1376 obstack_init (&dired_obstack);
1377 obstack_init (&subdired_obstack);
1380 cwd_n_alloc = 100;
1381 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1382 cwd_n_used = 0;
1384 clear_files ();
1386 n_files = argc - i;
1388 if (n_files <= 0)
1390 if (immediate_dirs)
1391 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1392 else
1393 queue_directory (".", NULL, true);
1395 else
1397 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1398 while (i < argc);
1400 if (cwd_n_used)
1402 sort_files ();
1403 if (!immediate_dirs)
1404 extract_dirs_from_files (NULL, true);
1405 /* `cwd_n_used' might be zero now. */
1408 /* In the following if/else blocks, it is sufficient to test `pending_dirs'
1409 (and not pending_dirs->name) because there may be no markers in the queue
1410 at this point. A marker may be enqueued when extract_dirs_from_files is
1411 called with a non-empty string or via print_dir. */
1412 if (cwd_n_used)
1414 print_current_files ();
1415 if (pending_dirs)
1416 DIRED_PUTCHAR ('\n');
1418 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1419 print_dir_name = false;
1421 while (pending_dirs)
1423 thispend = pending_dirs;
1424 pending_dirs = pending_dirs->next;
1426 if (LOOP_DETECT)
1428 if (thispend->name == NULL)
1430 /* thispend->name == NULL means this is a marker entry
1431 indicating we've finished processing the directory.
1432 Use its dev/ino numbers to remove the corresponding
1433 entry from the active_dir_set hash table. */
1434 struct dev_ino di = dev_ino_pop ();
1435 struct dev_ino *found = hash_delete (active_dir_set, &di);
1436 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1437 assert (found);
1438 dev_ino_free (found);
1439 free_pending_ent (thispend);
1440 continue;
1444 print_dir (thispend->name, thispend->realname,
1445 thispend->command_line_arg);
1447 free_pending_ent (thispend);
1448 print_dir_name = true;
1451 if (print_with_color)
1453 int j;
1455 if (used_color)
1457 /* Skip the restore when it would be a no-op, i.e.,
1458 when left is "\033[" and right is "m". */
1459 if (!(color_indicator[C_LEFT].len == 2
1460 && memcmp (color_indicator[C_LEFT].string, "\033[", 2) == 0
1461 && color_indicator[C_RIGHT].len == 1
1462 && color_indicator[C_RIGHT].string[0] == 'm'))
1463 restore_default_color ();
1465 fflush (stdout);
1467 /* Restore the default signal handling. */
1468 #if SA_NOCLDSTOP
1469 for (j = 0; j < nsigs; j++)
1470 if (sigismember (&caught_signals, sig[j]))
1471 signal (sig[j], SIG_DFL);
1472 #else
1473 for (j = 0; j < nsigs; j++)
1474 if (caught_sig[j])
1475 signal (sig[j], SIG_DFL);
1476 #endif
1478 /* Act on any signals that arrived before the default was restored.
1479 This can process signals out of order, but there doesn't seem to
1480 be an easy way to do them in order, and the order isn't that
1481 important anyway. */
1482 for (j = stop_signal_count; j; j--)
1483 raise (SIGSTOP);
1484 j = interrupt_signal;
1485 if (j)
1486 raise (j);
1489 if (dired)
1491 /* No need to free these since we're about to exit. */
1492 dired_dump_obstack ("//DIRED//", &dired_obstack);
1493 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1494 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1495 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1498 if (LOOP_DETECT)
1500 assert (hash_get_n_entries (active_dir_set) == 0);
1501 hash_free (active_dir_set);
1504 exit (exit_status);
1507 /* Set all the option flags according to the switches specified.
1508 Return the index of the first non-option argument. */
1510 static int
1511 decode_switches (int argc, char **argv)
1513 char *time_style_option = NULL;
1515 /* Record whether there is an option specifying sort type. */
1516 bool sort_type_specified = false;
1518 qmark_funny_chars = false;
1520 /* initialize all switches to default settings */
1522 switch (ls_mode)
1524 case LS_MULTI_COL:
1525 /* This is for the `dir' program. */
1526 format = many_per_line;
1527 set_quoting_style (NULL, escape_quoting_style);
1528 break;
1530 case LS_LONG_FORMAT:
1531 /* This is for the `vdir' program. */
1532 format = long_format;
1533 set_quoting_style (NULL, escape_quoting_style);
1534 break;
1536 case LS_LS:
1537 /* This is for the `ls' program. */
1538 if (isatty (STDOUT_FILENO))
1540 format = many_per_line;
1541 /* See description of qmark_funny_chars, above. */
1542 qmark_funny_chars = true;
1544 else
1546 format = one_per_line;
1547 qmark_funny_chars = false;
1549 break;
1551 default:
1552 abort ();
1555 time_type = time_mtime;
1556 sort_type = sort_name;
1557 sort_reverse = false;
1558 numeric_ids = false;
1559 print_block_size = false;
1560 indicator_style = none;
1561 print_inode = false;
1562 dereference = DEREF_UNDEFINED;
1563 recursive = false;
1564 immediate_dirs = false;
1565 ignore_mode = IGNORE_DEFAULT;
1566 ignore_patterns = NULL;
1567 hide_patterns = NULL;
1568 print_scontext = false;
1570 /* FIXME: put this in a function. */
1572 char const *q_style = getenv ("QUOTING_STYLE");
1573 if (q_style)
1575 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
1576 if (0 <= i)
1577 set_quoting_style (NULL, quoting_style_vals[i]);
1578 else
1579 error (0, 0,
1580 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
1581 quotearg (q_style));
1586 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1587 human_options (ls_block_size,
1588 &human_output_opts, &output_block_size);
1589 if (ls_block_size || getenv ("BLOCK_SIZE"))
1590 file_output_block_size = output_block_size;
1593 line_length = 80;
1595 char const *p = getenv ("COLUMNS");
1596 if (p && *p)
1598 unsigned long int tmp_ulong;
1599 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1600 && 0 < tmp_ulong && tmp_ulong <= SIZE_MAX)
1602 line_length = tmp_ulong;
1604 else
1606 error (0, 0,
1607 _("ignoring invalid width in environment variable COLUMNS: %s"),
1608 quotearg (p));
1613 #ifdef TIOCGWINSZ
1615 struct winsize ws;
1617 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1618 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1619 line_length = ws.ws_col;
1621 #endif
1624 char const *p = getenv ("TABSIZE");
1625 tabsize = 8;
1626 if (p)
1628 unsigned long int tmp_ulong;
1629 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1630 && tmp_ulong <= SIZE_MAX)
1632 tabsize = tmp_ulong;
1634 else
1636 error (0, 0,
1637 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1638 quotearg (p));
1643 while (true)
1645 int oi = -1;
1646 int c = getopt_long (argc, argv,
1647 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1648 long_options, &oi);
1649 if (c == -1)
1650 break;
1652 switch (c)
1654 case 'a':
1655 ignore_mode = IGNORE_MINIMAL;
1656 break;
1658 case 'b':
1659 set_quoting_style (NULL, escape_quoting_style);
1660 break;
1662 case 'c':
1663 time_type = time_ctime;
1664 break;
1666 case 'd':
1667 immediate_dirs = true;
1668 break;
1670 case 'f':
1671 /* Same as enabling -a -U and disabling -l -s. */
1672 ignore_mode = IGNORE_MINIMAL;
1673 sort_type = sort_none;
1674 sort_type_specified = true;
1675 /* disable -l */
1676 if (format == long_format)
1677 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1678 print_block_size = false; /* disable -s */
1679 print_with_color = false; /* disable --color */
1680 break;
1682 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1683 indicator_style = file_type;
1684 break;
1686 case 'g':
1687 format = long_format;
1688 print_owner = false;
1689 break;
1691 case 'h':
1692 human_output_opts = human_autoscale | human_SI | human_base_1024;
1693 file_output_block_size = output_block_size = 1;
1694 break;
1696 case 'i':
1697 print_inode = true;
1698 break;
1700 case 'k':
1701 human_output_opts = 0;
1702 file_output_block_size = output_block_size = 1024;
1703 break;
1705 case 'l':
1706 format = long_format;
1707 break;
1709 case 'm':
1710 format = with_commas;
1711 break;
1713 case 'n':
1714 numeric_ids = true;
1715 format = long_format;
1716 break;
1718 case 'o': /* Just like -l, but don't display group info. */
1719 format = long_format;
1720 print_group = false;
1721 break;
1723 case 'p':
1724 indicator_style = slash;
1725 break;
1727 case 'q':
1728 qmark_funny_chars = true;
1729 break;
1731 case 'r':
1732 sort_reverse = true;
1733 break;
1735 case 's':
1736 print_block_size = true;
1737 break;
1739 case 't':
1740 sort_type = sort_time;
1741 sort_type_specified = true;
1742 break;
1744 case 'u':
1745 time_type = time_atime;
1746 break;
1748 case 'v':
1749 sort_type = sort_version;
1750 sort_type_specified = true;
1751 break;
1753 case 'w':
1755 unsigned long int tmp_ulong;
1756 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1757 || ! (0 < tmp_ulong && tmp_ulong <= SIZE_MAX))
1758 error (LS_FAILURE, 0, _("invalid line width: %s"),
1759 quotearg (optarg));
1760 line_length = tmp_ulong;
1761 break;
1764 case 'x':
1765 format = horizontal;
1766 break;
1768 case 'A':
1769 if (ignore_mode == IGNORE_DEFAULT)
1770 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1771 break;
1773 case 'B':
1774 add_ignore_pattern ("*~");
1775 add_ignore_pattern (".*~");
1776 break;
1778 case 'C':
1779 format = many_per_line;
1780 break;
1782 case 'D':
1783 dired = true;
1784 break;
1786 case 'F':
1787 indicator_style = classify;
1788 break;
1790 case 'G': /* inhibit display of group info */
1791 print_group = false;
1792 break;
1794 case 'H':
1795 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1796 break;
1798 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1799 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1800 break;
1802 case 'I':
1803 add_ignore_pattern (optarg);
1804 break;
1806 case 'L':
1807 dereference = DEREF_ALWAYS;
1808 break;
1810 case 'N':
1811 set_quoting_style (NULL, literal_quoting_style);
1812 break;
1814 case 'Q':
1815 set_quoting_style (NULL, c_quoting_style);
1816 break;
1818 case 'R':
1819 recursive = true;
1820 break;
1822 case 'S':
1823 sort_type = sort_size;
1824 sort_type_specified = true;
1825 break;
1827 case 'T':
1829 unsigned long int tmp_ulong;
1830 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1831 || SIZE_MAX < tmp_ulong)
1832 error (LS_FAILURE, 0, _("invalid tab size: %s"),
1833 quotearg (optarg));
1834 tabsize = tmp_ulong;
1835 break;
1838 case 'U':
1839 sort_type = sort_none;
1840 sort_type_specified = true;
1841 break;
1843 case 'X':
1844 sort_type = sort_extension;
1845 sort_type_specified = true;
1846 break;
1848 case '1':
1849 /* -1 has no effect after -l. */
1850 if (format != long_format)
1851 format = one_per_line;
1852 break;
1854 case AUTHOR_OPTION:
1855 print_author = true;
1856 break;
1858 case HIDE_OPTION:
1860 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1861 hide->pattern = optarg;
1862 hide->next = hide_patterns;
1863 hide_patterns = hide;
1865 break;
1867 case SORT_OPTION:
1868 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1869 sort_type_specified = true;
1870 break;
1872 case GROUP_DIRECTORIES_FIRST_OPTION:
1873 directories_first = true;
1874 break;
1876 case TIME_OPTION:
1877 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1878 break;
1880 case FORMAT_OPTION:
1881 format = XARGMATCH ("--format", optarg, format_args, format_types);
1882 break;
1884 case FULL_TIME_OPTION:
1885 format = long_format;
1886 time_style_option = bad_cast ("full-iso");
1887 break;
1889 case COLOR_OPTION:
1891 int i;
1892 if (optarg)
1893 i = XARGMATCH ("--color", optarg, color_args, color_types);
1894 else
1895 /* Using --color with no argument is equivalent to using
1896 --color=always. */
1897 i = color_always;
1899 print_with_color = (i == color_always
1900 || (i == color_if_tty
1901 && isatty (STDOUT_FILENO)));
1903 if (print_with_color)
1905 /* Don't use TAB characters in output. Some terminal
1906 emulators can't handle the combination of tabs and
1907 color codes on the same line. */
1908 tabsize = 0;
1910 break;
1913 case INDICATOR_STYLE_OPTION:
1914 indicator_style = XARGMATCH ("--indicator-style", optarg,
1915 indicator_style_args,
1916 indicator_style_types);
1917 break;
1919 case QUOTING_STYLE_OPTION:
1920 set_quoting_style (NULL,
1921 XARGMATCH ("--quoting-style", optarg,
1922 quoting_style_args,
1923 quoting_style_vals));
1924 break;
1926 case TIME_STYLE_OPTION:
1927 time_style_option = optarg;
1928 break;
1930 case SHOW_CONTROL_CHARS_OPTION:
1931 qmark_funny_chars = false;
1932 break;
1934 case BLOCK_SIZE_OPTION:
1936 enum strtol_error e = human_options (optarg, &human_output_opts,
1937 &output_block_size);
1938 if (e != LONGINT_OK)
1939 xstrtol_fatal (e, oi, 0, long_options, optarg);
1940 file_output_block_size = output_block_size;
1942 break;
1944 case SI_OPTION:
1945 human_output_opts = human_autoscale | human_SI;
1946 file_output_block_size = output_block_size = 1;
1947 break;
1949 case 'Z':
1950 print_scontext = true;
1951 break;
1953 case_GETOPT_HELP_CHAR;
1955 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1957 default:
1958 usage (LS_FAILURE);
1962 max_idx = MAX (1, line_length / MIN_COLUMN_WIDTH);
1964 filename_quoting_options = clone_quoting_options (NULL);
1965 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1966 set_char_quoting (filename_quoting_options, ' ', 1);
1967 if (file_type <= indicator_style)
1969 char const *p;
1970 for (p = "*=>@|" + indicator_style - file_type; *p; p++)
1971 set_char_quoting (filename_quoting_options, *p, 1);
1974 dirname_quoting_options = clone_quoting_options (NULL);
1975 set_char_quoting (dirname_quoting_options, ':', 1);
1977 /* --dired is meaningful only with --format=long (-l).
1978 Otherwise, ignore it. FIXME: warn about this?
1979 Alternatively, make --dired imply --format=long? */
1980 if (dired && format != long_format)
1981 dired = false;
1983 /* If -c or -u is specified and not -l (or any other option that implies -l),
1984 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
1985 The behavior of ls when using either -c or -u but with neither -l nor -t
1986 appears to be unspecified by POSIX. So, with GNU ls, `-u' alone means
1987 sort by atime (this is the one that's not specified by the POSIX spec),
1988 -lu means show atime and sort by name, -lut means show atime and sort
1989 by atime. */
1991 if ((time_type == time_ctime || time_type == time_atime)
1992 && !sort_type_specified && format != long_format)
1994 sort_type = sort_time;
1997 if (format == long_format)
1999 char *style = time_style_option;
2000 static char const posix_prefix[] = "posix-";
2002 if (! style)
2003 if (! (style = getenv ("TIME_STYLE")))
2004 style = bad_cast ("locale");
2006 while (STREQ_LEN (style, posix_prefix, sizeof posix_prefix - 1))
2008 if (! hard_locale (LC_TIME))
2009 return optind;
2010 style += sizeof posix_prefix - 1;
2013 if (*style == '+')
2015 char *p0 = style + 1;
2016 char *p1 = strchr (p0, '\n');
2017 if (! p1)
2018 p1 = p0;
2019 else
2021 if (strchr (p1 + 1, '\n'))
2022 error (LS_FAILURE, 0, _("invalid time style format %s"),
2023 quote (p0));
2024 *p1++ = '\0';
2026 long_time_format[0] = p0;
2027 long_time_format[1] = p1;
2029 else
2030 switch (XARGMATCH ("time style", style,
2031 time_style_args,
2032 time_style_types))
2034 case full_iso_time_style:
2035 long_time_format[0] = long_time_format[1] =
2036 "%Y-%m-%d %H:%M:%S.%N %z";
2037 break;
2039 case long_iso_time_style:
2040 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
2041 break;
2043 case iso_time_style:
2044 long_time_format[0] = "%Y-%m-%d ";
2045 long_time_format[1] = "%m-%d %H:%M";
2046 break;
2048 case locale_time_style:
2049 if (hard_locale (LC_TIME))
2051 int i;
2052 for (i = 0; i < 2; i++)
2053 long_time_format[i] =
2054 dcgettext (NULL, long_time_format[i], LC_TIME);
2057 /* Note we leave %5b etc. alone so user widths/flags are honored. */
2058 if (strstr (long_time_format[0], "%b")
2059 || strstr (long_time_format[1], "%b"))
2060 if (!abmon_init ())
2061 error (0, 0, _("error initializing month strings"));
2064 return optind;
2067 /* Parse a string as part of the LS_COLORS variable; this may involve
2068 decoding all kinds of escape characters. If equals_end is set an
2069 unescaped equal sign ends the string, otherwise only a : or \0
2070 does. Set *OUTPUT_COUNT to the number of bytes output. Return
2071 true if successful.
2073 The resulting string is *not* null-terminated, but may contain
2074 embedded nulls.
2076 Note that both dest and src are char **; on return they point to
2077 the first free byte after the array and the character that ended
2078 the input string, respectively. */
2080 static bool
2081 get_funky_string (char **dest, const char **src, bool equals_end,
2082 size_t *output_count)
2084 char num; /* For numerical codes */
2085 size_t count; /* Something to count with */
2086 enum {
2087 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
2088 } state;
2089 const char *p;
2090 char *q;
2092 p = *src; /* We don't want to double-indirect */
2093 q = *dest; /* the whole darn time. */
2095 count = 0; /* No characters counted in yet. */
2096 num = 0;
2098 state = ST_GND; /* Start in ground state. */
2099 while (state < ST_END)
2101 switch (state)
2103 case ST_GND: /* Ground state (no escapes) */
2104 switch (*p)
2106 case ':':
2107 case '\0':
2108 state = ST_END; /* End of string */
2109 break;
2110 case '\\':
2111 state = ST_BACKSLASH; /* Backslash scape sequence */
2112 ++p;
2113 break;
2114 case '^':
2115 state = ST_CARET; /* Caret escape */
2116 ++p;
2117 break;
2118 case '=':
2119 if (equals_end)
2121 state = ST_END; /* End */
2122 break;
2124 /* else fall through */
2125 default:
2126 *(q++) = *(p++);
2127 ++count;
2128 break;
2130 break;
2132 case ST_BACKSLASH: /* Backslash escaped character */
2133 switch (*p)
2135 case '0':
2136 case '1':
2137 case '2':
2138 case '3':
2139 case '4':
2140 case '5':
2141 case '6':
2142 case '7':
2143 state = ST_OCTAL; /* Octal sequence */
2144 num = *p - '0';
2145 break;
2146 case 'x':
2147 case 'X':
2148 state = ST_HEX; /* Hex sequence */
2149 num = 0;
2150 break;
2151 case 'a': /* Bell */
2152 num = '\a';
2153 break;
2154 case 'b': /* Backspace */
2155 num = '\b';
2156 break;
2157 case 'e': /* Escape */
2158 num = 27;
2159 break;
2160 case 'f': /* Form feed */
2161 num = '\f';
2162 break;
2163 case 'n': /* Newline */
2164 num = '\n';
2165 break;
2166 case 'r': /* Carriage return */
2167 num = '\r';
2168 break;
2169 case 't': /* Tab */
2170 num = '\t';
2171 break;
2172 case 'v': /* Vtab */
2173 num = '\v';
2174 break;
2175 case '?': /* Delete */
2176 num = 127;
2177 break;
2178 case '_': /* Space */
2179 num = ' ';
2180 break;
2181 case '\0': /* End of string */
2182 state = ST_ERROR; /* Error! */
2183 break;
2184 default: /* Escaped character like \ ^ : = */
2185 num = *p;
2186 break;
2188 if (state == ST_BACKSLASH)
2190 *(q++) = num;
2191 ++count;
2192 state = ST_GND;
2194 ++p;
2195 break;
2197 case ST_OCTAL: /* Octal sequence */
2198 if (*p < '0' || *p > '7')
2200 *(q++) = num;
2201 ++count;
2202 state = ST_GND;
2204 else
2205 num = (num << 3) + (*(p++) - '0');
2206 break;
2208 case ST_HEX: /* Hex sequence */
2209 switch (*p)
2211 case '0':
2212 case '1':
2213 case '2':
2214 case '3':
2215 case '4':
2216 case '5':
2217 case '6':
2218 case '7':
2219 case '8':
2220 case '9':
2221 num = (num << 4) + (*(p++) - '0');
2222 break;
2223 case 'a':
2224 case 'b':
2225 case 'c':
2226 case 'd':
2227 case 'e':
2228 case 'f':
2229 num = (num << 4) + (*(p++) - 'a') + 10;
2230 break;
2231 case 'A':
2232 case 'B':
2233 case 'C':
2234 case 'D':
2235 case 'E':
2236 case 'F':
2237 num = (num << 4) + (*(p++) - 'A') + 10;
2238 break;
2239 default:
2240 *(q++) = num;
2241 ++count;
2242 state = ST_GND;
2243 break;
2245 break;
2247 case ST_CARET: /* Caret escape */
2248 state = ST_GND; /* Should be the next state... */
2249 if (*p >= '@' && *p <= '~')
2251 *(q++) = *(p++) & 037;
2252 ++count;
2254 else if (*p == '?')
2256 *(q++) = 127;
2257 ++count;
2259 else
2260 state = ST_ERROR;
2261 break;
2263 default:
2264 abort ();
2268 *dest = q;
2269 *src = p;
2270 *output_count = count;
2272 return state != ST_ERROR;
2275 enum parse_state
2277 PS_START = 1,
2278 PS_2,
2279 PS_3,
2280 PS_4,
2281 PS_DONE,
2282 PS_FAIL
2285 static void
2286 parse_ls_color (void)
2288 const char *p; /* Pointer to character being parsed */
2289 char *buf; /* color_buf buffer pointer */
2290 int ind_no; /* Indicator number */
2291 char label[3]; /* Indicator label */
2292 struct color_ext_type *ext; /* Extension we are working on */
2294 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2295 return;
2297 ext = NULL;
2298 strcpy (label, "??");
2300 /* This is an overly conservative estimate, but any possible
2301 LS_COLORS string will *not* generate a color_buf longer than
2302 itself, so it is a safe way of allocating a buffer in
2303 advance. */
2304 buf = color_buf = xstrdup (p);
2306 enum parse_state state = PS_START;
2307 while (true)
2309 switch (state)
2311 case PS_START: /* First label character */
2312 switch (*p)
2314 case ':':
2315 ++p;
2316 break;
2318 case '*':
2319 /* Allocate new extension block and add to head of
2320 linked list (this way a later definition will
2321 override an earlier one, which can be useful for
2322 having terminal-specific defs override global). */
2324 ext = xmalloc (sizeof *ext);
2325 ext->next = color_ext_list;
2326 color_ext_list = ext;
2328 ++p;
2329 ext->ext.string = buf;
2331 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2332 ? PS_4 : PS_FAIL);
2333 break;
2335 case '\0':
2336 state = PS_DONE; /* Done! */
2337 goto done;
2339 default: /* Assume it is file type label */
2340 label[0] = *(p++);
2341 state = PS_2;
2342 break;
2344 break;
2346 case PS_2: /* Second label character */
2347 if (*p)
2349 label[1] = *(p++);
2350 state = PS_3;
2352 else
2353 state = PS_FAIL; /* Error */
2354 break;
2356 case PS_3: /* Equal sign after indicator label */
2357 state = PS_FAIL; /* Assume failure... */
2358 if (*(p++) == '=')/* It *should* be... */
2360 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2362 if (STREQ (label, indicator_name[ind_no]))
2364 color_indicator[ind_no].string = buf;
2365 state = (get_funky_string (&buf, &p, false,
2366 &color_indicator[ind_no].len)
2367 ? PS_START : PS_FAIL);
2368 break;
2371 if (state == PS_FAIL)
2372 error (0, 0, _("unrecognized prefix: %s"), quotearg (label));
2374 break;
2376 case PS_4: /* Equal sign after *.ext */
2377 if (*(p++) == '=')
2379 ext->seq.string = buf;
2380 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2381 ? PS_START : PS_FAIL);
2383 else
2384 state = PS_FAIL;
2385 break;
2387 case PS_FAIL:
2388 goto done;
2390 default:
2391 abort ();
2394 done:
2396 if (state == PS_FAIL)
2398 struct color_ext_type *e;
2399 struct color_ext_type *e2;
2401 error (0, 0,
2402 _("unparsable value for LS_COLORS environment variable"));
2403 free (color_buf);
2404 for (e = color_ext_list; e != NULL; /* empty */)
2406 e2 = e;
2407 e = e->next;
2408 free (e2);
2410 print_with_color = false;
2413 if (color_indicator[C_LINK].len == 6
2414 && !STRNCMP_LIT (color_indicator[C_LINK].string, "target"))
2415 color_symlink_as_referent = true;
2418 /* Set the exit status to report a failure. If SERIOUS, it is a
2419 serious failure; otherwise, it is merely a minor problem. */
2421 static void
2422 set_exit_status (bool serious)
2424 if (serious)
2425 exit_status = LS_FAILURE;
2426 else if (exit_status == EXIT_SUCCESS)
2427 exit_status = LS_MINOR_PROBLEM;
2430 /* Assuming a failure is serious if SERIOUS, use the printf-style
2431 MESSAGE to report the failure to access a file named FILE. Assume
2432 errno is set appropriately for the failure. */
2434 static void
2435 file_failure (bool serious, char const *message, char const *file)
2437 error (0, errno, message, quotearg_colon (file));
2438 set_exit_status (serious);
2441 /* Request that the directory named NAME have its contents listed later.
2442 If REALNAME is nonzero, it will be used instead of NAME when the
2443 directory name is printed. This allows symbolic links to directories
2444 to be treated as regular directories but still be listed under their
2445 real names. NAME == NULL is used to insert a marker entry for the
2446 directory named in REALNAME.
2447 If NAME is non-NULL, we use its dev/ino information to save
2448 a call to stat -- when doing a recursive (-R) traversal.
2449 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2451 static void
2452 queue_directory (char const *name, char const *realname, bool command_line_arg)
2454 struct pending *new = xmalloc (sizeof *new);
2455 new->realname = realname ? xstrdup (realname) : NULL;
2456 new->name = name ? xstrdup (name) : NULL;
2457 new->command_line_arg = command_line_arg;
2458 new->next = pending_dirs;
2459 pending_dirs = new;
2462 /* Read directory NAME, and list the files in it.
2463 If REALNAME is nonzero, print its name instead of NAME;
2464 this is used for symbolic links to directories.
2465 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2467 static void
2468 print_dir (char const *name, char const *realname, bool command_line_arg)
2470 DIR *dirp;
2471 struct dirent *next;
2472 uintmax_t total_blocks = 0;
2473 static bool first = true;
2475 errno = 0;
2476 dirp = opendir (name);
2477 if (!dirp)
2479 file_failure (command_line_arg, _("cannot open directory %s"), name);
2480 return;
2483 if (LOOP_DETECT)
2485 struct stat dir_stat;
2486 int fd = dirfd (dirp);
2488 /* If dirfd failed, endure the overhead of using stat. */
2489 if ((0 <= fd
2490 ? fstat (fd, &dir_stat)
2491 : stat (name, &dir_stat)) < 0)
2493 file_failure (command_line_arg,
2494 _("cannot determine device and inode of %s"), name);
2495 closedir (dirp);
2496 return;
2499 /* If we've already visited this dev/inode pair, warn that
2500 we've found a loop, and do not process this directory. */
2501 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2503 error (0, 0, _("%s: not listing already-listed directory"),
2504 quotearg_colon (name));
2505 closedir (dirp);
2506 set_exit_status (true);
2507 return;
2510 DEV_INO_PUSH (dir_stat.st_dev, dir_stat.st_ino);
2513 if (recursive || print_dir_name)
2515 if (!first)
2516 DIRED_PUTCHAR ('\n');
2517 first = false;
2518 DIRED_INDENT ();
2519 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2520 dired_pos += quote_name (stdout, realname ? realname : name,
2521 dirname_quoting_options, NULL);
2522 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2523 DIRED_FPUTS_LITERAL (":\n", stdout);
2526 /* Read the directory entries, and insert the subfiles into the `cwd_file'
2527 table. */
2529 clear_files ();
2531 while (1)
2533 /* Set errno to zero so we can distinguish between a readdir failure
2534 and when readdir simply finds that there are no more entries. */
2535 errno = 0;
2536 next = readdir (dirp);
2537 if (next)
2539 if (! file_ignored (next->d_name))
2541 enum filetype type = unknown;
2543 #if HAVE_STRUCT_DIRENT_D_TYPE
2544 switch (next->d_type)
2546 case DT_BLK: type = blockdev; break;
2547 case DT_CHR: type = chardev; break;
2548 case DT_DIR: type = directory; break;
2549 case DT_FIFO: type = fifo; break;
2550 case DT_LNK: type = symbolic_link; break;
2551 case DT_REG: type = normal; break;
2552 case DT_SOCK: type = sock; break;
2553 # ifdef DT_WHT
2554 case DT_WHT: type = whiteout; break;
2555 # endif
2557 #endif
2558 total_blocks += gobble_file (next->d_name, type,
2559 RELIABLE_D_INO (next),
2560 false, name);
2562 /* In this narrow case, print out each name right away, so
2563 ls uses constant memory while processing the entries of
2564 this directory. Useful when there are many (millions)
2565 of entries in a directory. */
2566 if (format == one_per_line && sort_type == sort_none
2567 && !print_block_size && !recursive)
2569 /* We must call sort_files in spite of
2570 "sort_type == sort_none" for its initialization
2571 of the sorted_file vector. */
2572 sort_files ();
2573 print_current_files ();
2574 clear_files ();
2578 else if (errno != 0)
2580 file_failure (command_line_arg, _("reading directory %s"), name);
2581 if (errno != EOVERFLOW)
2582 break;
2584 else
2585 break;
2588 if (closedir (dirp) != 0)
2590 file_failure (command_line_arg, _("closing directory %s"), name);
2591 /* Don't return; print whatever we got. */
2594 /* Sort the directory contents. */
2595 sort_files ();
2597 /* If any member files are subdirectories, perhaps they should have their
2598 contents listed rather than being mentioned here as files. */
2600 if (recursive)
2601 extract_dirs_from_files (name, command_line_arg);
2603 if (format == long_format || print_block_size)
2605 const char *p;
2606 char buf[LONGEST_HUMAN_READABLE + 1];
2608 DIRED_INDENT ();
2609 p = _("total");
2610 DIRED_FPUTS (p, stdout, strlen (p));
2611 DIRED_PUTCHAR (' ');
2612 p = human_readable (total_blocks, buf, human_output_opts,
2613 ST_NBLOCKSIZE, output_block_size);
2614 DIRED_FPUTS (p, stdout, strlen (p));
2615 DIRED_PUTCHAR ('\n');
2618 if (cwd_n_used)
2619 print_current_files ();
2622 /* Add `pattern' to the list of patterns for which files that match are
2623 not listed. */
2625 static void
2626 add_ignore_pattern (const char *pattern)
2628 struct ignore_pattern *ignore;
2630 ignore = xmalloc (sizeof *ignore);
2631 ignore->pattern = pattern;
2632 /* Add it to the head of the linked list. */
2633 ignore->next = ignore_patterns;
2634 ignore_patterns = ignore;
2637 /* Return true if one of the PATTERNS matches FILE. */
2639 static bool
2640 patterns_match (struct ignore_pattern const *patterns, char const *file)
2642 struct ignore_pattern const *p;
2643 for (p = patterns; p; p = p->next)
2644 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2645 return true;
2646 return false;
2649 /* Return true if FILE should be ignored. */
2651 static bool
2652 file_ignored (char const *name)
2654 return ((ignore_mode != IGNORE_MINIMAL
2655 && name[0] == '.'
2656 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2657 || (ignore_mode == IGNORE_DEFAULT
2658 && patterns_match (hide_patterns, name))
2659 || patterns_match (ignore_patterns, name));
2662 /* POSIX requires that a file size be printed without a sign, even
2663 when negative. Assume the typical case where negative sizes are
2664 actually positive values that have wrapped around. */
2666 static uintmax_t
2667 unsigned_file_size (off_t size)
2669 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2672 #ifdef HAVE_CAP
2673 /* Return true if NAME has a capability (see linux/capability.h) */
2674 static bool
2675 has_capability (char const *name)
2677 char *result;
2678 bool has_cap;
2680 cap_t cap_d = cap_get_file (name);
2681 if (cap_d == NULL)
2682 return false;
2684 result = cap_to_text (cap_d, NULL);
2685 cap_free (cap_d);
2686 if (!result)
2687 return false;
2689 /* check if human-readable capability string is empty */
2690 has_cap = !!*result;
2692 cap_free (result);
2693 return has_cap;
2695 #else
2696 static bool
2697 has_capability (char const *name ATTRIBUTE_UNUSED)
2699 return false;
2701 #endif
2703 /* Enter and remove entries in the table `cwd_file'. */
2705 /* Empty the table of files. */
2707 static void
2708 clear_files (void)
2710 size_t i;
2712 for (i = 0; i < cwd_n_used; i++)
2714 struct fileinfo *f = sorted_file[i];
2715 free (f->name);
2716 free (f->linkname);
2717 if (f->scontext != UNKNOWN_SECURITY_CONTEXT)
2718 freecon (f->scontext);
2721 cwd_n_used = 0;
2722 any_has_acl = false;
2723 inode_number_width = 0;
2724 block_size_width = 0;
2725 nlink_width = 0;
2726 owner_width = 0;
2727 group_width = 0;
2728 author_width = 0;
2729 scontext_width = 0;
2730 major_device_number_width = 0;
2731 minor_device_number_width = 0;
2732 file_size_width = 0;
2735 /* Add a file to the current table of files.
2736 Verify that the file exists, and print an error message if it does not.
2737 Return the number of blocks that the file occupies. */
2739 static uintmax_t
2740 gobble_file (char const *name, enum filetype type, ino_t inode,
2741 bool command_line_arg, char const *dirname)
2743 uintmax_t blocks = 0;
2744 struct fileinfo *f;
2746 /* An inode value prior to gobble_file necessarily came from readdir,
2747 which is not used for command line arguments. */
2748 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2750 if (cwd_n_used == cwd_n_alloc)
2752 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
2753 cwd_n_alloc *= 2;
2756 f = &cwd_file[cwd_n_used];
2757 memset (f, '\0', sizeof *f);
2758 f->stat.st_ino = inode;
2759 f->filetype = type;
2761 if (command_line_arg
2762 || format_needs_stat
2763 /* When coloring a directory (we may know the type from
2764 direct.d_type), we have to stat it in order to indicate
2765 sticky and/or other-writable attributes. */
2766 || (type == directory && print_with_color
2767 && (is_colored (C_OTHER_WRITABLE)
2768 || is_colored (C_STICKY)
2769 || is_colored (C_STICKY_OTHER_WRITABLE)))
2770 /* When dereferencing symlinks, the inode and type must come from
2771 stat, but readdir provides the inode and type of lstat. */
2772 || ((print_inode || format_needs_type)
2773 && (type == symbolic_link || type == unknown)
2774 && (dereference == DEREF_ALWAYS
2775 || (command_line_arg && dereference != DEREF_NEVER)
2776 || color_symlink_as_referent || check_symlink_color))
2777 /* Command line dereferences are already taken care of by the above
2778 assertion that the inode number is not yet known. */
2779 || (print_inode && inode == NOT_AN_INODE_NUMBER)
2780 || (format_needs_type
2781 && (type == unknown || command_line_arg
2782 /* --indicator-style=classify (aka -F)
2783 requires that we stat each regular file
2784 to see if it's executable. */
2785 || (type == normal && (indicator_style == classify
2786 /* This is so that --color ends up
2787 highlighting files with these mode
2788 bits set even when options like -F are
2789 not specified. Note we do a redundant
2790 stat in the very unlikely case where
2791 C_CAP is set but not the others. */
2792 || (print_with_color
2793 && (is_colored (C_EXEC)
2794 || is_colored (C_SETUID)
2795 || is_colored (C_SETGID)
2796 || is_colored (C_CAP)))
2797 )))))
2800 /* Absolute name of this file. */
2801 char *absolute_name;
2802 bool do_deref;
2803 int err;
2805 if (name[0] == '/' || dirname[0] == 0)
2806 absolute_name = (char *) name;
2807 else
2809 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
2810 attach (absolute_name, dirname, name);
2813 switch (dereference)
2815 case DEREF_ALWAYS:
2816 err = stat (absolute_name, &f->stat);
2817 do_deref = true;
2818 break;
2820 case DEREF_COMMAND_LINE_ARGUMENTS:
2821 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
2822 if (command_line_arg)
2824 bool need_lstat;
2825 err = stat (absolute_name, &f->stat);
2826 do_deref = true;
2828 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
2829 break;
2831 need_lstat = (err < 0
2832 ? errno == ENOENT
2833 : ! S_ISDIR (f->stat.st_mode));
2834 if (!need_lstat)
2835 break;
2837 /* stat failed because of ENOENT, maybe indicating a dangling
2838 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
2839 directory, and --dereference-command-line-symlink-to-dir is
2840 in effect. Fall through so that we call lstat instead. */
2843 default: /* DEREF_NEVER */
2844 err = lstat (absolute_name, &f->stat);
2845 do_deref = false;
2846 break;
2849 if (err != 0)
2851 /* Failure to stat a command line argument leads to
2852 an exit status of 2. For other files, stat failure
2853 provokes an exit status of 1. */
2854 file_failure (command_line_arg,
2855 _("cannot access %s"), absolute_name);
2856 if (command_line_arg)
2857 return 0;
2859 f->name = xstrdup (name);
2860 cwd_n_used++;
2862 return 0;
2865 f->stat_ok = true;
2867 /* Note has_capability() adds around 30% runtime to `ls --color` */
2868 if ((type == normal || S_ISREG (f->stat.st_mode))
2869 && print_with_color && is_colored (C_CAP))
2870 f->has_capability = has_capability (absolute_name);
2872 if (format == long_format || print_scontext)
2874 bool have_selinux = false;
2875 bool have_acl = false;
2876 int attr_len = (do_deref
2877 ? getfilecon (absolute_name, &f->scontext)
2878 : lgetfilecon (absolute_name, &f->scontext));
2879 err = (attr_len < 0);
2881 if (err == 0)
2882 have_selinux = ! STREQ ("unlabeled", f->scontext);
2883 else
2885 f->scontext = UNKNOWN_SECURITY_CONTEXT;
2887 /* When requesting security context information, don't make
2888 ls fail just because the file (even a command line argument)
2889 isn't on the right type of file system. I.e., a getfilecon
2890 failure isn't in the same class as a stat failure. */
2891 if (errno == ENOTSUP || errno == EOPNOTSUPP || errno == ENODATA)
2892 err = 0;
2895 if (err == 0 && format == long_format)
2897 int n = file_has_acl (absolute_name, &f->stat);
2898 err = (n < 0);
2899 have_acl = (0 < n);
2902 f->acl_type = (!have_selinux && !have_acl
2903 ? ACL_T_NONE
2904 : (have_selinux && !have_acl
2905 ? ACL_T_SELINUX_ONLY
2906 : ACL_T_YES));
2907 any_has_acl |= f->acl_type != ACL_T_NONE;
2909 if (err)
2910 error (0, errno, "%s", quotearg_colon (absolute_name));
2913 if (S_ISLNK (f->stat.st_mode)
2914 && (format == long_format || check_symlink_color))
2916 char *linkname;
2917 struct stat linkstats;
2919 get_link_name (absolute_name, f, command_line_arg);
2920 linkname = make_link_name (absolute_name, f->linkname);
2922 /* Avoid following symbolic links when possible, ie, when
2923 they won't be traced and when no indicator is needed. */
2924 if (linkname
2925 && (file_type <= indicator_style || check_symlink_color)
2926 && stat (linkname, &linkstats) == 0)
2928 f->linkok = true;
2930 /* Symbolic links to directories that are mentioned on the
2931 command line are automatically traced if not being
2932 listed as files. */
2933 if (!command_line_arg || format == long_format
2934 || !S_ISDIR (linkstats.st_mode))
2936 /* Get the linked-to file's mode for the filetype indicator
2937 in long listings. */
2938 f->linkmode = linkstats.st_mode;
2941 free (linkname);
2944 /* When not distinguishing types of symlinks, pretend we know that
2945 it is stat'able, so that it will be colored as a regular symlink,
2946 and not as an orphan. */
2947 if (S_ISLNK (f->stat.st_mode) && !check_symlink_color)
2948 f->linkok = true;
2950 if (S_ISLNK (f->stat.st_mode))
2951 f->filetype = symbolic_link;
2952 else if (S_ISDIR (f->stat.st_mode))
2954 if (command_line_arg && !immediate_dirs)
2955 f->filetype = arg_directory;
2956 else
2957 f->filetype = directory;
2959 else
2960 f->filetype = normal;
2962 blocks = ST_NBLOCKS (f->stat);
2963 if (format == long_format || print_block_size)
2965 char buf[LONGEST_HUMAN_READABLE + 1];
2966 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
2967 ST_NBLOCKSIZE, output_block_size),
2969 if (block_size_width < len)
2970 block_size_width = len;
2973 if (format == long_format)
2975 if (print_owner)
2977 int len = format_user_width (f->stat.st_uid);
2978 if (owner_width < len)
2979 owner_width = len;
2982 if (print_group)
2984 int len = format_group_width (f->stat.st_gid);
2985 if (group_width < len)
2986 group_width = len;
2989 if (print_author)
2991 int len = format_user_width (f->stat.st_author);
2992 if (author_width < len)
2993 author_width = len;
2997 if (print_scontext)
2999 int len = strlen (f->scontext);
3000 if (scontext_width < len)
3001 scontext_width = len;
3004 if (format == long_format)
3006 char b[INT_BUFSIZE_BOUND (uintmax_t)];
3007 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
3008 if (nlink_width < b_len)
3009 nlink_width = b_len;
3011 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
3013 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
3014 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
3015 if (major_device_number_width < len)
3016 major_device_number_width = len;
3017 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
3018 if (minor_device_number_width < len)
3019 minor_device_number_width = len;
3020 len = major_device_number_width + 2 + minor_device_number_width;
3021 if (file_size_width < len)
3022 file_size_width = len;
3024 else
3026 char buf[LONGEST_HUMAN_READABLE + 1];
3027 uintmax_t size = unsigned_file_size (f->stat.st_size);
3028 int len = mbswidth (human_readable (size, buf, human_output_opts,
3029 1, file_output_block_size),
3031 if (file_size_width < len)
3032 file_size_width = len;
3037 if (print_inode)
3039 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
3040 int len = strlen (umaxtostr (f->stat.st_ino, buf));
3041 if (inode_number_width < len)
3042 inode_number_width = len;
3045 f->name = xstrdup (name);
3046 cwd_n_used++;
3048 return blocks;
3051 /* Return true if F refers to a directory. */
3052 static bool
3053 is_directory (const struct fileinfo *f)
3055 return f->filetype == directory || f->filetype == arg_directory;
3058 /* Put the name of the file that FILENAME is a symbolic link to
3059 into the LINKNAME field of `f'. COMMAND_LINE_ARG indicates whether
3060 FILENAME is a command-line argument. */
3062 static void
3063 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
3065 f->linkname = areadlink_with_size (filename, f->stat.st_size);
3066 if (f->linkname == NULL)
3067 file_failure (command_line_arg, _("cannot read symbolic link %s"),
3068 filename);
3071 /* If `linkname' is a relative name and `name' contains one or more
3072 leading directories, return `linkname' with those directories
3073 prepended; otherwise, return a copy of `linkname'.
3074 If `linkname' is zero, return zero. */
3076 static char *
3077 make_link_name (char const *name, char const *linkname)
3079 char *linkbuf;
3080 size_t bufsiz;
3082 if (!linkname)
3083 return NULL;
3085 if (*linkname == '/')
3086 return xstrdup (linkname);
3088 /* The link is to a relative name. Prepend any leading directory
3089 in `name' to the link name. */
3090 linkbuf = strrchr (name, '/');
3091 if (linkbuf == 0)
3092 return xstrdup (linkname);
3094 bufsiz = linkbuf - name + 1;
3095 linkbuf = xmalloc (bufsiz + strlen (linkname) + 1);
3096 strncpy (linkbuf, name, bufsiz);
3097 strcpy (linkbuf + bufsiz, linkname);
3098 return linkbuf;
3101 /* Return true if the last component of NAME is `.' or `..'
3102 This is so we don't try to recurse on `././././. ...' */
3104 static bool
3105 basename_is_dot_or_dotdot (const char *name)
3107 char const *base = last_component (name);
3108 return dot_or_dotdot (base);
3111 /* Remove any entries from CWD_FILE that are for directories,
3112 and queue them to be listed as directories instead.
3113 DIRNAME is the prefix to prepend to each dirname
3114 to make it correct relative to ls's working dir;
3115 if it is null, no prefix is needed and "." and ".." should not be ignored.
3116 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
3117 This is desirable when processing directories recursively. */
3119 static void
3120 extract_dirs_from_files (char const *dirname, bool command_line_arg)
3122 size_t i;
3123 size_t j;
3124 bool ignore_dot_and_dot_dot = (dirname != NULL);
3126 if (dirname && LOOP_DETECT)
3128 /* Insert a marker entry first. When we dequeue this marker entry,
3129 we'll know that DIRNAME has been processed and may be removed
3130 from the set of active directories. */
3131 queue_directory (NULL, dirname, false);
3134 /* Queue the directories last one first, because queueing reverses the
3135 order. */
3136 for (i = cwd_n_used; i-- != 0; )
3138 struct fileinfo *f = sorted_file[i];
3140 if (is_directory (f)
3141 && (! ignore_dot_and_dot_dot
3142 || ! basename_is_dot_or_dotdot (f->name)))
3144 if (!dirname || f->name[0] == '/')
3145 queue_directory (f->name, f->linkname, command_line_arg);
3146 else
3148 char *name = file_name_concat (dirname, f->name, NULL);
3149 queue_directory (name, f->linkname, command_line_arg);
3150 free (name);
3152 if (f->filetype == arg_directory)
3153 free (f->name);
3157 /* Now delete the directories from the table, compacting all the remaining
3158 entries. */
3160 for (i = 0, j = 0; i < cwd_n_used; i++)
3162 struct fileinfo *f = sorted_file[i];
3163 sorted_file[j] = f;
3164 j += (f->filetype != arg_directory);
3166 cwd_n_used = j;
3169 /* Use strcoll to compare strings in this locale. If an error occurs,
3170 report an error and longjmp to failed_strcoll. */
3172 static jmp_buf failed_strcoll;
3174 static int
3175 xstrcoll (char const *a, char const *b)
3177 int diff;
3178 errno = 0;
3179 diff = strcoll (a, b);
3180 if (errno)
3182 error (0, errno, _("cannot compare file names %s and %s"),
3183 quote_n (0, a), quote_n (1, b));
3184 set_exit_status (false);
3185 longjmp (failed_strcoll, 1);
3187 return diff;
3190 /* Comparison routines for sorting the files. */
3192 typedef void const *V;
3193 typedef int (*qsortFunc)(V a, V b);
3195 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
3196 The do { ... } while(0) makes it possible to use the macro more like
3197 a statement, without violating C89 rules: */
3198 #define DIRFIRST_CHECK(a, b) \
3199 do \
3201 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
3202 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
3203 if (a_is_dir && !b_is_dir) \
3204 return -1; /* a goes before b */ \
3205 if (!a_is_dir && b_is_dir) \
3206 return 1; /* b goes before a */ \
3208 while (0)
3210 /* Define the 8 different sort function variants required for each sortkey.
3211 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
3212 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
3213 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
3214 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
3215 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
3216 /* direct, non-dirfirst versions */ \
3217 static int xstrcoll_##key_name (V a, V b) \
3218 { return key_cmp_func (a, b, xstrcoll); } \
3219 static int strcmp_##key_name (V a, V b) \
3220 { return key_cmp_func (a, b, strcmp); } \
3222 /* reverse, non-dirfirst versions */ \
3223 static int rev_xstrcoll_##key_name (V a, V b) \
3224 { return key_cmp_func (b, a, xstrcoll); } \
3225 static int rev_strcmp_##key_name (V a, V b) \
3226 { return key_cmp_func (b, a, strcmp); } \
3228 /* direct, dirfirst versions */ \
3229 static int xstrcoll_df_##key_name (V a, V b) \
3230 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
3231 static int strcmp_df_##key_name (V a, V b) \
3232 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
3234 /* reverse, dirfirst versions */ \
3235 static int rev_xstrcoll_df_##key_name (V a, V b) \
3236 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
3237 static int rev_strcmp_df_##key_name (V a, V b) \
3238 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
3240 static inline int
3241 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3242 int (*cmp) (char const *, char const *))
3244 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3245 get_stat_ctime (&a->stat));
3246 return diff ? diff : cmp (a->name, b->name);
3249 static inline int
3250 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3251 int (*cmp) (char const *, char const *))
3253 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3254 get_stat_mtime (&a->stat));
3255 return diff ? diff : cmp (a->name, b->name);
3258 static inline int
3259 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3260 int (*cmp) (char const *, char const *))
3262 int diff = timespec_cmp (get_stat_atime (&b->stat),
3263 get_stat_atime (&a->stat));
3264 return diff ? diff : cmp (a->name, b->name);
3267 static inline int
3268 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3269 int (*cmp) (char const *, char const *))
3271 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3272 return diff ? diff : cmp (a->name, b->name);
3275 static inline int
3276 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3277 int (*cmp) (char const *, char const *))
3279 return cmp (a->name, b->name);
3282 /* Compare file extensions. Files with no extension are `smallest'.
3283 If extensions are the same, compare by filenames instead. */
3285 static inline int
3286 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3287 int (*cmp) (char const *, char const *))
3289 char const *base1 = strrchr (a->name, '.');
3290 char const *base2 = strrchr (b->name, '.');
3291 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3292 return diff ? diff : cmp (a->name, b->name);
3295 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3296 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3297 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3298 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3299 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3300 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3302 /* Compare file versions.
3303 Unlike all other compare functions above, cmp_version depends only
3304 on filevercmp, which does not fail (even for locale reasons), and does not
3305 need a secondary sort key. See lib/filevercmp.h for function description.
3307 All the other sort options, in fact, need xstrcoll and strcmp variants,
3308 because they all use a string comparison (either as the primary or secondary
3309 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3310 locale reasons. Lastly, filevercmp is ALWAYS available with gnulib. */
3311 static inline int
3312 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3314 return filevercmp (a->name, b->name);
3317 static int xstrcoll_version (V a, V b)
3318 { return cmp_version (a, b); }
3319 static int rev_xstrcoll_version (V a, V b)
3320 { return cmp_version (b, a); }
3321 static int xstrcoll_df_version (V a, V b)
3322 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3323 static int rev_xstrcoll_df_version (V a, V b)
3324 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3327 /* We have 2^3 different variants for each sortkey function
3328 (for 3 independent sort modes).
3329 The function pointers stored in this array must be dereferenced as:
3331 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3333 Note that the order in which sortkeys are listed in the function pointer
3334 array below is defined by the order of the elements in the time_type and
3335 sort_type enums! */
3337 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3340 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3341 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3342 }, \
3344 { strcmp_##key_name, strcmp_df_##key_name }, \
3345 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3349 static qsortFunc const sort_functions[][2][2][2] =
3351 LIST_SORTFUNCTION_VARIANTS (name),
3352 LIST_SORTFUNCTION_VARIANTS (extension),
3353 LIST_SORTFUNCTION_VARIANTS (size),
3357 { xstrcoll_version, xstrcoll_df_version },
3358 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3361 /* We use NULL for the strcmp variants of version comparison
3362 since as explained in cmp_version definition, version comparison
3363 does not rely on xstrcoll, so it will never longjmp, and never
3364 need to try the strcmp fallback. */
3366 { NULL, NULL },
3367 { NULL, NULL },
3371 /* last are time sort functions */
3372 LIST_SORTFUNCTION_VARIANTS (mtime),
3373 LIST_SORTFUNCTION_VARIANTS (ctime),
3374 LIST_SORTFUNCTION_VARIANTS (atime)
3377 /* The number of sortkeys is calculated as
3378 the number of elements in the sort_type enum (i.e. sort_numtypes) +
3379 the number of elements in the time_type enum (i.e. time_numtypes) - 1
3380 This is because when sort_type==sort_time, we have up to
3381 time_numtypes possible sortkeys.
3383 This line verifies at compile-time that the array of sort functions has been
3384 initialized for all possible sortkeys. */
3385 verify (ARRAY_CARDINALITY (sort_functions)
3386 == sort_numtypes + time_numtypes - 1 );
3388 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
3390 static void
3391 initialize_ordering_vector (void)
3393 size_t i;
3394 for (i = 0; i < cwd_n_used; i++)
3395 sorted_file[i] = &cwd_file[i];
3398 /* Sort the files now in the table. */
3400 static void
3401 sort_files (void)
3403 bool use_strcmp;
3405 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
3407 free (sorted_file);
3408 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
3409 sorted_file_alloc = 3 * cwd_n_used;
3412 initialize_ordering_vector ();
3414 if (sort_type == sort_none)
3415 return;
3417 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3418 ignore strcoll failures, as a failing strcoll might be a
3419 comparison function that is not a total order, and if we ignored
3420 the failure this might cause qsort to dump core. */
3422 if (! setjmp (failed_strcoll))
3423 use_strcmp = false; /* strcoll() succeeded */
3424 else
3426 use_strcmp = true;
3427 assert (sort_type != sort_version);
3428 initialize_ordering_vector ();
3431 /* When sort_type == sort_time, use time_type as subindex. */
3432 mpsort ((void const **) sorted_file, cwd_n_used,
3433 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
3434 [use_strcmp][sort_reverse]
3435 [directories_first]);
3438 /* List all the files now in the table. */
3440 static void
3441 print_current_files (void)
3443 size_t i;
3445 switch (format)
3447 case one_per_line:
3448 for (i = 0; i < cwd_n_used; i++)
3450 print_file_name_and_frills (sorted_file[i], 0);
3451 putchar ('\n');
3453 break;
3455 case many_per_line:
3456 print_many_per_line ();
3457 break;
3459 case horizontal:
3460 print_horizontal ();
3461 break;
3463 case with_commas:
3464 print_with_commas ();
3465 break;
3467 case long_format:
3468 for (i = 0; i < cwd_n_used; i++)
3470 set_normal_color ();
3471 print_long_format (sorted_file[i]);
3472 DIRED_PUTCHAR ('\n');
3474 break;
3478 /* Replace the first %b with precomputed aligned month names.
3479 Note on glibc-2.7 at least, this speeds up the whole `ls -lU`
3480 process by around 17%, compared to letting strftime() handle the %b. */
3482 static size_t
3483 align_nstrftime (char *buf, size_t size, char const *fmt, struct tm const *tm,
3484 int __utc, int __ns)
3486 const char *nfmt = fmt;
3487 /* In the unlikely event that rpl_fmt below is not large enough,
3488 the replacement is not done. A malloc here slows ls down by 2% */
3489 char rpl_fmt[sizeof (abmon[0]) + 100];
3490 const char *pb;
3491 if (required_mon_width && (pb = strstr (fmt, "%b")))
3493 if (strlen (fmt) < (sizeof (rpl_fmt) - sizeof (abmon[0]) + 2))
3495 char *pfmt = rpl_fmt;
3496 nfmt = rpl_fmt;
3498 pfmt = mempcpy (pfmt, fmt, pb - fmt);
3499 pfmt = stpcpy (pfmt, abmon[tm->tm_mon]);
3500 strcpy (pfmt, pb + 2);
3503 size_t ret = nstrftime (buf, size, nfmt, tm, __utc, __ns);
3504 return ret;
3507 /* Return the expected number of columns in a long-format time stamp,
3508 or zero if it cannot be calculated. */
3510 static int
3511 long_time_expected_width (void)
3513 static int width = -1;
3515 if (width < 0)
3517 time_t epoch = 0;
3518 struct tm const *tm = localtime (&epoch);
3519 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3521 /* In case you're wondering if localtime can fail with an input time_t
3522 value of 0, let's just say it's very unlikely, but not inconceivable.
3523 The TZ environment variable would have to specify a time zone that
3524 is 2**31-1900 years or more ahead of UTC. This could happen only on
3525 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3526 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3527 their implementations limit the offset to 167:59 and 24:00, resp. */
3528 if (tm)
3530 size_t len =
3531 align_nstrftime (buf, sizeof buf, long_time_format[0], tm, 0, 0);
3532 if (len != 0)
3533 width = mbsnwidth (buf, len, 0);
3536 if (width < 0)
3537 width = 0;
3540 return width;
3543 /* Print the user or group name NAME, with numeric id ID, using a
3544 print width of WIDTH columns. */
3546 static void
3547 format_user_or_group (char const *name, unsigned long int id, int width)
3549 size_t len;
3551 if (name)
3553 int width_gap = width - mbswidth (name, 0);
3554 int pad = MAX (0, width_gap);
3555 fputs (name, stdout);
3556 len = strlen (name) + pad;
3559 putchar (' ');
3560 while (pad--);
3562 else
3564 printf ("%*lu ", width, id);
3565 len = width;
3568 dired_pos += len + 1;
3571 /* Print the name or id of the user with id U, using a print width of
3572 WIDTH. */
3574 static void
3575 format_user (uid_t u, int width, bool stat_ok)
3577 format_user_or_group (! stat_ok ? "?" :
3578 (numeric_ids ? NULL : getuser (u)), u, width);
3581 /* Likewise, for groups. */
3583 static void
3584 format_group (gid_t g, int width, bool stat_ok)
3586 format_user_or_group (! stat_ok ? "?" :
3587 (numeric_ids ? NULL : getgroup (g)), g, width);
3590 /* Return the number of columns that format_user_or_group will print. */
3592 static int
3593 format_user_or_group_width (char const *name, unsigned long int id)
3595 if (name)
3597 int len = mbswidth (name, 0);
3598 return MAX (0, len);
3600 else
3602 char buf[INT_BUFSIZE_BOUND (id)];
3603 sprintf (buf, "%lu", id);
3604 return strlen (buf);
3608 /* Return the number of columns that format_user will print. */
3610 static int
3611 format_user_width (uid_t u)
3613 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3616 /* Likewise, for groups. */
3618 static int
3619 format_group_width (gid_t g)
3621 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3624 /* Return a pointer to a formatted version of F->stat.st_ino,
3625 possibly using buffer, BUF, of length BUFLEN, which must be at least
3626 INT_BUFSIZE_BOUND (uintmax_t) bytes. */
3627 static char *
3628 format_inode (char *buf, size_t buflen, const struct fileinfo *f)
3630 assert (INT_BUFSIZE_BOUND (uintmax_t) <= buflen);
3631 return (f->stat_ok && f->stat.st_ino != NOT_AN_INODE_NUMBER
3632 ? umaxtostr (f->stat.st_ino, buf)
3633 : (char *) "?");
3636 /* Print information about F in long format. */
3637 static void
3638 print_long_format (const struct fileinfo *f)
3640 char modebuf[12];
3641 char buf
3642 [LONGEST_HUMAN_READABLE + 1 /* inode */
3643 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3644 + sizeof (modebuf) - 1 + 1 /* mode string */
3645 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3646 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3647 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3648 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3650 size_t s;
3651 char *p;
3652 struct timespec when_timespec;
3653 struct tm *when_local;
3655 /* Compute the mode string, except remove the trailing space if no
3656 file in this directory has an ACL or SELinux security context. */
3657 if (f->stat_ok)
3658 filemodestring (&f->stat, modebuf);
3659 else
3661 modebuf[0] = filetype_letter[f->filetype];
3662 memset (modebuf + 1, '?', 10);
3663 modebuf[11] = '\0';
3665 if (! any_has_acl)
3666 modebuf[10] = '\0';
3667 else if (f->acl_type == ACL_T_SELINUX_ONLY)
3668 modebuf[10] = '.';
3669 else if (f->acl_type == ACL_T_YES)
3670 modebuf[10] = '+';
3672 switch (time_type)
3674 case time_ctime:
3675 when_timespec = get_stat_ctime (&f->stat);
3676 break;
3677 case time_mtime:
3678 when_timespec = get_stat_mtime (&f->stat);
3679 break;
3680 case time_atime:
3681 when_timespec = get_stat_atime (&f->stat);
3682 break;
3683 default:
3684 abort ();
3687 p = buf;
3689 if (print_inode)
3691 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3692 sprintf (p, "%*s ", inode_number_width,
3693 format_inode (hbuf, sizeof hbuf, f));
3694 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3695 The latter is wrong when inode_number_width is zero. */
3696 p += strlen (p);
3699 if (print_block_size)
3701 char hbuf[LONGEST_HUMAN_READABLE + 1];
3702 char const *blocks =
3703 (! f->stat_ok
3704 ? "?"
3705 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3706 ST_NBLOCKSIZE, output_block_size));
3707 int pad;
3708 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3709 *p++ = ' ';
3710 while ((*p++ = *blocks++))
3711 continue;
3712 p[-1] = ' ';
3715 /* The last byte of the mode string is the POSIX
3716 "optional alternate access method flag". */
3718 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3719 sprintf (p, "%s %*s ", modebuf, nlink_width,
3720 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3722 /* Increment by strlen (p) here, rather than by, e.g.,
3723 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3724 The latter is wrong when nlink_width is zero. */
3725 p += strlen (p);
3727 DIRED_INDENT ();
3729 if (print_owner || print_group || print_author || print_scontext)
3731 DIRED_FPUTS (buf, stdout, p - buf);
3733 if (print_owner)
3734 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3736 if (print_group)
3737 format_group (f->stat.st_gid, group_width, f->stat_ok);
3739 if (print_author)
3740 format_user (f->stat.st_author, author_width, f->stat_ok);
3742 if (print_scontext)
3743 format_user_or_group (f->scontext, 0, scontext_width);
3745 p = buf;
3748 if (f->stat_ok
3749 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3751 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3752 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3753 int blanks_width = (file_size_width
3754 - (major_device_number_width + 2
3755 + minor_device_number_width));
3756 sprintf (p, "%*s, %*s ",
3757 major_device_number_width + MAX (0, blanks_width),
3758 umaxtostr (major (f->stat.st_rdev), majorbuf),
3759 minor_device_number_width,
3760 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3761 p += file_size_width + 1;
3763 else
3765 char hbuf[LONGEST_HUMAN_READABLE + 1];
3766 char const *size =
3767 (! f->stat_ok
3768 ? "?"
3769 : human_readable (unsigned_file_size (f->stat.st_size),
3770 hbuf, human_output_opts, 1, file_output_block_size));
3771 int pad;
3772 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3773 *p++ = ' ';
3774 while ((*p++ = *size++))
3775 continue;
3776 p[-1] = ' ';
3779 when_local = localtime (&when_timespec.tv_sec);
3780 s = 0;
3781 *p = '\1';
3783 if (f->stat_ok && when_local)
3785 struct timespec six_months_ago;
3786 bool recent;
3787 char const *fmt;
3789 /* If the file appears to be in the future, update the current
3790 time, in case the file happens to have been modified since
3791 the last time we checked the clock. */
3792 if (timespec_cmp (current_time, when_timespec) < 0)
3794 /* Note that gettime may call gettimeofday which, on some non-
3795 compliant systems, clobbers the buffer used for localtime's result.
3796 But it's ok here, because we use a gettimeofday wrapper that
3797 saves and restores the buffer around the gettimeofday call. */
3798 gettime (&current_time);
3801 /* Consider a time to be recent if it is within the past six
3802 months. A Gregorian year has 365.2425 * 24 * 60 * 60 ==
3803 31556952 seconds on the average. Write this value as an
3804 integer constant to avoid floating point hassles. */
3805 six_months_ago.tv_sec = current_time.tv_sec - 31556952 / 2;
3806 six_months_ago.tv_nsec = current_time.tv_nsec;
3808 recent = (timespec_cmp (six_months_ago, when_timespec) < 0
3809 && (timespec_cmp (when_timespec, current_time) < 0));
3810 fmt = long_time_format[recent];
3812 /* We assume here that all time zones are offset from UTC by a
3813 whole number of seconds. */
3814 s = align_nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
3815 when_local, 0, when_timespec.tv_nsec);
3818 if (s || !*p)
3820 p += s;
3821 *p++ = ' ';
3823 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
3824 *p = '\0';
3826 else
3828 /* The time cannot be converted using the desired format, so
3829 print it as a huge integer number of seconds. */
3830 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
3831 sprintf (p, "%*s ", long_time_expected_width (),
3832 (! f->stat_ok
3833 ? "?"
3834 : timetostr (when_timespec.tv_sec, hbuf)));
3835 /* FIXME: (maybe) We discarded when_timespec.tv_nsec. */
3836 p += strlen (p);
3839 DIRED_FPUTS (buf, stdout, p - buf);
3840 size_t w = print_name_with_quoting (f, false, &dired_obstack, p - buf);
3842 if (f->filetype == symbolic_link)
3844 if (f->linkname)
3846 DIRED_FPUTS_LITERAL (" -> ", stdout);
3847 print_name_with_quoting (f, true, NULL, (p - buf) + w + 4);
3848 if (indicator_style != none)
3849 print_type_indicator (true, f->linkmode, unknown);
3852 else if (indicator_style != none)
3853 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3856 /* Output to OUT a quoted representation of the file name NAME,
3857 using OPTIONS to control quoting. Produce no output if OUT is NULL.
3858 Store the number of screen columns occupied by NAME's quoted
3859 representation into WIDTH, if non-NULL. Return the number of bytes
3860 produced. */
3862 static size_t
3863 quote_name (FILE *out, const char *name, struct quoting_options const *options,
3864 size_t *width)
3866 char smallbuf[BUFSIZ];
3867 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
3868 char *buf;
3869 size_t displayed_width IF_LINT ( = 0);
3871 if (len < sizeof smallbuf)
3872 buf = smallbuf;
3873 else
3875 buf = alloca (len + 1);
3876 quotearg_buffer (buf, len + 1, name, -1, options);
3879 if (qmark_funny_chars)
3881 if (MB_CUR_MAX > 1)
3883 char const *p = buf;
3884 char const *plimit = buf + len;
3885 char *q = buf;
3886 displayed_width = 0;
3888 while (p < plimit)
3889 switch (*p)
3891 case ' ': case '!': case '"': case '#': case '%':
3892 case '&': case '\'': case '(': case ')': case '*':
3893 case '+': case ',': case '-': case '.': case '/':
3894 case '0': case '1': case '2': case '3': case '4':
3895 case '5': case '6': case '7': case '8': case '9':
3896 case ':': case ';': case '<': case '=': case '>':
3897 case '?':
3898 case 'A': case 'B': case 'C': case 'D': case 'E':
3899 case 'F': case 'G': case 'H': case 'I': case 'J':
3900 case 'K': case 'L': case 'M': case 'N': case 'O':
3901 case 'P': case 'Q': case 'R': case 'S': case 'T':
3902 case 'U': case 'V': case 'W': case 'X': case 'Y':
3903 case 'Z':
3904 case '[': case '\\': case ']': case '^': case '_':
3905 case 'a': case 'b': case 'c': case 'd': case 'e':
3906 case 'f': case 'g': case 'h': case 'i': case 'j':
3907 case 'k': case 'l': case 'm': case 'n': case 'o':
3908 case 'p': case 'q': case 'r': case 's': case 't':
3909 case 'u': case 'v': case 'w': case 'x': case 'y':
3910 case 'z': case '{': case '|': case '}': case '~':
3911 /* These characters are printable ASCII characters. */
3912 *q++ = *p++;
3913 displayed_width += 1;
3914 break;
3915 default:
3916 /* If we have a multibyte sequence, copy it until we
3917 reach its end, replacing each non-printable multibyte
3918 character with a single question mark. */
3920 mbstate_t mbstate = { 0, };
3923 wchar_t wc;
3924 size_t bytes;
3925 int w;
3927 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
3929 if (bytes == (size_t) -1)
3931 /* An invalid multibyte sequence was
3932 encountered. Skip one input byte, and
3933 put a question mark. */
3934 p++;
3935 *q++ = '?';
3936 displayed_width += 1;
3937 break;
3940 if (bytes == (size_t) -2)
3942 /* An incomplete multibyte character
3943 at the end. Replace it entirely with
3944 a question mark. */
3945 p = plimit;
3946 *q++ = '?';
3947 displayed_width += 1;
3948 break;
3951 if (bytes == 0)
3952 /* A null wide character was encountered. */
3953 bytes = 1;
3955 w = wcwidth (wc);
3956 if (w >= 0)
3958 /* A printable multibyte character.
3959 Keep it. */
3960 for (; bytes > 0; --bytes)
3961 *q++ = *p++;
3962 displayed_width += w;
3964 else
3966 /* An unprintable multibyte character.
3967 Replace it entirely with a question
3968 mark. */
3969 p += bytes;
3970 *q++ = '?';
3971 displayed_width += 1;
3974 while (! mbsinit (&mbstate));
3976 break;
3979 /* The buffer may have shrunk. */
3980 len = q - buf;
3982 else
3984 char *p = buf;
3985 char const *plimit = buf + len;
3987 while (p < plimit)
3989 if (! isprint (to_uchar (*p)))
3990 *p = '?';
3991 p++;
3993 displayed_width = len;
3996 else if (width != NULL)
3998 if (MB_CUR_MAX > 1)
3999 displayed_width = mbsnwidth (buf, len, 0);
4000 else
4002 char const *p = buf;
4003 char const *plimit = buf + len;
4005 displayed_width = 0;
4006 while (p < plimit)
4008 if (isprint (to_uchar (*p)))
4009 displayed_width++;
4010 p++;
4015 if (out != NULL)
4016 fwrite (buf, 1, len, out);
4017 if (width != NULL)
4018 *width = displayed_width;
4019 return len;
4022 static size_t
4023 print_name_with_quoting (const struct fileinfo *f,
4024 bool symlink_target,
4025 struct obstack *stack,
4026 size_t start_col)
4028 const char* name = symlink_target ? f->linkname : f->name;
4030 bool used_color_this_time
4031 = (print_with_color
4032 && (print_color_indicator (f, symlink_target)
4033 || is_colored (C_NORM)));
4035 if (stack)
4036 PUSH_CURRENT_DIRED_POS (stack);
4038 size_t width = quote_name (stdout, name, filename_quoting_options, NULL);
4039 dired_pos += width;
4041 if (stack)
4042 PUSH_CURRENT_DIRED_POS (stack);
4044 if (used_color_this_time)
4046 process_signals ();
4047 prep_non_filename_text ();
4048 if (start_col / line_length != (start_col + width - 1) / line_length)
4049 put_indicator (&color_indicator[C_CLR_TO_EOL]);
4052 return width;
4055 static void
4056 prep_non_filename_text (void)
4058 if (color_indicator[C_END].string != NULL)
4059 put_indicator (&color_indicator[C_END]);
4060 else
4062 put_indicator (&color_indicator[C_LEFT]);
4063 put_indicator (&color_indicator[C_RESET]);
4064 put_indicator (&color_indicator[C_RIGHT]);
4068 /* Print the file name of `f' with appropriate quoting.
4069 Also print file size, inode number, and filetype indicator character,
4070 as requested by switches. */
4072 static size_t
4073 print_file_name_and_frills (const struct fileinfo *f, size_t start_col)
4075 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4077 set_normal_color ();
4079 if (print_inode)
4080 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
4081 format_inode (buf, sizeof buf, f));
4083 if (print_block_size)
4084 printf ("%*s ", format == with_commas ? 0 : block_size_width,
4085 ! f->stat_ok ? "?"
4086 : human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
4087 ST_NBLOCKSIZE, output_block_size));
4089 if (print_scontext)
4090 printf ("%*s ", format == with_commas ? 0 : scontext_width, f->scontext);
4092 size_t width = print_name_with_quoting (f, false, NULL, start_col);
4094 if (indicator_style != none)
4095 width += print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4097 return width;
4100 /* Given these arguments describing a file, return the single-byte
4101 type indicator, or 0. */
4102 static char
4103 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4105 char c;
4107 if (stat_ok ? S_ISREG (mode) : type == normal)
4109 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
4110 c = '*';
4111 else
4112 c = 0;
4114 else
4116 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
4117 c = '/';
4118 else if (indicator_style == slash)
4119 c = 0;
4120 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
4121 c = '@';
4122 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
4123 c = '|';
4124 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
4125 c = '=';
4126 else if (stat_ok && S_ISDOOR (mode))
4127 c = '>';
4128 else
4129 c = 0;
4131 return c;
4134 static bool
4135 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4137 char c = get_type_indicator (stat_ok, mode, type);
4138 if (c)
4139 DIRED_PUTCHAR (c);
4140 return !!c;
4143 /* Returns whether any color sequence was printed. */
4144 static bool
4145 print_color_indicator (const struct fileinfo *f, bool symlink_target)
4147 enum indicator_no type;
4148 struct color_ext_type *ext; /* Color extension */
4149 size_t len; /* Length of name */
4151 const char* name;
4152 mode_t mode;
4153 int linkok;
4154 if (symlink_target)
4156 name = f->linkname;
4157 mode = f->linkmode;
4158 linkok = f->linkok ? 0 : -1;
4160 else
4162 name = f->name;
4163 mode = FILE_OR_LINK_MODE (f);
4164 linkok = f->linkok;
4167 /* Is this a nonexistent file? If so, linkok == -1. */
4169 if (linkok == -1 && color_indicator[C_MISSING].string != NULL)
4170 type = C_MISSING;
4171 else if (!f->stat_ok)
4173 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
4174 type = filetype_indicator[f->filetype];
4176 else
4178 if (S_ISREG (mode))
4180 type = C_FILE;
4182 if ((mode & S_ISUID) != 0 && is_colored (C_SETUID))
4183 type = C_SETUID;
4184 else if ((mode & S_ISGID) != 0 && is_colored (C_SETGID))
4185 type = C_SETGID;
4186 else if (is_colored (C_CAP) && f->has_capability)
4187 type = C_CAP;
4188 else if ((mode & S_IXUGO) != 0 && is_colored (C_EXEC))
4189 type = C_EXEC;
4190 else if ((1 < f->stat.st_nlink) && is_colored (C_MULTIHARDLINK))
4191 type = C_MULTIHARDLINK;
4193 else if (S_ISDIR (mode))
4195 type = C_DIR;
4197 if ((mode & S_ISVTX) && (mode & S_IWOTH)
4198 && is_colored (C_STICKY_OTHER_WRITABLE))
4199 type = C_STICKY_OTHER_WRITABLE;
4200 else if ((mode & S_IWOTH) != 0 && is_colored (C_OTHER_WRITABLE))
4201 type = C_OTHER_WRITABLE;
4202 else if ((mode & S_ISVTX) != 0 && is_colored (C_STICKY))
4203 type = C_STICKY;
4205 else if (S_ISLNK (mode))
4206 type = ((!linkok
4207 && (!STRNCMP_LIT (color_indicator[C_LINK].string, "target")
4208 || color_indicator[C_ORPHAN].string))
4209 ? C_ORPHAN : C_LINK);
4210 else if (S_ISFIFO (mode))
4211 type = C_FIFO;
4212 else if (S_ISSOCK (mode))
4213 type = C_SOCK;
4214 else if (S_ISBLK (mode))
4215 type = C_BLK;
4216 else if (S_ISCHR (mode))
4217 type = C_CHR;
4218 else if (S_ISDOOR (mode))
4219 type = C_DOOR;
4220 else
4222 /* Classify a file of some other type as C_ORPHAN. */
4223 type = C_ORPHAN;
4227 /* Check the file's suffix only if still classified as C_FILE. */
4228 ext = NULL;
4229 if (type == C_FILE)
4231 /* Test if NAME has a recognized suffix. */
4233 len = strlen (name);
4234 name += len; /* Pointer to final \0. */
4235 for (ext = color_ext_list; ext != NULL; ext = ext->next)
4237 if (ext->ext.len <= len
4238 && STREQ_LEN (name - ext->ext.len, ext->ext.string,
4239 ext->ext.len))
4240 break;
4245 const struct bin_str *const s
4246 = ext ? &(ext->seq) : &color_indicator[type];
4247 if (s->string != NULL)
4249 /* Need to reset so not dealing with attribute combinations */
4250 if (is_colored (C_NORM))
4251 restore_default_color ();
4252 put_indicator (&color_indicator[C_LEFT]);
4253 put_indicator (s);
4254 put_indicator (&color_indicator[C_RIGHT]);
4255 return true;
4257 else
4258 return false;
4262 /* Output a color indicator (which may contain nulls). */
4263 static void
4264 put_indicator (const struct bin_str *ind)
4266 if (! used_color)
4268 used_color = true;
4269 prep_non_filename_text ();
4272 fwrite (ind->string, ind->len, 1, stdout);
4275 static size_t
4276 length_of_file_name_and_frills (const struct fileinfo *f)
4278 size_t len = 0;
4279 size_t name_width;
4280 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4282 if (print_inode)
4283 len += 1 + (format == with_commas
4284 ? strlen (umaxtostr (f->stat.st_ino, buf))
4285 : inode_number_width);
4287 if (print_block_size)
4288 len += 1 + (format == with_commas
4289 ? strlen (! f->stat_ok ? "?"
4290 : human_readable (ST_NBLOCKS (f->stat), buf,
4291 human_output_opts, ST_NBLOCKSIZE,
4292 output_block_size))
4293 : block_size_width);
4295 if (print_scontext)
4296 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
4298 quote_name (NULL, f->name, filename_quoting_options, &name_width);
4299 len += name_width;
4301 if (indicator_style != none)
4303 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4304 len += (c != 0);
4307 return len;
4310 static void
4311 print_many_per_line (void)
4313 size_t row; /* Current row. */
4314 size_t cols = calculate_columns (true);
4315 struct column_info const *line_fmt = &column_info[cols - 1];
4317 /* Calculate the number of rows that will be in each column except possibly
4318 for a short column on the right. */
4319 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
4321 for (row = 0; row < rows; row++)
4323 size_t col = 0;
4324 size_t filesno = row;
4325 size_t pos = 0;
4327 /* Print the next row. */
4328 while (1)
4330 struct fileinfo const *f = sorted_file[filesno];
4331 size_t name_length = length_of_file_name_and_frills (f);
4332 size_t max_name_length = line_fmt->col_arr[col++];
4333 print_file_name_and_frills (f, pos);
4335 filesno += rows;
4336 if (filesno >= cwd_n_used)
4337 break;
4339 indent (pos + name_length, pos + max_name_length);
4340 pos += max_name_length;
4342 putchar ('\n');
4346 static void
4347 print_horizontal (void)
4349 size_t filesno;
4350 size_t pos = 0;
4351 size_t cols = calculate_columns (false);
4352 struct column_info const *line_fmt = &column_info[cols - 1];
4353 struct fileinfo const *f = sorted_file[0];
4354 size_t name_length = length_of_file_name_and_frills (f);
4355 size_t max_name_length = line_fmt->col_arr[0];
4357 /* Print first entry. */
4358 print_file_name_and_frills (f, 0);
4360 /* Now the rest. */
4361 for (filesno = 1; filesno < cwd_n_used; ++filesno)
4363 size_t col = filesno % cols;
4365 if (col == 0)
4367 putchar ('\n');
4368 pos = 0;
4370 else
4372 indent (pos + name_length, pos + max_name_length);
4373 pos += max_name_length;
4376 f = sorted_file[filesno];
4377 print_file_name_and_frills (f, pos);
4379 name_length = length_of_file_name_and_frills (f);
4380 max_name_length = line_fmt->col_arr[col];
4382 putchar ('\n');
4385 static void
4386 print_with_commas (void)
4388 size_t filesno;
4389 size_t pos = 0;
4391 for (filesno = 0; filesno < cwd_n_used; filesno++)
4393 struct fileinfo const *f = sorted_file[filesno];
4394 size_t len = length_of_file_name_and_frills (f);
4396 if (filesno != 0)
4398 char separator;
4400 if (pos + len + 2 < line_length)
4402 pos += 2;
4403 separator = ' ';
4405 else
4407 pos = 0;
4408 separator = '\n';
4411 putchar (',');
4412 putchar (separator);
4415 print_file_name_and_frills (f, pos);
4416 pos += len;
4418 putchar ('\n');
4421 /* Assuming cursor is at position FROM, indent up to position TO.
4422 Use a TAB character instead of two or more spaces whenever possible. */
4424 static void
4425 indent (size_t from, size_t to)
4427 while (from < to)
4429 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4431 putchar ('\t');
4432 from += tabsize - from % tabsize;
4434 else
4436 putchar (' ');
4437 from++;
4442 /* Put DIRNAME/NAME into DEST, handling `.' and `/' properly. */
4443 /* FIXME: maybe remove this function someday. See about using a
4444 non-malloc'ing version of file_name_concat. */
4446 static void
4447 attach (char *dest, const char *dirname, const char *name)
4449 const char *dirnamep = dirname;
4451 /* Copy dirname if it is not ".". */
4452 if (dirname[0] != '.' || dirname[1] != 0)
4454 while (*dirnamep)
4455 *dest++ = *dirnamep++;
4456 /* Add '/' if `dirname' doesn't already end with it. */
4457 if (dirnamep > dirname && dirnamep[-1] != '/')
4458 *dest++ = '/';
4460 while (*name)
4461 *dest++ = *name++;
4462 *dest = 0;
4465 /* Allocate enough column info suitable for the current number of
4466 files and display columns, and initialize the info to represent the
4467 narrowest possible columns. */
4469 static void
4470 init_column_info (void)
4472 size_t i;
4473 size_t max_cols = MIN (max_idx, cwd_n_used);
4475 /* Currently allocated columns in column_info. */
4476 static size_t column_info_alloc;
4478 if (column_info_alloc < max_cols)
4480 size_t new_column_info_alloc;
4481 size_t *p;
4483 if (max_cols < max_idx / 2)
4485 /* The number of columns is far less than the display width
4486 allows. Grow the allocation, but only so that it's
4487 double the current requirements. If the display is
4488 extremely wide, this avoids allocating a lot of memory
4489 that is never needed. */
4490 column_info = xnrealloc (column_info, max_cols,
4491 2 * sizeof *column_info);
4492 new_column_info_alloc = 2 * max_cols;
4494 else
4496 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4497 new_column_info_alloc = max_idx;
4500 /* Allocate the new size_t objects by computing the triangle
4501 formula n * (n + 1) / 2, except that we don't need to
4502 allocate the part of the triangle that we've already
4503 allocated. Check for address arithmetic overflow. */
4505 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4506 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4507 size_t t = s * column_info_growth;
4508 if (s < new_column_info_alloc || t / column_info_growth != s)
4509 xalloc_die ();
4510 p = xnmalloc (t / 2, sizeof *p);
4513 /* Grow the triangle by parceling out the cells just allocated. */
4514 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4516 column_info[i].col_arr = p;
4517 p += i + 1;
4520 column_info_alloc = new_column_info_alloc;
4523 for (i = 0; i < max_cols; ++i)
4525 size_t j;
4527 column_info[i].valid_len = true;
4528 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4529 for (j = 0; j <= i; ++j)
4530 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4534 /* Calculate the number of columns needed to represent the current set
4535 of files in the current display width. */
4537 static size_t
4538 calculate_columns (bool by_columns)
4540 size_t filesno; /* Index into cwd_file. */
4541 size_t cols; /* Number of files across. */
4543 /* Normally the maximum number of columns is determined by the
4544 screen width. But if few files are available this might limit it
4545 as well. */
4546 size_t max_cols = MIN (max_idx, cwd_n_used);
4548 init_column_info ();
4550 /* Compute the maximum number of possible columns. */
4551 for (filesno = 0; filesno < cwd_n_used; ++filesno)
4553 struct fileinfo const *f = sorted_file[filesno];
4554 size_t name_length = length_of_file_name_and_frills (f);
4555 size_t i;
4557 for (i = 0; i < max_cols; ++i)
4559 if (column_info[i].valid_len)
4561 size_t idx = (by_columns
4562 ? filesno / ((cwd_n_used + i) / (i + 1))
4563 : filesno % (i + 1));
4564 size_t real_length = name_length + (idx == i ? 0 : 2);
4566 if (column_info[i].col_arr[idx] < real_length)
4568 column_info[i].line_len += (real_length
4569 - column_info[i].col_arr[idx]);
4570 column_info[i].col_arr[idx] = real_length;
4571 column_info[i].valid_len = (column_info[i].line_len
4572 < line_length);
4578 /* Find maximum allowed columns. */
4579 for (cols = max_cols; 1 < cols; --cols)
4581 if (column_info[cols - 1].valid_len)
4582 break;
4585 return cols;
4588 void
4589 usage (int status)
4591 if (status != EXIT_SUCCESS)
4592 fprintf (stderr, _("Try `%s --help' for more information.\n"),
4593 program_name);
4594 else
4596 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4597 fputs (_("\
4598 List information about the FILEs (the current directory by default).\n\
4599 Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.\n\
4601 "), stdout);
4602 fputs (_("\
4603 Mandatory arguments to long options are mandatory for short options too.\n\
4604 "), stdout);
4605 fputs (_("\
4606 -a, --all do not ignore entries starting with .\n\
4607 -A, --almost-all do not list implied . and ..\n\
4608 --author with -l, print the author of each file\n\
4609 -b, --escape print C-style escapes for nongraphic characters\n\
4610 "), stdout);
4611 fputs (_("\
4612 --block-size=SIZE scale sizes by SIZE before printing them. E.g.,\n\
4613 `--block-size=M' prints sizes in units of\n\
4614 1,048,576 bytes. See SIZE format below.\n\
4615 -B, --ignore-backups do not list implied entries ending with ~\n\
4616 -c with -lt: sort by, and show, ctime (time of last\n\
4617 modification of file status information)\n\
4618 with -l: show ctime and sort by name\n\
4619 otherwise: sort by ctime, newest first\n\
4620 "), stdout);
4621 fputs (_("\
4622 -C list entries by columns\n\
4623 --color[=WHEN] colorize the output. WHEN defaults to `always'\n\
4624 or can be `never' or `auto'. More info below\n\
4625 -d, --directory list directory entries instead of contents,\n\
4626 and do not dereference symbolic links\n\
4627 -D, --dired generate output designed for Emacs' dired mode\n\
4628 "), stdout);
4629 fputs (_("\
4630 -f do not sort, enable -aU, disable -ls --color\n\
4631 -F, --classify append indicator (one of */=>@|) to entries\n\
4632 --file-type likewise, except do not append `*'\n\
4633 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4634 single-column -1, verbose -l, vertical -C\n\
4635 --full-time like -l --time-style=full-iso\n\
4636 "), stdout);
4637 fputs (_("\
4638 -g like -l, but do not list owner\n\
4639 "), stdout);
4640 fputs (_("\
4641 --group-directories-first\n\
4642 group directories before files.\n\
4643 augment with a --sort option, but any\n\
4644 use of --sort=none (-U) disables grouping\n\
4645 "), stdout);
4646 fputs (_("\
4647 -G, --no-group in a long listing, don't print group names\n\
4648 -h, --human-readable with -l, print sizes in human readable format\n\
4649 (e.g., 1K 234M 2G)\n\
4650 --si likewise, but use powers of 1000 not 1024\n\
4651 "), stdout);
4652 fputs (_("\
4653 -H, --dereference-command-line\n\
4654 follow symbolic links listed on the command line\n\
4655 --dereference-command-line-symlink-to-dir\n\
4656 follow each command line symbolic link\n\
4657 that points to a directory\n\
4658 --hide=PATTERN do not list implied entries matching shell PATTERN\
4660 (overridden by -a or -A)\n\
4661 "), stdout);
4662 fputs (_("\
4663 --indicator-style=WORD append indicator with style WORD to entry names:\
4665 none (default), slash (-p),\n\
4666 file-type (--file-type), classify (-F)\n\
4667 -i, --inode print the index number of each file\n\
4668 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\
4670 -k like --block-size=1K\n\
4671 "), stdout);
4672 fputs (_("\
4673 -l use a long listing format\n\
4674 -L, --dereference when showing file information for a symbolic\n\
4675 link, show information for the file the link\n\
4676 references rather than for the link itself\n\
4677 -m fill width with a comma separated list of entries\
4679 "), stdout);
4680 fputs (_("\
4681 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4682 -N, --literal print raw entry names (don't treat e.g. control\n\
4683 characters specially)\n\
4684 -o like -l, but do not list group information\n\
4685 -p, --indicator-style=slash\n\
4686 append / indicator to directories\n\
4687 "), stdout);
4688 fputs (_("\
4689 -q, --hide-control-chars print ? instead of non graphic characters\n\
4690 --show-control-chars show non graphic characters as-is (default\n\
4691 unless program is `ls' and output is a terminal)\n\
4692 -Q, --quote-name enclose entry names in double quotes\n\
4693 --quoting-style=WORD use quoting style WORD for entry names:\n\
4694 literal, locale, shell, shell-always, c, escape\
4696 "), stdout);
4697 fputs (_("\
4698 -r, --reverse reverse order while sorting\n\
4699 -R, --recursive list subdirectories recursively\n\
4700 -s, --size print the allocated size of each file, in blocks\n\
4701 "), stdout);
4702 fputs (_("\
4703 -S sort by file size\n\
4704 --sort=WORD sort by WORD instead of name: none -U,\n\
4705 extension -X, size -S, time -t, version -v\n\
4706 --time=WORD with -l, show time as WORD instead of modification\
4708 time: atime -u, access -u, use -u, ctime -c,\n\
4709 or status -c; use specified time as sort key\n\
4710 if --sort=time\n\
4711 "), stdout);
4712 fputs (_("\
4713 --time-style=STYLE with -l, show times using style STYLE:\n\
4714 full-iso, long-iso, iso, locale, +FORMAT.\n\
4715 FORMAT is interpreted like `date'; if FORMAT is\n\
4716 FORMAT1<newline>FORMAT2, FORMAT1 applies to\n\
4717 non-recent files and FORMAT2 to recent files;\n\
4718 if STYLE is prefixed with `posix-', STYLE\n\
4719 takes effect only outside the POSIX locale\n\
4720 "), stdout);
4721 fputs (_("\
4722 -t sort by modification time, newest first\n\
4723 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4724 "), stdout);
4725 fputs (_("\
4726 -u with -lt: sort by, and show, access time\n\
4727 with -l: show access time and sort by name\n\
4728 otherwise: sort by access time\n\
4729 -U do not sort; list entries in directory order\n\
4730 -v natural sort of (version) numbers within text\n\
4731 "), stdout);
4732 fputs (_("\
4733 -w, --width=COLS assume screen width instead of current value\n\
4734 -x list entries by lines instead of by columns\n\
4735 -X sort alphabetically by entry extension\n\
4736 -Z, --context print any SELinux security context of each file\n\
4737 -1 list one file per line\n\
4738 "), stdout);
4739 fputs (HELP_OPTION_DESCRIPTION, stdout);
4740 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4741 emit_size_note ();
4742 fputs (_("\
4744 Using color to distinguish file types is disabled both by default and\n\
4745 with --color=never. With --color=auto, ls emits color codes only when\n\
4746 standard output is connected to a terminal. The LS_COLORS environment\n\
4747 variable can change the settings. Use the dircolors command to set it.\n\
4748 "), stdout);
4749 fputs (_("\
4751 Exit status:\n\
4752 0 if OK,\n\
4753 1 if minor problems (e.g., cannot access subdirectory),\n\
4754 2 if serious trouble (e.g., cannot access command-line argument).\n\
4755 "), stdout);
4756 emit_ancillary_info ();
4758 exit (status);