1 /* `dir', `vdir' and `ls' directory listing programs for GNU.
2 Copyright (C) 85, 88, 90, 91, 1995-2007 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 2, or (at your option)
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, write to the Free Software Foundation,
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
18 /* If ls_mode is LS_MULTI_COL,
19 the multi-column format is the default regardless
20 of the type of output device.
21 This is for the `dir' program.
23 If ls_mode is LS_LONG_FORMAT,
24 the long format is the default regardless of the
25 type of output device.
26 This is for the `vdir' program.
29 the output format depends on whether the output
31 This is for the `ls' program. */
33 /* Written by Richard Stallman and David MacKenzie. */
35 /* Color support by Peter Anvin <Peter.Anvin@linux.org> and Dennis
36 Flaherty <dennisf@denix.elk.miles.com> based on original patches by
37 Greg Lee <lee@uhunix.uhcc.hawaii.edu>. */
40 #include <sys/types.h>
49 # include <sys/ioctl.h>
52 #ifdef WINSIZE_IN_PTEM
53 # include <sys/stream.h>
54 # include <sys/ptem.h>
64 #include <selinux/selinux.h>
66 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
69 # define SA_NOCLDSTOP 0
70 # define sigprocmask(How, Set, Oset) /* empty */
72 # if ! HAVE_SIGINTERRUPT
73 # define siginterrupt(sig, flag) /* empty */
88 #include "filenamecat.h"
89 #include "hard-locale.h"
100 #include "quotearg.h"
102 #include "stat-time.h"
103 #include "strftime.h"
104 #include "strverscmp.h"
107 #include "xreadlink.h"
109 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
110 : (ls_mode == LS_MULTI_COL \
113 #define AUTHORS "Richard Stallman", "David MacKenzie"
115 #define obstack_chunk_alloc malloc
116 #define obstack_chunk_free free
118 /* Return an int indicating the result of comparing two integers.
119 Subtracting doesn't always work, due to overflow. */
120 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
122 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
123 # define st_author st_uid
140 /* Display letters and indicators for each filetype.
141 Keep these in sync with enum filetype. */
142 static char const filetype_letter[] = "?pcdb-lswd";
144 /* Ensure that filetype and filetype_letter have the same
145 number of elements. */
146 verify (sizeof filetype_letter - 1 == arg_directory + 1);
148 #define FILETYPE_INDICATORS \
150 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
151 C_LINK, C_SOCK, C_FILE, C_DIR \
160 /* For symbolic link, name of the file linked to, otherwise zero. */
165 enum filetype filetype;
167 /* For symbolic link and long listing, st_mode of file linked to, otherwise
171 /* SELinux security context. */
172 security_context_t scontext;
176 /* For symbolic link and color printing, true if linked-to file
177 exists, otherwise false. */
180 /* For long listings, true if the file has an access control list,
181 or an SELinux security context. */
185 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
187 /* Null is a valid character in a color indicator (think about Epson
188 printers, for example) so we have to use a length/buffer string
193 size_t len; /* Number of bytes */
194 const char *string; /* Pointer to the same */
201 # define tcgetpgrp(Fd) 0
204 static size_t quote_name (FILE *out, const char *name,
205 struct quoting_options const *options,
207 static char *make_link_name (char const *name, char const *linkname);
208 static int decode_switches (int argc, char **argv);
209 static bool file_ignored (char const *name);
210 static uintmax_t gobble_file (char const *name, enum filetype type,
211 ino_t inode, bool command_line_arg,
212 char const *dirname);
213 static void print_color_indicator (const char *name, mode_t mode, int linkok,
214 bool stat_ok, enum filetype type);
215 static void put_indicator (const struct bin_str *ind);
216 static void add_ignore_pattern (const char *pattern);
217 static void attach (char *dest, const char *dirname, const char *name);
218 static void clear_files (void);
219 static void extract_dirs_from_files (char const *dirname,
220 bool command_line_arg);
221 static void get_link_name (char const *filename, struct fileinfo *f,
222 bool command_line_arg);
223 static void indent (size_t from, size_t to);
224 static size_t calculate_columns (bool by_columns);
225 static void print_current_files (void);
226 static void print_dir (char const *name, char const *realname,
227 bool command_line_arg);
228 static void print_file_name_and_frills (const struct fileinfo *f);
229 static void print_horizontal (void);
230 static int format_user_width (uid_t u);
231 static int format_group_width (gid_t g);
232 static void print_long_format (const struct fileinfo *f);
233 static void print_many_per_line (void);
234 static void print_name_with_quoting (const char *p, mode_t mode,
235 int linkok, bool stat_ok,
237 struct obstack *stack);
238 static void prep_non_filename_text (void);
239 static void print_type_indicator (bool stat_ok, mode_t mode,
241 static void print_with_commas (void);
242 static void queue_directory (char const *name, char const *realname,
243 bool command_line_arg);
244 static void sort_files (void);
245 static void parse_ls_color (void);
246 void usage (int status);
248 /* The name this program was run with. */
251 /* Initial size of hash table.
252 Most hierarchies are likely to be shallower than this. */
253 #define INITIAL_TABLE_SIZE 30
255 /* The set of `active' directories, from the current command-line argument
256 to the level in the hierarchy at which files are being listed.
257 A directory is represented by its device and inode numbers (struct dev_ino).
258 A directory is added to this set when ls begins listing it or its
259 entries, and it is removed from the set just after ls has finished
260 processing it. This set is used solely to detect loops, e.g., with
261 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
262 static Hash_table *active_dir_set;
264 #define LOOP_DETECT (!!active_dir_set)
266 /* The table of files in the current directory:
268 `cwd_file' points to a vector of `struct fileinfo', one per file.
269 `cwd_n_alloc' is the number of elements space has been allocated for.
270 `cwd_n_used' is the number actually in use. */
272 /* Address of block containing the files that are described. */
273 static struct fileinfo *cwd_file;
275 /* Length of block that `cwd_file' points to, measured in files. */
276 static size_t cwd_n_alloc;
278 /* Index of first unused slot in `cwd_file'. */
279 static size_t cwd_n_used;
281 /* Vector of pointers to files, in proper sorted order, and the number
282 of entries allocated for it. */
283 static void **sorted_file;
284 static size_t sorted_file_alloc;
286 /* When true, in a color listing, color each symlink name according to the
287 type of file it points to. Otherwise, color them according to the `ln'
288 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
289 regardless. This is set when `ln=target' appears in LS_COLORS. */
291 static bool color_symlink_as_referent;
293 /* mode of appropriate file for colorization */
294 #define FILE_OR_LINK_MODE(File) \
295 ((color_symlink_as_referent & (File)->linkok) \
296 ? (File)->linkmode : (File)->stat.st_mode)
299 /* Record of one pending directory waiting to be listed. */
304 /* If the directory is actually the file pointed to by a symbolic link we
305 were told to list, `realname' will contain the name of the symbolic
306 link, otherwise zero. */
308 bool command_line_arg;
309 struct pending *next;
312 static struct pending *pending_dirs;
314 /* Current time in seconds and nanoseconds since 1970, updated as
315 needed when deciding whether a file is recent. */
317 static time_t current_time = TYPE_MINIMUM (time_t);
318 static int current_time_ns = -1;
320 static bool print_scontext;
322 /* Whether any of the files has an ACL. This affects the width of the
325 static bool any_has_acl;
327 /* The number of columns to use for columns containing inode numbers,
328 block sizes, link counts, owners, groups, authors, major device
329 numbers, minor device numbers, and file sizes, respectively. */
331 static int inode_number_width;
332 static int block_size_width;
333 static int nlink_width;
334 static int scontext_width;
335 static int owner_width;
336 static int group_width;
337 static int author_width;
338 static int major_device_number_width;
339 static int minor_device_number_width;
340 static int file_size_width;
344 /* long_format for lots of info, one per line.
345 one_per_line for just names, one per line.
346 many_per_line for just names, many per line, sorted vertically.
347 horizontal for just names, many per line, sorted horizontally.
348 with_commas for just names, many per line, separated by commas.
350 -l (and other options that imply -l), -1, -C, -x and -m control
355 long_format, /* -l and other options that imply -l */
356 one_per_line, /* -1 */
357 many_per_line, /* -C */
362 static enum format format;
364 /* `full-iso' uses full ISO-style dates and times. `long-iso' uses longer
365 ISO-style time stamps, though shorter than `full-iso'. `iso' uses shorter
366 ISO-style time stamps. `locale' uses locale-dependent time stamps. */
369 full_iso_time_style, /* --time-style=full-iso */
370 long_iso_time_style, /* --time-style=long-iso */
371 iso_time_style, /* --time-style=iso */
372 locale_time_style /* --time-style=locale */
375 static char const *const time_style_args[] =
377 "full-iso", "long-iso", "iso", "locale", NULL
379 static enum time_style const time_style_types[] =
381 full_iso_time_style, long_iso_time_style, iso_time_style,
384 ARGMATCH_VERIFY (time_style_args, time_style_types);
386 /* Type of time to print or sort by. Controlled by -c and -u.
387 The values of each item of this enum are important since they are
388 used as indices in the sort functions array (see sort_files()). */
392 time_mtime, /* default */
395 time_numtypes /* the number of elements of this enum */
398 static enum time_type time_type;
400 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
401 The values of each item of this enum are important since they are
402 used as indices in the sort functions array (see sort_files()). */
406 sort_none = -1, /* -U */
407 sort_name, /* default */
408 sort_extension, /* -X */
410 sort_version, /* -v */
412 sort_numtypes /* the number of elements of this enum */
415 static enum sort_type sort_type;
417 /* Direction of sort.
418 false means highest first if numeric,
419 lowest first if alphabetic;
420 these are the defaults.
421 true means the opposite order in each case. -r */
423 static bool sort_reverse;
425 /* True means to display owner information. -g turns this off. */
427 static bool print_owner = true;
429 /* True means to display author information. */
431 static bool print_author;
433 /* True means to display group information. -G and -o turn this off. */
435 static bool print_group = true;
437 /* True means print the user and group id's as numbers rather
440 static bool numeric_ids;
442 /* True means mention the size in blocks of each file. -s */
444 static bool print_block_size;
446 /* Human-readable options for output. */
447 static int human_output_opts;
449 /* The units to use when printing sizes other than file sizes. */
450 static uintmax_t output_block_size;
452 /* Likewise, but for file sizes. */
453 static uintmax_t file_output_block_size = 1;
455 /* Follow the output with a special string. Using this format,
456 Emacs' dired mode starts up twice as fast, and can handle all
457 strange characters in file names. */
460 /* `none' means don't mention the type of files.
461 `slash' means mention directories only, with a '/'.
462 `file_type' means mention file types.
463 `classify' means mention file types and mark executables.
465 Controlled by -F, -p, and --indicator-style. */
469 none, /* --indicator-style=none */
470 slash, /* -p, --indicator-style=slash */
471 file_type, /* --indicator-style=file-type */
472 classify /* -F, --indicator-style=classify */
475 static enum indicator_style indicator_style;
477 /* Names of indicator styles. */
478 static char const *const indicator_style_args[] =
480 "none", "slash", "file-type", "classify", NULL
482 static enum indicator_style const indicator_style_types[] =
484 none, slash, file_type, classify
486 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
488 /* True means use colors to mark types. Also define the different
489 colors as well as the stuff for the LS_COLORS environment variable.
490 The LS_COLORS variable is now in a termcap-like format. */
492 static bool print_with_color;
496 color_never, /* 0: default or --color=never */
497 color_always, /* 1: --color=always */
498 color_if_tty /* 2: --color=tty */
501 enum Dereference_symlink
505 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
506 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
507 DEREF_ALWAYS /* -L */
512 C_LEFT, C_RIGHT, C_END, C_NORM, C_FILE, C_DIR, C_LINK, C_FIFO, C_SOCK,
513 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
514 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE
517 static const char *const indicator_name[]=
519 "lc", "rc", "ec", "no", "fi", "di", "ln", "pi", "so",
520 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
524 struct color_ext_type
526 struct bin_str ext; /* The extension we're looking for */
527 struct bin_str seq; /* The sequence to output when we do */
528 struct color_ext_type *next; /* Next in list */
531 static struct bin_str color_indicator[] =
533 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
534 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
535 { 0, NULL }, /* ec: End color (replaces lc+no+rc) */
536 { LEN_STR_PAIR ("0") }, /* no: Normal */
537 { LEN_STR_PAIR ("0") }, /* fi: File: default */
538 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
539 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
540 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
541 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
542 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
543 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
544 { 0, NULL }, /* mi: Missing file: undefined */
545 { 0, NULL }, /* or: Orphaned symlink: undefined */
546 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
547 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
548 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
549 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
550 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
551 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
552 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
556 static struct color_ext_type *color_ext_list = NULL;
558 /* Buffer for color sequences */
559 static char *color_buf;
561 /* True means to check for orphaned symbolic link, for displaying
564 static bool check_symlink_color;
566 /* True means mention the inode number of each file. -i */
568 static bool print_inode;
570 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
571 other options that imply -l), and -L. */
573 static enum Dereference_symlink dereference;
575 /* True means when a directory is found, display info on its
578 static bool recursive;
580 /* True means when an argument is a directory name, display info
583 static bool immediate_dirs;
585 /* True means that directories are grouped before files. */
587 static bool directories_first;
589 /* Which files to ignore. */
593 /* Ignore files whose names start with `.', and files specified by
594 --hide and --ignore. */
597 /* Ignore `.', `..', and files specified by --ignore. */
598 IGNORE_DOT_AND_DOTDOT,
600 /* Ignore only files specified by --ignore. */
604 /* A linked list of shell-style globbing patterns. If a non-argument
605 file name matches any of these patterns, it is ignored.
606 Controlled by -I. Multiple -I options accumulate.
607 The -B option adds `*~' and `.*~' to this list. */
609 struct ignore_pattern
612 struct ignore_pattern *next;
615 static struct ignore_pattern *ignore_patterns;
617 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
618 variable itself to be ignored. */
619 static struct ignore_pattern *hide_patterns;
621 /* True means output nongraphic chars in file names as `?'.
622 (-q, --hide-control-chars)
623 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
624 independent. The algorithm is: first, obey the quoting style to get a
625 string representing the file name; then, if qmark_funny_chars is set,
626 replace all nonprintable chars in that string with `?'. It's necessary
627 to replace nonprintable chars even in quoted strings, because we don't
628 want to mess up the terminal if control chars get sent to it, and some
629 quoting methods pass through control chars as-is. */
630 static bool qmark_funny_chars;
632 /* Quoting options for file and dir name output. */
634 static struct quoting_options *filename_quoting_options;
635 static struct quoting_options *dirname_quoting_options;
637 /* The number of chars per hardware tab stop. Setting this to zero
638 inhibits the use of TAB characters for separating columns. -T */
639 static size_t tabsize;
641 /* True means print each directory name before listing it. */
643 static bool print_dir_name;
645 /* The line length to use for breaking lines in many-per-line format.
646 Can be set with -w. */
648 static size_t line_length;
650 /* If true, the file listing format requires that stat be called on
653 static bool format_needs_stat;
655 /* Similar to `format_needs_stat', but set if only the file type is
658 static bool format_needs_type;
660 /* An arbitrary limit on the number of bytes in a printed time stamp.
661 This is set to a relatively small value to avoid the need to worry
662 about denial-of-service attacks on servers that run "ls" on behalf
663 of remote clients. 1000 bytes should be enough for any practical
664 time stamp format. */
666 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
668 /* strftime formats for non-recent and recent files, respectively, in
671 static char const *long_time_format[2] =
673 /* strftime format for non-recent files (older than 6 months), in
674 -l output. This should contain the year, month and day (at
675 least), in an order that is understood by people in your
676 locale's territory. Please try to keep the number of used
677 screen columns small, because many people work in windows with
678 only 80 columns. But make this as wide as the other string
679 below, for recent files. */
681 /* strftime format for recent files (younger than 6 months), in -l
682 output. This should contain the month, day and time (at
683 least), in an order that is understood by people in your
684 locale's territory. Please try to keep the number of used
685 screen columns small, because many people work in windows with
686 only 80 columns. But make this as wide as the other string
687 above, for non-recent files. */
691 /* The set of signals that are caught. */
693 static sigset_t caught_signals;
695 /* If nonzero, the value of the pending fatal signal. */
697 static sig_atomic_t volatile interrupt_signal;
699 /* A count of the number of pending stop signals that have been received. */
701 static sig_atomic_t volatile stop_signal_count;
703 /* Desired exit status. */
705 static int exit_status;
710 /* "ls" had a minor problem (e.g., it could not stat a directory
712 LS_MINOR_PROBLEM = 1,
714 /* "ls" had more serious trouble. */
718 /* For long options that have no equivalent short option, use a
719 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
722 AUTHOR_OPTION = CHAR_MAX + 1,
725 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
726 FILE_TYPE_INDICATOR_OPTION,
729 GROUP_DIRECTORIES_FIRST_OPTION,
731 INDICATOR_STYLE_OPTION,
733 /* FIXME: --kilobytes is deprecated (but not -k); remove in late 2006 */
734 KILOBYTES_LONG_OPTION,
736 QUOTING_STYLE_OPTION,
737 SHOW_CONTROL_CHARS_OPTION,
744 static struct option const long_options[] =
746 {"all", no_argument, NULL, 'a'},
747 {"escape", no_argument, NULL, 'b'},
748 {"directory", no_argument, NULL, 'd'},
749 {"dired", no_argument, NULL, 'D'},
750 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
751 {"group-directories-first", no_argument, NULL,
752 GROUP_DIRECTORIES_FIRST_OPTION},
753 {"human-readable", no_argument, NULL, 'h'},
754 {"inode", no_argument, NULL, 'i'},
755 {"kilobytes", no_argument, NULL, KILOBYTES_LONG_OPTION},
756 {"numeric-uid-gid", no_argument, NULL, 'n'},
757 {"no-group", no_argument, NULL, 'G'},
758 {"hide-control-chars", no_argument, NULL, 'q'},
759 {"reverse", no_argument, NULL, 'r'},
760 {"size", no_argument, NULL, 's'},
761 {"width", required_argument, NULL, 'w'},
762 {"almost-all", no_argument, NULL, 'A'},
763 {"ignore-backups", no_argument, NULL, 'B'},
764 {"classify", no_argument, NULL, 'F'},
765 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
766 {"si", no_argument, NULL, SI_OPTION},
767 {"dereference-command-line", no_argument, NULL, 'H'},
768 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
769 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
770 {"hide", required_argument, NULL, HIDE_OPTION},
771 {"ignore", required_argument, NULL, 'I'},
772 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
773 {"dereference", no_argument, NULL, 'L'},
774 {"literal", no_argument, NULL, 'N'},
775 {"quote-name", no_argument, NULL, 'Q'},
776 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
777 {"recursive", no_argument, NULL, 'R'},
778 {"format", required_argument, NULL, FORMAT_OPTION},
779 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
780 {"sort", required_argument, NULL, SORT_OPTION},
781 {"tabsize", required_argument, NULL, 'T'},
782 {"time", required_argument, NULL, TIME_OPTION},
783 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
784 {"color", optional_argument, NULL, COLOR_OPTION},
785 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
786 {"context", no_argument, 0, 'Z'},
787 {"author", no_argument, NULL, AUTHOR_OPTION},
788 {GETOPT_HELP_OPTION_DECL},
789 {GETOPT_VERSION_OPTION_DECL},
793 static char const *const format_args[] =
795 "verbose", "long", "commas", "horizontal", "across",
796 "vertical", "single-column", NULL
798 static enum format const format_types[] =
800 long_format, long_format, with_commas, horizontal, horizontal,
801 many_per_line, one_per_line
803 ARGMATCH_VERIFY (format_args, format_types);
805 static char const *const sort_args[] =
807 "none", "time", "size", "extension", "version", NULL
809 static enum sort_type const sort_types[] =
811 sort_none, sort_time, sort_size, sort_extension, sort_version
813 ARGMATCH_VERIFY (sort_args, sort_types);
815 static char const *const time_args[] =
817 "atime", "access", "use", "ctime", "status", NULL
819 static enum time_type const time_types[] =
821 time_atime, time_atime, time_atime, time_ctime, time_ctime
823 ARGMATCH_VERIFY (time_args, time_types);
825 static char const *const color_args[] =
827 /* force and none are for compatibility with another color-ls version */
828 "always", "yes", "force",
829 "never", "no", "none",
830 "auto", "tty", "if-tty", NULL
832 static enum color_type const color_types[] =
834 color_always, color_always, color_always,
835 color_never, color_never, color_never,
836 color_if_tty, color_if_tty, color_if_tty
838 ARGMATCH_VERIFY (color_args, color_types);
840 /* Information about filling a column. */
848 /* Array with information about column filledness. */
849 static struct column_info *column_info;
851 /* Maximum number of columns ever possible for this display. */
852 static size_t max_idx;
854 /* The minimum width of a column is 3: 1 character for the name and 2
855 for the separating white space. */
856 #define MIN_COLUMN_WIDTH 3
859 /* This zero-based index is used solely with the --dired option.
860 When that option is in effect, this counter is incremented for each
861 byte of output generated by this program so that the beginning
862 and ending indices (in that output) of every file name can be recorded
863 and later output themselves. */
864 static size_t dired_pos;
866 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
868 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
869 #define DIRED_FPUTS(s, stream, s_len) \
870 do {fputs (s, stream); dired_pos += s_len;} while (0)
872 /* Like DIRED_FPUTS, but for use when S is a literal string. */
873 #define DIRED_FPUTS_LITERAL(s, stream) \
874 do {fputs (s, stream); dired_pos += sizeof (s) - 1;} while (0)
876 #define DIRED_INDENT() \
880 DIRED_FPUTS_LITERAL (" ", stdout); \
884 /* With --dired, store pairs of beginning and ending indices of filenames. */
885 static struct obstack dired_obstack;
887 /* With --dired, store pairs of beginning and ending indices of any
888 directory names that appear as headers (just before `total' line)
889 for lists of directory entries. Such directory names are seen when
890 listing hierarchies using -R and when a directory is listed with at
891 least one other command line argument. */
892 static struct obstack subdired_obstack;
894 /* Save the current index on the specified obstack, OBS. */
895 #define PUSH_CURRENT_DIRED_POS(obs) \
899 obstack_grow (obs, &dired_pos, sizeof (dired_pos)); \
903 /* With -R, this stack is used to help detect directory cycles.
904 The device/inode pairs on this stack mirror the pairs in the
905 active_dir_set hash table. */
906 static struct obstack dev_ino_obstack;
908 /* Push a pair onto the device/inode stack. */
909 #define DEV_INO_PUSH(Dev, Ino) \
912 struct dev_ino *di; \
913 obstack_blank (&dev_ino_obstack, sizeof (struct dev_ino)); \
914 di = -1 + (struct dev_ino *) obstack_next_free (&dev_ino_obstack); \
915 di->st_dev = (Dev); \
916 di->st_ino = (Ino); \
920 /* Pop a dev/ino struct off the global dev_ino_obstack
921 and return that struct. */
922 static struct dev_ino
925 assert (sizeof (struct dev_ino) <= obstack_object_size (&dev_ino_obstack));
926 obstack_blank (&dev_ino_obstack, -(int) (sizeof (struct dev_ino)));
927 return *(struct dev_ino *) obstack_next_free (&dev_ino_obstack);
930 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
935 assert (0 <= stat (Name, &sb)); \
936 assert (sb.st_dev == Di.st_dev); \
937 assert (sb.st_ino == Di.st_ino); \
942 /* Write to standard output PREFIX, followed by the quoting style and
943 a space-separated list of the integers stored in OS all on one line. */
946 dired_dump_obstack (const char *prefix, struct obstack *os)
950 n_pos = obstack_object_size (os) / sizeof (dired_pos);
956 pos = (size_t *) obstack_finish (os);
957 fputs (prefix, stdout);
958 for (i = 0; i < n_pos; i++)
959 printf (" %lu", (unsigned long int) pos[i]);
965 dev_ino_hash (void const *x, size_t table_size)
967 struct dev_ino const *p = x;
968 return (uintmax_t) p->st_ino % table_size;
972 dev_ino_compare (void const *x, void const *y)
974 struct dev_ino const *a = x;
975 struct dev_ino const *b = y;
976 return SAME_INODE (*a, *b) ? true : false;
980 dev_ino_free (void *x)
985 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
986 active directories. Return true if there is already a matching
987 entry in the table. */
990 visit_dir (dev_t dev, ino_t ino)
993 struct dev_ino *ent_from_table;
996 ent = xmalloc (sizeof *ent);
1000 /* Attempt to insert this entry into the table. */
1001 ent_from_table = hash_insert (active_dir_set, ent);
1003 if (ent_from_table == NULL)
1005 /* Insertion failed due to lack of memory. */
1009 found_match = (ent_from_table != ent);
1013 /* ent was not inserted, so free it. */
1021 free_pending_ent (struct pending *p)
1029 is_colored (enum indicator_no type)
1031 size_t len = color_indicator[type].len;
1032 char const *s = color_indicator[type].string;
1034 || (len == 1 && strncmp (s, "0", 1) == 0)
1035 || (len == 2 && strncmp (s, "00", 2) == 0));
1039 restore_default_color (void)
1041 put_indicator (&color_indicator[C_LEFT]);
1042 put_indicator (&color_indicator[C_RIGHT]);
1045 /* An ordinary signal was received; arrange for the program to exit. */
1048 sighandler (int sig)
1051 signal (sig, SIG_IGN);
1052 if (! interrupt_signal)
1053 interrupt_signal = sig;
1056 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1059 stophandler (int sig)
1062 signal (sig, stophandler);
1063 if (! interrupt_signal)
1064 stop_signal_count++;
1067 /* Process any pending signals. If signals are caught, this function
1068 should be called periodically. Ideally there should never be an
1069 unbounded amount of time when signals are not being processed.
1070 Signal handling can restore the default colors, so callers must
1071 immediately change colors after invoking this function. */
1074 process_signals (void)
1076 while (interrupt_signal | stop_signal_count)
1082 restore_default_color ();
1085 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1087 /* Reload interrupt_signal and stop_signal_count, in case a new
1088 signal was handled before sigprocmask took effect. */
1089 sig = interrupt_signal;
1090 stops = stop_signal_count;
1092 /* SIGTSTP is special, since the application can receive that signal
1093 more than once. In this case, don't set the signal handler to the
1094 default. Instead, just raise the uncatchable SIGSTOP. */
1097 stop_signal_count = stops - 1;
1101 signal (sig, SIG_DFL);
1103 /* Exit or suspend the program. */
1105 sigprocmask (SIG_SETMASK, &oldset, NULL);
1107 /* If execution reaches here, then the program has been
1108 continued (after being suspended). */
1113 main (int argc, char **argv)
1116 struct pending *thispend;
1119 /* The signals that are trapped, and the number of such signals. */
1120 static int const sig[] =
1122 /* This one is handled specially. */
1125 /* The usual suspects. */
1126 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1143 enum { nsigs = sizeof sig / sizeof sig[0] };
1146 bool caught_sig[nsigs];
1149 initialize_main (&argc, &argv);
1150 program_name = argv[0];
1151 setlocale (LC_ALL, "");
1152 bindtextdomain (PACKAGE, LOCALEDIR);
1153 textdomain (PACKAGE);
1155 initialize_exit_failure (LS_FAILURE);
1156 atexit (close_stdout);
1158 #define N_ENTRIES(Array) (sizeof Array / sizeof *(Array))
1159 assert (N_ENTRIES (color_indicator) + 1 == N_ENTRIES (indicator_name));
1161 exit_status = EXIT_SUCCESS;
1162 print_dir_name = true;
1163 pending_dirs = NULL;
1165 i = decode_switches (argc, argv);
1167 if (print_with_color)
1170 /* Test print_with_color again, because the call to parse_ls_color
1171 may have just reset it -- e.g., if LS_COLORS is invalid. */
1172 if (print_with_color)
1174 /* Avoid following symbolic links when possible. */
1175 if (is_colored (C_ORPHAN)
1176 || is_colored (C_EXEC)
1177 || (is_colored (C_MISSING) && format == long_format))
1178 check_symlink_color = true;
1180 /* If the standard output is a controlling terminal, watch out
1181 for signals, so that the colors can be restored to the
1182 default state if "ls" is suspended or interrupted. */
1184 if (0 <= tcgetpgrp (STDOUT_FILENO))
1188 struct sigaction act;
1190 sigemptyset (&caught_signals);
1191 for (j = 0; j < nsigs; j++)
1193 sigaction (sig[j], NULL, &act);
1194 if (act.sa_handler != SIG_IGN)
1195 sigaddset (&caught_signals, sig[j]);
1198 act.sa_mask = caught_signals;
1199 act.sa_flags = SA_RESTART;
1201 for (j = 0; j < nsigs; j++)
1202 if (sigismember (&caught_signals, sig[j]))
1204 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1205 sigaction (sig[j], &act, NULL);
1208 for (j = 0; j < nsigs; j++)
1210 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1213 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1214 siginterrupt (sig[j], 0);
1220 prep_non_filename_text ();
1223 if (dereference == DEREF_UNDEFINED)
1224 dereference = ((immediate_dirs
1225 || indicator_style == classify
1226 || format == long_format)
1228 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1230 /* When using -R, initialize a data structure we'll use to
1231 detect any directory cycles. */
1234 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, NULL,
1238 if (active_dir_set == NULL)
1241 obstack_init (&dev_ino_obstack);
1244 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1245 || format == long_format
1247 || print_block_size;
1248 format_needs_type = (! format_needs_stat
1251 || indicator_style != none
1252 || directories_first));
1256 obstack_init (&dired_obstack);
1257 obstack_init (&subdired_obstack);
1261 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1271 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1273 queue_directory (".", NULL, true);
1277 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1283 if (!immediate_dirs)
1284 extract_dirs_from_files (NULL, true);
1285 /* `cwd_n_used' might be zero now. */
1288 /* In the following if/else blocks, it is sufficient to test `pending_dirs'
1289 (and not pending_dirs->name) because there may be no markers in the queue
1290 at this point. A marker may be enqueued when extract_dirs_from_files is
1291 called with a non-empty string or via print_dir. */
1294 print_current_files ();
1296 DIRED_PUTCHAR ('\n');
1298 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1299 print_dir_name = false;
1301 while (pending_dirs)
1303 thispend = pending_dirs;
1304 pending_dirs = pending_dirs->next;
1308 if (thispend->name == NULL)
1310 /* thispend->name == NULL means this is a marker entry
1311 indicating we've finished processing the directory.
1312 Use its dev/ino numbers to remove the corresponding
1313 entry from the active_dir_set hash table. */
1314 struct dev_ino di = dev_ino_pop ();
1315 struct dev_ino *found = hash_delete (active_dir_set, &di);
1316 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1318 dev_ino_free (found);
1319 free_pending_ent (thispend);
1324 print_dir (thispend->name, thispend->realname,
1325 thispend->command_line_arg);
1327 free_pending_ent (thispend);
1328 print_dir_name = true;
1331 if (print_with_color)
1335 restore_default_color ();
1338 /* Restore the default signal handling. */
1340 for (j = 0; j < nsigs; j++)
1341 if (sigismember (&caught_signals, sig[j]))
1342 signal (sig[j], SIG_DFL);
1344 for (j = 0; j < nsigs; j++)
1346 signal (sig[j], SIG_DFL);
1349 /* Act on any signals that arrived before the default was restored.
1350 This can process signals out of order, but there doesn't seem to
1351 be an easy way to do them in order, and the order isn't that
1352 important anyway. */
1353 for (j = stop_signal_count; j; j--)
1355 j = interrupt_signal;
1362 /* No need to free these since we're about to exit. */
1363 dired_dump_obstack ("//DIRED//", &dired_obstack);
1364 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1365 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1366 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1371 assert (hash_get_n_entries (active_dir_set) == 0);
1372 hash_free (active_dir_set);
1378 /* Set all the option flags according to the switches specified.
1379 Return the index of the first non-option argument. */
1382 decode_switches (int argc, char **argv)
1385 char *time_style_option = NULL;
1387 /* Record whether there is an option specifying sort type. */
1388 bool sort_type_specified = false;
1390 qmark_funny_chars = false;
1392 /* initialize all switches to default settings */
1397 /* This is for the `dir' program. */
1398 format = many_per_line;
1399 set_quoting_style (NULL, escape_quoting_style);
1402 case LS_LONG_FORMAT:
1403 /* This is for the `vdir' program. */
1404 format = long_format;
1405 set_quoting_style (NULL, escape_quoting_style);
1409 /* This is for the `ls' program. */
1410 if (isatty (STDOUT_FILENO))
1412 format = many_per_line;
1413 /* See description of qmark_funny_chars, above. */
1414 qmark_funny_chars = true;
1418 format = one_per_line;
1419 qmark_funny_chars = false;
1427 time_type = time_mtime;
1428 sort_type = sort_name;
1429 sort_reverse = false;
1430 numeric_ids = false;
1431 print_block_size = false;
1432 indicator_style = none;
1433 print_inode = false;
1434 dereference = DEREF_UNDEFINED;
1436 immediate_dirs = false;
1437 ignore_mode = IGNORE_DEFAULT;
1438 ignore_patterns = NULL;
1439 hide_patterns = NULL;
1440 print_scontext = false;
1442 /* FIXME: put this in a function. */
1444 char const *q_style = getenv ("QUOTING_STYLE");
1447 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
1449 set_quoting_style (NULL, quoting_style_vals[i]);
1452 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
1453 quotearg (q_style));
1458 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1459 human_output_opts = human_options (ls_block_size, false,
1460 &output_block_size);
1461 if (ls_block_size || getenv ("BLOCK_SIZE"))
1462 file_output_block_size = output_block_size;
1467 char const *p = getenv ("COLUMNS");
1470 unsigned long int tmp_ulong;
1471 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1472 && 0 < tmp_ulong && tmp_ulong <= SIZE_MAX)
1474 line_length = tmp_ulong;
1479 _("ignoring invalid width in environment variable COLUMNS: %s"),
1489 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1490 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1491 line_length = ws.ws_col;
1496 char const *p = getenv ("TABSIZE");
1500 unsigned long int tmp_ulong;
1501 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1502 && tmp_ulong <= SIZE_MAX)
1504 tabsize = tmp_ulong;
1509 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1515 while ((c = getopt_long (argc, argv,
1516 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1517 long_options, NULL)) != -1)
1522 ignore_mode = IGNORE_MINIMAL;
1526 set_quoting_style (NULL, escape_quoting_style);
1530 time_type = time_ctime;
1534 immediate_dirs = true;
1538 /* Same as enabling -a -U and disabling -l -s. */
1539 ignore_mode = IGNORE_MINIMAL;
1540 sort_type = sort_none;
1541 sort_type_specified = true;
1543 if (format == long_format)
1544 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1545 print_block_size = false; /* disable -s */
1546 print_with_color = false; /* disable --color */
1549 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1550 indicator_style = file_type;
1554 format = long_format;
1555 print_owner = false;
1559 human_output_opts = human_autoscale | human_SI | human_base_1024;
1560 file_output_block_size = output_block_size = 1;
1567 case KILOBYTES_LONG_OPTION:
1569 _("the --kilobytes option is deprecated; use -k instead"));
1572 human_output_opts = 0;
1573 file_output_block_size = output_block_size = 1024;
1577 format = long_format;
1581 format = with_commas;
1586 format = long_format;
1589 case 'o': /* Just like -l, but don't display group info. */
1590 format = long_format;
1591 print_group = false;
1595 indicator_style = slash;
1599 qmark_funny_chars = true;
1603 sort_reverse = true;
1607 print_block_size = true;
1611 sort_type = sort_time;
1612 sort_type_specified = true;
1616 time_type = time_atime;
1620 sort_type = sort_version;
1621 sort_type_specified = true;
1626 unsigned long int tmp_ulong;
1627 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1628 || ! (0 < tmp_ulong && tmp_ulong <= SIZE_MAX))
1629 error (LS_FAILURE, 0, _("invalid line width: %s"),
1631 line_length = tmp_ulong;
1636 format = horizontal;
1640 if (ignore_mode == IGNORE_DEFAULT)
1641 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1645 add_ignore_pattern ("*~");
1646 add_ignore_pattern (".*~");
1650 format = many_per_line;
1658 indicator_style = classify;
1661 case 'G': /* inhibit display of group info */
1662 print_group = false;
1666 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1669 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1670 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1674 add_ignore_pattern (optarg);
1678 dereference = DEREF_ALWAYS;
1682 set_quoting_style (NULL, literal_quoting_style);
1686 set_quoting_style (NULL, c_quoting_style);
1694 sort_type = sort_size;
1695 sort_type_specified = true;
1700 unsigned long int tmp_ulong;
1701 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1702 || SIZE_MAX < tmp_ulong)
1703 error (LS_FAILURE, 0, _("invalid tab size: %s"),
1705 tabsize = tmp_ulong;
1710 sort_type = sort_none;
1711 sort_type_specified = true;
1715 sort_type = sort_extension;
1716 sort_type_specified = true;
1720 /* -1 has no effect after -l. */
1721 if (format != long_format)
1722 format = one_per_line;
1726 print_author = true;
1731 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1732 hide->pattern = optarg;
1733 hide->next = hide_patterns;
1734 hide_patterns = hide;
1739 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1740 sort_type_specified = true;
1743 case GROUP_DIRECTORIES_FIRST_OPTION:
1744 directories_first = true;
1748 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1752 format = XARGMATCH ("--format", optarg, format_args, format_types);
1755 case FULL_TIME_OPTION:
1756 format = long_format;
1757 time_style_option = "full-iso";
1764 i = XARGMATCH ("--color", optarg, color_args, color_types);
1766 /* Using --color with no argument is equivalent to using
1770 print_with_color = (i == color_always
1771 || (i == color_if_tty
1772 && isatty (STDOUT_FILENO)));
1774 if (print_with_color)
1776 /* Don't use TAB characters in output. Some terminal
1777 emulators can't handle the combination of tabs and
1778 color codes on the same line. */
1784 case INDICATOR_STYLE_OPTION:
1785 indicator_style = XARGMATCH ("--indicator-style", optarg,
1786 indicator_style_args,
1787 indicator_style_types);
1790 case QUOTING_STYLE_OPTION:
1791 set_quoting_style (NULL,
1792 XARGMATCH ("--quoting-style", optarg,
1794 quoting_style_vals));
1797 case TIME_STYLE_OPTION:
1798 time_style_option = optarg;
1801 case SHOW_CONTROL_CHARS_OPTION:
1802 qmark_funny_chars = false;
1805 case BLOCK_SIZE_OPTION:
1806 human_output_opts = human_options (optarg, true, &output_block_size);
1807 file_output_block_size = output_block_size;
1811 human_output_opts = human_autoscale | human_SI;
1812 file_output_block_size = output_block_size = 1;
1816 print_scontext = true;
1819 case_GETOPT_HELP_CHAR;
1821 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1828 max_idx = MAX (1, line_length / MIN_COLUMN_WIDTH);
1830 filename_quoting_options = clone_quoting_options (NULL);
1831 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1832 set_char_quoting (filename_quoting_options, ' ', 1);
1833 if (file_type <= indicator_style)
1836 for (p = "*=>@|" + indicator_style - file_type; *p; p++)
1837 set_char_quoting (filename_quoting_options, *p, 1);
1840 dirname_quoting_options = clone_quoting_options (NULL);
1841 set_char_quoting (dirname_quoting_options, ':', 1);
1843 /* --dired is meaningful only with --format=long (-l).
1844 Otherwise, ignore it. FIXME: warn about this?
1845 Alternatively, make --dired imply --format=long? */
1846 if (dired && format != long_format)
1849 /* If -c or -u is specified and not -l (or any other option that implies -l),
1850 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
1851 The behavior of ls when using either -c or -u but with neither -l nor -t
1852 appears to be unspecified by POSIX. So, with GNU ls, `-u' alone means
1853 sort by atime (this is the one that's not specified by the POSIX spec),
1854 -lu means show atime and sort by name, -lut means show atime and sort
1857 if ((time_type == time_ctime || time_type == time_atime)
1858 && !sort_type_specified && format != long_format)
1860 sort_type = sort_time;
1863 if (format == long_format)
1865 char *style = time_style_option;
1866 static char const posix_prefix[] = "posix-";
1869 if (! (style = getenv ("TIME_STYLE")))
1872 while (strncmp (style, posix_prefix, sizeof posix_prefix - 1) == 0)
1874 if (! hard_locale (LC_TIME))
1876 style += sizeof posix_prefix - 1;
1881 char *p0 = style + 1;
1882 char *p1 = strchr (p0, '\n');
1887 if (strchr (p1 + 1, '\n'))
1888 error (LS_FAILURE, 0, _("invalid time style format %s"),
1892 long_time_format[0] = p0;
1893 long_time_format[1] = p1;
1896 switch (XARGMATCH ("time style", style,
1900 case full_iso_time_style:
1901 long_time_format[0] = long_time_format[1] =
1902 "%Y-%m-%d %H:%M:%S.%N %z";
1905 case long_iso_time_style:
1906 case_long_iso_time_style:
1907 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
1910 case iso_time_style:
1911 long_time_format[0] = "%Y-%m-%d ";
1912 long_time_format[1] = "%m-%d %H:%M";
1915 case locale_time_style:
1916 if (hard_locale (LC_TIME))
1918 /* Ensure that the locale has translations for both
1919 formats. If not, fall back on long-iso format. */
1921 for (i = 0; i < 2; i++)
1923 char const *locale_format =
1924 dcgettext (NULL, long_time_format[i], LC_TIME);
1925 if (locale_format == long_time_format[i])
1926 goto case_long_iso_time_style;
1927 long_time_format[i] = locale_format;
1936 /* Parse a string as part of the LS_COLORS variable; this may involve
1937 decoding all kinds of escape characters. If equals_end is set an
1938 unescaped equal sign ends the string, otherwise only a : or \0
1939 does. Set *OUTPUT_COUNT to the number of bytes output. Return
1942 The resulting string is *not* null-terminated, but may contain
1945 Note that both dest and src are char **; on return they point to
1946 the first free byte after the array and the character that ended
1947 the input string, respectively. */
1950 get_funky_string (char **dest, const char **src, bool equals_end,
1951 size_t *output_count)
1953 char num; /* For numerical codes */
1954 size_t count; /* Something to count with */
1956 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
1961 p = *src; /* We don't want to double-indirect */
1962 q = *dest; /* the whole darn time. */
1964 count = 0; /* No characters counted in yet. */
1967 state = ST_GND; /* Start in ground state. */
1968 while (state < ST_END)
1972 case ST_GND: /* Ground state (no escapes) */
1977 state = ST_END; /* End of string */
1980 state = ST_BACKSLASH; /* Backslash scape sequence */
1984 state = ST_CARET; /* Caret escape */
1990 state = ST_END; /* End */
1993 /* else fall through */
2001 case ST_BACKSLASH: /* Backslash escaped character */
2012 state = ST_OCTAL; /* Octal sequence */
2017 state = ST_HEX; /* Hex sequence */
2020 case 'a': /* Bell */
2023 case 'b': /* Backspace */
2026 case 'e': /* Escape */
2029 case 'f': /* Form feed */
2032 case 'n': /* Newline */
2035 case 'r': /* Carriage return */
2041 case 'v': /* Vtab */
2044 case '?': /* Delete */
2047 case '_': /* Space */
2050 case '\0': /* End of string */
2051 state = ST_ERROR; /* Error! */
2053 default: /* Escaped character like \ ^ : = */
2057 if (state == ST_BACKSLASH)
2066 case ST_OCTAL: /* Octal sequence */
2067 if (*p < '0' || *p > '7')
2074 num = (num << 3) + (*(p++) - '0');
2077 case ST_HEX: /* Hex sequence */
2090 num = (num << 4) + (*(p++) - '0');
2098 num = (num << 4) + (*(p++) - 'a') + 10;
2106 num = (num << 4) + (*(p++) - 'A') + 10;
2116 case ST_CARET: /* Caret escape */
2117 state = ST_GND; /* Should be the next state... */
2118 if (*p >= '@' && *p <= '~')
2120 *(q++) = *(p++) & 037;
2139 *output_count = count;
2141 return state != ST_ERROR;
2145 parse_ls_color (void)
2147 const char *p; /* Pointer to character being parsed */
2148 char *buf; /* color_buf buffer pointer */
2149 int state; /* State of parser */
2150 int ind_no; /* Indicator number */
2151 char label[3]; /* Indicator label */
2152 struct color_ext_type *ext; /* Extension we are working on */
2154 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2158 strcpy (label, "??");
2160 /* This is an overly conservative estimate, but any possible
2161 LS_COLORS string will *not* generate a color_buf longer than
2162 itself, so it is a safe way of allocating a buffer in
2164 buf = color_buf = xstrdup (p);
2171 case 1: /* First label character */
2179 /* Allocate new extension block and add to head of
2180 linked list (this way a later definition will
2181 override an earlier one, which can be useful for
2182 having terminal-specific defs override global). */
2184 ext = xmalloc (sizeof *ext);
2185 ext->next = color_ext_list;
2186 color_ext_list = ext;
2189 ext->ext.string = buf;
2191 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2196 state = 0; /* Done! */
2199 default: /* Assume it is file type label */
2206 case 2: /* Second label character */
2213 state = -1; /* Error */
2216 case 3: /* Equal sign after indicator label */
2217 state = -1; /* Assume failure... */
2218 if (*(p++) == '=')/* It *should* be... */
2220 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2222 if (STREQ (label, indicator_name[ind_no]))
2224 color_indicator[ind_no].string = buf;
2225 state = (get_funky_string (&buf, &p, false,
2226 &color_indicator[ind_no].len)
2232 error (0, 0, _("unrecognized prefix: %s"), quotearg (label));
2236 case 4: /* Equal sign after *.ext */
2239 ext->seq.string = buf;
2240 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2251 struct color_ext_type *e;
2252 struct color_ext_type *e2;
2255 _("unparsable value for LS_COLORS environment variable"));
2257 for (e = color_ext_list; e != NULL; /* empty */)
2263 print_with_color = false;
2266 if (color_indicator[C_LINK].len == 6
2267 && !strncmp (color_indicator[C_LINK].string, "target", 6))
2268 color_symlink_as_referent = true;
2271 /* Set the exit status to report a failure. If SERIOUS, it is a
2272 serious failure; otherwise, it is merely a minor problem. */
2275 set_exit_status (bool serious)
2278 exit_status = LS_FAILURE;
2279 else if (exit_status == EXIT_SUCCESS)
2280 exit_status = LS_MINOR_PROBLEM;
2283 /* Assuming a failure is serious if SERIOUS, use the printf-style
2284 MESSAGE to report the failure to access a file named FILE. Assume
2285 errno is set appropriately for the failure. */
2288 file_failure (bool serious, char const *message, char const *file)
2290 error (0, errno, message, quotearg_colon (file));
2291 set_exit_status (serious);
2294 /* Request that the directory named NAME have its contents listed later.
2295 If REALNAME is nonzero, it will be used instead of NAME when the
2296 directory name is printed. This allows symbolic links to directories
2297 to be treated as regular directories but still be listed under their
2298 real names. NAME == NULL is used to insert a marker entry for the
2299 directory named in REALNAME.
2300 If NAME is non-NULL, we use its dev/ino information to save
2301 a call to stat -- when doing a recursive (-R) traversal.
2302 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2305 queue_directory (char const *name, char const *realname, bool command_line_arg)
2307 struct pending *new = xmalloc (sizeof *new);
2308 new->realname = realname ? xstrdup (realname) : NULL;
2309 new->name = name ? xstrdup (name) : NULL;
2310 new->command_line_arg = command_line_arg;
2311 new->next = pending_dirs;
2315 /* Read directory NAME, and list the files in it.
2316 If REALNAME is nonzero, print its name instead of NAME;
2317 this is used for symbolic links to directories.
2318 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2321 print_dir (char const *name, char const *realname, bool command_line_arg)
2324 struct dirent *next;
2325 uintmax_t total_blocks = 0;
2326 static bool first = true;
2329 dirp = opendir (name);
2332 file_failure (command_line_arg, _("cannot open directory %s"), name);
2338 struct stat dir_stat;
2339 int fd = dirfd (dirp);
2341 /* If dirfd failed, endure the overhead of using stat. */
2343 ? fstat (fd, &dir_stat)
2344 : stat (name, &dir_stat)) < 0)
2346 file_failure (command_line_arg,
2347 _("cannot determine device and inode of %s"), name);
2352 /* If we've already visited this dev/inode pair, warn that
2353 we've found a loop, and do not process this directory. */
2354 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2356 error (0, 0, _("%s: not listing already-listed directory"),
2357 quotearg_colon (name));
2362 DEV_INO_PUSH (dir_stat.st_dev, dir_stat.st_ino);
2365 /* Read the directory entries, and insert the subfiles into the `cwd_file'
2372 /* Set errno to zero so we can distinguish between a readdir failure
2373 and when readdir simply finds that there are no more entries. */
2375 next = readdir (dirp);
2378 if (! file_ignored (next->d_name))
2380 enum filetype type = unknown;
2382 #if HAVE_STRUCT_DIRENT_D_TYPE
2383 switch (next->d_type)
2385 case DT_BLK: type = blockdev; break;
2386 case DT_CHR: type = chardev; break;
2387 case DT_DIR: type = directory; break;
2388 case DT_FIFO: type = fifo; break;
2389 case DT_LNK: type = symbolic_link; break;
2390 case DT_REG: type = normal; break;
2391 case DT_SOCK: type = sock; break;
2393 case DT_WHT: type = whiteout; break;
2397 total_blocks += gobble_file (next->d_name, type, D_INO (next),
2401 else if (errno != 0)
2403 file_failure (command_line_arg, _("reading directory %s"), name);
2404 if (errno != EOVERFLOW)
2411 if (closedir (dirp) != 0)
2413 file_failure (command_line_arg, _("closing directory %s"), name);
2414 /* Don't return; print whatever we got. */
2417 /* Sort the directory contents. */
2420 /* If any member files are subdirectories, perhaps they should have their
2421 contents listed rather than being mentioned here as files. */
2424 extract_dirs_from_files (name, command_line_arg);
2426 if (recursive | print_dir_name)
2429 DIRED_PUTCHAR ('\n');
2432 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2433 dired_pos += quote_name (stdout, realname ? realname : name,
2434 dirname_quoting_options, NULL);
2435 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2436 DIRED_FPUTS_LITERAL (":\n", stdout);
2439 if (format == long_format || print_block_size)
2442 char buf[LONGEST_HUMAN_READABLE + 1];
2446 DIRED_FPUTS (p, stdout, strlen (p));
2447 DIRED_PUTCHAR (' ');
2448 p = human_readable (total_blocks, buf, human_output_opts,
2449 ST_NBLOCKSIZE, output_block_size);
2450 DIRED_FPUTS (p, stdout, strlen (p));
2451 DIRED_PUTCHAR ('\n');
2455 print_current_files ();
2458 /* Add `pattern' to the list of patterns for which files that match are
2462 add_ignore_pattern (const char *pattern)
2464 struct ignore_pattern *ignore;
2466 ignore = xmalloc (sizeof *ignore);
2467 ignore->pattern = pattern;
2468 /* Add it to the head of the linked list. */
2469 ignore->next = ignore_patterns;
2470 ignore_patterns = ignore;
2473 /* Return true if one of the PATTERNS matches FILE. */
2476 patterns_match (struct ignore_pattern const *patterns, char const *file)
2478 struct ignore_pattern const *p;
2479 for (p = patterns; p; p = p->next)
2480 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2485 /* Return true if FILE should be ignored. */
2488 file_ignored (char const *name)
2490 return ((ignore_mode != IGNORE_MINIMAL
2492 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2493 || (ignore_mode == IGNORE_DEFAULT
2494 && patterns_match (hide_patterns, name))
2495 || patterns_match (ignore_patterns, name));
2498 /* POSIX requires that a file size be printed without a sign, even
2499 when negative. Assume the typical case where negative sizes are
2500 actually positive values that have wrapped around. */
2503 unsigned_file_size (off_t size)
2505 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2508 /* Enter and remove entries in the table `cwd_file'. */
2510 /* Empty the table of files. */
2517 for (i = 0; i < cwd_n_used; i++)
2519 struct fileinfo *f = sorted_file[i];
2524 freecon (f->scontext);
2530 any_has_acl = false;
2531 inode_number_width = 0;
2532 block_size_width = 0;
2538 major_device_number_width = 0;
2539 minor_device_number_width = 0;
2540 file_size_width = 0;
2543 /* Add a file to the current table of files.
2544 Verify that the file exists, and print an error message if it does not.
2545 Return the number of blocks that the file occupies. */
2548 gobble_file (char const *name, enum filetype type, ino_t inode,
2549 bool command_line_arg, char const *dirname)
2551 uintmax_t blocks = 0;
2554 /* An inode value prior to gobble_file necessarily came from readdir,
2555 which is not used for command line arguments. */
2556 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2558 if (cwd_n_used == cwd_n_alloc)
2560 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
2564 f = &cwd_file[cwd_n_used];
2565 memset (f, '\0', sizeof *f);
2566 f->stat.st_ino = inode;
2569 if (command_line_arg
2570 || format_needs_stat
2571 /* When coloring a directory (we may know the type from
2572 direct.d_type), we have to stat it in order to indicate
2573 sticky and/or other-writable attributes. */
2574 || (type == directory && print_with_color)
2575 /* When dereferencing symlinks, the inode and type must come from
2576 stat, but readdir provides the inode and type of lstat. */
2577 || ((print_inode || format_needs_type)
2578 && (type == symbolic_link || type == unknown)
2579 && (dereference == DEREF_ALWAYS
2580 || (command_line_arg && dereference != DEREF_NEVER)
2581 || color_symlink_as_referent || check_symlink_color))
2582 /* Command line dereferences are already taken care of by the above
2583 assertion that the inode number is not yet known. */
2584 || (print_inode && inode == NOT_AN_INODE_NUMBER)
2585 || (format_needs_type
2586 && (type == unknown || command_line_arg
2587 /* --indicator-style=classify (aka -F)
2588 requires that we stat each regular file
2589 to see if it's executable. */
2590 || (type == normal && (indicator_style == classify
2591 /* This is so that --color ends up
2592 highlighting files with the executable
2593 bit set even when options like -F are
2595 || (print_with_color
2596 && is_colored (C_EXEC))
2600 /* FIXME-c99: move this decl "down", once ls.c stabilizes. */
2601 bool file_has_security_context = false;
2602 /* Absolute name of this file. */
2603 char *absolute_name;
2607 if (name[0] == '/' || dirname[0] == 0)
2608 absolute_name = (char *) name;
2611 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
2612 attach (absolute_name, dirname, name);
2615 switch (dereference)
2618 err = stat (absolute_name, &f->stat);
2622 case DEREF_COMMAND_LINE_ARGUMENTS:
2623 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
2624 if (command_line_arg)
2627 err = stat (absolute_name, &f->stat);
2630 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
2633 need_lstat = (err < 0
2635 : ! S_ISDIR (f->stat.st_mode));
2639 /* stat failed because of ENOENT, maybe indicating a dangling
2640 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
2641 directory, and --dereference-command-line-symlink-to-dir is
2642 in effect. Fall through so that we call lstat instead. */
2645 default: /* DEREF_NEVER */
2646 err = lstat (absolute_name, &f->stat);
2651 if (err == 0 && print_scontext)
2653 int attr_len = (do_deref
2654 ? getfilecon (absolute_name, &f->scontext)
2655 : lgetfilecon (absolute_name, &f->scontext));
2656 err = (attr_len < 0);
2657 file_has_security_context = (err == 0);
2659 /* When requesting security context information, don't make
2660 ls fail just because the file (even a command line argument)
2661 isn't on the right type of file system. I.e., a getfilecon
2662 failure isn't in the same class as a stat failure. */
2663 if (err && (errno == ENOTSUP || errno == ENODATA))
2669 /* Failure to stat a command line argument leads to
2670 an exit status of 2. For other files, stat failure
2671 provokes an exit status of 1. */
2672 file_failure (command_line_arg,
2673 _("cannot access %s"), absolute_name);
2674 if (command_line_arg)
2677 f->name = xstrdup (name);
2685 if (format == long_format)
2687 int n = file_has_acl (absolute_name, &f->stat);
2688 f->have_acl = (0 < n || file_has_security_context);
2689 any_has_acl |= f->have_acl;
2691 error (0, errno, "%s", quotearg_colon (absolute_name));
2694 if (S_ISLNK (f->stat.st_mode)
2695 && (format == long_format || check_symlink_color))
2698 struct stat linkstats;
2700 get_link_name (absolute_name, f, command_line_arg);
2701 linkname = make_link_name (absolute_name, f->linkname);
2703 /* Avoid following symbolic links when possible, ie, when
2704 they won't be traced and when no indicator is needed. */
2706 && (file_type <= indicator_style || check_symlink_color)
2707 && stat (linkname, &linkstats) == 0)
2711 /* Symbolic links to directories that are mentioned on the
2712 command line are automatically traced if not being
2714 if (!command_line_arg || format == long_format
2715 || !S_ISDIR (linkstats.st_mode))
2717 /* Get the linked-to file's mode for the filetype indicator
2718 in long listings. */
2719 f->linkmode = linkstats.st_mode;
2725 if (S_ISLNK (f->stat.st_mode))
2726 f->filetype = symbolic_link;
2727 else if (S_ISDIR (f->stat.st_mode))
2729 if (command_line_arg & !immediate_dirs)
2730 f->filetype = arg_directory;
2732 f->filetype = directory;
2735 f->filetype = normal;
2737 blocks = ST_NBLOCKS (f->stat);
2738 if (format == long_format || print_block_size)
2740 char buf[LONGEST_HUMAN_READABLE + 1];
2741 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
2742 ST_NBLOCKSIZE, output_block_size),
2744 if (block_size_width < len)
2745 block_size_width = len;
2748 if (format == long_format)
2752 int len = format_user_width (f->stat.st_uid);
2753 if (owner_width < len)
2759 int len = format_group_width (f->stat.st_gid);
2760 if (group_width < len)
2766 int len = format_user_width (f->stat.st_author);
2767 if (author_width < len)
2774 int len = f->scontext ? strlen (f->scontext) : 0;
2775 if (scontext_width < len)
2776 scontext_width = len;
2779 if (format == long_format)
2781 char b[INT_BUFSIZE_BOUND (uintmax_t)];
2782 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
2783 if (nlink_width < b_len)
2784 nlink_width = b_len;
2786 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
2788 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2789 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
2790 if (major_device_number_width < len)
2791 major_device_number_width = len;
2792 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
2793 if (minor_device_number_width < len)
2794 minor_device_number_width = len;
2795 len = major_device_number_width + 2 + minor_device_number_width;
2796 if (file_size_width < len)
2797 file_size_width = len;
2801 char buf[LONGEST_HUMAN_READABLE + 1];
2802 uintmax_t size = unsigned_file_size (f->stat.st_size);
2803 int len = mbswidth (human_readable (size, buf, human_output_opts,
2804 1, file_output_block_size),
2806 if (file_size_width < len)
2807 file_size_width = len;
2814 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2815 int len = strlen (umaxtostr (f->stat.st_ino, buf));
2816 if (inode_number_width < len)
2817 inode_number_width = len;
2820 f->name = xstrdup (name);
2826 /* Return true if F refers to a directory. */
2828 is_directory (const struct fileinfo *f)
2830 return f->filetype == directory || f->filetype == arg_directory;
2833 /* Put the name of the file that FILENAME is a symbolic link to
2834 into the LINKNAME field of `f'. COMMAND_LINE_ARG indicates whether
2835 FILENAME is a command-line argument. */
2838 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
2840 f->linkname = xreadlink_with_size (filename, f->stat.st_size);
2841 if (f->linkname == NULL)
2842 file_failure (command_line_arg, _("cannot read symbolic link %s"),
2846 /* If `linkname' is a relative name and `name' contains one or more
2847 leading directories, return `linkname' with those directories
2848 prepended; otherwise, return a copy of `linkname'.
2849 If `linkname' is zero, return zero. */
2852 make_link_name (char const *name, char const *linkname)
2860 if (*linkname == '/')
2861 return xstrdup (linkname);
2863 /* The link is to a relative name. Prepend any leading directory
2864 in `name' to the link name. */
2865 linkbuf = strrchr (name, '/');
2867 return xstrdup (linkname);
2869 bufsiz = linkbuf - name + 1;
2870 linkbuf = xmalloc (bufsiz + strlen (linkname) + 1);
2871 strncpy (linkbuf, name, bufsiz);
2872 strcpy (linkbuf + bufsiz, linkname);
2876 /* Return true if the last component of NAME is `.' or `..'
2877 This is so we don't try to recurse on `././././. ...' */
2880 basename_is_dot_or_dotdot (const char *name)
2882 char const *base = last_component (name);
2883 return dot_or_dotdot (base);
2886 /* Remove any entries from CWD_FILE that are for directories,
2887 and queue them to be listed as directories instead.
2888 DIRNAME is the prefix to prepend to each dirname
2889 to make it correct relative to ls's working dir;
2890 if it is null, no prefix is needed and "." and ".." should not be ignored.
2891 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
2892 This is desirable when processing directories recursively. */
2895 extract_dirs_from_files (char const *dirname, bool command_line_arg)
2899 bool ignore_dot_and_dot_dot = (dirname != NULL);
2901 if (dirname && LOOP_DETECT)
2903 /* Insert a marker entry first. When we dequeue this marker entry,
2904 we'll know that DIRNAME has been processed and may be removed
2905 from the set of active directories. */
2906 queue_directory (NULL, dirname, false);
2909 /* Queue the directories last one first, because queueing reverses the
2911 for (i = cwd_n_used; i-- != 0; )
2913 struct fileinfo *f = sorted_file[i];
2915 if (is_directory (f)
2916 && (! ignore_dot_and_dot_dot
2917 || ! basename_is_dot_or_dotdot (f->name)))
2919 if (!dirname || f->name[0] == '/')
2920 queue_directory (f->name, f->linkname, command_line_arg);
2923 char *name = file_name_concat (dirname, f->name, NULL);
2924 queue_directory (name, f->linkname, command_line_arg);
2927 if (f->filetype == arg_directory)
2932 /* Now delete the directories from the table, compacting all the remaining
2935 for (i = 0, j = 0; i < cwd_n_used; i++)
2937 struct fileinfo *f = sorted_file[i];
2939 j += (f->filetype != arg_directory);
2944 /* Use strcoll to compare strings in this locale. If an error occurs,
2945 report an error and longjmp to failed_strcoll. */
2947 static jmp_buf failed_strcoll;
2950 xstrcoll (char const *a, char const *b)
2954 diff = strcoll (a, b);
2957 error (0, errno, _("cannot compare file names %s and %s"),
2958 quote_n (0, a), quote_n (1, b));
2959 set_exit_status (false);
2960 longjmp (failed_strcoll, 1);
2965 /* Comparison routines for sorting the files. */
2967 typedef void const *V;
2968 typedef int (*qsortFunc)(V a, V b);
2970 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
2971 The do { ... } while(0) makes it possible to use the macro more like
2972 a statement, without violating C89 rules: */
2973 #define DIRFIRST_CHECK(a, b) \
2976 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
2977 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
2978 if (a_is_dir && !b_is_dir) \
2979 return -1; /* a goes before b */ \
2980 if (!a_is_dir && b_is_dir) \
2981 return 1; /* b goes before a */ \
2985 /* Define the 8 different sort function variants required for each sortkey.
2986 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
2987 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
2988 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
2989 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
2990 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
2991 /* direct, non-dirfirst versions */ \
2992 static int xstrcoll_##key_name (V a, V b) \
2993 { return key_cmp_func (a, b, xstrcoll); } \
2994 static int strcmp_##key_name (V a, V b) \
2995 { return key_cmp_func (a, b, strcmp); } \
2997 /* reverse, non-dirfirst versions */ \
2998 static int rev_xstrcoll_##key_name (V a, V b) \
2999 { return key_cmp_func (b, a, xstrcoll); } \
3000 static int rev_strcmp_##key_name (V a, V b) \
3001 { return key_cmp_func (b, a, strcmp); } \
3003 /* direct, dirfirst versions */ \
3004 static int xstrcoll_df_##key_name (V a, V b) \
3005 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
3006 static int strcmp_df_##key_name (V a, V b) \
3007 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
3009 /* reverse, dirfirst versions */ \
3010 static int rev_xstrcoll_df_##key_name (V a, V b) \
3011 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
3012 static int rev_strcmp_df_##key_name (V a, V b) \
3013 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
3016 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3017 int (*cmp) (char const *, char const *))
3019 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3020 get_stat_ctime (&a->stat));
3021 return diff ? diff : cmp (a->name, b->name);
3025 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3026 int (*cmp) (char const *, char const *))
3028 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3029 get_stat_mtime (&a->stat));
3030 return diff ? diff : cmp (a->name, b->name);
3034 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3035 int (*cmp) (char const *, char const *))
3037 int diff = timespec_cmp (get_stat_atime (&b->stat),
3038 get_stat_atime (&a->stat));
3039 return diff ? diff : cmp (a->name, b->name);
3043 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3044 int (*cmp) (char const *, char const *))
3046 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3047 return diff ? diff : cmp (a->name, b->name);
3051 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3052 int (*cmp) (char const *, char const *))
3054 return cmp (a->name, b->name);
3057 /* Compare file extensions. Files with no extension are `smallest'.
3058 If extensions are the same, compare by filenames instead. */
3061 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3062 int (*cmp) (char const *, char const *))
3064 char const *base1 = strrchr (a->name, '.');
3065 char const *base2 = strrchr (b->name, '.');
3066 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3067 return diff ? diff : cmp (a->name, b->name);
3070 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3071 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3072 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3073 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3074 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3075 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3077 /* Compare file versions.
3078 Unlike all other compare functions above, cmp_version depends only
3079 on strverscmp, which does not fail (even for locale reasons), and does not
3080 need a secondary sort key.
3081 All the other sort options, in fact, need xstrcoll and strcmp variants,
3082 because they all use a string comparison (either as the primary or secondary
3083 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3084 locale reasons. Last, strverscmp is ALWAYS available in coreutils,
3085 thanks to the gnulib library. */
3087 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3089 return strverscmp (a->name, b->name);
3092 static int xstrcoll_version (V a, V b)
3093 { return cmp_version (a, b); }
3094 static int rev_xstrcoll_version (V a, V b)
3095 { return cmp_version (b, a); }
3096 static int xstrcoll_df_version (V a, V b)
3097 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3098 static int rev_xstrcoll_df_version (V a, V b)
3099 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3102 /* We have 2^3 different variants for each sortkey function
3103 (for 3 independent sort modes).
3104 The function pointers stored in this array must be dereferenced as:
3106 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3108 Note that the order in which sortkeys are listed in the function pointer
3109 array below is defined by the order of the elements in the time_type and
3112 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3115 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3116 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3119 { strcmp_##key_name, strcmp_df_##key_name }, \
3120 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3124 static qsortFunc sort_functions[][2][2][2] =
3126 LIST_SORTFUNCTION_VARIANTS (name),
3127 LIST_SORTFUNCTION_VARIANTS (extension),
3128 LIST_SORTFUNCTION_VARIANTS (size),
3132 { xstrcoll_version, xstrcoll_df_version },
3133 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3136 /* We use NULL for the strcmp variants of version comparison
3137 since as explained in cmp_version definition, version comparison
3138 does not rely on xstrcoll, so it will never longjmp, and never
3139 need to try the strcmp fallback. */
3146 /* last are time sort functions */
3147 LIST_SORTFUNCTION_VARIANTS (mtime),
3148 LIST_SORTFUNCTION_VARIANTS (ctime),
3149 LIST_SORTFUNCTION_VARIANTS (atime)
3152 /* The number of sortkeys is calculated as
3153 the number of elements in the sort_type enum (i.e. sort_numtypes) +
3154 the number of elements in the time_type enum (i.e. time_numtypes) - 1
3155 This is because when sort_type==sort_time, we have up to
3156 time_numtypes possible sortkeys.
3158 This line verifies at compile-time that the array of sort functions has been
3159 initialized for all possible sortkeys. */
3160 verify (ARRAY_CARDINALITY (sort_functions)
3161 == sort_numtypes + time_numtypes - 1 );
3163 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
3166 initialize_ordering_vector (void)
3169 for (i = 0; i < cwd_n_used; i++)
3170 sorted_file[i] = &cwd_file[i];
3173 /* Sort the files now in the table. */
3180 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
3183 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
3184 sorted_file_alloc = 3 * cwd_n_used;
3187 initialize_ordering_vector ();
3189 if (sort_type == sort_none)
3192 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3193 ignore strcoll failures, as a failing strcoll might be a
3194 comparison function that is not a total order, and if we ignored
3195 the failure this might cause qsort to dump core. */
3197 if (! setjmp (failed_strcoll))
3198 use_strcmp = false; /* strcoll() succeeded */
3202 assert (sort_type != sort_version);
3203 initialize_ordering_vector ();
3206 /* When sort_type == sort_time, use time_type as subindex. */
3207 mpsort ((void const **) sorted_file, cwd_n_used,
3208 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
3209 [use_strcmp][sort_reverse]
3210 [directories_first]);
3213 /* List all the files now in the table. */
3216 print_current_files (void)
3223 for (i = 0; i < cwd_n_used; i++)
3225 print_file_name_and_frills (sorted_file[i]);
3231 print_many_per_line ();
3235 print_horizontal ();
3239 print_with_commas ();
3243 for (i = 0; i < cwd_n_used; i++)
3245 print_long_format (sorted_file[i]);
3246 DIRED_PUTCHAR ('\n');
3252 /* Return the expected number of columns in a long-format time stamp,
3253 or zero if it cannot be calculated. */
3256 long_time_expected_width (void)
3258 static int width = -1;
3263 struct tm const *tm = localtime (&epoch);
3264 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3266 /* In case you're wondering if localtime can fail with an input time_t
3267 value of 0, let's just say it's very unlikely, but not inconceivable.
3268 The TZ environment variable would have to specify a time zone that
3269 is 2**31-1900 years or more ahead of UTC. This could happen only on
3270 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3271 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3272 their implementations limit the offset to 167:59 and 24:00, resp. */
3276 nstrftime (buf, sizeof buf, long_time_format[0], tm, 0, 0);
3278 width = mbsnwidth (buf, len, 0);
3288 /* Get the current time. */
3291 get_current_time (void)
3293 #if HAVE_CLOCK_GETTIME && defined CLOCK_REALTIME
3295 struct timespec timespec;
3296 if (clock_gettime (CLOCK_REALTIME, ×pec) == 0)
3298 current_time = timespec.tv_sec;
3299 current_time_ns = timespec.tv_nsec;
3305 /* The clock does not have nanosecond resolution, so get the maximum
3306 possible value for the current time that is consistent with the
3307 reported clock. That way, files are not considered to be in the
3308 future merely because their time stamps have higher resolution
3309 than the clock resolution. */
3311 #if HAVE_GETTIMEOFDAY
3313 struct timeval timeval;
3314 gettimeofday (&timeval, NULL);
3315 current_time = timeval.tv_sec;
3316 current_time_ns = timeval.tv_usec * 1000 + 999;
3319 current_time = time (NULL);
3320 current_time_ns = 999999999;
3324 /* Print the user or group name NAME, with numeric id ID, using a
3325 print width of WIDTH columns. */
3328 format_user_or_group (char const *name, unsigned long int id, int width)
3334 int width_gap = width - mbswidth (name, 0);
3335 int pad = MAX (0, width_gap);
3336 fputs (name, stdout);
3337 len = strlen (name) + pad;
3345 printf ("%*lu ", width, id);
3349 dired_pos += len + 1;
3352 /* Print the name or id of the user with id U, using a print width of
3356 format_user (uid_t u, int width, bool stat_ok)
3358 format_user_or_group (! stat_ok ? "?" :
3359 (numeric_ids ? NULL : getuser (u)), u, width);
3362 /* Likewise, for groups. */
3365 format_group (gid_t g, int width, bool stat_ok)
3367 format_user_or_group (! stat_ok ? "?" :
3368 (numeric_ids ? NULL : getgroup (g)), g, width);
3371 /* Return the number of columns that format_user_or_group will print. */
3374 format_user_or_group_width (char const *name, unsigned long int id)
3378 int len = mbswidth (name, 0);
3379 return MAX (0, len);
3383 char buf[INT_BUFSIZE_BOUND (unsigned long int)];
3384 sprintf (buf, "%lu", id);
3385 return strlen (buf);
3389 /* Return the number of columns that format_user will print. */
3392 format_user_width (uid_t u)
3394 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3397 /* Likewise, for groups. */
3400 format_group_width (gid_t g)
3402 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3406 /* Print information about F in long format. */
3409 print_long_format (const struct fileinfo *f)
3413 [LONGEST_HUMAN_READABLE + 1 /* inode */
3414 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3415 + sizeof (modebuf) - 1 + 1 /* mode string */
3416 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3417 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3418 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3419 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3425 struct timespec when_timespec;
3426 struct tm *when_local;
3428 /* Compute the mode string, except remove the trailing space if no
3429 file in this directory has an ACL or SELinux security context. */
3431 filemodestring (&f->stat, modebuf);
3434 modebuf[0] = filetype_letter[f->filetype];
3435 memset (modebuf + 1, '?', 10);
3440 else if (f->have_acl)
3446 when_timespec = get_stat_ctime (&f->stat);
3449 when_timespec = get_stat_mtime (&f->stat);
3452 when_timespec = get_stat_atime (&f->stat);
3458 when = when_timespec.tv_sec;
3459 when_ns = when_timespec.tv_nsec;
3465 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3466 sprintf (p, "%*s ", inode_number_width,
3467 (f->stat.st_ino == NOT_AN_INODE_NUMBER
3469 : umaxtostr (f->stat.st_ino, hbuf)));
3470 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3471 The latter is wrong when inode_number_width is zero. */
3475 if (print_block_size)
3477 char hbuf[LONGEST_HUMAN_READABLE + 1];
3478 char const *blocks =
3481 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3482 ST_NBLOCKSIZE, output_block_size));
3484 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3486 while ((*p++ = *blocks++))
3491 /* The last byte of the mode string is the POSIX
3492 "optional alternate access method flag". */
3494 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3495 sprintf (p, "%s %*s ", modebuf, nlink_width,
3496 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3498 /* Increment by strlen (p) here, rather than by, e.g.,
3499 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3500 The latter is wrong when nlink_width is zero. */
3505 if (print_owner | print_group | print_author | print_scontext)
3507 DIRED_FPUTS (buf, stdout, p - buf);
3510 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3513 format_group (f->stat.st_gid, group_width, f->stat_ok);
3516 format_user (f->stat.st_author, author_width, f->stat_ok);
3519 format_user_or_group ((f->scontext ? f->scontext : "?"),
3526 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3528 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3529 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3530 int blanks_width = (file_size_width
3531 - (major_device_number_width + 2
3532 + minor_device_number_width));
3533 sprintf (p, "%*s, %*s ",
3534 major_device_number_width + MAX (0, blanks_width),
3535 umaxtostr (major (f->stat.st_rdev), majorbuf),
3536 minor_device_number_width,
3537 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3538 p += file_size_width + 1;
3542 char hbuf[LONGEST_HUMAN_READABLE + 1];
3546 : human_readable (unsigned_file_size (f->stat.st_size),
3547 hbuf, human_output_opts, 1, file_output_block_size));
3549 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3551 while ((*p++ = *size++))
3556 when_local = localtime (&when_timespec.tv_sec);
3560 if (f->stat_ok && when_local)
3562 time_t six_months_ago;
3566 /* If the file appears to be in the future, update the current
3567 time, in case the file happens to have been modified since
3568 the last time we checked the clock. */
3569 if (current_time < when
3570 || (current_time == when && current_time_ns < when_ns))
3572 /* Note that get_current_time calls gettimeofday which, on some non-
3573 compliant systems, clobbers the buffer used for localtime's result.
3574 But it's ok here, because we use a gettimeofday wrapper that
3575 saves and restores the buffer around the gettimeofday call. */
3576 get_current_time ();
3579 /* Consider a time to be recent if it is within the past six
3580 months. A Gregorian year has 365.2425 * 24 * 60 * 60 ==
3581 31556952 seconds on the average. Write this value as an
3582 integer constant to avoid floating point hassles. */
3583 six_months_ago = current_time - 31556952 / 2;
3584 recent = (six_months_ago <= when
3585 && (when < current_time
3586 || (when == current_time && when_ns <= current_time_ns)));
3587 fmt = long_time_format[recent];
3589 s = nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
3590 when_local, 0, when_ns);
3598 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
3603 /* The time cannot be converted using the desired format, so
3604 print it as a huge integer number of seconds. */
3605 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
3606 sprintf (p, "%*s ", long_time_expected_width (),
3609 : (TYPE_SIGNED (time_t)
3610 ? imaxtostr (when, hbuf)
3611 : umaxtostr (when, hbuf))));
3615 DIRED_FPUTS (buf, stdout, p - buf);
3616 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3617 f->stat_ok, f->filetype, &dired_obstack);
3619 if (f->filetype == symbolic_link)
3623 DIRED_FPUTS_LITERAL (" -> ", stdout);
3624 print_name_with_quoting (f->linkname, f->linkmode, f->linkok - 1,
3625 f->stat_ok, f->filetype, NULL);
3626 if (indicator_style != none)
3627 print_type_indicator (true, f->linkmode, unknown);
3630 else if (indicator_style != none)
3631 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3634 /* Output to OUT a quoted representation of the file name NAME,
3635 using OPTIONS to control quoting. Produce no output if OUT is NULL.
3636 Store the number of screen columns occupied by NAME's quoted
3637 representation into WIDTH, if non-NULL. Return the number of bytes
3641 quote_name (FILE *out, const char *name, struct quoting_options const *options,
3644 char smallbuf[BUFSIZ];
3645 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
3647 size_t displayed_width IF_LINT (= 0);
3649 if (len < sizeof smallbuf)
3653 buf = alloca (len + 1);
3654 quotearg_buffer (buf, len + 1, name, -1, options);
3657 if (qmark_funny_chars)
3662 char const *p = buf;
3663 char const *plimit = buf + len;
3665 displayed_width = 0;
3670 case ' ': case '!': case '"': case '#': case '%':
3671 case '&': case '\'': case '(': case ')': case '*':
3672 case '+': case ',': case '-': case '.': case '/':
3673 case '0': case '1': case '2': case '3': case '4':
3674 case '5': case '6': case '7': case '8': case '9':
3675 case ':': case ';': case '<': case '=': case '>':
3677 case 'A': case 'B': case 'C': case 'D': case 'E':
3678 case 'F': case 'G': case 'H': case 'I': case 'J':
3679 case 'K': case 'L': case 'M': case 'N': case 'O':
3680 case 'P': case 'Q': case 'R': case 'S': case 'T':
3681 case 'U': case 'V': case 'W': case 'X': case 'Y':
3683 case '[': case '\\': case ']': case '^': case '_':
3684 case 'a': case 'b': case 'c': case 'd': case 'e':
3685 case 'f': case 'g': case 'h': case 'i': case 'j':
3686 case 'k': case 'l': case 'm': case 'n': case 'o':
3687 case 'p': case 'q': case 'r': case 's': case 't':
3688 case 'u': case 'v': case 'w': case 'x': case 'y':
3689 case 'z': case '{': case '|': case '}': case '~':
3690 /* These characters are printable ASCII characters. */
3692 displayed_width += 1;
3695 /* If we have a multibyte sequence, copy it until we
3696 reach its end, replacing each non-printable multibyte
3697 character with a single question mark. */
3699 mbstate_t mbstate = { 0, };
3706 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
3708 if (bytes == (size_t) -1)
3710 /* An invalid multibyte sequence was
3711 encountered. Skip one input byte, and
3712 put a question mark. */
3715 displayed_width += 1;
3719 if (bytes == (size_t) -2)
3721 /* An incomplete multibyte character
3722 at the end. Replace it entirely with
3726 displayed_width += 1;
3731 /* A null wide character was encountered. */
3737 /* A printable multibyte character.
3739 for (; bytes > 0; --bytes)
3741 displayed_width += w;
3745 /* An unprintable multibyte character.
3746 Replace it entirely with a question
3750 displayed_width += 1;
3753 while (! mbsinit (&mbstate));
3758 /* The buffer may have shrunk. */
3765 char const *plimit = buf + len;
3769 if (! isprint (to_uchar (*p)))
3773 displayed_width = len;
3776 else if (width != NULL)
3780 displayed_width = mbsnwidth (buf, len, 0);
3784 char const *p = buf;
3785 char const *plimit = buf + len;
3787 displayed_width = 0;
3790 if (isprint (to_uchar (*p)))
3798 fwrite (buf, 1, len, out);
3800 *width = displayed_width;
3805 print_name_with_quoting (const char *p, mode_t mode, int linkok,
3806 bool stat_ok, enum filetype type,
3807 struct obstack *stack)
3809 if (print_with_color)
3810 print_color_indicator (p, mode, linkok, stat_ok, type);
3813 PUSH_CURRENT_DIRED_POS (stack);
3815 dired_pos += quote_name (stdout, p, filename_quoting_options, NULL);
3818 PUSH_CURRENT_DIRED_POS (stack);
3820 if (print_with_color)
3823 prep_non_filename_text ();
3828 prep_non_filename_text (void)
3830 if (color_indicator[C_END].string != NULL)
3831 put_indicator (&color_indicator[C_END]);
3834 put_indicator (&color_indicator[C_LEFT]);
3835 put_indicator (&color_indicator[C_NORM]);
3836 put_indicator (&color_indicator[C_RIGHT]);
3840 /* Print the file name of `f' with appropriate quoting.
3841 Also print file size, inode number, and filetype indicator character,
3842 as requested by switches. */
3845 print_file_name_and_frills (const struct fileinfo *f)
3847 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
3850 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
3851 umaxtostr (f->stat.st_ino, buf));
3853 if (print_block_size)
3854 printf ("%*s ", format == with_commas ? 0 : block_size_width,
3855 human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
3856 ST_NBLOCKSIZE, output_block_size));
3859 printf ("%*s ", format == with_commas ? 0 : scontext_width,
3860 (f->scontext ? f->scontext : "?"));
3862 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3863 f->stat_ok, f->filetype, NULL);
3865 if (indicator_style != none)
3866 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3869 /* Given these arguments describing a file, return the single-byte
3870 type indicator, or 0. */
3872 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3876 if (stat_ok ? S_ISREG (mode) : type == normal)
3878 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
3885 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
3887 else if (indicator_style == slash)
3889 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
3891 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
3893 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
3895 else if (stat_ok && S_ISDOOR (mode))
3904 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3906 char c = get_type_indicator (stat_ok, mode, type);
3912 print_color_indicator (const char *name, mode_t mode, int linkok,
3913 bool stat_ok, enum filetype filetype)
3916 struct color_ext_type *ext; /* Color extension */
3917 size_t len; /* Length of name */
3919 /* Is this a nonexistent file? If so, linkok == -1. */
3921 if (linkok == -1 && color_indicator[C_MISSING].string != NULL)
3925 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
3926 type = filetype_indicator[filetype];
3933 if ((mode & S_ISUID) != 0)
3935 else if ((mode & S_ISGID) != 0)
3937 else if ((mode & S_IXUGO) != 0)
3940 else if (S_ISDIR (mode))
3942 if ((mode & S_ISVTX) && (mode & S_IWOTH))
3943 type = C_STICKY_OTHER_WRITABLE;
3944 else if ((mode & S_IWOTH) != 0)
3945 type = C_OTHER_WRITABLE;
3946 else if ((mode & S_ISVTX) != 0)
3951 else if (S_ISLNK (mode))
3952 type = ((!linkok && color_indicator[C_ORPHAN].string)
3953 ? C_ORPHAN : C_LINK);
3954 else if (S_ISFIFO (mode))
3956 else if (S_ISSOCK (mode))
3958 else if (S_ISBLK (mode))
3960 else if (S_ISCHR (mode))
3962 else if (S_ISDOOR (mode))
3966 /* Classify a file of some other type as C_ORPHAN. */
3971 /* Check the file's suffix only if still classified as C_FILE. */
3975 /* Test if NAME has a recognized suffix. */
3977 len = strlen (name);
3978 name += len; /* Pointer to final \0. */
3979 for (ext = color_ext_list; ext != NULL; ext = ext->next)
3981 if (ext->ext.len <= len
3982 && strncmp (name - ext->ext.len, ext->ext.string,
3988 put_indicator (&color_indicator[C_LEFT]);
3989 put_indicator (ext ? &(ext->seq) : &color_indicator[type]);
3990 put_indicator (&color_indicator[C_RIGHT]);
3993 /* Output a color indicator (which may contain nulls). */
3995 put_indicator (const struct bin_str *ind)
4002 for (i = ind->len; i != 0; --i)
4007 length_of_file_name_and_frills (const struct fileinfo *f)
4011 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4014 len += 1 + (format == with_commas
4015 ? strlen (umaxtostr (f->stat.st_ino, buf))
4016 : inode_number_width);
4018 if (print_block_size)
4019 len += 1 + (format == with_commas
4020 ? strlen (human_readable (ST_NBLOCKS (f->stat), buf,
4021 human_output_opts, ST_NBLOCKSIZE,
4023 : block_size_width);
4026 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
4028 quote_name (NULL, f->name, filename_quoting_options, &name_width);
4031 if (indicator_style != none)
4033 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4041 print_many_per_line (void)
4043 size_t row; /* Current row. */
4044 size_t cols = calculate_columns (true);
4045 struct column_info const *line_fmt = &column_info[cols - 1];
4047 /* Calculate the number of rows that will be in each column except possibly
4048 for a short column on the right. */
4049 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
4051 for (row = 0; row < rows; row++)
4054 size_t filesno = row;
4057 /* Print the next row. */
4060 struct fileinfo const *f = sorted_file[filesno];
4061 size_t name_length = length_of_file_name_and_frills (f);
4062 size_t max_name_length = line_fmt->col_arr[col++];
4063 print_file_name_and_frills (f);
4066 if (filesno >= cwd_n_used)
4069 indent (pos + name_length, pos + max_name_length);
4070 pos += max_name_length;
4077 print_horizontal (void)
4081 size_t cols = calculate_columns (false);
4082 struct column_info const *line_fmt = &column_info[cols - 1];
4083 struct fileinfo const *f = sorted_file[0];
4084 size_t name_length = length_of_file_name_and_frills (f);
4085 size_t max_name_length = line_fmt->col_arr[0];
4087 /* Print first entry. */
4088 print_file_name_and_frills (f);
4091 for (filesno = 1; filesno < cwd_n_used; ++filesno)
4093 size_t col = filesno % cols;
4102 indent (pos + name_length, pos + max_name_length);
4103 pos += max_name_length;
4106 f = sorted_file[filesno];
4107 print_file_name_and_frills (f);
4109 name_length = length_of_file_name_and_frills (f);
4110 max_name_length = line_fmt->col_arr[col];
4116 print_with_commas (void)
4121 for (filesno = 0; filesno < cwd_n_used; filesno++)
4123 struct fileinfo const *f = sorted_file[filesno];
4124 size_t len = length_of_file_name_and_frills (f);
4130 if (pos + len + 2 < line_length)
4142 putchar (separator);
4145 print_file_name_and_frills (f);
4151 /* Assuming cursor is at position FROM, indent up to position TO.
4152 Use a TAB character instead of two or more spaces whenever possible. */
4155 indent (size_t from, size_t to)
4159 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4162 from += tabsize - from % tabsize;
4172 /* Put DIRNAME/NAME into DEST, handling `.' and `/' properly. */
4173 /* FIXME: maybe remove this function someday. See about using a
4174 non-malloc'ing version of file_name_concat. */
4177 attach (char *dest, const char *dirname, const char *name)
4179 const char *dirnamep = dirname;
4181 /* Copy dirname if it is not ".". */
4182 if (dirname[0] != '.' || dirname[1] != 0)
4185 *dest++ = *dirnamep++;
4186 /* Add '/' if `dirname' doesn't already end with it. */
4187 if (dirnamep > dirname && dirnamep[-1] != '/')
4195 /* Allocate enough column info suitable for the current number of
4196 files and display columns, and initialize the info to represent the
4197 narrowest possible columns. */
4200 init_column_info (void)
4203 size_t max_cols = MIN (max_idx, cwd_n_used);
4205 /* Currently allocated columns in column_info. */
4206 static size_t column_info_alloc;
4208 if (column_info_alloc < max_cols)
4210 size_t new_column_info_alloc;
4213 if (max_cols < max_idx / 2)
4215 /* The number of columns is far less than the display width
4216 allows. Grow the allocation, but only so that it's
4217 double the current requirements. If the display is
4218 extremely wide, this avoids allocating a lot of memory
4219 that is never needed. */
4220 column_info = xnrealloc (column_info, max_cols,
4221 2 * sizeof *column_info);
4222 new_column_info_alloc = 2 * max_cols;
4226 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4227 new_column_info_alloc = max_idx;
4230 /* Allocate the new size_t objects by computing the triangle
4231 formula n * (n + 1) / 2, except that we don't need to
4232 allocate the part of the triangle that we've already
4233 allocated. Check for address arithmetic overflow. */
4235 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4236 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4237 size_t t = s * column_info_growth;
4238 if (s < new_column_info_alloc || t / column_info_growth != s)
4240 p = xnmalloc (t / 2, sizeof *p);
4243 /* Grow the triangle by parceling out the cells just allocated. */
4244 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4246 column_info[i].col_arr = p;
4250 column_info_alloc = new_column_info_alloc;
4253 for (i = 0; i < max_cols; ++i)
4257 column_info[i].valid_len = true;
4258 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4259 for (j = 0; j <= i; ++j)
4260 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4264 /* Calculate the number of columns needed to represent the current set
4265 of files in the current display width. */
4268 calculate_columns (bool by_columns)
4270 size_t filesno; /* Index into cwd_file. */
4271 size_t cols; /* Number of files across. */
4273 /* Normally the maximum number of columns is determined by the
4274 screen width. But if few files are available this might limit it
4276 size_t max_cols = MIN (max_idx, cwd_n_used);
4278 init_column_info ();
4280 /* Compute the maximum number of possible columns. */
4281 for (filesno = 0; filesno < cwd_n_used; ++filesno)
4283 struct fileinfo const *f = sorted_file[filesno];
4284 size_t name_length = length_of_file_name_and_frills (f);
4287 for (i = 0; i < max_cols; ++i)
4289 if (column_info[i].valid_len)
4291 size_t idx = (by_columns
4292 ? filesno / ((cwd_n_used + i) / (i + 1))
4293 : filesno % (i + 1));
4294 size_t real_length = name_length + (idx == i ? 0 : 2);
4296 if (column_info[i].col_arr[idx] < real_length)
4298 column_info[i].line_len += (real_length
4299 - column_info[i].col_arr[idx]);
4300 column_info[i].col_arr[idx] = real_length;
4301 column_info[i].valid_len = (column_info[i].line_len
4308 /* Find maximum allowed columns. */
4309 for (cols = max_cols; 1 < cols; --cols)
4311 if (column_info[cols - 1].valid_len)
4321 if (status != EXIT_SUCCESS)
4322 fprintf (stderr, _("Try `%s --help' for more information.\n"),
4326 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4328 List information about the FILEs (the current directory by default).\n\
4329 Sort entries alphabetically if none of -cftuvSUX nor --sort.\n\
4333 Mandatory arguments to long options are mandatory for short options too.\n\
4336 -a, --all do not ignore entries starting with .\n\
4337 -A, --almost-all do not list implied . and ..\n\
4338 --author with -l, print the author of each file\n\
4339 -b, --escape print octal escapes for nongraphic characters\n\
4342 --block-size=SIZE use SIZE-byte blocks\n\
4343 -B, --ignore-backups do not list implied entries ending with ~\n\
4344 -c with -lt: sort by, and show, ctime (time of last\n\
4345 modification of file status information)\n\
4346 with -l: show ctime and sort by name\n\
4347 otherwise: sort by ctime\n\
4350 -C list entries by columns\n\
4351 --color[=WHEN] control whether color is used to distinguish file\n\
4352 types. WHEN may be `never', `always', or `auto'\n\
4353 -d, --directory list directory entries instead of contents,\n\
4354 and do not dereference symbolic links\n\
4355 -D, --dired generate output designed for Emacs' dired mode\n\
4358 -f do not sort, enable -aU, disable -ls --color\n\
4359 -F, --classify append indicator (one of */=>@|) to entries\n\
4360 --file-type likewise, except do not append `*'\n\
4361 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4362 single-column -1, verbose -l, vertical -C\n\
4363 --full-time like -l --time-style=full-iso\n\
4366 -g like -l, but do not list owner\n\
4369 --group-directories-first\n\
4370 group directories before files\n\
4373 -G, --no-group in a long listing, don't print group names\n\
4374 -h, --human-readable with -l, print sizes in human readable format\n\
4375 (e.g., 1K 234M 2G)\n\
4376 --si likewise, but use powers of 1000 not 1024\n\
4379 -H, --dereference-command-line\n\
4380 follow symbolic links listed on the command line\n\
4381 --dereference-command-line-symlink-to-dir\n\
4382 follow each command line symbolic link\n\
4383 that points to a directory\n\
4384 --hide=PATTERN do not list implied entries matching shell PATTERN\n\
4385 (overridden by -a or -A)\n\
4388 --indicator-style=WORD append indicator with style WORD to entry names:\n\
4389 none (default), slash (-p),\n\
4390 file-type (--file-type), classify (-F)\n\
4391 -i, --inode print the index number of each file\n\
4392 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\n\
4393 -k like --block-size=1K\n\
4396 -l use a long listing format\n\
4397 -L, --dereference when showing file information for a symbolic\n\
4398 link, show information for the file the link\n\
4399 references rather than for the link itself\n\
4400 -m fill width with a comma separated list of entries\n\
4403 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4404 -N, --literal print raw entry names (don't treat e.g. control\n\
4405 characters specially)\n\
4406 -o like -l, but do not list group information\n\
4407 -p, --indicator-style=slash\n\
4408 append / indicator to directories\n\
4411 -q, --hide-control-chars print ? instead of non graphic characters\n\
4412 --show-control-chars show non graphic characters as-is (default\n\
4413 unless program is `ls' and output is a terminal)\n\
4414 -Q, --quote-name enclose entry names in double quotes\n\
4415 --quoting-style=WORD use quoting style WORD for entry names:\n\
4416 literal, locale, shell, shell-always, c, escape\n\
4419 -r, --reverse reverse order while sorting\n\
4420 -R, --recursive list subdirectories recursively\n\
4421 -s, --size print the size of each file, in blocks\n\
4424 -S sort by file size\n\
4425 --sort=WORD sort by WORD instead of name: none -U,\n\
4426 extension -X, size -S, time -t, version -v\n\
4427 --time=WORD with -l, show time as WORD instead of modification\n\
4428 time: atime -u, access -u, use -u, ctime -c,\n\
4429 or status -c; use specified time as sort key\n\
4433 --time-style=STYLE with -l, show times using style STYLE:\n\
4434 full-iso, long-iso, iso, locale, +FORMAT.\n\
4435 FORMAT is interpreted like `date'; if FORMAT is\n\
4436 FORMAT1<newline>FORMAT2, FORMAT1 applies to\n\
4437 non-recent files and FORMAT2 to recent files;\n\
4438 if STYLE is prefixed with `posix-', STYLE\n\
4439 takes effect only outside the POSIX locale\n\
4442 -t sort by modification time\n\
4443 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4446 -u with -lt: sort by, and show, access time\n\
4447 with -l: show access time and sort by name\n\
4448 otherwise: sort by access time\n\
4449 -U do not sort; list entries in directory order\n\
4450 -v sort by version\n\
4453 -w, --width=COLS assume screen width instead of current value\n\
4454 -x list entries by lines instead of by columns\n\
4455 -X sort alphabetically by entry extension\n\
4456 -Z, --context print any SELinux security context of each file\n\
4457 -1 list one file per line\n\
4459 fputs (HELP_OPTION_DESCRIPTION, stdout);
4460 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4462 SIZE may be (or may be an integer optionally followed by) one of following:\n\
4463 kB 1000, K 1024, MB 1000*1000, M 1024*1024, and so on for G, T, P, E, Z, Y.\n\
4467 By default, color is not used to distinguish types of files. That is\n\
4468 equivalent to using --color=none. Using the --color option without the\n\
4469 optional WHEN argument is equivalent to using --color=always. With\n\
4470 --color=auto, color codes are output only if standard output is connected\n\
4471 to a terminal (tty). The environment variable LS_COLORS can influence the\n\
4472 colors, and can be set easily by the dircolors command.\n\
4476 Exit status is 0 if OK, 1 if minor problems, 2 if serious trouble.\n\
4478 emit_bug_reporting_address ();