1 /* `dir', `vdir' and `ls' directory listing programs for GNU.
2 Copyright (C) 85, 88, 90, 91, 1995-2008 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 \
114 proper_name ("Richard M. Stallman"), \
115 proper_name ("David MacKenzie")
117 #define obstack_chunk_alloc malloc
118 #define obstack_chunk_free free
120 /* Return an int indicating the result of comparing two integers.
121 Subtracting doesn't always work, due to overflow. */
122 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
124 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
125 # define st_author st_uid
142 /* Display letters and indicators for each filetype.
143 Keep these in sync with enum filetype. */
144 static char const filetype_letter[] = "?pcdb-lswd";
146 /* Ensure that filetype and filetype_letter have the same
147 number of elements. */
148 verify (sizeof filetype_letter - 1 == arg_directory + 1);
150 #define FILETYPE_INDICATORS \
152 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
153 C_LINK, C_SOCK, C_FILE, C_DIR \
162 /* For symbolic link, name of the file linked to, otherwise zero. */
167 enum filetype filetype;
169 /* For symbolic link and long listing, st_mode of file linked to, otherwise
173 /* SELinux security context. */
174 security_context_t scontext;
178 /* For symbolic link and color printing, true if linked-to file
179 exists, otherwise false. */
182 /* For long listings, true if the file has an access control list,
183 or an SELinux security context. */
187 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
189 /* Null is a valid character in a color indicator (think about Epson
190 printers, for example) so we have to use a length/buffer string
195 size_t len; /* Number of bytes */
196 const char *string; /* Pointer to the same */
200 # define tcgetpgrp(Fd) 0
203 static size_t quote_name (FILE *out, const char *name,
204 struct quoting_options const *options,
206 static char *make_link_name (char const *name, char const *linkname);
207 static int decode_switches (int argc, char **argv);
208 static bool file_ignored (char const *name);
209 static uintmax_t gobble_file (char const *name, enum filetype type,
210 ino_t inode, bool command_line_arg,
211 char const *dirname);
212 static bool print_color_indicator (const char *name, mode_t mode, int linkok,
213 bool stat_ok, enum filetype type);
214 static void put_indicator (const struct bin_str *ind);
215 static void add_ignore_pattern (const char *pattern);
216 static void attach (char *dest, const char *dirname, const char *name);
217 static void clear_files (void);
218 static void extract_dirs_from_files (char const *dirname,
219 bool command_line_arg);
220 static void get_link_name (char const *filename, struct fileinfo *f,
221 bool command_line_arg);
222 static void indent (size_t from, size_t to);
223 static size_t calculate_columns (bool by_columns);
224 static void print_current_files (void);
225 static void print_dir (char const *name, char const *realname,
226 bool command_line_arg);
227 static void print_file_name_and_frills (const struct fileinfo *f);
228 static void print_horizontal (void);
229 static int format_user_width (uid_t u);
230 static int format_group_width (gid_t g);
231 static void print_long_format (const struct fileinfo *f);
232 static void print_many_per_line (void);
233 static void print_name_with_quoting (const char *p, mode_t mode,
234 int linkok, bool stat_ok,
236 struct obstack *stack);
237 static void prep_non_filename_text (void);
238 static void print_type_indicator (bool stat_ok, mode_t mode,
240 static void print_with_commas (void);
241 static void queue_directory (char const *name, char const *realname,
242 bool command_line_arg);
243 static void sort_files (void);
244 static void parse_ls_color (void);
245 void usage (int status);
247 /* Initial size of hash table.
248 Most hierarchies are likely to be shallower than this. */
249 #define INITIAL_TABLE_SIZE 30
251 /* The set of `active' directories, from the current command-line argument
252 to the level in the hierarchy at which files are being listed.
253 A directory is represented by its device and inode numbers (struct dev_ino).
254 A directory is added to this set when ls begins listing it or its
255 entries, and it is removed from the set just after ls has finished
256 processing it. This set is used solely to detect loops, e.g., with
257 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
258 static Hash_table *active_dir_set;
260 #define LOOP_DETECT (!!active_dir_set)
262 /* The table of files in the current directory:
264 `cwd_file' points to a vector of `struct fileinfo', one per file.
265 `cwd_n_alloc' is the number of elements space has been allocated for.
266 `cwd_n_used' is the number actually in use. */
268 /* Address of block containing the files that are described. */
269 static struct fileinfo *cwd_file;
271 /* Length of block that `cwd_file' points to, measured in files. */
272 static size_t cwd_n_alloc;
274 /* Index of first unused slot in `cwd_file'. */
275 static size_t cwd_n_used;
277 /* Vector of pointers to files, in proper sorted order, and the number
278 of entries allocated for it. */
279 static void **sorted_file;
280 static size_t sorted_file_alloc;
282 /* When true, in a color listing, color each symlink name according to the
283 type of file it points to. Otherwise, color them according to the `ln'
284 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
285 regardless. This is set when `ln=target' appears in LS_COLORS. */
287 static bool color_symlink_as_referent;
289 /* mode of appropriate file for colorization */
290 #define FILE_OR_LINK_MODE(File) \
291 ((color_symlink_as_referent & (File)->linkok) \
292 ? (File)->linkmode : (File)->stat.st_mode)
295 /* Record of one pending directory waiting to be listed. */
300 /* If the directory is actually the file pointed to by a symbolic link we
301 were told to list, `realname' will contain the name of the symbolic
302 link, otherwise zero. */
304 bool command_line_arg;
305 struct pending *next;
308 static struct pending *pending_dirs;
310 /* Current time in seconds and nanoseconds since 1970, updated as
311 needed when deciding whether a file is recent. */
313 static struct timespec current_time;
315 static bool print_scontext;
316 static char UNKNOWN_SECURITY_CONTEXT[] = "?";
318 /* Whether any of the files has an ACL. This affects the width of the
321 static bool any_has_acl;
323 /* The number of columns to use for columns containing inode numbers,
324 block sizes, link counts, owners, groups, authors, major device
325 numbers, minor device numbers, and file sizes, respectively. */
327 static int inode_number_width;
328 static int block_size_width;
329 static int nlink_width;
330 static int scontext_width;
331 static int owner_width;
332 static int group_width;
333 static int author_width;
334 static int major_device_number_width;
335 static int minor_device_number_width;
336 static int file_size_width;
340 /* long_format for lots of info, one per line.
341 one_per_line for just names, one per line.
342 many_per_line for just names, many per line, sorted vertically.
343 horizontal for just names, many per line, sorted horizontally.
344 with_commas for just names, many per line, separated by commas.
346 -l (and other options that imply -l), -1, -C, -x and -m control
351 long_format, /* -l and other options that imply -l */
352 one_per_line, /* -1 */
353 many_per_line, /* -C */
358 static enum format format;
360 /* `full-iso' uses full ISO-style dates and times. `long-iso' uses longer
361 ISO-style time stamps, though shorter than `full-iso'. `iso' uses shorter
362 ISO-style time stamps. `locale' uses locale-dependent time stamps. */
365 full_iso_time_style, /* --time-style=full-iso */
366 long_iso_time_style, /* --time-style=long-iso */
367 iso_time_style, /* --time-style=iso */
368 locale_time_style /* --time-style=locale */
371 static char const *const time_style_args[] =
373 "full-iso", "long-iso", "iso", "locale", NULL
375 static enum time_style const time_style_types[] =
377 full_iso_time_style, long_iso_time_style, iso_time_style,
380 ARGMATCH_VERIFY (time_style_args, time_style_types);
382 /* Type of time to print or sort by. Controlled by -c and -u.
383 The values of each item of this enum are important since they are
384 used as indices in the sort functions array (see sort_files()). */
388 time_mtime, /* default */
391 time_numtypes /* the number of elements of this enum */
394 static enum time_type time_type;
396 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
397 The values of each item of this enum are important since they are
398 used as indices in the sort functions array (see sort_files()). */
402 sort_none = -1, /* -U */
403 sort_name, /* default */
404 sort_extension, /* -X */
406 sort_version, /* -v */
408 sort_numtypes /* the number of elements of this enum */
411 static enum sort_type sort_type;
413 /* Direction of sort.
414 false means highest first if numeric,
415 lowest first if alphabetic;
416 these are the defaults.
417 true means the opposite order in each case. -r */
419 static bool sort_reverse;
421 /* True means to display owner information. -g turns this off. */
423 static bool print_owner = true;
425 /* True means to display author information. */
427 static bool print_author;
429 /* True means to display group information. -G and -o turn this off. */
431 static bool print_group = true;
433 /* True means print the user and group id's as numbers rather
436 static bool numeric_ids;
438 /* True means mention the size in blocks of each file. -s */
440 static bool print_block_size;
442 /* Human-readable options for output. */
443 static int human_output_opts;
445 /* The units to use when printing sizes other than file sizes. */
446 static uintmax_t output_block_size;
448 /* Likewise, but for file sizes. */
449 static uintmax_t file_output_block_size = 1;
451 /* Follow the output with a special string. Using this format,
452 Emacs' dired mode starts up twice as fast, and can handle all
453 strange characters in file names. */
456 /* `none' means don't mention the type of files.
457 `slash' means mention directories only, with a '/'.
458 `file_type' means mention file types.
459 `classify' means mention file types and mark executables.
461 Controlled by -F, -p, and --indicator-style. */
465 none, /* --indicator-style=none */
466 slash, /* -p, --indicator-style=slash */
467 file_type, /* --indicator-style=file-type */
468 classify /* -F, --indicator-style=classify */
471 static enum indicator_style indicator_style;
473 /* Names of indicator styles. */
474 static char const *const indicator_style_args[] =
476 "none", "slash", "file-type", "classify", NULL
478 static enum indicator_style const indicator_style_types[] =
480 none, slash, file_type, classify
482 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
484 /* True means use colors to mark types. Also define the different
485 colors as well as the stuff for the LS_COLORS environment variable.
486 The LS_COLORS variable is now in a termcap-like format. */
488 static bool print_with_color;
490 /* Whether we used any colors in the output so far. If so, we will
491 need to restore the default color later. If not, we will need to
492 call prep_non_filename_text before using color for the first time. */
494 static bool used_color = false;
498 color_never, /* 0: default or --color=never */
499 color_always, /* 1: --color=always */
500 color_if_tty /* 2: --color=tty */
503 enum Dereference_symlink
507 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
508 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
509 DEREF_ALWAYS /* -L */
514 C_LEFT, C_RIGHT, C_END, C_RESET, C_NORM, C_FILE, C_DIR, C_LINK,
516 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
517 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE
520 static const char *const indicator_name[]=
522 "lc", "rc", "ec", "rs", "no", "fi", "di", "ln", "pi", "so",
523 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
527 struct color_ext_type
529 struct bin_str ext; /* The extension we're looking for */
530 struct bin_str seq; /* The sequence to output when we do */
531 struct color_ext_type *next; /* Next in list */
534 static struct bin_str color_indicator[] =
536 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
537 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
538 { 0, NULL }, /* ec: End color (replaces lc+no+rc) */
539 { LEN_STR_PAIR ("0") }, /* rs: Reset to ordinary colors */
540 { 0, NULL }, /* no: Normal */
541 { 0, NULL }, /* fi: File: default */
542 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
543 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
544 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
545 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
546 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
547 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
548 { 0, NULL }, /* mi: Missing file: undefined */
549 { 0, NULL }, /* or: Orphaned symlink: undefined */
550 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
551 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
552 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
553 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
554 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
555 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
556 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
560 static struct color_ext_type *color_ext_list = NULL;
562 /* Buffer for color sequences */
563 static char *color_buf;
565 /* True means to check for orphaned symbolic link, for displaying
568 static bool check_symlink_color;
570 /* True means mention the inode number of each file. -i */
572 static bool print_inode;
574 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
575 other options that imply -l), and -L. */
577 static enum Dereference_symlink dereference;
579 /* True means when a directory is found, display info on its
582 static bool recursive;
584 /* True means when an argument is a directory name, display info
587 static bool immediate_dirs;
589 /* True means that directories are grouped before files. */
591 static bool directories_first;
593 /* Which files to ignore. */
597 /* Ignore files whose names start with `.', and files specified by
598 --hide and --ignore. */
601 /* Ignore `.', `..', and files specified by --ignore. */
602 IGNORE_DOT_AND_DOTDOT,
604 /* Ignore only files specified by --ignore. */
608 /* A linked list of shell-style globbing patterns. If a non-argument
609 file name matches any of these patterns, it is ignored.
610 Controlled by -I. Multiple -I options accumulate.
611 The -B option adds `*~' and `.*~' to this list. */
613 struct ignore_pattern
616 struct ignore_pattern *next;
619 static struct ignore_pattern *ignore_patterns;
621 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
622 variable itself to be ignored. */
623 static struct ignore_pattern *hide_patterns;
625 /* True means output nongraphic chars in file names as `?'.
626 (-q, --hide-control-chars)
627 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
628 independent. The algorithm is: first, obey the quoting style to get a
629 string representing the file name; then, if qmark_funny_chars is set,
630 replace all nonprintable chars in that string with `?'. It's necessary
631 to replace nonprintable chars even in quoted strings, because we don't
632 want to mess up the terminal if control chars get sent to it, and some
633 quoting methods pass through control chars as-is. */
634 static bool qmark_funny_chars;
636 /* Quoting options for file and dir name output. */
638 static struct quoting_options *filename_quoting_options;
639 static struct quoting_options *dirname_quoting_options;
641 /* The number of chars per hardware tab stop. Setting this to zero
642 inhibits the use of TAB characters for separating columns. -T */
643 static size_t tabsize;
645 /* True means print each directory name before listing it. */
647 static bool print_dir_name;
649 /* The line length to use for breaking lines in many-per-line format.
650 Can be set with -w. */
652 static size_t line_length;
654 /* If true, the file listing format requires that stat be called on
657 static bool format_needs_stat;
659 /* Similar to `format_needs_stat', but set if only the file type is
662 static bool format_needs_type;
664 /* An arbitrary limit on the number of bytes in a printed time stamp.
665 This is set to a relatively small value to avoid the need to worry
666 about denial-of-service attacks on servers that run "ls" on behalf
667 of remote clients. 1000 bytes should be enough for any practical
668 time stamp format. */
670 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
672 /* strftime formats for non-recent and recent files, respectively, in
675 static char const *long_time_format[2] =
677 /* strftime format for non-recent files (older than 6 months), in
678 -l output. This should contain the year, month and day (at
679 least), in an order that is understood by people in your
680 locale's territory. Please try to keep the number of used
681 screen columns small, because many people work in windows with
682 only 80 columns. But make this as wide as the other string
683 below, for recent files. */
685 /* strftime format for recent files (younger than 6 months), in -l
686 output. This should contain the month, day and time (at
687 least), in an order that is understood by people in your
688 locale's territory. Please try to keep the number of used
689 screen columns small, because many people work in windows with
690 only 80 columns. But make this as wide as the other string
691 above, for non-recent files. */
695 /* The set of signals that are caught. */
697 static sigset_t caught_signals;
699 /* If nonzero, the value of the pending fatal signal. */
701 static sig_atomic_t volatile interrupt_signal;
703 /* A count of the number of pending stop signals that have been received. */
705 static sig_atomic_t volatile stop_signal_count;
707 /* Desired exit status. */
709 static int exit_status;
714 /* "ls" had a minor problem (e.g., it could not stat a directory
716 LS_MINOR_PROBLEM = 1,
718 /* "ls" had more serious trouble. */
722 /* For long options that have no equivalent short option, use a
723 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
726 AUTHOR_OPTION = CHAR_MAX + 1,
729 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
730 FILE_TYPE_INDICATOR_OPTION,
733 GROUP_DIRECTORIES_FIRST_OPTION,
735 INDICATOR_STYLE_OPTION,
736 QUOTING_STYLE_OPTION,
737 SHOW_CONTROL_CHARS_OPTION,
744 static struct option const long_options[] =
746 {"all", no_argument, NULL, 'a'},
747 {"escape", no_argument, NULL, 'b'},
748 {"directory", no_argument, NULL, 'd'},
749 {"dired", no_argument, NULL, 'D'},
750 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
751 {"group-directories-first", no_argument, NULL,
752 GROUP_DIRECTORIES_FIRST_OPTION},
753 {"human-readable", no_argument, NULL, 'h'},
754 {"inode", no_argument, NULL, 'i'},
755 {"numeric-uid-gid", no_argument, NULL, 'n'},
756 {"no-group", no_argument, NULL, 'G'},
757 {"hide-control-chars", no_argument, NULL, 'q'},
758 {"reverse", no_argument, NULL, 'r'},
759 {"size", no_argument, NULL, 's'},
760 {"width", required_argument, NULL, 'w'},
761 {"almost-all", no_argument, NULL, 'A'},
762 {"ignore-backups", no_argument, NULL, 'B'},
763 {"classify", no_argument, NULL, 'F'},
764 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
765 {"si", no_argument, NULL, SI_OPTION},
766 {"dereference-command-line", no_argument, NULL, 'H'},
767 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
768 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
769 {"hide", required_argument, NULL, HIDE_OPTION},
770 {"ignore", required_argument, NULL, 'I'},
771 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
772 {"dereference", no_argument, NULL, 'L'},
773 {"literal", no_argument, NULL, 'N'},
774 {"quote-name", no_argument, NULL, 'Q'},
775 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
776 {"recursive", no_argument, NULL, 'R'},
777 {"format", required_argument, NULL, FORMAT_OPTION},
778 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
779 {"sort", required_argument, NULL, SORT_OPTION},
780 {"tabsize", required_argument, NULL, 'T'},
781 {"time", required_argument, NULL, TIME_OPTION},
782 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
783 {"color", optional_argument, NULL, COLOR_OPTION},
784 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
785 {"context", no_argument, 0, 'Z'},
786 {"author", no_argument, NULL, AUTHOR_OPTION},
787 {GETOPT_HELP_OPTION_DECL},
788 {GETOPT_VERSION_OPTION_DECL},
792 static char const *const format_args[] =
794 "verbose", "long", "commas", "horizontal", "across",
795 "vertical", "single-column", NULL
797 static enum format const format_types[] =
799 long_format, long_format, with_commas, horizontal, horizontal,
800 many_per_line, one_per_line
802 ARGMATCH_VERIFY (format_args, format_types);
804 static char const *const sort_args[] =
806 "none", "time", "size", "extension", "version", NULL
808 static enum sort_type const sort_types[] =
810 sort_none, sort_time, sort_size, sort_extension, sort_version
812 ARGMATCH_VERIFY (sort_args, sort_types);
814 static char const *const time_args[] =
816 "atime", "access", "use", "ctime", "status", NULL
818 static enum time_type const time_types[] =
820 time_atime, time_atime, time_atime, time_ctime, time_ctime
822 ARGMATCH_VERIFY (time_args, time_types);
824 static char const *const color_args[] =
826 /* force and none are for compatibility with another color-ls version */
827 "always", "yes", "force",
828 "never", "no", "none",
829 "auto", "tty", "if-tty", NULL
831 static enum color_type const color_types[] =
833 color_always, color_always, color_always,
834 color_never, color_never, color_never,
835 color_if_tty, color_if_tty, color_if_tty
837 ARGMATCH_VERIFY (color_args, color_types);
839 /* Information about filling a column. */
847 /* Array with information about column filledness. */
848 static struct column_info *column_info;
850 /* Maximum number of columns ever possible for this display. */
851 static size_t max_idx;
853 /* The minimum width of a column is 3: 1 character for the name and 2
854 for the separating white space. */
855 #define MIN_COLUMN_WIDTH 3
858 /* This zero-based index is used solely with the --dired option.
859 When that option is in effect, this counter is incremented for each
860 byte of output generated by this program so that the beginning
861 and ending indices (in that output) of every file name can be recorded
862 and later output themselves. */
863 static size_t dired_pos;
865 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
867 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
868 #define DIRED_FPUTS(s, stream, s_len) \
869 do {fputs (s, stream); dired_pos += s_len;} while (0)
871 /* Like DIRED_FPUTS, but for use when S is a literal string. */
872 #define DIRED_FPUTS_LITERAL(s, stream) \
873 do {fputs (s, stream); dired_pos += sizeof (s) - 1;} while (0)
875 #define DIRED_INDENT() \
879 DIRED_FPUTS_LITERAL (" ", stdout); \
883 /* With --dired, store pairs of beginning and ending indices of filenames. */
884 static struct obstack dired_obstack;
886 /* With --dired, store pairs of beginning and ending indices of any
887 directory names that appear as headers (just before `total' line)
888 for lists of directory entries. Such directory names are seen when
889 listing hierarchies using -R and when a directory is listed with at
890 least one other command line argument. */
891 static struct obstack subdired_obstack;
893 /* Save the current index on the specified obstack, OBS. */
894 #define PUSH_CURRENT_DIRED_POS(obs) \
898 obstack_grow (obs, &dired_pos, sizeof (dired_pos)); \
902 /* With -R, this stack is used to help detect directory cycles.
903 The device/inode pairs on this stack mirror the pairs in the
904 active_dir_set hash table. */
905 static struct obstack dev_ino_obstack;
907 /* Push a pair onto the device/inode stack. */
908 #define DEV_INO_PUSH(Dev, Ino) \
911 struct dev_ino *di; \
912 obstack_blank (&dev_ino_obstack, sizeof (struct dev_ino)); \
913 di = -1 + (struct dev_ino *) obstack_next_free (&dev_ino_obstack); \
914 di->st_dev = (Dev); \
915 di->st_ino = (Ino); \
919 /* Pop a dev/ino struct off the global dev_ino_obstack
920 and return that struct. */
921 static struct dev_ino
924 assert (sizeof (struct dev_ino) <= obstack_object_size (&dev_ino_obstack));
925 obstack_blank (&dev_ino_obstack, -(int) (sizeof (struct dev_ino)));
926 return *(struct dev_ino *) obstack_next_free (&dev_ino_obstack);
929 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
934 assert (0 <= stat (Name, &sb)); \
935 assert (sb.st_dev == Di.st_dev); \
936 assert (sb.st_ino == Di.st_ino); \
941 /* Write to standard output PREFIX, followed by the quoting style and
942 a space-separated list of the integers stored in OS all on one line. */
945 dired_dump_obstack (const char *prefix, struct obstack *os)
949 n_pos = obstack_object_size (os) / sizeof (dired_pos);
955 pos = (size_t *) obstack_finish (os);
956 fputs (prefix, stdout);
957 for (i = 0; i < n_pos; i++)
958 printf (" %lu", (unsigned long int) pos[i]);
964 dev_ino_hash (void const *x, size_t table_size)
966 struct dev_ino const *p = x;
967 return (uintmax_t) p->st_ino % table_size;
971 dev_ino_compare (void const *x, void const *y)
973 struct dev_ino const *a = x;
974 struct dev_ino const *b = y;
975 return SAME_INODE (*a, *b) ? true : false;
979 dev_ino_free (void *x)
984 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
985 active directories. Return true if there is already a matching
986 entry in the table. */
989 visit_dir (dev_t dev, ino_t ino)
992 struct dev_ino *ent_from_table;
995 ent = xmalloc (sizeof *ent);
999 /* Attempt to insert this entry into the table. */
1000 ent_from_table = hash_insert (active_dir_set, ent);
1002 if (ent_from_table == NULL)
1004 /* Insertion failed due to lack of memory. */
1008 found_match = (ent_from_table != ent);
1012 /* ent was not inserted, so free it. */
1020 free_pending_ent (struct pending *p)
1028 is_colored (enum indicator_no type)
1030 size_t len = color_indicator[type].len;
1031 char const *s = color_indicator[type].string;
1033 || (len == 1 && strncmp (s, "0", 1) == 0)
1034 || (len == 2 && strncmp (s, "00", 2) == 0));
1038 restore_default_color (void)
1040 put_indicator (&color_indicator[C_LEFT]);
1041 put_indicator (&color_indicator[C_RIGHT]);
1044 /* An ordinary signal was received; arrange for the program to exit. */
1047 sighandler (int sig)
1050 signal (sig, SIG_IGN);
1051 if (! interrupt_signal)
1052 interrupt_signal = sig;
1055 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1058 stophandler (int sig)
1061 signal (sig, stophandler);
1062 if (! interrupt_signal)
1063 stop_signal_count++;
1066 /* Process any pending signals. If signals are caught, this function
1067 should be called periodically. Ideally there should never be an
1068 unbounded amount of time when signals are not being processed.
1069 Signal handling can restore the default colors, so callers must
1070 immediately change colors after invoking this function. */
1073 process_signals (void)
1075 while (interrupt_signal | stop_signal_count)
1082 restore_default_color ();
1085 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1087 /* Reload interrupt_signal and stop_signal_count, in case a new
1088 signal was handled before sigprocmask took effect. */
1089 sig = interrupt_signal;
1090 stops = stop_signal_count;
1092 /* SIGTSTP is special, since the application can receive that signal
1093 more than once. In this case, don't set the signal handler to the
1094 default. Instead, just raise the uncatchable SIGSTOP. */
1097 stop_signal_count = stops - 1;
1101 signal (sig, SIG_DFL);
1103 /* Exit or suspend the program. */
1105 sigprocmask (SIG_SETMASK, &oldset, NULL);
1107 /* If execution reaches here, then the program has been
1108 continued (after being suspended). */
1113 main (int argc, char **argv)
1116 struct pending *thispend;
1119 /* The signals that are trapped, and the number of such signals. */
1120 static int const sig[] =
1122 /* This one is handled specially. */
1125 /* The usual suspects. */
1126 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1143 enum { nsigs = sizeof sig / sizeof sig[0] };
1146 bool caught_sig[nsigs];
1149 initialize_main (&argc, &argv);
1150 set_program_name (argv[0]);
1151 setlocale (LC_ALL, "");
1152 bindtextdomain (PACKAGE, LOCALEDIR);
1153 textdomain (PACKAGE);
1155 initialize_exit_failure (LS_FAILURE);
1156 atexit (close_stdout);
1158 #define N_ENTRIES(Array) (sizeof Array / sizeof *(Array))
1159 assert (N_ENTRIES (color_indicator) + 1 == N_ENTRIES (indicator_name));
1161 exit_status = EXIT_SUCCESS;
1162 print_dir_name = true;
1163 pending_dirs = NULL;
1165 current_time.tv_sec = TYPE_MINIMUM (time_t);
1166 current_time.tv_nsec = -1;
1168 i = decode_switches (argc, argv);
1170 if (print_with_color)
1173 /* Test print_with_color again, because the call to parse_ls_color
1174 may have just reset it -- e.g., if LS_COLORS is invalid. */
1175 if (print_with_color)
1177 /* Avoid following symbolic links when possible. */
1178 if (is_colored (C_ORPHAN)
1179 || (is_colored (C_EXEC) && color_symlink_as_referent)
1180 || (is_colored (C_MISSING) && format == long_format))
1181 check_symlink_color = true;
1183 /* If the standard output is a controlling terminal, watch out
1184 for signals, so that the colors can be restored to the
1185 default state if "ls" is suspended or interrupted. */
1187 if (0 <= tcgetpgrp (STDOUT_FILENO))
1191 struct sigaction act;
1193 sigemptyset (&caught_signals);
1194 for (j = 0; j < nsigs; j++)
1196 sigaction (sig[j], NULL, &act);
1197 if (act.sa_handler != SIG_IGN)
1198 sigaddset (&caught_signals, sig[j]);
1201 act.sa_mask = caught_signals;
1202 act.sa_flags = SA_RESTART;
1204 for (j = 0; j < nsigs; j++)
1205 if (sigismember (&caught_signals, sig[j]))
1207 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1208 sigaction (sig[j], &act, NULL);
1211 for (j = 0; j < nsigs; j++)
1213 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1216 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1217 siginterrupt (sig[j], 0);
1224 if (dereference == DEREF_UNDEFINED)
1225 dereference = ((immediate_dirs
1226 || indicator_style == classify
1227 || format == long_format)
1229 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1231 /* When using -R, initialize a data structure we'll use to
1232 detect any directory cycles. */
1235 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, NULL,
1239 if (active_dir_set == NULL)
1242 obstack_init (&dev_ino_obstack);
1245 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1246 || format == long_format
1248 || print_block_size;
1249 format_needs_type = (! format_needs_stat
1252 || indicator_style != none
1253 || directories_first));
1257 obstack_init (&dired_obstack);
1258 obstack_init (&subdired_obstack);
1262 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1272 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1274 queue_directory (".", NULL, true);
1278 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1284 if (!immediate_dirs)
1285 extract_dirs_from_files (NULL, true);
1286 /* `cwd_n_used' might be zero now. */
1289 /* In the following if/else blocks, it is sufficient to test `pending_dirs'
1290 (and not pending_dirs->name) because there may be no markers in the queue
1291 at this point. A marker may be enqueued when extract_dirs_from_files is
1292 called with a non-empty string or via print_dir. */
1295 print_current_files ();
1297 DIRED_PUTCHAR ('\n');
1299 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1300 print_dir_name = false;
1302 while (pending_dirs)
1304 thispend = pending_dirs;
1305 pending_dirs = pending_dirs->next;
1309 if (thispend->name == NULL)
1311 /* thispend->name == NULL means this is a marker entry
1312 indicating we've finished processing the directory.
1313 Use its dev/ino numbers to remove the corresponding
1314 entry from the active_dir_set hash table. */
1315 struct dev_ino di = dev_ino_pop ();
1316 struct dev_ino *found = hash_delete (active_dir_set, &di);
1317 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1319 dev_ino_free (found);
1320 free_pending_ent (thispend);
1325 print_dir (thispend->name, thispend->realname,
1326 thispend->command_line_arg);
1328 free_pending_ent (thispend);
1329 print_dir_name = true;
1332 if (print_with_color)
1337 restore_default_color ();
1340 /* Restore the default signal handling. */
1342 for (j = 0; j < nsigs; j++)
1343 if (sigismember (&caught_signals, sig[j]))
1344 signal (sig[j], SIG_DFL);
1346 for (j = 0; j < nsigs; j++)
1348 signal (sig[j], SIG_DFL);
1351 /* Act on any signals that arrived before the default was restored.
1352 This can process signals out of order, but there doesn't seem to
1353 be an easy way to do them in order, and the order isn't that
1354 important anyway. */
1355 for (j = stop_signal_count; j; j--)
1357 j = interrupt_signal;
1364 /* No need to free these since we're about to exit. */
1365 dired_dump_obstack ("//DIRED//", &dired_obstack);
1366 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1367 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1368 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1373 assert (hash_get_n_entries (active_dir_set) == 0);
1374 hash_free (active_dir_set);
1380 /* Set all the option flags according to the switches specified.
1381 Return the index of the first non-option argument. */
1384 decode_switches (int argc, char **argv)
1386 char *time_style_option = NULL;
1388 /* Record whether there is an option specifying sort type. */
1389 bool sort_type_specified = false;
1391 qmark_funny_chars = false;
1393 /* initialize all switches to default settings */
1398 /* This is for the `dir' program. */
1399 format = many_per_line;
1400 set_quoting_style (NULL, escape_quoting_style);
1403 case LS_LONG_FORMAT:
1404 /* This is for the `vdir' program. */
1405 format = long_format;
1406 set_quoting_style (NULL, escape_quoting_style);
1410 /* This is for the `ls' program. */
1411 if (isatty (STDOUT_FILENO))
1413 format = many_per_line;
1414 /* See description of qmark_funny_chars, above. */
1415 qmark_funny_chars = true;
1419 format = one_per_line;
1420 qmark_funny_chars = false;
1428 time_type = time_mtime;
1429 sort_type = sort_name;
1430 sort_reverse = false;
1431 numeric_ids = false;
1432 print_block_size = false;
1433 indicator_style = none;
1434 print_inode = false;
1435 dereference = DEREF_UNDEFINED;
1437 immediate_dirs = false;
1438 ignore_mode = IGNORE_DEFAULT;
1439 ignore_patterns = NULL;
1440 hide_patterns = NULL;
1441 print_scontext = false;
1443 /* FIXME: put this in a function. */
1445 char const *q_style = getenv ("QUOTING_STYLE");
1448 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
1450 set_quoting_style (NULL, quoting_style_vals[i]);
1453 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
1454 quotearg (q_style));
1459 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1460 human_options (ls_block_size,
1461 &human_output_opts, &output_block_size);
1462 if (ls_block_size || getenv ("BLOCK_SIZE"))
1463 file_output_block_size = output_block_size;
1468 char const *p = getenv ("COLUMNS");
1471 unsigned long int tmp_ulong;
1472 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1473 && 0 < tmp_ulong && tmp_ulong <= SIZE_MAX)
1475 line_length = tmp_ulong;
1480 _("ignoring invalid width in environment variable COLUMNS: %s"),
1490 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1491 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1492 line_length = ws.ws_col;
1497 char const *p = getenv ("TABSIZE");
1501 unsigned long int tmp_ulong;
1502 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1503 && tmp_ulong <= SIZE_MAX)
1505 tabsize = tmp_ulong;
1510 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1519 int c = getopt_long (argc, argv,
1520 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1528 ignore_mode = IGNORE_MINIMAL;
1532 set_quoting_style (NULL, escape_quoting_style);
1536 time_type = time_ctime;
1540 immediate_dirs = true;
1544 /* Same as enabling -a -U and disabling -l -s. */
1545 ignore_mode = IGNORE_MINIMAL;
1546 sort_type = sort_none;
1547 sort_type_specified = true;
1549 if (format == long_format)
1550 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1551 print_block_size = false; /* disable -s */
1552 print_with_color = false; /* disable --color */
1555 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1556 indicator_style = file_type;
1560 format = long_format;
1561 print_owner = false;
1565 human_output_opts = human_autoscale | human_SI | human_base_1024;
1566 file_output_block_size = output_block_size = 1;
1574 human_output_opts = 0;
1575 file_output_block_size = output_block_size = 1024;
1579 format = long_format;
1583 format = with_commas;
1588 format = long_format;
1591 case 'o': /* Just like -l, but don't display group info. */
1592 format = long_format;
1593 print_group = false;
1597 indicator_style = slash;
1601 qmark_funny_chars = true;
1605 sort_reverse = true;
1609 print_block_size = true;
1613 sort_type = sort_time;
1614 sort_type_specified = true;
1618 time_type = time_atime;
1622 sort_type = sort_version;
1623 sort_type_specified = true;
1628 unsigned long int tmp_ulong;
1629 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1630 || ! (0 < tmp_ulong && tmp_ulong <= SIZE_MAX))
1631 error (LS_FAILURE, 0, _("invalid line width: %s"),
1633 line_length = tmp_ulong;
1638 format = horizontal;
1642 if (ignore_mode == IGNORE_DEFAULT)
1643 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1647 add_ignore_pattern ("*~");
1648 add_ignore_pattern (".*~");
1652 format = many_per_line;
1660 indicator_style = classify;
1663 case 'G': /* inhibit display of group info */
1664 print_group = false;
1668 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1671 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1672 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1676 add_ignore_pattern (optarg);
1680 dereference = DEREF_ALWAYS;
1684 set_quoting_style (NULL, literal_quoting_style);
1688 set_quoting_style (NULL, c_quoting_style);
1696 sort_type = sort_size;
1697 sort_type_specified = true;
1702 unsigned long int tmp_ulong;
1703 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1704 || SIZE_MAX < tmp_ulong)
1705 error (LS_FAILURE, 0, _("invalid tab size: %s"),
1707 tabsize = tmp_ulong;
1712 sort_type = sort_none;
1713 sort_type_specified = true;
1717 sort_type = sort_extension;
1718 sort_type_specified = true;
1722 /* -1 has no effect after -l. */
1723 if (format != long_format)
1724 format = one_per_line;
1728 print_author = true;
1733 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1734 hide->pattern = optarg;
1735 hide->next = hide_patterns;
1736 hide_patterns = hide;
1741 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1742 sort_type_specified = true;
1745 case GROUP_DIRECTORIES_FIRST_OPTION:
1746 directories_first = true;
1750 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1754 format = XARGMATCH ("--format", optarg, format_args, format_types);
1757 case FULL_TIME_OPTION:
1758 format = long_format;
1759 time_style_option = "full-iso";
1766 i = XARGMATCH ("--color", optarg, color_args, color_types);
1768 /* Using --color with no argument is equivalent to using
1772 print_with_color = (i == color_always
1773 || (i == color_if_tty
1774 && isatty (STDOUT_FILENO)));
1776 if (print_with_color)
1778 /* Don't use TAB characters in output. Some terminal
1779 emulators can't handle the combination of tabs and
1780 color codes on the same line. */
1786 case INDICATOR_STYLE_OPTION:
1787 indicator_style = XARGMATCH ("--indicator-style", optarg,
1788 indicator_style_args,
1789 indicator_style_types);
1792 case QUOTING_STYLE_OPTION:
1793 set_quoting_style (NULL,
1794 XARGMATCH ("--quoting-style", optarg,
1796 quoting_style_vals));
1799 case TIME_STYLE_OPTION:
1800 time_style_option = optarg;
1803 case SHOW_CONTROL_CHARS_OPTION:
1804 qmark_funny_chars = false;
1807 case BLOCK_SIZE_OPTION:
1809 enum strtol_error e = human_options (optarg, &human_output_opts,
1810 &output_block_size);
1811 if (e != LONGINT_OK)
1812 xstrtol_fatal (e, oi, 0, long_options, optarg);
1813 file_output_block_size = output_block_size;
1818 human_output_opts = human_autoscale | human_SI;
1819 file_output_block_size = output_block_size = 1;
1823 print_scontext = true;
1826 case_GETOPT_HELP_CHAR;
1828 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1835 max_idx = MAX (1, line_length / MIN_COLUMN_WIDTH);
1837 filename_quoting_options = clone_quoting_options (NULL);
1838 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1839 set_char_quoting (filename_quoting_options, ' ', 1);
1840 if (file_type <= indicator_style)
1843 for (p = "*=>@|" + indicator_style - file_type; *p; p++)
1844 set_char_quoting (filename_quoting_options, *p, 1);
1847 dirname_quoting_options = clone_quoting_options (NULL);
1848 set_char_quoting (dirname_quoting_options, ':', 1);
1850 /* --dired is meaningful only with --format=long (-l).
1851 Otherwise, ignore it. FIXME: warn about this?
1852 Alternatively, make --dired imply --format=long? */
1853 if (dired && format != long_format)
1856 /* If -c or -u is specified and not -l (or any other option that implies -l),
1857 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
1858 The behavior of ls when using either -c or -u but with neither -l nor -t
1859 appears to be unspecified by POSIX. So, with GNU ls, `-u' alone means
1860 sort by atime (this is the one that's not specified by the POSIX spec),
1861 -lu means show atime and sort by name, -lut means show atime and sort
1864 if ((time_type == time_ctime || time_type == time_atime)
1865 && !sort_type_specified && format != long_format)
1867 sort_type = sort_time;
1870 if (format == long_format)
1872 char *style = time_style_option;
1873 static char const posix_prefix[] = "posix-";
1876 if (! (style = getenv ("TIME_STYLE")))
1879 while (strncmp (style, posix_prefix, sizeof posix_prefix - 1) == 0)
1881 if (! hard_locale (LC_TIME))
1883 style += sizeof posix_prefix - 1;
1888 char *p0 = style + 1;
1889 char *p1 = strchr (p0, '\n');
1894 if (strchr (p1 + 1, '\n'))
1895 error (LS_FAILURE, 0, _("invalid time style format %s"),
1899 long_time_format[0] = p0;
1900 long_time_format[1] = p1;
1903 switch (XARGMATCH ("time style", style,
1907 case full_iso_time_style:
1908 long_time_format[0] = long_time_format[1] =
1909 "%Y-%m-%d %H:%M:%S.%N %z";
1912 case long_iso_time_style:
1913 case_long_iso_time_style:
1914 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
1917 case iso_time_style:
1918 long_time_format[0] = "%Y-%m-%d ";
1919 long_time_format[1] = "%m-%d %H:%M";
1922 case locale_time_style:
1923 if (hard_locale (LC_TIME))
1925 /* Ensure that the locale has translations for both
1926 formats. If not, fall back on long-iso format. */
1928 for (i = 0; i < 2; i++)
1930 char const *locale_format =
1931 dcgettext (NULL, long_time_format[i], LC_TIME);
1932 if (locale_format == long_time_format[i])
1933 goto case_long_iso_time_style;
1934 long_time_format[i] = locale_format;
1943 /* Parse a string as part of the LS_COLORS variable; this may involve
1944 decoding all kinds of escape characters. If equals_end is set an
1945 unescaped equal sign ends the string, otherwise only a : or \0
1946 does. Set *OUTPUT_COUNT to the number of bytes output. Return
1949 The resulting string is *not* null-terminated, but may contain
1952 Note that both dest and src are char **; on return they point to
1953 the first free byte after the array and the character that ended
1954 the input string, respectively. */
1957 get_funky_string (char **dest, const char **src, bool equals_end,
1958 size_t *output_count)
1960 char num; /* For numerical codes */
1961 size_t count; /* Something to count with */
1963 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
1968 p = *src; /* We don't want to double-indirect */
1969 q = *dest; /* the whole darn time. */
1971 count = 0; /* No characters counted in yet. */
1974 state = ST_GND; /* Start in ground state. */
1975 while (state < ST_END)
1979 case ST_GND: /* Ground state (no escapes) */
1984 state = ST_END; /* End of string */
1987 state = ST_BACKSLASH; /* Backslash scape sequence */
1991 state = ST_CARET; /* Caret escape */
1997 state = ST_END; /* End */
2000 /* else fall through */
2008 case ST_BACKSLASH: /* Backslash escaped character */
2019 state = ST_OCTAL; /* Octal sequence */
2024 state = ST_HEX; /* Hex sequence */
2027 case 'a': /* Bell */
2030 case 'b': /* Backspace */
2033 case 'e': /* Escape */
2036 case 'f': /* Form feed */
2039 case 'n': /* Newline */
2042 case 'r': /* Carriage return */
2048 case 'v': /* Vtab */
2051 case '?': /* Delete */
2054 case '_': /* Space */
2057 case '\0': /* End of string */
2058 state = ST_ERROR; /* Error! */
2060 default: /* Escaped character like \ ^ : = */
2064 if (state == ST_BACKSLASH)
2073 case ST_OCTAL: /* Octal sequence */
2074 if (*p < '0' || *p > '7')
2081 num = (num << 3) + (*(p++) - '0');
2084 case ST_HEX: /* Hex sequence */
2097 num = (num << 4) + (*(p++) - '0');
2105 num = (num << 4) + (*(p++) - 'a') + 10;
2113 num = (num << 4) + (*(p++) - 'A') + 10;
2123 case ST_CARET: /* Caret escape */
2124 state = ST_GND; /* Should be the next state... */
2125 if (*p >= '@' && *p <= '~')
2127 *(q++) = *(p++) & 037;
2146 *output_count = count;
2148 return state != ST_ERROR;
2152 parse_ls_color (void)
2154 const char *p; /* Pointer to character being parsed */
2155 char *buf; /* color_buf buffer pointer */
2156 int state; /* State of parser */
2157 int ind_no; /* Indicator number */
2158 char label[3]; /* Indicator label */
2159 struct color_ext_type *ext; /* Extension we are working on */
2161 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2165 strcpy (label, "??");
2167 /* This is an overly conservative estimate, but any possible
2168 LS_COLORS string will *not* generate a color_buf longer than
2169 itself, so it is a safe way of allocating a buffer in
2171 buf = color_buf = xstrdup (p);
2178 case 1: /* First label character */
2186 /* Allocate new extension block and add to head of
2187 linked list (this way a later definition will
2188 override an earlier one, which can be useful for
2189 having terminal-specific defs override global). */
2191 ext = xmalloc (sizeof *ext);
2192 ext->next = color_ext_list;
2193 color_ext_list = ext;
2196 ext->ext.string = buf;
2198 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2203 state = 0; /* Done! */
2206 default: /* Assume it is file type label */
2213 case 2: /* Second label character */
2220 state = -1; /* Error */
2223 case 3: /* Equal sign after indicator label */
2224 state = -1; /* Assume failure... */
2225 if (*(p++) == '=')/* It *should* be... */
2227 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2229 if (STREQ (label, indicator_name[ind_no]))
2231 color_indicator[ind_no].string = buf;
2232 state = (get_funky_string (&buf, &p, false,
2233 &color_indicator[ind_no].len)
2239 error (0, 0, _("unrecognized prefix: %s"), quotearg (label));
2243 case 4: /* Equal sign after *.ext */
2246 ext->seq.string = buf;
2247 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2258 struct color_ext_type *e;
2259 struct color_ext_type *e2;
2262 _("unparsable value for LS_COLORS environment variable"));
2264 for (e = color_ext_list; e != NULL; /* empty */)
2270 print_with_color = false;
2273 if (color_indicator[C_LINK].len == 6
2274 && !strncmp (color_indicator[C_LINK].string, "target", 6))
2275 color_symlink_as_referent = true;
2278 /* Set the exit status to report a failure. If SERIOUS, it is a
2279 serious failure; otherwise, it is merely a minor problem. */
2282 set_exit_status (bool serious)
2285 exit_status = LS_FAILURE;
2286 else if (exit_status == EXIT_SUCCESS)
2287 exit_status = LS_MINOR_PROBLEM;
2290 /* Assuming a failure is serious if SERIOUS, use the printf-style
2291 MESSAGE to report the failure to access a file named FILE. Assume
2292 errno is set appropriately for the failure. */
2295 file_failure (bool serious, char const *message, char const *file)
2297 error (0, errno, message, quotearg_colon (file));
2298 set_exit_status (serious);
2301 /* Request that the directory named NAME have its contents listed later.
2302 If REALNAME is nonzero, it will be used instead of NAME when the
2303 directory name is printed. This allows symbolic links to directories
2304 to be treated as regular directories but still be listed under their
2305 real names. NAME == NULL is used to insert a marker entry for the
2306 directory named in REALNAME.
2307 If NAME is non-NULL, we use its dev/ino information to save
2308 a call to stat -- when doing a recursive (-R) traversal.
2309 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2312 queue_directory (char const *name, char const *realname, bool command_line_arg)
2314 struct pending *new = xmalloc (sizeof *new);
2315 new->realname = realname ? xstrdup (realname) : NULL;
2316 new->name = name ? xstrdup (name) : NULL;
2317 new->command_line_arg = command_line_arg;
2318 new->next = pending_dirs;
2322 /* Read directory NAME, and list the files in it.
2323 If REALNAME is nonzero, print its name instead of NAME;
2324 this is used for symbolic links to directories.
2325 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2328 print_dir (char const *name, char const *realname, bool command_line_arg)
2331 struct dirent *next;
2332 uintmax_t total_blocks = 0;
2333 static bool first = true;
2336 dirp = opendir (name);
2339 file_failure (command_line_arg, _("cannot open directory %s"), name);
2345 struct stat dir_stat;
2346 int fd = dirfd (dirp);
2348 /* If dirfd failed, endure the overhead of using stat. */
2350 ? fstat (fd, &dir_stat)
2351 : stat (name, &dir_stat)) < 0)
2353 file_failure (command_line_arg,
2354 _("cannot determine device and inode of %s"), name);
2359 /* If we've already visited this dev/inode pair, warn that
2360 we've found a loop, and do not process this directory. */
2361 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2363 error (0, 0, _("%s: not listing already-listed directory"),
2364 quotearg_colon (name));
2369 DEV_INO_PUSH (dir_stat.st_dev, dir_stat.st_ino);
2372 /* Read the directory entries, and insert the subfiles into the `cwd_file'
2379 /* Set errno to zero so we can distinguish between a readdir failure
2380 and when readdir simply finds that there are no more entries. */
2382 next = readdir (dirp);
2385 if (! file_ignored (next->d_name))
2387 enum filetype type = unknown;
2389 #if HAVE_STRUCT_DIRENT_D_TYPE
2390 switch (next->d_type)
2392 case DT_BLK: type = blockdev; break;
2393 case DT_CHR: type = chardev; break;
2394 case DT_DIR: type = directory; break;
2395 case DT_FIFO: type = fifo; break;
2396 case DT_LNK: type = symbolic_link; break;
2397 case DT_REG: type = normal; break;
2398 case DT_SOCK: type = sock; break;
2400 case DT_WHT: type = whiteout; break;
2404 total_blocks += gobble_file (next->d_name, type, D_INO (next),
2408 else if (errno != 0)
2410 file_failure (command_line_arg, _("reading directory %s"), name);
2411 if (errno != EOVERFLOW)
2418 if (closedir (dirp) != 0)
2420 file_failure (command_line_arg, _("closing directory %s"), name);
2421 /* Don't return; print whatever we got. */
2424 /* Sort the directory contents. */
2427 /* If any member files are subdirectories, perhaps they should have their
2428 contents listed rather than being mentioned here as files. */
2431 extract_dirs_from_files (name, command_line_arg);
2433 if (recursive | print_dir_name)
2436 DIRED_PUTCHAR ('\n');
2439 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2440 dired_pos += quote_name (stdout, realname ? realname : name,
2441 dirname_quoting_options, NULL);
2442 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2443 DIRED_FPUTS_LITERAL (":\n", stdout);
2446 if (format == long_format || print_block_size)
2449 char buf[LONGEST_HUMAN_READABLE + 1];
2453 DIRED_FPUTS (p, stdout, strlen (p));
2454 DIRED_PUTCHAR (' ');
2455 p = human_readable (total_blocks, buf, human_output_opts,
2456 ST_NBLOCKSIZE, output_block_size);
2457 DIRED_FPUTS (p, stdout, strlen (p));
2458 DIRED_PUTCHAR ('\n');
2462 print_current_files ();
2465 /* Add `pattern' to the list of patterns for which files that match are
2469 add_ignore_pattern (const char *pattern)
2471 struct ignore_pattern *ignore;
2473 ignore = xmalloc (sizeof *ignore);
2474 ignore->pattern = pattern;
2475 /* Add it to the head of the linked list. */
2476 ignore->next = ignore_patterns;
2477 ignore_patterns = ignore;
2480 /* Return true if one of the PATTERNS matches FILE. */
2483 patterns_match (struct ignore_pattern const *patterns, char const *file)
2485 struct ignore_pattern const *p;
2486 for (p = patterns; p; p = p->next)
2487 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2492 /* Return true if FILE should be ignored. */
2495 file_ignored (char const *name)
2497 return ((ignore_mode != IGNORE_MINIMAL
2499 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2500 || (ignore_mode == IGNORE_DEFAULT
2501 && patterns_match (hide_patterns, name))
2502 || patterns_match (ignore_patterns, name));
2505 /* POSIX requires that a file size be printed without a sign, even
2506 when negative. Assume the typical case where negative sizes are
2507 actually positive values that have wrapped around. */
2510 unsigned_file_size (off_t size)
2512 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2515 /* Enter and remove entries in the table `cwd_file'. */
2517 /* Empty the table of files. */
2524 for (i = 0; i < cwd_n_used; i++)
2526 struct fileinfo *f = sorted_file[i];
2529 if (f->scontext != UNKNOWN_SECURITY_CONTEXT)
2530 freecon (f->scontext);
2534 any_has_acl = false;
2535 inode_number_width = 0;
2536 block_size_width = 0;
2542 major_device_number_width = 0;
2543 minor_device_number_width = 0;
2544 file_size_width = 0;
2547 /* Add a file to the current table of files.
2548 Verify that the file exists, and print an error message if it does not.
2549 Return the number of blocks that the file occupies. */
2552 gobble_file (char const *name, enum filetype type, ino_t inode,
2553 bool command_line_arg, char const *dirname)
2555 uintmax_t blocks = 0;
2558 /* An inode value prior to gobble_file necessarily came from readdir,
2559 which is not used for command line arguments. */
2560 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2562 if (cwd_n_used == cwd_n_alloc)
2564 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
2568 f = &cwd_file[cwd_n_used];
2569 memset (f, '\0', sizeof *f);
2570 f->stat.st_ino = inode;
2573 if (command_line_arg
2574 || format_needs_stat
2575 /* When coloring a directory (we may know the type from
2576 direct.d_type), we have to stat it in order to indicate
2577 sticky and/or other-writable attributes. */
2578 || (type == directory && print_with_color)
2579 /* When dereferencing symlinks, the inode and type must come from
2580 stat, but readdir provides the inode and type of lstat. */
2581 || ((print_inode || format_needs_type)
2582 && (type == symbolic_link || type == unknown)
2583 && (dereference == DEREF_ALWAYS
2584 || (command_line_arg && dereference != DEREF_NEVER)
2585 || color_symlink_as_referent || check_symlink_color))
2586 /* Command line dereferences are already taken care of by the above
2587 assertion that the inode number is not yet known. */
2588 || (print_inode && inode == NOT_AN_INODE_NUMBER)
2589 || (format_needs_type
2590 && (type == unknown || command_line_arg
2591 /* --indicator-style=classify (aka -F)
2592 requires that we stat each regular file
2593 to see if it's executable. */
2594 || (type == normal && (indicator_style == classify
2595 /* This is so that --color ends up
2596 highlighting files with the executable
2597 bit set even when options like -F are
2599 || (print_with_color
2600 && is_colored (C_EXEC))
2604 /* Absolute name of this file. */
2605 char *absolute_name;
2609 if (name[0] == '/' || dirname[0] == 0)
2610 absolute_name = (char *) name;
2613 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
2614 attach (absolute_name, dirname, name);
2617 switch (dereference)
2620 err = stat (absolute_name, &f->stat);
2624 case DEREF_COMMAND_LINE_ARGUMENTS:
2625 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
2626 if (command_line_arg)
2629 err = stat (absolute_name, &f->stat);
2632 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
2635 need_lstat = (err < 0
2637 : ! S_ISDIR (f->stat.st_mode));
2641 /* stat failed because of ENOENT, maybe indicating a dangling
2642 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
2643 directory, and --dereference-command-line-symlink-to-dir is
2644 in effect. Fall through so that we call lstat instead. */
2647 default: /* DEREF_NEVER */
2648 err = lstat (absolute_name, &f->stat);
2655 /* Failure to stat a command line argument leads to
2656 an exit status of 2. For other files, stat failure
2657 provokes an exit status of 1. */
2658 file_failure (command_line_arg,
2659 _("cannot access %s"), absolute_name);
2660 if (command_line_arg)
2663 f->name = xstrdup (name);
2671 if (format == long_format || print_scontext)
2673 bool have_acl = false;
2674 int attr_len = (do_deref
2675 ? getfilecon (absolute_name, &f->scontext)
2676 : lgetfilecon (absolute_name, &f->scontext));
2677 err = (attr_len < 0);
2679 /* Contrary to its documented API, getfilecon may return 0,
2680 yet set f->scontext to NULL (on at least Debian's libselinux1
2681 2.0.15-2+b1), so work around that bug.
2682 FIXME: remove this work-around in 2011, or whenever affected
2683 versions of libselinux are long gone. */
2687 f->scontext = xstrdup ("unlabeled");
2691 have_acl = ! STREQ ("unlabeled", f->scontext);
2694 f->scontext = UNKNOWN_SECURITY_CONTEXT;
2696 /* When requesting security context information, don't make
2697 ls fail just because the file (even a command line argument)
2698 isn't on the right type of file system. I.e., a getfilecon
2699 failure isn't in the same class as a stat failure. */
2700 if (errno == ENOTSUP || errno == ENODATA)
2704 if (err == 0 && ! have_acl && format == long_format)
2706 int n = file_has_acl (absolute_name, &f->stat);
2711 f->have_acl = have_acl;
2712 any_has_acl |= have_acl;
2715 error (0, errno, "%s", quotearg_colon (absolute_name));
2718 if (S_ISLNK (f->stat.st_mode)
2719 && (format == long_format || check_symlink_color))
2722 struct stat linkstats;
2724 get_link_name (absolute_name, f, command_line_arg);
2725 linkname = make_link_name (absolute_name, f->linkname);
2727 /* Avoid following symbolic links when possible, ie, when
2728 they won't be traced and when no indicator is needed. */
2730 && (file_type <= indicator_style || check_symlink_color)
2731 && stat (linkname, &linkstats) == 0)
2735 /* Symbolic links to directories that are mentioned on the
2736 command line are automatically traced if not being
2738 if (!command_line_arg || format == long_format
2739 || !S_ISDIR (linkstats.st_mode))
2741 /* Get the linked-to file's mode for the filetype indicator
2742 in long listings. */
2743 f->linkmode = linkstats.st_mode;
2749 /* When not distinguishing types of symlinks, pretend we know that
2750 it is stat'able, so that it will be colored as a regular symlink,
2751 and not as an orphan. */
2752 if (S_ISLNK (f->stat.st_mode) && !check_symlink_color)
2755 if (S_ISLNK (f->stat.st_mode))
2756 f->filetype = symbolic_link;
2757 else if (S_ISDIR (f->stat.st_mode))
2759 if (command_line_arg & !immediate_dirs)
2760 f->filetype = arg_directory;
2762 f->filetype = directory;
2765 f->filetype = normal;
2767 blocks = ST_NBLOCKS (f->stat);
2768 if (format == long_format || print_block_size)
2770 char buf[LONGEST_HUMAN_READABLE + 1];
2771 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
2772 ST_NBLOCKSIZE, output_block_size),
2774 if (block_size_width < len)
2775 block_size_width = len;
2778 if (format == long_format)
2782 int len = format_user_width (f->stat.st_uid);
2783 if (owner_width < len)
2789 int len = format_group_width (f->stat.st_gid);
2790 if (group_width < len)
2796 int len = format_user_width (f->stat.st_author);
2797 if (author_width < len)
2804 int len = strlen (f->scontext);
2805 if (scontext_width < len)
2806 scontext_width = len;
2809 if (format == long_format)
2811 char b[INT_BUFSIZE_BOUND (uintmax_t)];
2812 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
2813 if (nlink_width < b_len)
2814 nlink_width = b_len;
2816 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
2818 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2819 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
2820 if (major_device_number_width < len)
2821 major_device_number_width = len;
2822 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
2823 if (minor_device_number_width < len)
2824 minor_device_number_width = len;
2825 len = major_device_number_width + 2 + minor_device_number_width;
2826 if (file_size_width < len)
2827 file_size_width = len;
2831 char buf[LONGEST_HUMAN_READABLE + 1];
2832 uintmax_t size = unsigned_file_size (f->stat.st_size);
2833 int len = mbswidth (human_readable (size, buf, human_output_opts,
2834 1, file_output_block_size),
2836 if (file_size_width < len)
2837 file_size_width = len;
2844 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2845 int len = strlen (umaxtostr (f->stat.st_ino, buf));
2846 if (inode_number_width < len)
2847 inode_number_width = len;
2850 f->name = xstrdup (name);
2856 /* Return true if F refers to a directory. */
2858 is_directory (const struct fileinfo *f)
2860 return f->filetype == directory || f->filetype == arg_directory;
2863 /* Put the name of the file that FILENAME is a symbolic link to
2864 into the LINKNAME field of `f'. COMMAND_LINE_ARG indicates whether
2865 FILENAME is a command-line argument. */
2868 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
2870 f->linkname = areadlink_with_size (filename, f->stat.st_size);
2871 if (f->linkname == NULL)
2872 file_failure (command_line_arg, _("cannot read symbolic link %s"),
2876 /* If `linkname' is a relative name and `name' contains one or more
2877 leading directories, return `linkname' with those directories
2878 prepended; otherwise, return a copy of `linkname'.
2879 If `linkname' is zero, return zero. */
2882 make_link_name (char const *name, char const *linkname)
2890 if (*linkname == '/')
2891 return xstrdup (linkname);
2893 /* The link is to a relative name. Prepend any leading directory
2894 in `name' to the link name. */
2895 linkbuf = strrchr (name, '/');
2897 return xstrdup (linkname);
2899 bufsiz = linkbuf - name + 1;
2900 linkbuf = xmalloc (bufsiz + strlen (linkname) + 1);
2901 strncpy (linkbuf, name, bufsiz);
2902 strcpy (linkbuf + bufsiz, linkname);
2906 /* Return true if the last component of NAME is `.' or `..'
2907 This is so we don't try to recurse on `././././. ...' */
2910 basename_is_dot_or_dotdot (const char *name)
2912 char const *base = last_component (name);
2913 return dot_or_dotdot (base);
2916 /* Remove any entries from CWD_FILE that are for directories,
2917 and queue them to be listed as directories instead.
2918 DIRNAME is the prefix to prepend to each dirname
2919 to make it correct relative to ls's working dir;
2920 if it is null, no prefix is needed and "." and ".." should not be ignored.
2921 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
2922 This is desirable when processing directories recursively. */
2925 extract_dirs_from_files (char const *dirname, bool command_line_arg)
2929 bool ignore_dot_and_dot_dot = (dirname != NULL);
2931 if (dirname && LOOP_DETECT)
2933 /* Insert a marker entry first. When we dequeue this marker entry,
2934 we'll know that DIRNAME has been processed and may be removed
2935 from the set of active directories. */
2936 queue_directory (NULL, dirname, false);
2939 /* Queue the directories last one first, because queueing reverses the
2941 for (i = cwd_n_used; i-- != 0; )
2943 struct fileinfo *f = sorted_file[i];
2945 if (is_directory (f)
2946 && (! ignore_dot_and_dot_dot
2947 || ! basename_is_dot_or_dotdot (f->name)))
2949 if (!dirname || f->name[0] == '/')
2950 queue_directory (f->name, f->linkname, command_line_arg);
2953 char *name = file_name_concat (dirname, f->name, NULL);
2954 queue_directory (name, f->linkname, command_line_arg);
2957 if (f->filetype == arg_directory)
2962 /* Now delete the directories from the table, compacting all the remaining
2965 for (i = 0, j = 0; i < cwd_n_used; i++)
2967 struct fileinfo *f = sorted_file[i];
2969 j += (f->filetype != arg_directory);
2974 /* Use strcoll to compare strings in this locale. If an error occurs,
2975 report an error and longjmp to failed_strcoll. */
2977 static jmp_buf failed_strcoll;
2980 xstrcoll (char const *a, char const *b)
2984 diff = strcoll (a, b);
2987 error (0, errno, _("cannot compare file names %s and %s"),
2988 quote_n (0, a), quote_n (1, b));
2989 set_exit_status (false);
2990 longjmp (failed_strcoll, 1);
2995 /* Comparison routines for sorting the files. */
2997 typedef void const *V;
2998 typedef int (*qsortFunc)(V a, V b);
3000 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
3001 The do { ... } while(0) makes it possible to use the macro more like
3002 a statement, without violating C89 rules: */
3003 #define DIRFIRST_CHECK(a, b) \
3006 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
3007 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
3008 if (a_is_dir && !b_is_dir) \
3009 return -1; /* a goes before b */ \
3010 if (!a_is_dir && b_is_dir) \
3011 return 1; /* b goes before a */ \
3015 /* Define the 8 different sort function variants required for each sortkey.
3016 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
3017 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
3018 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
3019 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
3020 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
3021 /* direct, non-dirfirst versions */ \
3022 static int xstrcoll_##key_name (V a, V b) \
3023 { return key_cmp_func (a, b, xstrcoll); } \
3024 static int strcmp_##key_name (V a, V b) \
3025 { return key_cmp_func (a, b, strcmp); } \
3027 /* reverse, non-dirfirst versions */ \
3028 static int rev_xstrcoll_##key_name (V a, V b) \
3029 { return key_cmp_func (b, a, xstrcoll); } \
3030 static int rev_strcmp_##key_name (V a, V b) \
3031 { return key_cmp_func (b, a, strcmp); } \
3033 /* direct, dirfirst versions */ \
3034 static int xstrcoll_df_##key_name (V a, V b) \
3035 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
3036 static int strcmp_df_##key_name (V a, V b) \
3037 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
3039 /* reverse, dirfirst versions */ \
3040 static int rev_xstrcoll_df_##key_name (V a, V b) \
3041 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
3042 static int rev_strcmp_df_##key_name (V a, V b) \
3043 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
3046 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3047 int (*cmp) (char const *, char const *))
3049 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3050 get_stat_ctime (&a->stat));
3051 return diff ? diff : cmp (a->name, b->name);
3055 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3056 int (*cmp) (char const *, char const *))
3058 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3059 get_stat_mtime (&a->stat));
3060 return diff ? diff : cmp (a->name, b->name);
3064 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3065 int (*cmp) (char const *, char const *))
3067 int diff = timespec_cmp (get_stat_atime (&b->stat),
3068 get_stat_atime (&a->stat));
3069 return diff ? diff : cmp (a->name, b->name);
3073 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3074 int (*cmp) (char const *, char const *))
3076 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3077 return diff ? diff : cmp (a->name, b->name);
3081 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3082 int (*cmp) (char const *, char const *))
3084 return cmp (a->name, b->name);
3087 /* Compare file extensions. Files with no extension are `smallest'.
3088 If extensions are the same, compare by filenames instead. */
3091 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3092 int (*cmp) (char const *, char const *))
3094 char const *base1 = strrchr (a->name, '.');
3095 char const *base2 = strrchr (b->name, '.');
3096 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3097 return diff ? diff : cmp (a->name, b->name);
3100 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3101 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3102 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3103 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3104 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3105 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3107 /* Compare file versions.
3108 Unlike all other compare functions above, cmp_version depends only
3109 on strverscmp, which does not fail (even for locale reasons), and does not
3110 need a secondary sort key.
3111 All the other sort options, in fact, need xstrcoll and strcmp variants,
3112 because they all use a string comparison (either as the primary or secondary
3113 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3114 locale reasons. Last, strverscmp is ALWAYS available in coreutils,
3115 thanks to the gnulib library. */
3117 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3119 return strverscmp (a->name, b->name);
3122 static int xstrcoll_version (V a, V b)
3123 { return cmp_version (a, b); }
3124 static int rev_xstrcoll_version (V a, V b)
3125 { return cmp_version (b, a); }
3126 static int xstrcoll_df_version (V a, V b)
3127 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3128 static int rev_xstrcoll_df_version (V a, V b)
3129 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3132 /* We have 2^3 different variants for each sortkey function
3133 (for 3 independent sort modes).
3134 The function pointers stored in this array must be dereferenced as:
3136 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3138 Note that the order in which sortkeys are listed in the function pointer
3139 array below is defined by the order of the elements in the time_type and
3142 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3145 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3146 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3149 { strcmp_##key_name, strcmp_df_##key_name }, \
3150 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3154 static qsortFunc const sort_functions[][2][2][2] =
3156 LIST_SORTFUNCTION_VARIANTS (name),
3157 LIST_SORTFUNCTION_VARIANTS (extension),
3158 LIST_SORTFUNCTION_VARIANTS (size),
3162 { xstrcoll_version, xstrcoll_df_version },
3163 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3166 /* We use NULL for the strcmp variants of version comparison
3167 since as explained in cmp_version definition, version comparison
3168 does not rely on xstrcoll, so it will never longjmp, and never
3169 need to try the strcmp fallback. */
3176 /* last are time sort functions */
3177 LIST_SORTFUNCTION_VARIANTS (mtime),
3178 LIST_SORTFUNCTION_VARIANTS (ctime),
3179 LIST_SORTFUNCTION_VARIANTS (atime)
3182 /* The number of sortkeys is calculated as
3183 the number of elements in the sort_type enum (i.e. sort_numtypes) +
3184 the number of elements in the time_type enum (i.e. time_numtypes) - 1
3185 This is because when sort_type==sort_time, we have up to
3186 time_numtypes possible sortkeys.
3188 This line verifies at compile-time that the array of sort functions has been
3189 initialized for all possible sortkeys. */
3190 verify (ARRAY_CARDINALITY (sort_functions)
3191 == sort_numtypes + time_numtypes - 1 );
3193 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
3196 initialize_ordering_vector (void)
3199 for (i = 0; i < cwd_n_used; i++)
3200 sorted_file[i] = &cwd_file[i];
3203 /* Sort the files now in the table. */
3210 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
3213 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
3214 sorted_file_alloc = 3 * cwd_n_used;
3217 initialize_ordering_vector ();
3219 if (sort_type == sort_none)
3222 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3223 ignore strcoll failures, as a failing strcoll might be a
3224 comparison function that is not a total order, and if we ignored
3225 the failure this might cause qsort to dump core. */
3227 if (! setjmp (failed_strcoll))
3228 use_strcmp = false; /* strcoll() succeeded */
3232 assert (sort_type != sort_version);
3233 initialize_ordering_vector ();
3236 /* When sort_type == sort_time, use time_type as subindex. */
3237 mpsort ((void const **) sorted_file, cwd_n_used,
3238 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
3239 [use_strcmp][sort_reverse]
3240 [directories_first]);
3243 /* List all the files now in the table. */
3246 print_current_files (void)
3253 for (i = 0; i < cwd_n_used; i++)
3255 print_file_name_and_frills (sorted_file[i]);
3261 print_many_per_line ();
3265 print_horizontal ();
3269 print_with_commas ();
3273 for (i = 0; i < cwd_n_used; i++)
3275 print_long_format (sorted_file[i]);
3276 DIRED_PUTCHAR ('\n');
3282 /* Return the expected number of columns in a long-format time stamp,
3283 or zero if it cannot be calculated. */
3286 long_time_expected_width (void)
3288 static int width = -1;
3293 struct tm const *tm = localtime (&epoch);
3294 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3296 /* In case you're wondering if localtime can fail with an input time_t
3297 value of 0, let's just say it's very unlikely, but not inconceivable.
3298 The TZ environment variable would have to specify a time zone that
3299 is 2**31-1900 years or more ahead of UTC. This could happen only on
3300 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3301 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3302 their implementations limit the offset to 167:59 and 24:00, resp. */
3306 nstrftime (buf, sizeof buf, long_time_format[0], tm, 0, 0);
3308 width = mbsnwidth (buf, len, 0);
3318 /* Print the user or group name NAME, with numeric id ID, using a
3319 print width of WIDTH columns. */
3322 format_user_or_group (char const *name, unsigned long int id, int width)
3328 int width_gap = width - mbswidth (name, 0);
3329 int pad = MAX (0, width_gap);
3330 fputs (name, stdout);
3331 len = strlen (name) + pad;
3339 printf ("%*lu ", width, id);
3343 dired_pos += len + 1;
3346 /* Print the name or id of the user with id U, using a print width of
3350 format_user (uid_t u, int width, bool stat_ok)
3352 format_user_or_group (! stat_ok ? "?" :
3353 (numeric_ids ? NULL : getuser (u)), u, width);
3356 /* Likewise, for groups. */
3359 format_group (gid_t g, int width, bool stat_ok)
3361 format_user_or_group (! stat_ok ? "?" :
3362 (numeric_ids ? NULL : getgroup (g)), g, width);
3365 /* Return the number of columns that format_user_or_group will print. */
3368 format_user_or_group_width (char const *name, unsigned long int id)
3372 int len = mbswidth (name, 0);
3373 return MAX (0, len);
3377 char buf[INT_BUFSIZE_BOUND (unsigned long int)];
3378 sprintf (buf, "%lu", id);
3379 return strlen (buf);
3383 /* Return the number of columns that format_user will print. */
3386 format_user_width (uid_t u)
3388 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3391 /* Likewise, for groups. */
3394 format_group_width (gid_t g)
3396 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3400 /* Print information about F in long format. */
3403 print_long_format (const struct fileinfo *f)
3407 [LONGEST_HUMAN_READABLE + 1 /* inode */
3408 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3409 + sizeof (modebuf) - 1 + 1 /* mode string */
3410 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3411 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3412 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3413 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3417 struct timespec when_timespec;
3418 struct tm *when_local;
3420 /* Compute the mode string, except remove the trailing space if no
3421 file in this directory has an ACL or SELinux security context. */
3423 filemodestring (&f->stat, modebuf);
3426 modebuf[0] = filetype_letter[f->filetype];
3427 memset (modebuf + 1, '?', 10);
3432 else if (f->have_acl)
3438 when_timespec = get_stat_ctime (&f->stat);
3441 when_timespec = get_stat_mtime (&f->stat);
3444 when_timespec = get_stat_atime (&f->stat);
3454 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3455 sprintf (p, "%*s ", inode_number_width,
3456 (f->stat.st_ino == NOT_AN_INODE_NUMBER
3458 : umaxtostr (f->stat.st_ino, hbuf)));
3459 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3460 The latter is wrong when inode_number_width is zero. */
3464 if (print_block_size)
3466 char hbuf[LONGEST_HUMAN_READABLE + 1];
3467 char const *blocks =
3470 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3471 ST_NBLOCKSIZE, output_block_size));
3473 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3475 while ((*p++ = *blocks++))
3480 /* The last byte of the mode string is the POSIX
3481 "optional alternate access method flag". */
3483 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3484 sprintf (p, "%s %*s ", modebuf, nlink_width,
3485 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3487 /* Increment by strlen (p) here, rather than by, e.g.,
3488 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3489 The latter is wrong when nlink_width is zero. */
3494 if (print_owner | print_group | print_author | print_scontext)
3496 DIRED_FPUTS (buf, stdout, p - buf);
3499 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3502 format_group (f->stat.st_gid, group_width, f->stat_ok);
3505 format_user (f->stat.st_author, author_width, f->stat_ok);
3508 format_user_or_group (f->scontext, 0, scontext_width);
3514 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3516 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3517 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3518 int blanks_width = (file_size_width
3519 - (major_device_number_width + 2
3520 + minor_device_number_width));
3521 sprintf (p, "%*s, %*s ",
3522 major_device_number_width + MAX (0, blanks_width),
3523 umaxtostr (major (f->stat.st_rdev), majorbuf),
3524 minor_device_number_width,
3525 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3526 p += file_size_width + 1;
3530 char hbuf[LONGEST_HUMAN_READABLE + 1];
3534 : human_readable (unsigned_file_size (f->stat.st_size),
3535 hbuf, human_output_opts, 1, file_output_block_size));
3537 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3539 while ((*p++ = *size++))
3544 when_local = localtime (&when_timespec.tv_sec);
3548 if (f->stat_ok && when_local)
3550 struct timespec six_months_ago;
3554 /* If the file appears to be in the future, update the current
3555 time, in case the file happens to have been modified since
3556 the last time we checked the clock. */
3557 if (timespec_cmp (current_time, when_timespec) < 0)
3559 /* Note that gettime may call gettimeofday which, on some non-
3560 compliant systems, clobbers the buffer used for localtime's result.
3561 But it's ok here, because we use a gettimeofday wrapper that
3562 saves and restores the buffer around the gettimeofday call. */
3563 gettime (¤t_time);
3566 /* Consider a time to be recent if it is within the past six
3567 months. A Gregorian year has 365.2425 * 24 * 60 * 60 ==
3568 31556952 seconds on the average. Write this value as an
3569 integer constant to avoid floating point hassles. */
3570 six_months_ago.tv_sec = current_time.tv_sec - 31556952 / 2;
3571 six_months_ago.tv_nsec = current_time.tv_nsec;
3573 recent = (timespec_cmp (six_months_ago, when_timespec) < 0
3574 && (timespec_cmp (when_timespec, current_time) < 0));
3575 fmt = long_time_format[recent];
3577 /* We assume here that all time zones are offset from UTC by a
3578 whole number of seconds. */
3579 s = nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
3580 when_local, 0, when_timespec.tv_nsec);
3588 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
3593 /* The time cannot be converted using the desired format, so
3594 print it as a huge integer number of seconds. */
3595 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
3596 sprintf (p, "%*s ", long_time_expected_width (),
3599 : (TYPE_SIGNED (time_t)
3600 ? imaxtostr (when_timespec.tv_sec, hbuf)
3601 : umaxtostr (when_timespec.tv_sec, hbuf))));
3602 /* FIXME: (maybe) We discarded when_timespec.tv_nsec. */
3606 DIRED_FPUTS (buf, stdout, p - buf);
3607 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3608 f->stat_ok, f->filetype, &dired_obstack);
3610 if (f->filetype == symbolic_link)
3614 DIRED_FPUTS_LITERAL (" -> ", stdout);
3615 print_name_with_quoting (f->linkname, f->linkmode, f->linkok - 1,
3616 f->stat_ok, f->filetype, NULL);
3617 if (indicator_style != none)
3618 print_type_indicator (true, f->linkmode, unknown);
3621 else if (indicator_style != none)
3622 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3625 /* Output to OUT a quoted representation of the file name NAME,
3626 using OPTIONS to control quoting. Produce no output if OUT is NULL.
3627 Store the number of screen columns occupied by NAME's quoted
3628 representation into WIDTH, if non-NULL. Return the number of bytes
3632 quote_name (FILE *out, const char *name, struct quoting_options const *options,
3635 char smallbuf[BUFSIZ];
3636 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
3638 size_t displayed_width IF_LINT (= 0);
3640 if (len < sizeof smallbuf)
3644 buf = alloca (len + 1);
3645 quotearg_buffer (buf, len + 1, name, -1, options);
3648 if (qmark_funny_chars)
3653 char const *p = buf;
3654 char const *plimit = buf + len;
3656 displayed_width = 0;
3661 case ' ': case '!': case '"': case '#': case '%':
3662 case '&': case '\'': case '(': case ')': case '*':
3663 case '+': case ',': case '-': case '.': case '/':
3664 case '0': case '1': case '2': case '3': case '4':
3665 case '5': case '6': case '7': case '8': case '9':
3666 case ':': case ';': case '<': case '=': case '>':
3668 case 'A': case 'B': case 'C': case 'D': case 'E':
3669 case 'F': case 'G': case 'H': case 'I': case 'J':
3670 case 'K': case 'L': case 'M': case 'N': case 'O':
3671 case 'P': case 'Q': case 'R': case 'S': case 'T':
3672 case 'U': case 'V': case 'W': case 'X': case 'Y':
3674 case '[': case '\\': case ']': case '^': case '_':
3675 case 'a': case 'b': case 'c': case 'd': case 'e':
3676 case 'f': case 'g': case 'h': case 'i': case 'j':
3677 case 'k': case 'l': case 'm': case 'n': case 'o':
3678 case 'p': case 'q': case 'r': case 's': case 't':
3679 case 'u': case 'v': case 'w': case 'x': case 'y':
3680 case 'z': case '{': case '|': case '}': case '~':
3681 /* These characters are printable ASCII characters. */
3683 displayed_width += 1;
3686 /* If we have a multibyte sequence, copy it until we
3687 reach its end, replacing each non-printable multibyte
3688 character with a single question mark. */
3690 mbstate_t mbstate = { 0, };
3697 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
3699 if (bytes == (size_t) -1)
3701 /* An invalid multibyte sequence was
3702 encountered. Skip one input byte, and
3703 put a question mark. */
3706 displayed_width += 1;
3710 if (bytes == (size_t) -2)
3712 /* An incomplete multibyte character
3713 at the end. Replace it entirely with
3717 displayed_width += 1;
3722 /* A null wide character was encountered. */
3728 /* A printable multibyte character.
3730 for (; bytes > 0; --bytes)
3732 displayed_width += w;
3736 /* An unprintable multibyte character.
3737 Replace it entirely with a question
3741 displayed_width += 1;
3744 while (! mbsinit (&mbstate));
3749 /* The buffer may have shrunk. */
3756 char const *plimit = buf + len;
3760 if (! isprint (to_uchar (*p)))
3764 displayed_width = len;
3767 else if (width != NULL)
3771 displayed_width = mbsnwidth (buf, len, 0);
3775 char const *p = buf;
3776 char const *plimit = buf + len;
3778 displayed_width = 0;
3781 if (isprint (to_uchar (*p)))
3789 fwrite (buf, 1, len, out);
3791 *width = displayed_width;
3796 print_name_with_quoting (const char *p, mode_t mode, int linkok,
3797 bool stat_ok, enum filetype type,
3798 struct obstack *stack)
3800 bool used_color_this_time
3802 && print_color_indicator (p, mode, linkok, stat_ok, type));
3805 PUSH_CURRENT_DIRED_POS (stack);
3807 dired_pos += quote_name (stdout, p, filename_quoting_options, NULL);
3810 PUSH_CURRENT_DIRED_POS (stack);
3812 if (used_color_this_time)
3815 prep_non_filename_text ();
3820 prep_non_filename_text (void)
3822 if (color_indicator[C_END].string != NULL)
3823 put_indicator (&color_indicator[C_END]);
3826 put_indicator (&color_indicator[C_LEFT]);
3827 put_indicator (&color_indicator[C_RESET]);
3828 put_indicator (&color_indicator[C_RIGHT]);
3832 /* Print the file name of `f' with appropriate quoting.
3833 Also print file size, inode number, and filetype indicator character,
3834 as requested by switches. */
3837 print_file_name_and_frills (const struct fileinfo *f)
3839 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
3842 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
3843 umaxtostr (f->stat.st_ino, buf));
3845 if (print_block_size)
3846 printf ("%*s ", format == with_commas ? 0 : block_size_width,
3847 human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
3848 ST_NBLOCKSIZE, output_block_size));
3851 printf ("%*s ", format == with_commas ? 0 : scontext_width, f->scontext);
3853 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3854 f->stat_ok, f->filetype, NULL);
3856 if (indicator_style != none)
3857 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3860 /* Given these arguments describing a file, return the single-byte
3861 type indicator, or 0. */
3863 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3867 if (stat_ok ? S_ISREG (mode) : type == normal)
3869 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
3876 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
3878 else if (indicator_style == slash)
3880 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
3882 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
3884 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
3886 else if (stat_ok && S_ISDOOR (mode))
3895 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3897 char c = get_type_indicator (stat_ok, mode, type);
3902 /* Returns whether any color sequence was printed. */
3904 print_color_indicator (const char *name, mode_t mode, int linkok,
3905 bool stat_ok, enum filetype filetype)
3908 struct color_ext_type *ext; /* Color extension */
3909 size_t len; /* Length of name */
3911 /* Is this a nonexistent file? If so, linkok == -1. */
3913 if (linkok == -1 && color_indicator[C_MISSING].string != NULL)
3917 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
3918 type = filetype_indicator[filetype];
3925 if ((mode & S_ISUID) != 0)
3927 else if ((mode & S_ISGID) != 0)
3929 else if ((mode & S_IXUGO) != 0)
3932 else if (S_ISDIR (mode))
3934 if ((mode & S_ISVTX) && (mode & S_IWOTH))
3935 type = C_STICKY_OTHER_WRITABLE;
3936 else if ((mode & S_IWOTH) != 0)
3937 type = C_OTHER_WRITABLE;
3938 else if ((mode & S_ISVTX) != 0)
3943 else if (S_ISLNK (mode))
3944 type = ((!linkok && color_indicator[C_ORPHAN].string)
3945 ? C_ORPHAN : C_LINK);
3946 else if (S_ISFIFO (mode))
3948 else if (S_ISSOCK (mode))
3950 else if (S_ISBLK (mode))
3952 else if (S_ISCHR (mode))
3954 else if (S_ISDOOR (mode))
3958 /* Classify a file of some other type as C_ORPHAN. */
3963 /* Check the file's suffix only if still classified as C_FILE. */
3967 /* Test if NAME has a recognized suffix. */
3969 len = strlen (name);
3970 name += len; /* Pointer to final \0. */
3971 for (ext = color_ext_list; ext != NULL; ext = ext->next)
3973 if (ext->ext.len <= len
3974 && strncmp (name - ext->ext.len, ext->ext.string,
3981 const struct bin_str *const s
3982 = ext ? &(ext->seq) : &color_indicator[type];
3983 if (s->string != NULL)
3985 put_indicator (&color_indicator[C_LEFT]);
3987 put_indicator (&color_indicator[C_RIGHT]);
3995 /* Output a color indicator (which may contain nulls). */
3997 put_indicator (const struct bin_str *ind)
4002 prep_non_filename_text ();
4005 fwrite (ind->string, ind->len, 1, stdout);
4009 length_of_file_name_and_frills (const struct fileinfo *f)
4013 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4016 len += 1 + (format == with_commas
4017 ? strlen (umaxtostr (f->stat.st_ino, buf))
4018 : inode_number_width);
4020 if (print_block_size)
4021 len += 1 + (format == with_commas
4022 ? strlen (human_readable (ST_NBLOCKS (f->stat), buf,
4023 human_output_opts, ST_NBLOCKSIZE,
4025 : block_size_width);
4028 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
4030 quote_name (NULL, f->name, filename_quoting_options, &name_width);
4033 if (indicator_style != none)
4035 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4043 print_many_per_line (void)
4045 size_t row; /* Current row. */
4046 size_t cols = calculate_columns (true);
4047 struct column_info const *line_fmt = &column_info[cols - 1];
4049 /* Calculate the number of rows that will be in each column except possibly
4050 for a short column on the right. */
4051 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
4053 for (row = 0; row < rows; row++)
4056 size_t filesno = row;
4059 /* Print the next row. */
4062 struct fileinfo const *f = sorted_file[filesno];
4063 size_t name_length = length_of_file_name_and_frills (f);
4064 size_t max_name_length = line_fmt->col_arr[col++];
4065 print_file_name_and_frills (f);
4068 if (filesno >= cwd_n_used)
4071 indent (pos + name_length, pos + max_name_length);
4072 pos += max_name_length;
4079 print_horizontal (void)
4083 size_t cols = calculate_columns (false);
4084 struct column_info const *line_fmt = &column_info[cols - 1];
4085 struct fileinfo const *f = sorted_file[0];
4086 size_t name_length = length_of_file_name_and_frills (f);
4087 size_t max_name_length = line_fmt->col_arr[0];
4089 /* Print first entry. */
4090 print_file_name_and_frills (f);
4093 for (filesno = 1; filesno < cwd_n_used; ++filesno)
4095 size_t col = filesno % cols;
4104 indent (pos + name_length, pos + max_name_length);
4105 pos += max_name_length;
4108 f = sorted_file[filesno];
4109 print_file_name_and_frills (f);
4111 name_length = length_of_file_name_and_frills (f);
4112 max_name_length = line_fmt->col_arr[col];
4118 print_with_commas (void)
4123 for (filesno = 0; filesno < cwd_n_used; filesno++)
4125 struct fileinfo const *f = sorted_file[filesno];
4126 size_t len = length_of_file_name_and_frills (f);
4132 if (pos + len + 2 < line_length)
4144 putchar (separator);
4147 print_file_name_and_frills (f);
4153 /* Assuming cursor is at position FROM, indent up to position TO.
4154 Use a TAB character instead of two or more spaces whenever possible. */
4157 indent (size_t from, size_t to)
4161 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4164 from += tabsize - from % tabsize;
4174 /* Put DIRNAME/NAME into DEST, handling `.' and `/' properly. */
4175 /* FIXME: maybe remove this function someday. See about using a
4176 non-malloc'ing version of file_name_concat. */
4179 attach (char *dest, const char *dirname, const char *name)
4181 const char *dirnamep = dirname;
4183 /* Copy dirname if it is not ".". */
4184 if (dirname[0] != '.' || dirname[1] != 0)
4187 *dest++ = *dirnamep++;
4188 /* Add '/' if `dirname' doesn't already end with it. */
4189 if (dirnamep > dirname && dirnamep[-1] != '/')
4197 /* Allocate enough column info suitable for the current number of
4198 files and display columns, and initialize the info to represent the
4199 narrowest possible columns. */
4202 init_column_info (void)
4205 size_t max_cols = MIN (max_idx, cwd_n_used);
4207 /* Currently allocated columns in column_info. */
4208 static size_t column_info_alloc;
4210 if (column_info_alloc < max_cols)
4212 size_t new_column_info_alloc;
4215 if (max_cols < max_idx / 2)
4217 /* The number of columns is far less than the display width
4218 allows. Grow the allocation, but only so that it's
4219 double the current requirements. If the display is
4220 extremely wide, this avoids allocating a lot of memory
4221 that is never needed. */
4222 column_info = xnrealloc (column_info, max_cols,
4223 2 * sizeof *column_info);
4224 new_column_info_alloc = 2 * max_cols;
4228 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4229 new_column_info_alloc = max_idx;
4232 /* Allocate the new size_t objects by computing the triangle
4233 formula n * (n + 1) / 2, except that we don't need to
4234 allocate the part of the triangle that we've already
4235 allocated. Check for address arithmetic overflow. */
4237 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4238 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4239 size_t t = s * column_info_growth;
4240 if (s < new_column_info_alloc || t / column_info_growth != s)
4242 p = xnmalloc (t / 2, sizeof *p);
4245 /* Grow the triangle by parceling out the cells just allocated. */
4246 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4248 column_info[i].col_arr = p;
4252 column_info_alloc = new_column_info_alloc;
4255 for (i = 0; i < max_cols; ++i)
4259 column_info[i].valid_len = true;
4260 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4261 for (j = 0; j <= i; ++j)
4262 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4266 /* Calculate the number of columns needed to represent the current set
4267 of files in the current display width. */
4270 calculate_columns (bool by_columns)
4272 size_t filesno; /* Index into cwd_file. */
4273 size_t cols; /* Number of files across. */
4275 /* Normally the maximum number of columns is determined by the
4276 screen width. But if few files are available this might limit it
4278 size_t max_cols = MIN (max_idx, cwd_n_used);
4280 init_column_info ();
4282 /* Compute the maximum number of possible columns. */
4283 for (filesno = 0; filesno < cwd_n_used; ++filesno)
4285 struct fileinfo const *f = sorted_file[filesno];
4286 size_t name_length = length_of_file_name_and_frills (f);
4289 for (i = 0; i < max_cols; ++i)
4291 if (column_info[i].valid_len)
4293 size_t idx = (by_columns
4294 ? filesno / ((cwd_n_used + i) / (i + 1))
4295 : filesno % (i + 1));
4296 size_t real_length = name_length + (idx == i ? 0 : 2);
4298 if (column_info[i].col_arr[idx] < real_length)
4300 column_info[i].line_len += (real_length
4301 - column_info[i].col_arr[idx]);
4302 column_info[i].col_arr[idx] = real_length;
4303 column_info[i].valid_len = (column_info[i].line_len
4310 /* Find maximum allowed columns. */
4311 for (cols = max_cols; 1 < cols; --cols)
4313 if (column_info[cols - 1].valid_len)
4323 if (status != EXIT_SUCCESS)
4324 fprintf (stderr, _("Try `%s --help' for more information.\n"),
4328 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4330 List information about the FILEs (the current directory by default).\n\
4331 Sort entries alphabetically if none of -cftuvSUX nor --sort.\n\
4335 Mandatory arguments to long options are mandatory for short options too.\n\
4338 -a, --all do not ignore entries starting with .\n\
4339 -A, --almost-all do not list implied . and ..\n\
4340 --author with -l, print the author of each file\n\
4341 -b, --escape print octal escapes for nongraphic characters\n\
4344 --block-size=SIZE use SIZE-byte blocks\n\
4345 -B, --ignore-backups do not list implied entries ending with ~\n\
4346 -c with -lt: sort by, and show, ctime (time of last\n\
4347 modification of file status information)\n\
4348 with -l: show ctime and sort by name\n\
4349 otherwise: sort by ctime\n\
4352 -C list entries by columns\n\
4353 --color[=WHEN] control whether color is used to distinguish file\n\
4354 types. WHEN may be `never', `always', or `auto'\n\
4355 -d, --directory list directory entries instead of contents,\n\
4356 and do not dereference symbolic links\n\
4357 -D, --dired generate output designed for Emacs' dired mode\n\
4360 -f do not sort, enable -aU, disable -ls --color\n\
4361 -F, --classify append indicator (one of */=>@|) to entries\n\
4362 --file-type likewise, except do not append `*'\n\
4363 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4364 single-column -1, verbose -l, vertical -C\n\
4365 --full-time like -l --time-style=full-iso\n\
4368 -g like -l, but do not list owner\n\
4371 --group-directories-first\n\
4372 group directories before files.\n\
4373 augment with a --sort option, but any\n\
4374 use of --sort=none (-U) disables grouping\n\
4377 -G, --no-group in a long listing, don't print group names\n\
4378 -h, --human-readable with -l, print sizes in human readable format\n\
4379 (e.g., 1K 234M 2G)\n\
4380 --si likewise, but use powers of 1000 not 1024\n\
4383 -H, --dereference-command-line\n\
4384 follow symbolic links listed on the command line\n\
4385 --dereference-command-line-symlink-to-dir\n\
4386 follow each command line symbolic link\n\
4387 that points to a directory\n\
4388 --hide=PATTERN do not list implied entries matching shell PATTERN\n\
4389 (overridden by -a or -A)\n\
4392 --indicator-style=WORD append indicator with style WORD to entry names:\n\
4393 none (default), slash (-p),\n\
4394 file-type (--file-type), classify (-F)\n\
4395 -i, --inode print the index number of each file\n\
4396 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\n\
4397 -k like --block-size=1K\n\
4400 -l use a long listing format\n\
4401 -L, --dereference when showing file information for a symbolic\n\
4402 link, show information for the file the link\n\
4403 references rather than for the link itself\n\
4404 -m fill width with a comma separated list of entries\n\
4407 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4408 -N, --literal print raw entry names (don't treat e.g. control\n\
4409 characters specially)\n\
4410 -o like -l, but do not list group information\n\
4411 -p, --indicator-style=slash\n\
4412 append / indicator to directories\n\
4415 -q, --hide-control-chars print ? instead of non graphic characters\n\
4416 --show-control-chars show non graphic characters as-is (default\n\
4417 unless program is `ls' and output is a terminal)\n\
4418 -Q, --quote-name enclose entry names in double quotes\n\
4419 --quoting-style=WORD use quoting style WORD for entry names:\n\
4420 literal, locale, shell, shell-always, c, escape\n\
4423 -r, --reverse reverse order while sorting\n\
4424 -R, --recursive list subdirectories recursively\n\
4425 -s, --size print the size of each file, in blocks\n\
4428 -S sort by file size\n\
4429 --sort=WORD sort by WORD instead of name: none -U,\n\
4430 extension -X, size -S, time -t, version -v\n\
4431 --time=WORD with -l, show time as WORD instead of modification\n\
4432 time: atime -u, access -u, use -u, ctime -c,\n\
4433 or status -c; use specified time as sort key\n\
4437 --time-style=STYLE with -l, show times using style STYLE:\n\
4438 full-iso, long-iso, iso, locale, +FORMAT.\n\
4439 FORMAT is interpreted like `date'; if FORMAT is\n\
4440 FORMAT1<newline>FORMAT2, FORMAT1 applies to\n\
4441 non-recent files and FORMAT2 to recent files;\n\
4442 if STYLE is prefixed with `posix-', STYLE\n\
4443 takes effect only outside the POSIX locale\n\
4446 -t sort by modification time\n\
4447 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4450 -u with -lt: sort by, and show, access time\n\
4451 with -l: show access time and sort by name\n\
4452 otherwise: sort by access time\n\
4453 -U do not sort; list entries in directory order\n\
4454 -v sort by version\n\
4457 -w, --width=COLS assume screen width instead of current value\n\
4458 -x list entries by lines instead of by columns\n\
4459 -X sort alphabetically by entry extension\n\
4460 -Z, --context print any SELinux security context of each file\n\
4461 -1 list one file per line\n\
4463 fputs (HELP_OPTION_DESCRIPTION, stdout);
4464 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4466 SIZE may be (or may be an integer optionally followed by) one of following:\n\
4467 kB 1000, K 1024, MB 1000*1000, M 1024*1024, and so on for G, T, P, E, Z, Y.\n\
4471 By default, color is not used to distinguish types of files. That is\n\
4472 equivalent to using --color=none. Using the --color option without the\n\
4473 optional WHEN argument is equivalent to using --color=always. With\n\
4474 --color=auto, color codes are output only if standard output is connected\n\
4475 to a terminal (tty). The environment variable LS_COLORS can influence the\n\
4476 colors, and can be set easily by the dircolors command.\n\
4480 Exit status is 0 if OK, 1 if minor problems, 2 if serious trouble.\n\
4482 emit_bug_reporting_address ();