doc: improve various BLOCKSIZE and SIZE help
[coreutils.git] / src / ls.c
blobb62ea128c925baa730acca4d5ba9788466ec3fac
1 /* `dir', `vdir' and `ls' directory listing programs for GNU.
2 Copyright (C) 85, 88, 90, 91, 1995-2009 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 #ifdef HAVE_CAP
42 # include <sys/capability.h>
43 #endif
45 #if HAVE_TERMIOS_H
46 # include <termios.h>
47 #endif
48 #if HAVE_STROPTS_H
49 # include <stropts.h>
50 #endif
51 #if HAVE_SYS_IOCTL_H
52 # include <sys/ioctl.h>
53 #endif
55 #ifdef WINSIZE_IN_PTEM
56 # include <sys/stream.h>
57 # include <sys/ptem.h>
58 #endif
60 #include <stdio.h>
61 #include <assert.h>
62 #include <setjmp.h>
63 #include <grp.h>
64 #include <pwd.h>
65 #include <getopt.h>
66 #include <signal.h>
67 #include <selinux/selinux.h>
68 #include <wchar.h>
70 #if HAVE_LANGINFO_CODESET
71 # include <langinfo.h>
72 #endif
74 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
75 present. */
76 #ifndef SA_NOCLDSTOP
77 # define SA_NOCLDSTOP 0
78 # define sigprocmask(How, Set, Oset) /* empty */
79 # define sigset_t int
80 # if ! HAVE_SIGINTERRUPT
81 # define siginterrupt(sig, flag) /* empty */
82 # endif
83 #endif
84 #ifndef SA_RESTART
85 # define SA_RESTART 0
86 #endif
88 #include "system.h"
89 #include <fnmatch.h>
91 #include "acl.h"
92 #include "argmatch.h"
93 #include "dev-ino.h"
94 #include "error.h"
95 #include "filenamecat.h"
96 #include "hash.h"
97 #include "human.h"
98 #include "filemode.h"
99 #include "filevercmp.h"
100 #include "idcache.h"
101 #include "ls.h"
102 #include "mbswidth.h"
103 #include "mpsort.h"
104 #include "obstack.h"
105 #include "quote.h"
106 #include "quotearg.h"
107 #include "same.h"
108 #include "stat-time.h"
109 #include "strftime.h"
110 #include "xstrtol.h"
111 #include "areadlink.h"
112 #include "mbsalign.h"
114 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
115 : (ls_mode == LS_MULTI_COL \
116 ? "dir" : "vdir"))
118 #define AUTHORS \
119 proper_name ("Richard M. Stallman"), \
120 proper_name ("David MacKenzie")
122 #define obstack_chunk_alloc malloc
123 #define obstack_chunk_free free
125 /* Return an int indicating the result of comparing two integers.
126 Subtracting doesn't always work, due to overflow. */
127 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
129 /* Unix-based readdir implementations have historically returned a dirent.d_ino
130 value that is sometimes not equal to the stat-obtained st_ino value for
131 that same entry. This error occurs for a readdir entry that refers
132 to a mount point. readdir's error is to return the inode number of
133 the underlying directory -- one that typically cannot be stat'ed, as
134 long as a file system is mounted on that directory. RELIABLE_D_INO
135 encapsulates whether we can use the more efficient approach of relying
136 on readdir-supplied d_ino values, or whether we must incur the cost of
137 calling stat or lstat to obtain each guaranteed-valid inode number. */
139 #ifndef READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
140 # define READDIR_LIES_ABOUT_MOUNTPOINT_D_INO 1
141 #endif
143 #if READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
144 # define RELIABLE_D_INO(dp) NOT_AN_INODE_NUMBER
145 #else
146 # define RELIABLE_D_INO(dp) D_INO (dp)
147 #endif
149 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
150 # define st_author st_uid
151 #endif
153 enum filetype
155 unknown,
156 fifo,
157 chardev,
158 directory,
159 blockdev,
160 normal,
161 symbolic_link,
162 sock,
163 whiteout,
164 arg_directory
167 /* Display letters and indicators for each filetype.
168 Keep these in sync with enum filetype. */
169 static char const filetype_letter[] = "?pcdb-lswd";
171 /* Ensure that filetype and filetype_letter have the same
172 number of elements. */
173 verify (sizeof filetype_letter - 1 == arg_directory + 1);
175 #define FILETYPE_INDICATORS \
177 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
178 C_LINK, C_SOCK, C_FILE, C_DIR \
181 enum acl_type
183 ACL_T_NONE,
184 ACL_T_SELINUX_ONLY,
185 ACL_T_YES
188 struct fileinfo
190 /* The file name. */
191 char *name;
193 /* For symbolic link, name of the file linked to, otherwise zero. */
194 char *linkname;
196 struct stat stat;
198 enum filetype filetype;
200 /* For symbolic link and long listing, st_mode of file linked to, otherwise
201 zero. */
202 mode_t linkmode;
204 /* SELinux security context. */
205 security_context_t scontext;
207 bool stat_ok;
209 /* For symbolic link and color printing, true if linked-to file
210 exists, otherwise false. */
211 bool linkok;
213 /* For long listings, true if the file has an access control list,
214 or an SELinux security context. */
215 enum acl_type acl_type;
218 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
220 /* Null is a valid character in a color indicator (think about Epson
221 printers, for example) so we have to use a length/buffer string
222 type. */
224 struct bin_str
226 size_t len; /* Number of bytes */
227 const char *string; /* Pointer to the same */
230 #if ! HAVE_TCGETPGRP
231 # define tcgetpgrp(Fd) 0
232 #endif
234 static size_t quote_name (FILE *out, const char *name,
235 struct quoting_options const *options,
236 size_t *width);
237 static char *make_link_name (char const *name, char const *linkname);
238 static int decode_switches (int argc, char **argv);
239 static bool file_ignored (char const *name);
240 static uintmax_t gobble_file (char const *name, enum filetype type,
241 ino_t inode, bool command_line_arg,
242 char const *dirname);
243 static bool print_color_indicator (const char *name, mode_t mode, int linkok,
244 bool stat_ok, enum filetype type,
245 nlink_t nlink);
246 static void put_indicator (const struct bin_str *ind);
247 static void add_ignore_pattern (const char *pattern);
248 static void attach (char *dest, const char *dirname, const char *name);
249 static void clear_files (void);
250 static void extract_dirs_from_files (char const *dirname,
251 bool command_line_arg);
252 static void get_link_name (char const *filename, struct fileinfo *f,
253 bool command_line_arg);
254 static void indent (size_t from, size_t to);
255 static size_t calculate_columns (bool by_columns);
256 static void print_current_files (void);
257 static void print_dir (char const *name, char const *realname,
258 bool command_line_arg);
259 static size_t print_file_name_and_frills (const struct fileinfo *f,
260 size_t start_col);
261 static void print_horizontal (void);
262 static int format_user_width (uid_t u);
263 static int format_group_width (gid_t g);
264 static void print_long_format (const struct fileinfo *f);
265 static void print_many_per_line (void);
266 static size_t print_name_with_quoting (const char *p, mode_t mode,
267 int linkok, bool stat_ok,
268 enum filetype type,
269 struct obstack *stack,
270 nlink_t nlink,
271 size_t start_col);
272 static void prep_non_filename_text (void);
273 static bool print_type_indicator (bool stat_ok, mode_t mode,
274 enum filetype type);
275 static void print_with_commas (void);
276 static void queue_directory (char const *name, char const *realname,
277 bool command_line_arg);
278 static void sort_files (void);
279 static void parse_ls_color (void);
280 void usage (int status);
282 /* Initial size of hash table.
283 Most hierarchies are likely to be shallower than this. */
284 #define INITIAL_TABLE_SIZE 30
286 /* The set of `active' directories, from the current command-line argument
287 to the level in the hierarchy at which files are being listed.
288 A directory is represented by its device and inode numbers (struct dev_ino).
289 A directory is added to this set when ls begins listing it or its
290 entries, and it is removed from the set just after ls has finished
291 processing it. This set is used solely to detect loops, e.g., with
292 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
293 static Hash_table *active_dir_set;
295 #define LOOP_DETECT (!!active_dir_set)
297 /* The table of files in the current directory:
299 `cwd_file' points to a vector of `struct fileinfo', one per file.
300 `cwd_n_alloc' is the number of elements space has been allocated for.
301 `cwd_n_used' is the number actually in use. */
303 /* Address of block containing the files that are described. */
304 static struct fileinfo *cwd_file;
306 /* Length of block that `cwd_file' points to, measured in files. */
307 static size_t cwd_n_alloc;
309 /* Index of first unused slot in `cwd_file'. */
310 static size_t cwd_n_used;
312 /* Vector of pointers to files, in proper sorted order, and the number
313 of entries allocated for it. */
314 static void **sorted_file;
315 static size_t sorted_file_alloc;
317 /* When true, in a color listing, color each symlink name according to the
318 type of file it points to. Otherwise, color them according to the `ln'
319 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
320 regardless. This is set when `ln=target' appears in LS_COLORS. */
322 static bool color_symlink_as_referent;
324 /* mode of appropriate file for colorization */
325 #define FILE_OR_LINK_MODE(File) \
326 ((color_symlink_as_referent & (File)->linkok) \
327 ? (File)->linkmode : (File)->stat.st_mode)
330 /* Record of one pending directory waiting to be listed. */
332 struct pending
334 char *name;
335 /* If the directory is actually the file pointed to by a symbolic link we
336 were told to list, `realname' will contain the name of the symbolic
337 link, otherwise zero. */
338 char *realname;
339 bool command_line_arg;
340 struct pending *next;
343 static struct pending *pending_dirs;
345 /* Current time in seconds and nanoseconds since 1970, updated as
346 needed when deciding whether a file is recent. */
348 static struct timespec current_time;
350 static bool print_scontext;
351 static char UNKNOWN_SECURITY_CONTEXT[] = "?";
353 /* Whether any of the files has an ACL. This affects the width of the
354 mode column. */
356 static bool any_has_acl;
358 /* The number of columns to use for columns containing inode numbers,
359 block sizes, link counts, owners, groups, authors, major device
360 numbers, minor device numbers, and file sizes, respectively. */
362 static int inode_number_width;
363 static int block_size_width;
364 static int nlink_width;
365 static int scontext_width;
366 static int owner_width;
367 static int group_width;
368 static int author_width;
369 static int major_device_number_width;
370 static int minor_device_number_width;
371 static int file_size_width;
373 /* Option flags */
375 /* long_format for lots of info, one per line.
376 one_per_line for just names, one per line.
377 many_per_line for just names, many per line, sorted vertically.
378 horizontal for just names, many per line, sorted horizontally.
379 with_commas for just names, many per line, separated by commas.
381 -l (and other options that imply -l), -1, -C, -x and -m control
382 this parameter. */
384 enum format
386 long_format, /* -l and other options that imply -l */
387 one_per_line, /* -1 */
388 many_per_line, /* -C */
389 horizontal, /* -x */
390 with_commas /* -m */
393 static enum format format;
395 /* `full-iso' uses full ISO-style dates and times. `long-iso' uses longer
396 ISO-style time stamps, though shorter than `full-iso'. `iso' uses shorter
397 ISO-style time stamps. `locale' uses locale-dependent time stamps. */
398 enum time_style
400 full_iso_time_style, /* --time-style=full-iso */
401 long_iso_time_style, /* --time-style=long-iso */
402 iso_time_style, /* --time-style=iso */
403 locale_time_style /* --time-style=locale */
406 static char const *const time_style_args[] =
408 "full-iso", "long-iso", "iso", "locale", NULL
410 static enum time_style const time_style_types[] =
412 full_iso_time_style, long_iso_time_style, iso_time_style,
413 locale_time_style
415 ARGMATCH_VERIFY (time_style_args, time_style_types);
417 /* Type of time to print or sort by. Controlled by -c and -u.
418 The values of each item of this enum are important since they are
419 used as indices in the sort functions array (see sort_files()). */
421 enum time_type
423 time_mtime, /* default */
424 time_ctime, /* -c */
425 time_atime, /* -u */
426 time_numtypes /* the number of elements of this enum */
429 static enum time_type time_type;
431 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
432 The values of each item of this enum are important since they are
433 used as indices in the sort functions array (see sort_files()). */
435 enum sort_type
437 sort_none = -1, /* -U */
438 sort_name, /* default */
439 sort_extension, /* -X */
440 sort_size, /* -S */
441 sort_version, /* -v */
442 sort_time, /* -t */
443 sort_numtypes /* the number of elements of this enum */
446 static enum sort_type sort_type;
448 /* Direction of sort.
449 false means highest first if numeric,
450 lowest first if alphabetic;
451 these are the defaults.
452 true means the opposite order in each case. -r */
454 static bool sort_reverse;
456 /* True means to display owner information. -g turns this off. */
458 static bool print_owner = true;
460 /* True means to display author information. */
462 static bool print_author;
464 /* True means to display group information. -G and -o turn this off. */
466 static bool print_group = true;
468 /* True means print the user and group id's as numbers rather
469 than as names. -n */
471 static bool numeric_ids;
473 /* True means mention the size in blocks of each file. -s */
475 static bool print_block_size;
477 /* Human-readable options for output. */
478 static int human_output_opts;
480 /* The units to use when printing sizes other than file sizes. */
481 static uintmax_t output_block_size;
483 /* Likewise, but for file sizes. */
484 static uintmax_t file_output_block_size = 1;
486 /* Follow the output with a special string. Using this format,
487 Emacs' dired mode starts up twice as fast, and can handle all
488 strange characters in file names. */
489 static bool dired;
491 /* `none' means don't mention the type of files.
492 `slash' means mention directories only, with a '/'.
493 `file_type' means mention file types.
494 `classify' means mention file types and mark executables.
496 Controlled by -F, -p, and --indicator-style. */
498 enum indicator_style
500 none, /* --indicator-style=none */
501 slash, /* -p, --indicator-style=slash */
502 file_type, /* --indicator-style=file-type */
503 classify /* -F, --indicator-style=classify */
506 static enum indicator_style indicator_style;
508 /* Names of indicator styles. */
509 static char const *const indicator_style_args[] =
511 "none", "slash", "file-type", "classify", NULL
513 static enum indicator_style const indicator_style_types[] =
515 none, slash, file_type, classify
517 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
519 /* True means use colors to mark types. Also define the different
520 colors as well as the stuff for the LS_COLORS environment variable.
521 The LS_COLORS variable is now in a termcap-like format. */
523 static bool print_with_color;
525 /* Whether we used any colors in the output so far. If so, we will
526 need to restore the default color later. If not, we will need to
527 call prep_non_filename_text before using color for the first time. */
529 static bool used_color = false;
531 enum color_type
533 color_never, /* 0: default or --color=never */
534 color_always, /* 1: --color=always */
535 color_if_tty /* 2: --color=tty */
538 enum Dereference_symlink
540 DEREF_UNDEFINED = 1,
541 DEREF_NEVER,
542 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
543 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
544 DEREF_ALWAYS /* -L */
547 enum indicator_no
549 C_LEFT, C_RIGHT, C_END, C_RESET, C_NORM, C_FILE, C_DIR, C_LINK,
550 C_FIFO, C_SOCK,
551 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
552 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE, C_CAP, C_MULTIHARDLINK,
553 C_CLR_TO_EOL
556 static const char *const indicator_name[]=
558 "lc", "rc", "ec", "rs", "no", "fi", "di", "ln", "pi", "so",
559 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
560 "ow", "tw", "ca", "mh", "cl", NULL
563 struct color_ext_type
565 struct bin_str ext; /* The extension we're looking for */
566 struct bin_str seq; /* The sequence to output when we do */
567 struct color_ext_type *next; /* Next in list */
570 static struct bin_str color_indicator[] =
572 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
573 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
574 { 0, NULL }, /* ec: End color (replaces lc+no+rc) */
575 { LEN_STR_PAIR ("0") }, /* rs: Reset to ordinary colors */
576 { 0, NULL }, /* no: Normal */
577 { 0, NULL }, /* fi: File: default */
578 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
579 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
580 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
581 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
582 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
583 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
584 { 0, NULL }, /* mi: Missing file: undefined */
585 { 0, NULL }, /* or: Orphaned symlink: undefined */
586 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
587 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
588 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
589 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
590 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
591 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
592 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
593 { LEN_STR_PAIR ("30;41") }, /* ca: black on red */
594 { 0, NULL }, /* mh: disabled by default */
595 { LEN_STR_PAIR ("\033[K") }, /* cl: clear to end of line */
598 /* FIXME: comment */
599 static struct color_ext_type *color_ext_list = NULL;
601 /* Buffer for color sequences */
602 static char *color_buf;
604 /* True means to check for orphaned symbolic link, for displaying
605 colors. */
607 static bool check_symlink_color;
609 /* True means mention the inode number of each file. -i */
611 static bool print_inode;
613 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
614 other options that imply -l), and -L. */
616 static enum Dereference_symlink dereference;
618 /* True means when a directory is found, display info on its
619 contents. -R */
621 static bool recursive;
623 /* True means when an argument is a directory name, display info
624 on it itself. -d */
626 static bool immediate_dirs;
628 /* True means that directories are grouped before files. */
630 static bool directories_first;
632 /* Which files to ignore. */
634 static enum
636 /* Ignore files whose names start with `.', and files specified by
637 --hide and --ignore. */
638 IGNORE_DEFAULT,
640 /* Ignore `.', `..', and files specified by --ignore. */
641 IGNORE_DOT_AND_DOTDOT,
643 /* Ignore only files specified by --ignore. */
644 IGNORE_MINIMAL
645 } ignore_mode;
647 /* A linked list of shell-style globbing patterns. If a non-argument
648 file name matches any of these patterns, it is ignored.
649 Controlled by -I. Multiple -I options accumulate.
650 The -B option adds `*~' and `.*~' to this list. */
652 struct ignore_pattern
654 const char *pattern;
655 struct ignore_pattern *next;
658 static struct ignore_pattern *ignore_patterns;
660 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
661 variable itself to be ignored. */
662 static struct ignore_pattern *hide_patterns;
664 /* True means output nongraphic chars in file names as `?'.
665 (-q, --hide-control-chars)
666 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
667 independent. The algorithm is: first, obey the quoting style to get a
668 string representing the file name; then, if qmark_funny_chars is set,
669 replace all nonprintable chars in that string with `?'. It's necessary
670 to replace nonprintable chars even in quoted strings, because we don't
671 want to mess up the terminal if control chars get sent to it, and some
672 quoting methods pass through control chars as-is. */
673 static bool qmark_funny_chars;
675 /* Quoting options for file and dir name output. */
677 static struct quoting_options *filename_quoting_options;
678 static struct quoting_options *dirname_quoting_options;
680 /* The number of chars per hardware tab stop. Setting this to zero
681 inhibits the use of TAB characters for separating columns. -T */
682 static size_t tabsize;
684 /* True means print each directory name before listing it. */
686 static bool print_dir_name;
688 /* The line length to use for breaking lines in many-per-line format.
689 Can be set with -w. */
691 static size_t line_length;
693 /* If true, the file listing format requires that stat be called on
694 each file. */
696 static bool format_needs_stat;
698 /* Similar to `format_needs_stat', but set if only the file type is
699 needed. */
701 static bool format_needs_type;
703 /* An arbitrary limit on the number of bytes in a printed time stamp.
704 This is set to a relatively small value to avoid the need to worry
705 about denial-of-service attacks on servers that run "ls" on behalf
706 of remote clients. 1000 bytes should be enough for any practical
707 time stamp format. */
709 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
711 /* strftime formats for non-recent and recent files, respectively, in
712 -l output. */
714 static char const *long_time_format[2] =
716 /* strftime format for non-recent files (older than 6 months), in
717 -l output. This should contain the year, month and day (at
718 least), in an order that is understood by people in your
719 locale's territory. Please try to keep the number of used
720 screen columns small, because many people work in windows with
721 only 80 columns. But make this as wide as the other string
722 below, for recent files. */
723 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
724 so be wary of using variable width fields from the locale.
725 Note %b is handled specially by ls and aligned correctly.
726 Note also that specifying a width as in %5b is erroneous as strftime
727 will count bytes rather than characters in multibyte locales. */
728 N_("%b %e %Y"),
729 /* strftime format for recent files (younger than 6 months), in -l
730 output. This should contain the month, day and time (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 above, for non-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 %H:%M")
744 /* The set of signals that are caught. */
746 static sigset_t caught_signals;
748 /* If nonzero, the value of the pending fatal signal. */
750 static sig_atomic_t volatile interrupt_signal;
752 /* A count of the number of pending stop signals that have been received. */
754 static sig_atomic_t volatile stop_signal_count;
756 /* Desired exit status. */
758 static int exit_status;
760 /* Exit statuses. */
761 enum
763 /* "ls" had a minor problem. E.g., while processing a directory,
764 ls obtained the name of an entry via readdir, yet was later
765 unable to stat that name. This happens when listing a directory
766 in which entries are actively being removed or renamed. */
767 LS_MINOR_PROBLEM = 1,
769 /* "ls" had more serious trouble (e.g., memory exhausted, invalid
770 option or failure to stat a command line argument. */
771 LS_FAILURE = 2
774 /* For long options that have no equivalent short option, use a
775 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
776 enum
778 AUTHOR_OPTION = CHAR_MAX + 1,
779 BLOCK_SIZE_OPTION,
780 COLOR_OPTION,
781 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
782 FILE_TYPE_INDICATOR_OPTION,
783 FORMAT_OPTION,
784 FULL_TIME_OPTION,
785 GROUP_DIRECTORIES_FIRST_OPTION,
786 HIDE_OPTION,
787 INDICATOR_STYLE_OPTION,
788 QUOTING_STYLE_OPTION,
789 SHOW_CONTROL_CHARS_OPTION,
790 SI_OPTION,
791 SORT_OPTION,
792 TIME_OPTION,
793 TIME_STYLE_OPTION
796 static struct option const long_options[] =
798 {"all", no_argument, NULL, 'a'},
799 {"escape", no_argument, NULL, 'b'},
800 {"directory", no_argument, NULL, 'd'},
801 {"dired", no_argument, NULL, 'D'},
802 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
803 {"group-directories-first", no_argument, NULL,
804 GROUP_DIRECTORIES_FIRST_OPTION},
805 {"human-readable", no_argument, NULL, 'h'},
806 {"inode", no_argument, NULL, 'i'},
807 {"numeric-uid-gid", no_argument, NULL, 'n'},
808 {"no-group", no_argument, NULL, 'G'},
809 {"hide-control-chars", no_argument, NULL, 'q'},
810 {"reverse", no_argument, NULL, 'r'},
811 {"size", no_argument, NULL, 's'},
812 {"width", required_argument, NULL, 'w'},
813 {"almost-all", no_argument, NULL, 'A'},
814 {"ignore-backups", no_argument, NULL, 'B'},
815 {"classify", no_argument, NULL, 'F'},
816 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
817 {"si", no_argument, NULL, SI_OPTION},
818 {"dereference-command-line", no_argument, NULL, 'H'},
819 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
820 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
821 {"hide", required_argument, NULL, HIDE_OPTION},
822 {"ignore", required_argument, NULL, 'I'},
823 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
824 {"dereference", no_argument, NULL, 'L'},
825 {"literal", no_argument, NULL, 'N'},
826 {"quote-name", no_argument, NULL, 'Q'},
827 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
828 {"recursive", no_argument, NULL, 'R'},
829 {"format", required_argument, NULL, FORMAT_OPTION},
830 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
831 {"sort", required_argument, NULL, SORT_OPTION},
832 {"tabsize", required_argument, NULL, 'T'},
833 {"time", required_argument, NULL, TIME_OPTION},
834 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
835 {"color", optional_argument, NULL, COLOR_OPTION},
836 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
837 {"context", no_argument, 0, 'Z'},
838 {"author", no_argument, NULL, AUTHOR_OPTION},
839 {GETOPT_HELP_OPTION_DECL},
840 {GETOPT_VERSION_OPTION_DECL},
841 {NULL, 0, NULL, 0}
844 static char const *const format_args[] =
846 "verbose", "long", "commas", "horizontal", "across",
847 "vertical", "single-column", NULL
849 static enum format const format_types[] =
851 long_format, long_format, with_commas, horizontal, horizontal,
852 many_per_line, one_per_line
854 ARGMATCH_VERIFY (format_args, format_types);
856 static char const *const sort_args[] =
858 "none", "time", "size", "extension", "version", NULL
860 static enum sort_type const sort_types[] =
862 sort_none, sort_time, sort_size, sort_extension, sort_version
864 ARGMATCH_VERIFY (sort_args, sort_types);
866 static char const *const time_args[] =
868 "atime", "access", "use", "ctime", "status", NULL
870 static enum time_type const time_types[] =
872 time_atime, time_atime, time_atime, time_ctime, time_ctime
874 ARGMATCH_VERIFY (time_args, time_types);
876 static char const *const color_args[] =
878 /* force and none are for compatibility with another color-ls version */
879 "always", "yes", "force",
880 "never", "no", "none",
881 "auto", "tty", "if-tty", NULL
883 static enum color_type const color_types[] =
885 color_always, color_always, color_always,
886 color_never, color_never, color_never,
887 color_if_tty, color_if_tty, color_if_tty
889 ARGMATCH_VERIFY (color_args, color_types);
891 /* Information about filling a column. */
892 struct column_info
894 bool valid_len;
895 size_t line_len;
896 size_t *col_arr;
899 /* Array with information about column filledness. */
900 static struct column_info *column_info;
902 /* Maximum number of columns ever possible for this display. */
903 static size_t max_idx;
905 /* The minimum width of a column is 3: 1 character for the name and 2
906 for the separating white space. */
907 #define MIN_COLUMN_WIDTH 3
910 /* This zero-based index is used solely with the --dired option.
911 When that option is in effect, this counter is incremented for each
912 byte of output generated by this program so that the beginning
913 and ending indices (in that output) of every file name can be recorded
914 and later output themselves. */
915 static size_t dired_pos;
917 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
919 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
920 #define DIRED_FPUTS(s, stream, s_len) \
921 do {fputs (s, stream); dired_pos += s_len;} while (0)
923 /* Like DIRED_FPUTS, but for use when S is a literal string. */
924 #define DIRED_FPUTS_LITERAL(s, stream) \
925 do {fputs (s, stream); dired_pos += sizeof (s) - 1;} while (0)
927 #define DIRED_INDENT() \
928 do \
930 if (dired) \
931 DIRED_FPUTS_LITERAL (" ", stdout); \
933 while (0)
935 /* With --dired, store pairs of beginning and ending indices of filenames. */
936 static struct obstack dired_obstack;
938 /* With --dired, store pairs of beginning and ending indices of any
939 directory names that appear as headers (just before `total' line)
940 for lists of directory entries. Such directory names are seen when
941 listing hierarchies using -R and when a directory is listed with at
942 least one other command line argument. */
943 static struct obstack subdired_obstack;
945 /* Save the current index on the specified obstack, OBS. */
946 #define PUSH_CURRENT_DIRED_POS(obs) \
947 do \
949 if (dired) \
950 obstack_grow (obs, &dired_pos, sizeof (dired_pos)); \
952 while (0)
954 /* With -R, this stack is used to help detect directory cycles.
955 The device/inode pairs on this stack mirror the pairs in the
956 active_dir_set hash table. */
957 static struct obstack dev_ino_obstack;
959 /* Push a pair onto the device/inode stack. */
960 #define DEV_INO_PUSH(Dev, Ino) \
961 do \
963 struct dev_ino *di; \
964 obstack_blank (&dev_ino_obstack, sizeof (struct dev_ino)); \
965 di = -1 + (struct dev_ino *) obstack_next_free (&dev_ino_obstack); \
966 di->st_dev = (Dev); \
967 di->st_ino = (Ino); \
969 while (0)
971 /* Pop a dev/ino struct off the global dev_ino_obstack
972 and return that struct. */
973 static struct dev_ino
974 dev_ino_pop (void)
976 assert (sizeof (struct dev_ino) <= obstack_object_size (&dev_ino_obstack));
977 obstack_blank (&dev_ino_obstack, -(int) (sizeof (struct dev_ino)));
978 return *(struct dev_ino *) obstack_next_free (&dev_ino_obstack);
981 /* Note the use commented out below:
982 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
983 do \
985 struct stat sb; \
986 assert (Name); \
987 assert (0 <= stat (Name, &sb)); \
988 assert (sb.st_dev == Di.st_dev); \
989 assert (sb.st_ino == Di.st_ino); \
991 while (0)
994 /* Write to standard output PREFIX, followed by the quoting style and
995 a space-separated list of the integers stored in OS all on one line. */
997 static void
998 dired_dump_obstack (const char *prefix, struct obstack *os)
1000 size_t n_pos;
1002 n_pos = obstack_object_size (os) / sizeof (dired_pos);
1003 if (n_pos > 0)
1005 size_t i;
1006 size_t *pos;
1008 pos = (size_t *) obstack_finish (os);
1009 fputs (prefix, stdout);
1010 for (i = 0; i < n_pos; i++)
1011 printf (" %lu", (unsigned long int) pos[i]);
1012 putchar ('\n');
1016 /* Read the abbreviated month names from the locale, to align them
1017 and to determine the max width of the field and to truncate names
1018 greater than our max allowed.
1019 Note even though this handles multibyte locales correctly
1020 it's not restricted to them as single byte locales can have
1021 variable width abbreviated months and also precomputing/caching
1022 the names was seen to increase the performance of ls significantly. */
1024 /* max number of display cells to use */
1025 enum { MAX_MON_WIDTH = 5 };
1026 /* In the unlikely event that the abmon[] storage is not big enough
1027 an error message will be displayed, and we revert to using
1028 unmodified abbreviated month names from the locale database. */
1029 static char abmon[12][MAX_MON_WIDTH * 2 * MB_LEN_MAX + 1];
1030 /* minimum width needed to align %b, 0 => don't use precomputed values. */
1031 static size_t required_mon_width;
1033 static size_t
1034 abmon_init (void)
1036 #ifdef HAVE_NL_LANGINFO
1037 required_mon_width = MAX_MON_WIDTH;
1038 size_t curr_max_width;
1041 curr_max_width = required_mon_width;
1042 required_mon_width = 0;
1043 for (int i = 0; i < 12; i++)
1045 size_t width = curr_max_width;
1047 size_t req = mbsalign (nl_langinfo (ABMON_1 + i),
1048 abmon[i], sizeof (abmon[i]),
1049 &width, MBS_ALIGN_LEFT, 0);
1051 if (req == (size_t) -1 || req >= sizeof (abmon[i]))
1053 required_mon_width = 0; /* ignore precomputed strings. */
1054 return required_mon_width;
1057 required_mon_width = MAX (required_mon_width, width);
1060 while (curr_max_width > required_mon_width);
1061 #endif
1063 return required_mon_width;
1066 static size_t
1067 dev_ino_hash (void const *x, size_t table_size)
1069 struct dev_ino const *p = x;
1070 return (uintmax_t) p->st_ino % table_size;
1073 static bool
1074 dev_ino_compare (void const *x, void const *y)
1076 struct dev_ino const *a = x;
1077 struct dev_ino const *b = y;
1078 return SAME_INODE (*a, *b) ? true : false;
1081 static void
1082 dev_ino_free (void *x)
1084 free (x);
1087 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
1088 active directories. Return true if there is already a matching
1089 entry in the table. */
1091 static bool
1092 visit_dir (dev_t dev, ino_t ino)
1094 struct dev_ino *ent;
1095 struct dev_ino *ent_from_table;
1096 bool found_match;
1098 ent = xmalloc (sizeof *ent);
1099 ent->st_ino = ino;
1100 ent->st_dev = dev;
1102 /* Attempt to insert this entry into the table. */
1103 ent_from_table = hash_insert (active_dir_set, ent);
1105 if (ent_from_table == NULL)
1107 /* Insertion failed due to lack of memory. */
1108 xalloc_die ();
1111 found_match = (ent_from_table != ent);
1113 if (found_match)
1115 /* ent was not inserted, so free it. */
1116 free (ent);
1119 return found_match;
1122 static void
1123 free_pending_ent (struct pending *p)
1125 free (p->name);
1126 free (p->realname);
1127 free (p);
1130 static bool
1131 is_colored (enum indicator_no type)
1133 size_t len = color_indicator[type].len;
1134 char const *s = color_indicator[type].string;
1135 return ! (len == 0
1136 || (len == 1 && strncmp (s, "0", 1) == 0)
1137 || (len == 2 && strncmp (s, "00", 2) == 0));
1140 static void
1141 restore_default_color (void)
1143 put_indicator (&color_indicator[C_LEFT]);
1144 put_indicator (&color_indicator[C_RIGHT]);
1147 /* An ordinary signal was received; arrange for the program to exit. */
1149 static void
1150 sighandler (int sig)
1152 if (! SA_NOCLDSTOP)
1153 signal (sig, SIG_IGN);
1154 if (! interrupt_signal)
1155 interrupt_signal = sig;
1158 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1160 static void
1161 stophandler (int sig)
1163 if (! SA_NOCLDSTOP)
1164 signal (sig, stophandler);
1165 if (! interrupt_signal)
1166 stop_signal_count++;
1169 /* Process any pending signals. If signals are caught, this function
1170 should be called periodically. Ideally there should never be an
1171 unbounded amount of time when signals are not being processed.
1172 Signal handling can restore the default colors, so callers must
1173 immediately change colors after invoking this function. */
1175 static void
1176 process_signals (void)
1178 while (interrupt_signal | stop_signal_count)
1180 int sig;
1181 int stops;
1182 sigset_t oldset;
1184 if (used_color)
1185 restore_default_color ();
1186 fflush (stdout);
1188 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1190 /* Reload interrupt_signal and stop_signal_count, in case a new
1191 signal was handled before sigprocmask took effect. */
1192 sig = interrupt_signal;
1193 stops = stop_signal_count;
1195 /* SIGTSTP is special, since the application can receive that signal
1196 more than once. In this case, don't set the signal handler to the
1197 default. Instead, just raise the uncatchable SIGSTOP. */
1198 if (stops)
1200 stop_signal_count = stops - 1;
1201 sig = SIGSTOP;
1203 else
1204 signal (sig, SIG_DFL);
1206 /* Exit or suspend the program. */
1207 raise (sig);
1208 sigprocmask (SIG_SETMASK, &oldset, NULL);
1210 /* If execution reaches here, then the program has been
1211 continued (after being suspended). */
1216 main (int argc, char **argv)
1218 int i;
1219 struct pending *thispend;
1220 int n_files;
1222 /* The signals that are trapped, and the number of such signals. */
1223 static int const sig[] =
1225 /* This one is handled specially. */
1226 SIGTSTP,
1228 /* The usual suspects. */
1229 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1230 #ifdef SIGPOLL
1231 SIGPOLL,
1232 #endif
1233 #ifdef SIGPROF
1234 SIGPROF,
1235 #endif
1236 #ifdef SIGVTALRM
1237 SIGVTALRM,
1238 #endif
1239 #ifdef SIGXCPU
1240 SIGXCPU,
1241 #endif
1242 #ifdef SIGXFSZ
1243 SIGXFSZ,
1244 #endif
1246 enum { nsigs = ARRAY_CARDINALITY (sig) };
1248 #if ! SA_NOCLDSTOP
1249 bool caught_sig[nsigs];
1250 #endif
1252 initialize_main (&argc, &argv);
1253 set_program_name (argv[0]);
1254 setlocale (LC_ALL, "");
1255 bindtextdomain (PACKAGE, LOCALEDIR);
1256 textdomain (PACKAGE);
1258 initialize_exit_failure (LS_FAILURE);
1259 atexit (close_stdout);
1261 assert (ARRAY_CARDINALITY (color_indicator) + 1
1262 == ARRAY_CARDINALITY (indicator_name));
1264 exit_status = EXIT_SUCCESS;
1265 print_dir_name = true;
1266 pending_dirs = NULL;
1268 current_time.tv_sec = TYPE_MINIMUM (time_t);
1269 current_time.tv_nsec = -1;
1271 i = decode_switches (argc, argv);
1273 if (print_with_color)
1274 parse_ls_color ();
1276 /* Test print_with_color again, because the call to parse_ls_color
1277 may have just reset it -- e.g., if LS_COLORS is invalid. */
1278 if (print_with_color)
1280 /* Avoid following symbolic links when possible. */
1281 if (is_colored (C_ORPHAN)
1282 || (is_colored (C_EXEC) && color_symlink_as_referent)
1283 || (is_colored (C_MISSING) && format == long_format))
1284 check_symlink_color = true;
1286 /* If the standard output is a controlling terminal, watch out
1287 for signals, so that the colors can be restored to the
1288 default state if "ls" is suspended or interrupted. */
1290 if (0 <= tcgetpgrp (STDOUT_FILENO))
1292 int j;
1293 #if SA_NOCLDSTOP
1294 struct sigaction act;
1296 sigemptyset (&caught_signals);
1297 for (j = 0; j < nsigs; j++)
1299 sigaction (sig[j], NULL, &act);
1300 if (act.sa_handler != SIG_IGN)
1301 sigaddset (&caught_signals, sig[j]);
1304 act.sa_mask = caught_signals;
1305 act.sa_flags = SA_RESTART;
1307 for (j = 0; j < nsigs; j++)
1308 if (sigismember (&caught_signals, sig[j]))
1310 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1311 sigaction (sig[j], &act, NULL);
1313 #else
1314 for (j = 0; j < nsigs; j++)
1316 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1317 if (caught_sig[j])
1319 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1320 siginterrupt (sig[j], 0);
1323 #endif
1327 if (dereference == DEREF_UNDEFINED)
1328 dereference = ((immediate_dirs
1329 || indicator_style == classify
1330 || format == long_format)
1331 ? DEREF_NEVER
1332 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1334 /* When using -R, initialize a data structure we'll use to
1335 detect any directory cycles. */
1336 if (recursive)
1338 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, NULL,
1339 dev_ino_hash,
1340 dev_ino_compare,
1341 dev_ino_free);
1342 if (active_dir_set == NULL)
1343 xalloc_die ();
1345 obstack_init (&dev_ino_obstack);
1348 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1349 || format == long_format
1350 || print_scontext
1351 || print_block_size;
1352 format_needs_type = (! format_needs_stat
1353 && (recursive
1354 || print_with_color
1355 || indicator_style != none
1356 || directories_first));
1358 if (dired)
1360 obstack_init (&dired_obstack);
1361 obstack_init (&subdired_obstack);
1364 cwd_n_alloc = 100;
1365 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1366 cwd_n_used = 0;
1368 clear_files ();
1370 n_files = argc - i;
1372 if (n_files <= 0)
1374 if (immediate_dirs)
1375 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1376 else
1377 queue_directory (".", NULL, true);
1379 else
1381 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1382 while (i < argc);
1384 if (cwd_n_used)
1386 sort_files ();
1387 if (!immediate_dirs)
1388 extract_dirs_from_files (NULL, true);
1389 /* `cwd_n_used' might be zero now. */
1392 /* In the following if/else blocks, it is sufficient to test `pending_dirs'
1393 (and not pending_dirs->name) because there may be no markers in the queue
1394 at this point. A marker may be enqueued when extract_dirs_from_files is
1395 called with a non-empty string or via print_dir. */
1396 if (cwd_n_used)
1398 print_current_files ();
1399 if (pending_dirs)
1400 DIRED_PUTCHAR ('\n');
1402 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1403 print_dir_name = false;
1405 while (pending_dirs)
1407 thispend = pending_dirs;
1408 pending_dirs = pending_dirs->next;
1410 if (LOOP_DETECT)
1412 if (thispend->name == NULL)
1414 /* thispend->name == NULL means this is a marker entry
1415 indicating we've finished processing the directory.
1416 Use its dev/ino numbers to remove the corresponding
1417 entry from the active_dir_set hash table. */
1418 struct dev_ino di = dev_ino_pop ();
1419 struct dev_ino *found = hash_delete (active_dir_set, &di);
1420 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1421 assert (found);
1422 dev_ino_free (found);
1423 free_pending_ent (thispend);
1424 continue;
1428 print_dir (thispend->name, thispend->realname,
1429 thispend->command_line_arg);
1431 free_pending_ent (thispend);
1432 print_dir_name = true;
1435 if (print_with_color)
1437 int j;
1439 if (used_color)
1440 restore_default_color ();
1441 fflush (stdout);
1443 /* Restore the default signal handling. */
1444 #if SA_NOCLDSTOP
1445 for (j = 0; j < nsigs; j++)
1446 if (sigismember (&caught_signals, sig[j]))
1447 signal (sig[j], SIG_DFL);
1448 #else
1449 for (j = 0; j < nsigs; j++)
1450 if (caught_sig[j])
1451 signal (sig[j], SIG_DFL);
1452 #endif
1454 /* Act on any signals that arrived before the default was restored.
1455 This can process signals out of order, but there doesn't seem to
1456 be an easy way to do them in order, and the order isn't that
1457 important anyway. */
1458 for (j = stop_signal_count; j; j--)
1459 raise (SIGSTOP);
1460 j = interrupt_signal;
1461 if (j)
1462 raise (j);
1465 if (dired)
1467 /* No need to free these since we're about to exit. */
1468 dired_dump_obstack ("//DIRED//", &dired_obstack);
1469 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1470 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1471 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1474 if (LOOP_DETECT)
1476 assert (hash_get_n_entries (active_dir_set) == 0);
1477 hash_free (active_dir_set);
1480 exit (exit_status);
1483 /* Set all the option flags according to the switches specified.
1484 Return the index of the first non-option argument. */
1486 static int
1487 decode_switches (int argc, char **argv)
1489 char *time_style_option = NULL;
1491 /* Record whether there is an option specifying sort type. */
1492 bool sort_type_specified = false;
1494 qmark_funny_chars = false;
1496 /* initialize all switches to default settings */
1498 switch (ls_mode)
1500 case LS_MULTI_COL:
1501 /* This is for the `dir' program. */
1502 format = many_per_line;
1503 set_quoting_style (NULL, escape_quoting_style);
1504 break;
1506 case LS_LONG_FORMAT:
1507 /* This is for the `vdir' program. */
1508 format = long_format;
1509 set_quoting_style (NULL, escape_quoting_style);
1510 break;
1512 case LS_LS:
1513 /* This is for the `ls' program. */
1514 if (isatty (STDOUT_FILENO))
1516 format = many_per_line;
1517 /* See description of qmark_funny_chars, above. */
1518 qmark_funny_chars = true;
1520 else
1522 format = one_per_line;
1523 qmark_funny_chars = false;
1525 break;
1527 default:
1528 abort ();
1531 time_type = time_mtime;
1532 sort_type = sort_name;
1533 sort_reverse = false;
1534 numeric_ids = false;
1535 print_block_size = false;
1536 indicator_style = none;
1537 print_inode = false;
1538 dereference = DEREF_UNDEFINED;
1539 recursive = false;
1540 immediate_dirs = false;
1541 ignore_mode = IGNORE_DEFAULT;
1542 ignore_patterns = NULL;
1543 hide_patterns = NULL;
1544 print_scontext = false;
1546 /* FIXME: put this in a function. */
1548 char const *q_style = getenv ("QUOTING_STYLE");
1549 if (q_style)
1551 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
1552 if (0 <= i)
1553 set_quoting_style (NULL, quoting_style_vals[i]);
1554 else
1555 error (0, 0,
1556 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
1557 quotearg (q_style));
1562 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1563 human_options (ls_block_size,
1564 &human_output_opts, &output_block_size);
1565 if (ls_block_size || getenv ("BLOCK_SIZE"))
1566 file_output_block_size = output_block_size;
1569 line_length = 80;
1571 char const *p = getenv ("COLUMNS");
1572 if (p && *p)
1574 unsigned long int tmp_ulong;
1575 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1576 && 0 < tmp_ulong && tmp_ulong <= SIZE_MAX)
1578 line_length = tmp_ulong;
1580 else
1582 error (0, 0,
1583 _("ignoring invalid width in environment variable COLUMNS: %s"),
1584 quotearg (p));
1589 #ifdef TIOCGWINSZ
1591 struct winsize ws;
1593 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1594 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1595 line_length = ws.ws_col;
1597 #endif
1600 char const *p = getenv ("TABSIZE");
1601 tabsize = 8;
1602 if (p)
1604 unsigned long int tmp_ulong;
1605 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1606 && tmp_ulong <= SIZE_MAX)
1608 tabsize = tmp_ulong;
1610 else
1612 error (0, 0,
1613 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1614 quotearg (p));
1619 for (;;)
1621 int oi = -1;
1622 int c = getopt_long (argc, argv,
1623 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1624 long_options, &oi);
1625 if (c == -1)
1626 break;
1628 switch (c)
1630 case 'a':
1631 ignore_mode = IGNORE_MINIMAL;
1632 break;
1634 case 'b':
1635 set_quoting_style (NULL, escape_quoting_style);
1636 break;
1638 case 'c':
1639 time_type = time_ctime;
1640 break;
1642 case 'd':
1643 immediate_dirs = true;
1644 break;
1646 case 'f':
1647 /* Same as enabling -a -U and disabling -l -s. */
1648 ignore_mode = IGNORE_MINIMAL;
1649 sort_type = sort_none;
1650 sort_type_specified = true;
1651 /* disable -l */
1652 if (format == long_format)
1653 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1654 print_block_size = false; /* disable -s */
1655 print_with_color = false; /* disable --color */
1656 break;
1658 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1659 indicator_style = file_type;
1660 break;
1662 case 'g':
1663 format = long_format;
1664 print_owner = false;
1665 break;
1667 case 'h':
1668 human_output_opts = human_autoscale | human_SI | human_base_1024;
1669 file_output_block_size = output_block_size = 1;
1670 break;
1672 case 'i':
1673 print_inode = true;
1674 break;
1676 case 'k':
1677 human_output_opts = 0;
1678 file_output_block_size = output_block_size = 1024;
1679 break;
1681 case 'l':
1682 format = long_format;
1683 break;
1685 case 'm':
1686 format = with_commas;
1687 break;
1689 case 'n':
1690 numeric_ids = true;
1691 format = long_format;
1692 break;
1694 case 'o': /* Just like -l, but don't display group info. */
1695 format = long_format;
1696 print_group = false;
1697 break;
1699 case 'p':
1700 indicator_style = slash;
1701 break;
1703 case 'q':
1704 qmark_funny_chars = true;
1705 break;
1707 case 'r':
1708 sort_reverse = true;
1709 break;
1711 case 's':
1712 print_block_size = true;
1713 break;
1715 case 't':
1716 sort_type = sort_time;
1717 sort_type_specified = true;
1718 break;
1720 case 'u':
1721 time_type = time_atime;
1722 break;
1724 case 'v':
1725 sort_type = sort_version;
1726 sort_type_specified = true;
1727 break;
1729 case 'w':
1731 unsigned long int tmp_ulong;
1732 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1733 || ! (0 < tmp_ulong && tmp_ulong <= SIZE_MAX))
1734 error (LS_FAILURE, 0, _("invalid line width: %s"),
1735 quotearg (optarg));
1736 line_length = tmp_ulong;
1737 break;
1740 case 'x':
1741 format = horizontal;
1742 break;
1744 case 'A':
1745 if (ignore_mode == IGNORE_DEFAULT)
1746 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1747 break;
1749 case 'B':
1750 add_ignore_pattern ("*~");
1751 add_ignore_pattern (".*~");
1752 break;
1754 case 'C':
1755 format = many_per_line;
1756 break;
1758 case 'D':
1759 dired = true;
1760 break;
1762 case 'F':
1763 indicator_style = classify;
1764 break;
1766 case 'G': /* inhibit display of group info */
1767 print_group = false;
1768 break;
1770 case 'H':
1771 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1772 break;
1774 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1775 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1776 break;
1778 case 'I':
1779 add_ignore_pattern (optarg);
1780 break;
1782 case 'L':
1783 dereference = DEREF_ALWAYS;
1784 break;
1786 case 'N':
1787 set_quoting_style (NULL, literal_quoting_style);
1788 break;
1790 case 'Q':
1791 set_quoting_style (NULL, c_quoting_style);
1792 break;
1794 case 'R':
1795 recursive = true;
1796 break;
1798 case 'S':
1799 sort_type = sort_size;
1800 sort_type_specified = true;
1801 break;
1803 case 'T':
1805 unsigned long int tmp_ulong;
1806 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1807 || SIZE_MAX < tmp_ulong)
1808 error (LS_FAILURE, 0, _("invalid tab size: %s"),
1809 quotearg (optarg));
1810 tabsize = tmp_ulong;
1811 break;
1814 case 'U':
1815 sort_type = sort_none;
1816 sort_type_specified = true;
1817 break;
1819 case 'X':
1820 sort_type = sort_extension;
1821 sort_type_specified = true;
1822 break;
1824 case '1':
1825 /* -1 has no effect after -l. */
1826 if (format != long_format)
1827 format = one_per_line;
1828 break;
1830 case AUTHOR_OPTION:
1831 print_author = true;
1832 break;
1834 case HIDE_OPTION:
1836 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1837 hide->pattern = optarg;
1838 hide->next = hide_patterns;
1839 hide_patterns = hide;
1841 break;
1843 case SORT_OPTION:
1844 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1845 sort_type_specified = true;
1846 break;
1848 case GROUP_DIRECTORIES_FIRST_OPTION:
1849 directories_first = true;
1850 break;
1852 case TIME_OPTION:
1853 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1854 break;
1856 case FORMAT_OPTION:
1857 format = XARGMATCH ("--format", optarg, format_args, format_types);
1858 break;
1860 case FULL_TIME_OPTION:
1861 format = long_format;
1862 time_style_option = bad_cast ("full-iso");
1863 break;
1865 case COLOR_OPTION:
1867 int i;
1868 if (optarg)
1869 i = XARGMATCH ("--color", optarg, color_args, color_types);
1870 else
1871 /* Using --color with no argument is equivalent to using
1872 --color=always. */
1873 i = color_always;
1875 print_with_color = (i == color_always
1876 || (i == color_if_tty
1877 && isatty (STDOUT_FILENO)));
1879 if (print_with_color)
1881 /* Don't use TAB characters in output. Some terminal
1882 emulators can't handle the combination of tabs and
1883 color codes on the same line. */
1884 tabsize = 0;
1886 break;
1889 case INDICATOR_STYLE_OPTION:
1890 indicator_style = XARGMATCH ("--indicator-style", optarg,
1891 indicator_style_args,
1892 indicator_style_types);
1893 break;
1895 case QUOTING_STYLE_OPTION:
1896 set_quoting_style (NULL,
1897 XARGMATCH ("--quoting-style", optarg,
1898 quoting_style_args,
1899 quoting_style_vals));
1900 break;
1902 case TIME_STYLE_OPTION:
1903 time_style_option = optarg;
1904 break;
1906 case SHOW_CONTROL_CHARS_OPTION:
1907 qmark_funny_chars = false;
1908 break;
1910 case BLOCK_SIZE_OPTION:
1912 enum strtol_error e = human_options (optarg, &human_output_opts,
1913 &output_block_size);
1914 if (e != LONGINT_OK)
1915 xstrtol_fatal (e, oi, 0, long_options, optarg);
1916 file_output_block_size = output_block_size;
1918 break;
1920 case SI_OPTION:
1921 human_output_opts = human_autoscale | human_SI;
1922 file_output_block_size = output_block_size = 1;
1923 break;
1925 case 'Z':
1926 print_scontext = true;
1927 break;
1929 case_GETOPT_HELP_CHAR;
1931 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1933 default:
1934 usage (LS_FAILURE);
1938 max_idx = MAX (1, line_length / MIN_COLUMN_WIDTH);
1940 filename_quoting_options = clone_quoting_options (NULL);
1941 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1942 set_char_quoting (filename_quoting_options, ' ', 1);
1943 if (file_type <= indicator_style)
1945 char const *p;
1946 for (p = "*=>@|" + indicator_style - file_type; *p; p++)
1947 set_char_quoting (filename_quoting_options, *p, 1);
1950 dirname_quoting_options = clone_quoting_options (NULL);
1951 set_char_quoting (dirname_quoting_options, ':', 1);
1953 /* --dired is meaningful only with --format=long (-l).
1954 Otherwise, ignore it. FIXME: warn about this?
1955 Alternatively, make --dired imply --format=long? */
1956 if (dired && format != long_format)
1957 dired = false;
1959 /* If -c or -u is specified and not -l (or any other option that implies -l),
1960 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
1961 The behavior of ls when using either -c or -u but with neither -l nor -t
1962 appears to be unspecified by POSIX. So, with GNU ls, `-u' alone means
1963 sort by atime (this is the one that's not specified by the POSIX spec),
1964 -lu means show atime and sort by name, -lut means show atime and sort
1965 by atime. */
1967 if ((time_type == time_ctime || time_type == time_atime)
1968 && !sort_type_specified && format != long_format)
1970 sort_type = sort_time;
1973 if (format == long_format)
1975 char *style = time_style_option;
1976 static char const posix_prefix[] = "posix-";
1978 if (! style)
1979 if (! (style = getenv ("TIME_STYLE")))
1980 style = bad_cast ("locale");
1982 while (strncmp (style, posix_prefix, sizeof posix_prefix - 1) == 0)
1984 if (! hard_locale (LC_TIME))
1985 return optind;
1986 style += sizeof posix_prefix - 1;
1989 if (*style == '+')
1991 char *p0 = style + 1;
1992 char *p1 = strchr (p0, '\n');
1993 if (! p1)
1994 p1 = p0;
1995 else
1997 if (strchr (p1 + 1, '\n'))
1998 error (LS_FAILURE, 0, _("invalid time style format %s"),
1999 quote (p0));
2000 *p1++ = '\0';
2002 long_time_format[0] = p0;
2003 long_time_format[1] = p1;
2005 else
2006 switch (XARGMATCH ("time style", style,
2007 time_style_args,
2008 time_style_types))
2010 case full_iso_time_style:
2011 long_time_format[0] = long_time_format[1] =
2012 "%Y-%m-%d %H:%M:%S.%N %z";
2013 break;
2015 case long_iso_time_style:
2016 case_long_iso_time_style:
2017 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
2018 break;
2020 case iso_time_style:
2021 long_time_format[0] = "%Y-%m-%d ";
2022 long_time_format[1] = "%m-%d %H:%M";
2023 break;
2025 case locale_time_style:
2026 if (hard_locale (LC_TIME))
2028 /* Ensure that the locale has translations for both
2029 formats. If not, fall back on long-iso format. */
2030 int i;
2031 for (i = 0; i < 2; i++)
2033 char const *locale_format =
2034 dcgettext (NULL, long_time_format[i], LC_TIME);
2035 if (locale_format == long_time_format[i])
2036 goto case_long_iso_time_style;
2037 long_time_format[i] = locale_format;
2041 /* Note we leave %5b etc. alone so user widths/flags are honored. */
2042 if (strstr (long_time_format[0],"%b") || strstr (long_time_format[1],"%b"))
2043 if (!abmon_init ())
2044 error (0, 0, _("error initializing month strings"));
2047 return optind;
2050 /* Parse a string as part of the LS_COLORS variable; this may involve
2051 decoding all kinds of escape characters. If equals_end is set an
2052 unescaped equal sign ends the string, otherwise only a : or \0
2053 does. Set *OUTPUT_COUNT to the number of bytes output. Return
2054 true if successful.
2056 The resulting string is *not* null-terminated, but may contain
2057 embedded nulls.
2059 Note that both dest and src are char **; on return they point to
2060 the first free byte after the array and the character that ended
2061 the input string, respectively. */
2063 static bool
2064 get_funky_string (char **dest, const char **src, bool equals_end,
2065 size_t *output_count)
2067 char num; /* For numerical codes */
2068 size_t count; /* Something to count with */
2069 enum {
2070 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
2071 } state;
2072 const char *p;
2073 char *q;
2075 p = *src; /* We don't want to double-indirect */
2076 q = *dest; /* the whole darn time. */
2078 count = 0; /* No characters counted in yet. */
2079 num = 0;
2081 state = ST_GND; /* Start in ground state. */
2082 while (state < ST_END)
2084 switch (state)
2086 case ST_GND: /* Ground state (no escapes) */
2087 switch (*p)
2089 case ':':
2090 case '\0':
2091 state = ST_END; /* End of string */
2092 break;
2093 case '\\':
2094 state = ST_BACKSLASH; /* Backslash scape sequence */
2095 ++p;
2096 break;
2097 case '^':
2098 state = ST_CARET; /* Caret escape */
2099 ++p;
2100 break;
2101 case '=':
2102 if (equals_end)
2104 state = ST_END; /* End */
2105 break;
2107 /* else fall through */
2108 default:
2109 *(q++) = *(p++);
2110 ++count;
2111 break;
2113 break;
2115 case ST_BACKSLASH: /* Backslash escaped character */
2116 switch (*p)
2118 case '0':
2119 case '1':
2120 case '2':
2121 case '3':
2122 case '4':
2123 case '5':
2124 case '6':
2125 case '7':
2126 state = ST_OCTAL; /* Octal sequence */
2127 num = *p - '0';
2128 break;
2129 case 'x':
2130 case 'X':
2131 state = ST_HEX; /* Hex sequence */
2132 num = 0;
2133 break;
2134 case 'a': /* Bell */
2135 num = '\a';
2136 break;
2137 case 'b': /* Backspace */
2138 num = '\b';
2139 break;
2140 case 'e': /* Escape */
2141 num = 27;
2142 break;
2143 case 'f': /* Form feed */
2144 num = '\f';
2145 break;
2146 case 'n': /* Newline */
2147 num = '\n';
2148 break;
2149 case 'r': /* Carriage return */
2150 num = '\r';
2151 break;
2152 case 't': /* Tab */
2153 num = '\t';
2154 break;
2155 case 'v': /* Vtab */
2156 num = '\v';
2157 break;
2158 case '?': /* Delete */
2159 num = 127;
2160 break;
2161 case '_': /* Space */
2162 num = ' ';
2163 break;
2164 case '\0': /* End of string */
2165 state = ST_ERROR; /* Error! */
2166 break;
2167 default: /* Escaped character like \ ^ : = */
2168 num = *p;
2169 break;
2171 if (state == ST_BACKSLASH)
2173 *(q++) = num;
2174 ++count;
2175 state = ST_GND;
2177 ++p;
2178 break;
2180 case ST_OCTAL: /* Octal sequence */
2181 if (*p < '0' || *p > '7')
2183 *(q++) = num;
2184 ++count;
2185 state = ST_GND;
2187 else
2188 num = (num << 3) + (*(p++) - '0');
2189 break;
2191 case ST_HEX: /* Hex sequence */
2192 switch (*p)
2194 case '0':
2195 case '1':
2196 case '2':
2197 case '3':
2198 case '4':
2199 case '5':
2200 case '6':
2201 case '7':
2202 case '8':
2203 case '9':
2204 num = (num << 4) + (*(p++) - '0');
2205 break;
2206 case 'a':
2207 case 'b':
2208 case 'c':
2209 case 'd':
2210 case 'e':
2211 case 'f':
2212 num = (num << 4) + (*(p++) - 'a') + 10;
2213 break;
2214 case 'A':
2215 case 'B':
2216 case 'C':
2217 case 'D':
2218 case 'E':
2219 case 'F':
2220 num = (num << 4) + (*(p++) - 'A') + 10;
2221 break;
2222 default:
2223 *(q++) = num;
2224 ++count;
2225 state = ST_GND;
2226 break;
2228 break;
2230 case ST_CARET: /* Caret escape */
2231 state = ST_GND; /* Should be the next state... */
2232 if (*p >= '@' && *p <= '~')
2234 *(q++) = *(p++) & 037;
2235 ++count;
2237 else if (*p == '?')
2239 *(q++) = 127;
2240 ++count;
2242 else
2243 state = ST_ERROR;
2244 break;
2246 default:
2247 abort ();
2251 *dest = q;
2252 *src = p;
2253 *output_count = count;
2255 return state != ST_ERROR;
2258 static void
2259 parse_ls_color (void)
2261 const char *p; /* Pointer to character being parsed */
2262 char *buf; /* color_buf buffer pointer */
2263 int state; /* State of parser */
2264 int ind_no; /* Indicator number */
2265 char label[3]; /* Indicator label */
2266 struct color_ext_type *ext; /* Extension we are working on */
2268 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2269 return;
2271 ext = NULL;
2272 strcpy (label, "??");
2274 /* This is an overly conservative estimate, but any possible
2275 LS_COLORS string will *not* generate a color_buf longer than
2276 itself, so it is a safe way of allocating a buffer in
2277 advance. */
2278 buf = color_buf = xstrdup (p);
2280 state = 1;
2281 while (state > 0)
2283 switch (state)
2285 case 1: /* First label character */
2286 switch (*p)
2288 case ':':
2289 ++p;
2290 break;
2292 case '*':
2293 /* Allocate new extension block and add to head of
2294 linked list (this way a later definition will
2295 override an earlier one, which can be useful for
2296 having terminal-specific defs override global). */
2298 ext = xmalloc (sizeof *ext);
2299 ext->next = color_ext_list;
2300 color_ext_list = ext;
2302 ++p;
2303 ext->ext.string = buf;
2305 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2306 ? 4 : -1);
2307 break;
2309 case '\0':
2310 state = 0; /* Done! */
2311 break;
2313 default: /* Assume it is file type label */
2314 label[0] = *(p++);
2315 state = 2;
2316 break;
2318 break;
2320 case 2: /* Second label character */
2321 if (*p)
2323 label[1] = *(p++);
2324 state = 3;
2326 else
2327 state = -1; /* Error */
2328 break;
2330 case 3: /* Equal sign after indicator label */
2331 state = -1; /* Assume failure... */
2332 if (*(p++) == '=')/* It *should* be... */
2334 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2336 if (STREQ (label, indicator_name[ind_no]))
2338 color_indicator[ind_no].string = buf;
2339 state = (get_funky_string (&buf, &p, false,
2340 &color_indicator[ind_no].len)
2341 ? 1 : -1);
2342 break;
2345 if (state == -1)
2346 error (0, 0, _("unrecognized prefix: %s"), quotearg (label));
2348 break;
2350 case 4: /* Equal sign after *.ext */
2351 if (*(p++) == '=')
2353 ext->seq.string = buf;
2354 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2355 ? 1 : -1);
2357 else
2358 state = -1;
2359 break;
2363 if (state < 0)
2365 struct color_ext_type *e;
2366 struct color_ext_type *e2;
2368 error (0, 0,
2369 _("unparsable value for LS_COLORS environment variable"));
2370 free (color_buf);
2371 for (e = color_ext_list; e != NULL; /* empty */)
2373 e2 = e;
2374 e = e->next;
2375 free (e2);
2377 print_with_color = false;
2380 if (color_indicator[C_LINK].len == 6
2381 && !strncmp (color_indicator[C_LINK].string, "target", 6))
2382 color_symlink_as_referent = true;
2385 /* Set the exit status to report a failure. If SERIOUS, it is a
2386 serious failure; otherwise, it is merely a minor problem. */
2388 static void
2389 set_exit_status (bool serious)
2391 if (serious)
2392 exit_status = LS_FAILURE;
2393 else if (exit_status == EXIT_SUCCESS)
2394 exit_status = LS_MINOR_PROBLEM;
2397 /* Assuming a failure is serious if SERIOUS, use the printf-style
2398 MESSAGE to report the failure to access a file named FILE. Assume
2399 errno is set appropriately for the failure. */
2401 static void
2402 file_failure (bool serious, char const *message, char const *file)
2404 error (0, errno, message, quotearg_colon (file));
2405 set_exit_status (serious);
2408 /* Request that the directory named NAME have its contents listed later.
2409 If REALNAME is nonzero, it will be used instead of NAME when the
2410 directory name is printed. This allows symbolic links to directories
2411 to be treated as regular directories but still be listed under their
2412 real names. NAME == NULL is used to insert a marker entry for the
2413 directory named in REALNAME.
2414 If NAME is non-NULL, we use its dev/ino information to save
2415 a call to stat -- when doing a recursive (-R) traversal.
2416 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2418 static void
2419 queue_directory (char const *name, char const *realname, bool command_line_arg)
2421 struct pending *new = xmalloc (sizeof *new);
2422 new->realname = realname ? xstrdup (realname) : NULL;
2423 new->name = name ? xstrdup (name) : NULL;
2424 new->command_line_arg = command_line_arg;
2425 new->next = pending_dirs;
2426 pending_dirs = new;
2429 /* Read directory NAME, and list the files in it.
2430 If REALNAME is nonzero, print its name instead of NAME;
2431 this is used for symbolic links to directories.
2432 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2434 static void
2435 print_dir (char const *name, char const *realname, bool command_line_arg)
2437 DIR *dirp;
2438 struct dirent *next;
2439 uintmax_t total_blocks = 0;
2440 static bool first = true;
2442 errno = 0;
2443 dirp = opendir (name);
2444 if (!dirp)
2446 file_failure (command_line_arg, _("cannot open directory %s"), name);
2447 return;
2450 if (LOOP_DETECT)
2452 struct stat dir_stat;
2453 int fd = dirfd (dirp);
2455 /* If dirfd failed, endure the overhead of using stat. */
2456 if ((0 <= fd
2457 ? fstat (fd, &dir_stat)
2458 : stat (name, &dir_stat)) < 0)
2460 file_failure (command_line_arg,
2461 _("cannot determine device and inode of %s"), name);
2462 closedir (dirp);
2463 return;
2466 /* If we've already visited this dev/inode pair, warn that
2467 we've found a loop, and do not process this directory. */
2468 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2470 error (0, 0, _("%s: not listing already-listed directory"),
2471 quotearg_colon (name));
2472 closedir (dirp);
2473 return;
2476 DEV_INO_PUSH (dir_stat.st_dev, dir_stat.st_ino);
2479 if (recursive | print_dir_name)
2481 if (!first)
2482 DIRED_PUTCHAR ('\n');
2483 first = false;
2484 DIRED_INDENT ();
2485 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2486 dired_pos += quote_name (stdout, realname ? realname : name,
2487 dirname_quoting_options, NULL);
2488 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2489 DIRED_FPUTS_LITERAL (":\n", stdout);
2492 /* Read the directory entries, and insert the subfiles into the `cwd_file'
2493 table. */
2495 clear_files ();
2497 while (1)
2499 /* Set errno to zero so we can distinguish between a readdir failure
2500 and when readdir simply finds that there are no more entries. */
2501 errno = 0;
2502 next = readdir (dirp);
2503 if (next)
2505 if (! file_ignored (next->d_name))
2507 enum filetype type = unknown;
2509 #if HAVE_STRUCT_DIRENT_D_TYPE
2510 switch (next->d_type)
2512 case DT_BLK: type = blockdev; break;
2513 case DT_CHR: type = chardev; break;
2514 case DT_DIR: type = directory; break;
2515 case DT_FIFO: type = fifo; break;
2516 case DT_LNK: type = symbolic_link; break;
2517 case DT_REG: type = normal; break;
2518 case DT_SOCK: type = sock; break;
2519 # ifdef DT_WHT
2520 case DT_WHT: type = whiteout; break;
2521 # endif
2523 #endif
2524 total_blocks += gobble_file (next->d_name, type,
2525 RELIABLE_D_INO (next),
2526 false, name);
2528 /* In this narrow case, print out each name right away, so
2529 ls uses constant memory while processing the entries of
2530 this directory. Useful when there are many (millions)
2531 of entries in a directory. */
2532 if (format == one_per_line && sort_type == sort_none
2533 && !print_block_size && !recursive)
2535 /* We must call sort_files in spite of
2536 "sort_type == sort_none" for its initialization
2537 of the sorted_file vector. */
2538 sort_files ();
2539 print_current_files ();
2540 clear_files ();
2544 else if (errno != 0)
2546 file_failure (command_line_arg, _("reading directory %s"), name);
2547 if (errno != EOVERFLOW)
2548 break;
2550 else
2551 break;
2554 if (closedir (dirp) != 0)
2556 file_failure (command_line_arg, _("closing directory %s"), name);
2557 /* Don't return; print whatever we got. */
2560 /* Sort the directory contents. */
2561 sort_files ();
2563 /* If any member files are subdirectories, perhaps they should have their
2564 contents listed rather than being mentioned here as files. */
2566 if (recursive)
2567 extract_dirs_from_files (name, command_line_arg);
2569 if (format == long_format || print_block_size)
2571 const char *p;
2572 char buf[LONGEST_HUMAN_READABLE + 1];
2574 DIRED_INDENT ();
2575 p = _("total");
2576 DIRED_FPUTS (p, stdout, strlen (p));
2577 DIRED_PUTCHAR (' ');
2578 p = human_readable (total_blocks, buf, human_output_opts,
2579 ST_NBLOCKSIZE, output_block_size);
2580 DIRED_FPUTS (p, stdout, strlen (p));
2581 DIRED_PUTCHAR ('\n');
2584 if (cwd_n_used)
2585 print_current_files ();
2588 /* Add `pattern' to the list of patterns for which files that match are
2589 not listed. */
2591 static void
2592 add_ignore_pattern (const char *pattern)
2594 struct ignore_pattern *ignore;
2596 ignore = xmalloc (sizeof *ignore);
2597 ignore->pattern = pattern;
2598 /* Add it to the head of the linked list. */
2599 ignore->next = ignore_patterns;
2600 ignore_patterns = ignore;
2603 /* Return true if one of the PATTERNS matches FILE. */
2605 static bool
2606 patterns_match (struct ignore_pattern const *patterns, char const *file)
2608 struct ignore_pattern const *p;
2609 for (p = patterns; p; p = p->next)
2610 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2611 return true;
2612 return false;
2615 /* Return true if FILE should be ignored. */
2617 static bool
2618 file_ignored (char const *name)
2620 return ((ignore_mode != IGNORE_MINIMAL
2621 && name[0] == '.'
2622 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2623 || (ignore_mode == IGNORE_DEFAULT
2624 && patterns_match (hide_patterns, name))
2625 || patterns_match (ignore_patterns, name));
2628 /* POSIX requires that a file size be printed without a sign, even
2629 when negative. Assume the typical case where negative sizes are
2630 actually positive values that have wrapped around. */
2632 static uintmax_t
2633 unsigned_file_size (off_t size)
2635 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2638 /* Enter and remove entries in the table `cwd_file'. */
2640 /* Empty the table of files. */
2642 static void
2643 clear_files (void)
2645 size_t i;
2647 for (i = 0; i < cwd_n_used; i++)
2649 struct fileinfo *f = sorted_file[i];
2650 free (f->name);
2651 free (f->linkname);
2652 if (f->scontext != UNKNOWN_SECURITY_CONTEXT)
2653 freecon (f->scontext);
2656 cwd_n_used = 0;
2657 any_has_acl = false;
2658 inode_number_width = 0;
2659 block_size_width = 0;
2660 nlink_width = 0;
2661 owner_width = 0;
2662 group_width = 0;
2663 author_width = 0;
2664 scontext_width = 0;
2665 major_device_number_width = 0;
2666 minor_device_number_width = 0;
2667 file_size_width = 0;
2670 /* Add a file to the current table of files.
2671 Verify that the file exists, and print an error message if it does not.
2672 Return the number of blocks that the file occupies. */
2674 static uintmax_t
2675 gobble_file (char const *name, enum filetype type, ino_t inode,
2676 bool command_line_arg, char const *dirname)
2678 uintmax_t blocks = 0;
2679 struct fileinfo *f;
2681 /* An inode value prior to gobble_file necessarily came from readdir,
2682 which is not used for command line arguments. */
2683 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2685 if (cwd_n_used == cwd_n_alloc)
2687 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
2688 cwd_n_alloc *= 2;
2691 f = &cwd_file[cwd_n_used];
2692 memset (f, '\0', sizeof *f);
2693 f->stat.st_ino = inode;
2694 f->filetype = type;
2696 if (command_line_arg
2697 || format_needs_stat
2698 /* When coloring a directory (we may know the type from
2699 direct.d_type), we have to stat it in order to indicate
2700 sticky and/or other-writable attributes. */
2701 || (type == directory && print_with_color)
2702 /* When dereferencing symlinks, the inode and type must come from
2703 stat, but readdir provides the inode and type of lstat. */
2704 || ((print_inode || format_needs_type)
2705 && (type == symbolic_link || type == unknown)
2706 && (dereference == DEREF_ALWAYS
2707 || (command_line_arg && dereference != DEREF_NEVER)
2708 || color_symlink_as_referent || check_symlink_color))
2709 /* Command line dereferences are already taken care of by the above
2710 assertion that the inode number is not yet known. */
2711 || (print_inode && inode == NOT_AN_INODE_NUMBER)
2712 || (format_needs_type
2713 && (type == unknown || command_line_arg
2714 /* --indicator-style=classify (aka -F)
2715 requires that we stat each regular file
2716 to see if it's executable. */
2717 || (type == normal && (indicator_style == classify
2718 /* This is so that --color ends up
2719 highlighting files with the executable
2720 bit set even when options like -F are
2721 not specified. */
2722 || (print_with_color
2723 && is_colored (C_EXEC))
2724 )))))
2727 /* Absolute name of this file. */
2728 char *absolute_name;
2729 bool do_deref;
2730 int err;
2732 if (name[0] == '/' || dirname[0] == 0)
2733 absolute_name = (char *) name;
2734 else
2736 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
2737 attach (absolute_name, dirname, name);
2740 switch (dereference)
2742 case DEREF_ALWAYS:
2743 err = stat (absolute_name, &f->stat);
2744 do_deref = true;
2745 break;
2747 case DEREF_COMMAND_LINE_ARGUMENTS:
2748 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
2749 if (command_line_arg)
2751 bool need_lstat;
2752 err = stat (absolute_name, &f->stat);
2753 do_deref = true;
2755 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
2756 break;
2758 need_lstat = (err < 0
2759 ? errno == ENOENT
2760 : ! S_ISDIR (f->stat.st_mode));
2761 if (!need_lstat)
2762 break;
2764 /* stat failed because of ENOENT, maybe indicating a dangling
2765 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
2766 directory, and --dereference-command-line-symlink-to-dir is
2767 in effect. Fall through so that we call lstat instead. */
2770 default: /* DEREF_NEVER */
2771 err = lstat (absolute_name, &f->stat);
2772 do_deref = false;
2773 break;
2776 if (err != 0)
2778 /* Failure to stat a command line argument leads to
2779 an exit status of 2. For other files, stat failure
2780 provokes an exit status of 1. */
2781 file_failure (command_line_arg,
2782 _("cannot access %s"), absolute_name);
2783 if (command_line_arg)
2784 return 0;
2786 f->name = xstrdup (name);
2787 cwd_n_used++;
2789 return 0;
2792 f->stat_ok = true;
2794 if (format == long_format || print_scontext)
2796 bool have_selinux = false;
2797 bool have_acl = false;
2798 int attr_len = (do_deref
2799 ? getfilecon (absolute_name, &f->scontext)
2800 : lgetfilecon (absolute_name, &f->scontext));
2801 err = (attr_len < 0);
2803 /* Contrary to its documented API, getfilecon may return 0,
2804 yet set f->scontext to NULL (on at least Debian's libselinux1
2805 2.0.15-2+b1), so work around that bug.
2806 FIXME: remove this work-around in 2011, or whenever affected
2807 versions of libselinux are long gone. */
2808 if (attr_len == 0)
2810 err = 0;
2811 f->scontext = xstrdup ("unlabeled");
2814 if (err == 0)
2815 have_selinux = ! STREQ ("unlabeled", f->scontext);
2816 else
2818 f->scontext = UNKNOWN_SECURITY_CONTEXT;
2820 /* When requesting security context information, don't make
2821 ls fail just because the file (even a command line argument)
2822 isn't on the right type of file system. I.e., a getfilecon
2823 failure isn't in the same class as a stat failure. */
2824 if (errno == ENOTSUP || errno == EOPNOTSUPP || errno == ENODATA)
2825 err = 0;
2828 if (err == 0 && format == long_format)
2830 int n = file_has_acl (absolute_name, &f->stat);
2831 err = (n < 0);
2832 have_acl = (0 < n);
2835 f->acl_type = (!have_selinux && !have_acl
2836 ? ACL_T_NONE
2837 : (have_selinux && !have_acl
2838 ? ACL_T_SELINUX_ONLY
2839 : ACL_T_YES));
2840 any_has_acl |= f->acl_type != ACL_T_NONE;
2842 if (err)
2843 error (0, errno, "%s", quotearg_colon (absolute_name));
2846 if (S_ISLNK (f->stat.st_mode)
2847 && (format == long_format || check_symlink_color))
2849 char *linkname;
2850 struct stat linkstats;
2852 get_link_name (absolute_name, f, command_line_arg);
2853 linkname = make_link_name (absolute_name, f->linkname);
2855 /* Avoid following symbolic links when possible, ie, when
2856 they won't be traced and when no indicator is needed. */
2857 if (linkname
2858 && (file_type <= indicator_style || check_symlink_color)
2859 && stat (linkname, &linkstats) == 0)
2861 f->linkok = true;
2863 /* Symbolic links to directories that are mentioned on the
2864 command line are automatically traced if not being
2865 listed as files. */
2866 if (!command_line_arg || format == long_format
2867 || !S_ISDIR (linkstats.st_mode))
2869 /* Get the linked-to file's mode for the filetype indicator
2870 in long listings. */
2871 f->linkmode = linkstats.st_mode;
2874 free (linkname);
2877 /* When not distinguishing types of symlinks, pretend we know that
2878 it is stat'able, so that it will be colored as a regular symlink,
2879 and not as an orphan. */
2880 if (S_ISLNK (f->stat.st_mode) && !check_symlink_color)
2881 f->linkok = true;
2883 if (S_ISLNK (f->stat.st_mode))
2884 f->filetype = symbolic_link;
2885 else if (S_ISDIR (f->stat.st_mode))
2887 if (command_line_arg & !immediate_dirs)
2888 f->filetype = arg_directory;
2889 else
2890 f->filetype = directory;
2892 else
2893 f->filetype = normal;
2895 blocks = ST_NBLOCKS (f->stat);
2896 if (format == long_format || print_block_size)
2898 char buf[LONGEST_HUMAN_READABLE + 1];
2899 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
2900 ST_NBLOCKSIZE, output_block_size),
2902 if (block_size_width < len)
2903 block_size_width = len;
2906 if (format == long_format)
2908 if (print_owner)
2910 int len = format_user_width (f->stat.st_uid);
2911 if (owner_width < len)
2912 owner_width = len;
2915 if (print_group)
2917 int len = format_group_width (f->stat.st_gid);
2918 if (group_width < len)
2919 group_width = len;
2922 if (print_author)
2924 int len = format_user_width (f->stat.st_author);
2925 if (author_width < len)
2926 author_width = len;
2930 if (print_scontext)
2932 int len = strlen (f->scontext);
2933 if (scontext_width < len)
2934 scontext_width = len;
2937 if (format == long_format)
2939 char b[INT_BUFSIZE_BOUND (uintmax_t)];
2940 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
2941 if (nlink_width < b_len)
2942 nlink_width = b_len;
2944 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
2946 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2947 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
2948 if (major_device_number_width < len)
2949 major_device_number_width = len;
2950 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
2951 if (minor_device_number_width < len)
2952 minor_device_number_width = len;
2953 len = major_device_number_width + 2 + minor_device_number_width;
2954 if (file_size_width < len)
2955 file_size_width = len;
2957 else
2959 char buf[LONGEST_HUMAN_READABLE + 1];
2960 uintmax_t size = unsigned_file_size (f->stat.st_size);
2961 int len = mbswidth (human_readable (size, buf, human_output_opts,
2962 1, file_output_block_size),
2964 if (file_size_width < len)
2965 file_size_width = len;
2970 if (print_inode)
2972 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2973 int len = strlen (umaxtostr (f->stat.st_ino, buf));
2974 if (inode_number_width < len)
2975 inode_number_width = len;
2978 f->name = xstrdup (name);
2979 cwd_n_used++;
2981 return blocks;
2984 /* Return true if F refers to a directory. */
2985 static bool
2986 is_directory (const struct fileinfo *f)
2988 return f->filetype == directory || f->filetype == arg_directory;
2991 /* Put the name of the file that FILENAME is a symbolic link to
2992 into the LINKNAME field of `f'. COMMAND_LINE_ARG indicates whether
2993 FILENAME is a command-line argument. */
2995 static void
2996 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
2998 f->linkname = areadlink_with_size (filename, f->stat.st_size);
2999 if (f->linkname == NULL)
3000 file_failure (command_line_arg, _("cannot read symbolic link %s"),
3001 filename);
3004 /* If `linkname' is a relative name and `name' contains one or more
3005 leading directories, return `linkname' with those directories
3006 prepended; otherwise, return a copy of `linkname'.
3007 If `linkname' is zero, return zero. */
3009 static char *
3010 make_link_name (char const *name, char const *linkname)
3012 char *linkbuf;
3013 size_t bufsiz;
3015 if (!linkname)
3016 return NULL;
3018 if (*linkname == '/')
3019 return xstrdup (linkname);
3021 /* The link is to a relative name. Prepend any leading directory
3022 in `name' to the link name. */
3023 linkbuf = strrchr (name, '/');
3024 if (linkbuf == 0)
3025 return xstrdup (linkname);
3027 bufsiz = linkbuf - name + 1;
3028 linkbuf = xmalloc (bufsiz + strlen (linkname) + 1);
3029 strncpy (linkbuf, name, bufsiz);
3030 strcpy (linkbuf + bufsiz, linkname);
3031 return linkbuf;
3034 /* Return true if the last component of NAME is `.' or `..'
3035 This is so we don't try to recurse on `././././. ...' */
3037 static bool
3038 basename_is_dot_or_dotdot (const char *name)
3040 char const *base = last_component (name);
3041 return dot_or_dotdot (base);
3044 /* Remove any entries from CWD_FILE that are for directories,
3045 and queue them to be listed as directories instead.
3046 DIRNAME is the prefix to prepend to each dirname
3047 to make it correct relative to ls's working dir;
3048 if it is null, no prefix is needed and "." and ".." should not be ignored.
3049 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
3050 This is desirable when processing directories recursively. */
3052 static void
3053 extract_dirs_from_files (char const *dirname, bool command_line_arg)
3055 size_t i;
3056 size_t j;
3057 bool ignore_dot_and_dot_dot = (dirname != NULL);
3059 if (dirname && LOOP_DETECT)
3061 /* Insert a marker entry first. When we dequeue this marker entry,
3062 we'll know that DIRNAME has been processed and may be removed
3063 from the set of active directories. */
3064 queue_directory (NULL, dirname, false);
3067 /* Queue the directories last one first, because queueing reverses the
3068 order. */
3069 for (i = cwd_n_used; i-- != 0; )
3071 struct fileinfo *f = sorted_file[i];
3073 if (is_directory (f)
3074 && (! ignore_dot_and_dot_dot
3075 || ! basename_is_dot_or_dotdot (f->name)))
3077 if (!dirname || f->name[0] == '/')
3078 queue_directory (f->name, f->linkname, command_line_arg);
3079 else
3081 char *name = file_name_concat (dirname, f->name, NULL);
3082 queue_directory (name, f->linkname, command_line_arg);
3083 free (name);
3085 if (f->filetype == arg_directory)
3086 free (f->name);
3090 /* Now delete the directories from the table, compacting all the remaining
3091 entries. */
3093 for (i = 0, j = 0; i < cwd_n_used; i++)
3095 struct fileinfo *f = sorted_file[i];
3096 sorted_file[j] = f;
3097 j += (f->filetype != arg_directory);
3099 cwd_n_used = j;
3102 /* Use strcoll to compare strings in this locale. If an error occurs,
3103 report an error and longjmp to failed_strcoll. */
3105 static jmp_buf failed_strcoll;
3107 static int
3108 xstrcoll (char const *a, char const *b)
3110 int diff;
3111 errno = 0;
3112 diff = strcoll (a, b);
3113 if (errno)
3115 error (0, errno, _("cannot compare file names %s and %s"),
3116 quote_n (0, a), quote_n (1, b));
3117 set_exit_status (false);
3118 longjmp (failed_strcoll, 1);
3120 return diff;
3123 /* Comparison routines for sorting the files. */
3125 typedef void const *V;
3126 typedef int (*qsortFunc)(V a, V b);
3128 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
3129 The do { ... } while(0) makes it possible to use the macro more like
3130 a statement, without violating C89 rules: */
3131 #define DIRFIRST_CHECK(a, b) \
3132 do \
3134 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
3135 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
3136 if (a_is_dir && !b_is_dir) \
3137 return -1; /* a goes before b */ \
3138 if (!a_is_dir && b_is_dir) \
3139 return 1; /* b goes before a */ \
3141 while (0)
3143 /* Define the 8 different sort function variants required for each sortkey.
3144 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
3145 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
3146 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
3147 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
3148 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
3149 /* direct, non-dirfirst versions */ \
3150 static int xstrcoll_##key_name (V a, V b) \
3151 { return key_cmp_func (a, b, xstrcoll); } \
3152 static int strcmp_##key_name (V a, V b) \
3153 { return key_cmp_func (a, b, strcmp); } \
3155 /* reverse, non-dirfirst versions */ \
3156 static int rev_xstrcoll_##key_name (V a, V b) \
3157 { return key_cmp_func (b, a, xstrcoll); } \
3158 static int rev_strcmp_##key_name (V a, V b) \
3159 { return key_cmp_func (b, a, strcmp); } \
3161 /* direct, dirfirst versions */ \
3162 static int xstrcoll_df_##key_name (V a, V b) \
3163 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
3164 static int strcmp_df_##key_name (V a, V b) \
3165 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
3167 /* reverse, dirfirst versions */ \
3168 static int rev_xstrcoll_df_##key_name (V a, V b) \
3169 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
3170 static int rev_strcmp_df_##key_name (V a, V b) \
3171 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
3173 static inline int
3174 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3175 int (*cmp) (char const *, char const *))
3177 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3178 get_stat_ctime (&a->stat));
3179 return diff ? diff : cmp (a->name, b->name);
3182 static inline int
3183 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3184 int (*cmp) (char const *, char const *))
3186 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3187 get_stat_mtime (&a->stat));
3188 return diff ? diff : cmp (a->name, b->name);
3191 static inline int
3192 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3193 int (*cmp) (char const *, char const *))
3195 int diff = timespec_cmp (get_stat_atime (&b->stat),
3196 get_stat_atime (&a->stat));
3197 return diff ? diff : cmp (a->name, b->name);
3200 static inline int
3201 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3202 int (*cmp) (char const *, char const *))
3204 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3205 return diff ? diff : cmp (a->name, b->name);
3208 static inline int
3209 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3210 int (*cmp) (char const *, char const *))
3212 return cmp (a->name, b->name);
3215 /* Compare file extensions. Files with no extension are `smallest'.
3216 If extensions are the same, compare by filenames instead. */
3218 static inline int
3219 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3220 int (*cmp) (char const *, char const *))
3222 char const *base1 = strrchr (a->name, '.');
3223 char const *base2 = strrchr (b->name, '.');
3224 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3225 return diff ? diff : cmp (a->name, b->name);
3228 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3229 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3230 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3231 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3232 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3233 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3235 /* Compare file versions.
3236 Unlike all other compare functions above, cmp_version depends only
3237 on filevercmp, which does not fail (even for locale reasons), and does not
3238 need a secondary sort key. See lib/filevercmp.h for function description.
3240 All the other sort options, in fact, need xstrcoll and strcmp variants,
3241 because they all use a string comparison (either as the primary or secondary
3242 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3243 locale reasons. Last, strverscmp is ALWAYS available in coreutils,
3244 thanks to the gnulib library. */
3245 static inline int
3246 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3248 return filevercmp (a->name, b->name);
3251 static int xstrcoll_version (V a, V b)
3252 { return cmp_version (a, b); }
3253 static int rev_xstrcoll_version (V a, V b)
3254 { return cmp_version (b, a); }
3255 static int xstrcoll_df_version (V a, V b)
3256 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3257 static int rev_xstrcoll_df_version (V a, V b)
3258 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3261 /* We have 2^3 different variants for each sortkey function
3262 (for 3 independent sort modes).
3263 The function pointers stored in this array must be dereferenced as:
3265 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3267 Note that the order in which sortkeys are listed in the function pointer
3268 array below is defined by the order of the elements in the time_type and
3269 sort_type enums! */
3271 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3274 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3275 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3276 }, \
3278 { strcmp_##key_name, strcmp_df_##key_name }, \
3279 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3283 static qsortFunc const sort_functions[][2][2][2] =
3285 LIST_SORTFUNCTION_VARIANTS (name),
3286 LIST_SORTFUNCTION_VARIANTS (extension),
3287 LIST_SORTFUNCTION_VARIANTS (size),
3291 { xstrcoll_version, xstrcoll_df_version },
3292 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3295 /* We use NULL for the strcmp variants of version comparison
3296 since as explained in cmp_version definition, version comparison
3297 does not rely on xstrcoll, so it will never longjmp, and never
3298 need to try the strcmp fallback. */
3300 { NULL, NULL },
3301 { NULL, NULL },
3305 /* last are time sort functions */
3306 LIST_SORTFUNCTION_VARIANTS (mtime),
3307 LIST_SORTFUNCTION_VARIANTS (ctime),
3308 LIST_SORTFUNCTION_VARIANTS (atime)
3311 /* The number of sortkeys is calculated as
3312 the number of elements in the sort_type enum (i.e. sort_numtypes) +
3313 the number of elements in the time_type enum (i.e. time_numtypes) - 1
3314 This is because when sort_type==sort_time, we have up to
3315 time_numtypes possible sortkeys.
3317 This line verifies at compile-time that the array of sort functions has been
3318 initialized for all possible sortkeys. */
3319 verify (ARRAY_CARDINALITY (sort_functions)
3320 == sort_numtypes + time_numtypes - 1 );
3322 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
3324 static void
3325 initialize_ordering_vector (void)
3327 size_t i;
3328 for (i = 0; i < cwd_n_used; i++)
3329 sorted_file[i] = &cwd_file[i];
3332 /* Sort the files now in the table. */
3334 static void
3335 sort_files (void)
3337 bool use_strcmp;
3339 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
3341 free (sorted_file);
3342 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
3343 sorted_file_alloc = 3 * cwd_n_used;
3346 initialize_ordering_vector ();
3348 if (sort_type == sort_none)
3349 return;
3351 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3352 ignore strcoll failures, as a failing strcoll might be a
3353 comparison function that is not a total order, and if we ignored
3354 the failure this might cause qsort to dump core. */
3356 if (! setjmp (failed_strcoll))
3357 use_strcmp = false; /* strcoll() succeeded */
3358 else
3360 use_strcmp = true;
3361 assert (sort_type != sort_version);
3362 initialize_ordering_vector ();
3365 /* When sort_type == sort_time, use time_type as subindex. */
3366 mpsort ((void const **) sorted_file, cwd_n_used,
3367 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
3368 [use_strcmp][sort_reverse]
3369 [directories_first]);
3372 /* List all the files now in the table. */
3374 static void
3375 print_current_files (void)
3377 size_t i;
3379 switch (format)
3381 case one_per_line:
3382 for (i = 0; i < cwd_n_used; i++)
3384 print_file_name_and_frills (sorted_file[i], 0);
3385 putchar ('\n');
3387 break;
3389 case many_per_line:
3390 print_many_per_line ();
3391 break;
3393 case horizontal:
3394 print_horizontal ();
3395 break;
3397 case with_commas:
3398 print_with_commas ();
3399 break;
3401 case long_format:
3402 for (i = 0; i < cwd_n_used; i++)
3404 print_long_format (sorted_file[i]);
3405 DIRED_PUTCHAR ('\n');
3407 break;
3411 /* Replace the first %b with precomputed aligned month names.
3412 Note on glibc-2.7 at least, this speeds up the whole `ls -lU`
3413 process by around 17%, compared to letting strftime() handle the %b. */
3415 static size_t
3416 align_nstrftime (char *buf, size_t size, char const *fmt, struct tm const *tm,
3417 int __utc, int __ns)
3419 const char *nfmt = fmt;
3420 /* In the unlikely event that rpl_fmt below is not large enough,
3421 the replacement is not done. A malloc here slows ls down by 2% */
3422 char rpl_fmt[sizeof (abmon[0]) + 100];
3423 const char *pb;
3424 if (required_mon_width && (pb = strstr (fmt, "%b")))
3426 if (strlen (fmt) < (sizeof (rpl_fmt) - sizeof (abmon[0]) + 2))
3428 char *pfmt = rpl_fmt;
3429 nfmt = rpl_fmt;
3431 pfmt = mempcpy (pfmt, fmt, pb - fmt);
3432 pfmt = stpcpy (pfmt, abmon[tm->tm_mon]);
3433 strcpy (pfmt, pb + 2);
3436 size_t ret = nstrftime (buf, size, nfmt, tm, __utc, __ns);
3437 return ret;
3440 /* Return the expected number of columns in a long-format time stamp,
3441 or zero if it cannot be calculated. */
3443 static int
3444 long_time_expected_width (void)
3446 static int width = -1;
3448 if (width < 0)
3450 time_t epoch = 0;
3451 struct tm const *tm = localtime (&epoch);
3452 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3454 /* In case you're wondering if localtime can fail with an input time_t
3455 value of 0, let's just say it's very unlikely, but not inconceivable.
3456 The TZ environment variable would have to specify a time zone that
3457 is 2**31-1900 years or more ahead of UTC. This could happen only on
3458 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3459 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3460 their implementations limit the offset to 167:59 and 24:00, resp. */
3461 if (tm)
3463 size_t len =
3464 align_nstrftime (buf, sizeof buf, long_time_format[0], tm, 0, 0);
3465 if (len != 0)
3466 width = mbsnwidth (buf, len, 0);
3469 if (width < 0)
3470 width = 0;
3473 return width;
3476 /* Print the user or group name NAME, with numeric id ID, using a
3477 print width of WIDTH columns. */
3479 static void
3480 format_user_or_group (char const *name, unsigned long int id, int width)
3482 size_t len;
3484 if (name)
3486 int width_gap = width - mbswidth (name, 0);
3487 int pad = MAX (0, width_gap);
3488 fputs (name, stdout);
3489 len = strlen (name) + pad;
3492 putchar (' ');
3493 while (pad--);
3495 else
3497 printf ("%*lu ", width, id);
3498 len = width;
3501 dired_pos += len + 1;
3504 /* Print the name or id of the user with id U, using a print width of
3505 WIDTH. */
3507 static void
3508 format_user (uid_t u, int width, bool stat_ok)
3510 format_user_or_group (! stat_ok ? "?" :
3511 (numeric_ids ? NULL : getuser (u)), u, width);
3514 /* Likewise, for groups. */
3516 static void
3517 format_group (gid_t g, int width, bool stat_ok)
3519 format_user_or_group (! stat_ok ? "?" :
3520 (numeric_ids ? NULL : getgroup (g)), g, width);
3523 /* Return the number of columns that format_user_or_group will print. */
3525 static int
3526 format_user_or_group_width (char const *name, unsigned long int id)
3528 if (name)
3530 int len = mbswidth (name, 0);
3531 return MAX (0, len);
3533 else
3535 char buf[INT_BUFSIZE_BOUND (unsigned long int)];
3536 sprintf (buf, "%lu", id);
3537 return strlen (buf);
3541 /* Return the number of columns that format_user will print. */
3543 static int
3544 format_user_width (uid_t u)
3546 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3549 /* Likewise, for groups. */
3551 static int
3552 format_group_width (gid_t g)
3554 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3558 /* Print information about F in long format. */
3560 static void
3561 print_long_format (const struct fileinfo *f)
3563 char modebuf[12];
3564 char buf
3565 [LONGEST_HUMAN_READABLE + 1 /* inode */
3566 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3567 + sizeof (modebuf) - 1 + 1 /* mode string */
3568 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3569 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3570 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3571 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3573 size_t s;
3574 char *p;
3575 struct timespec when_timespec;
3576 struct tm *when_local;
3578 /* Compute the mode string, except remove the trailing space if no
3579 file in this directory has an ACL or SELinux security context. */
3580 if (f->stat_ok)
3581 filemodestring (&f->stat, modebuf);
3582 else
3584 modebuf[0] = filetype_letter[f->filetype];
3585 memset (modebuf + 1, '?', 10);
3586 modebuf[11] = '\0';
3588 if (! any_has_acl)
3589 modebuf[10] = '\0';
3590 else if (f->acl_type == ACL_T_SELINUX_ONLY)
3591 modebuf[10] = '.';
3592 else if (f->acl_type == ACL_T_YES)
3593 modebuf[10] = '+';
3595 switch (time_type)
3597 case time_ctime:
3598 when_timespec = get_stat_ctime (&f->stat);
3599 break;
3600 case time_mtime:
3601 when_timespec = get_stat_mtime (&f->stat);
3602 break;
3603 case time_atime:
3604 when_timespec = get_stat_atime (&f->stat);
3605 break;
3606 default:
3607 abort ();
3610 p = buf;
3612 if (print_inode)
3614 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3615 sprintf (p, "%*s ", inode_number_width,
3616 (f->stat.st_ino == NOT_AN_INODE_NUMBER
3617 ? "?"
3618 : umaxtostr (f->stat.st_ino, hbuf)));
3619 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3620 The latter is wrong when inode_number_width is zero. */
3621 p += strlen (p);
3624 if (print_block_size)
3626 char hbuf[LONGEST_HUMAN_READABLE + 1];
3627 char const *blocks =
3628 (! f->stat_ok
3629 ? "?"
3630 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3631 ST_NBLOCKSIZE, output_block_size));
3632 int pad;
3633 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3634 *p++ = ' ';
3635 while ((*p++ = *blocks++))
3636 continue;
3637 p[-1] = ' ';
3640 /* The last byte of the mode string is the POSIX
3641 "optional alternate access method flag". */
3643 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3644 sprintf (p, "%s %*s ", modebuf, nlink_width,
3645 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3647 /* Increment by strlen (p) here, rather than by, e.g.,
3648 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3649 The latter is wrong when nlink_width is zero. */
3650 p += strlen (p);
3652 DIRED_INDENT ();
3654 if (print_owner | print_group | print_author | print_scontext)
3656 DIRED_FPUTS (buf, stdout, p - buf);
3658 if (print_owner)
3659 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3661 if (print_group)
3662 format_group (f->stat.st_gid, group_width, f->stat_ok);
3664 if (print_author)
3665 format_user (f->stat.st_author, author_width, f->stat_ok);
3667 if (print_scontext)
3668 format_user_or_group (f->scontext, 0, scontext_width);
3670 p = buf;
3673 if (f->stat_ok
3674 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3676 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3677 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3678 int blanks_width = (file_size_width
3679 - (major_device_number_width + 2
3680 + minor_device_number_width));
3681 sprintf (p, "%*s, %*s ",
3682 major_device_number_width + MAX (0, blanks_width),
3683 umaxtostr (major (f->stat.st_rdev), majorbuf),
3684 minor_device_number_width,
3685 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3686 p += file_size_width + 1;
3688 else
3690 char hbuf[LONGEST_HUMAN_READABLE + 1];
3691 char const *size =
3692 (! f->stat_ok
3693 ? "?"
3694 : human_readable (unsigned_file_size (f->stat.st_size),
3695 hbuf, human_output_opts, 1, file_output_block_size));
3696 int pad;
3697 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3698 *p++ = ' ';
3699 while ((*p++ = *size++))
3700 continue;
3701 p[-1] = ' ';
3704 when_local = localtime (&when_timespec.tv_sec);
3705 s = 0;
3706 *p = '\1';
3708 if (f->stat_ok && when_local)
3710 struct timespec six_months_ago;
3711 bool recent;
3712 char const *fmt;
3714 /* If the file appears to be in the future, update the current
3715 time, in case the file happens to have been modified since
3716 the last time we checked the clock. */
3717 if (timespec_cmp (current_time, when_timespec) < 0)
3719 /* Note that gettime may call gettimeofday which, on some non-
3720 compliant systems, clobbers the buffer used for localtime's result.
3721 But it's ok here, because we use a gettimeofday wrapper that
3722 saves and restores the buffer around the gettimeofday call. */
3723 gettime (&current_time);
3726 /* Consider a time to be recent if it is within the past six
3727 months. A Gregorian year has 365.2425 * 24 * 60 * 60 ==
3728 31556952 seconds on the average. Write this value as an
3729 integer constant to avoid floating point hassles. */
3730 six_months_ago.tv_sec = current_time.tv_sec - 31556952 / 2;
3731 six_months_ago.tv_nsec = current_time.tv_nsec;
3733 recent = (timespec_cmp (six_months_ago, when_timespec) < 0
3734 && (timespec_cmp (when_timespec, current_time) < 0));
3735 fmt = long_time_format[recent];
3737 /* We assume here that all time zones are offset from UTC by a
3738 whole number of seconds. */
3739 s = align_nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
3740 when_local, 0, when_timespec.tv_nsec);
3743 if (s || !*p)
3745 p += s;
3746 *p++ = ' ';
3748 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
3749 *p = '\0';
3751 else
3753 /* The time cannot be converted using the desired format, so
3754 print it as a huge integer number of seconds. */
3755 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
3756 sprintf (p, "%*s ", long_time_expected_width (),
3757 (! f->stat_ok
3758 ? "?"
3759 : timetostr (when_timespec.tv_sec, hbuf)));
3760 /* FIXME: (maybe) We discarded when_timespec.tv_nsec. */
3761 p += strlen (p);
3764 DIRED_FPUTS (buf, stdout, p - buf);
3765 size_t w = print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3766 f->stat_ok, f->filetype, &dired_obstack,
3767 f->stat.st_nlink, p - buf);
3769 if (f->filetype == symbolic_link)
3771 if (f->linkname)
3773 DIRED_FPUTS_LITERAL (" -> ", stdout);
3774 print_name_with_quoting (f->linkname, f->linkmode, f->linkok - 1,
3775 f->stat_ok, f->filetype, NULL,
3776 f->stat.st_nlink, (p - buf) + w + 4);
3777 if (indicator_style != none)
3778 print_type_indicator (true, f->linkmode, unknown);
3781 else if (indicator_style != none)
3782 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3785 /* Output to OUT a quoted representation of the file name NAME,
3786 using OPTIONS to control quoting. Produce no output if OUT is NULL.
3787 Store the number of screen columns occupied by NAME's quoted
3788 representation into WIDTH, if non-NULL. Return the number of bytes
3789 produced. */
3791 static size_t
3792 quote_name (FILE *out, const char *name, struct quoting_options const *options,
3793 size_t *width)
3795 char smallbuf[BUFSIZ];
3796 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
3797 char *buf;
3798 size_t displayed_width IF_LINT (= 0);
3800 if (len < sizeof smallbuf)
3801 buf = smallbuf;
3802 else
3804 buf = alloca (len + 1);
3805 quotearg_buffer (buf, len + 1, name, -1, options);
3808 if (qmark_funny_chars)
3810 if (MB_CUR_MAX > 1)
3812 char const *p = buf;
3813 char const *plimit = buf + len;
3814 char *q = buf;
3815 displayed_width = 0;
3817 while (p < plimit)
3818 switch (*p)
3820 case ' ': case '!': case '"': case '#': case '%':
3821 case '&': case '\'': case '(': case ')': case '*':
3822 case '+': case ',': case '-': case '.': case '/':
3823 case '0': case '1': case '2': case '3': case '4':
3824 case '5': case '6': case '7': case '8': case '9':
3825 case ':': case ';': case '<': case '=': case '>':
3826 case '?':
3827 case 'A': case 'B': case 'C': case 'D': case 'E':
3828 case 'F': case 'G': case 'H': case 'I': case 'J':
3829 case 'K': case 'L': case 'M': case 'N': case 'O':
3830 case 'P': case 'Q': case 'R': case 'S': case 'T':
3831 case 'U': case 'V': case 'W': case 'X': case 'Y':
3832 case 'Z':
3833 case '[': case '\\': case ']': case '^': case '_':
3834 case 'a': case 'b': case 'c': case 'd': case 'e':
3835 case 'f': case 'g': case 'h': case 'i': case 'j':
3836 case 'k': case 'l': case 'm': case 'n': case 'o':
3837 case 'p': case 'q': case 'r': case 's': case 't':
3838 case 'u': case 'v': case 'w': case 'x': case 'y':
3839 case 'z': case '{': case '|': case '}': case '~':
3840 /* These characters are printable ASCII characters. */
3841 *q++ = *p++;
3842 displayed_width += 1;
3843 break;
3844 default:
3845 /* If we have a multibyte sequence, copy it until we
3846 reach its end, replacing each non-printable multibyte
3847 character with a single question mark. */
3849 DECLARE_ZEROED_AGGREGATE (mbstate_t, mbstate);
3852 wchar_t wc;
3853 size_t bytes;
3854 int w;
3856 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
3858 if (bytes == (size_t) -1)
3860 /* An invalid multibyte sequence was
3861 encountered. Skip one input byte, and
3862 put a question mark. */
3863 p++;
3864 *q++ = '?';
3865 displayed_width += 1;
3866 break;
3869 if (bytes == (size_t) -2)
3871 /* An incomplete multibyte character
3872 at the end. Replace it entirely with
3873 a question mark. */
3874 p = plimit;
3875 *q++ = '?';
3876 displayed_width += 1;
3877 break;
3880 if (bytes == 0)
3881 /* A null wide character was encountered. */
3882 bytes = 1;
3884 w = wcwidth (wc);
3885 if (w >= 0)
3887 /* A printable multibyte character.
3888 Keep it. */
3889 for (; bytes > 0; --bytes)
3890 *q++ = *p++;
3891 displayed_width += w;
3893 else
3895 /* An unprintable multibyte character.
3896 Replace it entirely with a question
3897 mark. */
3898 p += bytes;
3899 *q++ = '?';
3900 displayed_width += 1;
3903 while (! mbsinit (&mbstate));
3905 break;
3908 /* The buffer may have shrunk. */
3909 len = q - buf;
3911 else
3913 char *p = buf;
3914 char const *plimit = buf + len;
3916 while (p < plimit)
3918 if (! isprint (to_uchar (*p)))
3919 *p = '?';
3920 p++;
3922 displayed_width = len;
3925 else if (width != NULL)
3927 if (MB_CUR_MAX > 1)
3928 displayed_width = mbsnwidth (buf, len, 0);
3929 else
3931 char const *p = buf;
3932 char const *plimit = buf + len;
3934 displayed_width = 0;
3935 while (p < plimit)
3937 if (isprint (to_uchar (*p)))
3938 displayed_width++;
3939 p++;
3944 if (out != NULL)
3945 fwrite (buf, 1, len, out);
3946 if (width != NULL)
3947 *width = displayed_width;
3948 return len;
3951 static size_t
3952 print_name_with_quoting (const char *p, mode_t mode, int linkok,
3953 bool stat_ok, enum filetype type,
3954 struct obstack *stack, nlink_t nlink,
3955 size_t start_col)
3957 bool used_color_this_time
3958 = (print_with_color
3959 && print_color_indicator (p, mode, linkok, stat_ok, type, nlink));
3961 if (stack)
3962 PUSH_CURRENT_DIRED_POS (stack);
3964 size_t width = quote_name (stdout, p, filename_quoting_options, NULL);
3965 dired_pos += width;
3967 if (stack)
3968 PUSH_CURRENT_DIRED_POS (stack);
3970 if (used_color_this_time)
3972 process_signals ();
3973 prep_non_filename_text ();
3974 if (start_col / line_length != (start_col + width - 1) / line_length)
3975 put_indicator (&color_indicator[C_CLR_TO_EOL]);
3978 return width;
3981 static void
3982 prep_non_filename_text (void)
3984 if (color_indicator[C_END].string != NULL)
3985 put_indicator (&color_indicator[C_END]);
3986 else
3988 put_indicator (&color_indicator[C_LEFT]);
3989 put_indicator (&color_indicator[C_RESET]);
3990 put_indicator (&color_indicator[C_RIGHT]);
3994 /* Print the file name of `f' with appropriate quoting.
3995 Also print file size, inode number, and filetype indicator character,
3996 as requested by switches. */
3998 static size_t
3999 print_file_name_and_frills (const struct fileinfo *f, size_t start_col)
4001 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4003 if (print_inode)
4004 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
4005 umaxtostr (f->stat.st_ino, buf));
4007 if (print_block_size)
4008 printf ("%*s ", format == with_commas ? 0 : block_size_width,
4009 human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
4010 ST_NBLOCKSIZE, output_block_size));
4012 if (print_scontext)
4013 printf ("%*s ", format == with_commas ? 0 : scontext_width, f->scontext);
4015 size_t width = print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f),
4016 f->linkok, f->stat_ok, f->filetype,
4017 NULL, f->stat.st_nlink, start_col);
4019 if (indicator_style != none)
4020 width += print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4022 return width;
4025 /* Given these arguments describing a file, return the single-byte
4026 type indicator, or 0. */
4027 static char
4028 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4030 char c;
4032 if (stat_ok ? S_ISREG (mode) : type == normal)
4034 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
4035 c = '*';
4036 else
4037 c = 0;
4039 else
4041 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
4042 c = '/';
4043 else if (indicator_style == slash)
4044 c = 0;
4045 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
4046 c = '@';
4047 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
4048 c = '|';
4049 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
4050 c = '=';
4051 else if (stat_ok && S_ISDOOR (mode))
4052 c = '>';
4053 else
4054 c = 0;
4056 return c;
4059 static bool
4060 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4062 char c = get_type_indicator (stat_ok, mode, type);
4063 if (c)
4064 DIRED_PUTCHAR (c);
4065 return !!c;
4068 #ifdef HAVE_CAP
4069 /* Return true if NAME has a capability (see linux/capability.h) */
4070 static bool
4071 has_capability (char const *name)
4073 char *result;
4074 bool has_cap;
4076 cap_t cap_d = cap_get_file (name);
4077 if (cap_d == NULL)
4078 return false;
4080 result = cap_to_text (cap_d, NULL);
4081 cap_free (cap_d);
4082 if (!result)
4083 return false;
4085 /* check if human-readable capability string is empty */
4086 has_cap = !!*result;
4088 cap_free (result);
4089 return has_cap;
4091 #else
4092 static bool
4093 has_capability (char const *name ATTRIBUTE_UNUSED)
4095 return false;
4097 #endif
4099 /* Returns whether any color sequence was printed. */
4100 static bool
4101 print_color_indicator (const char *name, mode_t mode, int linkok,
4102 bool stat_ok, enum filetype filetype,
4103 nlink_t nlink)
4105 int type;
4106 struct color_ext_type *ext; /* Color extension */
4107 size_t len; /* Length of name */
4109 /* Is this a nonexistent file? If so, linkok == -1. */
4111 if (linkok == -1 && color_indicator[C_MISSING].string != NULL)
4112 type = C_MISSING;
4113 else if (! stat_ok)
4115 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
4116 type = filetype_indicator[filetype];
4118 else
4120 if (S_ISREG (mode))
4122 type = C_FILE;
4123 if ((mode & S_ISUID) != 0)
4124 type = C_SETUID;
4125 else if ((mode & S_ISGID) != 0)
4126 type = C_SETGID;
4127 else if (is_colored (C_CAP) && has_capability (name))
4128 type = C_CAP;
4129 else if ((mode & S_IXUGO) != 0)
4130 type = C_EXEC;
4131 else if (is_colored (C_MULTIHARDLINK) && (1 < nlink))
4132 type = C_MULTIHARDLINK;
4134 else if (S_ISDIR (mode))
4136 if ((mode & S_ISVTX) && (mode & S_IWOTH))
4137 type = C_STICKY_OTHER_WRITABLE;
4138 else if ((mode & S_IWOTH) != 0)
4139 type = C_OTHER_WRITABLE;
4140 else if ((mode & S_ISVTX) != 0)
4141 type = C_STICKY;
4142 else
4143 type = C_DIR;
4145 else if (S_ISLNK (mode))
4146 type = ((!linkok && color_indicator[C_ORPHAN].string)
4147 ? C_ORPHAN : C_LINK);
4148 else if (S_ISFIFO (mode))
4149 type = C_FIFO;
4150 else if (S_ISSOCK (mode))
4151 type = C_SOCK;
4152 else if (S_ISBLK (mode))
4153 type = C_BLK;
4154 else if (S_ISCHR (mode))
4155 type = C_CHR;
4156 else if (S_ISDOOR (mode))
4157 type = C_DOOR;
4158 else
4160 /* Classify a file of some other type as C_ORPHAN. */
4161 type = C_ORPHAN;
4165 /* Check the file's suffix only if still classified as C_FILE. */
4166 ext = NULL;
4167 if (type == C_FILE)
4169 /* Test if NAME has a recognized suffix. */
4171 len = strlen (name);
4172 name += len; /* Pointer to final \0. */
4173 for (ext = color_ext_list; ext != NULL; ext = ext->next)
4175 if (ext->ext.len <= len
4176 && strncmp (name - ext->ext.len, ext->ext.string,
4177 ext->ext.len) == 0)
4178 break;
4183 const struct bin_str *const s
4184 = ext ? &(ext->seq) : &color_indicator[type];
4185 if (s->string != NULL)
4187 put_indicator (&color_indicator[C_LEFT]);
4188 put_indicator (s);
4189 put_indicator (&color_indicator[C_RIGHT]);
4190 return true;
4192 else
4193 return false;
4197 /* Output a color indicator (which may contain nulls). */
4198 static void
4199 put_indicator (const struct bin_str *ind)
4201 if (! used_color)
4203 used_color = true;
4204 prep_non_filename_text ();
4207 fwrite (ind->string, ind->len, 1, stdout);
4210 static size_t
4211 length_of_file_name_and_frills (const struct fileinfo *f)
4213 size_t len = 0;
4214 size_t name_width;
4215 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4217 if (print_inode)
4218 len += 1 + (format == with_commas
4219 ? strlen (umaxtostr (f->stat.st_ino, buf))
4220 : inode_number_width);
4222 if (print_block_size)
4223 len += 1 + (format == with_commas
4224 ? strlen (human_readable (ST_NBLOCKS (f->stat), buf,
4225 human_output_opts, ST_NBLOCKSIZE,
4226 output_block_size))
4227 : block_size_width);
4229 if (print_scontext)
4230 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
4232 quote_name (NULL, f->name, filename_quoting_options, &name_width);
4233 len += name_width;
4235 if (indicator_style != none)
4237 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4238 len += (c != 0);
4241 return len;
4244 static void
4245 print_many_per_line (void)
4247 size_t row; /* Current row. */
4248 size_t cols = calculate_columns (true);
4249 struct column_info const *line_fmt = &column_info[cols - 1];
4251 /* Calculate the number of rows that will be in each column except possibly
4252 for a short column on the right. */
4253 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
4255 for (row = 0; row < rows; row++)
4257 size_t col = 0;
4258 size_t filesno = row;
4259 size_t pos = 0;
4261 /* Print the next row. */
4262 while (1)
4264 struct fileinfo const *f = sorted_file[filesno];
4265 size_t name_length = length_of_file_name_and_frills (f);
4266 size_t max_name_length = line_fmt->col_arr[col++];
4267 print_file_name_and_frills (f, pos);
4269 filesno += rows;
4270 if (filesno >= cwd_n_used)
4271 break;
4273 indent (pos + name_length, pos + max_name_length);
4274 pos += max_name_length;
4276 putchar ('\n');
4280 static void
4281 print_horizontal (void)
4283 size_t filesno;
4284 size_t pos = 0;
4285 size_t cols = calculate_columns (false);
4286 struct column_info const *line_fmt = &column_info[cols - 1];
4287 struct fileinfo const *f = sorted_file[0];
4288 size_t name_length = length_of_file_name_and_frills (f);
4289 size_t max_name_length = line_fmt->col_arr[0];
4291 /* Print first entry. */
4292 print_file_name_and_frills (f, 0);
4294 /* Now the rest. */
4295 for (filesno = 1; filesno < cwd_n_used; ++filesno)
4297 size_t col = filesno % cols;
4299 if (col == 0)
4301 putchar ('\n');
4302 pos = 0;
4304 else
4306 indent (pos + name_length, pos + max_name_length);
4307 pos += max_name_length;
4310 f = sorted_file[filesno];
4311 print_file_name_and_frills (f, pos);
4313 name_length = length_of_file_name_and_frills (f);
4314 max_name_length = line_fmt->col_arr[col];
4316 putchar ('\n');
4319 static void
4320 print_with_commas (void)
4322 size_t filesno;
4323 size_t pos = 0;
4325 for (filesno = 0; filesno < cwd_n_used; filesno++)
4327 struct fileinfo const *f = sorted_file[filesno];
4328 size_t len = length_of_file_name_and_frills (f);
4330 if (filesno != 0)
4332 char separator;
4334 if (pos + len + 2 < line_length)
4336 pos += 2;
4337 separator = ' ';
4339 else
4341 pos = 0;
4342 separator = '\n';
4345 putchar (',');
4346 putchar (separator);
4349 print_file_name_and_frills (f, pos);
4350 pos += len;
4352 putchar ('\n');
4355 /* Assuming cursor is at position FROM, indent up to position TO.
4356 Use a TAB character instead of two or more spaces whenever possible. */
4358 static void
4359 indent (size_t from, size_t to)
4361 while (from < to)
4363 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4365 putchar ('\t');
4366 from += tabsize - from % tabsize;
4368 else
4370 putchar (' ');
4371 from++;
4376 /* Put DIRNAME/NAME into DEST, handling `.' and `/' properly. */
4377 /* FIXME: maybe remove this function someday. See about using a
4378 non-malloc'ing version of file_name_concat. */
4380 static void
4381 attach (char *dest, const char *dirname, const char *name)
4383 const char *dirnamep = dirname;
4385 /* Copy dirname if it is not ".". */
4386 if (dirname[0] != '.' || dirname[1] != 0)
4388 while (*dirnamep)
4389 *dest++ = *dirnamep++;
4390 /* Add '/' if `dirname' doesn't already end with it. */
4391 if (dirnamep > dirname && dirnamep[-1] != '/')
4392 *dest++ = '/';
4394 while (*name)
4395 *dest++ = *name++;
4396 *dest = 0;
4399 /* Allocate enough column info suitable for the current number of
4400 files and display columns, and initialize the info to represent the
4401 narrowest possible columns. */
4403 static void
4404 init_column_info (void)
4406 size_t i;
4407 size_t max_cols = MIN (max_idx, cwd_n_used);
4409 /* Currently allocated columns in column_info. */
4410 static size_t column_info_alloc;
4412 if (column_info_alloc < max_cols)
4414 size_t new_column_info_alloc;
4415 size_t *p;
4417 if (max_cols < max_idx / 2)
4419 /* The number of columns is far less than the display width
4420 allows. Grow the allocation, but only so that it's
4421 double the current requirements. If the display is
4422 extremely wide, this avoids allocating a lot of memory
4423 that is never needed. */
4424 column_info = xnrealloc (column_info, max_cols,
4425 2 * sizeof *column_info);
4426 new_column_info_alloc = 2 * max_cols;
4428 else
4430 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4431 new_column_info_alloc = max_idx;
4434 /* Allocate the new size_t objects by computing the triangle
4435 formula n * (n + 1) / 2, except that we don't need to
4436 allocate the part of the triangle that we've already
4437 allocated. Check for address arithmetic overflow. */
4439 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4440 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4441 size_t t = s * column_info_growth;
4442 if (s < new_column_info_alloc || t / column_info_growth != s)
4443 xalloc_die ();
4444 p = xnmalloc (t / 2, sizeof *p);
4447 /* Grow the triangle by parceling out the cells just allocated. */
4448 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4450 column_info[i].col_arr = p;
4451 p += i + 1;
4454 column_info_alloc = new_column_info_alloc;
4457 for (i = 0; i < max_cols; ++i)
4459 size_t j;
4461 column_info[i].valid_len = true;
4462 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4463 for (j = 0; j <= i; ++j)
4464 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4468 /* Calculate the number of columns needed to represent the current set
4469 of files in the current display width. */
4471 static size_t
4472 calculate_columns (bool by_columns)
4474 size_t filesno; /* Index into cwd_file. */
4475 size_t cols; /* Number of files across. */
4477 /* Normally the maximum number of columns is determined by the
4478 screen width. But if few files are available this might limit it
4479 as well. */
4480 size_t max_cols = MIN (max_idx, cwd_n_used);
4482 init_column_info ();
4484 /* Compute the maximum number of possible columns. */
4485 for (filesno = 0; filesno < cwd_n_used; ++filesno)
4487 struct fileinfo const *f = sorted_file[filesno];
4488 size_t name_length = length_of_file_name_and_frills (f);
4489 size_t i;
4491 for (i = 0; i < max_cols; ++i)
4493 if (column_info[i].valid_len)
4495 size_t idx = (by_columns
4496 ? filesno / ((cwd_n_used + i) / (i + 1))
4497 : filesno % (i + 1));
4498 size_t real_length = name_length + (idx == i ? 0 : 2);
4500 if (column_info[i].col_arr[idx] < real_length)
4502 column_info[i].line_len += (real_length
4503 - column_info[i].col_arr[idx]);
4504 column_info[i].col_arr[idx] = real_length;
4505 column_info[i].valid_len = (column_info[i].line_len
4506 < line_length);
4512 /* Find maximum allowed columns. */
4513 for (cols = max_cols; 1 < cols; --cols)
4515 if (column_info[cols - 1].valid_len)
4516 break;
4519 return cols;
4522 void
4523 usage (int status)
4525 if (status != EXIT_SUCCESS)
4526 fprintf (stderr, _("Try `%s --help' for more information.\n"),
4527 program_name);
4528 else
4530 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4531 fputs (_("\
4532 List information about the FILEs (the current directory by default).\n\
4533 Sort entries alphabetically if none of -cftuvSUX nor --sort.\n\
4535 "), stdout);
4536 fputs (_("\
4537 Mandatory arguments to long options are mandatory for short options too.\n\
4538 "), stdout);
4539 fputs (_("\
4540 -a, --all do not ignore entries starting with .\n\
4541 -A, --almost-all do not list implied . and ..\n\
4542 --author with -l, print the author of each file\n\
4543 -b, --escape print octal escapes for nongraphic characters\n\
4544 "), stdout);
4545 fputs (_("\
4546 --block-size=SIZE use SIZE-byte blocks. See SIZE format below\n\
4547 -B, --ignore-backups do not list implied entries ending with ~\n\
4548 -c with -lt: sort by, and show, ctime (time of last\n\
4549 modification of file status information)\n\
4550 with -l: show ctime and sort by name\n\
4551 otherwise: sort by ctime\n\
4552 "), stdout);
4553 fputs (_("\
4554 -C list entries by columns\n\
4555 --color[=WHEN] control whether color is used to distinguish file\n\
4556 types. WHEN may be `never', `always', or `auto'\n\
4557 -d, --directory list directory entries instead of contents,\n\
4558 and do not dereference symbolic links\n\
4559 -D, --dired generate output designed for Emacs' dired mode\n\
4560 "), stdout);
4561 fputs (_("\
4562 -f do not sort, enable -aU, disable -ls --color\n\
4563 -F, --classify append indicator (one of */=>@|) to entries\n\
4564 --file-type likewise, except do not append `*'\n\
4565 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4566 single-column -1, verbose -l, vertical -C\n\
4567 --full-time like -l --time-style=full-iso\n\
4568 "), stdout);
4569 fputs (_("\
4570 -g like -l, but do not list owner\n\
4571 "), stdout);
4572 fputs (_("\
4573 --group-directories-first\n\
4574 group directories before files.\n\
4575 augment with a --sort option, but any\n\
4576 use of --sort=none (-U) disables grouping\n\
4577 "), stdout);
4578 fputs (_("\
4579 -G, --no-group in a long listing, don't print group names\n\
4580 -h, --human-readable with -l, print sizes in human readable format\n\
4581 (e.g., 1K 234M 2G)\n\
4582 --si likewise, but use powers of 1000 not 1024\n\
4583 "), stdout);
4584 fputs (_("\
4585 -H, --dereference-command-line\n\
4586 follow symbolic links listed on the command line\n\
4587 --dereference-command-line-symlink-to-dir\n\
4588 follow each command line symbolic link\n\
4589 that points to a directory\n\
4590 --hide=PATTERN do not list implied entries matching shell PATTERN\n\
4591 (overridden by -a or -A)\n\
4592 "), stdout);
4593 fputs (_("\
4594 --indicator-style=WORD append indicator with style WORD to entry names:\n\
4595 none (default), slash (-p),\n\
4596 file-type (--file-type), classify (-F)\n\
4597 -i, --inode print the index number of each file\n\
4598 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\n\
4599 -k like --block-size=1K\n\
4600 "), stdout);
4601 fputs (_("\
4602 -l use a long listing format\n\
4603 -L, --dereference when showing file information for a symbolic\n\
4604 link, show information for the file the link\n\
4605 references rather than for the link itself\n\
4606 -m fill width with a comma separated list of entries\n\
4607 "), stdout);
4608 fputs (_("\
4609 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4610 -N, --literal print raw entry names (don't treat e.g. control\n\
4611 characters specially)\n\
4612 -o like -l, but do not list group information\n\
4613 -p, --indicator-style=slash\n\
4614 append / indicator to directories\n\
4615 "), stdout);
4616 fputs (_("\
4617 -q, --hide-control-chars print ? instead of non graphic characters\n\
4618 --show-control-chars show non graphic characters as-is (default\n\
4619 unless program is `ls' and output is a terminal)\n\
4620 -Q, --quote-name enclose entry names in double quotes\n\
4621 --quoting-style=WORD use quoting style WORD for entry names:\n\
4622 literal, locale, shell, shell-always, c, escape\n\
4623 "), stdout);
4624 fputs (_("\
4625 -r, --reverse reverse order while sorting\n\
4626 -R, --recursive list subdirectories recursively\n\
4627 -s, --size print the allocated size of each file, in blocks\n\
4628 "), stdout);
4629 fputs (_("\
4630 -S sort by file size\n\
4631 --sort=WORD sort by WORD instead of name: none -U,\n\
4632 extension -X, size -S, time -t, version -v\n\
4633 --time=WORD with -l, show time as WORD instead of modification\n\
4634 time: atime -u, access -u, use -u, ctime -c,\n\
4635 or status -c; use specified time as sort key\n\
4636 if --sort=time\n\
4637 "), stdout);
4638 fputs (_("\
4639 --time-style=STYLE with -l, show times using style STYLE:\n\
4640 full-iso, long-iso, iso, locale, +FORMAT.\n\
4641 FORMAT is interpreted like `date'; if FORMAT is\n\
4642 FORMAT1<newline>FORMAT2, FORMAT1 applies to\n\
4643 non-recent files and FORMAT2 to recent files;\n\
4644 if STYLE is prefixed with `posix-', STYLE\n\
4645 takes effect only outside the POSIX locale\n\
4646 "), stdout);
4647 fputs (_("\
4648 -t sort by modification time\n\
4649 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4650 "), stdout);
4651 fputs (_("\
4652 -u with -lt: sort by, and show, access time\n\
4653 with -l: show access time and sort by name\n\
4654 otherwise: sort by access time\n\
4655 -U do not sort; list entries in directory order\n\
4656 -v natural sort of (version) numbers within text\n\
4657 "), stdout);
4658 fputs (_("\
4659 -w, --width=COLS assume screen width instead of current value\n\
4660 -x list entries by lines instead of by columns\n\
4661 -X sort alphabetically by entry extension\n\
4662 -Z, --context print any SELinux security context of each file\n\
4663 -1 list one file per line\n\
4664 "), stdout);
4665 fputs (HELP_OPTION_DESCRIPTION, stdout);
4666 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4667 emit_size_note ();
4668 fputs (_("\
4670 By default, color is not used to distinguish types of files. That is\n\
4671 equivalent to using --color=none. Using the --color option without the\n\
4672 optional WHEN argument is equivalent to using --color=always. With\n\
4673 --color=auto, color codes are output only if standard output is connected\n\
4674 to a terminal (tty). The environment variable LS_COLORS can influence the\n\
4675 colors, and can be set easily by the dircolors command.\n\
4676 "), stdout);
4677 fputs (_("\
4679 Exit status:\n\
4680 0 if OK,\n\
4681 1 if minor problems (e.g., cannot access subdirectory),\n\
4682 2 if serious trouble (e.g., cannot access command-line argument).\n\
4683 "), stdout);
4684 emit_bug_reporting_address ();
4686 exit (status);