build: update gnulib submodule to latest
[coreutils.git] / src / ls.c
blobef708dfa3ee70d2ae74371f79c7fd804ebc24248
1 /* 'dir', 'vdir' and 'ls' directory listing programs for GNU.
2 Copyright (C) 1985-2015 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* If ls_mode is LS_MULTI_COL,
18 the multi-column format is the default regardless
19 of the type of output device.
20 This is for the 'dir' program.
22 If ls_mode is LS_LONG_FORMAT,
23 the long format is the default regardless of the
24 type of output device.
25 This is for the 'vdir' program.
27 If ls_mode is LS_LS,
28 the output format depends on whether the output
29 device is a terminal.
30 This is for the 'ls' program. */
32 /* Written by Richard Stallman and David MacKenzie. */
34 /* Color support by Peter Anvin <Peter.Anvin@linux.org> and Dennis
35 Flaherty <dennisf@denix.elk.miles.com> based on original patches by
36 Greg Lee <lee@uhunix.uhcc.hawaii.edu>. */
38 #include <config.h>
39 #include <sys/types.h>
41 #include <termios.h>
42 #if HAVE_STROPTS_H
43 # include <stropts.h>
44 #endif
45 #include <sys/ioctl.h>
47 #ifdef WINSIZE_IN_PTEM
48 # include <sys/stream.h>
49 # include <sys/ptem.h>
50 #endif
52 #include <stdio.h>
53 #include <assert.h>
54 #include <setjmp.h>
55 #include <pwd.h>
56 #include <getopt.h>
57 #include <signal.h>
58 #include <selinux/selinux.h>
59 #include <wchar.h>
61 #if HAVE_LANGINFO_CODESET
62 # include <langinfo.h>
63 #endif
65 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
66 present. */
67 #ifndef SA_NOCLDSTOP
68 # define SA_NOCLDSTOP 0
69 # define sigprocmask(How, Set, Oset) /* empty */
70 # define sigset_t int
71 # if ! HAVE_SIGINTERRUPT
72 # define siginterrupt(sig, flag) /* empty */
73 # endif
74 #endif
76 /* NonStop circa 2011 lacks both SA_RESTART and siginterrupt, so don't
77 restart syscalls after a signal handler fires. This may cause
78 colors to get messed up on the screen if 'ls' is interrupted, but
79 that's the best we can do on such a platform. */
80 #ifndef SA_RESTART
81 # define SA_RESTART 0
82 #endif
84 #include "system.h"
85 #include <fnmatch.h>
87 #include "acl.h"
88 #include "argmatch.h"
89 #include "dev-ino.h"
90 #include "error.h"
91 #include "filenamecat.h"
92 #include "hard-locale.h"
93 #include "hash.h"
94 #include "human.h"
95 #include "filemode.h"
96 #include "filevercmp.h"
97 #include "idcache.h"
98 #include "ls.h"
99 #include "mbswidth.h"
100 #include "mpsort.h"
101 #include "obstack.h"
102 #include "quote.h"
103 #include "quotearg.h"
104 #include "smack.h"
105 #include "stat-size.h"
106 #include "stat-time.h"
107 #include "strftime.h"
108 #include "xdectoint.h"
109 #include "xstrtol.h"
110 #include "areadlink.h"
111 #include "mbsalign.h"
112 #include "dircolors.h"
114 /* Include <sys/capability.h> last to avoid a clash of <sys/types.h>
115 include guards with some premature versions of libcap.
116 For more details, see <http://bugzilla.redhat.com/483548>. */
117 #ifdef HAVE_CAP
118 # include <sys/capability.h>
119 #endif
121 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
122 : (ls_mode == LS_MULTI_COL \
123 ? "dir" : "vdir"))
125 #define AUTHORS \
126 proper_name ("Richard M. Stallman"), \
127 proper_name ("David MacKenzie")
129 #define obstack_chunk_alloc malloc
130 #define obstack_chunk_free free
132 /* Return an int indicating the result of comparing two integers.
133 Subtracting doesn't always work, due to overflow. */
134 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
136 /* Unix-based readdir implementations have historically returned a dirent.d_ino
137 value that is sometimes not equal to the stat-obtained st_ino value for
138 that same entry. This error occurs for a readdir entry that refers
139 to a mount point. readdir's error is to return the inode number of
140 the underlying directory -- one that typically cannot be stat'ed, as
141 long as a file system is mounted on that directory. RELIABLE_D_INO
142 encapsulates whether we can use the more efficient approach of relying
143 on readdir-supplied d_ino values, or whether we must incur the cost of
144 calling stat or lstat to obtain each guaranteed-valid inode number. */
146 #ifndef READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
147 # define READDIR_LIES_ABOUT_MOUNTPOINT_D_INO 1
148 #endif
150 #if READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
151 # define RELIABLE_D_INO(dp) NOT_AN_INODE_NUMBER
152 #else
153 # define RELIABLE_D_INO(dp) D_INO (dp)
154 #endif
156 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
157 # define st_author st_uid
158 #endif
160 enum filetype
162 unknown,
163 fifo,
164 chardev,
165 directory,
166 blockdev,
167 normal,
168 symbolic_link,
169 sock,
170 whiteout,
171 arg_directory
174 /* Display letters and indicators for each filetype.
175 Keep these in sync with enum filetype. */
176 static char const filetype_letter[] = "?pcdb-lswd";
178 /* Ensure that filetype and filetype_letter have the same
179 number of elements. */
180 verify (sizeof filetype_letter - 1 == arg_directory + 1);
182 #define FILETYPE_INDICATORS \
184 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
185 C_LINK, C_SOCK, C_FILE, C_DIR \
188 enum acl_type
190 ACL_T_NONE,
191 ACL_T_LSM_CONTEXT_ONLY,
192 ACL_T_YES
195 struct fileinfo
197 /* The file name. */
198 char *name;
200 /* For symbolic link, name of the file linked to, otherwise zero. */
201 char *linkname;
203 struct stat stat;
205 enum filetype filetype;
207 /* For symbolic link and long listing, st_mode of file linked to, otherwise
208 zero. */
209 mode_t linkmode;
211 /* security context. */
212 char *scontext;
214 bool stat_ok;
216 /* For symbolic link and color printing, true if linked-to file
217 exists, otherwise false. */
218 bool linkok;
220 /* For long listings, true if the file has an access control list,
221 or a security context. */
222 enum acl_type acl_type;
224 /* For color listings, true if a regular file has capability info. */
225 bool has_capability;
228 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
230 /* Null is a valid character in a color indicator (think about Epson
231 printers, for example) so we have to use a length/buffer string
232 type. */
234 struct bin_str
236 size_t len; /* Number of bytes */
237 const char *string; /* Pointer to the same */
240 #if ! HAVE_TCGETPGRP
241 # define tcgetpgrp(Fd) 0
242 #endif
244 static size_t quote_name (FILE *out, const char *name,
245 struct quoting_options const *options,
246 size_t *width);
247 static char *make_link_name (char const *name, char const *linkname);
248 static int decode_switches (int argc, char **argv);
249 static bool file_ignored (char const *name);
250 static uintmax_t gobble_file (char const *name, enum filetype type,
251 ino_t inode, bool command_line_arg,
252 char const *dirname);
253 static bool print_color_indicator (const struct fileinfo *f,
254 bool symlink_target);
255 static void put_indicator (const struct bin_str *ind);
256 static void add_ignore_pattern (const char *pattern);
257 static void attach (char *dest, const char *dirname, const char *name);
258 static void clear_files (void);
259 static void extract_dirs_from_files (char const *dirname,
260 bool command_line_arg);
261 static void get_link_name (char const *filename, struct fileinfo *f,
262 bool command_line_arg);
263 static void indent (size_t from, size_t to);
264 static size_t calculate_columns (bool by_columns);
265 static void print_current_files (void);
266 static void print_dir (char const *name, char const *realname,
267 bool command_line_arg);
268 static size_t print_file_name_and_frills (const struct fileinfo *f,
269 size_t start_col);
270 static void print_horizontal (void);
271 static int format_user_width (uid_t u);
272 static int format_group_width (gid_t g);
273 static void print_long_format (const struct fileinfo *f);
274 static void print_many_per_line (void);
275 static size_t print_name_with_quoting (const struct fileinfo *f,
276 bool symlink_target,
277 struct obstack *stack,
278 size_t start_col);
279 static void prep_non_filename_text (void);
280 static bool print_type_indicator (bool stat_ok, mode_t mode,
281 enum filetype type);
282 static void print_with_separator (char sep);
283 static void queue_directory (char const *name, char const *realname,
284 bool command_line_arg);
285 static void sort_files (void);
286 static void parse_ls_color (void);
288 static void getenv_quoting_style (void);
290 /* Initial size of hash table.
291 Most hierarchies are likely to be shallower than this. */
292 #define INITIAL_TABLE_SIZE 30
294 /* The set of 'active' directories, from the current command-line argument
295 to the level in the hierarchy at which files are being listed.
296 A directory is represented by its device and inode numbers (struct dev_ino).
297 A directory is added to this set when ls begins listing it or its
298 entries, and it is removed from the set just after ls has finished
299 processing it. This set is used solely to detect loops, e.g., with
300 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
301 static Hash_table *active_dir_set;
303 #define LOOP_DETECT (!!active_dir_set)
305 /* The table of files in the current directory:
307 'cwd_file' points to a vector of 'struct fileinfo', one per file.
308 'cwd_n_alloc' is the number of elements space has been allocated for.
309 'cwd_n_used' is the number actually in use. */
311 /* Address of block containing the files that are described. */
312 static struct fileinfo *cwd_file;
314 /* Length of block that 'cwd_file' points to, measured in files. */
315 static size_t cwd_n_alloc;
317 /* Index of first unused slot in 'cwd_file'. */
318 static size_t cwd_n_used;
320 /* Vector of pointers to files, in proper sorted order, and the number
321 of entries allocated for it. */
322 static void **sorted_file;
323 static size_t sorted_file_alloc;
325 /* When true, in a color listing, color each symlink name according to the
326 type of file it points to. Otherwise, color them according to the 'ln'
327 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
328 regardless. This is set when 'ln=target' appears in LS_COLORS. */
330 static bool color_symlink_as_referent;
332 /* mode of appropriate file for colorization */
333 #define FILE_OR_LINK_MODE(File) \
334 ((color_symlink_as_referent && (File)->linkok) \
335 ? (File)->linkmode : (File)->stat.st_mode)
338 /* Record of one pending directory waiting to be listed. */
340 struct pending
342 char *name;
343 /* If the directory is actually the file pointed to by a symbolic link we
344 were told to list, 'realname' will contain the name of the symbolic
345 link, otherwise zero. */
346 char *realname;
347 bool command_line_arg;
348 struct pending *next;
351 static struct pending *pending_dirs;
353 /* Current time in seconds and nanoseconds since 1970, updated as
354 needed when deciding whether a file is recent. */
356 static struct timespec current_time;
358 static bool print_scontext;
359 static char UNKNOWN_SECURITY_CONTEXT[] = "?";
361 /* Whether any of the files has an ACL. This affects the width of the
362 mode column. */
364 static bool any_has_acl;
366 /* The number of columns to use for columns containing inode numbers,
367 block sizes, link counts, owners, groups, authors, major device
368 numbers, minor device numbers, and file sizes, respectively. */
370 static int inode_number_width;
371 static int block_size_width;
372 static int nlink_width;
373 static int scontext_width;
374 static int owner_width;
375 static int group_width;
376 static int author_width;
377 static int major_device_number_width;
378 static int minor_device_number_width;
379 static int file_size_width;
381 /* Option flags */
383 /* long_format for lots of info, one per line.
384 one_per_line for just names, one per line.
385 many_per_line for just names, many per line, sorted vertically.
386 horizontal for just names, many per line, sorted horizontally.
387 with_commas for just names, many per line, separated by commas.
389 -l (and other options that imply -l), -1, -C, -x and -m control
390 this parameter. */
392 enum format
394 long_format, /* -l and other options that imply -l */
395 one_per_line, /* -1 */
396 many_per_line, /* -C */
397 horizontal, /* -x */
398 with_commas /* -m */
401 static enum format format;
403 /* 'full-iso' uses full ISO-style dates and times. 'long-iso' uses longer
404 ISO-style time stamps, though shorter than 'full-iso'. 'iso' uses shorter
405 ISO-style time stamps. 'locale' uses locale-dependent time stamps. */
406 enum time_style
408 full_iso_time_style, /* --time-style=full-iso */
409 long_iso_time_style, /* --time-style=long-iso */
410 iso_time_style, /* --time-style=iso */
411 locale_time_style /* --time-style=locale */
414 static char const *const time_style_args[] =
416 "full-iso", "long-iso", "iso", "locale", NULL
418 static enum time_style const time_style_types[] =
420 full_iso_time_style, long_iso_time_style, iso_time_style,
421 locale_time_style
423 ARGMATCH_VERIFY (time_style_args, time_style_types);
425 /* Type of time to print or sort by. Controlled by -c and -u.
426 The values of each item of this enum are important since they are
427 used as indices in the sort functions array (see sort_files()). */
429 enum time_type
431 time_mtime, /* default */
432 time_ctime, /* -c */
433 time_atime, /* -u */
434 time_numtypes /* the number of elements of this enum */
437 static enum time_type time_type;
439 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
440 The values of each item of this enum are important since they are
441 used as indices in the sort functions array (see sort_files()). */
443 enum sort_type
445 sort_none = -1, /* -U */
446 sort_name, /* default */
447 sort_extension, /* -X */
448 sort_size, /* -S */
449 sort_version, /* -v */
450 sort_time, /* -t */
451 sort_numtypes /* the number of elements of this enum */
454 static enum sort_type sort_type;
456 /* Direction of sort.
457 false means highest first if numeric,
458 lowest first if alphabetic;
459 these are the defaults.
460 true means the opposite order in each case. -r */
462 static bool sort_reverse;
464 /* True means to display owner information. -g turns this off. */
466 static bool print_owner = true;
468 /* True means to display author information. */
470 static bool print_author;
472 /* True means to display group information. -G and -o turn this off. */
474 static bool print_group = true;
476 /* True means print the user and group id's as numbers rather
477 than as names. -n */
479 static bool numeric_ids;
481 /* True means mention the size in blocks of each file. -s */
483 static bool print_block_size;
485 /* Human-readable options for output, when printing block counts. */
486 static int human_output_opts;
488 /* The units to use when printing block counts. */
489 static uintmax_t output_block_size;
491 /* Likewise, but for file sizes. */
492 static int file_human_output_opts;
493 static uintmax_t file_output_block_size = 1;
495 /* Follow the output with a special string. Using this format,
496 Emacs' dired mode starts up twice as fast, and can handle all
497 strange characters in file names. */
498 static bool dired;
500 /* 'none' means don't mention the type of files.
501 'slash' means mention directories only, with a '/'.
502 'file_type' means mention file types.
503 'classify' means mention file types and mark executables.
505 Controlled by -F, -p, and --indicator-style. */
507 enum indicator_style
509 none, /* --indicator-style=none */
510 slash, /* -p, --indicator-style=slash */
511 file_type, /* --indicator-style=file-type */
512 classify /* -F, --indicator-style=classify */
515 static enum indicator_style indicator_style;
517 /* Names of indicator styles. */
518 static char const *const indicator_style_args[] =
520 "none", "slash", "file-type", "classify", NULL
522 static enum indicator_style const indicator_style_types[] =
524 none, slash, file_type, classify
526 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
528 /* True means use colors to mark types. Also define the different
529 colors as well as the stuff for the LS_COLORS environment variable.
530 The LS_COLORS variable is now in a termcap-like format. */
532 static bool print_with_color;
534 /* Whether we used any colors in the output so far. If so, we will
535 need to restore the default color later. If not, we will need to
536 call prep_non_filename_text before using color for the first time. */
538 static bool used_color = false;
540 enum color_type
542 color_never, /* 0: default or --color=never */
543 color_always, /* 1: --color=always */
544 color_if_tty /* 2: --color=tty */
547 enum Dereference_symlink
549 DEREF_UNDEFINED = 1,
550 DEREF_NEVER,
551 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
552 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
553 DEREF_ALWAYS /* -L */
556 enum indicator_no
558 C_LEFT, C_RIGHT, C_END, C_RESET, C_NORM, C_FILE, C_DIR, C_LINK,
559 C_FIFO, C_SOCK,
560 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
561 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE, C_CAP, C_MULTIHARDLINK,
562 C_CLR_TO_EOL
565 static const char *const indicator_name[]=
567 "lc", "rc", "ec", "rs", "no", "fi", "di", "ln", "pi", "so",
568 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
569 "ow", "tw", "ca", "mh", "cl", NULL
572 struct color_ext_type
574 struct bin_str ext; /* The extension we're looking for */
575 struct bin_str seq; /* The sequence to output when we do */
576 struct color_ext_type *next; /* Next in list */
579 static struct bin_str color_indicator[] =
581 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
582 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
583 { 0, NULL }, /* ec: End color (replaces lc+rs+rc) */
584 { LEN_STR_PAIR ("0") }, /* rs: Reset to ordinary colors */
585 { 0, NULL }, /* no: Normal */
586 { 0, NULL }, /* fi: File: default */
587 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
588 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
589 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
590 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
591 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
592 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
593 { 0, NULL }, /* mi: Missing file: undefined */
594 { 0, NULL }, /* or: Orphaned symlink: undefined */
595 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
596 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
597 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
598 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
599 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
600 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
601 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
602 { LEN_STR_PAIR ("30;41") }, /* ca: black on red */
603 { 0, NULL }, /* mh: disabled by default */
604 { LEN_STR_PAIR ("\033[K") }, /* cl: clear to end of line */
607 /* FIXME: comment */
608 static struct color_ext_type *color_ext_list = NULL;
610 /* Buffer for color sequences */
611 static char *color_buf;
613 /* True means to check for orphaned symbolic link, for displaying
614 colors. */
616 static bool check_symlink_color;
618 /* True means mention the inode number of each file. -i */
620 static bool print_inode;
622 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
623 other options that imply -l), and -L. */
625 static enum Dereference_symlink dereference;
627 /* True means when a directory is found, display info on its
628 contents. -R */
630 static bool recursive;
632 /* True means when an argument is a directory name, display info
633 on it itself. -d */
635 static bool immediate_dirs;
637 /* True means that directories are grouped before files. */
639 static bool directories_first;
641 /* Which files to ignore. */
643 static enum
645 /* Ignore files whose names start with '.', and files specified by
646 --hide and --ignore. */
647 IGNORE_DEFAULT,
649 /* Ignore '.', '..', and files specified by --ignore. */
650 IGNORE_DOT_AND_DOTDOT,
652 /* Ignore only files specified by --ignore. */
653 IGNORE_MINIMAL
654 } ignore_mode;
656 /* A linked list of shell-style globbing patterns. If a non-argument
657 file name matches any of these patterns, it is ignored.
658 Controlled by -I. Multiple -I options accumulate.
659 The -B option adds '*~' and '.*~' to this list. */
661 struct ignore_pattern
663 const char *pattern;
664 struct ignore_pattern *next;
667 static struct ignore_pattern *ignore_patterns;
669 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
670 variable itself to be ignored. */
671 static struct ignore_pattern *hide_patterns;
673 /* True means output nongraphic chars in file names as '?'.
674 (-q, --hide-control-chars)
675 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
676 independent. The algorithm is: first, obey the quoting style to get a
677 string representing the file name; then, if qmark_funny_chars is set,
678 replace all nonprintable chars in that string with '?'. It's necessary
679 to replace nonprintable chars even in quoted strings, because we don't
680 want to mess up the terminal if control chars get sent to it, and some
681 quoting methods pass through control chars as-is. */
682 static bool qmark_funny_chars;
684 /* Quoting options for file and dir name output. */
686 static struct quoting_options *filename_quoting_options;
687 static struct quoting_options *dirname_quoting_options;
689 /* The number of chars per hardware tab stop. Setting this to zero
690 inhibits the use of TAB characters for separating columns. -T */
691 static size_t tabsize;
693 /* True means print each directory name before listing it. */
695 static bool print_dir_name;
697 /* The line length to use for breaking lines in many-per-line format.
698 Can be set with -w. */
700 static size_t line_length;
702 /* The local time zone rules, as per the TZ environment variable. */
704 static timezone_t localtz;
706 /* If true, the file listing format requires that stat be called on
707 each file. */
709 static bool format_needs_stat;
711 /* Similar to 'format_needs_stat', but set if only the file type is
712 needed. */
714 static bool format_needs_type;
716 /* An arbitrary limit on the number of bytes in a printed time stamp.
717 This is set to a relatively small value to avoid the need to worry
718 about denial-of-service attacks on servers that run "ls" on behalf
719 of remote clients. 1000 bytes should be enough for any practical
720 time stamp format. */
722 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
724 /* strftime formats for non-recent and recent files, respectively, in
725 -l output. */
727 static char const *long_time_format[2] =
729 /* strftime format for non-recent files (older than 6 months), in
730 -l output. This should contain the year, month and day (at
731 least), in an order that is understood by people in your
732 locale's territory. Please try to keep the number of used
733 screen columns small, because many people work in windows with
734 only 80 columns. But make this as wide as the other string
735 below, for recent files. */
736 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
737 so be wary of using variable width fields from the locale.
738 Note %b is handled specially by ls and aligned correctly.
739 Note also that specifying a width as in %5b is erroneous as strftime
740 will count bytes rather than characters in multibyte locales. */
741 N_("%b %e %Y"),
742 /* strftime format for recent files (younger than 6 months), in -l
743 output. This should contain the month, day and time (at
744 least), in an order that is understood by people in your
745 locale's territory. Please try to keep the number of used
746 screen columns small, because many people work in windows with
747 only 80 columns. But make this as wide as the other string
748 above, for non-recent files. */
749 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
750 so be wary of using variable width fields from the locale.
751 Note %b is handled specially by ls and aligned correctly.
752 Note also that specifying a width as in %5b is erroneous as strftime
753 will count bytes rather than characters in multibyte locales. */
754 N_("%b %e %H:%M")
757 /* The set of signals that are caught. */
759 static sigset_t caught_signals;
761 /* If nonzero, the value of the pending fatal signal. */
763 static sig_atomic_t volatile interrupt_signal;
765 /* A count of the number of pending stop signals that have been received. */
767 static sig_atomic_t volatile stop_signal_count;
769 /* Desired exit status. */
771 static int exit_status;
773 /* Exit statuses. */
774 enum
776 /* "ls" had a minor problem. E.g., while processing a directory,
777 ls obtained the name of an entry via readdir, yet was later
778 unable to stat that name. This happens when listing a directory
779 in which entries are actively being removed or renamed. */
780 LS_MINOR_PROBLEM = 1,
782 /* "ls" had more serious trouble (e.g., memory exhausted, invalid
783 option or failure to stat a command line argument. */
784 LS_FAILURE = 2
787 /* For long options that have no equivalent short option, use a
788 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
789 enum
791 AUTHOR_OPTION = CHAR_MAX + 1,
792 BLOCK_SIZE_OPTION,
793 COLOR_OPTION,
794 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
795 FILE_TYPE_INDICATOR_OPTION,
796 FORMAT_OPTION,
797 FULL_TIME_OPTION,
798 GROUP_DIRECTORIES_FIRST_OPTION,
799 HIDE_OPTION,
800 INDICATOR_STYLE_OPTION,
801 QUOTING_STYLE_OPTION,
802 SHOW_CONTROL_CHARS_OPTION,
803 SI_OPTION,
804 SORT_OPTION,
805 TIME_OPTION,
806 TIME_STYLE_OPTION
809 static struct option const long_options[] =
811 {"all", no_argument, NULL, 'a'},
812 {"escape", no_argument, NULL, 'b'},
813 {"directory", no_argument, NULL, 'd'},
814 {"dired", no_argument, NULL, 'D'},
815 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
816 {"group-directories-first", no_argument, NULL,
817 GROUP_DIRECTORIES_FIRST_OPTION},
818 {"human-readable", no_argument, NULL, 'h'},
819 {"inode", no_argument, NULL, 'i'},
820 {"kibibytes", no_argument, NULL, 'k'},
821 {"numeric-uid-gid", no_argument, NULL, 'n'},
822 {"no-group", no_argument, NULL, 'G'},
823 {"hide-control-chars", no_argument, NULL, 'q'},
824 {"reverse", no_argument, NULL, 'r'},
825 {"size", no_argument, NULL, 's'},
826 {"width", required_argument, NULL, 'w'},
827 {"almost-all", no_argument, NULL, 'A'},
828 {"ignore-backups", no_argument, NULL, 'B'},
829 {"classify", no_argument, NULL, 'F'},
830 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
831 {"si", no_argument, NULL, SI_OPTION},
832 {"dereference-command-line", no_argument, NULL, 'H'},
833 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
834 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
835 {"hide", required_argument, NULL, HIDE_OPTION},
836 {"ignore", required_argument, NULL, 'I'},
837 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
838 {"dereference", no_argument, NULL, 'L'},
839 {"literal", no_argument, NULL, 'N'},
840 {"quote-name", no_argument, NULL, 'Q'},
841 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
842 {"recursive", no_argument, NULL, 'R'},
843 {"format", required_argument, NULL, FORMAT_OPTION},
844 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
845 {"sort", required_argument, NULL, SORT_OPTION},
846 {"tabsize", required_argument, NULL, 'T'},
847 {"time", required_argument, NULL, TIME_OPTION},
848 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
849 {"color", optional_argument, NULL, COLOR_OPTION},
850 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
851 {"context", no_argument, 0, 'Z'},
852 {"author", no_argument, NULL, AUTHOR_OPTION},
853 {GETOPT_HELP_OPTION_DECL},
854 {GETOPT_VERSION_OPTION_DECL},
855 {NULL, 0, NULL, 0}
858 static char const *const format_args[] =
860 "verbose", "long", "commas", "horizontal", "across",
861 "vertical", "single-column", NULL
863 static enum format const format_types[] =
865 long_format, long_format, with_commas, horizontal, horizontal,
866 many_per_line, one_per_line
868 ARGMATCH_VERIFY (format_args, format_types);
870 static char const *const sort_args[] =
872 "none", "time", "size", "extension", "version", NULL
874 static enum sort_type const sort_types[] =
876 sort_none, sort_time, sort_size, sort_extension, sort_version
878 ARGMATCH_VERIFY (sort_args, sort_types);
880 static char const *const time_args[] =
882 "atime", "access", "use", "ctime", "status", NULL
884 static enum time_type const time_types[] =
886 time_atime, time_atime, time_atime, time_ctime, time_ctime
888 ARGMATCH_VERIFY (time_args, time_types);
890 static char const *const color_args[] =
892 /* force and none are for compatibility with another color-ls version */
893 "always", "yes", "force",
894 "never", "no", "none",
895 "auto", "tty", "if-tty", NULL
897 static enum color_type const color_types[] =
899 color_always, color_always, color_always,
900 color_never, color_never, color_never,
901 color_if_tty, color_if_tty, color_if_tty
903 ARGMATCH_VERIFY (color_args, color_types);
905 /* Information about filling a column. */
906 struct column_info
908 bool valid_len;
909 size_t line_len;
910 size_t *col_arr;
913 /* Array with information about column filledness. */
914 static struct column_info *column_info;
916 /* Maximum number of columns ever possible for this display. */
917 static size_t max_idx;
919 /* The minimum width of a column is 3: 1 character for the name and 2
920 for the separating white space. */
921 #define MIN_COLUMN_WIDTH 3
924 /* This zero-based index is used solely with the --dired option.
925 When that option is in effect, this counter is incremented for each
926 byte of output generated by this program so that the beginning
927 and ending indices (in that output) of every file name can be recorded
928 and later output themselves. */
929 static size_t dired_pos;
931 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
933 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
934 #define DIRED_FPUTS(s, stream, s_len) \
935 do {fputs (s, stream); dired_pos += s_len;} while (0)
937 /* Like DIRED_FPUTS, but for use when S is a literal string. */
938 #define DIRED_FPUTS_LITERAL(s, stream) \
939 do {fputs (s, stream); dired_pos += sizeof (s) - 1;} while (0)
941 #define DIRED_INDENT() \
942 do \
944 if (dired) \
945 DIRED_FPUTS_LITERAL (" ", stdout); \
947 while (0)
949 /* With --dired, store pairs of beginning and ending indices of filenames. */
950 static struct obstack dired_obstack;
952 /* With --dired, store pairs of beginning and ending indices of any
953 directory names that appear as headers (just before 'total' line)
954 for lists of directory entries. Such directory names are seen when
955 listing hierarchies using -R and when a directory is listed with at
956 least one other command line argument. */
957 static struct obstack subdired_obstack;
959 /* Save the current index on the specified obstack, OBS. */
960 #define PUSH_CURRENT_DIRED_POS(obs) \
961 do \
963 if (dired) \
964 obstack_grow (obs, &dired_pos, sizeof (dired_pos)); \
966 while (0)
968 /* With -R, this stack is used to help detect directory cycles.
969 The device/inode pairs on this stack mirror the pairs in the
970 active_dir_set hash table. */
971 static struct obstack dev_ino_obstack;
973 /* Push a pair onto the device/inode stack. */
974 static void
975 dev_ino_push (dev_t dev, ino_t ino)
977 void *vdi;
978 struct dev_ino *di;
979 int dev_ino_size = sizeof *di;
980 obstack_blank (&dev_ino_obstack, dev_ino_size);
981 vdi = obstack_next_free (&dev_ino_obstack);
982 di = vdi;
983 di--;
984 di->st_dev = dev;
985 di->st_ino = ino;
988 /* Pop a dev/ino struct off the global dev_ino_obstack
989 and return that struct. */
990 static struct dev_ino
991 dev_ino_pop (void)
993 void *vdi;
994 struct dev_ino *di;
995 int dev_ino_size = sizeof *di;
996 assert (dev_ino_size <= obstack_object_size (&dev_ino_obstack));
997 obstack_blank_fast (&dev_ino_obstack, -dev_ino_size);
998 vdi = obstack_next_free (&dev_ino_obstack);
999 di = vdi;
1000 return *di;
1003 /* Note the use commented out below:
1004 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
1005 do \
1007 struct stat sb; \
1008 assert (Name); \
1009 assert (0 <= stat (Name, &sb)); \
1010 assert (sb.st_dev == Di.st_dev); \
1011 assert (sb.st_ino == Di.st_ino); \
1013 while (0)
1016 /* Write to standard output PREFIX, followed by the quoting style and
1017 a space-separated list of the integers stored in OS all on one line. */
1019 static void
1020 dired_dump_obstack (const char *prefix, struct obstack *os)
1022 size_t n_pos;
1024 n_pos = obstack_object_size (os) / sizeof (dired_pos);
1025 if (n_pos > 0)
1027 size_t i;
1028 size_t *pos;
1030 pos = (size_t *) obstack_finish (os);
1031 fputs (prefix, stdout);
1032 for (i = 0; i < n_pos; i++)
1033 printf (" %lu", (unsigned long int) pos[i]);
1034 putchar ('\n');
1038 /* Read the abbreviated month names from the locale, to align them
1039 and to determine the max width of the field and to truncate names
1040 greater than our max allowed.
1041 Note even though this handles multibyte locales correctly
1042 it's not restricted to them as single byte locales can have
1043 variable width abbreviated months and also precomputing/caching
1044 the names was seen to increase the performance of ls significantly. */
1046 /* max number of display cells to use */
1047 enum { MAX_MON_WIDTH = 5 };
1048 /* In the unlikely event that the abmon[] storage is not big enough
1049 an error message will be displayed, and we revert to using
1050 unmodified abbreviated month names from the locale database. */
1051 static char abmon[12][MAX_MON_WIDTH * 2 * MB_LEN_MAX + 1];
1052 /* minimum width needed to align %b, 0 => don't use precomputed values. */
1053 static size_t required_mon_width;
1055 static size_t
1056 abmon_init (void)
1058 #ifdef HAVE_NL_LANGINFO
1059 required_mon_width = MAX_MON_WIDTH;
1060 size_t curr_max_width;
1063 curr_max_width = required_mon_width;
1064 required_mon_width = 0;
1065 for (int i = 0; i < 12; i++)
1067 size_t width = curr_max_width;
1069 size_t req = mbsalign (nl_langinfo (ABMON_1 + i),
1070 abmon[i], sizeof (abmon[i]),
1071 &width, MBS_ALIGN_LEFT, 0);
1073 if (req == (size_t) -1 || req >= sizeof (abmon[i]))
1075 required_mon_width = 0; /* ignore precomputed strings. */
1076 return required_mon_width;
1079 required_mon_width = MAX (required_mon_width, width);
1082 while (curr_max_width > required_mon_width);
1083 #endif
1085 return required_mon_width;
1088 static size_t
1089 dev_ino_hash (void const *x, size_t table_size)
1091 struct dev_ino const *p = x;
1092 return (uintmax_t) p->st_ino % table_size;
1095 static bool
1096 dev_ino_compare (void const *x, void const *y)
1098 struct dev_ino const *a = x;
1099 struct dev_ino const *b = y;
1100 return SAME_INODE (*a, *b) ? true : false;
1103 static void
1104 dev_ino_free (void *x)
1106 free (x);
1109 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
1110 active directories. Return true if there is already a matching
1111 entry in the table. */
1113 static bool
1114 visit_dir (dev_t dev, ino_t ino)
1116 struct dev_ino *ent;
1117 struct dev_ino *ent_from_table;
1118 bool found_match;
1120 ent = xmalloc (sizeof *ent);
1121 ent->st_ino = ino;
1122 ent->st_dev = dev;
1124 /* Attempt to insert this entry into the table. */
1125 ent_from_table = hash_insert (active_dir_set, ent);
1127 if (ent_from_table == NULL)
1129 /* Insertion failed due to lack of memory. */
1130 xalloc_die ();
1133 found_match = (ent_from_table != ent);
1135 if (found_match)
1137 /* ent was not inserted, so free it. */
1138 free (ent);
1141 return found_match;
1144 static void
1145 free_pending_ent (struct pending *p)
1147 free (p->name);
1148 free (p->realname);
1149 free (p);
1152 static bool
1153 is_colored (enum indicator_no type)
1155 size_t len = color_indicator[type].len;
1156 char const *s = color_indicator[type].string;
1157 return ! (len == 0
1158 || (len == 1 && STRNCMP_LIT (s, "0") == 0)
1159 || (len == 2 && STRNCMP_LIT (s, "00") == 0));
1162 static void
1163 restore_default_color (void)
1165 put_indicator (&color_indicator[C_LEFT]);
1166 put_indicator (&color_indicator[C_RIGHT]);
1169 static void
1170 set_normal_color (void)
1172 if (print_with_color && is_colored (C_NORM))
1174 put_indicator (&color_indicator[C_LEFT]);
1175 put_indicator (&color_indicator[C_NORM]);
1176 put_indicator (&color_indicator[C_RIGHT]);
1180 /* An ordinary signal was received; arrange for the program to exit. */
1182 static void
1183 sighandler (int sig)
1185 if (! SA_NOCLDSTOP)
1186 signal (sig, SIG_IGN);
1187 if (! interrupt_signal)
1188 interrupt_signal = sig;
1191 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1193 static void
1194 stophandler (int sig)
1196 if (! SA_NOCLDSTOP)
1197 signal (sig, stophandler);
1198 if (! interrupt_signal)
1199 stop_signal_count++;
1202 /* Process any pending signals. If signals are caught, this function
1203 should be called periodically. Ideally there should never be an
1204 unbounded amount of time when signals are not being processed.
1205 Signal handling can restore the default colors, so callers must
1206 immediately change colors after invoking this function. */
1208 static void
1209 process_signals (void)
1211 while (interrupt_signal || stop_signal_count)
1213 int sig;
1214 int stops;
1215 sigset_t oldset;
1217 if (used_color)
1218 restore_default_color ();
1219 fflush (stdout);
1221 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1223 /* Reload interrupt_signal and stop_signal_count, in case a new
1224 signal was handled before sigprocmask took effect. */
1225 sig = interrupt_signal;
1226 stops = stop_signal_count;
1228 /* SIGTSTP is special, since the application can receive that signal
1229 more than once. In this case, don't set the signal handler to the
1230 default. Instead, just raise the uncatchable SIGSTOP. */
1231 if (stops)
1233 stop_signal_count = stops - 1;
1234 sig = SIGSTOP;
1236 else
1237 signal (sig, SIG_DFL);
1239 /* Exit or suspend the program. */
1240 raise (sig);
1241 sigprocmask (SIG_SETMASK, &oldset, NULL);
1243 /* If execution reaches here, then the program has been
1244 continued (after being suspended). */
1249 main (int argc, char **argv)
1251 int i;
1252 struct pending *thispend;
1253 int n_files;
1255 /* The signals that are trapped, and the number of such signals. */
1256 static int const sig[] =
1258 /* This one is handled specially. */
1259 SIGTSTP,
1261 /* The usual suspects. */
1262 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1263 #ifdef SIGPOLL
1264 SIGPOLL,
1265 #endif
1266 #ifdef SIGPROF
1267 SIGPROF,
1268 #endif
1269 #ifdef SIGVTALRM
1270 SIGVTALRM,
1271 #endif
1272 #ifdef SIGXCPU
1273 SIGXCPU,
1274 #endif
1275 #ifdef SIGXFSZ
1276 SIGXFSZ,
1277 #endif
1279 enum { nsigs = ARRAY_CARDINALITY (sig) };
1281 #if ! SA_NOCLDSTOP
1282 bool caught_sig[nsigs];
1283 #endif
1285 initialize_main (&argc, &argv);
1286 set_program_name (argv[0]);
1287 setlocale (LC_ALL, "");
1288 bindtextdomain (PACKAGE, LOCALEDIR);
1289 textdomain (PACKAGE);
1291 initialize_exit_failure (LS_FAILURE);
1292 atexit (close_stdout);
1294 assert (ARRAY_CARDINALITY (color_indicator) + 1
1295 == ARRAY_CARDINALITY (indicator_name));
1297 exit_status = EXIT_SUCCESS;
1298 print_dir_name = true;
1299 pending_dirs = NULL;
1301 current_time.tv_sec = TYPE_MINIMUM (time_t);
1302 current_time.tv_nsec = -1;
1304 i = decode_switches (argc, argv);
1306 if (print_with_color)
1307 parse_ls_color ();
1309 /* Test print_with_color again, because the call to parse_ls_color
1310 may have just reset it -- e.g., if LS_COLORS is invalid. */
1311 if (print_with_color)
1313 /* Avoid following symbolic links when possible. */
1314 if (is_colored (C_ORPHAN)
1315 || (is_colored (C_EXEC) && color_symlink_as_referent)
1316 || (is_colored (C_MISSING) && format == long_format))
1317 check_symlink_color = true;
1319 /* If the standard output is a controlling terminal, watch out
1320 for signals, so that the colors can be restored to the
1321 default state if "ls" is suspended or interrupted. */
1323 if (0 <= tcgetpgrp (STDOUT_FILENO))
1325 int j;
1326 #if SA_NOCLDSTOP
1327 struct sigaction act;
1329 sigemptyset (&caught_signals);
1330 for (j = 0; j < nsigs; j++)
1332 sigaction (sig[j], NULL, &act);
1333 if (act.sa_handler != SIG_IGN)
1334 sigaddset (&caught_signals, sig[j]);
1337 act.sa_mask = caught_signals;
1338 act.sa_flags = SA_RESTART;
1340 for (j = 0; j < nsigs; j++)
1341 if (sigismember (&caught_signals, sig[j]))
1343 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1344 sigaction (sig[j], &act, NULL);
1346 #else
1347 for (j = 0; j < nsigs; j++)
1349 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1350 if (caught_sig[j])
1352 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1353 siginterrupt (sig[j], 0);
1356 #endif
1360 if (dereference == DEREF_UNDEFINED)
1361 dereference = ((immediate_dirs
1362 || indicator_style == classify
1363 || format == long_format)
1364 ? DEREF_NEVER
1365 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1367 /* When using -R, initialize a data structure we'll use to
1368 detect any directory cycles. */
1369 if (recursive)
1371 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, NULL,
1372 dev_ino_hash,
1373 dev_ino_compare,
1374 dev_ino_free);
1375 if (active_dir_set == NULL)
1376 xalloc_die ();
1378 obstack_init (&dev_ino_obstack);
1381 localtz = tzalloc (getenv ("TZ"));
1383 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1384 || format == long_format
1385 || print_scontext
1386 || print_block_size;
1387 format_needs_type = (! format_needs_stat
1388 && (recursive
1389 || print_with_color
1390 || indicator_style != none
1391 || directories_first));
1393 if (dired)
1395 obstack_init (&dired_obstack);
1396 obstack_init (&subdired_obstack);
1399 cwd_n_alloc = 100;
1400 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1401 cwd_n_used = 0;
1403 clear_files ();
1405 n_files = argc - i;
1407 if (n_files <= 0)
1409 if (immediate_dirs)
1410 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1411 else
1412 queue_directory (".", NULL, true);
1414 else
1416 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1417 while (i < argc);
1419 if (cwd_n_used)
1421 sort_files ();
1422 if (!immediate_dirs)
1423 extract_dirs_from_files (NULL, true);
1424 /* 'cwd_n_used' might be zero now. */
1427 /* In the following if/else blocks, it is sufficient to test 'pending_dirs'
1428 (and not pending_dirs->name) because there may be no markers in the queue
1429 at this point. A marker may be enqueued when extract_dirs_from_files is
1430 called with a non-empty string or via print_dir. */
1431 if (cwd_n_used)
1433 print_current_files ();
1434 if (pending_dirs)
1435 DIRED_PUTCHAR ('\n');
1437 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1438 print_dir_name = false;
1440 while (pending_dirs)
1442 thispend = pending_dirs;
1443 pending_dirs = pending_dirs->next;
1445 if (LOOP_DETECT)
1447 if (thispend->name == NULL)
1449 /* thispend->name == NULL means this is a marker entry
1450 indicating we've finished processing the directory.
1451 Use its dev/ino numbers to remove the corresponding
1452 entry from the active_dir_set hash table. */
1453 struct dev_ino di = dev_ino_pop ();
1454 struct dev_ino *found = hash_delete (active_dir_set, &di);
1455 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1456 assert (found);
1457 dev_ino_free (found);
1458 free_pending_ent (thispend);
1459 continue;
1463 print_dir (thispend->name, thispend->realname,
1464 thispend->command_line_arg);
1466 free_pending_ent (thispend);
1467 print_dir_name = true;
1470 if (print_with_color)
1472 int j;
1474 if (used_color)
1476 /* Skip the restore when it would be a no-op, i.e.,
1477 when left is "\033[" and right is "m". */
1478 if (!(color_indicator[C_LEFT].len == 2
1479 && memcmp (color_indicator[C_LEFT].string, "\033[", 2) == 0
1480 && color_indicator[C_RIGHT].len == 1
1481 && color_indicator[C_RIGHT].string[0] == 'm'))
1482 restore_default_color ();
1484 fflush (stdout);
1486 /* Restore the default signal handling. */
1487 #if SA_NOCLDSTOP
1488 for (j = 0; j < nsigs; j++)
1489 if (sigismember (&caught_signals, sig[j]))
1490 signal (sig[j], SIG_DFL);
1491 #else
1492 for (j = 0; j < nsigs; j++)
1493 if (caught_sig[j])
1494 signal (sig[j], SIG_DFL);
1495 #endif
1497 /* Act on any signals that arrived before the default was restored.
1498 This can process signals out of order, but there doesn't seem to
1499 be an easy way to do them in order, and the order isn't that
1500 important anyway. */
1501 for (j = stop_signal_count; j; j--)
1502 raise (SIGSTOP);
1503 j = interrupt_signal;
1504 if (j)
1505 raise (j);
1508 if (dired)
1510 /* No need to free these since we're about to exit. */
1511 dired_dump_obstack ("//DIRED//", &dired_obstack);
1512 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1513 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1514 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1517 if (LOOP_DETECT)
1519 assert (hash_get_n_entries (active_dir_set) == 0);
1520 hash_free (active_dir_set);
1523 return exit_status;
1526 /* Set the line length to the value given by SPEC. Return true if
1527 successful. 0 means no limit on line length. */
1529 static bool
1530 set_line_length (char const *spec)
1532 uintmax_t val;
1534 /* Treat too-large values as if they were SIZE_MAX, which is
1535 effectively infinity. */
1536 switch (xstrtoumax (spec, NULL, 0, &val, ""))
1538 case LONGINT_OK:
1539 line_length = MIN (val, SIZE_MAX);
1540 return true;
1542 case LONGINT_OVERFLOW:
1543 line_length = SIZE_MAX;
1544 return true;
1546 default:
1547 return false;
1551 /* Set all the option flags according to the switches specified.
1552 Return the index of the first non-option argument. */
1554 static int
1555 decode_switches (int argc, char **argv)
1557 char *time_style_option = NULL;
1559 bool sort_type_specified = false;
1560 bool kibibytes_specified = false;
1562 qmark_funny_chars = false;
1564 /* initialize all switches to default settings */
1566 switch (ls_mode)
1568 case LS_MULTI_COL:
1569 /* This is for the 'dir' program. */
1570 format = many_per_line;
1571 set_quoting_style (NULL, escape_quoting_style);
1572 break;
1574 case LS_LONG_FORMAT:
1575 /* This is for the 'vdir' program. */
1576 format = long_format;
1577 set_quoting_style (NULL, escape_quoting_style);
1578 break;
1580 case LS_LS:
1581 /* This is for the 'ls' program. */
1582 if (isatty (STDOUT_FILENO))
1584 format = many_per_line;
1585 /* See description of qmark_funny_chars, above. */
1586 qmark_funny_chars = true;
1588 else
1590 format = one_per_line;
1591 qmark_funny_chars = false;
1593 break;
1595 default:
1596 abort ();
1599 time_type = time_mtime;
1600 sort_type = sort_name;
1601 sort_reverse = false;
1602 numeric_ids = false;
1603 print_block_size = false;
1604 indicator_style = none;
1605 print_inode = false;
1606 dereference = DEREF_UNDEFINED;
1607 recursive = false;
1608 immediate_dirs = false;
1609 ignore_mode = IGNORE_DEFAULT;
1610 ignore_patterns = NULL;
1611 hide_patterns = NULL;
1612 print_scontext = false;
1614 getenv_quoting_style ();
1616 line_length = 80;
1618 char const *p = getenv ("COLUMNS");
1619 if (p && *p && ! set_line_length (p))
1620 error (0, 0,
1621 _("ignoring invalid width in environment variable COLUMNS: %s"),
1622 quote (p));
1625 #ifdef TIOCGWINSZ
1627 struct winsize ws;
1629 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1630 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1631 line_length = ws.ws_col;
1633 #endif
1636 char const *p = getenv ("TABSIZE");
1637 tabsize = 8;
1638 if (p)
1640 unsigned long int tmp_ulong;
1641 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1642 && tmp_ulong <= SIZE_MAX)
1644 tabsize = tmp_ulong;
1646 else
1648 error (0, 0,
1649 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1650 quote (p));
1655 while (true)
1657 int oi = -1;
1658 int c = getopt_long (argc, argv,
1659 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1660 long_options, &oi);
1661 if (c == -1)
1662 break;
1664 switch (c)
1666 case 'a':
1667 ignore_mode = IGNORE_MINIMAL;
1668 break;
1670 case 'b':
1671 set_quoting_style (NULL, escape_quoting_style);
1672 break;
1674 case 'c':
1675 time_type = time_ctime;
1676 break;
1678 case 'd':
1679 immediate_dirs = true;
1680 break;
1682 case 'f':
1683 /* Same as enabling -a -U and disabling -l -s. */
1684 ignore_mode = IGNORE_MINIMAL;
1685 sort_type = sort_none;
1686 sort_type_specified = true;
1687 /* disable -l */
1688 if (format == long_format)
1689 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1690 print_block_size = false; /* disable -s */
1691 print_with_color = false; /* disable --color */
1692 break;
1694 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1695 indicator_style = file_type;
1696 break;
1698 case 'g':
1699 format = long_format;
1700 print_owner = false;
1701 break;
1703 case 'h':
1704 file_human_output_opts = human_output_opts =
1705 human_autoscale | human_SI | human_base_1024;
1706 file_output_block_size = output_block_size = 1;
1707 break;
1709 case 'i':
1710 print_inode = true;
1711 break;
1713 case 'k':
1714 kibibytes_specified = true;
1715 break;
1717 case 'l':
1718 format = long_format;
1719 break;
1721 case 'm':
1722 format = with_commas;
1723 break;
1725 case 'n':
1726 numeric_ids = true;
1727 format = long_format;
1728 break;
1730 case 'o': /* Just like -l, but don't display group info. */
1731 format = long_format;
1732 print_group = false;
1733 break;
1735 case 'p':
1736 indicator_style = slash;
1737 break;
1739 case 'q':
1740 qmark_funny_chars = true;
1741 break;
1743 case 'r':
1744 sort_reverse = true;
1745 break;
1747 case 's':
1748 print_block_size = true;
1749 break;
1751 case 't':
1752 sort_type = sort_time;
1753 sort_type_specified = true;
1754 break;
1756 case 'u':
1757 time_type = time_atime;
1758 break;
1760 case 'v':
1761 sort_type = sort_version;
1762 sort_type_specified = true;
1763 break;
1765 case 'w':
1766 if (! set_line_length (optarg))
1767 error (LS_FAILURE, 0, "%s: %s", _("invalid line width"),
1768 quote (optarg));
1769 break;
1771 case 'x':
1772 format = horizontal;
1773 break;
1775 case 'A':
1776 if (ignore_mode == IGNORE_DEFAULT)
1777 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1778 break;
1780 case 'B':
1781 add_ignore_pattern ("*~");
1782 add_ignore_pattern (".*~");
1783 break;
1785 case 'C':
1786 format = many_per_line;
1787 break;
1789 case 'D':
1790 dired = true;
1791 break;
1793 case 'F':
1794 indicator_style = classify;
1795 break;
1797 case 'G': /* inhibit display of group info */
1798 print_group = false;
1799 break;
1801 case 'H':
1802 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1803 break;
1805 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1806 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1807 break;
1809 case 'I':
1810 add_ignore_pattern (optarg);
1811 break;
1813 case 'L':
1814 dereference = DEREF_ALWAYS;
1815 break;
1817 case 'N':
1818 set_quoting_style (NULL, literal_quoting_style);
1819 break;
1821 case 'Q':
1822 set_quoting_style (NULL, c_quoting_style);
1823 break;
1825 case 'R':
1826 recursive = true;
1827 break;
1829 case 'S':
1830 sort_type = sort_size;
1831 sort_type_specified = true;
1832 break;
1834 case 'T':
1835 tabsize = xnumtoumax (optarg, 0, 0, SIZE_MAX, "",
1836 _("invalid tab size"), LS_FAILURE);
1837 break;
1839 case 'U':
1840 sort_type = sort_none;
1841 sort_type_specified = true;
1842 break;
1844 case 'X':
1845 sort_type = sort_extension;
1846 sort_type_specified = true;
1847 break;
1849 case '1':
1850 /* -1 has no effect after -l. */
1851 if (format != long_format)
1852 format = one_per_line;
1853 break;
1855 case AUTHOR_OPTION:
1856 print_author = true;
1857 break;
1859 case HIDE_OPTION:
1861 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1862 hide->pattern = optarg;
1863 hide->next = hide_patterns;
1864 hide_patterns = hide;
1866 break;
1868 case SORT_OPTION:
1869 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1870 sort_type_specified = true;
1871 break;
1873 case GROUP_DIRECTORIES_FIRST_OPTION:
1874 directories_first = true;
1875 break;
1877 case TIME_OPTION:
1878 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1879 break;
1881 case FORMAT_OPTION:
1882 format = XARGMATCH ("--format", optarg, format_args, format_types);
1883 break;
1885 case FULL_TIME_OPTION:
1886 format = long_format;
1887 time_style_option = bad_cast ("full-iso");
1888 break;
1890 case COLOR_OPTION:
1892 int i;
1893 if (optarg)
1894 i = XARGMATCH ("--color", optarg, color_args, color_types);
1895 else
1896 /* Using --color with no argument is equivalent to using
1897 --color=always. */
1898 i = color_always;
1900 print_with_color = (i == color_always
1901 || (i == color_if_tty
1902 && isatty (STDOUT_FILENO)));
1904 if (print_with_color)
1906 /* Don't use TAB characters in output. Some terminal
1907 emulators can't handle the combination of tabs and
1908 color codes on the same line. */
1909 tabsize = 0;
1911 break;
1914 case INDICATOR_STYLE_OPTION:
1915 indicator_style = XARGMATCH ("--indicator-style", optarg,
1916 indicator_style_args,
1917 indicator_style_types);
1918 break;
1920 case QUOTING_STYLE_OPTION:
1921 set_quoting_style (NULL,
1922 XARGMATCH ("--quoting-style", optarg,
1923 quoting_style_args,
1924 quoting_style_vals));
1925 break;
1927 case TIME_STYLE_OPTION:
1928 time_style_option = optarg;
1929 break;
1931 case SHOW_CONTROL_CHARS_OPTION:
1932 qmark_funny_chars = false;
1933 break;
1935 case BLOCK_SIZE_OPTION:
1937 enum strtol_error e = human_options (optarg, &human_output_opts,
1938 &output_block_size);
1939 if (e != LONGINT_OK)
1940 xstrtol_fatal (e, oi, 0, long_options, optarg);
1941 file_human_output_opts = human_output_opts;
1942 file_output_block_size = output_block_size;
1944 break;
1946 case SI_OPTION:
1947 file_human_output_opts = human_output_opts =
1948 human_autoscale | human_SI;
1949 file_output_block_size = output_block_size = 1;
1950 break;
1952 case 'Z':
1953 print_scontext = true;
1954 break;
1956 case_GETOPT_HELP_CHAR;
1958 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1960 default:
1961 usage (LS_FAILURE);
1965 if (! output_block_size)
1967 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1968 human_options (ls_block_size,
1969 &human_output_opts, &output_block_size);
1970 if (ls_block_size || getenv ("BLOCK_SIZE"))
1972 file_human_output_opts = human_output_opts;
1973 file_output_block_size = output_block_size;
1975 if (kibibytes_specified)
1977 human_output_opts = 0;
1978 output_block_size = 1024;
1982 /* Determine the max possible number of display columns. */
1983 max_idx = line_length / MIN_COLUMN_WIDTH;
1984 /* Account for first display column not having a separator,
1985 or line_lengths shorter than MIN_COLUMN_WIDTH. */
1986 max_idx += line_length % MIN_COLUMN_WIDTH != 0;
1988 filename_quoting_options = clone_quoting_options (NULL);
1989 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1990 set_char_quoting (filename_quoting_options, ' ', 1);
1991 if (file_type <= indicator_style)
1993 char const *p;
1994 for (p = &"*=>@|"[indicator_style - file_type]; *p; p++)
1995 set_char_quoting (filename_quoting_options, *p, 1);
1998 dirname_quoting_options = clone_quoting_options (NULL);
1999 set_char_quoting (dirname_quoting_options, ':', 1);
2001 /* --dired is meaningful only with --format=long (-l).
2002 Otherwise, ignore it. FIXME: warn about this?
2003 Alternatively, make --dired imply --format=long? */
2004 if (dired && format != long_format)
2005 dired = false;
2007 /* If -c or -u is specified and not -l (or any other option that implies -l),
2008 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
2009 The behavior of ls when using either -c or -u but with neither -l nor -t
2010 appears to be unspecified by POSIX. So, with GNU ls, '-u' alone means
2011 sort by atime (this is the one that's not specified by the POSIX spec),
2012 -lu means show atime and sort by name, -lut means show atime and sort
2013 by atime. */
2015 if ((time_type == time_ctime || time_type == time_atime)
2016 && !sort_type_specified && format != long_format)
2018 sort_type = sort_time;
2021 if (format == long_format)
2023 char *style = time_style_option;
2024 static char const posix_prefix[] = "posix-";
2026 if (! style)
2027 if (! (style = getenv ("TIME_STYLE")))
2028 style = bad_cast ("locale");
2030 while (STREQ_LEN (style, posix_prefix, sizeof posix_prefix - 1))
2032 if (! hard_locale (LC_TIME))
2033 return optind;
2034 style += sizeof posix_prefix - 1;
2037 if (*style == '+')
2039 char *p0 = style + 1;
2040 char *p1 = strchr (p0, '\n');
2041 if (! p1)
2042 p1 = p0;
2043 else
2045 if (strchr (p1 + 1, '\n'))
2046 error (LS_FAILURE, 0, _("invalid time style format %s"),
2047 quote (p0));
2048 *p1++ = '\0';
2050 long_time_format[0] = p0;
2051 long_time_format[1] = p1;
2053 else
2055 ptrdiff_t res = argmatch (style, time_style_args,
2056 (char const *) time_style_types,
2057 sizeof (*time_style_types));
2058 if (res < 0)
2060 /* This whole block used to be a simple use of XARGMATCH.
2061 but that didn't print the "posix-"-prefixed variants or
2062 the "+"-prefixed format string option upon failure. */
2063 argmatch_invalid ("time style", style, res);
2065 /* The following is a manual expansion of argmatch_valid,
2066 but with the added "+ ..." description and the [posix-]
2067 prefixes prepended. Note that this simplification works
2068 only because all four existing time_style_types values
2069 are distinct. */
2070 fputs (_("Valid arguments are:\n"), stderr);
2071 char const *const *p = time_style_args;
2072 while (*p)
2073 fprintf (stderr, " - [posix-]%s\n", *p++);
2074 fputs (_(" - +FORMAT (e.g., +%H:%M) for a 'date'-style"
2075 " format\n"), stderr);
2076 usage (LS_FAILURE);
2078 switch (res)
2080 case full_iso_time_style:
2081 long_time_format[0] = long_time_format[1] =
2082 "%Y-%m-%d %H:%M:%S.%N %z";
2083 break;
2085 case long_iso_time_style:
2086 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
2087 break;
2089 case iso_time_style:
2090 long_time_format[0] = "%Y-%m-%d ";
2091 long_time_format[1] = "%m-%d %H:%M";
2092 break;
2094 case locale_time_style:
2095 if (hard_locale (LC_TIME))
2097 int i;
2098 for (i = 0; i < 2; i++)
2099 long_time_format[i] =
2100 dcgettext (NULL, long_time_format[i], LC_TIME);
2105 /* Note we leave %5b etc. alone so user widths/flags are honored. */
2106 if (strstr (long_time_format[0], "%b")
2107 || strstr (long_time_format[1], "%b"))
2108 if (!abmon_init ())
2109 error (0, 0, _("error initializing month strings"));
2112 return optind;
2115 /* Parse a string as part of the LS_COLORS variable; this may involve
2116 decoding all kinds of escape characters. If equals_end is set an
2117 unescaped equal sign ends the string, otherwise only a : or \0
2118 does. Set *OUTPUT_COUNT to the number of bytes output. Return
2119 true if successful.
2121 The resulting string is *not* null-terminated, but may contain
2122 embedded nulls.
2124 Note that both dest and src are char **; on return they point to
2125 the first free byte after the array and the character that ended
2126 the input string, respectively. */
2128 static bool
2129 get_funky_string (char **dest, const char **src, bool equals_end,
2130 size_t *output_count)
2132 char num; /* For numerical codes */
2133 size_t count; /* Something to count with */
2134 enum {
2135 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
2136 } state;
2137 const char *p;
2138 char *q;
2140 p = *src; /* We don't want to double-indirect */
2141 q = *dest; /* the whole darn time. */
2143 count = 0; /* No characters counted in yet. */
2144 num = 0;
2146 state = ST_GND; /* Start in ground state. */
2147 while (state < ST_END)
2149 switch (state)
2151 case ST_GND: /* Ground state (no escapes) */
2152 switch (*p)
2154 case ':':
2155 case '\0':
2156 state = ST_END; /* End of string */
2157 break;
2158 case '\\':
2159 state = ST_BACKSLASH; /* Backslash scape sequence */
2160 ++p;
2161 break;
2162 case '^':
2163 state = ST_CARET; /* Caret escape */
2164 ++p;
2165 break;
2166 case '=':
2167 if (equals_end)
2169 state = ST_END; /* End */
2170 break;
2172 /* else fall through */
2173 default:
2174 *(q++) = *(p++);
2175 ++count;
2176 break;
2178 break;
2180 case ST_BACKSLASH: /* Backslash escaped character */
2181 switch (*p)
2183 case '0':
2184 case '1':
2185 case '2':
2186 case '3':
2187 case '4':
2188 case '5':
2189 case '6':
2190 case '7':
2191 state = ST_OCTAL; /* Octal sequence */
2192 num = *p - '0';
2193 break;
2194 case 'x':
2195 case 'X':
2196 state = ST_HEX; /* Hex sequence */
2197 num = 0;
2198 break;
2199 case 'a': /* Bell */
2200 num = '\a';
2201 break;
2202 case 'b': /* Backspace */
2203 num = '\b';
2204 break;
2205 case 'e': /* Escape */
2206 num = 27;
2207 break;
2208 case 'f': /* Form feed */
2209 num = '\f';
2210 break;
2211 case 'n': /* Newline */
2212 num = '\n';
2213 break;
2214 case 'r': /* Carriage return */
2215 num = '\r';
2216 break;
2217 case 't': /* Tab */
2218 num = '\t';
2219 break;
2220 case 'v': /* Vtab */
2221 num = '\v';
2222 break;
2223 case '?': /* Delete */
2224 num = 127;
2225 break;
2226 case '_': /* Space */
2227 num = ' ';
2228 break;
2229 case '\0': /* End of string */
2230 state = ST_ERROR; /* Error! */
2231 break;
2232 default: /* Escaped character like \ ^ : = */
2233 num = *p;
2234 break;
2236 if (state == ST_BACKSLASH)
2238 *(q++) = num;
2239 ++count;
2240 state = ST_GND;
2242 ++p;
2243 break;
2245 case ST_OCTAL: /* Octal sequence */
2246 if (*p < '0' || *p > '7')
2248 *(q++) = num;
2249 ++count;
2250 state = ST_GND;
2252 else
2253 num = (num << 3) + (*(p++) - '0');
2254 break;
2256 case ST_HEX: /* Hex sequence */
2257 switch (*p)
2259 case '0':
2260 case '1':
2261 case '2':
2262 case '3':
2263 case '4':
2264 case '5':
2265 case '6':
2266 case '7':
2267 case '8':
2268 case '9':
2269 num = (num << 4) + (*(p++) - '0');
2270 break;
2271 case 'a':
2272 case 'b':
2273 case 'c':
2274 case 'd':
2275 case 'e':
2276 case 'f':
2277 num = (num << 4) + (*(p++) - 'a') + 10;
2278 break;
2279 case 'A':
2280 case 'B':
2281 case 'C':
2282 case 'D':
2283 case 'E':
2284 case 'F':
2285 num = (num << 4) + (*(p++) - 'A') + 10;
2286 break;
2287 default:
2288 *(q++) = num;
2289 ++count;
2290 state = ST_GND;
2291 break;
2293 break;
2295 case ST_CARET: /* Caret escape */
2296 state = ST_GND; /* Should be the next state... */
2297 if (*p >= '@' && *p <= '~')
2299 *(q++) = *(p++) & 037;
2300 ++count;
2302 else if (*p == '?')
2304 *(q++) = 127;
2305 ++count;
2307 else
2308 state = ST_ERROR;
2309 break;
2311 default:
2312 abort ();
2316 *dest = q;
2317 *src = p;
2318 *output_count = count;
2320 return state != ST_ERROR;
2323 enum parse_state
2325 PS_START = 1,
2326 PS_2,
2327 PS_3,
2328 PS_4,
2329 PS_DONE,
2330 PS_FAIL
2334 /* Check if the content of TERM is a valid name in dircolors. */
2336 static bool
2337 known_term_type (void)
2339 char const *term = getenv ("TERM");
2340 if (! term || ! *term)
2341 return false;
2343 char const *line = G_line;
2344 while (line - G_line < sizeof (G_line))
2346 if (STRNCMP_LIT (line, "TERM ") == 0)
2348 if (fnmatch (line + 5, term, 0) == 0)
2349 return true;
2351 line += strlen (line) + 1;
2354 return false;
2357 static void
2358 parse_ls_color (void)
2360 const char *p; /* Pointer to character being parsed */
2361 char *buf; /* color_buf buffer pointer */
2362 int ind_no; /* Indicator number */
2363 char label[3]; /* Indicator label */
2364 struct color_ext_type *ext; /* Extension we are working on */
2366 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2368 /* LS_COLORS takes precedence, but if that's not set then
2369 honor the COLORTERM and TERM env variables so that
2370 we only go with the internal ANSI color codes if the
2371 former is non empty or the latter is set to a known value. */
2372 char const *colorterm = getenv ("COLORTERM");
2373 if (! (colorterm && *colorterm) && ! known_term_type ())
2374 print_with_color = false;
2375 return;
2378 ext = NULL;
2379 strcpy (label, "??");
2381 /* This is an overly conservative estimate, but any possible
2382 LS_COLORS string will *not* generate a color_buf longer than
2383 itself, so it is a safe way of allocating a buffer in
2384 advance. */
2385 buf = color_buf = xstrdup (p);
2387 enum parse_state state = PS_START;
2388 while (true)
2390 switch (state)
2392 case PS_START: /* First label character */
2393 switch (*p)
2395 case ':':
2396 ++p;
2397 break;
2399 case '*':
2400 /* Allocate new extension block and add to head of
2401 linked list (this way a later definition will
2402 override an earlier one, which can be useful for
2403 having terminal-specific defs override global). */
2405 ext = xmalloc (sizeof *ext);
2406 ext->next = color_ext_list;
2407 color_ext_list = ext;
2409 ++p;
2410 ext->ext.string = buf;
2412 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2413 ? PS_4 : PS_FAIL);
2414 break;
2416 case '\0':
2417 state = PS_DONE; /* Done! */
2418 goto done;
2420 default: /* Assume it is file type label */
2421 label[0] = *(p++);
2422 state = PS_2;
2423 break;
2425 break;
2427 case PS_2: /* Second label character */
2428 if (*p)
2430 label[1] = *(p++);
2431 state = PS_3;
2433 else
2434 state = PS_FAIL; /* Error */
2435 break;
2437 case PS_3: /* Equal sign after indicator label */
2438 state = PS_FAIL; /* Assume failure... */
2439 if (*(p++) == '=')/* It *should* be... */
2441 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2443 if (STREQ (label, indicator_name[ind_no]))
2445 color_indicator[ind_no].string = buf;
2446 state = (get_funky_string (&buf, &p, false,
2447 &color_indicator[ind_no].len)
2448 ? PS_START : PS_FAIL);
2449 break;
2452 if (state == PS_FAIL)
2453 error (0, 0, _("unrecognized prefix: %s"), quote (label));
2455 break;
2457 case PS_4: /* Equal sign after *.ext */
2458 if (*(p++) == '=')
2460 ext->seq.string = buf;
2461 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2462 ? PS_START : PS_FAIL);
2464 else
2465 state = PS_FAIL;
2466 break;
2468 case PS_FAIL:
2469 goto done;
2471 default:
2472 abort ();
2475 done:
2477 if (state == PS_FAIL)
2479 struct color_ext_type *e;
2480 struct color_ext_type *e2;
2482 error (0, 0,
2483 _("unparsable value for LS_COLORS environment variable"));
2484 free (color_buf);
2485 for (e = color_ext_list; e != NULL; /* empty */)
2487 e2 = e;
2488 e = e->next;
2489 free (e2);
2491 print_with_color = false;
2494 if (color_indicator[C_LINK].len == 6
2495 && !STRNCMP_LIT (color_indicator[C_LINK].string, "target"))
2496 color_symlink_as_referent = true;
2499 /* Set the quoting style default if the environment variable
2500 QUOTING_STYLE is set. */
2502 static void
2503 getenv_quoting_style (void)
2505 char const *q_style = getenv ("QUOTING_STYLE");
2506 if (q_style)
2508 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
2509 if (0 <= i)
2510 set_quoting_style (NULL, quoting_style_vals[i]);
2511 else
2512 error (0, 0,
2513 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
2514 quote (q_style));
2518 /* Set the exit status to report a failure. If SERIOUS, it is a
2519 serious failure; otherwise, it is merely a minor problem. */
2521 static void
2522 set_exit_status (bool serious)
2524 if (serious)
2525 exit_status = LS_FAILURE;
2526 else if (exit_status == EXIT_SUCCESS)
2527 exit_status = LS_MINOR_PROBLEM;
2530 /* Assuming a failure is serious if SERIOUS, use the printf-style
2531 MESSAGE to report the failure to access a file named FILE. Assume
2532 errno is set appropriately for the failure. */
2534 static void
2535 file_failure (bool serious, char const *message, char const *file)
2537 error (0, errno, message, quote (file));
2538 set_exit_status (serious);
2541 /* Request that the directory named NAME have its contents listed later.
2542 If REALNAME is nonzero, it will be used instead of NAME when the
2543 directory name is printed. This allows symbolic links to directories
2544 to be treated as regular directories but still be listed under their
2545 real names. NAME == NULL is used to insert a marker entry for the
2546 directory named in REALNAME.
2547 If NAME is non-NULL, we use its dev/ino information to save
2548 a call to stat -- when doing a recursive (-R) traversal.
2549 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2551 static void
2552 queue_directory (char const *name, char const *realname, bool command_line_arg)
2554 struct pending *new = xmalloc (sizeof *new);
2555 new->realname = realname ? xstrdup (realname) : NULL;
2556 new->name = name ? xstrdup (name) : NULL;
2557 new->command_line_arg = command_line_arg;
2558 new->next = pending_dirs;
2559 pending_dirs = new;
2562 /* Read directory NAME, and list the files in it.
2563 If REALNAME is nonzero, print its name instead of NAME;
2564 this is used for symbolic links to directories.
2565 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2567 static void
2568 print_dir (char const *name, char const *realname, bool command_line_arg)
2570 DIR *dirp;
2571 struct dirent *next;
2572 uintmax_t total_blocks = 0;
2573 static bool first = true;
2575 errno = 0;
2576 dirp = opendir (name);
2577 if (!dirp)
2579 file_failure (command_line_arg, _("cannot open directory %s"), name);
2580 return;
2583 if (LOOP_DETECT)
2585 struct stat dir_stat;
2586 int fd = dirfd (dirp);
2588 /* If dirfd failed, endure the overhead of using stat. */
2589 if ((0 <= fd
2590 ? fstat (fd, &dir_stat)
2591 : stat (name, &dir_stat)) < 0)
2593 file_failure (command_line_arg,
2594 _("cannot determine device and inode of %s"), name);
2595 closedir (dirp);
2596 return;
2599 /* If we've already visited this dev/inode pair, warn that
2600 we've found a loop, and do not process this directory. */
2601 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2603 error (0, 0, _("%s: not listing already-listed directory"),
2604 quote (name));
2605 closedir (dirp);
2606 set_exit_status (true);
2607 return;
2610 dev_ino_push (dir_stat.st_dev, dir_stat.st_ino);
2613 if (recursive || print_dir_name)
2615 if (!first)
2616 DIRED_PUTCHAR ('\n');
2617 first = false;
2618 DIRED_INDENT ();
2619 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2620 dired_pos += quote_name (stdout, realname ? realname : name,
2621 dirname_quoting_options, NULL);
2622 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2623 DIRED_FPUTS_LITERAL (":\n", stdout);
2626 /* Read the directory entries, and insert the subfiles into the 'cwd_file'
2627 table. */
2629 clear_files ();
2631 while (1)
2633 /* Set errno to zero so we can distinguish between a readdir failure
2634 and when readdir simply finds that there are no more entries. */
2635 errno = 0;
2636 next = readdir (dirp);
2637 if (next)
2639 if (! file_ignored (next->d_name))
2641 enum filetype type = unknown;
2643 #if HAVE_STRUCT_DIRENT_D_TYPE
2644 switch (next->d_type)
2646 case DT_BLK: type = blockdev; break;
2647 case DT_CHR: type = chardev; break;
2648 case DT_DIR: type = directory; break;
2649 case DT_FIFO: type = fifo; break;
2650 case DT_LNK: type = symbolic_link; break;
2651 case DT_REG: type = normal; break;
2652 case DT_SOCK: type = sock; break;
2653 # ifdef DT_WHT
2654 case DT_WHT: type = whiteout; break;
2655 # endif
2657 #endif
2658 total_blocks += gobble_file (next->d_name, type,
2659 RELIABLE_D_INO (next),
2660 false, name);
2662 /* In this narrow case, print out each name right away, so
2663 ls uses constant memory while processing the entries of
2664 this directory. Useful when there are many (millions)
2665 of entries in a directory. */
2666 if (format == one_per_line && sort_type == sort_none
2667 && !print_block_size && !recursive)
2669 /* We must call sort_files in spite of
2670 "sort_type == sort_none" for its initialization
2671 of the sorted_file vector. */
2672 sort_files ();
2673 print_current_files ();
2674 clear_files ();
2678 else if (errno != 0)
2680 file_failure (command_line_arg, _("reading directory %s"), name);
2681 if (errno != EOVERFLOW)
2682 break;
2684 else
2685 break;
2687 /* When processing a very large directory, and since we've inhibited
2688 interrupts, this loop would take so long that ls would be annoyingly
2689 uninterruptible. This ensures that it handles signals promptly. */
2690 process_signals ();
2693 if (closedir (dirp) != 0)
2695 file_failure (command_line_arg, _("closing directory %s"), name);
2696 /* Don't return; print whatever we got. */
2699 /* Sort the directory contents. */
2700 sort_files ();
2702 /* If any member files are subdirectories, perhaps they should have their
2703 contents listed rather than being mentioned here as files. */
2705 if (recursive)
2706 extract_dirs_from_files (name, false);
2708 if (format == long_format || print_block_size)
2710 const char *p;
2711 char buf[LONGEST_HUMAN_READABLE + 1];
2713 DIRED_INDENT ();
2714 p = _("total");
2715 DIRED_FPUTS (p, stdout, strlen (p));
2716 DIRED_PUTCHAR (' ');
2717 p = human_readable (total_blocks, buf, human_output_opts,
2718 ST_NBLOCKSIZE, output_block_size);
2719 DIRED_FPUTS (p, stdout, strlen (p));
2720 DIRED_PUTCHAR ('\n');
2723 if (cwd_n_used)
2724 print_current_files ();
2727 /* Add 'pattern' to the list of patterns for which files that match are
2728 not listed. */
2730 static void
2731 add_ignore_pattern (const char *pattern)
2733 struct ignore_pattern *ignore;
2735 ignore = xmalloc (sizeof *ignore);
2736 ignore->pattern = pattern;
2737 /* Add it to the head of the linked list. */
2738 ignore->next = ignore_patterns;
2739 ignore_patterns = ignore;
2742 /* Return true if one of the PATTERNS matches FILE. */
2744 static bool
2745 patterns_match (struct ignore_pattern const *patterns, char const *file)
2747 struct ignore_pattern const *p;
2748 for (p = patterns; p; p = p->next)
2749 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2750 return true;
2751 return false;
2754 /* Return true if FILE should be ignored. */
2756 static bool
2757 file_ignored (char const *name)
2759 return ((ignore_mode != IGNORE_MINIMAL
2760 && name[0] == '.'
2761 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2762 || (ignore_mode == IGNORE_DEFAULT
2763 && patterns_match (hide_patterns, name))
2764 || patterns_match (ignore_patterns, name));
2767 /* POSIX requires that a file size be printed without a sign, even
2768 when negative. Assume the typical case where negative sizes are
2769 actually positive values that have wrapped around. */
2771 static uintmax_t
2772 unsigned_file_size (off_t size)
2774 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2777 #ifdef HAVE_CAP
2778 /* Return true if NAME has a capability (see linux/capability.h) */
2779 static bool
2780 has_capability (char const *name)
2782 char *result;
2783 bool has_cap;
2785 cap_t cap_d = cap_get_file (name);
2786 if (cap_d == NULL)
2787 return false;
2789 result = cap_to_text (cap_d, NULL);
2790 cap_free (cap_d);
2791 if (!result)
2792 return false;
2794 /* check if human-readable capability string is empty */
2795 has_cap = !!*result;
2797 cap_free (result);
2798 return has_cap;
2800 #else
2801 static bool
2802 has_capability (char const *name _GL_UNUSED)
2804 errno = ENOTSUP;
2805 return false;
2807 #endif
2809 /* Enter and remove entries in the table 'cwd_file'. */
2811 static void
2812 free_ent (struct fileinfo *f)
2814 free (f->name);
2815 free (f->linkname);
2816 if (f->scontext != UNKNOWN_SECURITY_CONTEXT)
2818 if (is_smack_enabled ())
2819 free (f->scontext);
2820 else
2821 freecon (f->scontext);
2825 /* Empty the table of files. */
2826 static void
2827 clear_files (void)
2829 size_t i;
2831 for (i = 0; i < cwd_n_used; i++)
2833 struct fileinfo *f = sorted_file[i];
2834 free_ent (f);
2837 cwd_n_used = 0;
2838 any_has_acl = false;
2839 inode_number_width = 0;
2840 block_size_width = 0;
2841 nlink_width = 0;
2842 owner_width = 0;
2843 group_width = 0;
2844 author_width = 0;
2845 scontext_width = 0;
2846 major_device_number_width = 0;
2847 minor_device_number_width = 0;
2848 file_size_width = 0;
2851 /* Return true if ERR implies lack-of-support failure by a
2852 getxattr-calling function like getfilecon or file_has_acl. */
2853 static bool
2854 errno_unsupported (int err)
2856 return (err == EINVAL || err == ENOSYS || is_ENOTSUP (err));
2859 /* Cache *getfilecon failure, when it's trivial to do so.
2860 Like getfilecon/lgetfilecon, but when F's st_dev says it's doesn't
2861 support getting the security context, fail with ENOTSUP immediately. */
2862 static int
2863 getfilecon_cache (char const *file, struct fileinfo *f, bool deref)
2865 /* st_dev of the most recently processed device for which we've
2866 found that [l]getfilecon fails indicating lack of support. */
2867 static dev_t unsupported_device;
2869 if (f->stat.st_dev == unsupported_device)
2871 errno = ENOTSUP;
2872 return -1;
2874 int r = 0;
2875 #ifdef HAVE_SMACK
2876 if (is_smack_enabled ())
2877 r = smack_new_label_from_path (file, "security.SMACK64", deref,
2878 &f->scontext);
2879 else
2880 #endif
2881 r = (deref
2882 ? getfilecon (file, &f->scontext)
2883 : lgetfilecon (file, &f->scontext));
2884 if (r < 0 && errno_unsupported (errno))
2885 unsupported_device = f->stat.st_dev;
2886 return r;
2889 /* Cache file_has_acl failure, when it's trivial to do.
2890 Like file_has_acl, but when F's st_dev says it's on a file
2891 system lacking ACL support, return 0 with ENOTSUP immediately. */
2892 static int
2893 file_has_acl_cache (char const *file, struct fileinfo *f)
2895 /* st_dev of the most recently processed device for which we've
2896 found that file_has_acl fails indicating lack of support. */
2897 static dev_t unsupported_device;
2899 if (f->stat.st_dev == unsupported_device)
2901 errno = ENOTSUP;
2902 return 0;
2905 /* Zero errno so that we can distinguish between two 0-returning cases:
2906 "has-ACL-support, but only a default ACL" and "no ACL support". */
2907 errno = 0;
2908 int n = file_has_acl (file, &f->stat);
2909 if (n <= 0 && errno_unsupported (errno))
2910 unsupported_device = f->stat.st_dev;
2911 return n;
2914 /* Cache has_capability failure, when it's trivial to do.
2915 Like has_capability, but when F's st_dev says it's on a file
2916 system lacking capability support, return 0 with ENOTSUP immediately. */
2917 static bool
2918 has_capability_cache (char const *file, struct fileinfo *f)
2920 /* st_dev of the most recently processed device for which we've
2921 found that has_capability fails indicating lack of support. */
2922 static dev_t unsupported_device;
2924 if (f->stat.st_dev == unsupported_device)
2926 errno = ENOTSUP;
2927 return 0;
2930 bool b = has_capability (file);
2931 if ( !b && errno_unsupported (errno))
2932 unsupported_device = f->stat.st_dev;
2933 return b;
2936 /* Add a file to the current table of files.
2937 Verify that the file exists, and print an error message if it does not.
2938 Return the number of blocks that the file occupies. */
2939 static uintmax_t
2940 gobble_file (char const *name, enum filetype type, ino_t inode,
2941 bool command_line_arg, char const *dirname)
2943 uintmax_t blocks = 0;
2944 struct fileinfo *f;
2946 /* An inode value prior to gobble_file necessarily came from readdir,
2947 which is not used for command line arguments. */
2948 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2950 if (cwd_n_used == cwd_n_alloc)
2952 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
2953 cwd_n_alloc *= 2;
2956 f = &cwd_file[cwd_n_used];
2957 memset (f, '\0', sizeof *f);
2958 f->stat.st_ino = inode;
2959 f->filetype = type;
2961 if (command_line_arg
2962 || format_needs_stat
2963 /* When coloring a directory (we may know the type from
2964 direct.d_type), we have to stat it in order to indicate
2965 sticky and/or other-writable attributes. */
2966 || (type == directory && print_with_color
2967 && (is_colored (C_OTHER_WRITABLE)
2968 || is_colored (C_STICKY)
2969 || is_colored (C_STICKY_OTHER_WRITABLE)))
2970 /* When dereferencing symlinks, the inode and type must come from
2971 stat, but readdir provides the inode and type of lstat. */
2972 || ((print_inode || format_needs_type)
2973 && (type == symbolic_link || type == unknown)
2974 && (dereference == DEREF_ALWAYS
2975 || color_symlink_as_referent || check_symlink_color))
2976 /* Command line dereferences are already taken care of by the above
2977 assertion that the inode number is not yet known. */
2978 || (print_inode && inode == NOT_AN_INODE_NUMBER)
2979 || (format_needs_type
2980 && (type == unknown || command_line_arg
2981 /* --indicator-style=classify (aka -F)
2982 requires that we stat each regular file
2983 to see if it's executable. */
2984 || (type == normal && (indicator_style == classify
2985 /* This is so that --color ends up
2986 highlighting files with these mode
2987 bits set even when options like -F are
2988 not specified. Note we do a redundant
2989 stat in the very unlikely case where
2990 C_CAP is set but not the others. */
2991 || (print_with_color
2992 && (is_colored (C_EXEC)
2993 || is_colored (C_SETUID)
2994 || is_colored (C_SETGID)
2995 || is_colored (C_CAP)))
2996 )))))
2999 /* Absolute name of this file. */
3000 char *absolute_name;
3001 bool do_deref;
3002 int err;
3004 if (name[0] == '/' || dirname[0] == 0)
3005 absolute_name = (char *) name;
3006 else
3008 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
3009 attach (absolute_name, dirname, name);
3012 switch (dereference)
3014 case DEREF_ALWAYS:
3015 err = stat (absolute_name, &f->stat);
3016 do_deref = true;
3017 break;
3019 case DEREF_COMMAND_LINE_ARGUMENTS:
3020 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
3021 if (command_line_arg)
3023 bool need_lstat;
3024 err = stat (absolute_name, &f->stat);
3025 do_deref = true;
3027 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
3028 break;
3030 need_lstat = (err < 0
3031 ? errno == ENOENT
3032 : ! S_ISDIR (f->stat.st_mode));
3033 if (!need_lstat)
3034 break;
3036 /* stat failed because of ENOENT, maybe indicating a dangling
3037 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
3038 directory, and --dereference-command-line-symlink-to-dir is
3039 in effect. Fall through so that we call lstat instead. */
3042 default: /* DEREF_NEVER */
3043 err = lstat (absolute_name, &f->stat);
3044 do_deref = false;
3045 break;
3048 if (err != 0)
3050 /* Failure to stat a command line argument leads to
3051 an exit status of 2. For other files, stat failure
3052 provokes an exit status of 1. */
3053 file_failure (command_line_arg,
3054 _("cannot access %s"), absolute_name);
3055 if (command_line_arg)
3056 return 0;
3058 f->name = xstrdup (name);
3059 cwd_n_used++;
3061 return 0;
3064 f->stat_ok = true;
3066 /* Note has_capability() adds around 30% runtime to 'ls --color' */
3067 if ((type == normal || S_ISREG (f->stat.st_mode))
3068 && print_with_color && is_colored (C_CAP))
3069 f->has_capability = has_capability_cache (absolute_name, f);
3071 if (format == long_format || print_scontext)
3073 bool have_scontext = false;
3074 bool have_acl = false;
3075 int attr_len = getfilecon_cache (absolute_name, f, do_deref);
3076 err = (attr_len < 0);
3078 if (err == 0)
3080 if (is_smack_enabled ())
3081 have_scontext = ! STREQ ("_", f->scontext);
3082 else
3083 have_scontext = ! STREQ ("unlabeled", f->scontext);
3085 else
3087 f->scontext = UNKNOWN_SECURITY_CONTEXT;
3089 /* When requesting security context information, don't make
3090 ls fail just because the file (even a command line argument)
3091 isn't on the right type of file system. I.e., a getfilecon
3092 failure isn't in the same class as a stat failure. */
3093 if (is_ENOTSUP (errno) || errno == ENODATA)
3094 err = 0;
3097 if (err == 0 && format == long_format)
3099 int n = file_has_acl_cache (absolute_name, f);
3100 err = (n < 0);
3101 have_acl = (0 < n);
3104 f->acl_type = (!have_scontext && !have_acl
3105 ? ACL_T_NONE
3106 : (have_scontext && !have_acl
3107 ? ACL_T_LSM_CONTEXT_ONLY
3108 : ACL_T_YES));
3109 any_has_acl |= f->acl_type != ACL_T_NONE;
3111 if (err)
3112 error (0, errno, "%s", quote (absolute_name));
3115 if (S_ISLNK (f->stat.st_mode)
3116 && (format == long_format || check_symlink_color))
3118 struct stat linkstats;
3120 get_link_name (absolute_name, f, command_line_arg);
3121 char *linkname = make_link_name (absolute_name, f->linkname);
3123 /* Avoid following symbolic links when possible, ie, when
3124 they won't be traced and when no indicator is needed. */
3125 if (linkname
3126 && (file_type <= indicator_style || check_symlink_color)
3127 && stat (linkname, &linkstats) == 0)
3129 f->linkok = true;
3131 /* Symbolic links to directories that are mentioned on the
3132 command line are automatically traced if not being
3133 listed as files. */
3134 if (!command_line_arg || format == long_format
3135 || !S_ISDIR (linkstats.st_mode))
3137 /* Get the linked-to file's mode for the filetype indicator
3138 in long listings. */
3139 f->linkmode = linkstats.st_mode;
3142 free (linkname);
3145 if (S_ISLNK (f->stat.st_mode))
3146 f->filetype = symbolic_link;
3147 else if (S_ISDIR (f->stat.st_mode))
3149 if (command_line_arg && !immediate_dirs)
3150 f->filetype = arg_directory;
3151 else
3152 f->filetype = directory;
3154 else
3155 f->filetype = normal;
3157 blocks = ST_NBLOCKS (f->stat);
3158 if (format == long_format || print_block_size)
3160 char buf[LONGEST_HUMAN_READABLE + 1];
3161 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
3162 ST_NBLOCKSIZE, output_block_size),
3164 if (block_size_width < len)
3165 block_size_width = len;
3168 if (format == long_format)
3170 if (print_owner)
3172 int len = format_user_width (f->stat.st_uid);
3173 if (owner_width < len)
3174 owner_width = len;
3177 if (print_group)
3179 int len = format_group_width (f->stat.st_gid);
3180 if (group_width < len)
3181 group_width = len;
3184 if (print_author)
3186 int len = format_user_width (f->stat.st_author);
3187 if (author_width < len)
3188 author_width = len;
3192 if (print_scontext)
3194 int len = strlen (f->scontext);
3195 if (scontext_width < len)
3196 scontext_width = len;
3199 if (format == long_format)
3201 char b[INT_BUFSIZE_BOUND (uintmax_t)];
3202 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
3203 if (nlink_width < b_len)
3204 nlink_width = b_len;
3206 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
3208 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
3209 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
3210 if (major_device_number_width < len)
3211 major_device_number_width = len;
3212 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
3213 if (minor_device_number_width < len)
3214 minor_device_number_width = len;
3215 len = major_device_number_width + 2 + minor_device_number_width;
3216 if (file_size_width < len)
3217 file_size_width = len;
3219 else
3221 char buf[LONGEST_HUMAN_READABLE + 1];
3222 uintmax_t size = unsigned_file_size (f->stat.st_size);
3223 int len = mbswidth (human_readable (size, buf,
3224 file_human_output_opts,
3225 1, file_output_block_size),
3227 if (file_size_width < len)
3228 file_size_width = len;
3233 if (print_inode)
3235 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
3236 int len = strlen (umaxtostr (f->stat.st_ino, buf));
3237 if (inode_number_width < len)
3238 inode_number_width = len;
3241 f->name = xstrdup (name);
3242 cwd_n_used++;
3244 return blocks;
3247 /* Return true if F refers to a directory. */
3248 static bool
3249 is_directory (const struct fileinfo *f)
3251 return f->filetype == directory || f->filetype == arg_directory;
3254 /* Put the name of the file that FILENAME is a symbolic link to
3255 into the LINKNAME field of 'f'. COMMAND_LINE_ARG indicates whether
3256 FILENAME is a command-line argument. */
3258 static void
3259 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
3261 f->linkname = areadlink_with_size (filename, f->stat.st_size);
3262 if (f->linkname == NULL)
3263 file_failure (command_line_arg, _("cannot read symbolic link %s"),
3264 filename);
3267 /* If LINKNAME is a relative name and NAME contains one or more
3268 leading directories, return LINKNAME with those directories
3269 prepended; otherwise, return a copy of LINKNAME.
3270 If LINKNAME is NULL, return NULL. */
3272 static char *
3273 make_link_name (char const *name, char const *linkname)
3275 if (!linkname)
3276 return NULL;
3278 if (IS_ABSOLUTE_FILE_NAME (linkname))
3279 return xstrdup (linkname);
3281 /* The link is to a relative name. Prepend any leading directory
3282 in 'name' to the link name. */
3283 size_t prefix_len = dir_len (name);
3284 if (prefix_len == 0)
3285 return xstrdup (linkname);
3287 char *p = xmalloc (prefix_len + 1 + strlen (linkname) + 1);
3289 /* PREFIX_LEN usually specifies a string not ending in slash.
3290 In that case, extend it by one, since the next byte *is* a slash.
3291 Otherwise, the prefix is "/", so leave the length unchanged. */
3292 if ( ! ISSLASH (name[prefix_len - 1]))
3293 ++prefix_len;
3295 stpcpy (stpncpy (p, name, prefix_len), linkname);
3296 return p;
3299 /* Return true if the last component of NAME is '.' or '..'
3300 This is so we don't try to recurse on '././././. ...' */
3302 static bool
3303 basename_is_dot_or_dotdot (const char *name)
3305 char const *base = last_component (name);
3306 return dot_or_dotdot (base);
3309 /* Remove any entries from CWD_FILE that are for directories,
3310 and queue them to be listed as directories instead.
3311 DIRNAME is the prefix to prepend to each dirname
3312 to make it correct relative to ls's working dir;
3313 if it is null, no prefix is needed and "." and ".." should not be ignored.
3314 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
3315 This is desirable when processing directories recursively. */
3317 static void
3318 extract_dirs_from_files (char const *dirname, bool command_line_arg)
3320 size_t i;
3321 size_t j;
3322 bool ignore_dot_and_dot_dot = (dirname != NULL);
3324 if (dirname && LOOP_DETECT)
3326 /* Insert a marker entry first. When we dequeue this marker entry,
3327 we'll know that DIRNAME has been processed and may be removed
3328 from the set of active directories. */
3329 queue_directory (NULL, dirname, false);
3332 /* Queue the directories last one first, because queueing reverses the
3333 order. */
3334 for (i = cwd_n_used; i-- != 0; )
3336 struct fileinfo *f = sorted_file[i];
3338 if (is_directory (f)
3339 && (! ignore_dot_and_dot_dot
3340 || ! basename_is_dot_or_dotdot (f->name)))
3342 if (!dirname || f->name[0] == '/')
3343 queue_directory (f->name, f->linkname, command_line_arg);
3344 else
3346 char *name = file_name_concat (dirname, f->name, NULL);
3347 queue_directory (name, f->linkname, command_line_arg);
3348 free (name);
3350 if (f->filetype == arg_directory)
3351 free_ent (f);
3355 /* Now delete the directories from the table, compacting all the remaining
3356 entries. */
3358 for (i = 0, j = 0; i < cwd_n_used; i++)
3360 struct fileinfo *f = sorted_file[i];
3361 sorted_file[j] = f;
3362 j += (f->filetype != arg_directory);
3364 cwd_n_used = j;
3367 /* Use strcoll to compare strings in this locale. If an error occurs,
3368 report an error and longjmp to failed_strcoll. */
3370 static jmp_buf failed_strcoll;
3372 static int
3373 xstrcoll (char const *a, char const *b)
3375 int diff;
3376 errno = 0;
3377 diff = strcoll (a, b);
3378 if (errno)
3380 error (0, errno, _("cannot compare file names %s and %s"),
3381 quote_n (0, a), quote_n (1, b));
3382 set_exit_status (false);
3383 longjmp (failed_strcoll, 1);
3385 return diff;
3388 /* Comparison routines for sorting the files. */
3390 typedef void const *V;
3391 typedef int (*qsortFunc)(V a, V b);
3393 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
3394 The do { ... } while(0) makes it possible to use the macro more like
3395 a statement, without violating C89 rules: */
3396 #define DIRFIRST_CHECK(a, b) \
3397 do \
3399 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
3400 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
3401 if (a_is_dir && !b_is_dir) \
3402 return -1; /* a goes before b */ \
3403 if (!a_is_dir && b_is_dir) \
3404 return 1; /* b goes before a */ \
3406 while (0)
3408 /* Define the 8 different sort function variants required for each sortkey.
3409 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
3410 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
3411 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
3412 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
3413 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
3414 /* direct, non-dirfirst versions */ \
3415 static int xstrcoll_##key_name (V a, V b) \
3416 { return key_cmp_func (a, b, xstrcoll); } \
3417 static int strcmp_##key_name (V a, V b) \
3418 { return key_cmp_func (a, b, strcmp); } \
3420 /* reverse, non-dirfirst versions */ \
3421 static int rev_xstrcoll_##key_name (V a, V b) \
3422 { return key_cmp_func (b, a, xstrcoll); } \
3423 static int rev_strcmp_##key_name (V a, V b) \
3424 { return key_cmp_func (b, a, strcmp); } \
3426 /* direct, dirfirst versions */ \
3427 static int xstrcoll_df_##key_name (V a, V b) \
3428 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
3429 static int strcmp_df_##key_name (V a, V b) \
3430 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
3432 /* reverse, dirfirst versions */ \
3433 static int rev_xstrcoll_df_##key_name (V a, V b) \
3434 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
3435 static int rev_strcmp_df_##key_name (V a, V b) \
3436 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
3438 static inline int
3439 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3440 int (*cmp) (char const *, char const *))
3442 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3443 get_stat_ctime (&a->stat));
3444 return diff ? diff : cmp (a->name, b->name);
3447 static inline int
3448 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3449 int (*cmp) (char const *, char const *))
3451 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3452 get_stat_mtime (&a->stat));
3453 return diff ? diff : cmp (a->name, b->name);
3456 static inline int
3457 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3458 int (*cmp) (char const *, char const *))
3460 int diff = timespec_cmp (get_stat_atime (&b->stat),
3461 get_stat_atime (&a->stat));
3462 return diff ? diff : cmp (a->name, b->name);
3465 static inline int
3466 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3467 int (*cmp) (char const *, char const *))
3469 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3470 return diff ? diff : cmp (a->name, b->name);
3473 static inline int
3474 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3475 int (*cmp) (char const *, char const *))
3477 return cmp (a->name, b->name);
3480 /* Compare file extensions. Files with no extension are 'smallest'.
3481 If extensions are the same, compare by filenames instead. */
3483 static inline int
3484 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3485 int (*cmp) (char const *, char const *))
3487 char const *base1 = strrchr (a->name, '.');
3488 char const *base2 = strrchr (b->name, '.');
3489 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3490 return diff ? diff : cmp (a->name, b->name);
3493 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3494 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3495 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3496 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3497 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3498 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3500 /* Compare file versions.
3501 Unlike all other compare functions above, cmp_version depends only
3502 on filevercmp, which does not fail (even for locale reasons), and does not
3503 need a secondary sort key. See lib/filevercmp.h for function description.
3505 All the other sort options, in fact, need xstrcoll and strcmp variants,
3506 because they all use a string comparison (either as the primary or secondary
3507 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3508 locale reasons. Lastly, filevercmp is ALWAYS available with gnulib. */
3509 static inline int
3510 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3512 return filevercmp (a->name, b->name);
3515 static int xstrcoll_version (V a, V b)
3516 { return cmp_version (a, b); }
3517 static int rev_xstrcoll_version (V a, V b)
3518 { return cmp_version (b, a); }
3519 static int xstrcoll_df_version (V a, V b)
3520 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3521 static int rev_xstrcoll_df_version (V a, V b)
3522 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3525 /* We have 2^3 different variants for each sort-key function
3526 (for 3 independent sort modes).
3527 The function pointers stored in this array must be dereferenced as:
3529 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3531 Note that the order in which sort keys are listed in the function pointer
3532 array below is defined by the order of the elements in the time_type and
3533 sort_type enums! */
3535 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3538 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3539 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3540 }, \
3542 { strcmp_##key_name, strcmp_df_##key_name }, \
3543 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3547 static qsortFunc const sort_functions[][2][2][2] =
3549 LIST_SORTFUNCTION_VARIANTS (name),
3550 LIST_SORTFUNCTION_VARIANTS (extension),
3551 LIST_SORTFUNCTION_VARIANTS (size),
3555 { xstrcoll_version, xstrcoll_df_version },
3556 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3559 /* We use NULL for the strcmp variants of version comparison
3560 since as explained in cmp_version definition, version comparison
3561 does not rely on xstrcoll, so it will never longjmp, and never
3562 need to try the strcmp fallback. */
3564 { NULL, NULL },
3565 { NULL, NULL },
3569 /* last are time sort functions */
3570 LIST_SORTFUNCTION_VARIANTS (mtime),
3571 LIST_SORTFUNCTION_VARIANTS (ctime),
3572 LIST_SORTFUNCTION_VARIANTS (atime)
3575 /* The number of sort keys is calculated as the sum of
3576 the number of elements in the sort_type enum (i.e., sort_numtypes)
3577 the number of elements in the time_type enum (i.e., time_numtypes) - 1
3578 This is because when sort_type==sort_time, we have up to
3579 time_numtypes possible sort keys.
3581 This line verifies at compile-time that the array of sort functions has been
3582 initialized for all possible sort keys. */
3583 verify (ARRAY_CARDINALITY (sort_functions)
3584 == sort_numtypes + time_numtypes - 1 );
3586 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
3588 static void
3589 initialize_ordering_vector (void)
3591 size_t i;
3592 for (i = 0; i < cwd_n_used; i++)
3593 sorted_file[i] = &cwd_file[i];
3596 /* Sort the files now in the table. */
3598 static void
3599 sort_files (void)
3601 bool use_strcmp;
3603 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
3605 free (sorted_file);
3606 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
3607 sorted_file_alloc = 3 * cwd_n_used;
3610 initialize_ordering_vector ();
3612 if (sort_type == sort_none)
3613 return;
3615 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3616 ignore strcoll failures, as a failing strcoll might be a
3617 comparison function that is not a total order, and if we ignored
3618 the failure this might cause qsort to dump core. */
3620 if (! setjmp (failed_strcoll))
3621 use_strcmp = false; /* strcoll() succeeded */
3622 else
3624 use_strcmp = true;
3625 assert (sort_type != sort_version);
3626 initialize_ordering_vector ();
3629 /* When sort_type == sort_time, use time_type as subindex. */
3630 mpsort ((void const **) sorted_file, cwd_n_used,
3631 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
3632 [use_strcmp][sort_reverse]
3633 [directories_first]);
3636 /* List all the files now in the table. */
3638 static void
3639 print_current_files (void)
3641 size_t i;
3643 switch (format)
3645 case one_per_line:
3646 for (i = 0; i < cwd_n_used; i++)
3648 print_file_name_and_frills (sorted_file[i], 0);
3649 putchar ('\n');
3651 break;
3653 case many_per_line:
3654 if (! line_length)
3655 print_with_separator (' ');
3656 else
3657 print_many_per_line ();
3658 break;
3660 case horizontal:
3661 if (! line_length)
3662 print_with_separator (' ');
3663 else
3664 print_horizontal ();
3665 break;
3667 case with_commas:
3668 print_with_separator (',');
3669 break;
3671 case long_format:
3672 for (i = 0; i < cwd_n_used; i++)
3674 set_normal_color ();
3675 print_long_format (sorted_file[i]);
3676 DIRED_PUTCHAR ('\n');
3678 break;
3682 /* Replace the first %b with precomputed aligned month names.
3683 Note on glibc-2.7 at least, this speeds up the whole 'ls -lU'
3684 process by around 17%, compared to letting strftime() handle the %b. */
3686 static size_t
3687 align_nstrftime (char *buf, size_t size, char const *fmt, struct tm const *tm,
3688 timezone_t tz, int ns)
3690 const char *nfmt = fmt;
3691 /* In the unlikely event that rpl_fmt below is not large enough,
3692 the replacement is not done. A malloc here slows ls down by 2% */
3693 char rpl_fmt[sizeof (abmon[0]) + 100];
3694 const char *pb;
3695 if (required_mon_width && (pb = strstr (fmt, "%b"))
3696 && 0 <= tm->tm_mon && tm->tm_mon <= 11)
3698 if (strlen (fmt) < (sizeof (rpl_fmt) - sizeof (abmon[0]) + 2))
3700 char *pfmt = rpl_fmt;
3701 nfmt = rpl_fmt;
3703 pfmt = mempcpy (pfmt, fmt, pb - fmt);
3704 pfmt = stpcpy (pfmt, abmon[tm->tm_mon]);
3705 strcpy (pfmt, pb + 2);
3708 size_t ret = nstrftime (buf, size, nfmt, tm, tz, ns);
3709 return ret;
3712 /* Return the expected number of columns in a long-format time stamp,
3713 or zero if it cannot be calculated. */
3715 static int
3716 long_time_expected_width (void)
3718 static int width = -1;
3720 if (width < 0)
3722 time_t epoch = 0;
3723 struct tm const *tm = localtime (&epoch);
3724 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3726 /* In case you're wondering if localtime can fail with an input time_t
3727 value of 0, let's just say it's very unlikely, but not inconceivable.
3728 The TZ environment variable would have to specify a time zone that
3729 is 2**31-1900 years or more ahead of UTC. This could happen only on
3730 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3731 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3732 their implementations limit the offset to 167:59 and 24:00, resp. */
3733 if (tm)
3735 size_t len =
3736 align_nstrftime (buf, sizeof buf, long_time_format[0], tm,
3737 localtz, 0);
3738 if (len != 0)
3739 width = mbsnwidth (buf, len, 0);
3742 if (width < 0)
3743 width = 0;
3746 return width;
3749 /* Print the user or group name NAME, with numeric id ID, using a
3750 print width of WIDTH columns. */
3752 static void
3753 format_user_or_group (char const *name, unsigned long int id, int width)
3755 size_t len;
3757 if (name)
3759 int width_gap = width - mbswidth (name, 0);
3760 int pad = MAX (0, width_gap);
3761 fputs (name, stdout);
3762 len = strlen (name) + pad;
3765 putchar (' ');
3766 while (pad--);
3768 else
3770 printf ("%*lu ", width, id);
3771 len = width;
3774 dired_pos += len + 1;
3777 /* Print the name or id of the user with id U, using a print width of
3778 WIDTH. */
3780 static void
3781 format_user (uid_t u, int width, bool stat_ok)
3783 format_user_or_group (! stat_ok ? "?" :
3784 (numeric_ids ? NULL : getuser (u)), u, width);
3787 /* Likewise, for groups. */
3789 static void
3790 format_group (gid_t g, int width, bool stat_ok)
3792 format_user_or_group (! stat_ok ? "?" :
3793 (numeric_ids ? NULL : getgroup (g)), g, width);
3796 /* Return the number of columns that format_user_or_group will print. */
3798 static int
3799 format_user_or_group_width (char const *name, unsigned long int id)
3801 if (name)
3803 int len = mbswidth (name, 0);
3804 return MAX (0, len);
3806 else
3808 char buf[INT_BUFSIZE_BOUND (id)];
3809 sprintf (buf, "%lu", id);
3810 return strlen (buf);
3814 /* Return the number of columns that format_user will print. */
3816 static int
3817 format_user_width (uid_t u)
3819 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3822 /* Likewise, for groups. */
3824 static int
3825 format_group_width (gid_t g)
3827 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3830 /* Return a pointer to a formatted version of F->stat.st_ino,
3831 possibly using buffer, BUF, of length BUFLEN, which must be at least
3832 INT_BUFSIZE_BOUND (uintmax_t) bytes. */
3833 static char *
3834 format_inode (char *buf, size_t buflen, const struct fileinfo *f)
3836 assert (INT_BUFSIZE_BOUND (uintmax_t) <= buflen);
3837 return (f->stat_ok && f->stat.st_ino != NOT_AN_INODE_NUMBER
3838 ? umaxtostr (f->stat.st_ino, buf)
3839 : (char *) "?");
3842 /* Print information about F in long format. */
3843 static void
3844 print_long_format (const struct fileinfo *f)
3846 char modebuf[12];
3847 char buf
3848 [LONGEST_HUMAN_READABLE + 1 /* inode */
3849 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3850 + sizeof (modebuf) - 1 + 1 /* mode string */
3851 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3852 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3853 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3854 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3856 size_t s;
3857 char *p;
3858 struct timespec when_timespec;
3859 struct tm *when_local;
3861 /* Compute the mode string, except remove the trailing space if no
3862 file in this directory has an ACL or security context. */
3863 if (f->stat_ok)
3864 filemodestring (&f->stat, modebuf);
3865 else
3867 modebuf[0] = filetype_letter[f->filetype];
3868 memset (modebuf + 1, '?', 10);
3869 modebuf[11] = '\0';
3871 if (! any_has_acl)
3872 modebuf[10] = '\0';
3873 else if (f->acl_type == ACL_T_LSM_CONTEXT_ONLY)
3874 modebuf[10] = '.';
3875 else if (f->acl_type == ACL_T_YES)
3876 modebuf[10] = '+';
3878 switch (time_type)
3880 case time_ctime:
3881 when_timespec = get_stat_ctime (&f->stat);
3882 break;
3883 case time_mtime:
3884 when_timespec = get_stat_mtime (&f->stat);
3885 break;
3886 case time_atime:
3887 when_timespec = get_stat_atime (&f->stat);
3888 break;
3889 default:
3890 abort ();
3893 p = buf;
3895 if (print_inode)
3897 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3898 sprintf (p, "%*s ", inode_number_width,
3899 format_inode (hbuf, sizeof hbuf, f));
3900 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3901 The latter is wrong when inode_number_width is zero. */
3902 p += strlen (p);
3905 if (print_block_size)
3907 char hbuf[LONGEST_HUMAN_READABLE + 1];
3908 char const *blocks =
3909 (! f->stat_ok
3910 ? "?"
3911 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3912 ST_NBLOCKSIZE, output_block_size));
3913 int pad;
3914 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3915 *p++ = ' ';
3916 while ((*p++ = *blocks++))
3917 continue;
3918 p[-1] = ' ';
3921 /* The last byte of the mode string is the POSIX
3922 "optional alternate access method flag". */
3924 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3925 sprintf (p, "%s %*s ", modebuf, nlink_width,
3926 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3928 /* Increment by strlen (p) here, rather than by, e.g.,
3929 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3930 The latter is wrong when nlink_width is zero. */
3931 p += strlen (p);
3933 DIRED_INDENT ();
3935 if (print_owner || print_group || print_author || print_scontext)
3937 DIRED_FPUTS (buf, stdout, p - buf);
3939 if (print_owner)
3940 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3942 if (print_group)
3943 format_group (f->stat.st_gid, group_width, f->stat_ok);
3945 if (print_author)
3946 format_user (f->stat.st_author, author_width, f->stat_ok);
3948 if (print_scontext)
3949 format_user_or_group (f->scontext, 0, scontext_width);
3951 p = buf;
3954 if (f->stat_ok
3955 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3957 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3958 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3959 int blanks_width = (file_size_width
3960 - (major_device_number_width + 2
3961 + minor_device_number_width));
3962 sprintf (p, "%*s, %*s ",
3963 major_device_number_width + MAX (0, blanks_width),
3964 umaxtostr (major (f->stat.st_rdev), majorbuf),
3965 minor_device_number_width,
3966 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3967 p += file_size_width + 1;
3969 else
3971 char hbuf[LONGEST_HUMAN_READABLE + 1];
3972 char const *size =
3973 (! f->stat_ok
3974 ? "?"
3975 : human_readable (unsigned_file_size (f->stat.st_size),
3976 hbuf, file_human_output_opts, 1,
3977 file_output_block_size));
3978 int pad;
3979 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3980 *p++ = ' ';
3981 while ((*p++ = *size++))
3982 continue;
3983 p[-1] = ' ';
3986 when_local = localtime (&when_timespec.tv_sec);
3987 s = 0;
3988 *p = '\1';
3990 if (f->stat_ok && when_local)
3992 struct timespec six_months_ago;
3993 bool recent;
3994 char const *fmt;
3996 /* If the file appears to be in the future, update the current
3997 time, in case the file happens to have been modified since
3998 the last time we checked the clock. */
3999 if (timespec_cmp (current_time, when_timespec) < 0)
4001 /* Note that gettime may call gettimeofday which, on some non-
4002 compliant systems, clobbers the buffer used for localtime's result.
4003 But it's ok here, because we use a gettimeofday wrapper that
4004 saves and restores the buffer around the gettimeofday call. */
4005 gettime (&current_time);
4008 /* Consider a time to be recent if it is within the past six months.
4009 A Gregorian year has 365.2425 * 24 * 60 * 60 == 31556952 seconds
4010 on the average. Write this value as an integer constant to
4011 avoid floating point hassles. */
4012 six_months_ago.tv_sec = current_time.tv_sec - 31556952 / 2;
4013 six_months_ago.tv_nsec = current_time.tv_nsec;
4015 recent = (timespec_cmp (six_months_ago, when_timespec) < 0
4016 && (timespec_cmp (when_timespec, current_time) < 0));
4017 fmt = long_time_format[recent];
4019 /* We assume here that all time zones are offset from UTC by a
4020 whole number of seconds. */
4021 s = align_nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
4022 when_local, localtz, when_timespec.tv_nsec);
4025 if (s || !*p)
4027 p += s;
4028 *p++ = ' ';
4030 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
4031 *p = '\0';
4033 else
4035 /* The time cannot be converted using the desired format, so
4036 print it as a huge integer number of seconds. */
4037 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
4038 sprintf (p, "%*s ", long_time_expected_width (),
4039 (! f->stat_ok
4040 ? "?"
4041 : timetostr (when_timespec.tv_sec, hbuf)));
4042 /* FIXME: (maybe) We discarded when_timespec.tv_nsec. */
4043 p += strlen (p);
4046 DIRED_FPUTS (buf, stdout, p - buf);
4047 size_t w = print_name_with_quoting (f, false, &dired_obstack, p - buf);
4049 if (f->filetype == symbolic_link)
4051 if (f->linkname)
4053 DIRED_FPUTS_LITERAL (" -> ", stdout);
4054 print_name_with_quoting (f, true, NULL, (p - buf) + w + 4);
4055 if (indicator_style != none)
4056 print_type_indicator (true, f->linkmode, unknown);
4059 else if (indicator_style != none)
4060 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4063 /* Output to OUT a quoted representation of the file name NAME,
4064 using OPTIONS to control quoting. Produce no output if OUT is NULL.
4065 Store the number of screen columns occupied by NAME's quoted
4066 representation into WIDTH, if non-NULL. Return the number of bytes
4067 produced. */
4069 static size_t
4070 quote_name (FILE *out, const char *name, struct quoting_options const *options,
4071 size_t *width)
4073 char smallbuf[BUFSIZ];
4074 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
4075 char *buf;
4076 size_t displayed_width IF_LINT ( = 0);
4078 if (len < sizeof smallbuf)
4079 buf = smallbuf;
4080 else
4082 buf = alloca (len + 1);
4083 quotearg_buffer (buf, len + 1, name, -1, options);
4086 if (qmark_funny_chars)
4088 if (MB_CUR_MAX > 1)
4090 char const *p = buf;
4091 char const *plimit = buf + len;
4092 char *q = buf;
4093 displayed_width = 0;
4095 while (p < plimit)
4096 switch (*p)
4098 case ' ': case '!': case '"': case '#': case '%':
4099 case '&': case '\'': case '(': case ')': case '*':
4100 case '+': case ',': case '-': case '.': case '/':
4101 case '0': case '1': case '2': case '3': case '4':
4102 case '5': case '6': case '7': case '8': case '9':
4103 case ':': case ';': case '<': case '=': case '>':
4104 case '?':
4105 case 'A': case 'B': case 'C': case 'D': case 'E':
4106 case 'F': case 'G': case 'H': case 'I': case 'J':
4107 case 'K': case 'L': case 'M': case 'N': case 'O':
4108 case 'P': case 'Q': case 'R': case 'S': case 'T':
4109 case 'U': case 'V': case 'W': case 'X': case 'Y':
4110 case 'Z':
4111 case '[': case '\\': case ']': case '^': case '_':
4112 case 'a': case 'b': case 'c': case 'd': case 'e':
4113 case 'f': case 'g': case 'h': case 'i': case 'j':
4114 case 'k': case 'l': case 'm': case 'n': case 'o':
4115 case 'p': case 'q': case 'r': case 's': case 't':
4116 case 'u': case 'v': case 'w': case 'x': case 'y':
4117 case 'z': case '{': case '|': case '}': case '~':
4118 /* These characters are printable ASCII characters. */
4119 *q++ = *p++;
4120 displayed_width += 1;
4121 break;
4122 default:
4123 /* If we have a multibyte sequence, copy it until we
4124 reach its end, replacing each non-printable multibyte
4125 character with a single question mark. */
4127 mbstate_t mbstate = { 0, };
4130 wchar_t wc;
4131 size_t bytes;
4132 int w;
4134 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
4136 if (bytes == (size_t) -1)
4138 /* An invalid multibyte sequence was
4139 encountered. Skip one input byte, and
4140 put a question mark. */
4141 p++;
4142 *q++ = '?';
4143 displayed_width += 1;
4144 break;
4147 if (bytes == (size_t) -2)
4149 /* An incomplete multibyte character
4150 at the end. Replace it entirely with
4151 a question mark. */
4152 p = plimit;
4153 *q++ = '?';
4154 displayed_width += 1;
4155 break;
4158 if (bytes == 0)
4159 /* A null wide character was encountered. */
4160 bytes = 1;
4162 w = wcwidth (wc);
4163 if (w >= 0)
4165 /* A printable multibyte character.
4166 Keep it. */
4167 for (; bytes > 0; --bytes)
4168 *q++ = *p++;
4169 displayed_width += w;
4171 else
4173 /* An unprintable multibyte character.
4174 Replace it entirely with a question
4175 mark. */
4176 p += bytes;
4177 *q++ = '?';
4178 displayed_width += 1;
4181 while (! mbsinit (&mbstate));
4183 break;
4186 /* The buffer may have shrunk. */
4187 len = q - buf;
4189 else
4191 char *p = buf;
4192 char const *plimit = buf + len;
4194 while (p < plimit)
4196 if (! isprint (to_uchar (*p)))
4197 *p = '?';
4198 p++;
4200 displayed_width = len;
4203 else if (width != NULL)
4205 if (MB_CUR_MAX > 1)
4206 displayed_width = mbsnwidth (buf, len, 0);
4207 else
4209 char const *p = buf;
4210 char const *plimit = buf + len;
4212 displayed_width = 0;
4213 while (p < plimit)
4215 if (isprint (to_uchar (*p)))
4216 displayed_width++;
4217 p++;
4222 if (out != NULL)
4223 fwrite (buf, 1, len, out);
4224 if (width != NULL)
4225 *width = displayed_width;
4226 return len;
4229 static size_t
4230 print_name_with_quoting (const struct fileinfo *f,
4231 bool symlink_target,
4232 struct obstack *stack,
4233 size_t start_col)
4235 const char* name = symlink_target ? f->linkname : f->name;
4237 bool used_color_this_time
4238 = (print_with_color
4239 && (print_color_indicator (f, symlink_target)
4240 || is_colored (C_NORM)));
4242 if (stack)
4243 PUSH_CURRENT_DIRED_POS (stack);
4245 size_t width = quote_name (stdout, name, filename_quoting_options, NULL);
4246 dired_pos += width;
4248 if (stack)
4249 PUSH_CURRENT_DIRED_POS (stack);
4251 process_signals ();
4252 if (used_color_this_time)
4254 prep_non_filename_text ();
4255 if (line_length
4256 && (start_col / line_length != (start_col + width - 1) / line_length))
4257 put_indicator (&color_indicator[C_CLR_TO_EOL]);
4260 return width;
4263 static void
4264 prep_non_filename_text (void)
4266 if (color_indicator[C_END].string != NULL)
4267 put_indicator (&color_indicator[C_END]);
4268 else
4270 put_indicator (&color_indicator[C_LEFT]);
4271 put_indicator (&color_indicator[C_RESET]);
4272 put_indicator (&color_indicator[C_RIGHT]);
4276 /* Print the file name of 'f' with appropriate quoting.
4277 Also print file size, inode number, and filetype indicator character,
4278 as requested by switches. */
4280 static size_t
4281 print_file_name_and_frills (const struct fileinfo *f, size_t start_col)
4283 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4285 set_normal_color ();
4287 if (print_inode)
4288 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
4289 format_inode (buf, sizeof buf, f));
4291 if (print_block_size)
4292 printf ("%*s ", format == with_commas ? 0 : block_size_width,
4293 ! f->stat_ok ? "?"
4294 : human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
4295 ST_NBLOCKSIZE, output_block_size));
4297 if (print_scontext)
4298 printf ("%*s ", format == with_commas ? 0 : scontext_width, f->scontext);
4300 size_t width = print_name_with_quoting (f, false, NULL, start_col);
4302 if (indicator_style != none)
4303 width += print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4305 return width;
4308 /* Given these arguments describing a file, return the single-byte
4309 type indicator, or 0. */
4310 static char
4311 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4313 char c;
4315 if (stat_ok ? S_ISREG (mode) : type == normal)
4317 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
4318 c = '*';
4319 else
4320 c = 0;
4322 else
4324 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
4325 c = '/';
4326 else if (indicator_style == slash)
4327 c = 0;
4328 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
4329 c = '@';
4330 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
4331 c = '|';
4332 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
4333 c = '=';
4334 else if (stat_ok && S_ISDOOR (mode))
4335 c = '>';
4336 else
4337 c = 0;
4339 return c;
4342 static bool
4343 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4345 char c = get_type_indicator (stat_ok, mode, type);
4346 if (c)
4347 DIRED_PUTCHAR (c);
4348 return !!c;
4351 /* Returns whether any color sequence was printed. */
4352 static bool
4353 print_color_indicator (const struct fileinfo *f, bool symlink_target)
4355 enum indicator_no type;
4356 struct color_ext_type *ext; /* Color extension */
4357 size_t len; /* Length of name */
4359 const char* name;
4360 mode_t mode;
4361 int linkok;
4362 if (symlink_target)
4364 name = f->linkname;
4365 mode = f->linkmode;
4366 linkok = f->linkok ? 0 : -1;
4368 else
4370 name = f->name;
4371 mode = FILE_OR_LINK_MODE (f);
4372 linkok = f->linkok;
4375 /* Is this a nonexistent file? If so, linkok == -1. */
4377 if (linkok == -1 && is_colored (C_MISSING))
4378 type = C_MISSING;
4379 else if (!f->stat_ok)
4381 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
4382 type = filetype_indicator[f->filetype];
4384 else
4386 if (S_ISREG (mode))
4388 type = C_FILE;
4390 if ((mode & S_ISUID) != 0 && is_colored (C_SETUID))
4391 type = C_SETUID;
4392 else if ((mode & S_ISGID) != 0 && is_colored (C_SETGID))
4393 type = C_SETGID;
4394 else if (is_colored (C_CAP) && f->has_capability)
4395 type = C_CAP;
4396 else if ((mode & S_IXUGO) != 0 && is_colored (C_EXEC))
4397 type = C_EXEC;
4398 else if ((1 < f->stat.st_nlink) && is_colored (C_MULTIHARDLINK))
4399 type = C_MULTIHARDLINK;
4401 else if (S_ISDIR (mode))
4403 type = C_DIR;
4405 if ((mode & S_ISVTX) && (mode & S_IWOTH)
4406 && is_colored (C_STICKY_OTHER_WRITABLE))
4407 type = C_STICKY_OTHER_WRITABLE;
4408 else if ((mode & S_IWOTH) != 0 && is_colored (C_OTHER_WRITABLE))
4409 type = C_OTHER_WRITABLE;
4410 else if ((mode & S_ISVTX) != 0 && is_colored (C_STICKY))
4411 type = C_STICKY;
4413 else if (S_ISLNK (mode))
4414 type = C_LINK;
4415 else if (S_ISFIFO (mode))
4416 type = C_FIFO;
4417 else if (S_ISSOCK (mode))
4418 type = C_SOCK;
4419 else if (S_ISBLK (mode))
4420 type = C_BLK;
4421 else if (S_ISCHR (mode))
4422 type = C_CHR;
4423 else if (S_ISDOOR (mode))
4424 type = C_DOOR;
4425 else
4427 /* Classify a file of some other type as C_ORPHAN. */
4428 type = C_ORPHAN;
4432 /* Check the file's suffix only if still classified as C_FILE. */
4433 ext = NULL;
4434 if (type == C_FILE)
4436 /* Test if NAME has a recognized suffix. */
4438 len = strlen (name);
4439 name += len; /* Pointer to final \0. */
4440 for (ext = color_ext_list; ext != NULL; ext = ext->next)
4442 if (ext->ext.len <= len
4443 && STREQ_LEN (name - ext->ext.len, ext->ext.string,
4444 ext->ext.len))
4445 break;
4449 /* Adjust the color for orphaned symlinks. */
4450 if (type == C_LINK && !linkok)
4452 if (color_symlink_as_referent || is_colored (C_ORPHAN))
4453 type = C_ORPHAN;
4457 const struct bin_str *const s
4458 = ext ? &(ext->seq) : &color_indicator[type];
4459 if (s->string != NULL)
4461 /* Need to reset so not dealing with attribute combinations */
4462 if (is_colored (C_NORM))
4463 restore_default_color ();
4464 put_indicator (&color_indicator[C_LEFT]);
4465 put_indicator (s);
4466 put_indicator (&color_indicator[C_RIGHT]);
4467 return true;
4469 else
4470 return false;
4474 /* Output a color indicator (which may contain nulls). */
4475 static void
4476 put_indicator (const struct bin_str *ind)
4478 if (! used_color)
4480 used_color = true;
4481 prep_non_filename_text ();
4484 fwrite (ind->string, ind->len, 1, stdout);
4487 static size_t
4488 length_of_file_name_and_frills (const struct fileinfo *f)
4490 size_t len = 0;
4491 size_t name_width;
4492 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4494 if (print_inode)
4495 len += 1 + (format == with_commas
4496 ? strlen (umaxtostr (f->stat.st_ino, buf))
4497 : inode_number_width);
4499 if (print_block_size)
4500 len += 1 + (format == with_commas
4501 ? strlen (! f->stat_ok ? "?"
4502 : human_readable (ST_NBLOCKS (f->stat), buf,
4503 human_output_opts, ST_NBLOCKSIZE,
4504 output_block_size))
4505 : block_size_width);
4507 if (print_scontext)
4508 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
4510 quote_name (NULL, f->name, filename_quoting_options, &name_width);
4511 len += name_width;
4513 if (indicator_style != none)
4515 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4516 len += (c != 0);
4519 return len;
4522 static void
4523 print_many_per_line (void)
4525 size_t row; /* Current row. */
4526 size_t cols = calculate_columns (true);
4527 struct column_info const *line_fmt = &column_info[cols - 1];
4529 /* Calculate the number of rows that will be in each column except possibly
4530 for a short column on the right. */
4531 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
4533 for (row = 0; row < rows; row++)
4535 size_t col = 0;
4536 size_t filesno = row;
4537 size_t pos = 0;
4539 /* Print the next row. */
4540 while (1)
4542 struct fileinfo const *f = sorted_file[filesno];
4543 size_t name_length = length_of_file_name_and_frills (f);
4544 size_t max_name_length = line_fmt->col_arr[col++];
4545 print_file_name_and_frills (f, pos);
4547 filesno += rows;
4548 if (filesno >= cwd_n_used)
4549 break;
4551 indent (pos + name_length, pos + max_name_length);
4552 pos += max_name_length;
4554 putchar ('\n');
4558 static void
4559 print_horizontal (void)
4561 size_t filesno;
4562 size_t pos = 0;
4563 size_t cols = calculate_columns (false);
4564 struct column_info const *line_fmt = &column_info[cols - 1];
4565 struct fileinfo const *f = sorted_file[0];
4566 size_t name_length = length_of_file_name_and_frills (f);
4567 size_t max_name_length = line_fmt->col_arr[0];
4569 /* Print first entry. */
4570 print_file_name_and_frills (f, 0);
4572 /* Now the rest. */
4573 for (filesno = 1; filesno < cwd_n_used; ++filesno)
4575 size_t col = filesno % cols;
4577 if (col == 0)
4579 putchar ('\n');
4580 pos = 0;
4582 else
4584 indent (pos + name_length, pos + max_name_length);
4585 pos += max_name_length;
4588 f = sorted_file[filesno];
4589 print_file_name_and_frills (f, pos);
4591 name_length = length_of_file_name_and_frills (f);
4592 max_name_length = line_fmt->col_arr[col];
4594 putchar ('\n');
4597 /* Output name + SEP + ' '. */
4599 static void
4600 print_with_separator (char sep)
4602 size_t filesno;
4603 size_t pos = 0;
4605 for (filesno = 0; filesno < cwd_n_used; filesno++)
4607 struct fileinfo const *f = sorted_file[filesno];
4608 size_t len = line_length ? length_of_file_name_and_frills (f) : 0;
4610 if (filesno != 0)
4612 char separator;
4614 if (! line_length
4615 || ((pos + len + 2 < line_length)
4616 && (pos <= SIZE_MAX - len - 2)))
4618 pos += 2;
4619 separator = ' ';
4621 else
4623 pos = 0;
4624 separator = '\n';
4627 putchar (sep);
4628 putchar (separator);
4631 print_file_name_and_frills (f, pos);
4632 pos += len;
4634 putchar ('\n');
4637 /* Assuming cursor is at position FROM, indent up to position TO.
4638 Use a TAB character instead of two or more spaces whenever possible. */
4640 static void
4641 indent (size_t from, size_t to)
4643 while (from < to)
4645 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4647 putchar ('\t');
4648 from += tabsize - from % tabsize;
4650 else
4652 putchar (' ');
4653 from++;
4658 /* Put DIRNAME/NAME into DEST, handling '.' and '/' properly. */
4659 /* FIXME: maybe remove this function someday. See about using a
4660 non-malloc'ing version of file_name_concat. */
4662 static void
4663 attach (char *dest, const char *dirname, const char *name)
4665 const char *dirnamep = dirname;
4667 /* Copy dirname if it is not ".". */
4668 if (dirname[0] != '.' || dirname[1] != 0)
4670 while (*dirnamep)
4671 *dest++ = *dirnamep++;
4672 /* Add '/' if 'dirname' doesn't already end with it. */
4673 if (dirnamep > dirname && dirnamep[-1] != '/')
4674 *dest++ = '/';
4676 while (*name)
4677 *dest++ = *name++;
4678 *dest = 0;
4681 /* Allocate enough column info suitable for the current number of
4682 files and display columns, and initialize the info to represent the
4683 narrowest possible columns. */
4685 static void
4686 init_column_info (void)
4688 size_t i;
4689 size_t max_cols = MIN (max_idx, cwd_n_used);
4691 /* Currently allocated columns in column_info. */
4692 static size_t column_info_alloc;
4694 if (column_info_alloc < max_cols)
4696 size_t new_column_info_alloc;
4697 size_t *p;
4699 if (max_cols < max_idx / 2)
4701 /* The number of columns is far less than the display width
4702 allows. Grow the allocation, but only so that it's
4703 double the current requirements. If the display is
4704 extremely wide, this avoids allocating a lot of memory
4705 that is never needed. */
4706 column_info = xnrealloc (column_info, max_cols,
4707 2 * sizeof *column_info);
4708 new_column_info_alloc = 2 * max_cols;
4710 else
4712 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4713 new_column_info_alloc = max_idx;
4716 /* Allocate the new size_t objects by computing the triangle
4717 formula n * (n + 1) / 2, except that we don't need to
4718 allocate the part of the triangle that we've already
4719 allocated. Check for address arithmetic overflow. */
4721 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4722 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4723 size_t t = s * column_info_growth;
4724 if (s < new_column_info_alloc || t / column_info_growth != s)
4725 xalloc_die ();
4726 p = xnmalloc (t / 2, sizeof *p);
4729 /* Grow the triangle by parceling out the cells just allocated. */
4730 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4732 column_info[i].col_arr = p;
4733 p += i + 1;
4736 column_info_alloc = new_column_info_alloc;
4739 for (i = 0; i < max_cols; ++i)
4741 size_t j;
4743 column_info[i].valid_len = true;
4744 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4745 for (j = 0; j <= i; ++j)
4746 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4750 /* Calculate the number of columns needed to represent the current set
4751 of files in the current display width. */
4753 static size_t
4754 calculate_columns (bool by_columns)
4756 size_t filesno; /* Index into cwd_file. */
4757 size_t cols; /* Number of files across. */
4759 /* Normally the maximum number of columns is determined by the
4760 screen width. But if few files are available this might limit it
4761 as well. */
4762 size_t max_cols = MIN (max_idx, cwd_n_used);
4764 init_column_info ();
4766 /* Compute the maximum number of possible columns. */
4767 for (filesno = 0; filesno < cwd_n_used; ++filesno)
4769 struct fileinfo const *f = sorted_file[filesno];
4770 size_t name_length = length_of_file_name_and_frills (f);
4771 size_t i;
4773 for (i = 0; i < max_cols; ++i)
4775 if (column_info[i].valid_len)
4777 size_t idx = (by_columns
4778 ? filesno / ((cwd_n_used + i) / (i + 1))
4779 : filesno % (i + 1));
4780 size_t real_length = name_length + (idx == i ? 0 : 2);
4782 if (column_info[i].col_arr[idx] < real_length)
4784 column_info[i].line_len += (real_length
4785 - column_info[i].col_arr[idx]);
4786 column_info[i].col_arr[idx] = real_length;
4787 column_info[i].valid_len = (column_info[i].line_len
4788 < line_length);
4794 /* Find maximum allowed columns. */
4795 for (cols = max_cols; 1 < cols; --cols)
4797 if (column_info[cols - 1].valid_len)
4798 break;
4801 return cols;
4804 void
4805 usage (int status)
4807 if (status != EXIT_SUCCESS)
4808 emit_try_help ();
4809 else
4811 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4812 fputs (_("\
4813 List information about the FILEs (the current directory by default).\n\
4814 Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.\n\
4815 "), stdout);
4817 emit_mandatory_arg_note ();
4819 fputs (_("\
4820 -a, --all do not ignore entries starting with .\n\
4821 -A, --almost-all do not list implied . and ..\n\
4822 --author with -l, print the author of each file\n\
4823 -b, --escape print C-style escapes for nongraphic characters\n\
4824 "), stdout);
4825 fputs (_("\
4826 --block-size=SIZE scale sizes by SIZE before printing them; e.g.,\n\
4827 '--block-size=M' prints sizes in units of\n\
4828 1,048,576 bytes; see SIZE format below\n\
4829 -B, --ignore-backups do not list implied entries ending with ~\n\
4830 -c with -lt: sort by, and show, ctime (time of last\n\
4831 modification of file status information);\n\
4832 with -l: show ctime and sort by name;\n\
4833 otherwise: sort by ctime, newest first\n\
4834 "), stdout);
4835 fputs (_("\
4836 -C list entries by columns\n\
4837 --color[=WHEN] colorize the output; WHEN can be 'always' (default\
4839 if omitted), 'auto', or 'never'; more info below\
4841 -d, --directory list directories themselves, not their contents\n\
4842 -D, --dired generate output designed for Emacs' dired mode\n\
4843 "), stdout);
4844 fputs (_("\
4845 -f do not sort, enable -aU, disable -ls --color\n\
4846 -F, --classify append indicator (one of */=>@|) to entries\n\
4847 --file-type likewise, except do not append '*'\n\
4848 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4849 single-column -1, verbose -l, vertical -C\n\
4850 --full-time like -l --time-style=full-iso\n\
4851 "), stdout);
4852 fputs (_("\
4853 -g like -l, but do not list owner\n\
4854 "), stdout);
4855 fputs (_("\
4856 --group-directories-first\n\
4857 group directories before files;\n\
4858 can be augmented with a --sort option, but any\n\
4859 use of --sort=none (-U) disables grouping\n\
4860 "), stdout);
4861 fputs (_("\
4862 -G, --no-group in a long listing, don't print group names\n\
4863 -h, --human-readable with -l and/or -s, print human readable sizes\n\
4864 (e.g., 1K 234M 2G)\n\
4865 --si likewise, but use powers of 1000 not 1024\n\
4866 "), stdout);
4867 fputs (_("\
4868 -H, --dereference-command-line\n\
4869 follow symbolic links listed on the command line\n\
4870 --dereference-command-line-symlink-to-dir\n\
4871 follow each command line symbolic link\n\
4872 that points to a directory\n\
4873 --hide=PATTERN do not list implied entries matching shell PATTERN\
4875 (overridden by -a or -A)\n\
4876 "), stdout);
4877 fputs (_("\
4878 --indicator-style=WORD append indicator with style WORD to entry names:\
4880 none (default), slash (-p),\n\
4881 file-type (--file-type), classify (-F)\n\
4882 -i, --inode print the index number of each file\n\
4883 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\
4885 -k, --kibibytes default to 1024-byte blocks for disk usage\n\
4886 "), stdout);
4887 fputs (_("\
4888 -l use a long listing format\n\
4889 -L, --dereference when showing file information for a symbolic\n\
4890 link, show information for the file the link\n\
4891 references rather than for the link itself\n\
4892 -m fill width with a comma separated list of entries\
4894 "), stdout);
4895 fputs (_("\
4896 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4897 -N, --literal print raw entry names (don't treat e.g. control\n\
4898 characters specially)\n\
4899 -o like -l, but do not list group information\n\
4900 -p, --indicator-style=slash\n\
4901 append / indicator to directories\n\
4902 "), stdout);
4903 fputs (_("\
4904 -q, --hide-control-chars print ? instead of nongraphic characters\n\
4905 --show-control-chars show nongraphic characters as-is (the default,\n\
4906 unless program is 'ls' and output is a terminal)\
4908 -Q, --quote-name enclose entry names in double quotes\n\
4909 --quoting-style=WORD use quoting style WORD for entry names:\n\
4910 literal, locale, shell, shell-always, c, escape\
4912 "), stdout);
4913 fputs (_("\
4914 -r, --reverse reverse order while sorting\n\
4915 -R, --recursive list subdirectories recursively\n\
4916 -s, --size print the allocated size of each file, in blocks\n\
4917 "), stdout);
4918 fputs (_("\
4919 -S sort by file size, largest first\n\
4920 --sort=WORD sort by WORD instead of name: none (-U), size (-S)\
4921 ,\n\
4922 time (-t), version (-v), extension (-X)\n\
4923 --time=WORD with -l, show time as WORD instead of default\n\
4924 modification time: atime or access or use (-u);\
4926 ctime or status (-c); also use specified time\n\
4927 as sort key if --sort=time (newest first)\n\
4928 "), stdout);
4929 fputs (_("\
4930 --time-style=STYLE with -l, show times using style STYLE:\n\
4931 full-iso, long-iso, iso, locale, or +FORMAT;\n\
4932 FORMAT is interpreted like in 'date'; if FORMAT\
4934 is FORMAT1<newline>FORMAT2, then FORMAT1 applies\
4936 to non-recent files and FORMAT2 to recent files;\
4938 if STYLE is prefixed with 'posix-', STYLE\n\
4939 takes effect only outside the POSIX locale\n\
4940 "), stdout);
4941 fputs (_("\
4942 -t sort by modification time, newest first\n\
4943 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4944 "), stdout);
4945 fputs (_("\
4946 -u with -lt: sort by, and show, access time;\n\
4947 with -l: show access time and sort by name;\n\
4948 otherwise: sort by access time, newest first\n\
4949 -U do not sort; list entries in directory order\n\
4950 -v natural sort of (version) numbers within text\n\
4951 "), stdout);
4952 fputs (_("\
4953 -w, --width=COLS set output width to COLS. 0 means no limit\n\
4954 -x list entries by lines instead of by columns\n\
4955 -X sort alphabetically by entry extension\n\
4956 -Z, --context print any security context of each file\n\
4957 -1 list one file per line. Avoid '\\n' with -q or -b\
4959 "), stdout);
4960 fputs (HELP_OPTION_DESCRIPTION, stdout);
4961 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4962 emit_size_note ();
4963 fputs (_("\
4965 Using color to distinguish file types is disabled both by default and\n\
4966 with --color=never. With --color=auto, ls emits color codes only when\n\
4967 standard output is connected to a terminal. The LS_COLORS environment\n\
4968 variable can change the settings. Use the dircolors command to set it.\n\
4969 "), stdout);
4970 fputs (_("\
4972 Exit status:\n\
4973 0 if OK,\n\
4974 1 if minor problems (e.g., cannot access subdirectory),\n\
4975 2 if serious trouble (e.g., cannot access command-line argument).\n\
4976 "), stdout);
4977 emit_ancillary_info (PROGRAM_NAME);
4979 exit (status);