1 /* `dir', `vdir' and `ls' directory listing programs for GNU.
2 Copyright (C) 85, 88, 90, 91, 1995-2007 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* If ls_mode is LS_MULTI_COL,
18 the multi-column format is the default regardless
19 of the type of output device.
20 This is for the `dir' program.
22 If ls_mode is LS_LONG_FORMAT,
23 the long format is the default regardless of the
24 type of output device.
25 This is for the `vdir' program.
28 the output format depends on whether the output
30 This is for the `ls' program. */
32 /* Written by Richard Stallman and David MacKenzie. */
34 /* Color support by Peter Anvin <Peter.Anvin@linux.org> and Dennis
35 Flaherty <dennisf@denix.elk.miles.com> based on original patches by
36 Greg Lee <lee@uhunix.uhcc.hawaii.edu>. */
39 #include <sys/types.h>
48 # include <sys/ioctl.h>
51 #ifdef WINSIZE_IN_PTEM
52 # include <sys/stream.h>
53 # include <sys/ptem.h>
63 #include <selinux/selinux.h>
66 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
69 # define SA_NOCLDSTOP 0
70 # define sigprocmask(How, Set, Oset) /* empty */
72 # if ! HAVE_SIGINTERRUPT
73 # define siginterrupt(sig, flag) /* empty */
88 #include "filenamecat.h"
89 #include "hard-locale.h"
101 #include "quotearg.h"
103 #include "stat-time.h"
104 #include "strftime.h"
105 #include "strverscmp.h"
107 #include "areadlink.h"
109 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
110 : (ls_mode == LS_MULTI_COL \
113 #define AUTHORS "Richard Stallman", "David MacKenzie"
115 #define obstack_chunk_alloc malloc
116 #define obstack_chunk_free free
118 /* Return an int indicating the result of comparing two integers.
119 Subtracting doesn't always work, due to overflow. */
120 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
122 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
123 # define st_author st_uid
140 /* Display letters and indicators for each filetype.
141 Keep these in sync with enum filetype. */
142 static char const filetype_letter[] = "?pcdb-lswd";
144 /* Ensure that filetype and filetype_letter have the same
145 number of elements. */
146 verify (sizeof filetype_letter - 1 == arg_directory + 1);
148 #define FILETYPE_INDICATORS \
150 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
151 C_LINK, C_SOCK, C_FILE, C_DIR \
160 /* For symbolic link, name of the file linked to, otherwise zero. */
165 enum filetype filetype;
167 /* For symbolic link and long listing, st_mode of file linked to, otherwise
171 /* SELinux security context. */
172 security_context_t scontext;
176 /* For symbolic link and color printing, true if linked-to file
177 exists, otherwise false. */
180 /* For long listings, true if the file has an access control list,
181 or an SELinux security context. */
185 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
187 /* Null is a valid character in a color indicator (think about Epson
188 printers, for example) so we have to use a length/buffer string
193 size_t len; /* Number of bytes */
194 const char *string; /* Pointer to the same */
198 # define tcgetpgrp(Fd) 0
201 static size_t quote_name (FILE *out, const char *name,
202 struct quoting_options const *options,
204 static char *make_link_name (char const *name, char const *linkname);
205 static int decode_switches (int argc, char **argv);
206 static bool file_ignored (char const *name);
207 static uintmax_t gobble_file (char const *name, enum filetype type,
208 ino_t inode, bool command_line_arg,
209 char const *dirname);
210 static void print_color_indicator (const char *name, mode_t mode, int linkok,
211 bool stat_ok, enum filetype type);
212 static void put_indicator (const struct bin_str *ind);
213 static void add_ignore_pattern (const char *pattern);
214 static void attach (char *dest, const char *dirname, const char *name);
215 static void clear_files (void);
216 static void extract_dirs_from_files (char const *dirname,
217 bool command_line_arg);
218 static void get_link_name (char const *filename, struct fileinfo *f,
219 bool command_line_arg);
220 static void indent (size_t from, size_t to);
221 static size_t calculate_columns (bool by_columns);
222 static void print_current_files (void);
223 static void print_dir (char const *name, char const *realname,
224 bool command_line_arg);
225 static void print_file_name_and_frills (const struct fileinfo *f);
226 static void print_horizontal (void);
227 static int format_user_width (uid_t u);
228 static int format_group_width (gid_t g);
229 static void print_long_format (const struct fileinfo *f);
230 static void print_many_per_line (void);
231 static void print_name_with_quoting (const char *p, mode_t mode,
232 int linkok, bool stat_ok,
234 struct obstack *stack);
235 static void prep_non_filename_text (void);
236 static void print_type_indicator (bool stat_ok, mode_t mode,
238 static void print_with_commas (void);
239 static void queue_directory (char const *name, char const *realname,
240 bool command_line_arg);
241 static void sort_files (void);
242 static void parse_ls_color (void);
243 void usage (int status);
245 /* The name this program was run with. */
248 /* Initial size of hash table.
249 Most hierarchies are likely to be shallower than this. */
250 #define INITIAL_TABLE_SIZE 30
252 /* The set of `active' directories, from the current command-line argument
253 to the level in the hierarchy at which files are being listed.
254 A directory is represented by its device and inode numbers (struct dev_ino).
255 A directory is added to this set when ls begins listing it or its
256 entries, and it is removed from the set just after ls has finished
257 processing it. This set is used solely to detect loops, e.g., with
258 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
259 static Hash_table *active_dir_set;
261 #define LOOP_DETECT (!!active_dir_set)
263 /* The table of files in the current directory:
265 `cwd_file' points to a vector of `struct fileinfo', one per file.
266 `cwd_n_alloc' is the number of elements space has been allocated for.
267 `cwd_n_used' is the number actually in use. */
269 /* Address of block containing the files that are described. */
270 static struct fileinfo *cwd_file;
272 /* Length of block that `cwd_file' points to, measured in files. */
273 static size_t cwd_n_alloc;
275 /* Index of first unused slot in `cwd_file'. */
276 static size_t cwd_n_used;
278 /* Vector of pointers to files, in proper sorted order, and the number
279 of entries allocated for it. */
280 static void **sorted_file;
281 static size_t sorted_file_alloc;
283 /* When true, in a color listing, color each symlink name according to the
284 type of file it points to. Otherwise, color them according to the `ln'
285 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
286 regardless. This is set when `ln=target' appears in LS_COLORS. */
288 static bool color_symlink_as_referent;
290 /* mode of appropriate file for colorization */
291 #define FILE_OR_LINK_MODE(File) \
292 ((color_symlink_as_referent & (File)->linkok) \
293 ? (File)->linkmode : (File)->stat.st_mode)
296 /* Record of one pending directory waiting to be listed. */
301 /* If the directory is actually the file pointed to by a symbolic link we
302 were told to list, `realname' will contain the name of the symbolic
303 link, otherwise zero. */
305 bool command_line_arg;
306 struct pending *next;
309 static struct pending *pending_dirs;
311 /* Current time in seconds and nanoseconds since 1970, updated as
312 needed when deciding whether a file is recent. */
314 static time_t current_time = TYPE_MINIMUM (time_t);
315 static int current_time_ns = -1;
317 static bool print_scontext;
319 /* Whether any of the files has an ACL. This affects the width of the
322 static bool any_has_acl;
324 /* The number of columns to use for columns containing inode numbers,
325 block sizes, link counts, owners, groups, authors, major device
326 numbers, minor device numbers, and file sizes, respectively. */
328 static int inode_number_width;
329 static int block_size_width;
330 static int nlink_width;
331 static int scontext_width;
332 static int owner_width;
333 static int group_width;
334 static int author_width;
335 static int major_device_number_width;
336 static int minor_device_number_width;
337 static int file_size_width;
341 /* long_format for lots of info, one per line.
342 one_per_line for just names, one per line.
343 many_per_line for just names, many per line, sorted vertically.
344 horizontal for just names, many per line, sorted horizontally.
345 with_commas for just names, many per line, separated by commas.
347 -l (and other options that imply -l), -1, -C, -x and -m control
352 long_format, /* -l and other options that imply -l */
353 one_per_line, /* -1 */
354 many_per_line, /* -C */
359 static enum format format;
361 /* `full-iso' uses full ISO-style dates and times. `long-iso' uses longer
362 ISO-style time stamps, though shorter than `full-iso'. `iso' uses shorter
363 ISO-style time stamps. `locale' uses locale-dependent time stamps. */
366 full_iso_time_style, /* --time-style=full-iso */
367 long_iso_time_style, /* --time-style=long-iso */
368 iso_time_style, /* --time-style=iso */
369 locale_time_style /* --time-style=locale */
372 static char const *const time_style_args[] =
374 "full-iso", "long-iso", "iso", "locale", NULL
376 static enum time_style const time_style_types[] =
378 full_iso_time_style, long_iso_time_style, iso_time_style,
381 ARGMATCH_VERIFY (time_style_args, time_style_types);
383 /* Type of time to print or sort by. Controlled by -c and -u.
384 The values of each item of this enum are important since they are
385 used as indices in the sort functions array (see sort_files()). */
389 time_mtime, /* default */
392 time_numtypes /* the number of elements of this enum */
395 static enum time_type time_type;
397 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
398 The values of each item of this enum are important since they are
399 used as indices in the sort functions array (see sort_files()). */
403 sort_none = -1, /* -U */
404 sort_name, /* default */
405 sort_extension, /* -X */
407 sort_version, /* -v */
409 sort_numtypes /* the number of elements of this enum */
412 static enum sort_type sort_type;
414 /* Direction of sort.
415 false means highest first if numeric,
416 lowest first if alphabetic;
417 these are the defaults.
418 true means the opposite order in each case. -r */
420 static bool sort_reverse;
422 /* True means to display owner information. -g turns this off. */
424 static bool print_owner = true;
426 /* True means to display author information. */
428 static bool print_author;
430 /* True means to display group information. -G and -o turn this off. */
432 static bool print_group = true;
434 /* True means print the user and group id's as numbers rather
437 static bool numeric_ids;
439 /* True means mention the size in blocks of each file. -s */
441 static bool print_block_size;
443 /* Human-readable options for output. */
444 static int human_output_opts;
446 /* The units to use when printing sizes other than file sizes. */
447 static uintmax_t output_block_size;
449 /* Likewise, but for file sizes. */
450 static uintmax_t file_output_block_size = 1;
452 /* Follow the output with a special string. Using this format,
453 Emacs' dired mode starts up twice as fast, and can handle all
454 strange characters in file names. */
457 /* `none' means don't mention the type of files.
458 `slash' means mention directories only, with a '/'.
459 `file_type' means mention file types.
460 `classify' means mention file types and mark executables.
462 Controlled by -F, -p, and --indicator-style. */
466 none, /* --indicator-style=none */
467 slash, /* -p, --indicator-style=slash */
468 file_type, /* --indicator-style=file-type */
469 classify /* -F, --indicator-style=classify */
472 static enum indicator_style indicator_style;
474 /* Names of indicator styles. */
475 static char const *const indicator_style_args[] =
477 "none", "slash", "file-type", "classify", NULL
479 static enum indicator_style const indicator_style_types[] =
481 none, slash, file_type, classify
483 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
485 /* True means use colors to mark types. Also define the different
486 colors as well as the stuff for the LS_COLORS environment variable.
487 The LS_COLORS variable is now in a termcap-like format. */
489 static bool print_with_color;
493 color_never, /* 0: default or --color=never */
494 color_always, /* 1: --color=always */
495 color_if_tty /* 2: --color=tty */
498 enum Dereference_symlink
502 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
503 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
504 DEREF_ALWAYS /* -L */
509 C_LEFT, C_RIGHT, C_END, C_NORM, C_FILE, C_DIR, C_LINK, C_FIFO, C_SOCK,
510 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
511 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE
514 static const char *const indicator_name[]=
516 "lc", "rc", "ec", "no", "fi", "di", "ln", "pi", "so",
517 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
521 struct color_ext_type
523 struct bin_str ext; /* The extension we're looking for */
524 struct bin_str seq; /* The sequence to output when we do */
525 struct color_ext_type *next; /* Next in list */
528 static struct bin_str color_indicator[] =
530 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
531 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
532 { 0, NULL }, /* ec: End color (replaces lc+no+rc) */
533 { LEN_STR_PAIR ("0") }, /* no: Normal */
534 { LEN_STR_PAIR ("0") }, /* fi: File: default */
535 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
536 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
537 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
538 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
539 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
540 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
541 { 0, NULL }, /* mi: Missing file: undefined */
542 { 0, NULL }, /* or: Orphaned symlink: undefined */
543 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
544 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
545 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
546 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
547 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
548 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
549 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
553 static struct color_ext_type *color_ext_list = NULL;
555 /* Buffer for color sequences */
556 static char *color_buf;
558 /* True means to check for orphaned symbolic link, for displaying
561 static bool check_symlink_color;
563 /* True means mention the inode number of each file. -i */
565 static bool print_inode;
567 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
568 other options that imply -l), and -L. */
570 static enum Dereference_symlink dereference;
572 /* True means when a directory is found, display info on its
575 static bool recursive;
577 /* True means when an argument is a directory name, display info
580 static bool immediate_dirs;
582 /* True means that directories are grouped before files. */
584 static bool directories_first;
586 /* Which files to ignore. */
590 /* Ignore files whose names start with `.', and files specified by
591 --hide and --ignore. */
594 /* Ignore `.', `..', and files specified by --ignore. */
595 IGNORE_DOT_AND_DOTDOT,
597 /* Ignore only files specified by --ignore. */
601 /* A linked list of shell-style globbing patterns. If a non-argument
602 file name matches any of these patterns, it is ignored.
603 Controlled by -I. Multiple -I options accumulate.
604 The -B option adds `*~' and `.*~' to this list. */
606 struct ignore_pattern
609 struct ignore_pattern *next;
612 static struct ignore_pattern *ignore_patterns;
614 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
615 variable itself to be ignored. */
616 static struct ignore_pattern *hide_patterns;
618 /* True means output nongraphic chars in file names as `?'.
619 (-q, --hide-control-chars)
620 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
621 independent. The algorithm is: first, obey the quoting style to get a
622 string representing the file name; then, if qmark_funny_chars is set,
623 replace all nonprintable chars in that string with `?'. It's necessary
624 to replace nonprintable chars even in quoted strings, because we don't
625 want to mess up the terminal if control chars get sent to it, and some
626 quoting methods pass through control chars as-is. */
627 static bool qmark_funny_chars;
629 /* Quoting options for file and dir name output. */
631 static struct quoting_options *filename_quoting_options;
632 static struct quoting_options *dirname_quoting_options;
634 /* The number of chars per hardware tab stop. Setting this to zero
635 inhibits the use of TAB characters for separating columns. -T */
636 static size_t tabsize;
638 /* True means print each directory name before listing it. */
640 static bool print_dir_name;
642 /* The line length to use for breaking lines in many-per-line format.
643 Can be set with -w. */
645 static size_t line_length;
647 /* If true, the file listing format requires that stat be called on
650 static bool format_needs_stat;
652 /* Similar to `format_needs_stat', but set if only the file type is
655 static bool format_needs_type;
657 /* An arbitrary limit on the number of bytes in a printed time stamp.
658 This is set to a relatively small value to avoid the need to worry
659 about denial-of-service attacks on servers that run "ls" on behalf
660 of remote clients. 1000 bytes should be enough for any practical
661 time stamp format. */
663 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
665 /* strftime formats for non-recent and recent files, respectively, in
668 static char const *long_time_format[2] =
670 /* strftime format for non-recent files (older than 6 months), in
671 -l output. This should contain the year, month and day (at
672 least), in an order that is understood by people in your
673 locale's territory. Please try to keep the number of used
674 screen columns small, because many people work in windows with
675 only 80 columns. But make this as wide as the other string
676 below, for recent files. */
678 /* strftime format for recent files (younger than 6 months), in -l
679 output. This should contain the month, day and time (at
680 least), in an order that is understood by people in your
681 locale's territory. Please try to keep the number of used
682 screen columns small, because many people work in windows with
683 only 80 columns. But make this as wide as the other string
684 above, for non-recent files. */
688 /* The set of signals that are caught. */
690 static sigset_t caught_signals;
692 /* If nonzero, the value of the pending fatal signal. */
694 static sig_atomic_t volatile interrupt_signal;
696 /* A count of the number of pending stop signals that have been received. */
698 static sig_atomic_t volatile stop_signal_count;
700 /* Desired exit status. */
702 static int exit_status;
707 /* "ls" had a minor problem (e.g., it could not stat a directory
709 LS_MINOR_PROBLEM = 1,
711 /* "ls" had more serious trouble. */
715 /* For long options that have no equivalent short option, use a
716 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
719 AUTHOR_OPTION = CHAR_MAX + 1,
722 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
723 FILE_TYPE_INDICATOR_OPTION,
726 GROUP_DIRECTORIES_FIRST_OPTION,
728 INDICATOR_STYLE_OPTION,
729 QUOTING_STYLE_OPTION,
730 SHOW_CONTROL_CHARS_OPTION,
737 static struct option const long_options[] =
739 {"all", no_argument, NULL, 'a'},
740 {"escape", no_argument, NULL, 'b'},
741 {"directory", no_argument, NULL, 'd'},
742 {"dired", no_argument, NULL, 'D'},
743 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
744 {"group-directories-first", no_argument, NULL,
745 GROUP_DIRECTORIES_FIRST_OPTION},
746 {"human-readable", no_argument, NULL, 'h'},
747 {"inode", no_argument, NULL, 'i'},
748 {"numeric-uid-gid", no_argument, NULL, 'n'},
749 {"no-group", no_argument, NULL, 'G'},
750 {"hide-control-chars", no_argument, NULL, 'q'},
751 {"reverse", no_argument, NULL, 'r'},
752 {"size", no_argument, NULL, 's'},
753 {"width", required_argument, NULL, 'w'},
754 {"almost-all", no_argument, NULL, 'A'},
755 {"ignore-backups", no_argument, NULL, 'B'},
756 {"classify", no_argument, NULL, 'F'},
757 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
758 {"si", no_argument, NULL, SI_OPTION},
759 {"dereference-command-line", no_argument, NULL, 'H'},
760 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
761 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
762 {"hide", required_argument, NULL, HIDE_OPTION},
763 {"ignore", required_argument, NULL, 'I'},
764 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
765 {"dereference", no_argument, NULL, 'L'},
766 {"literal", no_argument, NULL, 'N'},
767 {"quote-name", no_argument, NULL, 'Q'},
768 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
769 {"recursive", no_argument, NULL, 'R'},
770 {"format", required_argument, NULL, FORMAT_OPTION},
771 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
772 {"sort", required_argument, NULL, SORT_OPTION},
773 {"tabsize", required_argument, NULL, 'T'},
774 {"time", required_argument, NULL, TIME_OPTION},
775 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
776 {"color", optional_argument, NULL, COLOR_OPTION},
777 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
778 {"context", no_argument, 0, 'Z'},
779 {"author", no_argument, NULL, AUTHOR_OPTION},
780 {GETOPT_HELP_OPTION_DECL},
781 {GETOPT_VERSION_OPTION_DECL},
785 static char const *const format_args[] =
787 "verbose", "long", "commas", "horizontal", "across",
788 "vertical", "single-column", NULL
790 static enum format const format_types[] =
792 long_format, long_format, with_commas, horizontal, horizontal,
793 many_per_line, one_per_line
795 ARGMATCH_VERIFY (format_args, format_types);
797 static char const *const sort_args[] =
799 "none", "time", "size", "extension", "version", NULL
801 static enum sort_type const sort_types[] =
803 sort_none, sort_time, sort_size, sort_extension, sort_version
805 ARGMATCH_VERIFY (sort_args, sort_types);
807 static char const *const time_args[] =
809 "atime", "access", "use", "ctime", "status", NULL
811 static enum time_type const time_types[] =
813 time_atime, time_atime, time_atime, time_ctime, time_ctime
815 ARGMATCH_VERIFY (time_args, time_types);
817 static char const *const color_args[] =
819 /* force and none are for compatibility with another color-ls version */
820 "always", "yes", "force",
821 "never", "no", "none",
822 "auto", "tty", "if-tty", NULL
824 static enum color_type const color_types[] =
826 color_always, color_always, color_always,
827 color_never, color_never, color_never,
828 color_if_tty, color_if_tty, color_if_tty
830 ARGMATCH_VERIFY (color_args, color_types);
832 /* Information about filling a column. */
840 /* Array with information about column filledness. */
841 static struct column_info *column_info;
843 /* Maximum number of columns ever possible for this display. */
844 static size_t max_idx;
846 /* The minimum width of a column is 3: 1 character for the name and 2
847 for the separating white space. */
848 #define MIN_COLUMN_WIDTH 3
851 /* This zero-based index is used solely with the --dired option.
852 When that option is in effect, this counter is incremented for each
853 byte of output generated by this program so that the beginning
854 and ending indices (in that output) of every file name can be recorded
855 and later output themselves. */
856 static size_t dired_pos;
858 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
860 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
861 #define DIRED_FPUTS(s, stream, s_len) \
862 do {fputs (s, stream); dired_pos += s_len;} while (0)
864 /* Like DIRED_FPUTS, but for use when S is a literal string. */
865 #define DIRED_FPUTS_LITERAL(s, stream) \
866 do {fputs (s, stream); dired_pos += sizeof (s) - 1;} while (0)
868 #define DIRED_INDENT() \
872 DIRED_FPUTS_LITERAL (" ", stdout); \
876 /* With --dired, store pairs of beginning and ending indices of filenames. */
877 static struct obstack dired_obstack;
879 /* With --dired, store pairs of beginning and ending indices of any
880 directory names that appear as headers (just before `total' line)
881 for lists of directory entries. Such directory names are seen when
882 listing hierarchies using -R and when a directory is listed with at
883 least one other command line argument. */
884 static struct obstack subdired_obstack;
886 /* Save the current index on the specified obstack, OBS. */
887 #define PUSH_CURRENT_DIRED_POS(obs) \
891 obstack_grow (obs, &dired_pos, sizeof (dired_pos)); \
895 /* With -R, this stack is used to help detect directory cycles.
896 The device/inode pairs on this stack mirror the pairs in the
897 active_dir_set hash table. */
898 static struct obstack dev_ino_obstack;
900 /* Push a pair onto the device/inode stack. */
901 #define DEV_INO_PUSH(Dev, Ino) \
904 struct dev_ino *di; \
905 obstack_blank (&dev_ino_obstack, sizeof (struct dev_ino)); \
906 di = -1 + (struct dev_ino *) obstack_next_free (&dev_ino_obstack); \
907 di->st_dev = (Dev); \
908 di->st_ino = (Ino); \
912 /* Pop a dev/ino struct off the global dev_ino_obstack
913 and return that struct. */
914 static struct dev_ino
917 assert (sizeof (struct dev_ino) <= obstack_object_size (&dev_ino_obstack));
918 obstack_blank (&dev_ino_obstack, -(int) (sizeof (struct dev_ino)));
919 return *(struct dev_ino *) obstack_next_free (&dev_ino_obstack);
922 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
927 assert (0 <= stat (Name, &sb)); \
928 assert (sb.st_dev == Di.st_dev); \
929 assert (sb.st_ino == Di.st_ino); \
934 /* Write to standard output PREFIX, followed by the quoting style and
935 a space-separated list of the integers stored in OS all on one line. */
938 dired_dump_obstack (const char *prefix, struct obstack *os)
942 n_pos = obstack_object_size (os) / sizeof (dired_pos);
948 pos = (size_t *) obstack_finish (os);
949 fputs (prefix, stdout);
950 for (i = 0; i < n_pos; i++)
951 printf (" %lu", (unsigned long int) pos[i]);
957 dev_ino_hash (void const *x, size_t table_size)
959 struct dev_ino const *p = x;
960 return (uintmax_t) p->st_ino % table_size;
964 dev_ino_compare (void const *x, void const *y)
966 struct dev_ino const *a = x;
967 struct dev_ino const *b = y;
968 return SAME_INODE (*a, *b) ? true : false;
972 dev_ino_free (void *x)
977 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
978 active directories. Return true if there is already a matching
979 entry in the table. */
982 visit_dir (dev_t dev, ino_t ino)
985 struct dev_ino *ent_from_table;
988 ent = xmalloc (sizeof *ent);
992 /* Attempt to insert this entry into the table. */
993 ent_from_table = hash_insert (active_dir_set, ent);
995 if (ent_from_table == NULL)
997 /* Insertion failed due to lack of memory. */
1001 found_match = (ent_from_table != ent);
1005 /* ent was not inserted, so free it. */
1013 free_pending_ent (struct pending *p)
1021 is_colored (enum indicator_no type)
1023 size_t len = color_indicator[type].len;
1024 char const *s = color_indicator[type].string;
1026 || (len == 1 && strncmp (s, "0", 1) == 0)
1027 || (len == 2 && strncmp (s, "00", 2) == 0));
1031 restore_default_color (void)
1033 put_indicator (&color_indicator[C_LEFT]);
1034 put_indicator (&color_indicator[C_RIGHT]);
1037 /* An ordinary signal was received; arrange for the program to exit. */
1040 sighandler (int sig)
1043 signal (sig, SIG_IGN);
1044 if (! interrupt_signal)
1045 interrupt_signal = sig;
1048 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1051 stophandler (int sig)
1054 signal (sig, stophandler);
1055 if (! interrupt_signal)
1056 stop_signal_count++;
1059 /* Process any pending signals. If signals are caught, this function
1060 should be called periodically. Ideally there should never be an
1061 unbounded amount of time when signals are not being processed.
1062 Signal handling can restore the default colors, so callers must
1063 immediately change colors after invoking this function. */
1066 process_signals (void)
1068 while (interrupt_signal | stop_signal_count)
1074 restore_default_color ();
1077 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1079 /* Reload interrupt_signal and stop_signal_count, in case a new
1080 signal was handled before sigprocmask took effect. */
1081 sig = interrupt_signal;
1082 stops = stop_signal_count;
1084 /* SIGTSTP is special, since the application can receive that signal
1085 more than once. In this case, don't set the signal handler to the
1086 default. Instead, just raise the uncatchable SIGSTOP. */
1089 stop_signal_count = stops - 1;
1093 signal (sig, SIG_DFL);
1095 /* Exit or suspend the program. */
1097 sigprocmask (SIG_SETMASK, &oldset, NULL);
1099 /* If execution reaches here, then the program has been
1100 continued (after being suspended). */
1105 main (int argc, char **argv)
1108 struct pending *thispend;
1111 /* The signals that are trapped, and the number of such signals. */
1112 static int const sig[] =
1114 /* This one is handled specially. */
1117 /* The usual suspects. */
1118 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1135 enum { nsigs = sizeof sig / sizeof sig[0] };
1138 bool caught_sig[nsigs];
1141 initialize_main (&argc, &argv);
1142 program_name = argv[0];
1143 setlocale (LC_ALL, "");
1144 bindtextdomain (PACKAGE, LOCALEDIR);
1145 textdomain (PACKAGE);
1147 initialize_exit_failure (LS_FAILURE);
1148 atexit (close_stdout);
1150 #define N_ENTRIES(Array) (sizeof Array / sizeof *(Array))
1151 assert (N_ENTRIES (color_indicator) + 1 == N_ENTRIES (indicator_name));
1153 exit_status = EXIT_SUCCESS;
1154 print_dir_name = true;
1155 pending_dirs = NULL;
1157 i = decode_switches (argc, argv);
1159 if (print_with_color)
1162 /* Test print_with_color again, because the call to parse_ls_color
1163 may have just reset it -- e.g., if LS_COLORS is invalid. */
1164 if (print_with_color)
1166 /* Avoid following symbolic links when possible. */
1167 if (is_colored (C_ORPHAN)
1168 || (is_colored (C_EXEC) && color_symlink_as_referent)
1169 || (is_colored (C_MISSING) && format == long_format))
1170 check_symlink_color = true;
1172 /* If the standard output is a controlling terminal, watch out
1173 for signals, so that the colors can be restored to the
1174 default state if "ls" is suspended or interrupted. */
1176 if (0 <= tcgetpgrp (STDOUT_FILENO))
1180 struct sigaction act;
1182 sigemptyset (&caught_signals);
1183 for (j = 0; j < nsigs; j++)
1185 sigaction (sig[j], NULL, &act);
1186 if (act.sa_handler != SIG_IGN)
1187 sigaddset (&caught_signals, sig[j]);
1190 act.sa_mask = caught_signals;
1191 act.sa_flags = SA_RESTART;
1193 for (j = 0; j < nsigs; j++)
1194 if (sigismember (&caught_signals, sig[j]))
1196 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1197 sigaction (sig[j], &act, NULL);
1200 for (j = 0; j < nsigs; j++)
1202 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1205 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1206 siginterrupt (sig[j], 0);
1212 prep_non_filename_text ();
1215 if (dereference == DEREF_UNDEFINED)
1216 dereference = ((immediate_dirs
1217 || indicator_style == classify
1218 || format == long_format)
1220 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1222 /* When using -R, initialize a data structure we'll use to
1223 detect any directory cycles. */
1226 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, NULL,
1230 if (active_dir_set == NULL)
1233 obstack_init (&dev_ino_obstack);
1236 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1237 || format == long_format
1239 || print_block_size;
1240 format_needs_type = (! format_needs_stat
1243 || indicator_style != none
1244 || directories_first));
1248 obstack_init (&dired_obstack);
1249 obstack_init (&subdired_obstack);
1253 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1263 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1265 queue_directory (".", NULL, true);
1269 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1275 if (!immediate_dirs)
1276 extract_dirs_from_files (NULL, true);
1277 /* `cwd_n_used' might be zero now. */
1280 /* In the following if/else blocks, it is sufficient to test `pending_dirs'
1281 (and not pending_dirs->name) because there may be no markers in the queue
1282 at this point. A marker may be enqueued when extract_dirs_from_files is
1283 called with a non-empty string or via print_dir. */
1286 print_current_files ();
1288 DIRED_PUTCHAR ('\n');
1290 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1291 print_dir_name = false;
1293 while (pending_dirs)
1295 thispend = pending_dirs;
1296 pending_dirs = pending_dirs->next;
1300 if (thispend->name == NULL)
1302 /* thispend->name == NULL means this is a marker entry
1303 indicating we've finished processing the directory.
1304 Use its dev/ino numbers to remove the corresponding
1305 entry from the active_dir_set hash table. */
1306 struct dev_ino di = dev_ino_pop ();
1307 struct dev_ino *found = hash_delete (active_dir_set, &di);
1308 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1310 dev_ino_free (found);
1311 free_pending_ent (thispend);
1316 print_dir (thispend->name, thispend->realname,
1317 thispend->command_line_arg);
1319 free_pending_ent (thispend);
1320 print_dir_name = true;
1323 if (print_with_color)
1327 restore_default_color ();
1330 /* Restore the default signal handling. */
1332 for (j = 0; j < nsigs; j++)
1333 if (sigismember (&caught_signals, sig[j]))
1334 signal (sig[j], SIG_DFL);
1336 for (j = 0; j < nsigs; j++)
1338 signal (sig[j], SIG_DFL);
1341 /* Act on any signals that arrived before the default was restored.
1342 This can process signals out of order, but there doesn't seem to
1343 be an easy way to do them in order, and the order isn't that
1344 important anyway. */
1345 for (j = stop_signal_count; j; j--)
1347 j = interrupt_signal;
1354 /* No need to free these since we're about to exit. */
1355 dired_dump_obstack ("//DIRED//", &dired_obstack);
1356 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1357 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1358 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1363 assert (hash_get_n_entries (active_dir_set) == 0);
1364 hash_free (active_dir_set);
1370 /* Set all the option flags according to the switches specified.
1371 Return the index of the first non-option argument. */
1374 decode_switches (int argc, char **argv)
1376 char *time_style_option = NULL;
1378 /* Record whether there is an option specifying sort type. */
1379 bool sort_type_specified = false;
1381 qmark_funny_chars = false;
1383 /* initialize all switches to default settings */
1388 /* This is for the `dir' program. */
1389 format = many_per_line;
1390 set_quoting_style (NULL, escape_quoting_style);
1393 case LS_LONG_FORMAT:
1394 /* This is for the `vdir' program. */
1395 format = long_format;
1396 set_quoting_style (NULL, escape_quoting_style);
1400 /* This is for the `ls' program. */
1401 if (isatty (STDOUT_FILENO))
1403 format = many_per_line;
1404 /* See description of qmark_funny_chars, above. */
1405 qmark_funny_chars = true;
1409 format = one_per_line;
1410 qmark_funny_chars = false;
1418 time_type = time_mtime;
1419 sort_type = sort_name;
1420 sort_reverse = false;
1421 numeric_ids = false;
1422 print_block_size = false;
1423 indicator_style = none;
1424 print_inode = false;
1425 dereference = DEREF_UNDEFINED;
1427 immediate_dirs = false;
1428 ignore_mode = IGNORE_DEFAULT;
1429 ignore_patterns = NULL;
1430 hide_patterns = NULL;
1431 print_scontext = false;
1433 /* FIXME: put this in a function. */
1435 char const *q_style = getenv ("QUOTING_STYLE");
1438 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
1440 set_quoting_style (NULL, quoting_style_vals[i]);
1443 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
1444 quotearg (q_style));
1449 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1450 human_options (ls_block_size,
1451 &human_output_opts, &output_block_size);
1452 if (ls_block_size || getenv ("BLOCK_SIZE"))
1453 file_output_block_size = output_block_size;
1458 char const *p = getenv ("COLUMNS");
1461 unsigned long int tmp_ulong;
1462 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1463 && 0 < tmp_ulong && tmp_ulong <= SIZE_MAX)
1465 line_length = tmp_ulong;
1470 _("ignoring invalid width in environment variable COLUMNS: %s"),
1480 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1481 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1482 line_length = ws.ws_col;
1487 char const *p = getenv ("TABSIZE");
1491 unsigned long int tmp_ulong;
1492 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1493 && tmp_ulong <= SIZE_MAX)
1495 tabsize = tmp_ulong;
1500 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1509 int c = getopt_long (argc, argv,
1510 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1518 ignore_mode = IGNORE_MINIMAL;
1522 set_quoting_style (NULL, escape_quoting_style);
1526 time_type = time_ctime;
1530 immediate_dirs = true;
1534 /* Same as enabling -a -U and disabling -l -s. */
1535 ignore_mode = IGNORE_MINIMAL;
1536 sort_type = sort_none;
1537 sort_type_specified = true;
1539 if (format == long_format)
1540 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1541 print_block_size = false; /* disable -s */
1542 print_with_color = false; /* disable --color */
1545 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1546 indicator_style = file_type;
1550 format = long_format;
1551 print_owner = false;
1555 human_output_opts = human_autoscale | human_SI | human_base_1024;
1556 file_output_block_size = output_block_size = 1;
1564 human_output_opts = 0;
1565 file_output_block_size = output_block_size = 1024;
1569 format = long_format;
1573 format = with_commas;
1578 format = long_format;
1581 case 'o': /* Just like -l, but don't display group info. */
1582 format = long_format;
1583 print_group = false;
1587 indicator_style = slash;
1591 qmark_funny_chars = true;
1595 sort_reverse = true;
1599 print_block_size = true;
1603 sort_type = sort_time;
1604 sort_type_specified = true;
1608 time_type = time_atime;
1612 sort_type = sort_version;
1613 sort_type_specified = true;
1618 unsigned long int tmp_ulong;
1619 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1620 || ! (0 < tmp_ulong && tmp_ulong <= SIZE_MAX))
1621 error (LS_FAILURE, 0, _("invalid line width: %s"),
1623 line_length = tmp_ulong;
1628 format = horizontal;
1632 if (ignore_mode == IGNORE_DEFAULT)
1633 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1637 add_ignore_pattern ("*~");
1638 add_ignore_pattern (".*~");
1642 format = many_per_line;
1650 indicator_style = classify;
1653 case 'G': /* inhibit display of group info */
1654 print_group = false;
1658 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1661 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1662 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1666 add_ignore_pattern (optarg);
1670 dereference = DEREF_ALWAYS;
1674 set_quoting_style (NULL, literal_quoting_style);
1678 set_quoting_style (NULL, c_quoting_style);
1686 sort_type = sort_size;
1687 sort_type_specified = true;
1692 unsigned long int tmp_ulong;
1693 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1694 || SIZE_MAX < tmp_ulong)
1695 error (LS_FAILURE, 0, _("invalid tab size: %s"),
1697 tabsize = tmp_ulong;
1702 sort_type = sort_none;
1703 sort_type_specified = true;
1707 sort_type = sort_extension;
1708 sort_type_specified = true;
1712 /* -1 has no effect after -l. */
1713 if (format != long_format)
1714 format = one_per_line;
1718 print_author = true;
1723 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1724 hide->pattern = optarg;
1725 hide->next = hide_patterns;
1726 hide_patterns = hide;
1731 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1732 sort_type_specified = true;
1735 case GROUP_DIRECTORIES_FIRST_OPTION:
1736 directories_first = true;
1740 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1744 format = XARGMATCH ("--format", optarg, format_args, format_types);
1747 case FULL_TIME_OPTION:
1748 format = long_format;
1749 time_style_option = "full-iso";
1756 i = XARGMATCH ("--color", optarg, color_args, color_types);
1758 /* Using --color with no argument is equivalent to using
1762 print_with_color = (i == color_always
1763 || (i == color_if_tty
1764 && isatty (STDOUT_FILENO)));
1766 if (print_with_color)
1768 /* Don't use TAB characters in output. Some terminal
1769 emulators can't handle the combination of tabs and
1770 color codes on the same line. */
1776 case INDICATOR_STYLE_OPTION:
1777 indicator_style = XARGMATCH ("--indicator-style", optarg,
1778 indicator_style_args,
1779 indicator_style_types);
1782 case QUOTING_STYLE_OPTION:
1783 set_quoting_style (NULL,
1784 XARGMATCH ("--quoting-style", optarg,
1786 quoting_style_vals));
1789 case TIME_STYLE_OPTION:
1790 time_style_option = optarg;
1793 case SHOW_CONTROL_CHARS_OPTION:
1794 qmark_funny_chars = false;
1797 case BLOCK_SIZE_OPTION:
1799 enum strtol_error e = human_options (optarg, &human_output_opts,
1800 &output_block_size);
1801 if (e != LONGINT_OK)
1802 xstrtol_fatal (e, oi, 0, long_options, optarg);
1803 file_output_block_size = output_block_size;
1808 human_output_opts = human_autoscale | human_SI;
1809 file_output_block_size = output_block_size = 1;
1813 print_scontext = true;
1816 case_GETOPT_HELP_CHAR;
1818 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1825 max_idx = MAX (1, line_length / MIN_COLUMN_WIDTH);
1827 filename_quoting_options = clone_quoting_options (NULL);
1828 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1829 set_char_quoting (filename_quoting_options, ' ', 1);
1830 if (file_type <= indicator_style)
1833 for (p = "*=>@|" + indicator_style - file_type; *p; p++)
1834 set_char_quoting (filename_quoting_options, *p, 1);
1837 dirname_quoting_options = clone_quoting_options (NULL);
1838 set_char_quoting (dirname_quoting_options, ':', 1);
1840 /* --dired is meaningful only with --format=long (-l).
1841 Otherwise, ignore it. FIXME: warn about this?
1842 Alternatively, make --dired imply --format=long? */
1843 if (dired && format != long_format)
1846 /* If -c or -u is specified and not -l (or any other option that implies -l),
1847 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
1848 The behavior of ls when using either -c or -u but with neither -l nor -t
1849 appears to be unspecified by POSIX. So, with GNU ls, `-u' alone means
1850 sort by atime (this is the one that's not specified by the POSIX spec),
1851 -lu means show atime and sort by name, -lut means show atime and sort
1854 if ((time_type == time_ctime || time_type == time_atime)
1855 && !sort_type_specified && format != long_format)
1857 sort_type = sort_time;
1860 if (format == long_format)
1862 char *style = time_style_option;
1863 static char const posix_prefix[] = "posix-";
1866 if (! (style = getenv ("TIME_STYLE")))
1869 while (strncmp (style, posix_prefix, sizeof posix_prefix - 1) == 0)
1871 if (! hard_locale (LC_TIME))
1873 style += sizeof posix_prefix - 1;
1878 char *p0 = style + 1;
1879 char *p1 = strchr (p0, '\n');
1884 if (strchr (p1 + 1, '\n'))
1885 error (LS_FAILURE, 0, _("invalid time style format %s"),
1889 long_time_format[0] = p0;
1890 long_time_format[1] = p1;
1893 switch (XARGMATCH ("time style", style,
1897 case full_iso_time_style:
1898 long_time_format[0] = long_time_format[1] =
1899 "%Y-%m-%d %H:%M:%S.%N %z";
1902 case long_iso_time_style:
1903 case_long_iso_time_style:
1904 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
1907 case iso_time_style:
1908 long_time_format[0] = "%Y-%m-%d ";
1909 long_time_format[1] = "%m-%d %H:%M";
1912 case locale_time_style:
1913 if (hard_locale (LC_TIME))
1915 /* Ensure that the locale has translations for both
1916 formats. If not, fall back on long-iso format. */
1918 for (i = 0; i < 2; i++)
1920 char const *locale_format =
1921 dcgettext (NULL, long_time_format[i], LC_TIME);
1922 if (locale_format == long_time_format[i])
1923 goto case_long_iso_time_style;
1924 long_time_format[i] = locale_format;
1933 /* Parse a string as part of the LS_COLORS variable; this may involve
1934 decoding all kinds of escape characters. If equals_end is set an
1935 unescaped equal sign ends the string, otherwise only a : or \0
1936 does. Set *OUTPUT_COUNT to the number of bytes output. Return
1939 The resulting string is *not* null-terminated, but may contain
1942 Note that both dest and src are char **; on return they point to
1943 the first free byte after the array and the character that ended
1944 the input string, respectively. */
1947 get_funky_string (char **dest, const char **src, bool equals_end,
1948 size_t *output_count)
1950 char num; /* For numerical codes */
1951 size_t count; /* Something to count with */
1953 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
1958 p = *src; /* We don't want to double-indirect */
1959 q = *dest; /* the whole darn time. */
1961 count = 0; /* No characters counted in yet. */
1964 state = ST_GND; /* Start in ground state. */
1965 while (state < ST_END)
1969 case ST_GND: /* Ground state (no escapes) */
1974 state = ST_END; /* End of string */
1977 state = ST_BACKSLASH; /* Backslash scape sequence */
1981 state = ST_CARET; /* Caret escape */
1987 state = ST_END; /* End */
1990 /* else fall through */
1998 case ST_BACKSLASH: /* Backslash escaped character */
2009 state = ST_OCTAL; /* Octal sequence */
2014 state = ST_HEX; /* Hex sequence */
2017 case 'a': /* Bell */
2020 case 'b': /* Backspace */
2023 case 'e': /* Escape */
2026 case 'f': /* Form feed */
2029 case 'n': /* Newline */
2032 case 'r': /* Carriage return */
2038 case 'v': /* Vtab */
2041 case '?': /* Delete */
2044 case '_': /* Space */
2047 case '\0': /* End of string */
2048 state = ST_ERROR; /* Error! */
2050 default: /* Escaped character like \ ^ : = */
2054 if (state == ST_BACKSLASH)
2063 case ST_OCTAL: /* Octal sequence */
2064 if (*p < '0' || *p > '7')
2071 num = (num << 3) + (*(p++) - '0');
2074 case ST_HEX: /* Hex sequence */
2087 num = (num << 4) + (*(p++) - '0');
2095 num = (num << 4) + (*(p++) - 'a') + 10;
2103 num = (num << 4) + (*(p++) - 'A') + 10;
2113 case ST_CARET: /* Caret escape */
2114 state = ST_GND; /* Should be the next state... */
2115 if (*p >= '@' && *p <= '~')
2117 *(q++) = *(p++) & 037;
2136 *output_count = count;
2138 return state != ST_ERROR;
2142 parse_ls_color (void)
2144 const char *p; /* Pointer to character being parsed */
2145 char *buf; /* color_buf buffer pointer */
2146 int state; /* State of parser */
2147 int ind_no; /* Indicator number */
2148 char label[3]; /* Indicator label */
2149 struct color_ext_type *ext; /* Extension we are working on */
2151 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2155 strcpy (label, "??");
2157 /* This is an overly conservative estimate, but any possible
2158 LS_COLORS string will *not* generate a color_buf longer than
2159 itself, so it is a safe way of allocating a buffer in
2161 buf = color_buf = xstrdup (p);
2168 case 1: /* First label character */
2176 /* Allocate new extension block and add to head of
2177 linked list (this way a later definition will
2178 override an earlier one, which can be useful for
2179 having terminal-specific defs override global). */
2181 ext = xmalloc (sizeof *ext);
2182 ext->next = color_ext_list;
2183 color_ext_list = ext;
2186 ext->ext.string = buf;
2188 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2193 state = 0; /* Done! */
2196 default: /* Assume it is file type label */
2203 case 2: /* Second label character */
2210 state = -1; /* Error */
2213 case 3: /* Equal sign after indicator label */
2214 state = -1; /* Assume failure... */
2215 if (*(p++) == '=')/* It *should* be... */
2217 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2219 if (STREQ (label, indicator_name[ind_no]))
2221 color_indicator[ind_no].string = buf;
2222 state = (get_funky_string (&buf, &p, false,
2223 &color_indicator[ind_no].len)
2229 error (0, 0, _("unrecognized prefix: %s"), quotearg (label));
2233 case 4: /* Equal sign after *.ext */
2236 ext->seq.string = buf;
2237 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2248 struct color_ext_type *e;
2249 struct color_ext_type *e2;
2252 _("unparsable value for LS_COLORS environment variable"));
2254 for (e = color_ext_list; e != NULL; /* empty */)
2260 print_with_color = false;
2263 if (color_indicator[C_LINK].len == 6
2264 && !strncmp (color_indicator[C_LINK].string, "target", 6))
2265 color_symlink_as_referent = true;
2268 /* Set the exit status to report a failure. If SERIOUS, it is a
2269 serious failure; otherwise, it is merely a minor problem. */
2272 set_exit_status (bool serious)
2275 exit_status = LS_FAILURE;
2276 else if (exit_status == EXIT_SUCCESS)
2277 exit_status = LS_MINOR_PROBLEM;
2280 /* Assuming a failure is serious if SERIOUS, use the printf-style
2281 MESSAGE to report the failure to access a file named FILE. Assume
2282 errno is set appropriately for the failure. */
2285 file_failure (bool serious, char const *message, char const *file)
2287 error (0, errno, message, quotearg_colon (file));
2288 set_exit_status (serious);
2291 /* Request that the directory named NAME have its contents listed later.
2292 If REALNAME is nonzero, it will be used instead of NAME when the
2293 directory name is printed. This allows symbolic links to directories
2294 to be treated as regular directories but still be listed under their
2295 real names. NAME == NULL is used to insert a marker entry for the
2296 directory named in REALNAME.
2297 If NAME is non-NULL, we use its dev/ino information to save
2298 a call to stat -- when doing a recursive (-R) traversal.
2299 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2302 queue_directory (char const *name, char const *realname, bool command_line_arg)
2304 struct pending *new = xmalloc (sizeof *new);
2305 new->realname = realname ? xstrdup (realname) : NULL;
2306 new->name = name ? xstrdup (name) : NULL;
2307 new->command_line_arg = command_line_arg;
2308 new->next = pending_dirs;
2312 /* Read directory NAME, and list the files in it.
2313 If REALNAME is nonzero, print its name instead of NAME;
2314 this is used for symbolic links to directories.
2315 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2318 print_dir (char const *name, char const *realname, bool command_line_arg)
2321 struct dirent *next;
2322 uintmax_t total_blocks = 0;
2323 static bool first = true;
2326 dirp = opendir (name);
2329 file_failure (command_line_arg, _("cannot open directory %s"), name);
2335 struct stat dir_stat;
2336 int fd = dirfd (dirp);
2338 /* If dirfd failed, endure the overhead of using stat. */
2340 ? fstat (fd, &dir_stat)
2341 : stat (name, &dir_stat)) < 0)
2343 file_failure (command_line_arg,
2344 _("cannot determine device and inode of %s"), name);
2349 /* If we've already visited this dev/inode pair, warn that
2350 we've found a loop, and do not process this directory. */
2351 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2353 error (0, 0, _("%s: not listing already-listed directory"),
2354 quotearg_colon (name));
2359 DEV_INO_PUSH (dir_stat.st_dev, dir_stat.st_ino);
2362 /* Read the directory entries, and insert the subfiles into the `cwd_file'
2369 /* Set errno to zero so we can distinguish between a readdir failure
2370 and when readdir simply finds that there are no more entries. */
2372 next = readdir (dirp);
2375 if (! file_ignored (next->d_name))
2377 enum filetype type = unknown;
2379 #if HAVE_STRUCT_DIRENT_D_TYPE
2380 switch (next->d_type)
2382 case DT_BLK: type = blockdev; break;
2383 case DT_CHR: type = chardev; break;
2384 case DT_DIR: type = directory; break;
2385 case DT_FIFO: type = fifo; break;
2386 case DT_LNK: type = symbolic_link; break;
2387 case DT_REG: type = normal; break;
2388 case DT_SOCK: type = sock; break;
2390 case DT_WHT: type = whiteout; break;
2394 total_blocks += gobble_file (next->d_name, type, D_INO (next),
2398 else if (errno != 0)
2400 file_failure (command_line_arg, _("reading directory %s"), name);
2401 if (errno != EOVERFLOW)
2408 if (closedir (dirp) != 0)
2410 file_failure (command_line_arg, _("closing directory %s"), name);
2411 /* Don't return; print whatever we got. */
2414 /* Sort the directory contents. */
2417 /* If any member files are subdirectories, perhaps they should have their
2418 contents listed rather than being mentioned here as files. */
2421 extract_dirs_from_files (name, command_line_arg);
2423 if (recursive | print_dir_name)
2426 DIRED_PUTCHAR ('\n');
2429 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2430 dired_pos += quote_name (stdout, realname ? realname : name,
2431 dirname_quoting_options, NULL);
2432 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2433 DIRED_FPUTS_LITERAL (":\n", stdout);
2436 if (format == long_format || print_block_size)
2439 char buf[LONGEST_HUMAN_READABLE + 1];
2443 DIRED_FPUTS (p, stdout, strlen (p));
2444 DIRED_PUTCHAR (' ');
2445 p = human_readable (total_blocks, buf, human_output_opts,
2446 ST_NBLOCKSIZE, output_block_size);
2447 DIRED_FPUTS (p, stdout, strlen (p));
2448 DIRED_PUTCHAR ('\n');
2452 print_current_files ();
2455 /* Add `pattern' to the list of patterns for which files that match are
2459 add_ignore_pattern (const char *pattern)
2461 struct ignore_pattern *ignore;
2463 ignore = xmalloc (sizeof *ignore);
2464 ignore->pattern = pattern;
2465 /* Add it to the head of the linked list. */
2466 ignore->next = ignore_patterns;
2467 ignore_patterns = ignore;
2470 /* Return true if one of the PATTERNS matches FILE. */
2473 patterns_match (struct ignore_pattern const *patterns, char const *file)
2475 struct ignore_pattern const *p;
2476 for (p = patterns; p; p = p->next)
2477 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2482 /* Return true if FILE should be ignored. */
2485 file_ignored (char const *name)
2487 return ((ignore_mode != IGNORE_MINIMAL
2489 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2490 || (ignore_mode == IGNORE_DEFAULT
2491 && patterns_match (hide_patterns, name))
2492 || patterns_match (ignore_patterns, name));
2495 /* POSIX requires that a file size be printed without a sign, even
2496 when negative. Assume the typical case where negative sizes are
2497 actually positive values that have wrapped around. */
2500 unsigned_file_size (off_t size)
2502 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2505 /* Enter and remove entries in the table `cwd_file'. */
2507 /* Empty the table of files. */
2514 for (i = 0; i < cwd_n_used; i++)
2516 struct fileinfo *f = sorted_file[i];
2521 freecon (f->scontext);
2527 any_has_acl = false;
2528 inode_number_width = 0;
2529 block_size_width = 0;
2535 major_device_number_width = 0;
2536 minor_device_number_width = 0;
2537 file_size_width = 0;
2540 /* Add a file to the current table of files.
2541 Verify that the file exists, and print an error message if it does not.
2542 Return the number of blocks that the file occupies. */
2545 gobble_file (char const *name, enum filetype type, ino_t inode,
2546 bool command_line_arg, char const *dirname)
2548 uintmax_t blocks = 0;
2551 /* An inode value prior to gobble_file necessarily came from readdir,
2552 which is not used for command line arguments. */
2553 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2555 if (cwd_n_used == cwd_n_alloc)
2557 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
2561 f = &cwd_file[cwd_n_used];
2562 memset (f, '\0', sizeof *f);
2563 f->stat.st_ino = inode;
2566 if (command_line_arg
2567 || format_needs_stat
2568 /* When coloring a directory (we may know the type from
2569 direct.d_type), we have to stat it in order to indicate
2570 sticky and/or other-writable attributes. */
2571 || (type == directory && print_with_color)
2572 /* When dereferencing symlinks, the inode and type must come from
2573 stat, but readdir provides the inode and type of lstat. */
2574 || ((print_inode || format_needs_type)
2575 && (type == symbolic_link || type == unknown)
2576 && (dereference == DEREF_ALWAYS
2577 || (command_line_arg && dereference != DEREF_NEVER)
2578 || color_symlink_as_referent || check_symlink_color))
2579 /* Command line dereferences are already taken care of by the above
2580 assertion that the inode number is not yet known. */
2581 || (print_inode && inode == NOT_AN_INODE_NUMBER)
2582 || (format_needs_type
2583 && (type == unknown || command_line_arg
2584 /* --indicator-style=classify (aka -F)
2585 requires that we stat each regular file
2586 to see if it's executable. */
2587 || (type == normal && (indicator_style == classify
2588 /* This is so that --color ends up
2589 highlighting files with the executable
2590 bit set even when options like -F are
2592 || (print_with_color
2593 && is_colored (C_EXEC))
2597 /* FIXME-c99: move this decl "down", once ls.c stabilizes. */
2598 bool file_has_security_context = false;
2599 /* Absolute name of this file. */
2600 char *absolute_name;
2604 if (name[0] == '/' || dirname[0] == 0)
2605 absolute_name = (char *) name;
2608 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
2609 attach (absolute_name, dirname, name);
2612 switch (dereference)
2615 err = stat (absolute_name, &f->stat);
2619 case DEREF_COMMAND_LINE_ARGUMENTS:
2620 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
2621 if (command_line_arg)
2624 err = stat (absolute_name, &f->stat);
2627 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
2630 need_lstat = (err < 0
2632 : ! S_ISDIR (f->stat.st_mode));
2636 /* stat failed because of ENOENT, maybe indicating a dangling
2637 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
2638 directory, and --dereference-command-line-symlink-to-dir is
2639 in effect. Fall through so that we call lstat instead. */
2642 default: /* DEREF_NEVER */
2643 err = lstat (absolute_name, &f->stat);
2648 if (err == 0 && print_scontext)
2650 int attr_len = (do_deref
2651 ? getfilecon (absolute_name, &f->scontext)
2652 : lgetfilecon (absolute_name, &f->scontext));
2653 err = (attr_len < 0);
2654 file_has_security_context = (err == 0);
2656 /* When requesting security context information, don't make
2657 ls fail just because the file (even a command line argument)
2658 isn't on the right type of file system. I.e., a getfilecon
2659 failure isn't in the same class as a stat failure. */
2660 if (err && (errno == ENOTSUP || errno == ENODATA))
2666 /* Failure to stat a command line argument leads to
2667 an exit status of 2. For other files, stat failure
2668 provokes an exit status of 1. */
2669 file_failure (command_line_arg,
2670 _("cannot access %s"), absolute_name);
2671 if (command_line_arg)
2674 f->name = xstrdup (name);
2682 if (format == long_format)
2684 int n = file_has_acl (absolute_name, &f->stat);
2685 f->have_acl = (0 < n || file_has_security_context);
2686 any_has_acl |= f->have_acl;
2688 error (0, errno, "%s", quotearg_colon (absolute_name));
2691 if (S_ISLNK (f->stat.st_mode)
2692 && (format == long_format || check_symlink_color))
2695 struct stat linkstats;
2697 get_link_name (absolute_name, f, command_line_arg);
2698 linkname = make_link_name (absolute_name, f->linkname);
2700 /* Avoid following symbolic links when possible, ie, when
2701 they won't be traced and when no indicator is needed. */
2703 && (file_type <= indicator_style || check_symlink_color)
2704 && stat (linkname, &linkstats) == 0)
2708 /* Symbolic links to directories that are mentioned on the
2709 command line are automatically traced if not being
2711 if (!command_line_arg || format == long_format
2712 || !S_ISDIR (linkstats.st_mode))
2714 /* Get the linked-to file's mode for the filetype indicator
2715 in long listings. */
2716 f->linkmode = linkstats.st_mode;
2722 /* When not distinguishing types of symlinks, pretend we know that
2723 it is stat'able, so that it will be colored as a regular symlink,
2724 and not as an orphan. */
2725 if (S_ISLNK (f->stat.st_mode) && !check_symlink_color)
2728 if (S_ISLNK (f->stat.st_mode))
2729 f->filetype = symbolic_link;
2730 else if (S_ISDIR (f->stat.st_mode))
2732 if (command_line_arg & !immediate_dirs)
2733 f->filetype = arg_directory;
2735 f->filetype = directory;
2738 f->filetype = normal;
2740 blocks = ST_NBLOCKS (f->stat);
2741 if (format == long_format || print_block_size)
2743 char buf[LONGEST_HUMAN_READABLE + 1];
2744 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
2745 ST_NBLOCKSIZE, output_block_size),
2747 if (block_size_width < len)
2748 block_size_width = len;
2751 if (format == long_format)
2755 int len = format_user_width (f->stat.st_uid);
2756 if (owner_width < len)
2762 int len = format_group_width (f->stat.st_gid);
2763 if (group_width < len)
2769 int len = format_user_width (f->stat.st_author);
2770 if (author_width < len)
2777 int len = f->scontext ? strlen (f->scontext) : 0;
2778 if (scontext_width < len)
2779 scontext_width = len;
2782 if (format == long_format)
2784 char b[INT_BUFSIZE_BOUND (uintmax_t)];
2785 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
2786 if (nlink_width < b_len)
2787 nlink_width = b_len;
2789 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
2791 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2792 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
2793 if (major_device_number_width < len)
2794 major_device_number_width = len;
2795 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
2796 if (minor_device_number_width < len)
2797 minor_device_number_width = len;
2798 len = major_device_number_width + 2 + minor_device_number_width;
2799 if (file_size_width < len)
2800 file_size_width = len;
2804 char buf[LONGEST_HUMAN_READABLE + 1];
2805 uintmax_t size = unsigned_file_size (f->stat.st_size);
2806 int len = mbswidth (human_readable (size, buf, human_output_opts,
2807 1, file_output_block_size),
2809 if (file_size_width < len)
2810 file_size_width = len;
2817 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2818 int len = strlen (umaxtostr (f->stat.st_ino, buf));
2819 if (inode_number_width < len)
2820 inode_number_width = len;
2823 f->name = xstrdup (name);
2829 /* Return true if F refers to a directory. */
2831 is_directory (const struct fileinfo *f)
2833 return f->filetype == directory || f->filetype == arg_directory;
2836 /* Put the name of the file that FILENAME is a symbolic link to
2837 into the LINKNAME field of `f'. COMMAND_LINE_ARG indicates whether
2838 FILENAME is a command-line argument. */
2841 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
2843 f->linkname = areadlink_with_size (filename, f->stat.st_size);
2844 if (f->linkname == NULL)
2845 file_failure (command_line_arg, _("cannot read symbolic link %s"),
2849 /* If `linkname' is a relative name and `name' contains one or more
2850 leading directories, return `linkname' with those directories
2851 prepended; otherwise, return a copy of `linkname'.
2852 If `linkname' is zero, return zero. */
2855 make_link_name (char const *name, char const *linkname)
2863 if (*linkname == '/')
2864 return xstrdup (linkname);
2866 /* The link is to a relative name. Prepend any leading directory
2867 in `name' to the link name. */
2868 linkbuf = strrchr (name, '/');
2870 return xstrdup (linkname);
2872 bufsiz = linkbuf - name + 1;
2873 linkbuf = xmalloc (bufsiz + strlen (linkname) + 1);
2874 strncpy (linkbuf, name, bufsiz);
2875 strcpy (linkbuf + bufsiz, linkname);
2879 /* Return true if the last component of NAME is `.' or `..'
2880 This is so we don't try to recurse on `././././. ...' */
2883 basename_is_dot_or_dotdot (const char *name)
2885 char const *base = last_component (name);
2886 return dot_or_dotdot (base);
2889 /* Remove any entries from CWD_FILE that are for directories,
2890 and queue them to be listed as directories instead.
2891 DIRNAME is the prefix to prepend to each dirname
2892 to make it correct relative to ls's working dir;
2893 if it is null, no prefix is needed and "." and ".." should not be ignored.
2894 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
2895 This is desirable when processing directories recursively. */
2898 extract_dirs_from_files (char const *dirname, bool command_line_arg)
2902 bool ignore_dot_and_dot_dot = (dirname != NULL);
2904 if (dirname && LOOP_DETECT)
2906 /* Insert a marker entry first. When we dequeue this marker entry,
2907 we'll know that DIRNAME has been processed and may be removed
2908 from the set of active directories. */
2909 queue_directory (NULL, dirname, false);
2912 /* Queue the directories last one first, because queueing reverses the
2914 for (i = cwd_n_used; i-- != 0; )
2916 struct fileinfo *f = sorted_file[i];
2918 if (is_directory (f)
2919 && (! ignore_dot_and_dot_dot
2920 || ! basename_is_dot_or_dotdot (f->name)))
2922 if (!dirname || f->name[0] == '/')
2923 queue_directory (f->name, f->linkname, command_line_arg);
2926 char *name = file_name_concat (dirname, f->name, NULL);
2927 queue_directory (name, f->linkname, command_line_arg);
2930 if (f->filetype == arg_directory)
2935 /* Now delete the directories from the table, compacting all the remaining
2938 for (i = 0, j = 0; i < cwd_n_used; i++)
2940 struct fileinfo *f = sorted_file[i];
2942 j += (f->filetype != arg_directory);
2947 /* Use strcoll to compare strings in this locale. If an error occurs,
2948 report an error and longjmp to failed_strcoll. */
2950 static jmp_buf failed_strcoll;
2953 xstrcoll (char const *a, char const *b)
2957 diff = strcoll (a, b);
2960 error (0, errno, _("cannot compare file names %s and %s"),
2961 quote_n (0, a), quote_n (1, b));
2962 set_exit_status (false);
2963 longjmp (failed_strcoll, 1);
2968 /* Comparison routines for sorting the files. */
2970 typedef void const *V;
2971 typedef int (*qsortFunc)(V a, V b);
2973 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
2974 The do { ... } while(0) makes it possible to use the macro more like
2975 a statement, without violating C89 rules: */
2976 #define DIRFIRST_CHECK(a, b) \
2979 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
2980 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
2981 if (a_is_dir && !b_is_dir) \
2982 return -1; /* a goes before b */ \
2983 if (!a_is_dir && b_is_dir) \
2984 return 1; /* b goes before a */ \
2988 /* Define the 8 different sort function variants required for each sortkey.
2989 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
2990 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
2991 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
2992 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
2993 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
2994 /* direct, non-dirfirst versions */ \
2995 static int xstrcoll_##key_name (V a, V b) \
2996 { return key_cmp_func (a, b, xstrcoll); } \
2997 static int strcmp_##key_name (V a, V b) \
2998 { return key_cmp_func (a, b, strcmp); } \
3000 /* reverse, non-dirfirst versions */ \
3001 static int rev_xstrcoll_##key_name (V a, V b) \
3002 { return key_cmp_func (b, a, xstrcoll); } \
3003 static int rev_strcmp_##key_name (V a, V b) \
3004 { return key_cmp_func (b, a, strcmp); } \
3006 /* direct, dirfirst versions */ \
3007 static int xstrcoll_df_##key_name (V a, V b) \
3008 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
3009 static int strcmp_df_##key_name (V a, V b) \
3010 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
3012 /* reverse, dirfirst versions */ \
3013 static int rev_xstrcoll_df_##key_name (V a, V b) \
3014 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
3015 static int rev_strcmp_df_##key_name (V a, V b) \
3016 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
3019 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3020 int (*cmp) (char const *, char const *))
3022 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3023 get_stat_ctime (&a->stat));
3024 return diff ? diff : cmp (a->name, b->name);
3028 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3029 int (*cmp) (char const *, char const *))
3031 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3032 get_stat_mtime (&a->stat));
3033 return diff ? diff : cmp (a->name, b->name);
3037 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3038 int (*cmp) (char const *, char const *))
3040 int diff = timespec_cmp (get_stat_atime (&b->stat),
3041 get_stat_atime (&a->stat));
3042 return diff ? diff : cmp (a->name, b->name);
3046 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3047 int (*cmp) (char const *, char const *))
3049 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3050 return diff ? diff : cmp (a->name, b->name);
3054 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3055 int (*cmp) (char const *, char const *))
3057 return cmp (a->name, b->name);
3060 /* Compare file extensions. Files with no extension are `smallest'.
3061 If extensions are the same, compare by filenames instead. */
3064 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3065 int (*cmp) (char const *, char const *))
3067 char const *base1 = strrchr (a->name, '.');
3068 char const *base2 = strrchr (b->name, '.');
3069 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3070 return diff ? diff : cmp (a->name, b->name);
3073 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3074 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3075 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3076 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3077 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3078 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3080 /* Compare file versions.
3081 Unlike all other compare functions above, cmp_version depends only
3082 on strverscmp, which does not fail (even for locale reasons), and does not
3083 need a secondary sort key.
3084 All the other sort options, in fact, need xstrcoll and strcmp variants,
3085 because they all use a string comparison (either as the primary or secondary
3086 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3087 locale reasons. Last, strverscmp is ALWAYS available in coreutils,
3088 thanks to the gnulib library. */
3090 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3092 return strverscmp (a->name, b->name);
3095 static int xstrcoll_version (V a, V b)
3096 { return cmp_version (a, b); }
3097 static int rev_xstrcoll_version (V a, V b)
3098 { return cmp_version (b, a); }
3099 static int xstrcoll_df_version (V a, V b)
3100 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3101 static int rev_xstrcoll_df_version (V a, V b)
3102 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3105 /* We have 2^3 different variants for each sortkey function
3106 (for 3 independent sort modes).
3107 The function pointers stored in this array must be dereferenced as:
3109 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3111 Note that the order in which sortkeys are listed in the function pointer
3112 array below is defined by the order of the elements in the time_type and
3115 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3118 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3119 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3122 { strcmp_##key_name, strcmp_df_##key_name }, \
3123 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3127 static qsortFunc sort_functions[][2][2][2] =
3129 LIST_SORTFUNCTION_VARIANTS (name),
3130 LIST_SORTFUNCTION_VARIANTS (extension),
3131 LIST_SORTFUNCTION_VARIANTS (size),
3135 { xstrcoll_version, xstrcoll_df_version },
3136 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3139 /* We use NULL for the strcmp variants of version comparison
3140 since as explained in cmp_version definition, version comparison
3141 does not rely on xstrcoll, so it will never longjmp, and never
3142 need to try the strcmp fallback. */
3149 /* last are time sort functions */
3150 LIST_SORTFUNCTION_VARIANTS (mtime),
3151 LIST_SORTFUNCTION_VARIANTS (ctime),
3152 LIST_SORTFUNCTION_VARIANTS (atime)
3155 /* The number of sortkeys is calculated as
3156 the number of elements in the sort_type enum (i.e. sort_numtypes) +
3157 the number of elements in the time_type enum (i.e. time_numtypes) - 1
3158 This is because when sort_type==sort_time, we have up to
3159 time_numtypes possible sortkeys.
3161 This line verifies at compile-time that the array of sort functions has been
3162 initialized for all possible sortkeys. */
3163 verify (ARRAY_CARDINALITY (sort_functions)
3164 == sort_numtypes + time_numtypes - 1 );
3166 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
3169 initialize_ordering_vector (void)
3172 for (i = 0; i < cwd_n_used; i++)
3173 sorted_file[i] = &cwd_file[i];
3176 /* Sort the files now in the table. */
3183 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
3186 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
3187 sorted_file_alloc = 3 * cwd_n_used;
3190 initialize_ordering_vector ();
3192 if (sort_type == sort_none)
3195 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3196 ignore strcoll failures, as a failing strcoll might be a
3197 comparison function that is not a total order, and if we ignored
3198 the failure this might cause qsort to dump core. */
3200 if (! setjmp (failed_strcoll))
3201 use_strcmp = false; /* strcoll() succeeded */
3205 assert (sort_type != sort_version);
3206 initialize_ordering_vector ();
3209 /* When sort_type == sort_time, use time_type as subindex. */
3210 mpsort ((void const **) sorted_file, cwd_n_used,
3211 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
3212 [use_strcmp][sort_reverse]
3213 [directories_first]);
3216 /* List all the files now in the table. */
3219 print_current_files (void)
3226 for (i = 0; i < cwd_n_used; i++)
3228 print_file_name_and_frills (sorted_file[i]);
3234 print_many_per_line ();
3238 print_horizontal ();
3242 print_with_commas ();
3246 for (i = 0; i < cwd_n_used; i++)
3248 print_long_format (sorted_file[i]);
3249 DIRED_PUTCHAR ('\n');
3255 /* Return the expected number of columns in a long-format time stamp,
3256 or zero if it cannot be calculated. */
3259 long_time_expected_width (void)
3261 static int width = -1;
3266 struct tm const *tm = localtime (&epoch);
3267 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3269 /* In case you're wondering if localtime can fail with an input time_t
3270 value of 0, let's just say it's very unlikely, but not inconceivable.
3271 The TZ environment variable would have to specify a time zone that
3272 is 2**31-1900 years or more ahead of UTC. This could happen only on
3273 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3274 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3275 their implementations limit the offset to 167:59 and 24:00, resp. */
3279 nstrftime (buf, sizeof buf, long_time_format[0], tm, 0, 0);
3281 width = mbsnwidth (buf, len, 0);
3291 /* Get the current time. */
3294 get_current_time (void)
3296 #if HAVE_CLOCK_GETTIME && defined CLOCK_REALTIME
3298 struct timespec timespec;
3299 if (clock_gettime (CLOCK_REALTIME, ×pec) == 0)
3301 current_time = timespec.tv_sec;
3302 current_time_ns = timespec.tv_nsec;
3308 /* The clock does not have nanosecond resolution, so get the maximum
3309 possible value for the current time that is consistent with the
3310 reported clock. That way, files are not considered to be in the
3311 future merely because their time stamps have higher resolution
3312 than the clock resolution. */
3314 #if HAVE_GETTIMEOFDAY
3316 struct timeval timeval;
3317 gettimeofday (&timeval, NULL);
3318 current_time = timeval.tv_sec;
3319 current_time_ns = timeval.tv_usec * 1000 + 999;
3322 current_time = time (NULL);
3323 current_time_ns = 999999999;
3327 /* Print the user or group name NAME, with numeric id ID, using a
3328 print width of WIDTH columns. */
3331 format_user_or_group (char const *name, unsigned long int id, int width)
3337 int width_gap = width - mbswidth (name, 0);
3338 int pad = MAX (0, width_gap);
3339 fputs (name, stdout);
3340 len = strlen (name) + pad;
3348 printf ("%*lu ", width, id);
3352 dired_pos += len + 1;
3355 /* Print the name or id of the user with id U, using a print width of
3359 format_user (uid_t u, int width, bool stat_ok)
3361 format_user_or_group (! stat_ok ? "?" :
3362 (numeric_ids ? NULL : getuser (u)), u, width);
3365 /* Likewise, for groups. */
3368 format_group (gid_t g, int width, bool stat_ok)
3370 format_user_or_group (! stat_ok ? "?" :
3371 (numeric_ids ? NULL : getgroup (g)), g, width);
3374 /* Return the number of columns that format_user_or_group will print. */
3377 format_user_or_group_width (char const *name, unsigned long int id)
3381 int len = mbswidth (name, 0);
3382 return MAX (0, len);
3386 char buf[INT_BUFSIZE_BOUND (unsigned long int)];
3387 sprintf (buf, "%lu", id);
3388 return strlen (buf);
3392 /* Return the number of columns that format_user will print. */
3395 format_user_width (uid_t u)
3397 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3400 /* Likewise, for groups. */
3403 format_group_width (gid_t g)
3405 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3409 /* Print information about F in long format. */
3412 print_long_format (const struct fileinfo *f)
3416 [LONGEST_HUMAN_READABLE + 1 /* inode */
3417 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3418 + sizeof (modebuf) - 1 + 1 /* mode string */
3419 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3420 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3421 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3422 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3428 struct timespec when_timespec;
3429 struct tm *when_local;
3431 /* Compute the mode string, except remove the trailing space if no
3432 file in this directory has an ACL or SELinux security context. */
3434 filemodestring (&f->stat, modebuf);
3437 modebuf[0] = filetype_letter[f->filetype];
3438 memset (modebuf + 1, '?', 10);
3443 else if (f->have_acl)
3449 when_timespec = get_stat_ctime (&f->stat);
3452 when_timespec = get_stat_mtime (&f->stat);
3455 when_timespec = get_stat_atime (&f->stat);
3461 when = when_timespec.tv_sec;
3462 when_ns = when_timespec.tv_nsec;
3468 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3469 sprintf (p, "%*s ", inode_number_width,
3470 (f->stat.st_ino == NOT_AN_INODE_NUMBER
3472 : umaxtostr (f->stat.st_ino, hbuf)));
3473 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3474 The latter is wrong when inode_number_width is zero. */
3478 if (print_block_size)
3480 char hbuf[LONGEST_HUMAN_READABLE + 1];
3481 char const *blocks =
3484 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3485 ST_NBLOCKSIZE, output_block_size));
3487 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3489 while ((*p++ = *blocks++))
3494 /* The last byte of the mode string is the POSIX
3495 "optional alternate access method flag". */
3497 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3498 sprintf (p, "%s %*s ", modebuf, nlink_width,
3499 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3501 /* Increment by strlen (p) here, rather than by, e.g.,
3502 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3503 The latter is wrong when nlink_width is zero. */
3508 if (print_owner | print_group | print_author | print_scontext)
3510 DIRED_FPUTS (buf, stdout, p - buf);
3513 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3516 format_group (f->stat.st_gid, group_width, f->stat_ok);
3519 format_user (f->stat.st_author, author_width, f->stat_ok);
3522 format_user_or_group ((f->scontext ? f->scontext : "?"),
3529 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3531 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3532 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3533 int blanks_width = (file_size_width
3534 - (major_device_number_width + 2
3535 + minor_device_number_width));
3536 sprintf (p, "%*s, %*s ",
3537 major_device_number_width + MAX (0, blanks_width),
3538 umaxtostr (major (f->stat.st_rdev), majorbuf),
3539 minor_device_number_width,
3540 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3541 p += file_size_width + 1;
3545 char hbuf[LONGEST_HUMAN_READABLE + 1];
3549 : human_readable (unsigned_file_size (f->stat.st_size),
3550 hbuf, human_output_opts, 1, file_output_block_size));
3552 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3554 while ((*p++ = *size++))
3559 when_local = localtime (&when_timespec.tv_sec);
3563 if (f->stat_ok && when_local)
3565 time_t six_months_ago;
3569 /* If the file appears to be in the future, update the current
3570 time, in case the file happens to have been modified since
3571 the last time we checked the clock. */
3572 if (current_time < when
3573 || (current_time == when && current_time_ns < when_ns))
3575 /* Note that get_current_time calls gettimeofday which, on some non-
3576 compliant systems, clobbers the buffer used for localtime's result.
3577 But it's ok here, because we use a gettimeofday wrapper that
3578 saves and restores the buffer around the gettimeofday call. */
3579 get_current_time ();
3582 /* Consider a time to be recent if it is within the past six
3583 months. A Gregorian year has 365.2425 * 24 * 60 * 60 ==
3584 31556952 seconds on the average. Write this value as an
3585 integer constant to avoid floating point hassles. */
3586 six_months_ago = current_time - 31556952 / 2;
3587 recent = (six_months_ago <= when
3588 && (when < current_time
3589 || (when == current_time && when_ns <= current_time_ns)));
3590 fmt = long_time_format[recent];
3592 s = nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
3593 when_local, 0, when_ns);
3601 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
3606 /* The time cannot be converted using the desired format, so
3607 print it as a huge integer number of seconds. */
3608 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
3609 sprintf (p, "%*s ", long_time_expected_width (),
3612 : (TYPE_SIGNED (time_t)
3613 ? imaxtostr (when, hbuf)
3614 : umaxtostr (when, hbuf))));
3618 DIRED_FPUTS (buf, stdout, p - buf);
3619 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3620 f->stat_ok, f->filetype, &dired_obstack);
3622 if (f->filetype == symbolic_link)
3626 DIRED_FPUTS_LITERAL (" -> ", stdout);
3627 print_name_with_quoting (f->linkname, f->linkmode, f->linkok - 1,
3628 f->stat_ok, f->filetype, NULL);
3629 if (indicator_style != none)
3630 print_type_indicator (true, f->linkmode, unknown);
3633 else if (indicator_style != none)
3634 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3637 /* Output to OUT a quoted representation of the file name NAME,
3638 using OPTIONS to control quoting. Produce no output if OUT is NULL.
3639 Store the number of screen columns occupied by NAME's quoted
3640 representation into WIDTH, if non-NULL. Return the number of bytes
3644 quote_name (FILE *out, const char *name, struct quoting_options const *options,
3647 char smallbuf[BUFSIZ];
3648 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
3650 size_t displayed_width IF_LINT (= 0);
3652 if (len < sizeof smallbuf)
3656 buf = alloca (len + 1);
3657 quotearg_buffer (buf, len + 1, name, -1, options);
3660 if (qmark_funny_chars)
3665 char const *p = buf;
3666 char const *plimit = buf + len;
3668 displayed_width = 0;
3673 case ' ': case '!': case '"': case '#': case '%':
3674 case '&': case '\'': case '(': case ')': case '*':
3675 case '+': case ',': case '-': case '.': case '/':
3676 case '0': case '1': case '2': case '3': case '4':
3677 case '5': case '6': case '7': case '8': case '9':
3678 case ':': case ';': case '<': case '=': case '>':
3680 case 'A': case 'B': case 'C': case 'D': case 'E':
3681 case 'F': case 'G': case 'H': case 'I': case 'J':
3682 case 'K': case 'L': case 'M': case 'N': case 'O':
3683 case 'P': case 'Q': case 'R': case 'S': case 'T':
3684 case 'U': case 'V': case 'W': case 'X': case 'Y':
3686 case '[': case '\\': case ']': case '^': case '_':
3687 case 'a': case 'b': case 'c': case 'd': case 'e':
3688 case 'f': case 'g': case 'h': case 'i': case 'j':
3689 case 'k': case 'l': case 'm': case 'n': case 'o':
3690 case 'p': case 'q': case 'r': case 's': case 't':
3691 case 'u': case 'v': case 'w': case 'x': case 'y':
3692 case 'z': case '{': case '|': case '}': case '~':
3693 /* These characters are printable ASCII characters. */
3695 displayed_width += 1;
3698 /* If we have a multibyte sequence, copy it until we
3699 reach its end, replacing each non-printable multibyte
3700 character with a single question mark. */
3702 mbstate_t mbstate = { 0, };
3709 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
3711 if (bytes == (size_t) -1)
3713 /* An invalid multibyte sequence was
3714 encountered. Skip one input byte, and
3715 put a question mark. */
3718 displayed_width += 1;
3722 if (bytes == (size_t) -2)
3724 /* An incomplete multibyte character
3725 at the end. Replace it entirely with
3729 displayed_width += 1;
3734 /* A null wide character was encountered. */
3740 /* A printable multibyte character.
3742 for (; bytes > 0; --bytes)
3744 displayed_width += w;
3748 /* An unprintable multibyte character.
3749 Replace it entirely with a question
3753 displayed_width += 1;
3756 while (! mbsinit (&mbstate));
3761 /* The buffer may have shrunk. */
3768 char const *plimit = buf + len;
3772 if (! isprint (to_uchar (*p)))
3776 displayed_width = len;
3779 else if (width != NULL)
3783 displayed_width = mbsnwidth (buf, len, 0);
3787 char const *p = buf;
3788 char const *plimit = buf + len;
3790 displayed_width = 0;
3793 if (isprint (to_uchar (*p)))
3801 fwrite (buf, 1, len, out);
3803 *width = displayed_width;
3808 print_name_with_quoting (const char *p, mode_t mode, int linkok,
3809 bool stat_ok, enum filetype type,
3810 struct obstack *stack)
3812 if (print_with_color)
3813 print_color_indicator (p, mode, linkok, stat_ok, type);
3816 PUSH_CURRENT_DIRED_POS (stack);
3818 dired_pos += quote_name (stdout, p, filename_quoting_options, NULL);
3821 PUSH_CURRENT_DIRED_POS (stack);
3823 if (print_with_color)
3826 prep_non_filename_text ();
3831 prep_non_filename_text (void)
3833 if (color_indicator[C_END].string != NULL)
3834 put_indicator (&color_indicator[C_END]);
3837 put_indicator (&color_indicator[C_LEFT]);
3838 put_indicator (&color_indicator[C_NORM]);
3839 put_indicator (&color_indicator[C_RIGHT]);
3843 /* Print the file name of `f' with appropriate quoting.
3844 Also print file size, inode number, and filetype indicator character,
3845 as requested by switches. */
3848 print_file_name_and_frills (const struct fileinfo *f)
3850 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
3853 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
3854 umaxtostr (f->stat.st_ino, buf));
3856 if (print_block_size)
3857 printf ("%*s ", format == with_commas ? 0 : block_size_width,
3858 human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
3859 ST_NBLOCKSIZE, output_block_size));
3862 printf ("%*s ", format == with_commas ? 0 : scontext_width,
3863 (f->scontext ? f->scontext : "?"));
3865 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3866 f->stat_ok, f->filetype, NULL);
3868 if (indicator_style != none)
3869 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3872 /* Given these arguments describing a file, return the single-byte
3873 type indicator, or 0. */
3875 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3879 if (stat_ok ? S_ISREG (mode) : type == normal)
3881 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
3888 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
3890 else if (indicator_style == slash)
3892 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
3894 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
3896 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
3898 else if (stat_ok && S_ISDOOR (mode))
3907 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3909 char c = get_type_indicator (stat_ok, mode, type);
3915 print_color_indicator (const char *name, mode_t mode, int linkok,
3916 bool stat_ok, enum filetype filetype)
3919 struct color_ext_type *ext; /* Color extension */
3920 size_t len; /* Length of name */
3922 /* Is this a nonexistent file? If so, linkok == -1. */
3924 if (linkok == -1 && color_indicator[C_MISSING].string != NULL)
3928 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
3929 type = filetype_indicator[filetype];
3936 if ((mode & S_ISUID) != 0)
3938 else if ((mode & S_ISGID) != 0)
3940 else if ((mode & S_IXUGO) != 0)
3943 else if (S_ISDIR (mode))
3945 if ((mode & S_ISVTX) && (mode & S_IWOTH))
3946 type = C_STICKY_OTHER_WRITABLE;
3947 else if ((mode & S_IWOTH) != 0)
3948 type = C_OTHER_WRITABLE;
3949 else if ((mode & S_ISVTX) != 0)
3954 else if (S_ISLNK (mode))
3955 type = ((!linkok && color_indicator[C_ORPHAN].string)
3956 ? C_ORPHAN : C_LINK);
3957 else if (S_ISFIFO (mode))
3959 else if (S_ISSOCK (mode))
3961 else if (S_ISBLK (mode))
3963 else if (S_ISCHR (mode))
3965 else if (S_ISDOOR (mode))
3969 /* Classify a file of some other type as C_ORPHAN. */
3974 /* Check the file's suffix only if still classified as C_FILE. */
3978 /* Test if NAME has a recognized suffix. */
3980 len = strlen (name);
3981 name += len; /* Pointer to final \0. */
3982 for (ext = color_ext_list; ext != NULL; ext = ext->next)
3984 if (ext->ext.len <= len
3985 && strncmp (name - ext->ext.len, ext->ext.string,
3991 put_indicator (&color_indicator[C_LEFT]);
3992 put_indicator (ext ? &(ext->seq) : &color_indicator[type]);
3993 put_indicator (&color_indicator[C_RIGHT]);
3996 /* Output a color indicator (which may contain nulls). */
3998 put_indicator (const struct bin_str *ind)
4005 for (i = ind->len; i != 0; --i)
4010 length_of_file_name_and_frills (const struct fileinfo *f)
4014 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4017 len += 1 + (format == with_commas
4018 ? strlen (umaxtostr (f->stat.st_ino, buf))
4019 : inode_number_width);
4021 if (print_block_size)
4022 len += 1 + (format == with_commas
4023 ? strlen (human_readable (ST_NBLOCKS (f->stat), buf,
4024 human_output_opts, ST_NBLOCKSIZE,
4026 : block_size_width);
4029 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
4031 quote_name (NULL, f->name, filename_quoting_options, &name_width);
4034 if (indicator_style != none)
4036 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4044 print_many_per_line (void)
4046 size_t row; /* Current row. */
4047 size_t cols = calculate_columns (true);
4048 struct column_info const *line_fmt = &column_info[cols - 1];
4050 /* Calculate the number of rows that will be in each column except possibly
4051 for a short column on the right. */
4052 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
4054 for (row = 0; row < rows; row++)
4057 size_t filesno = row;
4060 /* Print the next row. */
4063 struct fileinfo const *f = sorted_file[filesno];
4064 size_t name_length = length_of_file_name_and_frills (f);
4065 size_t max_name_length = line_fmt->col_arr[col++];
4066 print_file_name_and_frills (f);
4069 if (filesno >= cwd_n_used)
4072 indent (pos + name_length, pos + max_name_length);
4073 pos += max_name_length;
4080 print_horizontal (void)
4084 size_t cols = calculate_columns (false);
4085 struct column_info const *line_fmt = &column_info[cols - 1];
4086 struct fileinfo const *f = sorted_file[0];
4087 size_t name_length = length_of_file_name_and_frills (f);
4088 size_t max_name_length = line_fmt->col_arr[0];
4090 /* Print first entry. */
4091 print_file_name_and_frills (f);
4094 for (filesno = 1; filesno < cwd_n_used; ++filesno)
4096 size_t col = filesno % cols;
4105 indent (pos + name_length, pos + max_name_length);
4106 pos += max_name_length;
4109 f = sorted_file[filesno];
4110 print_file_name_and_frills (f);
4112 name_length = length_of_file_name_and_frills (f);
4113 max_name_length = line_fmt->col_arr[col];
4119 print_with_commas (void)
4124 for (filesno = 0; filesno < cwd_n_used; filesno++)
4126 struct fileinfo const *f = sorted_file[filesno];
4127 size_t len = length_of_file_name_and_frills (f);
4133 if (pos + len + 2 < line_length)
4145 putchar (separator);
4148 print_file_name_and_frills (f);
4154 /* Assuming cursor is at position FROM, indent up to position TO.
4155 Use a TAB character instead of two or more spaces whenever possible. */
4158 indent (size_t from, size_t to)
4162 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4165 from += tabsize - from % tabsize;
4175 /* Put DIRNAME/NAME into DEST, handling `.' and `/' properly. */
4176 /* FIXME: maybe remove this function someday. See about using a
4177 non-malloc'ing version of file_name_concat. */
4180 attach (char *dest, const char *dirname, const char *name)
4182 const char *dirnamep = dirname;
4184 /* Copy dirname if it is not ".". */
4185 if (dirname[0] != '.' || dirname[1] != 0)
4188 *dest++ = *dirnamep++;
4189 /* Add '/' if `dirname' doesn't already end with it. */
4190 if (dirnamep > dirname && dirnamep[-1] != '/')
4198 /* Allocate enough column info suitable for the current number of
4199 files and display columns, and initialize the info to represent the
4200 narrowest possible columns. */
4203 init_column_info (void)
4206 size_t max_cols = MIN (max_idx, cwd_n_used);
4208 /* Currently allocated columns in column_info. */
4209 static size_t column_info_alloc;
4211 if (column_info_alloc < max_cols)
4213 size_t new_column_info_alloc;
4216 if (max_cols < max_idx / 2)
4218 /* The number of columns is far less than the display width
4219 allows. Grow the allocation, but only so that it's
4220 double the current requirements. If the display is
4221 extremely wide, this avoids allocating a lot of memory
4222 that is never needed. */
4223 column_info = xnrealloc (column_info, max_cols,
4224 2 * sizeof *column_info);
4225 new_column_info_alloc = 2 * max_cols;
4229 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4230 new_column_info_alloc = max_idx;
4233 /* Allocate the new size_t objects by computing the triangle
4234 formula n * (n + 1) / 2, except that we don't need to
4235 allocate the part of the triangle that we've already
4236 allocated. Check for address arithmetic overflow. */
4238 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4239 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4240 size_t t = s * column_info_growth;
4241 if (s < new_column_info_alloc || t / column_info_growth != s)
4243 p = xnmalloc (t / 2, sizeof *p);
4246 /* Grow the triangle by parceling out the cells just allocated. */
4247 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4249 column_info[i].col_arr = p;
4253 column_info_alloc = new_column_info_alloc;
4256 for (i = 0; i < max_cols; ++i)
4260 column_info[i].valid_len = true;
4261 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4262 for (j = 0; j <= i; ++j)
4263 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4267 /* Calculate the number of columns needed to represent the current set
4268 of files in the current display width. */
4271 calculate_columns (bool by_columns)
4273 size_t filesno; /* Index into cwd_file. */
4274 size_t cols; /* Number of files across. */
4276 /* Normally the maximum number of columns is determined by the
4277 screen width. But if few files are available this might limit it
4279 size_t max_cols = MIN (max_idx, cwd_n_used);
4281 init_column_info ();
4283 /* Compute the maximum number of possible columns. */
4284 for (filesno = 0; filesno < cwd_n_used; ++filesno)
4286 struct fileinfo const *f = sorted_file[filesno];
4287 size_t name_length = length_of_file_name_and_frills (f);
4290 for (i = 0; i < max_cols; ++i)
4292 if (column_info[i].valid_len)
4294 size_t idx = (by_columns
4295 ? filesno / ((cwd_n_used + i) / (i + 1))
4296 : filesno % (i + 1));
4297 size_t real_length = name_length + (idx == i ? 0 : 2);
4299 if (column_info[i].col_arr[idx] < real_length)
4301 column_info[i].line_len += (real_length
4302 - column_info[i].col_arr[idx]);
4303 column_info[i].col_arr[idx] = real_length;
4304 column_info[i].valid_len = (column_info[i].line_len
4311 /* Find maximum allowed columns. */
4312 for (cols = max_cols; 1 < cols; --cols)
4314 if (column_info[cols - 1].valid_len)
4324 if (status != EXIT_SUCCESS)
4325 fprintf (stderr, _("Try `%s --help' for more information.\n"),
4329 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4331 List information about the FILEs (the current directory by default).\n\
4332 Sort entries alphabetically if none of -cftuvSUX nor --sort.\n\
4336 Mandatory arguments to long options are mandatory for short options too.\n\
4339 -a, --all do not ignore entries starting with .\n\
4340 -A, --almost-all do not list implied . and ..\n\
4341 --author with -l, print the author of each file\n\
4342 -b, --escape print octal escapes for nongraphic characters\n\
4345 --block-size=SIZE use SIZE-byte blocks\n\
4346 -B, --ignore-backups do not list implied entries ending with ~\n\
4347 -c with -lt: sort by, and show, ctime (time of last\n\
4348 modification of file status information)\n\
4349 with -l: show ctime and sort by name\n\
4350 otherwise: sort by ctime\n\
4353 -C list entries by columns\n\
4354 --color[=WHEN] control whether color is used to distinguish file\n\
4355 types. WHEN may be `never', `always', or `auto'\n\
4356 -d, --directory list directory entries instead of contents,\n\
4357 and do not dereference symbolic links\n\
4358 -D, --dired generate output designed for Emacs' dired mode\n\
4361 -f do not sort, enable -aU, disable -ls --color\n\
4362 -F, --classify append indicator (one of */=>@|) to entries\n\
4363 --file-type likewise, except do not append `*'\n\
4364 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4365 single-column -1, verbose -l, vertical -C\n\
4366 --full-time like -l --time-style=full-iso\n\
4369 -g like -l, but do not list owner\n\
4372 --group-directories-first\n\
4373 group directories before files\n\
4376 -G, --no-group in a long listing, don't print group names\n\
4377 -h, --human-readable with -l, print sizes in human readable format\n\
4378 (e.g., 1K 234M 2G)\n\
4379 --si likewise, but use powers of 1000 not 1024\n\
4382 -H, --dereference-command-line\n\
4383 follow symbolic links listed on the command line\n\
4384 --dereference-command-line-symlink-to-dir\n\
4385 follow each command line symbolic link\n\
4386 that points to a directory\n\
4387 --hide=PATTERN do not list implied entries matching shell PATTERN\n\
4388 (overridden by -a or -A)\n\
4391 --indicator-style=WORD append indicator with style WORD to entry names:\n\
4392 none (default), slash (-p),\n\
4393 file-type (--file-type), classify (-F)\n\
4394 -i, --inode print the index number of each file\n\
4395 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\n\
4396 -k like --block-size=1K\n\
4399 -l use a long listing format\n\
4400 -L, --dereference when showing file information for a symbolic\n\
4401 link, show information for the file the link\n\
4402 references rather than for the link itself\n\
4403 -m fill width with a comma separated list of entries\n\
4406 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4407 -N, --literal print raw entry names (don't treat e.g. control\n\
4408 characters specially)\n\
4409 -o like -l, but do not list group information\n\
4410 -p, --indicator-style=slash\n\
4411 append / indicator to directories\n\
4414 -q, --hide-control-chars print ? instead of non graphic characters\n\
4415 --show-control-chars show non graphic characters as-is (default\n\
4416 unless program is `ls' and output is a terminal)\n\
4417 -Q, --quote-name enclose entry names in double quotes\n\
4418 --quoting-style=WORD use quoting style WORD for entry names:\n\
4419 literal, locale, shell, shell-always, c, escape\n\
4422 -r, --reverse reverse order while sorting\n\
4423 -R, --recursive list subdirectories recursively\n\
4424 -s, --size print the size of each file, in blocks\n\
4427 -S sort by file size\n\
4428 --sort=WORD sort by WORD instead of name: none -U,\n\
4429 extension -X, size -S, time -t, version -v\n\
4430 --time=WORD with -l, show time as WORD instead of modification\n\
4431 time: atime -u, access -u, use -u, ctime -c,\n\
4432 or status -c; use specified time as sort key\n\
4436 --time-style=STYLE with -l, show times using style STYLE:\n\
4437 full-iso, long-iso, iso, locale, +FORMAT.\n\
4438 FORMAT is interpreted like `date'; if FORMAT is\n\
4439 FORMAT1<newline>FORMAT2, FORMAT1 applies to\n\
4440 non-recent files and FORMAT2 to recent files;\n\
4441 if STYLE is prefixed with `posix-', STYLE\n\
4442 takes effect only outside the POSIX locale\n\
4445 -t sort by modification time\n\
4446 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4449 -u with -lt: sort by, and show, access time\n\
4450 with -l: show access time and sort by name\n\
4451 otherwise: sort by access time\n\
4452 -U do not sort; list entries in directory order\n\
4453 -v sort by version\n\
4456 -w, --width=COLS assume screen width instead of current value\n\
4457 -x list entries by lines instead of by columns\n\
4458 -X sort alphabetically by entry extension\n\
4459 -Z, --context print any SELinux security context of each file\n\
4460 -1 list one file per line\n\
4462 fputs (HELP_OPTION_DESCRIPTION, stdout);
4463 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4465 SIZE may be (or may be an integer optionally followed by) one of following:\n\
4466 kB 1000, K 1024, MB 1000*1000, M 1024*1024, and so on for G, T, P, E, Z, Y.\n\
4470 By default, color is not used to distinguish types of files. That is\n\
4471 equivalent to using --color=none. Using the --color option without the\n\
4472 optional WHEN argument is equivalent to using --color=always. With\n\
4473 --color=auto, color codes are output only if standard output is connected\n\
4474 to a terminal (tty). The environment variable LS_COLORS can influence the\n\
4475 colors, and can be set easily by the dircolors command.\n\
4479 Exit status is 0 if OK, 1 if minor problems, 2 if serious trouble.\n\
4481 emit_bug_reporting_address ();