1 /* `dir', `vdir' and `ls' directory listing programs for GNU.
2 Copyright (C) 85, 88, 90, 91, 1995-2006 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>
65 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
68 # define SA_NOCLDSTOP 0
69 # define sigprocmask(How, Set, Oset) /* empty */
71 # if ! HAVE_SIGINTERRUPT
72 # define siginterrupt(sig, flag) /* empty */
76 /* Get mbstate_t, mbrtowc(), mbsinit(), wcwidth(). */
85 #if !defined iswprint && !HAVE_ISWPRINT
86 # define iswprint(wc) 1
89 #ifndef HAVE_DECL_WCWIDTH
90 "this configure-time declaration test was not run"
92 #if !HAVE_DECL_WCWIDTH
96 /* If wcwidth() doesn't exist, assume all printable characters have
100 # define wcwidth(wc) ((wc) == 0 ? 0 : iswprint (wc) ? 1 : -1)
108 #include "argmatch.h"
113 #include "filenamecat.h"
114 #include "hard-locale.h"
117 #include "filemode.h"
118 #include "inttostr.h"
121 #include "mbswidth.h"
124 #include "quotearg.h"
126 #include "stat-time.h"
127 #include "strftime.h"
128 #include "strverscmp.h"
130 #include "xreadlink.h"
132 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
133 : (ls_mode == LS_MULTI_COL \
136 #define AUTHORS "Richard Stallman", "David MacKenzie"
138 #define obstack_chunk_alloc malloc
139 #define obstack_chunk_free free
141 /* Return an int indicating the result of comparing two integers.
142 Subtracting doesn't always work, due to overflow. */
143 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
145 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
146 # define st_author st_uid
163 /* Display letters and indicators for each filetype.
164 Keep these in sync with enum filetype. */
165 static char const filetype_letter[] = "?pcdb-lswd";
167 /* Ensure that filetype and filetype_letter have the same
168 number of elements. */
169 verify (sizeof filetype_letter - 1 == arg_directory + 1);
171 #define FILETYPE_INDICATORS \
173 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
174 C_LINK, C_SOCK, C_FILE, C_DIR \
186 /* For symbolic link, name of the file linked to, otherwise zero. */
189 /* For symbolic link and long listing, st_mode of file linked to, otherwise
193 /* For symbolic link and color printing, true if linked-to file
194 exists, otherwise false. */
197 enum filetype filetype;
200 /* For long listings, true if the file has an access control list. */
206 # define FILE_HAS_ACL(F) ((F)->have_acl)
208 # define FILE_HAS_ACL(F) 0
211 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
213 /* Null is a valid character in a color indicator (think about Epson
214 printers, for example) so we have to use a length/buffer string
219 size_t len; /* Number of bytes */
220 const char *string; /* Pointer to the same */
227 # define tcgetpgrp(Fd) 0
230 static size_t quote_name (FILE *out, const char *name,
231 struct quoting_options const *options,
233 static char *make_link_name (char const *name, char const *linkname);
234 static int decode_switches (int argc, char **argv);
235 static bool file_ignored (char const *name);
236 static uintmax_t gobble_file (char const *name, enum filetype type,
237 ino_t inode, bool command_line_arg,
238 char const *dirname);
239 static void print_color_indicator (const char *name, mode_t mode, int linkok,
240 bool stat_ok, enum filetype type);
241 static void put_indicator (const struct bin_str *ind);
242 static void add_ignore_pattern (const char *pattern);
243 static void attach (char *dest, const char *dirname, const char *name);
244 static void clear_files (void);
245 static void extract_dirs_from_files (char const *dirname,
246 bool command_line_arg);
247 static void get_link_name (char const *filename, struct fileinfo *f,
248 bool command_line_arg);
249 static void indent (size_t from, size_t to);
250 static size_t calculate_columns (bool by_columns);
251 static void print_current_files (void);
252 static void print_dir (char const *name, char const *realname,
253 bool command_line_arg);
254 static void print_file_name_and_frills (const struct fileinfo *f);
255 static void print_horizontal (void);
256 static int format_user_width (uid_t u);
257 static int format_group_width (gid_t g);
258 static void print_long_format (const struct fileinfo *f);
259 static void print_many_per_line (void);
260 static void print_name_with_quoting (const char *p, mode_t mode,
261 int linkok, bool stat_ok,
263 struct obstack *stack);
264 static void prep_non_filename_text (void);
265 static void print_type_indicator (bool stat_ok, mode_t mode,
267 static void print_with_commas (void);
268 static void queue_directory (char const *name, char const *realname,
269 bool command_line_arg);
270 static void sort_files (void);
271 static void parse_ls_color (void);
272 void usage (int status);
274 /* The name this program was run with. */
277 /* Initial size of hash table.
278 Most hierarchies are likely to be shallower than this. */
279 #define INITIAL_TABLE_SIZE 30
281 /* The set of `active' directories, from the current command-line argument
282 to the level in the hierarchy at which files are being listed.
283 A directory is represented by its device and inode numbers (struct dev_ino).
284 A directory is added to this set when ls begins listing it or its
285 entries, and it is removed from the set just after ls has finished
286 processing it. This set is used solely to detect loops, e.g., with
287 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
288 static Hash_table *active_dir_set;
290 #define LOOP_DETECT (!!active_dir_set)
292 /* The table of files in the current directory:
294 `files' points to a vector of `struct fileinfo', one per file.
295 `nfiles' is the number of elements space has been allocated for.
296 `files_index' is the number actually in use. */
298 /* Address of block containing the files that are described. */
299 static struct fileinfo *files; /* FIXME: rename this to e.g. cwd_file */
301 /* Length of block that `files' points to, measured in files. */
302 static size_t nfiles; /* FIXME: rename this to e.g. cwd_n_alloc */
304 /* Index of first unused in `files'. */
305 static size_t files_index; /* FIXME: rename this to e.g. cwd_n_used */
307 /* When true, in a color listing, color each symlink name according to the
308 type of file it points to. Otherwise, color them according to the `ln'
309 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
310 regardless. This is set when `ln=target' appears in LS_COLORS. */
312 static bool color_symlink_as_referent;
314 /* mode of appropriate file for colorization */
315 #define FILE_OR_LINK_MODE(File) \
316 ((color_symlink_as_referent & (File)->linkok) \
317 ? (File)->linkmode : (File)->stat.st_mode)
320 /* Record of one pending directory waiting to be listed. */
325 /* If the directory is actually the file pointed to by a symbolic link we
326 were told to list, `realname' will contain the name of the symbolic
327 link, otherwise zero. */
329 bool command_line_arg;
330 struct pending *next;
333 static struct pending *pending_dirs;
335 /* Current time in seconds and nanoseconds since 1970, updated as
336 needed when deciding whether a file is recent. */
338 static time_t current_time = TYPE_MINIMUM (time_t);
339 static int current_time_ns = -1;
341 /* Whether any of the files has an ACL. This affects the width of the
345 static bool any_has_acl;
347 enum { any_has_acl = false };
350 /* The number of columns to use for columns containing inode numbers,
351 block sizes, link counts, owners, groups, authors, major device
352 numbers, minor device numbers, and file sizes, respectively. */
354 static int inode_number_width;
355 static int block_size_width;
356 static int nlink_width;
357 static int owner_width;
358 static int group_width;
359 static int author_width;
360 static int major_device_number_width;
361 static int minor_device_number_width;
362 static int file_size_width;
366 /* long_format for lots of info, one per line.
367 one_per_line for just names, one per line.
368 many_per_line for just names, many per line, sorted vertically.
369 horizontal for just names, many per line, sorted horizontally.
370 with_commas for just names, many per line, separated by commas.
372 -l (and other options that imply -l), -1, -C, -x and -m control
377 long_format, /* -l and other options that imply -l */
378 one_per_line, /* -1 */
379 many_per_line, /* -C */
384 static enum format format;
386 /* `full-iso' uses full ISO-style dates and times. `long-iso' uses longer
387 ISO-style time stamps, though shorter than `full-iso'. `iso' uses shorter
388 ISO-style time stamps. `locale' uses locale-dependent time stamps. */
391 full_iso_time_style, /* --time-style=full-iso */
392 long_iso_time_style, /* --time-style=long-iso */
393 iso_time_style, /* --time-style=iso */
394 locale_time_style /* --time-style=locale */
397 static char const *const time_style_args[] =
399 "full-iso", "long-iso", "iso", "locale", NULL
401 static enum time_style const time_style_types[] =
403 full_iso_time_style, long_iso_time_style, iso_time_style,
406 ARGMATCH_VERIFY (time_style_args, time_style_types);
408 /* Type of time to print or sort by. Controlled by -c and -u.
409 The values of each item of this enum are important since they are
410 used as indices in the sort functions array (see sort_files()). */
414 time_mtime, /* default */
417 time_numtypes /* the number of elements of this enum */
420 static enum time_type time_type;
422 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
423 The values of each item of this enum are important since they are
424 used as indices in the sort functions array (see sort_files()). */
428 sort_none = -1, /* -U */
429 sort_name, /* default */
430 sort_extension, /* -X */
432 sort_version, /* -v */
434 sort_numtypes /* the number of elements of this enum */
437 static enum sort_type sort_type;
439 /* Direction of sort.
440 false means highest first if numeric,
441 lowest first if alphabetic;
442 these are the defaults.
443 true means the opposite order in each case. -r */
445 static bool sort_reverse;
447 /* True means to display owner information. -g turns this off. */
449 static bool print_owner = true;
451 /* True means to display author information. */
453 static bool print_author;
455 /* True means to display group information. -G and -o turn this off. */
457 static bool print_group = true;
459 /* True means print the user and group id's as numbers rather
462 static bool numeric_ids;
464 /* True means mention the size in blocks of each file. -s */
466 static bool print_block_size;
468 /* Human-readable options for output. */
469 static int human_output_opts;
471 /* The units to use when printing sizes other than file sizes. */
472 static uintmax_t output_block_size;
474 /* Likewise, but for file sizes. */
475 static uintmax_t file_output_block_size = 1;
477 /* Follow the output with a special string. Using this format,
478 Emacs' dired mode starts up twice as fast, and can handle all
479 strange characters in file names. */
482 /* `none' means don't mention the type of files.
483 `slash' means mention directories only, with a '/'.
484 `file_type' means mention file types.
485 `classify' means mention file types and mark executables.
487 Controlled by -F, -p, and --indicator-style. */
491 none, /* --indicator-style=none */
492 slash, /* -p, --indicator-style=slash */
493 file_type, /* --indicator-style=file-type */
494 classify /* -F, --indicator-style=classify */
497 static enum indicator_style indicator_style;
499 /* Names of indicator styles. */
500 static char const *const indicator_style_args[] =
502 "none", "slash", "file-type", "classify", NULL
504 static enum indicator_style const indicator_style_types[] =
506 none, slash, file_type, classify
508 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
510 /* True means use colors to mark types. Also define the different
511 colors as well as the stuff for the LS_COLORS environment variable.
512 The LS_COLORS variable is now in a termcap-like format. */
514 static bool print_with_color;
518 color_never, /* 0: default or --color=never */
519 color_always, /* 1: --color=always */
520 color_if_tty /* 2: --color=tty */
523 enum Dereference_symlink
527 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
528 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
529 DEREF_ALWAYS /* -L */
534 C_LEFT, C_RIGHT, C_END, C_NORM, C_FILE, C_DIR, C_LINK, C_FIFO, C_SOCK,
535 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
536 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE
539 static const char *const indicator_name[]=
541 "lc", "rc", "ec", "no", "fi", "di", "ln", "pi", "so",
542 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
546 struct color_ext_type
548 struct bin_str ext; /* The extension we're looking for */
549 struct bin_str seq; /* The sequence to output when we do */
550 struct color_ext_type *next; /* Next in list */
553 static struct bin_str color_indicator[] =
555 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
556 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
557 { 0, NULL }, /* ec: End color (replaces lc+no+rc) */
558 { LEN_STR_PAIR ("0") }, /* no: Normal */
559 { LEN_STR_PAIR ("0") }, /* fi: File: default */
560 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
561 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
562 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
563 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
564 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
565 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
566 { 0, NULL }, /* mi: Missing file: undefined */
567 { 0, NULL }, /* or: Orphaned symlink: undefined */
568 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
569 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
570 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
571 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
572 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
573 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
574 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
578 static struct color_ext_type *color_ext_list = NULL;
580 /* Buffer for color sequences */
581 static char *color_buf;
583 /* True means to check for orphaned symbolic link, for displaying
586 static bool check_symlink_color;
588 /* True means mention the inode number of each file. -i */
590 static bool print_inode;
592 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
593 other options that imply -l), and -L. */
595 static enum Dereference_symlink dereference;
597 /* True means when a directory is found, display info on its
600 static bool recursive;
602 /* True means when an argument is a directory name, display info
605 static bool immediate_dirs;
607 /* True means that directories are grouped before files. */
609 static bool directories_first;
611 /* Which files to ignore. */
615 /* Ignore files whose names start with `.', and files specified by
616 --hide and --ignore. */
619 /* Ignore `.', `..', and files specified by --ignore. */
620 IGNORE_DOT_AND_DOTDOT,
622 /* Ignore only files specified by --ignore. */
626 /* A linked list of shell-style globbing patterns. If a non-argument
627 file name matches any of these patterns, it is ignored.
628 Controlled by -I. Multiple -I options accumulate.
629 The -B option adds `*~' and `.*~' to this list. */
631 struct ignore_pattern
634 struct ignore_pattern *next;
637 static struct ignore_pattern *ignore_patterns;
639 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
640 variable itself to be ignored. */
641 static struct ignore_pattern *hide_patterns;
643 /* True means output nongraphic chars in file names as `?'.
644 (-q, --hide-control-chars)
645 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
646 independent. The algorithm is: first, obey the quoting style to get a
647 string representing the file name; then, if qmark_funny_chars is set,
648 replace all nonprintable chars in that string with `?'. It's necessary
649 to replace nonprintable chars even in quoted strings, because we don't
650 want to mess up the terminal if control chars get sent to it, and some
651 quoting methods pass through control chars as-is. */
652 static bool qmark_funny_chars;
654 /* Quoting options for file and dir name output. */
656 static struct quoting_options *filename_quoting_options;
657 static struct quoting_options *dirname_quoting_options;
659 /* The number of chars per hardware tab stop. Setting this to zero
660 inhibits the use of TAB characters for separating columns. -T */
661 static size_t tabsize;
663 /* True means print each directory name before listing it. */
665 static bool print_dir_name;
667 /* The line length to use for breaking lines in many-per-line format.
668 Can be set with -w. */
670 static size_t line_length;
672 /* If true, the file listing format requires that stat be called on
675 static bool format_needs_stat;
677 /* Similar to `format_needs_stat', but set if only the file type is
680 static bool format_needs_type;
682 /* An arbitrary limit on the number of bytes in a printed time stamp.
683 This is set to a relatively small value to avoid the need to worry
684 about denial-of-service attacks on servers that run "ls" on behalf
685 of remote clients. 1000 bytes should be enough for any practical
686 time stamp format. */
688 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
690 /* strftime formats for non-recent and recent files, respectively, in
693 static char const *long_time_format[2] =
695 /* strftime format for non-recent files (older than 6 months), in
696 -l output. This should contain the year, month and day (at
697 least), in an order that is understood by people in your
698 locale's territory. Please try to keep the number of used
699 screen columns small, because many people work in windows with
700 only 80 columns. But make this as wide as the other string
701 below, for recent files. */
703 /* strftime format for recent files (younger than 6 months), in -l
704 output. This should contain the month, day and time (at
705 least), in an order that is understood by people in your
706 locale's territory. Please try to keep the number of used
707 screen columns small, because many people work in windows with
708 only 80 columns. But make this as wide as the other string
709 above, for non-recent files. */
713 /* The set of signals that are caught. */
715 static sigset_t caught_signals;
717 /* If nonzero, the value of the pending fatal signal. */
719 static sig_atomic_t volatile interrupt_signal;
721 /* A count of the number of pending stop signals that have been received. */
723 static sig_atomic_t volatile stop_signal_count;
725 /* Desired exit status. */
727 static int exit_status;
732 /* "ls" had a minor problem (e.g., it could not stat a directory
734 LS_MINOR_PROBLEM = 1,
736 /* "ls" had more serious trouble. */
740 /* For long options that have no equivalent short option, use a
741 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
744 AUTHOR_OPTION = CHAR_MAX + 1,
747 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
748 FILE_TYPE_INDICATOR_OPTION,
751 GROUP_DIRECTORIES_FIRST_OPTION,
753 INDICATOR_STYLE_OPTION,
755 /* FIXME: --kilobytes is deprecated (but not -k); remove in late 2006 */
756 KILOBYTES_LONG_OPTION,
758 QUOTING_STYLE_OPTION,
759 SHOW_CONTROL_CHARS_OPTION,
766 static struct option const long_options[] =
768 {"all", no_argument, NULL, 'a'},
769 {"escape", no_argument, NULL, 'b'},
770 {"directory", no_argument, NULL, 'd'},
771 {"dired", no_argument, NULL, 'D'},
772 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
773 {"group-directories-first", no_argument, NULL,
774 GROUP_DIRECTORIES_FIRST_OPTION},
775 {"human-readable", no_argument, NULL, 'h'},
776 {"inode", no_argument, NULL, 'i'},
777 {"kilobytes", no_argument, NULL, KILOBYTES_LONG_OPTION},
778 {"numeric-uid-gid", no_argument, NULL, 'n'},
779 {"no-group", no_argument, NULL, 'G'},
780 {"hide-control-chars", no_argument, NULL, 'q'},
781 {"reverse", no_argument, NULL, 'r'},
782 {"size", no_argument, NULL, 's'},
783 {"width", required_argument, NULL, 'w'},
784 {"almost-all", no_argument, NULL, 'A'},
785 {"ignore-backups", no_argument, NULL, 'B'},
786 {"classify", no_argument, NULL, 'F'},
787 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
788 {"si", no_argument, NULL, SI_OPTION},
789 {"dereference-command-line", no_argument, NULL, 'H'},
790 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
791 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
792 {"hide", required_argument, NULL, HIDE_OPTION},
793 {"ignore", required_argument, NULL, 'I'},
794 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
795 {"dereference", no_argument, NULL, 'L'},
796 {"literal", no_argument, NULL, 'N'},
797 {"quote-name", no_argument, NULL, 'Q'},
798 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
799 {"recursive", no_argument, NULL, 'R'},
800 {"format", required_argument, NULL, FORMAT_OPTION},
801 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
802 {"sort", required_argument, NULL, SORT_OPTION},
803 {"tabsize", required_argument, NULL, 'T'},
804 {"time", required_argument, NULL, TIME_OPTION},
805 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
806 {"color", optional_argument, NULL, COLOR_OPTION},
807 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
808 {"author", no_argument, NULL, AUTHOR_OPTION},
809 {GETOPT_HELP_OPTION_DECL},
810 {GETOPT_VERSION_OPTION_DECL},
814 static char const *const format_args[] =
816 "verbose", "long", "commas", "horizontal", "across",
817 "vertical", "single-column", NULL
819 static enum format const format_types[] =
821 long_format, long_format, with_commas, horizontal, horizontal,
822 many_per_line, one_per_line
824 ARGMATCH_VERIFY (format_args, format_types);
826 static char const *const sort_args[] =
828 "none", "time", "size", "extension", "version", NULL
830 static enum sort_type const sort_types[] =
832 sort_none, sort_time, sort_size, sort_extension, sort_version
834 ARGMATCH_VERIFY (sort_args, sort_types);
836 static char const *const time_args[] =
838 "atime", "access", "use", "ctime", "status", NULL
840 static enum time_type const time_types[] =
842 time_atime, time_atime, time_atime, time_ctime, time_ctime
844 ARGMATCH_VERIFY (time_args, time_types);
846 static char const *const color_args[] =
848 /* force and none are for compatibility with another color-ls version */
849 "always", "yes", "force",
850 "never", "no", "none",
851 "auto", "tty", "if-tty", NULL
853 static enum color_type const color_types[] =
855 color_always, color_always, color_always,
856 color_never, color_never, color_never,
857 color_if_tty, color_if_tty, color_if_tty
859 ARGMATCH_VERIFY (color_args, color_types);
861 /* Information about filling a column. */
869 /* Array with information about column filledness. */
870 static struct column_info *column_info;
872 /* Maximum number of columns ever possible for this display. */
873 static size_t max_idx;
875 /* The minimum width of a column is 3: 1 character for the name and 2
876 for the separating white space. */
877 #define MIN_COLUMN_WIDTH 3
880 /* This zero-based index is used solely with the --dired option.
881 When that option is in effect, this counter is incremented for each
882 byte of output generated by this program so that the beginning
883 and ending indices (in that output) of every file name can be recorded
884 and later output themselves. */
885 static size_t dired_pos;
887 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
889 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
890 #define DIRED_FPUTS(s, stream, s_len) \
891 do {fputs ((s), (stream)); dired_pos += s_len;} while (0)
893 /* Like DIRED_FPUTS, but for use when S is a literal string. */
894 #define DIRED_FPUTS_LITERAL(s, stream) \
895 do {fputs ((s), (stream)); dired_pos += sizeof((s)) - 1;} while (0)
897 #define DIRED_INDENT() \
901 DIRED_FPUTS_LITERAL (" ", stdout); \
905 /* With --dired, store pairs of beginning and ending indices of filenames. */
906 static struct obstack dired_obstack;
908 /* With --dired, store pairs of beginning and ending indices of any
909 directory names that appear as headers (just before `total' line)
910 for lists of directory entries. Such directory names are seen when
911 listing hierarchies using -R and when a directory is listed with at
912 least one other command line argument. */
913 static struct obstack subdired_obstack;
915 /* Save the current index on the specified obstack, OBS. */
916 #define PUSH_CURRENT_DIRED_POS(obs) \
920 obstack_grow ((obs), &dired_pos, sizeof (dired_pos)); \
924 /* With -R, this stack is used to help detect directory cycles.
925 The device/inode pairs on this stack mirror the pairs in the
926 active_dir_set hash table. */
927 static struct obstack dev_ino_obstack;
929 /* Push a pair onto the device/inode stack. */
930 #define DEV_INO_PUSH(Dev, Ino) \
933 struct dev_ino *di; \
934 obstack_blank (&dev_ino_obstack, sizeof (struct dev_ino)); \
935 di = -1 + (struct dev_ino *) obstack_next_free (&dev_ino_obstack); \
936 di->st_dev = (Dev); \
937 di->st_ino = (Ino); \
941 /* Pop a dev/ino struct off the global dev_ino_obstack
942 and return that struct. */
943 static struct dev_ino
946 assert (sizeof (struct dev_ino) <= obstack_object_size (&dev_ino_obstack));
947 obstack_blank (&dev_ino_obstack, -(int) (sizeof (struct dev_ino)));
948 return *(struct dev_ino *) obstack_next_free (&dev_ino_obstack);
951 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
956 assert (0 <= stat (Name, &sb)); \
957 assert (sb.st_dev == Di.st_dev); \
958 assert (sb.st_ino == Di.st_ino); \
963 /* Write to standard output PREFIX, followed by the quoting style and
964 a space-separated list of the integers stored in OS all on one line. */
967 dired_dump_obstack (const char *prefix, struct obstack *os)
971 n_pos = obstack_object_size (os) / sizeof (dired_pos);
977 pos = (size_t *) obstack_finish (os);
978 fputs (prefix, stdout);
979 for (i = 0; i < n_pos; i++)
980 printf (" %lu", (unsigned long int) pos[i]);
986 dev_ino_hash (void const *x, size_t table_size)
988 struct dev_ino const *p = x;
989 return (uintmax_t) p->st_ino % table_size;
993 dev_ino_compare (void const *x, void const *y)
995 struct dev_ino const *a = x;
996 struct dev_ino const *b = y;
997 return SAME_INODE (*a, *b) ? true : false;
1001 dev_ino_free (void *x)
1006 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
1007 active directories. Return true if there is already a matching
1008 entry in the table. */
1011 visit_dir (dev_t dev, ino_t ino)
1013 struct dev_ino *ent;
1014 struct dev_ino *ent_from_table;
1017 ent = xmalloc (sizeof *ent);
1021 /* Attempt to insert this entry into the table. */
1022 ent_from_table = hash_insert (active_dir_set, ent);
1024 if (ent_from_table == NULL)
1026 /* Insertion failed due to lack of memory. */
1030 found_match = (ent_from_table != ent);
1034 /* ent was not inserted, so free it. */
1042 free_pending_ent (struct pending *p)
1050 is_colored (enum indicator_no type)
1052 size_t len = color_indicator[type].len;
1053 char const *s = color_indicator[type].string;
1055 || (len == 1 && strncmp (s, "0", 1) == 0)
1056 || (len == 2 && strncmp (s, "00", 2) == 0));
1060 restore_default_color (void)
1062 put_indicator (&color_indicator[C_LEFT]);
1063 put_indicator (&color_indicator[C_RIGHT]);
1066 /* An ordinary signal was received; arrange for the program to exit. */
1069 sighandler (int sig)
1072 signal (sig, SIG_IGN);
1073 if (! interrupt_signal)
1074 interrupt_signal = sig;
1077 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1080 stophandler (int sig)
1083 signal (sig, stophandler);
1084 if (! interrupt_signal)
1085 stop_signal_count++;
1088 /* Process any pending signals. If signals are caught, this function
1089 should be called periodically. Ideally there should never be an
1090 unbounded amount of time when signals are not being processed.
1091 Signal handling can restore the default colors, so callers must
1092 immediately change colors after invoking this function. */
1095 process_signals (void)
1097 while (interrupt_signal | stop_signal_count)
1103 restore_default_color ();
1106 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1108 /* Reload interrupt_signal and stop_signal_count, in case a new
1109 signal was handled before sigprocmask took effect. */
1110 sig = interrupt_signal;
1111 stops = stop_signal_count;
1113 /* SIGTSTP is special, since the application can receive that signal
1114 more than once. In this case, don't set the signal handler to the
1115 default. Instead, just raise the uncatchable SIGSTOP. */
1118 stop_signal_count = stops - 1;
1122 signal (sig, SIG_DFL);
1124 /* Exit or suspend the program. */
1126 sigprocmask (SIG_SETMASK, &oldset, NULL);
1128 /* If execution reaches here, then the program has been
1129 continued (after being suspended). */
1134 main (int argc, char **argv)
1137 struct pending *thispend;
1140 /* The signals that are trapped, and the number of such signals. */
1141 static int const sig[] = { SIGHUP, SIGINT, SIGPIPE,
1142 SIGQUIT, SIGTERM, SIGTSTP };
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
1246 || print_block_size;
1247 format_needs_type = (! format_needs_stat
1250 || indicator_style != none
1251 || directories_first));
1255 obstack_init (&dired_obstack);
1256 obstack_init (&subdired_obstack);
1260 files = xnmalloc (nfiles, sizeof *files);
1270 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1272 queue_directory (".", NULL, true);
1276 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1282 if (!immediate_dirs)
1283 extract_dirs_from_files (NULL, true);
1284 /* `files_index' might be zero now. */
1287 /* In the following if/else blocks, it is sufficient to test `pending_dirs'
1288 (and not pending_dirs->name) because there may be no markers in the queue
1289 at this point. A marker may be enqueued when extract_dirs_from_files is
1290 called with a non-empty string or via print_dir. */
1293 print_current_files ();
1295 DIRED_PUTCHAR ('\n');
1297 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1298 print_dir_name = false;
1300 while (pending_dirs)
1302 thispend = pending_dirs;
1303 pending_dirs = pending_dirs->next;
1307 if (thispend->name == NULL)
1309 /* thispend->name == NULL means this is a marker entry
1310 indicating we've finished processing the directory.
1311 Use its dev/ino numbers to remove the corresponding
1312 entry from the active_dir_set hash table. */
1313 struct dev_ino di = dev_ino_pop ();
1314 struct dev_ino *found = hash_delete (active_dir_set, &di);
1315 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1317 dev_ino_free (found);
1318 free_pending_ent (thispend);
1323 print_dir (thispend->name, thispend->realname,
1324 thispend->command_line_arg);
1326 free_pending_ent (thispend);
1327 print_dir_name = true;
1330 if (print_with_color)
1334 restore_default_color ();
1337 /* Restore the default signal handling. */
1339 for (j = 0; j < nsigs; j++)
1340 if (sigismember (&caught_signals, sig[j]))
1341 signal (sig[j], SIG_DFL);
1343 for (j = 0; j < nsigs; j++)
1345 signal (sig[j], SIG_DFL);
1348 /* Act on any signals that arrived before the default was restored.
1349 This can process signals out of order, but there doesn't seem to
1350 be an easy way to do them in order, and the order isn't that
1351 important anyway. */
1352 for (j = stop_signal_count; j; j--)
1354 j = interrupt_signal;
1361 /* No need to free these since we're about to exit. */
1362 dired_dump_obstack ("//DIRED//", &dired_obstack);
1363 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1364 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1365 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1370 assert (hash_get_n_entries (active_dir_set) == 0);
1371 hash_free (active_dir_set);
1377 /* Set all the option flags according to the switches specified.
1378 Return the index of the first non-option argument. */
1381 decode_switches (int argc, char **argv)
1384 char *time_style_option = NULL;
1386 /* Record whether there is an option specifying sort type. */
1387 bool sort_type_specified = false;
1389 qmark_funny_chars = false;
1391 /* initialize all switches to default settings */
1396 /* This is for the `dir' program. */
1397 format = many_per_line;
1398 set_quoting_style (NULL, escape_quoting_style);
1401 case LS_LONG_FORMAT:
1402 /* This is for the `vdir' program. */
1403 format = long_format;
1404 set_quoting_style (NULL, escape_quoting_style);
1408 /* This is for the `ls' program. */
1409 if (isatty (STDOUT_FILENO))
1411 format = many_per_line;
1412 /* See description of qmark_funny_chars, above. */
1413 qmark_funny_chars = true;
1417 format = one_per_line;
1418 qmark_funny_chars = false;
1426 time_type = time_mtime;
1427 sort_type = sort_name;
1428 sort_reverse = false;
1429 numeric_ids = false;
1430 print_block_size = false;
1431 indicator_style = none;
1432 print_inode = false;
1433 dereference = DEREF_UNDEFINED;
1435 immediate_dirs = false;
1436 ignore_mode = IGNORE_DEFAULT;
1437 ignore_patterns = NULL;
1438 hide_patterns = NULL;
1440 /* FIXME: put this in a function. */
1442 char const *q_style = getenv ("QUOTING_STYLE");
1445 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
1447 set_quoting_style (NULL, quoting_style_vals[i]);
1450 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
1451 quotearg (q_style));
1456 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1457 human_output_opts = human_options (ls_block_size, false,
1458 &output_block_size);
1459 if (ls_block_size || getenv ("BLOCK_SIZE"))
1460 file_output_block_size = output_block_size;
1465 char const *p = getenv ("COLUMNS");
1468 unsigned long int tmp_ulong;
1469 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1470 && 0 < tmp_ulong && tmp_ulong <= SIZE_MAX)
1472 line_length = tmp_ulong;
1477 _("ignoring invalid width in environment variable COLUMNS: %s"),
1487 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1488 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1489 line_length = ws.ws_col;
1494 char const *p = getenv ("TABSIZE");
1498 unsigned long int tmp_ulong;
1499 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1500 && tmp_ulong <= SIZE_MAX)
1502 tabsize = tmp_ulong;
1507 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1513 while ((c = getopt_long (argc, argv,
1514 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UX1",
1515 long_options, NULL)) != -1)
1520 ignore_mode = IGNORE_MINIMAL;
1524 set_quoting_style (NULL, escape_quoting_style);
1528 time_type = time_ctime;
1532 immediate_dirs = true;
1536 /* Same as enabling -a -U and disabling -l -s. */
1537 ignore_mode = IGNORE_MINIMAL;
1538 sort_type = sort_none;
1539 sort_type_specified = true;
1541 if (format == long_format)
1542 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1543 print_block_size = false; /* disable -s */
1544 print_with_color = false; /* disable --color */
1547 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1548 indicator_style = file_type;
1552 format = long_format;
1553 print_owner = false;
1557 human_output_opts = human_autoscale | human_SI | human_base_1024;
1558 file_output_block_size = output_block_size = 1;
1565 case KILOBYTES_LONG_OPTION:
1567 _("the --kilobytes option is deprecated; use -k instead"));
1570 human_output_opts = 0;
1571 file_output_block_size = output_block_size = 1024;
1575 format = long_format;
1579 format = with_commas;
1584 format = long_format;
1587 case 'o': /* Just like -l, but don't display group info. */
1588 format = long_format;
1589 print_group = false;
1593 indicator_style = slash;
1597 qmark_funny_chars = true;
1601 sort_reverse = true;
1605 print_block_size = true;
1609 sort_type = sort_time;
1610 sort_type_specified = true;
1614 time_type = time_atime;
1618 sort_type = sort_version;
1619 sort_type_specified = true;
1624 unsigned long int tmp_ulong;
1625 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1626 || ! (0 < tmp_ulong && tmp_ulong <= SIZE_MAX))
1627 error (LS_FAILURE, 0, _("invalid line width: %s"),
1629 line_length = tmp_ulong;
1634 format = horizontal;
1638 if (ignore_mode == IGNORE_DEFAULT)
1639 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1643 add_ignore_pattern ("*~");
1644 add_ignore_pattern (".*~");
1648 format = many_per_line;
1656 indicator_style = classify;
1659 case 'G': /* inhibit display of group info */
1660 print_group = false;
1664 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1667 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1668 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1672 add_ignore_pattern (optarg);
1676 dereference = DEREF_ALWAYS;
1680 set_quoting_style (NULL, literal_quoting_style);
1684 set_quoting_style (NULL, c_quoting_style);
1692 sort_type = sort_size;
1693 sort_type_specified = true;
1698 unsigned long int tmp_ulong;
1699 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1700 || SIZE_MAX < tmp_ulong)
1701 error (LS_FAILURE, 0, _("invalid tab size: %s"),
1703 tabsize = tmp_ulong;
1708 sort_type = sort_none;
1709 sort_type_specified = true;
1713 sort_type = sort_extension;
1714 sort_type_specified = true;
1718 /* -1 has no effect after -l. */
1719 if (format != long_format)
1720 format = one_per_line;
1724 print_author = true;
1729 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1730 hide->pattern = optarg;
1731 hide->next = hide_patterns;
1732 hide_patterns = hide;
1737 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1738 sort_type_specified = true;
1741 case GROUP_DIRECTORIES_FIRST_OPTION:
1742 directories_first = true;
1746 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1750 format = XARGMATCH ("--format", optarg, format_args, format_types);
1753 case FULL_TIME_OPTION:
1754 format = long_format;
1755 time_style_option = "full-iso";
1762 i = XARGMATCH ("--color", optarg, color_args, color_types);
1764 /* Using --color with no argument is equivalent to using
1768 print_with_color = (i == color_always
1769 || (i == color_if_tty
1770 && isatty (STDOUT_FILENO)));
1772 if (print_with_color)
1774 /* Don't use TAB characters in output. Some terminal
1775 emulators can't handle the combination of tabs and
1776 color codes on the same line. */
1782 case INDICATOR_STYLE_OPTION:
1783 indicator_style = XARGMATCH ("--indicator-style", optarg,
1784 indicator_style_args,
1785 indicator_style_types);
1788 case QUOTING_STYLE_OPTION:
1789 set_quoting_style (NULL,
1790 XARGMATCH ("--quoting-style", optarg,
1792 quoting_style_vals));
1795 case TIME_STYLE_OPTION:
1796 time_style_option = optarg;
1799 case SHOW_CONTROL_CHARS_OPTION:
1800 qmark_funny_chars = false;
1803 case BLOCK_SIZE_OPTION:
1804 human_output_opts = human_options (optarg, true, &output_block_size);
1805 file_output_block_size = output_block_size;
1809 human_output_opts = human_autoscale | human_SI;
1810 file_output_block_size = output_block_size = 1;
1813 case_GETOPT_HELP_CHAR;
1815 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1822 max_idx = MAX (1, line_length / MIN_COLUMN_WIDTH);
1824 filename_quoting_options = clone_quoting_options (NULL);
1825 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1826 set_char_quoting (filename_quoting_options, ' ', 1);
1827 if (file_type <= indicator_style)
1830 for (p = "*=>@|" + indicator_style - file_type; *p; p++)
1831 set_char_quoting (filename_quoting_options, *p, 1);
1834 dirname_quoting_options = clone_quoting_options (NULL);
1835 set_char_quoting (dirname_quoting_options, ':', 1);
1837 /* --dired is meaningful only with --format=long (-l).
1838 Otherwise, ignore it. FIXME: warn about this?
1839 Alternatively, make --dired imply --format=long? */
1840 if (dired && format != long_format)
1843 /* If -c or -u is specified and not -l (or any other option that implies -l),
1844 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
1845 The behavior of ls when using either -c or -u but with neither -l nor -t
1846 appears to be unspecified by POSIX. So, with GNU ls, `-u' alone means
1847 sort by atime (this is the one that's not specified by the POSIX spec),
1848 -lu means show atime and sort by name, -lut means show atime and sort
1851 if ((time_type == time_ctime || time_type == time_atime)
1852 && !sort_type_specified && format != long_format)
1854 sort_type = sort_time;
1857 if (format == long_format)
1859 char *style = time_style_option;
1860 static char const posix_prefix[] = "posix-";
1863 if (! (style = getenv ("TIME_STYLE")))
1866 while (strncmp (style, posix_prefix, sizeof posix_prefix - 1) == 0)
1868 if (! hard_locale (LC_TIME))
1870 style += sizeof posix_prefix - 1;
1875 char *p0 = style + 1;
1876 char *p1 = strchr (p0, '\n');
1881 if (strchr (p1 + 1, '\n'))
1882 error (LS_FAILURE, 0, _("invalid time style format %s"),
1886 long_time_format[0] = p0;
1887 long_time_format[1] = p1;
1890 switch (XARGMATCH ("time style", style,
1894 case full_iso_time_style:
1895 long_time_format[0] = long_time_format[1] =
1896 "%Y-%m-%d %H:%M:%S.%N %z";
1899 case long_iso_time_style:
1900 case_long_iso_time_style:
1901 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
1904 case iso_time_style:
1905 long_time_format[0] = "%Y-%m-%d ";
1906 long_time_format[1] = "%m-%d %H:%M";
1909 case locale_time_style:
1910 if (hard_locale (LC_TIME))
1912 /* Ensure that the locale has translations for both
1913 formats. If not, fall back on long-iso format. */
1915 for (i = 0; i < 2; i++)
1917 char const *locale_format =
1918 dcgettext (NULL, long_time_format[i], LC_TIME);
1919 if (locale_format == long_time_format[i])
1920 goto case_long_iso_time_style;
1921 long_time_format[i] = locale_format;
1930 /* Parse a string as part of the LS_COLORS variable; this may involve
1931 decoding all kinds of escape characters. If equals_end is set an
1932 unescaped equal sign ends the string, otherwise only a : or \0
1933 does. Set *OUTPUT_COUNT to the number of bytes output. Return
1936 The resulting string is *not* null-terminated, but may contain
1939 Note that both dest and src are char **; on return they point to
1940 the first free byte after the array and the character that ended
1941 the input string, respectively. */
1944 get_funky_string (char **dest, const char **src, bool equals_end,
1945 size_t *output_count)
1947 char num; /* For numerical codes */
1948 size_t count; /* Something to count with */
1950 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
1955 p = *src; /* We don't want to double-indirect */
1956 q = *dest; /* the whole darn time. */
1958 count = 0; /* No characters counted in yet. */
1961 state = ST_GND; /* Start in ground state. */
1962 while (state < ST_END)
1966 case ST_GND: /* Ground state (no escapes) */
1971 state = ST_END; /* End of string */
1974 state = ST_BACKSLASH; /* Backslash scape sequence */
1978 state = ST_CARET; /* Caret escape */
1984 state = ST_END; /* End */
1987 /* else fall through */
1995 case ST_BACKSLASH: /* Backslash escaped character */
2006 state = ST_OCTAL; /* Octal sequence */
2011 state = ST_HEX; /* Hex sequence */
2014 case 'a': /* Bell */
2017 case 'b': /* Backspace */
2020 case 'e': /* Escape */
2023 case 'f': /* Form feed */
2026 case 'n': /* Newline */
2029 case 'r': /* Carriage return */
2035 case 'v': /* Vtab */
2038 case '?': /* Delete */
2041 case '_': /* Space */
2044 case '\0': /* End of string */
2045 state = ST_ERROR; /* Error! */
2047 default: /* Escaped character like \ ^ : = */
2051 if (state == ST_BACKSLASH)
2060 case ST_OCTAL: /* Octal sequence */
2061 if (*p < '0' || *p > '7')
2068 num = (num << 3) + (*(p++) - '0');
2071 case ST_HEX: /* Hex sequence */
2084 num = (num << 4) + (*(p++) - '0');
2092 num = (num << 4) + (*(p++) - 'a') + 10;
2100 num = (num << 4) + (*(p++) - 'A') + 10;
2110 case ST_CARET: /* Caret escape */
2111 state = ST_GND; /* Should be the next state... */
2112 if (*p >= '@' && *p <= '~')
2114 *(q++) = *(p++) & 037;
2133 *output_count = count;
2135 return state != ST_ERROR;
2139 parse_ls_color (void)
2141 const char *p; /* Pointer to character being parsed */
2142 char *buf; /* color_buf buffer pointer */
2143 int state; /* State of parser */
2144 int ind_no; /* Indicator number */
2145 char label[3]; /* Indicator label */
2146 struct color_ext_type *ext; /* Extension we are working on */
2148 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2152 strcpy (label, "??");
2154 /* This is an overly conservative estimate, but any possible
2155 LS_COLORS string will *not* generate a color_buf longer than
2156 itself, so it is a safe way of allocating a buffer in
2158 buf = color_buf = xstrdup (p);
2165 case 1: /* First label character */
2173 /* Allocate new extension block and add to head of
2174 linked list (this way a later definition will
2175 override an earlier one, which can be useful for
2176 having terminal-specific defs override global). */
2178 ext = xmalloc (sizeof *ext);
2179 ext->next = color_ext_list;
2180 color_ext_list = ext;
2183 ext->ext.string = buf;
2185 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2190 state = 0; /* Done! */
2193 default: /* Assume it is file type label */
2200 case 2: /* Second label character */
2207 state = -1; /* Error */
2210 case 3: /* Equal sign after indicator label */
2211 state = -1; /* Assume failure... */
2212 if (*(p++) == '=')/* It *should* be... */
2214 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2216 if (STREQ (label, indicator_name[ind_no]))
2218 color_indicator[ind_no].string = buf;
2219 state = (get_funky_string (&buf, &p, false,
2220 &color_indicator[ind_no].len)
2226 error (0, 0, _("unrecognized prefix: %s"), quotearg (label));
2230 case 4: /* Equal sign after *.ext */
2233 ext->seq.string = buf;
2234 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2245 struct color_ext_type *e;
2246 struct color_ext_type *e2;
2249 _("unparsable value for LS_COLORS environment variable"));
2251 for (e = color_ext_list; e != NULL; /* empty */)
2257 print_with_color = false;
2260 if (color_indicator[C_LINK].len == 6
2261 && !strncmp (color_indicator[C_LINK].string, "target", 6))
2262 color_symlink_as_referent = true;
2265 /* Set the exit status to report a failure. If SERIOUS, it is a
2266 serious failure; otherwise, it is merely a minor problem. */
2269 set_exit_status (bool serious)
2272 exit_status = LS_FAILURE;
2273 else if (exit_status == EXIT_SUCCESS)
2274 exit_status = LS_MINOR_PROBLEM;
2277 /* Assuming a failure is serious if SERIOUS, use the printf-style
2278 MESSAGE to report the failure to access a file named FILE. Assume
2279 errno is set appropriately for the failure. */
2282 file_failure (bool serious, char const *message, char const *file)
2284 error (0, errno, message, quotearg_colon (file));
2285 set_exit_status (serious);
2288 /* Request that the directory named NAME have its contents listed later.
2289 If REALNAME is nonzero, it will be used instead of NAME when the
2290 directory name is printed. This allows symbolic links to directories
2291 to be treated as regular directories but still be listed under their
2292 real names. NAME == NULL is used to insert a marker entry for the
2293 directory named in REALNAME.
2294 If NAME is non-NULL, we use its dev/ino information to save
2295 a call to stat -- when doing a recursive (-R) traversal.
2296 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2299 queue_directory (char const *name, char const *realname, bool command_line_arg)
2301 struct pending *new = xmalloc (sizeof *new);
2302 new->realname = realname ? xstrdup (realname) : NULL;
2303 new->name = name ? xstrdup (name) : NULL;
2304 new->command_line_arg = command_line_arg;
2305 new->next = pending_dirs;
2309 /* Read directory NAME, and list the files in it.
2310 If REALNAME is nonzero, print its name instead of NAME;
2311 this is used for symbolic links to directories.
2312 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2315 print_dir (char const *name, char const *realname, bool command_line_arg)
2318 struct dirent *next;
2319 uintmax_t total_blocks = 0;
2320 static bool first = true;
2323 dirp = opendir (name);
2326 file_failure (command_line_arg, _("cannot open directory %s"), name);
2332 struct stat dir_stat;
2333 int fd = dirfd (dirp);
2335 /* If dirfd failed, endure the overhead of using stat. */
2337 ? fstat (fd, &dir_stat)
2338 : stat (name, &dir_stat)) < 0)
2340 file_failure (command_line_arg,
2341 _("cannot determine device and inode of %s"), name);
2345 /* If we've already visited this dev/inode pair, warn that
2346 we've found a loop, and do not process this directory. */
2347 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2349 error (0, 0, _("%s: not listing already-listed directory"),
2350 quotearg_colon (name));
2354 DEV_INO_PUSH (dir_stat.st_dev, dir_stat.st_ino);
2357 /* Read the directory entries, and insert the subfiles into the `files'
2364 /* Set errno to zero so we can distinguish between a readdir failure
2365 and when readdir simply finds that there are no more entries. */
2367 next = readdir (dirp);
2370 if (! file_ignored (next->d_name))
2372 enum filetype type = unknown;
2374 #if HAVE_STRUCT_DIRENT_D_TYPE
2375 switch (next->d_type)
2377 case DT_BLK: type = blockdev; break;
2378 case DT_CHR: type = chardev; break;
2379 case DT_DIR: type = directory; break;
2380 case DT_FIFO: type = fifo; break;
2381 case DT_LNK: type = symbolic_link; break;
2382 case DT_REG: type = normal; break;
2383 case DT_SOCK: type = sock; break;
2385 case DT_WHT: type = whiteout; break;
2389 total_blocks += gobble_file (next->d_name, type, D_INO (next),
2393 else if (errno != 0)
2395 file_failure (command_line_arg, _("reading directory %s"), name);
2396 if (errno != EOVERFLOW)
2403 if (closedir (dirp) != 0)
2405 file_failure (command_line_arg, _("closing directory %s"), name);
2406 /* Don't return; print whatever we got. */
2409 /* Sort the directory contents. */
2412 /* If any member files are subdirectories, perhaps they should have their
2413 contents listed rather than being mentioned here as files. */
2416 extract_dirs_from_files (name, command_line_arg);
2418 if (recursive | print_dir_name)
2421 DIRED_PUTCHAR ('\n');
2424 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2425 dired_pos += quote_name (stdout, realname ? realname : name,
2426 dirname_quoting_options, NULL);
2427 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2428 DIRED_FPUTS_LITERAL (":\n", stdout);
2431 if (format == long_format || print_block_size)
2434 char buf[LONGEST_HUMAN_READABLE + 1];
2438 DIRED_FPUTS (p, stdout, strlen (p));
2439 DIRED_PUTCHAR (' ');
2440 p = human_readable (total_blocks, buf, human_output_opts,
2441 ST_NBLOCKSIZE, output_block_size);
2442 DIRED_FPUTS (p, stdout, strlen (p));
2443 DIRED_PUTCHAR ('\n');
2447 print_current_files ();
2450 /* Add `pattern' to the list of patterns for which files that match are
2454 add_ignore_pattern (const char *pattern)
2456 struct ignore_pattern *ignore;
2458 ignore = xmalloc (sizeof *ignore);
2459 ignore->pattern = pattern;
2460 /* Add it to the head of the linked list. */
2461 ignore->next = ignore_patterns;
2462 ignore_patterns = ignore;
2465 /* Return true if one of the PATTERNS matches FILE. */
2468 patterns_match (struct ignore_pattern const *patterns, char const *file)
2470 struct ignore_pattern const *p;
2471 for (p = patterns; p; p = p->next)
2472 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2477 /* Return true if FILE should be ignored. */
2480 file_ignored (char const *name)
2482 return ((ignore_mode != IGNORE_MINIMAL
2484 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2485 || (ignore_mode == IGNORE_DEFAULT
2486 && patterns_match (hide_patterns, name))
2487 || patterns_match (ignore_patterns, name));
2490 /* POSIX requires that a file size be printed without a sign, even
2491 when negative. Assume the typical case where negative sizes are
2492 actually positive values that have wrapped around. */
2495 unsigned_file_size (off_t size)
2497 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2500 /* Enter and remove entries in the table `files'. */
2502 /* Empty the table of files. */
2509 for (i = 0; i < files_index; i++)
2511 free (files[i].name);
2512 free (files[i].linkname);
2517 any_has_acl = false;
2519 inode_number_width = 0;
2520 block_size_width = 0;
2525 major_device_number_width = 0;
2526 minor_device_number_width = 0;
2527 file_size_width = 0;
2530 /* Add a file to the current table of files.
2531 Verify that the file exists, and print an error message if it does not.
2532 Return the number of blocks that the file occupies. */
2535 gobble_file (char const *name, enum filetype type, ino_t inode,
2536 bool command_line_arg, char const *dirname)
2538 uintmax_t blocks = 0;
2541 /* An inode value prior to gobble_file necessarily came from readdir,
2542 which is not used for command line arguments. */
2543 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2545 if (files_index == nfiles)
2547 files = xnrealloc (files, nfiles, 2 * sizeof *files);
2551 f = &files[files_index];
2552 memset (f, '\0', sizeof *f);
2553 f->stat.st_ino = inode;
2556 if (command_line_arg
2557 || format_needs_stat
2559 && (inode == NOT_AN_INODE_NUMBER
2560 /* When dereferencing symlinks, the inode must come from
2561 stat, but readdir provides the inode of lstat. Command
2562 line dereferences are already taken care of by the above
2563 assertion that the inode number is not yet known. */
2564 || (dereference == DEREF_ALWAYS
2565 && (type == symbolic_link || type == unknown))))
2566 || (format_needs_type
2567 && (type == unknown || command_line_arg
2568 /* --indicator-style=classify (aka -F)
2569 requires that we stat each regular file
2570 to see if it's executable. */
2571 || (type == normal && (indicator_style == classify
2572 /* This is so that --color ends up
2573 highlighting files with the executable
2574 bit set even when options like -F are
2576 || (print_with_color
2577 && is_colored (C_EXEC))
2581 /* Absolute name of this file. */
2582 char *absolute_name;
2586 if (name[0] == '/' || dirname[0] == 0)
2587 absolute_name = (char *) name;
2590 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
2591 attach (absolute_name, dirname, name);
2594 switch (dereference)
2597 err = stat (absolute_name, &f->stat);
2600 case DEREF_COMMAND_LINE_ARGUMENTS:
2601 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
2602 if (command_line_arg)
2605 err = stat (absolute_name, &f->stat);
2607 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
2610 need_lstat = (err < 0
2612 : ! S_ISDIR (f->stat.st_mode));
2616 /* stat failed because of ENOENT, maybe indicating a dangling
2617 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
2618 directory, and --dereference-command-line-symlink-to-dir is
2619 in effect. Fall through so that we call lstat instead. */
2622 default: /* DEREF_NEVER */
2623 err = lstat (absolute_name, &f->stat);
2629 /* Failure to stat a command line argument leads to
2630 an exit status of 2. For other files, stat failure
2631 provokes an exit status of 1. */
2632 file_failure (command_line_arg,
2633 _("cannot access %s"), absolute_name);
2634 if (command_line_arg)
2637 f->name = xstrdup (name);
2646 if (format == long_format)
2648 int n = file_has_acl (absolute_name, &f->stat);
2649 f->have_acl = (0 < n);
2650 any_has_acl |= f->have_acl;
2652 error (0, errno, "%s", quotearg_colon (absolute_name));
2656 if (S_ISLNK (f->stat.st_mode)
2657 && (format == long_format || check_symlink_color))
2660 struct stat linkstats;
2662 get_link_name (absolute_name, f, command_line_arg);
2663 linkname = make_link_name (absolute_name, f->linkname);
2665 /* Avoid following symbolic links when possible, ie, when
2666 they won't be traced and when no indicator is needed. */
2668 && (file_type <= indicator_style || check_symlink_color)
2669 && stat (linkname, &linkstats) == 0)
2673 /* Symbolic links to directories that are mentioned on the
2674 command line are automatically traced if not being
2676 if (!command_line_arg || format == long_format
2677 || !S_ISDIR (linkstats.st_mode))
2679 /* Get the linked-to file's mode for the filetype indicator
2680 in long listings. */
2681 f->linkmode = linkstats.st_mode;
2687 if (S_ISLNK (f->stat.st_mode))
2688 f->filetype = symbolic_link;
2689 else if (S_ISDIR (f->stat.st_mode))
2691 if (command_line_arg & !immediate_dirs)
2692 f->filetype = arg_directory;
2694 f->filetype = directory;
2697 f->filetype = normal;
2699 blocks = ST_NBLOCKS (f->stat);
2701 char buf[LONGEST_HUMAN_READABLE + 1];
2702 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
2703 ST_NBLOCKSIZE, output_block_size),
2705 if (block_size_width < len)
2706 block_size_width = len;
2711 int len = format_user_width (f->stat.st_uid);
2712 if (owner_width < len)
2718 int len = format_group_width (f->stat.st_gid);
2719 if (group_width < len)
2725 int len = format_user_width (f->stat.st_author);
2726 if (author_width < len)
2731 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2732 int len = strlen (umaxtostr (f->stat.st_nlink, buf));
2733 if (nlink_width < len)
2737 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
2739 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2740 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
2741 if (major_device_number_width < len)
2742 major_device_number_width = len;
2743 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
2744 if (minor_device_number_width < len)
2745 minor_device_number_width = len;
2746 len = major_device_number_width + 2 + minor_device_number_width;
2747 if (file_size_width < len)
2748 file_size_width = len;
2752 char buf[LONGEST_HUMAN_READABLE + 1];
2753 uintmax_t size = unsigned_file_size (f->stat.st_size);
2754 int len = mbswidth (human_readable (size, buf, human_output_opts,
2755 1, file_output_block_size),
2757 if (file_size_width < len)
2758 file_size_width = len;
2764 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2765 int len = strlen (umaxtostr (f->stat.st_ino, buf));
2766 if (inode_number_width < len)
2767 inode_number_width = len;
2770 f->name = xstrdup (name);
2776 /* Return true if F refers to a directory. */
2778 is_directory (const struct fileinfo *f)
2780 return f->filetype == directory || f->filetype == arg_directory;
2786 /* Put the name of the file that FILENAME is a symbolic link to
2787 into the LINKNAME field of `f'. COMMAND_LINE_ARG indicates whether
2788 FILENAME is a command-line argument. */
2791 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
2793 f->linkname = xreadlink (filename, f->stat.st_size);
2794 if (f->linkname == NULL)
2795 file_failure (command_line_arg, _("cannot read symbolic link %s"),
2799 /* If `linkname' is a relative name and `name' contains one or more
2800 leading directories, return `linkname' with those directories
2801 prepended; otherwise, return a copy of `linkname'.
2802 If `linkname' is zero, return zero. */
2805 make_link_name (char const *name, char const *linkname)
2813 if (*linkname == '/')
2814 return xstrdup (linkname);
2816 /* The link is to a relative name. Prepend any leading directory
2817 in `name' to the link name. */
2818 linkbuf = strrchr (name, '/');
2820 return xstrdup (linkname);
2822 bufsiz = linkbuf - name + 1;
2823 linkbuf = xmalloc (bufsiz + strlen (linkname) + 1);
2824 strncpy (linkbuf, name, bufsiz);
2825 strcpy (linkbuf + bufsiz, linkname);
2830 /* Return true if the last component of NAME is `.' or `..'
2831 This is so we don't try to recurse on `././././. ...' */
2834 basename_is_dot_or_dotdot (const char *name)
2836 char const *base = last_component (name);
2837 return DOT_OR_DOTDOT (base);
2840 /* Remove any entries from FILES that are for directories,
2841 and queue them to be listed as directories instead.
2842 DIRNAME is the prefix to prepend to each dirname
2843 to make it correct relative to ls's working dir;
2844 if it is null, no prefix is needed and "." and ".." should not be ignored.
2845 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
2846 This is desirable when processing directories recursively. */
2849 extract_dirs_from_files (char const *dirname, bool command_line_arg)
2853 bool ignore_dot_and_dot_dot = (dirname != NULL);
2855 if (dirname && LOOP_DETECT)
2857 /* Insert a marker entry first. When we dequeue this marker entry,
2858 we'll know that DIRNAME has been processed and may be removed
2859 from the set of active directories. */
2860 queue_directory (NULL, dirname, false);
2863 /* Queue the directories last one first, because queueing reverses the
2865 for (i = files_index; i-- != 0; )
2866 if (is_directory (&files[i])
2867 && (! ignore_dot_and_dot_dot
2868 || ! basename_is_dot_or_dotdot (files[i].name)))
2870 if (!dirname || files[i].name[0] == '/')
2872 queue_directory (files[i].name, files[i].linkname,
2877 char *name = file_name_concat (dirname, files[i].name, NULL);
2878 queue_directory (name, files[i].linkname, command_line_arg);
2881 if (files[i].filetype == arg_directory)
2882 free (files[i].name);
2885 /* Now delete the directories from the table, compacting all the remaining
2888 for (i = 0, j = 0; i < files_index; i++)
2890 if (files[i].filetype != arg_directory)
2893 files[j] = files[i];
2900 /* Use strcoll to compare strings in this locale. If an error occurs,
2901 report an error and longjmp to failed_strcoll. */
2903 static jmp_buf failed_strcoll;
2906 xstrcoll (char const *a, char const *b)
2910 diff = strcoll (a, b);
2913 error (0, errno, _("cannot compare file names %s and %s"),
2914 quote_n (0, a), quote_n (1, b));
2915 set_exit_status (false);
2916 longjmp (failed_strcoll, 1);
2921 /* Comparison routines for sorting the files. */
2923 typedef void const *V;
2924 typedef int (*qsortFunc)(V a, V b);
2926 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
2927 The do { ... } while(0) makes it possible to use the macro more like
2928 a statement, without violating C89 rules: */
2929 #define DIRFIRST_CHECK(a, b) \
2932 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
2933 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
2934 if (a_is_dir && !b_is_dir) \
2935 return -1; /* a goes before b */ \
2936 if (!a_is_dir && b_is_dir) \
2937 return 1; /* b goes before a */ \
2941 /* Define the 8 different sort function variants required for each sortkey.
2942 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
2943 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
2944 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
2945 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
2946 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
2947 /* direct, non-dirfirst versions */ \
2948 static int xstrcoll_##key_name (V a, V b) \
2949 { return key_cmp_func (a, b, xstrcoll); } \
2950 static int strcmp_##key_name (V a, V b) \
2951 { return key_cmp_func (a, b, strcmp); } \
2953 /* reverse, non-dirfirst versions */ \
2954 static int rev_xstrcoll_##key_name (V a, V b) \
2955 { return key_cmp_func (b, a, xstrcoll); } \
2956 static int rev_strcmp_##key_name (V a, V b) \
2957 { return key_cmp_func (b, a, strcmp); } \
2959 /* direct, dirfirst versions */ \
2960 static int xstrcoll_df_##key_name (V a, V b) \
2961 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
2962 static int strcmp_df_##key_name (V a, V b) \
2963 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
2965 /* reverse, dirfirst versions */ \
2966 static int rev_xstrcoll_df_##key_name (V a, V b) \
2967 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
2968 static int rev_strcmp_df_##key_name (V a, V b) \
2969 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
2972 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
2973 int (*cmp) (char const *, char const *))
2975 int diff = timespec_cmp (get_stat_ctime (&b->stat),
2976 get_stat_ctime (&a->stat));
2977 return diff ? diff : cmp (a->name, b->name);
2981 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
2982 int (*cmp) (char const *, char const *))
2984 int diff = timespec_cmp (get_stat_mtime (&b->stat),
2985 get_stat_mtime (&a->stat));
2986 return diff ? diff : cmp (a->name, b->name);
2990 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
2991 int (*cmp) (char const *, char const *))
2993 int diff = timespec_cmp (get_stat_atime (&b->stat),
2994 get_stat_atime (&a->stat));
2995 return diff ? diff : cmp (a->name, b->name);
2999 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3000 int (*cmp) (char const *, char const *))
3002 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3003 return diff ? diff : cmp (a->name, b->name);
3007 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3008 int (*cmp) (char const *, char const *))
3010 return cmp (a->name, b->name);
3013 /* Compare file extensions. Files with no extension are `smallest'.
3014 If extensions are the same, compare by filenames instead. */
3017 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3018 int (*cmp) (char const *, char const *))
3020 char const *base1 = strrchr (a->name, '.');
3021 char const *base2 = strrchr (b->name, '.');
3022 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3023 return diff ? diff : cmp (a->name, b->name);
3026 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3027 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3028 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3029 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3030 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3031 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3033 /* Compare file versions.
3034 Unlike all other compare functions above, cmp_version depends only
3035 on strverscmp, which does not fail (even for locale reasons), and does not
3036 need a secondary sort key.
3037 All the other sort options, in fact, need xstrcoll and strcmp variants,
3038 because they all use a string comparison (either as the primary or secondary
3039 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3040 locale reasons. Last, strverscmp is ALWAYS available in coreutils,
3041 thanks to the gnulib library. */
3043 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3045 return strverscmp (a->name, b->name);
3048 static int xstrcoll_version (V a, V b)
3049 { return cmp_version (a, b); }
3050 static int rev_xstrcoll_version (V a, V b)
3051 { return cmp_version (b, a); }
3052 static int xstrcoll_df_version (V a, V b)
3053 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3054 static int rev_xstrcoll_df_version (V a, V b)
3055 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3058 /* We have 2^3 different variants for each sortkey function
3059 (for 3 independent sort modes).
3060 The function pointers stored in this array must be dereferenced as:
3062 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3064 Note that the order in which sortkeys are listed in the function pointer
3065 array below is defined by the order of the elements in the time_type and
3068 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3071 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3072 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3075 { strcmp_##key_name, strcmp_df_##key_name }, \
3076 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3080 static qsortFunc sort_functions[][2][2][2] =
3082 LIST_SORTFUNCTION_VARIANTS (name),
3083 LIST_SORTFUNCTION_VARIANTS (extension),
3084 LIST_SORTFUNCTION_VARIANTS (size),
3088 { xstrcoll_version, xstrcoll_df_version },
3089 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3092 /* We use NULL for the strcmp variants of version comparison
3093 since as explained in cmp_version definition, version comparison
3094 does not rely on xstrcoll, so it will never longjmp, and never
3095 need to try the strcmp fallback. */
3102 /* last are time sort functions */
3103 LIST_SORTFUNCTION_VARIANTS (mtime),
3104 LIST_SORTFUNCTION_VARIANTS (ctime),
3105 LIST_SORTFUNCTION_VARIANTS (atime)
3108 /* The number of sortkeys is calculated as
3109 the number of elements in the sort_type enum (i.e. sort_numtypes) +
3110 the number of elements in the time_type enum (i.e. time_numtypes) - 1
3111 This is because when sort_type==sort_time, we have up to
3112 time_numtypes possible sortkeys.
3114 This line verifies at compile-time that the array of sort functions has been
3115 initialized for all possible sortkeys. */
3116 verify (ARRAY_CARDINALITY (sort_functions)
3117 == sort_numtypes + time_numtypes - 1 );
3120 /* Sort the files now in the table. */
3127 if (sort_type == sort_none)
3130 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3131 ignore strcoll failures, as a failing strcoll might be a
3132 comparison function that is not a total order, and if we ignored
3133 the failure this might cause qsort to dump core. */
3135 if (! setjmp (failed_strcoll))
3136 use_strcmp = false; /* strcoll() succeeded */
3140 assert (sort_type != sort_version);
3143 /* When sort_type == sort_time, use time_type as subindex. */
3144 int timeoffset = sort_type == sort_time ? time_type : 0;
3146 qsort (files, files_index, sizeof *files,
3147 sort_functions[sort_type + timeoffset][use_strcmp][sort_reverse]
3148 [directories_first]);
3151 /* List all the files now in the table. */
3154 print_current_files (void)
3161 for (i = 0; i < files_index; i++)
3163 print_file_name_and_frills (files + i);
3169 print_many_per_line ();
3173 print_horizontal ();
3177 print_with_commas ();
3181 for (i = 0; i < files_index; i++)
3183 print_long_format (files + i);
3184 DIRED_PUTCHAR ('\n');
3190 /* Return the expected number of columns in a long-format time stamp,
3191 or zero if it cannot be calculated. */
3194 long_time_expected_width (void)
3196 static int width = -1;
3201 struct tm const *tm = localtime (&epoch);
3202 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3204 /* In case you're wondering if localtime can fail with an input time_t
3205 value of 0, let's just say it's very unlikely, but not inconceivable.
3206 The TZ environment variable would have to specify a time zone that
3207 is 2**31-1900 years or more ahead of UTC. This could happen only on
3208 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3209 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3210 their implementations limit the offset to 167:59 and 24:00, resp. */
3214 nstrftime (buf, sizeof buf, long_time_format[0], tm, 0, 0);
3216 width = mbsnwidth (buf, len, 0);
3226 /* Get the current time. */
3229 get_current_time (void)
3231 #if HAVE_CLOCK_GETTIME && defined CLOCK_REALTIME
3233 struct timespec timespec;
3234 if (clock_gettime (CLOCK_REALTIME, ×pec) == 0)
3236 current_time = timespec.tv_sec;
3237 current_time_ns = timespec.tv_nsec;
3243 /* The clock does not have nanosecond resolution, so get the maximum
3244 possible value for the current time that is consistent with the
3245 reported clock. That way, files are not considered to be in the
3246 future merely because their time stamps have higher resolution
3247 than the clock resolution. */
3249 #if HAVE_GETTIMEOFDAY
3251 struct timeval timeval;
3252 gettimeofday (&timeval, NULL);
3253 current_time = timeval.tv_sec;
3254 current_time_ns = timeval.tv_usec * 1000 + 999;
3257 current_time = time (NULL);
3258 current_time_ns = 999999999;
3262 /* Print the user or group name NAME, with numeric id ID, using a
3263 print width of WIDTH columns. */
3266 format_user_or_group (char const *name, unsigned long int id, int width)
3272 int width_gap = width - mbswidth (name, 0);
3273 int pad = MAX (0, width_gap);
3274 fputs (name, stdout);
3275 len = strlen (name) + pad;
3283 printf ("%*lu ", width, id);
3287 dired_pos += len + 1;
3290 /* Print the name or id of the user with id U, using a print width of
3294 format_user (uid_t u, int width, bool stat_ok)
3296 format_user_or_group (! stat_ok ? "?" :
3297 (numeric_ids ? NULL : getuser (u)), u, width);
3300 /* Likewise, for groups. */
3303 format_group (gid_t g, int width, bool stat_ok)
3305 format_user_or_group (! stat_ok ? "?" :
3306 (numeric_ids ? NULL : getgroup (g)), g, width);
3309 /* Return the number of columns that format_user_or_group will print. */
3312 format_user_or_group_width (char const *name, unsigned long int id)
3316 int len = mbswidth (name, 0);
3317 return MAX (0, len);
3321 char buf[INT_BUFSIZE_BOUND (unsigned long int)];
3322 sprintf (buf, "%lu", id);
3323 return strlen (buf);
3327 /* Return the number of columns that format_user will print. */
3330 format_user_width (uid_t u)
3332 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3335 /* Likewise, for groups. */
3338 format_group_width (gid_t g)
3340 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3344 /* Print information about F in long format. */
3347 print_long_format (const struct fileinfo *f)
3351 [LONGEST_HUMAN_READABLE + 1 /* inode */
3352 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3353 + sizeof (modebuf) - 1 + 1 /* mode string */
3354 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3355 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3356 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3357 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3363 struct timespec when_timespec;
3364 struct tm *when_local;
3366 /* Compute the mode string, except remove the trailing space if no
3367 files in this directory have ACLs. */
3369 filemodestring (&f->stat, modebuf);
3372 modebuf[0] = filetype_letter[f->filetype];
3373 memset (modebuf + 1, '?', 10);
3378 else if (FILE_HAS_ACL (f))
3384 when_timespec = get_stat_ctime (&f->stat);
3387 when_timespec = get_stat_mtime (&f->stat);
3390 when_timespec = get_stat_atime (&f->stat);
3396 when = when_timespec.tv_sec;
3397 when_ns = when_timespec.tv_nsec;
3403 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3404 sprintf (p, "%*s ", inode_number_width,
3405 (f->stat.st_ino == NOT_AN_INODE_NUMBER
3407 : umaxtostr (f->stat.st_ino, hbuf)));
3408 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3409 The latter is wrong when inode_number_width is zero. */
3413 if (print_block_size)
3415 char hbuf[LONGEST_HUMAN_READABLE + 1];
3416 char const *blocks =
3419 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3420 ST_NBLOCKSIZE, output_block_size));
3422 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3424 while ((*p++ = *blocks++))
3429 /* The last byte of the mode string is the POSIX
3430 "optional alternate access method flag". */
3432 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3433 sprintf (p, "%s %*s ", modebuf, nlink_width,
3434 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3436 /* Increment by strlen (p) here, rather than by, e.g.,
3437 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3438 The latter is wrong when nlink_width is zero. */
3443 if (print_owner | print_group | print_author)
3445 DIRED_FPUTS (buf, stdout, p - buf);
3448 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3451 format_group (f->stat.st_gid, group_width, f->stat_ok);
3454 format_user (f->stat.st_author, author_width, f->stat_ok);
3460 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3462 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3463 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3464 int blanks_width = (file_size_width
3465 - (major_device_number_width + 2
3466 + minor_device_number_width));
3467 sprintf (p, "%*s, %*s ",
3468 major_device_number_width + MAX (0, blanks_width),
3469 umaxtostr (major (f->stat.st_rdev), majorbuf),
3470 minor_device_number_width,
3471 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3472 p += file_size_width + 1;
3476 char hbuf[LONGEST_HUMAN_READABLE + 1];
3480 : human_readable (unsigned_file_size (f->stat.st_size),
3481 hbuf, human_output_opts, 1, file_output_block_size));
3483 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3485 while ((*p++ = *size++))
3490 when_local = localtime (&when_timespec.tv_sec);
3494 if (f->stat_ok && when_local)
3496 time_t six_months_ago;
3500 /* If the file appears to be in the future, update the current
3501 time, in case the file happens to have been modified since
3502 the last time we checked the clock. */
3503 if (current_time < when
3504 || (current_time == when && current_time_ns < when_ns))
3506 /* Note that get_current_time calls gettimeofday which, on some non-
3507 compliant systems, clobbers the buffer used for localtime's result.
3508 But it's ok here, because we use a gettimeofday wrapper that
3509 saves and restores the buffer around the gettimeofday call. */
3510 get_current_time ();
3513 /* Consider a time to be recent if it is within the past six
3514 months. A Gregorian year has 365.2425 * 24 * 60 * 60 ==
3515 31556952 seconds on the average. Write this value as an
3516 integer constant to avoid floating point hassles. */
3517 six_months_ago = current_time - 31556952 / 2;
3518 recent = (six_months_ago <= when
3519 && (when < current_time
3520 || (when == current_time && when_ns <= current_time_ns)));
3521 fmt = long_time_format[recent];
3523 s = nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
3524 when_local, 0, when_ns);
3532 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
3537 /* The time cannot be converted using the desired format, so
3538 print it as a huge integer number of seconds. */
3539 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
3540 sprintf (p, "%*s ", long_time_expected_width (),
3543 : (TYPE_SIGNED (time_t)
3544 ? imaxtostr (when, hbuf)
3545 : umaxtostr (when, hbuf))));
3549 DIRED_FPUTS (buf, stdout, p - buf);
3550 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3551 f->stat_ok, f->filetype, &dired_obstack);
3553 if (f->filetype == symbolic_link)
3557 DIRED_FPUTS_LITERAL (" -> ", stdout);
3558 print_name_with_quoting (f->linkname, f->linkmode, f->linkok - 1,
3559 f->stat_ok, f->filetype, NULL);
3560 if (indicator_style != none)
3561 print_type_indicator (true, f->linkmode, unknown);
3564 else if (indicator_style != none)
3565 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3568 /* Output to OUT a quoted representation of the file name NAME,
3569 using OPTIONS to control quoting. Produce no output if OUT is NULL.
3570 Store the number of screen columns occupied by NAME's quoted
3571 representation into WIDTH, if non-NULL. Return the number of bytes
3575 quote_name (FILE *out, const char *name, struct quoting_options const *options,
3578 char smallbuf[BUFSIZ];
3579 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
3581 size_t displayed_width IF_LINT (= 0);
3583 if (len < sizeof smallbuf)
3587 buf = alloca (len + 1);
3588 quotearg_buffer (buf, len + 1, name, -1, options);
3591 if (qmark_funny_chars)
3596 char const *p = buf;
3597 char const *plimit = buf + len;
3599 displayed_width = 0;
3604 case ' ': case '!': case '"': case '#': case '%':
3605 case '&': case '\'': case '(': case ')': case '*':
3606 case '+': case ',': case '-': case '.': case '/':
3607 case '0': case '1': case '2': case '3': case '4':
3608 case '5': case '6': case '7': case '8': case '9':
3609 case ':': case ';': case '<': case '=': case '>':
3611 case 'A': case 'B': case 'C': case 'D': case 'E':
3612 case 'F': case 'G': case 'H': case 'I': case 'J':
3613 case 'K': case 'L': case 'M': case 'N': case 'O':
3614 case 'P': case 'Q': case 'R': case 'S': case 'T':
3615 case 'U': case 'V': case 'W': case 'X': case 'Y':
3617 case '[': case '\\': case ']': case '^': case '_':
3618 case 'a': case 'b': case 'c': case 'd': case 'e':
3619 case 'f': case 'g': case 'h': case 'i': case 'j':
3620 case 'k': case 'l': case 'm': case 'n': case 'o':
3621 case 'p': case 'q': case 'r': case 's': case 't':
3622 case 'u': case 'v': case 'w': case 'x': case 'y':
3623 case 'z': case '{': case '|': case '}': case '~':
3624 /* These characters are printable ASCII characters. */
3626 displayed_width += 1;
3629 /* If we have a multibyte sequence, copy it until we
3630 reach its end, replacing each non-printable multibyte
3631 character with a single question mark. */
3634 memset (&mbstate, 0, sizeof mbstate);
3641 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
3643 if (bytes == (size_t) -1)
3645 /* An invalid multibyte sequence was
3646 encountered. Skip one input byte, and
3647 put a question mark. */
3650 displayed_width += 1;
3654 if (bytes == (size_t) -2)
3656 /* An incomplete multibyte character
3657 at the end. Replace it entirely with
3661 displayed_width += 1;
3666 /* A null wide character was encountered. */
3672 /* A printable multibyte character.
3674 for (; bytes > 0; --bytes)
3676 displayed_width += w;
3680 /* An unprintable multibyte character.
3681 Replace it entirely with a question
3685 displayed_width += 1;
3688 while (! mbsinit (&mbstate));
3693 /* The buffer may have shrunk. */
3700 char const *plimit = buf + len;
3704 if (! isprint (to_uchar (*p)))
3708 displayed_width = len;
3711 else if (width != NULL)
3715 displayed_width = mbsnwidth (buf, len, 0);
3719 char const *p = buf;
3720 char const *plimit = buf + len;
3722 displayed_width = 0;
3725 if (isprint (to_uchar (*p)))
3733 fwrite (buf, 1, len, out);
3735 *width = displayed_width;
3740 print_name_with_quoting (const char *p, mode_t mode, int linkok,
3741 bool stat_ok, enum filetype type,
3742 struct obstack *stack)
3744 if (print_with_color)
3745 print_color_indicator (p, mode, linkok, stat_ok, type);
3748 PUSH_CURRENT_DIRED_POS (stack);
3750 dired_pos += quote_name (stdout, p, filename_quoting_options, NULL);
3753 PUSH_CURRENT_DIRED_POS (stack);
3755 if (print_with_color)
3758 prep_non_filename_text ();
3763 prep_non_filename_text (void)
3765 if (color_indicator[C_END].string != NULL)
3766 put_indicator (&color_indicator[C_END]);
3769 put_indicator (&color_indicator[C_LEFT]);
3770 put_indicator (&color_indicator[C_NORM]);
3771 put_indicator (&color_indicator[C_RIGHT]);
3775 /* Print the file name of `f' with appropriate quoting.
3776 Also print file size, inode number, and filetype indicator character,
3777 as requested by switches. */
3780 print_file_name_and_frills (const struct fileinfo *f)
3782 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
3785 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
3786 umaxtostr (f->stat.st_ino, buf));
3788 if (print_block_size)
3789 printf ("%*s ", format == with_commas ? 0 : block_size_width,
3790 human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
3791 ST_NBLOCKSIZE, output_block_size));
3793 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3794 f->stat_ok, f->filetype, NULL);
3796 if (indicator_style != none)
3797 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3801 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3805 if (stat_ok ? S_ISREG (mode) : type == normal)
3807 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
3814 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
3816 else if (indicator_style == slash)
3818 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
3820 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
3822 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
3824 else if (stat_ok && S_ISDOOR (mode))
3835 print_color_indicator (const char *name, mode_t mode, int linkok,
3836 bool stat_ok, enum filetype filetype)
3839 struct color_ext_type *ext; /* Color extension */
3840 size_t len; /* Length of name */
3842 /* Is this a nonexistent file? If so, linkok == -1. */
3844 if (linkok == -1 && color_indicator[C_MISSING].string != NULL)
3848 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
3849 type = filetype_indicator[filetype];
3856 if ((mode & S_ISUID) != 0)
3858 else if ((mode & S_ISGID) != 0)
3860 else if ((mode & S_IXUGO) != 0)
3863 else if (S_ISDIR (mode))
3865 if ((mode & S_ISVTX) && (mode & S_IWOTH))
3866 type = C_STICKY_OTHER_WRITABLE;
3867 else if ((mode & S_IWOTH) != 0)
3868 type = C_OTHER_WRITABLE;
3869 else if ((mode & S_ISVTX) != 0)
3874 else if (S_ISLNK (mode))
3875 type = ((!linkok && color_indicator[C_ORPHAN].string)
3876 ? C_ORPHAN : C_LINK);
3877 else if (S_ISFIFO (mode))
3879 else if (S_ISSOCK (mode))
3881 else if (S_ISBLK (mode))
3883 else if (S_ISCHR (mode))
3885 else if (S_ISDOOR (mode))
3889 /* Classify a file of some other type as C_ORPHAN. */
3894 /* Check the file's suffix only if still classified as C_FILE. */
3898 /* Test if NAME has a recognized suffix. */
3900 len = strlen (name);
3901 name += len; /* Pointer to final \0. */
3902 for (ext = color_ext_list; ext != NULL; ext = ext->next)
3904 if (ext->ext.len <= len
3905 && strncmp (name - ext->ext.len, ext->ext.string,
3911 put_indicator (&color_indicator[C_LEFT]);
3912 put_indicator (ext ? &(ext->seq) : &color_indicator[type]);
3913 put_indicator (&color_indicator[C_RIGHT]);
3916 /* Output a color indicator (which may contain nulls). */
3918 put_indicator (const struct bin_str *ind)
3925 for (i = ind->len; i != 0; --i)
3930 length_of_file_name_and_frills (const struct fileinfo *f)
3934 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
3937 len += 1 + (format == with_commas
3938 ? strlen (umaxtostr (f->stat.st_ino, buf))
3939 : inode_number_width);
3941 if (print_block_size)
3942 len += 1 + (format == with_commas
3943 ? strlen (human_readable (ST_NBLOCKS (f->stat), buf,
3944 human_output_opts, ST_NBLOCKSIZE,
3946 : block_size_width);
3948 quote_name (NULL, f->name, filename_quoting_options, &name_width);
3951 if (indicator_style != none)
3953 mode_t mode = f->stat.st_mode;
3955 len += (S_ISREG (mode)
3956 ? (indicator_style == classify && (mode & S_IXUGO))
3958 || (indicator_style != slash
3962 || S_ISDOOR (mode)))));
3969 print_many_per_line (void)
3971 size_t row; /* Current row. */
3972 size_t cols = calculate_columns (true);
3973 struct column_info const *line_fmt = &column_info[cols - 1];
3975 /* Calculate the number of rows that will be in each column except possibly
3976 for a short column on the right. */
3977 size_t rows = files_index / cols + (files_index % cols != 0);
3979 for (row = 0; row < rows; row++)
3982 size_t filesno = row;
3985 /* Print the next row. */
3988 size_t name_length = length_of_file_name_and_frills (files + filesno);
3989 size_t max_name_length = line_fmt->col_arr[col++];
3990 print_file_name_and_frills (files + filesno);
3993 if (filesno >= files_index)
3996 indent (pos + name_length, pos + max_name_length);
3997 pos += max_name_length;
4004 print_horizontal (void)
4008 size_t cols = calculate_columns (false);
4009 struct column_info const *line_fmt = &column_info[cols - 1];
4010 size_t name_length = length_of_file_name_and_frills (files);
4011 size_t max_name_length = line_fmt->col_arr[0];
4013 /* Print first entry. */
4014 print_file_name_and_frills (files);
4017 for (filesno = 1; filesno < files_index; ++filesno)
4019 size_t col = filesno % cols;
4028 indent (pos + name_length, pos + max_name_length);
4029 pos += max_name_length;
4032 print_file_name_and_frills (files + filesno);
4034 name_length = length_of_file_name_and_frills (files + filesno);
4035 max_name_length = line_fmt->col_arr[col];
4041 print_with_commas (void)
4046 for (filesno = 0; filesno < files_index; filesno++)
4048 size_t len = length_of_file_name_and_frills (files + filesno);
4054 if (pos + len + 2 < line_length)
4066 putchar (separator);
4069 print_file_name_and_frills (files + filesno);
4075 /* Assuming cursor is at position FROM, indent up to position TO.
4076 Use a TAB character instead of two or more spaces whenever possible. */
4079 indent (size_t from, size_t to)
4083 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4086 from += tabsize - from % tabsize;
4096 /* Put DIRNAME/NAME into DEST, handling `.' and `/' properly. */
4097 /* FIXME: maybe remove this function someday. See about using a
4098 non-malloc'ing version of file_name_concat. */
4101 attach (char *dest, const char *dirname, const char *name)
4103 const char *dirnamep = dirname;
4105 /* Copy dirname if it is not ".". */
4106 if (dirname[0] != '.' || dirname[1] != 0)
4109 *dest++ = *dirnamep++;
4110 /* Add '/' if `dirname' doesn't already end with it. */
4111 if (dirnamep > dirname && dirnamep[-1] != '/')
4119 /* Allocate enough column info suitable for the current number of
4120 files and display columns, and initialize the info to represent the
4121 narrowest possible columns. */
4124 init_column_info (void)
4127 size_t max_cols = MIN (max_idx, files_index);
4129 /* Currently allocated columns in column_info. */
4130 static size_t column_info_alloc;
4132 if (column_info_alloc < max_cols)
4134 size_t new_column_info_alloc;
4137 if (max_cols < max_idx / 2)
4139 /* The number of columns is far less than the display width
4140 allows. Grow the allocation, but only so that it's
4141 double the current requirements. If the display is
4142 extremely wide, this avoids allocating a lot of memory
4143 that is never needed. */
4144 column_info = xnrealloc (column_info, max_cols,
4145 2 * sizeof *column_info);
4146 new_column_info_alloc = 2 * max_cols;
4150 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4151 new_column_info_alloc = max_idx;
4154 /* Allocate the new size_t objects by computing the triangle
4155 formula n * (n + 1) / 2, except that we don't need to
4156 allocate the part of the triangle that we've already
4157 allocated. Check for address arithmetic overflow. */
4159 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4160 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4161 size_t t = s * column_info_growth;
4162 if (s < new_column_info_alloc || t / column_info_growth != s)
4164 p = xnmalloc (t / 2, sizeof *p);
4167 /* Grow the triangle by parceling out the cells just allocated. */
4168 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4170 column_info[i].col_arr = p;
4174 column_info_alloc = new_column_info_alloc;
4177 for (i = 0; i < max_cols; ++i)
4181 column_info[i].valid_len = true;
4182 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4183 for (j = 0; j <= i; ++j)
4184 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4188 /* Calculate the number of columns needed to represent the current set
4189 of files in the current display width. */
4192 calculate_columns (bool by_columns)
4194 size_t filesno; /* Index into files. */
4195 size_t cols; /* Number of files across. */
4197 /* Normally the maximum number of columns is determined by the
4198 screen width. But if few files are available this might limit it
4200 size_t max_cols = MIN (max_idx, files_index);
4202 init_column_info ();
4204 /* Compute the maximum number of possible columns. */
4205 for (filesno = 0; filesno < files_index; ++filesno)
4207 size_t name_length = length_of_file_name_and_frills (files + filesno);
4210 for (i = 0; i < max_cols; ++i)
4212 if (column_info[i].valid_len)
4214 size_t idx = (by_columns
4215 ? filesno / ((files_index + i) / (i + 1))
4216 : filesno % (i + 1));
4217 size_t real_length = name_length + (idx == i ? 0 : 2);
4219 if (column_info[i].col_arr[idx] < real_length)
4221 column_info[i].line_len += (real_length
4222 - column_info[i].col_arr[idx]);
4223 column_info[i].col_arr[idx] = real_length;
4224 column_info[i].valid_len = (column_info[i].line_len
4231 /* Find maximum allowed columns. */
4232 for (cols = max_cols; 1 < cols; --cols)
4234 if (column_info[cols - 1].valid_len)
4244 if (status != EXIT_SUCCESS)
4245 fprintf (stderr, _("Try `%s --help' for more information.\n"),
4249 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4251 List information about the FILEs (the current directory by default).\n\
4252 Sort entries alphabetically if none of -cftuvSUX nor --sort.\n\
4256 Mandatory arguments to long options are mandatory for short options too.\n\
4259 -a, --all do not ignore entries starting with .\n\
4260 -A, --almost-all do not list implied . and ..\n\
4261 --author with -l, print the author of each file\n\
4262 -b, --escape print octal escapes for nongraphic characters\n\
4265 --block-size=SIZE use SIZE-byte blocks\n\
4266 -B, --ignore-backups do not list implied entries ending with ~\n\
4267 -c with -lt: sort by, and show, ctime (time of last\n\
4268 modification of file status information)\n\
4269 with -l: show ctime and sort by name\n\
4270 otherwise: sort by ctime\n\
4273 -C list entries by columns\n\
4274 --color[=WHEN] control whether color is used to distinguish file\n\
4275 types. WHEN may be `never', `always', or `auto'\n\
4276 -d, --directory list directory entries instead of contents,\n\
4277 and do not dereference symbolic links\n\
4278 -D, --dired generate output designed for Emacs' dired mode\n\
4281 -f do not sort, enable -aU, disable -ls --color\n\
4282 -F, --classify append indicator (one of */=>@|) to entries\n\
4283 --file-type likewise, except do not append `*'\n\
4284 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4285 single-column -1, verbose -l, vertical -C\n\
4286 --full-time like -l --time-style=full-iso\n\
4289 -g like -l, but do not list owner\n\
4292 --group-directories-first\n\
4293 group directories before files\n\
4296 -G, --no-group in a long listing, don't print group names\n\
4297 -h, --human-readable with -l, print sizes in human readable format\n\
4298 (e.g., 1K 234M 2G)\n\
4299 --si likewise, but use powers of 1000 not 1024\n\
4300 -H, --dereference-command-line\n\
4301 follow symbolic links listed on the command line\n\
4302 --dereference-command-line-symlink-to-dir\n\
4303 follow each command line symbolic link\n\
4304 that points to a directory\n\
4305 --hide=PATTERN do not list implied entries matching shell PATTERN\n\
4306 (overridden by -a or -A)\n\
4309 --indicator-style=WORD append indicator with style WORD to entry names:\n\
4310 none (default), slash (-p),\n\
4311 file-type (--file-type), classify (-F)\n\
4312 -i, --inode print the index number of each file\n\
4313 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\n\
4314 -k like --block-size=1K\n\
4317 -l use a long listing format\n\
4318 -L, --dereference when showing file information for a symbolic\n\
4319 link, show information for the file the link\n\
4320 references rather than for the link itself\n\
4321 -m fill width with a comma separated list of entries\n\
4324 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4325 -N, --literal print raw entry names (don't treat e.g. control\n\
4326 characters specially)\n\
4327 -o like -l, but do not list group information\n\
4328 -p, --indicator-style=slash\n\
4329 append / indicator to directories\n\
4332 -q, --hide-control-chars print ? instead of non graphic characters\n\
4333 --show-control-chars show non graphic characters as-is (default\n\
4334 unless program is `ls' and output is a terminal)\n\
4335 -Q, --quote-name enclose entry names in double quotes\n\
4336 --quoting-style=WORD use quoting style WORD for entry names:\n\
4337 literal, locale, shell, shell-always, c, escape\n\
4340 -r, --reverse reverse order while sorting\n\
4341 -R, --recursive list subdirectories recursively\n\
4342 -s, --size with -l, print size of each file, in blocks\n\
4345 -S sort by file size\n\
4346 --sort=WORD sort by WORD instead of name: none -U,\n\
4347 extension -X, size -S, time -t, version -v\n\
4348 --time=WORD with -l, show time as WORD instead of modification\n\
4349 time: atime -u, access -u, use -u, ctime -c,\n\
4350 or status -c; use specified time as sort key\n\
4354 --time-style=STYLE with -l, show times using style STYLE:\n\
4355 full-iso, long-iso, iso, locale, +FORMAT.\n\
4356 FORMAT is interpreted like `date'; if FORMAT is\n\
4357 FORMAT1<newline>FORMAT2, FORMAT1 applies to\n\
4358 non-recent files and FORMAT2 to recent files;\n\
4359 if STYLE is prefixed with `posix-', STYLE\n\
4360 takes effect only outside the POSIX locale\n\
4361 -t sort by modification time\n\
4362 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4365 -u with -lt: sort by, and show, access time\n\
4366 with -l: show access time and sort by name\n\
4367 otherwise: sort by access time\n\
4368 -U do not sort; list entries in directory order\n\
4369 -v sort by version\n\
4372 -w, --width=COLS assume screen width instead of current value\n\
4373 -x list entries by lines instead of by columns\n\
4374 -X sort alphabetically by entry extension\n\
4375 -1 list one file per line\n\
4377 fputs (HELP_OPTION_DESCRIPTION, stdout);
4378 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4380 SIZE may be (or may be an integer optionally followed by) one of following:\n\
4381 kB 1000, K 1024, MB 1000*1000, M 1024*1024, and so on for G, T, P, E, Z, Y.\n\
4385 By default, color is not used to distinguish types of files. That is\n\
4386 equivalent to using --color=none. Using the --color option without the\n\
4387 optional WHEN argument is equivalent to using --color=always. With\n\
4388 --color=auto, color codes are output only if standard output is connected\n\
4389 to a terminal (tty). The environment variable LS_COLORS can influence the\n\
4390 colors, and can be set easily by the dircolors command.\n\
4394 Exit status is 0 if OK, 1 if minor problems, 2 if serious trouble.\n\
4396 printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);