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 \
113 #define AUTHORS "Richard Stallman", "David MacKenzie"
115 #define obstack_chunk_alloc malloc
116 #define obstack_chunk_free free
118 /* Return an int indicating the result of comparing two integers.
119 Subtracting doesn't always work, due to overflow. */
120 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
122 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
123 # define st_author st_uid
140 /* Display letters and indicators for each filetype.
141 Keep these in sync with enum filetype. */
142 static char const filetype_letter[] = "?pcdb-lswd";
144 /* Ensure that filetype and filetype_letter have the same
145 number of elements. */
146 verify (sizeof filetype_letter - 1 == arg_directory + 1);
148 #define FILETYPE_INDICATORS \
150 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
151 C_LINK, C_SOCK, C_FILE, C_DIR \
160 /* For symbolic link, name of the file linked to, otherwise zero. */
165 enum filetype filetype;
167 /* For symbolic link and long listing, st_mode of file linked to, otherwise
171 /* SELinux security context. */
172 security_context_t scontext;
176 /* For symbolic link and color printing, true if linked-to file
177 exists, otherwise false. */
180 /* For long listings, true if the file has an access control list,
181 or an SELinux security context. */
185 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
187 /* Null is a valid character in a color indicator (think about Epson
188 printers, for example) so we have to use a length/buffer string
193 size_t len; /* Number of bytes */
194 const char *string; /* Pointer to the same */
198 # define tcgetpgrp(Fd) 0
201 static size_t quote_name (FILE *out, const char *name,
202 struct quoting_options const *options,
204 static char *make_link_name (char const *name, char const *linkname);
205 static int decode_switches (int argc, char **argv);
206 static bool file_ignored (char const *name);
207 static uintmax_t gobble_file (char const *name, enum filetype type,
208 ino_t inode, bool command_line_arg,
209 char const *dirname);
210 static bool print_color_indicator (const char *name, mode_t mode, int linkok,
211 bool stat_ok, enum filetype type);
212 static void put_indicator (const struct bin_str *ind);
213 static void add_ignore_pattern (const char *pattern);
214 static void attach (char *dest, const char *dirname, const char *name);
215 static void clear_files (void);
216 static void extract_dirs_from_files (char const *dirname,
217 bool command_line_arg);
218 static void get_link_name (char const *filename, struct fileinfo *f,
219 bool command_line_arg);
220 static void indent (size_t from, size_t to);
221 static size_t calculate_columns (bool by_columns);
222 static void print_current_files (void);
223 static void print_dir (char const *name, char const *realname,
224 bool command_line_arg);
225 static void print_file_name_and_frills (const struct fileinfo *f);
226 static void print_horizontal (void);
227 static int format_user_width (uid_t u);
228 static int format_group_width (gid_t g);
229 static void print_long_format (const struct fileinfo *f);
230 static void print_many_per_line (void);
231 static void print_name_with_quoting (const char *p, mode_t mode,
232 int linkok, bool stat_ok,
234 struct obstack *stack);
235 static void prep_non_filename_text (void);
236 static void print_type_indicator (bool stat_ok, mode_t mode,
238 static void print_with_commas (void);
239 static void queue_directory (char const *name, char const *realname,
240 bool command_line_arg);
241 static void sort_files (void);
242 static void parse_ls_color (void);
243 void usage (int status);
245 /* The name this program was run with. */
248 /* Initial size of hash table.
249 Most hierarchies are likely to be shallower than this. */
250 #define INITIAL_TABLE_SIZE 30
252 /* The set of `active' directories, from the current command-line argument
253 to the level in the hierarchy at which files are being listed.
254 A directory is represented by its device and inode numbers (struct dev_ino).
255 A directory is added to this set when ls begins listing it or its
256 entries, and it is removed from the set just after ls has finished
257 processing it. This set is used solely to detect loops, e.g., with
258 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
259 static Hash_table *active_dir_set;
261 #define LOOP_DETECT (!!active_dir_set)
263 /* The table of files in the current directory:
265 `cwd_file' points to a vector of `struct fileinfo', one per file.
266 `cwd_n_alloc' is the number of elements space has been allocated for.
267 `cwd_n_used' is the number actually in use. */
269 /* Address of block containing the files that are described. */
270 static struct fileinfo *cwd_file;
272 /* Length of block that `cwd_file' points to, measured in files. */
273 static size_t cwd_n_alloc;
275 /* Index of first unused slot in `cwd_file'. */
276 static size_t cwd_n_used;
278 /* Vector of pointers to files, in proper sorted order, and the number
279 of entries allocated for it. */
280 static void **sorted_file;
281 static size_t sorted_file_alloc;
283 /* When true, in a color listing, color each symlink name according to the
284 type of file it points to. Otherwise, color them according to the `ln'
285 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
286 regardless. This is set when `ln=target' appears in LS_COLORS. */
288 static bool color_symlink_as_referent;
290 /* mode of appropriate file for colorization */
291 #define FILE_OR_LINK_MODE(File) \
292 ((color_symlink_as_referent & (File)->linkok) \
293 ? (File)->linkmode : (File)->stat.st_mode)
296 /* Record of one pending directory waiting to be listed. */
301 /* If the directory is actually the file pointed to by a symbolic link we
302 were told to list, `realname' will contain the name of the symbolic
303 link, otherwise zero. */
305 bool command_line_arg;
306 struct pending *next;
309 static struct pending *pending_dirs;
311 /* Current time in seconds and nanoseconds since 1970, updated as
312 needed when deciding whether a file is recent. */
314 static struct timespec current_time;
316 static bool print_scontext;
317 static char UNKNOWN_SECURITY_CONTEXT[] = "?";
319 /* Whether any of the files has an ACL. This affects the width of the
322 static bool any_has_acl;
324 /* The number of columns to use for columns containing inode numbers,
325 block sizes, link counts, owners, groups, authors, major device
326 numbers, minor device numbers, and file sizes, respectively. */
328 static int inode_number_width;
329 static int block_size_width;
330 static int nlink_width;
331 static int scontext_width;
332 static int owner_width;
333 static int group_width;
334 static int author_width;
335 static int major_device_number_width;
336 static int minor_device_number_width;
337 static int file_size_width;
341 /* long_format for lots of info, one per line.
342 one_per_line for just names, one per line.
343 many_per_line for just names, many per line, sorted vertically.
344 horizontal for just names, many per line, sorted horizontally.
345 with_commas for just names, many per line, separated by commas.
347 -l (and other options that imply -l), -1, -C, -x and -m control
352 long_format, /* -l and other options that imply -l */
353 one_per_line, /* -1 */
354 many_per_line, /* -C */
359 static enum format format;
361 /* `full-iso' uses full ISO-style dates and times. `long-iso' uses longer
362 ISO-style time stamps, though shorter than `full-iso'. `iso' uses shorter
363 ISO-style time stamps. `locale' uses locale-dependent time stamps. */
366 full_iso_time_style, /* --time-style=full-iso */
367 long_iso_time_style, /* --time-style=long-iso */
368 iso_time_style, /* --time-style=iso */
369 locale_time_style /* --time-style=locale */
372 static char const *const time_style_args[] =
374 "full-iso", "long-iso", "iso", "locale", NULL
376 static enum time_style const time_style_types[] =
378 full_iso_time_style, long_iso_time_style, iso_time_style,
381 ARGMATCH_VERIFY (time_style_args, time_style_types);
383 /* Type of time to print or sort by. Controlled by -c and -u.
384 The values of each item of this enum are important since they are
385 used as indices in the sort functions array (see sort_files()). */
389 time_mtime, /* default */
392 time_numtypes /* the number of elements of this enum */
395 static enum time_type time_type;
397 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
398 The values of each item of this enum are important since they are
399 used as indices in the sort functions array (see sort_files()). */
403 sort_none = -1, /* -U */
404 sort_name, /* default */
405 sort_extension, /* -X */
407 sort_version, /* -v */
409 sort_numtypes /* the number of elements of this enum */
412 static enum sort_type sort_type;
414 /* Direction of sort.
415 false means highest first if numeric,
416 lowest first if alphabetic;
417 these are the defaults.
418 true means the opposite order in each case. -r */
420 static bool sort_reverse;
422 /* True means to display owner information. -g turns this off. */
424 static bool print_owner = true;
426 /* True means to display author information. */
428 static bool print_author;
430 /* True means to display group information. -G and -o turn this off. */
432 static bool print_group = true;
434 /* True means print the user and group id's as numbers rather
437 static bool numeric_ids;
439 /* True means mention the size in blocks of each file. -s */
441 static bool print_block_size;
443 /* Human-readable options for output. */
444 static int human_output_opts;
446 /* The units to use when printing sizes other than file sizes. */
447 static uintmax_t output_block_size;
449 /* Likewise, but for file sizes. */
450 static uintmax_t file_output_block_size = 1;
452 /* Follow the output with a special string. Using this format,
453 Emacs' dired mode starts up twice as fast, and can handle all
454 strange characters in file names. */
457 /* `none' means don't mention the type of files.
458 `slash' means mention directories only, with a '/'.
459 `file_type' means mention file types.
460 `classify' means mention file types and mark executables.
462 Controlled by -F, -p, and --indicator-style. */
466 none, /* --indicator-style=none */
467 slash, /* -p, --indicator-style=slash */
468 file_type, /* --indicator-style=file-type */
469 classify /* -F, --indicator-style=classify */
472 static enum indicator_style indicator_style;
474 /* Names of indicator styles. */
475 static char const *const indicator_style_args[] =
477 "none", "slash", "file-type", "classify", NULL
479 static enum indicator_style const indicator_style_types[] =
481 none, slash, file_type, classify
483 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
485 /* True means use colors to mark types. Also define the different
486 colors as well as the stuff for the LS_COLORS environment variable.
487 The LS_COLORS variable is now in a termcap-like format. */
489 static bool print_with_color;
491 /* Whether we used any colors in the output so far. If so, we will
492 need to restore the default color later. If not, we will need to
493 call prep_non_filename_text before using color for the first time. */
495 static bool used_color = false;
499 color_never, /* 0: default or --color=never */
500 color_always, /* 1: --color=always */
501 color_if_tty /* 2: --color=tty */
504 enum Dereference_symlink
508 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
509 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
510 DEREF_ALWAYS /* -L */
515 C_LEFT, C_RIGHT, C_END, C_RESET, C_NORM, C_FILE, C_DIR, C_LINK,
517 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
518 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE
521 static const char *const indicator_name[]=
523 "lc", "rc", "ec", "rs", "no", "fi", "di", "ln", "pi", "so",
524 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
528 struct color_ext_type
530 struct bin_str ext; /* The extension we're looking for */
531 struct bin_str seq; /* The sequence to output when we do */
532 struct color_ext_type *next; /* Next in list */
535 static struct bin_str color_indicator[] =
537 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
538 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
539 { 0, NULL }, /* ec: End color (replaces lc+no+rc) */
540 { LEN_STR_PAIR ("0") }, /* rs: Reset to ordinary colors */
541 { 0, NULL }, /* no: Normal */
542 { 0, NULL }, /* fi: File: default */
543 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
544 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
545 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
546 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
547 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
548 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
549 { 0, NULL }, /* mi: Missing file: undefined */
550 { 0, NULL }, /* or: Orphaned symlink: undefined */
551 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
552 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
553 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
554 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
555 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
556 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
557 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
561 static struct color_ext_type *color_ext_list = NULL;
563 /* Buffer for color sequences */
564 static char *color_buf;
566 /* True means to check for orphaned symbolic link, for displaying
569 static bool check_symlink_color;
571 /* True means mention the inode number of each file. -i */
573 static bool print_inode;
575 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
576 other options that imply -l), and -L. */
578 static enum Dereference_symlink dereference;
580 /* True means when a directory is found, display info on its
583 static bool recursive;
585 /* True means when an argument is a directory name, display info
588 static bool immediate_dirs;
590 /* True means that directories are grouped before files. */
592 static bool directories_first;
594 /* Which files to ignore. */
598 /* Ignore files whose names start with `.', and files specified by
599 --hide and --ignore. */
602 /* Ignore `.', `..', and files specified by --ignore. */
603 IGNORE_DOT_AND_DOTDOT,
605 /* Ignore only files specified by --ignore. */
609 /* A linked list of shell-style globbing patterns. If a non-argument
610 file name matches any of these patterns, it is ignored.
611 Controlled by -I. Multiple -I options accumulate.
612 The -B option adds `*~' and `.*~' to this list. */
614 struct ignore_pattern
617 struct ignore_pattern *next;
620 static struct ignore_pattern *ignore_patterns;
622 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
623 variable itself to be ignored. */
624 static struct ignore_pattern *hide_patterns;
626 /* True means output nongraphic chars in file names as `?'.
627 (-q, --hide-control-chars)
628 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
629 independent. The algorithm is: first, obey the quoting style to get a
630 string representing the file name; then, if qmark_funny_chars is set,
631 replace all nonprintable chars in that string with `?'. It's necessary
632 to replace nonprintable chars even in quoted strings, because we don't
633 want to mess up the terminal if control chars get sent to it, and some
634 quoting methods pass through control chars as-is. */
635 static bool qmark_funny_chars;
637 /* Quoting options for file and dir name output. */
639 static struct quoting_options *filename_quoting_options;
640 static struct quoting_options *dirname_quoting_options;
642 /* The number of chars per hardware tab stop. Setting this to zero
643 inhibits the use of TAB characters for separating columns. -T */
644 static size_t tabsize;
646 /* True means print each directory name before listing it. */
648 static bool print_dir_name;
650 /* The line length to use for breaking lines in many-per-line format.
651 Can be set with -w. */
653 static size_t line_length;
655 /* If true, the file listing format requires that stat be called on
658 static bool format_needs_stat;
660 /* Similar to `format_needs_stat', but set if only the file type is
663 static bool format_needs_type;
665 /* An arbitrary limit on the number of bytes in a printed time stamp.
666 This is set to a relatively small value to avoid the need to worry
667 about denial-of-service attacks on servers that run "ls" on behalf
668 of remote clients. 1000 bytes should be enough for any practical
669 time stamp format. */
671 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
673 /* strftime formats for non-recent and recent files, respectively, in
676 static char const *long_time_format[2] =
678 /* strftime format for non-recent files (older than 6 months), in
679 -l output. This should contain the year, month and day (at
680 least), in an order that is understood by people in your
681 locale's territory. Please try to keep the number of used
682 screen columns small, because many people work in windows with
683 only 80 columns. But make this as wide as the other string
684 below, for recent files. */
686 /* strftime format for recent files (younger than 6 months), in -l
687 output. This should contain the month, day and time (at
688 least), in an order that is understood by people in your
689 locale's territory. Please try to keep the number of used
690 screen columns small, because many people work in windows with
691 only 80 columns. But make this as wide as the other string
692 above, for non-recent files. */
696 /* The set of signals that are caught. */
698 static sigset_t caught_signals;
700 /* If nonzero, the value of the pending fatal signal. */
702 static sig_atomic_t volatile interrupt_signal;
704 /* A count of the number of pending stop signals that have been received. */
706 static sig_atomic_t volatile stop_signal_count;
708 /* Desired exit status. */
710 static int exit_status;
715 /* "ls" had a minor problem (e.g., it could not stat a directory
717 LS_MINOR_PROBLEM = 1,
719 /* "ls" had more serious trouble. */
723 /* For long options that have no equivalent short option, use a
724 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
727 AUTHOR_OPTION = CHAR_MAX + 1,
730 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
731 FILE_TYPE_INDICATOR_OPTION,
734 GROUP_DIRECTORIES_FIRST_OPTION,
736 INDICATOR_STYLE_OPTION,
737 QUOTING_STYLE_OPTION,
738 SHOW_CONTROL_CHARS_OPTION,
745 static struct option const long_options[] =
747 {"all", no_argument, NULL, 'a'},
748 {"escape", no_argument, NULL, 'b'},
749 {"directory", no_argument, NULL, 'd'},
750 {"dired", no_argument, NULL, 'D'},
751 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
752 {"group-directories-first", no_argument, NULL,
753 GROUP_DIRECTORIES_FIRST_OPTION},
754 {"human-readable", no_argument, NULL, 'h'},
755 {"inode", no_argument, NULL, 'i'},
756 {"numeric-uid-gid", no_argument, NULL, 'n'},
757 {"no-group", no_argument, NULL, 'G'},
758 {"hide-control-chars", no_argument, NULL, 'q'},
759 {"reverse", no_argument, NULL, 'r'},
760 {"size", no_argument, NULL, 's'},
761 {"width", required_argument, NULL, 'w'},
762 {"almost-all", no_argument, NULL, 'A'},
763 {"ignore-backups", no_argument, NULL, 'B'},
764 {"classify", no_argument, NULL, 'F'},
765 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
766 {"si", no_argument, NULL, SI_OPTION},
767 {"dereference-command-line", no_argument, NULL, 'H'},
768 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
769 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
770 {"hide", required_argument, NULL, HIDE_OPTION},
771 {"ignore", required_argument, NULL, 'I'},
772 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
773 {"dereference", no_argument, NULL, 'L'},
774 {"literal", no_argument, NULL, 'N'},
775 {"quote-name", no_argument, NULL, 'Q'},
776 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
777 {"recursive", no_argument, NULL, 'R'},
778 {"format", required_argument, NULL, FORMAT_OPTION},
779 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
780 {"sort", required_argument, NULL, SORT_OPTION},
781 {"tabsize", required_argument, NULL, 'T'},
782 {"time", required_argument, NULL, TIME_OPTION},
783 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
784 {"color", optional_argument, NULL, COLOR_OPTION},
785 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
786 {"context", no_argument, 0, 'Z'},
787 {"author", no_argument, NULL, AUTHOR_OPTION},
788 {GETOPT_HELP_OPTION_DECL},
789 {GETOPT_VERSION_OPTION_DECL},
793 static char const *const format_args[] =
795 "verbose", "long", "commas", "horizontal", "across",
796 "vertical", "single-column", NULL
798 static enum format const format_types[] =
800 long_format, long_format, with_commas, horizontal, horizontal,
801 many_per_line, one_per_line
803 ARGMATCH_VERIFY (format_args, format_types);
805 static char const *const sort_args[] =
807 "none", "time", "size", "extension", "version", NULL
809 static enum sort_type const sort_types[] =
811 sort_none, sort_time, sort_size, sort_extension, sort_version
813 ARGMATCH_VERIFY (sort_args, sort_types);
815 static char const *const time_args[] =
817 "atime", "access", "use", "ctime", "status", NULL
819 static enum time_type const time_types[] =
821 time_atime, time_atime, time_atime, time_ctime, time_ctime
823 ARGMATCH_VERIFY (time_args, time_types);
825 static char const *const color_args[] =
827 /* force and none are for compatibility with another color-ls version */
828 "always", "yes", "force",
829 "never", "no", "none",
830 "auto", "tty", "if-tty", NULL
832 static enum color_type const color_types[] =
834 color_always, color_always, color_always,
835 color_never, color_never, color_never,
836 color_if_tty, color_if_tty, color_if_tty
838 ARGMATCH_VERIFY (color_args, color_types);
840 /* Information about filling a column. */
848 /* Array with information about column filledness. */
849 static struct column_info *column_info;
851 /* Maximum number of columns ever possible for this display. */
852 static size_t max_idx;
854 /* The minimum width of a column is 3: 1 character for the name and 2
855 for the separating white space. */
856 #define MIN_COLUMN_WIDTH 3
859 /* This zero-based index is used solely with the --dired option.
860 When that option is in effect, this counter is incremented for each
861 byte of output generated by this program so that the beginning
862 and ending indices (in that output) of every file name can be recorded
863 and later output themselves. */
864 static size_t dired_pos;
866 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
868 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
869 #define DIRED_FPUTS(s, stream, s_len) \
870 do {fputs (s, stream); dired_pos += s_len;} while (0)
872 /* Like DIRED_FPUTS, but for use when S is a literal string. */
873 #define DIRED_FPUTS_LITERAL(s, stream) \
874 do {fputs (s, stream); dired_pos += sizeof (s) - 1;} while (0)
876 #define DIRED_INDENT() \
880 DIRED_FPUTS_LITERAL (" ", stdout); \
884 /* With --dired, store pairs of beginning and ending indices of filenames. */
885 static struct obstack dired_obstack;
887 /* With --dired, store pairs of beginning and ending indices of any
888 directory names that appear as headers (just before `total' line)
889 for lists of directory entries. Such directory names are seen when
890 listing hierarchies using -R and when a directory is listed with at
891 least one other command line argument. */
892 static struct obstack subdired_obstack;
894 /* Save the current index on the specified obstack, OBS. */
895 #define PUSH_CURRENT_DIRED_POS(obs) \
899 obstack_grow (obs, &dired_pos, sizeof (dired_pos)); \
903 /* With -R, this stack is used to help detect directory cycles.
904 The device/inode pairs on this stack mirror the pairs in the
905 active_dir_set hash table. */
906 static struct obstack dev_ino_obstack;
908 /* Push a pair onto the device/inode stack. */
909 #define DEV_INO_PUSH(Dev, Ino) \
912 struct dev_ino *di; \
913 obstack_blank (&dev_ino_obstack, sizeof (struct dev_ino)); \
914 di = -1 + (struct dev_ino *) obstack_next_free (&dev_ino_obstack); \
915 di->st_dev = (Dev); \
916 di->st_ino = (Ino); \
920 /* Pop a dev/ino struct off the global dev_ino_obstack
921 and return that struct. */
922 static struct dev_ino
925 assert (sizeof (struct dev_ino) <= obstack_object_size (&dev_ino_obstack));
926 obstack_blank (&dev_ino_obstack, -(int) (sizeof (struct dev_ino)));
927 return *(struct dev_ino *) obstack_next_free (&dev_ino_obstack);
930 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
935 assert (0 <= stat (Name, &sb)); \
936 assert (sb.st_dev == Di.st_dev); \
937 assert (sb.st_ino == Di.st_ino); \
942 /* Write to standard output PREFIX, followed by the quoting style and
943 a space-separated list of the integers stored in OS all on one line. */
946 dired_dump_obstack (const char *prefix, struct obstack *os)
950 n_pos = obstack_object_size (os) / sizeof (dired_pos);
956 pos = (size_t *) obstack_finish (os);
957 fputs (prefix, stdout);
958 for (i = 0; i < n_pos; i++)
959 printf (" %lu", (unsigned long int) pos[i]);
965 dev_ino_hash (void const *x, size_t table_size)
967 struct dev_ino const *p = x;
968 return (uintmax_t) p->st_ino % table_size;
972 dev_ino_compare (void const *x, void const *y)
974 struct dev_ino const *a = x;
975 struct dev_ino const *b = y;
976 return SAME_INODE (*a, *b) ? true : false;
980 dev_ino_free (void *x)
985 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
986 active directories. Return true if there is already a matching
987 entry in the table. */
990 visit_dir (dev_t dev, ino_t ino)
993 struct dev_ino *ent_from_table;
996 ent = xmalloc (sizeof *ent);
1000 /* Attempt to insert this entry into the table. */
1001 ent_from_table = hash_insert (active_dir_set, ent);
1003 if (ent_from_table == NULL)
1005 /* Insertion failed due to lack of memory. */
1009 found_match = (ent_from_table != ent);
1013 /* ent was not inserted, so free it. */
1021 free_pending_ent (struct pending *p)
1029 is_colored (enum indicator_no type)
1031 size_t len = color_indicator[type].len;
1032 char const *s = color_indicator[type].string;
1034 || (len == 1 && strncmp (s, "0", 1) == 0)
1035 || (len == 2 && strncmp (s, "00", 2) == 0));
1039 restore_default_color (void)
1041 put_indicator (&color_indicator[C_LEFT]);
1042 put_indicator (&color_indicator[C_RIGHT]);
1045 /* An ordinary signal was received; arrange for the program to exit. */
1048 sighandler (int sig)
1051 signal (sig, SIG_IGN);
1052 if (! interrupt_signal)
1053 interrupt_signal = sig;
1056 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1059 stophandler (int sig)
1062 signal (sig, stophandler);
1063 if (! interrupt_signal)
1064 stop_signal_count++;
1067 /* Process any pending signals. If signals are caught, this function
1068 should be called periodically. Ideally there should never be an
1069 unbounded amount of time when signals are not being processed.
1070 Signal handling can restore the default colors, so callers must
1071 immediately change colors after invoking this function. */
1074 process_signals (void)
1076 while (interrupt_signal | stop_signal_count)
1083 restore_default_color ();
1086 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1088 /* Reload interrupt_signal and stop_signal_count, in case a new
1089 signal was handled before sigprocmask took effect. */
1090 sig = interrupt_signal;
1091 stops = stop_signal_count;
1093 /* SIGTSTP is special, since the application can receive that signal
1094 more than once. In this case, don't set the signal handler to the
1095 default. Instead, just raise the uncatchable SIGSTOP. */
1098 stop_signal_count = stops - 1;
1102 signal (sig, SIG_DFL);
1104 /* Exit or suspend the program. */
1106 sigprocmask (SIG_SETMASK, &oldset, NULL);
1108 /* If execution reaches here, then the program has been
1109 continued (after being suspended). */
1114 main (int argc, char **argv)
1117 struct pending *thispend;
1120 /* The signals that are trapped, and the number of such signals. */
1121 static int const sig[] =
1123 /* This one is handled specially. */
1126 /* The usual suspects. */
1127 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1144 enum { nsigs = sizeof sig / sizeof sig[0] };
1147 bool caught_sig[nsigs];
1150 initialize_main (&argc, &argv);
1151 program_name = argv[0];
1152 setlocale (LC_ALL, "");
1153 bindtextdomain (PACKAGE, LOCALEDIR);
1154 textdomain (PACKAGE);
1156 initialize_exit_failure (LS_FAILURE);
1157 atexit (close_stdout);
1159 #define N_ENTRIES(Array) (sizeof Array / sizeof *(Array))
1160 assert (N_ENTRIES (color_indicator) + 1 == N_ENTRIES (indicator_name));
1162 exit_status = EXIT_SUCCESS;
1163 print_dir_name = true;
1164 pending_dirs = NULL;
1166 current_time.tv_sec = TYPE_MINIMUM (time_t);
1167 current_time.tv_nsec = -1;
1169 i = decode_switches (argc, argv);
1171 if (print_with_color)
1174 /* Test print_with_color again, because the call to parse_ls_color
1175 may have just reset it -- e.g., if LS_COLORS is invalid. */
1176 if (print_with_color)
1178 /* Avoid following symbolic links when possible. */
1179 if (is_colored (C_ORPHAN)
1180 || (is_colored (C_EXEC) && color_symlink_as_referent)
1181 || (is_colored (C_MISSING) && format == long_format))
1182 check_symlink_color = true;
1184 /* If the standard output is a controlling terminal, watch out
1185 for signals, so that the colors can be restored to the
1186 default state if "ls" is suspended or interrupted. */
1188 if (0 <= tcgetpgrp (STDOUT_FILENO))
1192 struct sigaction act;
1194 sigemptyset (&caught_signals);
1195 for (j = 0; j < nsigs; j++)
1197 sigaction (sig[j], NULL, &act);
1198 if (act.sa_handler != SIG_IGN)
1199 sigaddset (&caught_signals, sig[j]);
1202 act.sa_mask = caught_signals;
1203 act.sa_flags = SA_RESTART;
1205 for (j = 0; j < nsigs; j++)
1206 if (sigismember (&caught_signals, sig[j]))
1208 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1209 sigaction (sig[j], &act, NULL);
1212 for (j = 0; j < nsigs; j++)
1214 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1217 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1218 siginterrupt (sig[j], 0);
1225 if (dereference == DEREF_UNDEFINED)
1226 dereference = ((immediate_dirs
1227 || indicator_style == classify
1228 || format == long_format)
1230 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1232 /* When using -R, initialize a data structure we'll use to
1233 detect any directory cycles. */
1236 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, NULL,
1240 if (active_dir_set == NULL)
1243 obstack_init (&dev_ino_obstack);
1246 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1247 || format == long_format
1249 || print_block_size;
1250 format_needs_type = (! format_needs_stat
1253 || indicator_style != none
1254 || directories_first));
1258 obstack_init (&dired_obstack);
1259 obstack_init (&subdired_obstack);
1263 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1273 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1275 queue_directory (".", NULL, true);
1279 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1285 if (!immediate_dirs)
1286 extract_dirs_from_files (NULL, true);
1287 /* `cwd_n_used' might be zero now. */
1290 /* In the following if/else blocks, it is sufficient to test `pending_dirs'
1291 (and not pending_dirs->name) because there may be no markers in the queue
1292 at this point. A marker may be enqueued when extract_dirs_from_files is
1293 called with a non-empty string or via print_dir. */
1296 print_current_files ();
1298 DIRED_PUTCHAR ('\n');
1300 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1301 print_dir_name = false;
1303 while (pending_dirs)
1305 thispend = pending_dirs;
1306 pending_dirs = pending_dirs->next;
1310 if (thispend->name == NULL)
1312 /* thispend->name == NULL means this is a marker entry
1313 indicating we've finished processing the directory.
1314 Use its dev/ino numbers to remove the corresponding
1315 entry from the active_dir_set hash table. */
1316 struct dev_ino di = dev_ino_pop ();
1317 struct dev_ino *found = hash_delete (active_dir_set, &di);
1318 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1320 dev_ino_free (found);
1321 free_pending_ent (thispend);
1326 print_dir (thispend->name, thispend->realname,
1327 thispend->command_line_arg);
1329 free_pending_ent (thispend);
1330 print_dir_name = true;
1333 if (print_with_color)
1338 restore_default_color ();
1341 /* Restore the default signal handling. */
1343 for (j = 0; j < nsigs; j++)
1344 if (sigismember (&caught_signals, sig[j]))
1345 signal (sig[j], SIG_DFL);
1347 for (j = 0; j < nsigs; j++)
1349 signal (sig[j], SIG_DFL);
1352 /* Act on any signals that arrived before the default was restored.
1353 This can process signals out of order, but there doesn't seem to
1354 be an easy way to do them in order, and the order isn't that
1355 important anyway. */
1356 for (j = stop_signal_count; j; j--)
1358 j = interrupt_signal;
1365 /* No need to free these since we're about to exit. */
1366 dired_dump_obstack ("//DIRED//", &dired_obstack);
1367 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1368 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1369 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1374 assert (hash_get_n_entries (active_dir_set) == 0);
1375 hash_free (active_dir_set);
1381 /* Set all the option flags according to the switches specified.
1382 Return the index of the first non-option argument. */
1385 decode_switches (int argc, char **argv)
1387 char *time_style_option = NULL;
1389 /* Record whether there is an option specifying sort type. */
1390 bool sort_type_specified = false;
1392 qmark_funny_chars = false;
1394 /* initialize all switches to default settings */
1399 /* This is for the `dir' program. */
1400 format = many_per_line;
1401 set_quoting_style (NULL, escape_quoting_style);
1404 case LS_LONG_FORMAT:
1405 /* This is for the `vdir' program. */
1406 format = long_format;
1407 set_quoting_style (NULL, escape_quoting_style);
1411 /* This is for the `ls' program. */
1412 if (isatty (STDOUT_FILENO))
1414 format = many_per_line;
1415 /* See description of qmark_funny_chars, above. */
1416 qmark_funny_chars = true;
1420 format = one_per_line;
1421 qmark_funny_chars = false;
1429 time_type = time_mtime;
1430 sort_type = sort_name;
1431 sort_reverse = false;
1432 numeric_ids = false;
1433 print_block_size = false;
1434 indicator_style = none;
1435 print_inode = false;
1436 dereference = DEREF_UNDEFINED;
1438 immediate_dirs = false;
1439 ignore_mode = IGNORE_DEFAULT;
1440 ignore_patterns = NULL;
1441 hide_patterns = NULL;
1442 print_scontext = false;
1444 /* FIXME: put this in a function. */
1446 char const *q_style = getenv ("QUOTING_STYLE");
1449 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
1451 set_quoting_style (NULL, quoting_style_vals[i]);
1454 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
1455 quotearg (q_style));
1460 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1461 human_options (ls_block_size,
1462 &human_output_opts, &output_block_size);
1463 if (ls_block_size || getenv ("BLOCK_SIZE"))
1464 file_output_block_size = output_block_size;
1469 char const *p = getenv ("COLUMNS");
1472 unsigned long int tmp_ulong;
1473 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1474 && 0 < tmp_ulong && tmp_ulong <= SIZE_MAX)
1476 line_length = tmp_ulong;
1481 _("ignoring invalid width in environment variable COLUMNS: %s"),
1491 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1492 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1493 line_length = ws.ws_col;
1498 char const *p = getenv ("TABSIZE");
1502 unsigned long int tmp_ulong;
1503 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1504 && tmp_ulong <= SIZE_MAX)
1506 tabsize = tmp_ulong;
1511 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1520 int c = getopt_long (argc, argv,
1521 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1529 ignore_mode = IGNORE_MINIMAL;
1533 set_quoting_style (NULL, escape_quoting_style);
1537 time_type = time_ctime;
1541 immediate_dirs = true;
1545 /* Same as enabling -a -U and disabling -l -s. */
1546 ignore_mode = IGNORE_MINIMAL;
1547 sort_type = sort_none;
1548 sort_type_specified = true;
1550 if (format == long_format)
1551 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1552 print_block_size = false; /* disable -s */
1553 print_with_color = false; /* disable --color */
1556 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1557 indicator_style = file_type;
1561 format = long_format;
1562 print_owner = false;
1566 human_output_opts = human_autoscale | human_SI | human_base_1024;
1567 file_output_block_size = output_block_size = 1;
1575 human_output_opts = 0;
1576 file_output_block_size = output_block_size = 1024;
1580 format = long_format;
1584 format = with_commas;
1589 format = long_format;
1592 case 'o': /* Just like -l, but don't display group info. */
1593 format = long_format;
1594 print_group = false;
1598 indicator_style = slash;
1602 qmark_funny_chars = true;
1606 sort_reverse = true;
1610 print_block_size = true;
1614 sort_type = sort_time;
1615 sort_type_specified = true;
1619 time_type = time_atime;
1623 sort_type = sort_version;
1624 sort_type_specified = true;
1629 unsigned long int tmp_ulong;
1630 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1631 || ! (0 < tmp_ulong && tmp_ulong <= SIZE_MAX))
1632 error (LS_FAILURE, 0, _("invalid line width: %s"),
1634 line_length = tmp_ulong;
1639 format = horizontal;
1643 if (ignore_mode == IGNORE_DEFAULT)
1644 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1648 add_ignore_pattern ("*~");
1649 add_ignore_pattern (".*~");
1653 format = many_per_line;
1661 indicator_style = classify;
1664 case 'G': /* inhibit display of group info */
1665 print_group = false;
1669 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1672 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1673 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1677 add_ignore_pattern (optarg);
1681 dereference = DEREF_ALWAYS;
1685 set_quoting_style (NULL, literal_quoting_style);
1689 set_quoting_style (NULL, c_quoting_style);
1697 sort_type = sort_size;
1698 sort_type_specified = true;
1703 unsigned long int tmp_ulong;
1704 if (xstrtoul (optarg, NULL, 0, &tmp_ulong, NULL) != LONGINT_OK
1705 || SIZE_MAX < tmp_ulong)
1706 error (LS_FAILURE, 0, _("invalid tab size: %s"),
1708 tabsize = tmp_ulong;
1713 sort_type = sort_none;
1714 sort_type_specified = true;
1718 sort_type = sort_extension;
1719 sort_type_specified = true;
1723 /* -1 has no effect after -l. */
1724 if (format != long_format)
1725 format = one_per_line;
1729 print_author = true;
1734 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1735 hide->pattern = optarg;
1736 hide->next = hide_patterns;
1737 hide_patterns = hide;
1742 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1743 sort_type_specified = true;
1746 case GROUP_DIRECTORIES_FIRST_OPTION:
1747 directories_first = true;
1751 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1755 format = XARGMATCH ("--format", optarg, format_args, format_types);
1758 case FULL_TIME_OPTION:
1759 format = long_format;
1760 time_style_option = "full-iso";
1767 i = XARGMATCH ("--color", optarg, color_args, color_types);
1769 /* Using --color with no argument is equivalent to using
1773 print_with_color = (i == color_always
1774 || (i == color_if_tty
1775 && isatty (STDOUT_FILENO)));
1777 if (print_with_color)
1779 /* Don't use TAB characters in output. Some terminal
1780 emulators can't handle the combination of tabs and
1781 color codes on the same line. */
1787 case INDICATOR_STYLE_OPTION:
1788 indicator_style = XARGMATCH ("--indicator-style", optarg,
1789 indicator_style_args,
1790 indicator_style_types);
1793 case QUOTING_STYLE_OPTION:
1794 set_quoting_style (NULL,
1795 XARGMATCH ("--quoting-style", optarg,
1797 quoting_style_vals));
1800 case TIME_STYLE_OPTION:
1801 time_style_option = optarg;
1804 case SHOW_CONTROL_CHARS_OPTION:
1805 qmark_funny_chars = false;
1808 case BLOCK_SIZE_OPTION:
1810 enum strtol_error e = human_options (optarg, &human_output_opts,
1811 &output_block_size);
1812 if (e != LONGINT_OK)
1813 xstrtol_fatal (e, oi, 0, long_options, optarg);
1814 file_output_block_size = output_block_size;
1819 human_output_opts = human_autoscale | human_SI;
1820 file_output_block_size = output_block_size = 1;
1824 print_scontext = true;
1827 case_GETOPT_HELP_CHAR;
1829 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1836 max_idx = MAX (1, line_length / MIN_COLUMN_WIDTH);
1838 filename_quoting_options = clone_quoting_options (NULL);
1839 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1840 set_char_quoting (filename_quoting_options, ' ', 1);
1841 if (file_type <= indicator_style)
1844 for (p = "*=>@|" + indicator_style - file_type; *p; p++)
1845 set_char_quoting (filename_quoting_options, *p, 1);
1848 dirname_quoting_options = clone_quoting_options (NULL);
1849 set_char_quoting (dirname_quoting_options, ':', 1);
1851 /* --dired is meaningful only with --format=long (-l).
1852 Otherwise, ignore it. FIXME: warn about this?
1853 Alternatively, make --dired imply --format=long? */
1854 if (dired && format != long_format)
1857 /* If -c or -u is specified and not -l (or any other option that implies -l),
1858 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
1859 The behavior of ls when using either -c or -u but with neither -l nor -t
1860 appears to be unspecified by POSIX. So, with GNU ls, `-u' alone means
1861 sort by atime (this is the one that's not specified by the POSIX spec),
1862 -lu means show atime and sort by name, -lut means show atime and sort
1865 if ((time_type == time_ctime || time_type == time_atime)
1866 && !sort_type_specified && format != long_format)
1868 sort_type = sort_time;
1871 if (format == long_format)
1873 char *style = time_style_option;
1874 static char const posix_prefix[] = "posix-";
1877 if (! (style = getenv ("TIME_STYLE")))
1880 while (strncmp (style, posix_prefix, sizeof posix_prefix - 1) == 0)
1882 if (! hard_locale (LC_TIME))
1884 style += sizeof posix_prefix - 1;
1889 char *p0 = style + 1;
1890 char *p1 = strchr (p0, '\n');
1895 if (strchr (p1 + 1, '\n'))
1896 error (LS_FAILURE, 0, _("invalid time style format %s"),
1900 long_time_format[0] = p0;
1901 long_time_format[1] = p1;
1904 switch (XARGMATCH ("time style", style,
1908 case full_iso_time_style:
1909 long_time_format[0] = long_time_format[1] =
1910 "%Y-%m-%d %H:%M:%S.%N %z";
1913 case long_iso_time_style:
1914 case_long_iso_time_style:
1915 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
1918 case iso_time_style:
1919 long_time_format[0] = "%Y-%m-%d ";
1920 long_time_format[1] = "%m-%d %H:%M";
1923 case locale_time_style:
1924 if (hard_locale (LC_TIME))
1926 /* Ensure that the locale has translations for both
1927 formats. If not, fall back on long-iso format. */
1929 for (i = 0; i < 2; i++)
1931 char const *locale_format =
1932 dcgettext (NULL, long_time_format[i], LC_TIME);
1933 if (locale_format == long_time_format[i])
1934 goto case_long_iso_time_style;
1935 long_time_format[i] = locale_format;
1944 /* Parse a string as part of the LS_COLORS variable; this may involve
1945 decoding all kinds of escape characters. If equals_end is set an
1946 unescaped equal sign ends the string, otherwise only a : or \0
1947 does. Set *OUTPUT_COUNT to the number of bytes output. Return
1950 The resulting string is *not* null-terminated, but may contain
1953 Note that both dest and src are char **; on return they point to
1954 the first free byte after the array and the character that ended
1955 the input string, respectively. */
1958 get_funky_string (char **dest, const char **src, bool equals_end,
1959 size_t *output_count)
1961 char num; /* For numerical codes */
1962 size_t count; /* Something to count with */
1964 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
1969 p = *src; /* We don't want to double-indirect */
1970 q = *dest; /* the whole darn time. */
1972 count = 0; /* No characters counted in yet. */
1975 state = ST_GND; /* Start in ground state. */
1976 while (state < ST_END)
1980 case ST_GND: /* Ground state (no escapes) */
1985 state = ST_END; /* End of string */
1988 state = ST_BACKSLASH; /* Backslash scape sequence */
1992 state = ST_CARET; /* Caret escape */
1998 state = ST_END; /* End */
2001 /* else fall through */
2009 case ST_BACKSLASH: /* Backslash escaped character */
2020 state = ST_OCTAL; /* Octal sequence */
2025 state = ST_HEX; /* Hex sequence */
2028 case 'a': /* Bell */
2031 case 'b': /* Backspace */
2034 case 'e': /* Escape */
2037 case 'f': /* Form feed */
2040 case 'n': /* Newline */
2043 case 'r': /* Carriage return */
2049 case 'v': /* Vtab */
2052 case '?': /* Delete */
2055 case '_': /* Space */
2058 case '\0': /* End of string */
2059 state = ST_ERROR; /* Error! */
2061 default: /* Escaped character like \ ^ : = */
2065 if (state == ST_BACKSLASH)
2074 case ST_OCTAL: /* Octal sequence */
2075 if (*p < '0' || *p > '7')
2082 num = (num << 3) + (*(p++) - '0');
2085 case ST_HEX: /* Hex sequence */
2098 num = (num << 4) + (*(p++) - '0');
2106 num = (num << 4) + (*(p++) - 'a') + 10;
2114 num = (num << 4) + (*(p++) - 'A') + 10;
2124 case ST_CARET: /* Caret escape */
2125 state = ST_GND; /* Should be the next state... */
2126 if (*p >= '@' && *p <= '~')
2128 *(q++) = *(p++) & 037;
2147 *output_count = count;
2149 return state != ST_ERROR;
2153 parse_ls_color (void)
2155 const char *p; /* Pointer to character being parsed */
2156 char *buf; /* color_buf buffer pointer */
2157 int state; /* State of parser */
2158 int ind_no; /* Indicator number */
2159 char label[3]; /* Indicator label */
2160 struct color_ext_type *ext; /* Extension we are working on */
2162 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2166 strcpy (label, "??");
2168 /* This is an overly conservative estimate, but any possible
2169 LS_COLORS string will *not* generate a color_buf longer than
2170 itself, so it is a safe way of allocating a buffer in
2172 buf = color_buf = xstrdup (p);
2179 case 1: /* First label character */
2187 /* Allocate new extension block and add to head of
2188 linked list (this way a later definition will
2189 override an earlier one, which can be useful for
2190 having terminal-specific defs override global). */
2192 ext = xmalloc (sizeof *ext);
2193 ext->next = color_ext_list;
2194 color_ext_list = ext;
2197 ext->ext.string = buf;
2199 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2204 state = 0; /* Done! */
2207 default: /* Assume it is file type label */
2214 case 2: /* Second label character */
2221 state = -1; /* Error */
2224 case 3: /* Equal sign after indicator label */
2225 state = -1; /* Assume failure... */
2226 if (*(p++) == '=')/* It *should* be... */
2228 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2230 if (STREQ (label, indicator_name[ind_no]))
2232 color_indicator[ind_no].string = buf;
2233 state = (get_funky_string (&buf, &p, false,
2234 &color_indicator[ind_no].len)
2240 error (0, 0, _("unrecognized prefix: %s"), quotearg (label));
2244 case 4: /* Equal sign after *.ext */
2247 ext->seq.string = buf;
2248 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2259 struct color_ext_type *e;
2260 struct color_ext_type *e2;
2263 _("unparsable value for LS_COLORS environment variable"));
2265 for (e = color_ext_list; e != NULL; /* empty */)
2271 print_with_color = false;
2274 if (color_indicator[C_LINK].len == 6
2275 && !strncmp (color_indicator[C_LINK].string, "target", 6))
2276 color_symlink_as_referent = true;
2279 /* Set the exit status to report a failure. If SERIOUS, it is a
2280 serious failure; otherwise, it is merely a minor problem. */
2283 set_exit_status (bool serious)
2286 exit_status = LS_FAILURE;
2287 else if (exit_status == EXIT_SUCCESS)
2288 exit_status = LS_MINOR_PROBLEM;
2291 /* Assuming a failure is serious if SERIOUS, use the printf-style
2292 MESSAGE to report the failure to access a file named FILE. Assume
2293 errno is set appropriately for the failure. */
2296 file_failure (bool serious, char const *message, char const *file)
2298 error (0, errno, message, quotearg_colon (file));
2299 set_exit_status (serious);
2302 /* Request that the directory named NAME have its contents listed later.
2303 If REALNAME is nonzero, it will be used instead of NAME when the
2304 directory name is printed. This allows symbolic links to directories
2305 to be treated as regular directories but still be listed under their
2306 real names. NAME == NULL is used to insert a marker entry for the
2307 directory named in REALNAME.
2308 If NAME is non-NULL, we use its dev/ino information to save
2309 a call to stat -- when doing a recursive (-R) traversal.
2310 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2313 queue_directory (char const *name, char const *realname, bool command_line_arg)
2315 struct pending *new = xmalloc (sizeof *new);
2316 new->realname = realname ? xstrdup (realname) : NULL;
2317 new->name = name ? xstrdup (name) : NULL;
2318 new->command_line_arg = command_line_arg;
2319 new->next = pending_dirs;
2323 /* Read directory NAME, and list the files in it.
2324 If REALNAME is nonzero, print its name instead of NAME;
2325 this is used for symbolic links to directories.
2326 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2329 print_dir (char const *name, char const *realname, bool command_line_arg)
2332 struct dirent *next;
2333 uintmax_t total_blocks = 0;
2334 static bool first = true;
2337 dirp = opendir (name);
2340 file_failure (command_line_arg, _("cannot open directory %s"), name);
2346 struct stat dir_stat;
2347 int fd = dirfd (dirp);
2349 /* If dirfd failed, endure the overhead of using stat. */
2351 ? fstat (fd, &dir_stat)
2352 : stat (name, &dir_stat)) < 0)
2354 file_failure (command_line_arg,
2355 _("cannot determine device and inode of %s"), name);
2360 /* If we've already visited this dev/inode pair, warn that
2361 we've found a loop, and do not process this directory. */
2362 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2364 error (0, 0, _("%s: not listing already-listed directory"),
2365 quotearg_colon (name));
2370 DEV_INO_PUSH (dir_stat.st_dev, dir_stat.st_ino);
2373 /* Read the directory entries, and insert the subfiles into the `cwd_file'
2380 /* Set errno to zero so we can distinguish between a readdir failure
2381 and when readdir simply finds that there are no more entries. */
2383 next = readdir (dirp);
2386 if (! file_ignored (next->d_name))
2388 enum filetype type = unknown;
2390 #if HAVE_STRUCT_DIRENT_D_TYPE
2391 switch (next->d_type)
2393 case DT_BLK: type = blockdev; break;
2394 case DT_CHR: type = chardev; break;
2395 case DT_DIR: type = directory; break;
2396 case DT_FIFO: type = fifo; break;
2397 case DT_LNK: type = symbolic_link; break;
2398 case DT_REG: type = normal; break;
2399 case DT_SOCK: type = sock; break;
2401 case DT_WHT: type = whiteout; break;
2405 total_blocks += gobble_file (next->d_name, type, D_INO (next),
2409 else if (errno != 0)
2411 file_failure (command_line_arg, _("reading directory %s"), name);
2412 if (errno != EOVERFLOW)
2419 if (closedir (dirp) != 0)
2421 file_failure (command_line_arg, _("closing directory %s"), name);
2422 /* Don't return; print whatever we got. */
2425 /* Sort the directory contents. */
2428 /* If any member files are subdirectories, perhaps they should have their
2429 contents listed rather than being mentioned here as files. */
2432 extract_dirs_from_files (name, command_line_arg);
2434 if (recursive | print_dir_name)
2437 DIRED_PUTCHAR ('\n');
2440 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2441 dired_pos += quote_name (stdout, realname ? realname : name,
2442 dirname_quoting_options, NULL);
2443 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2444 DIRED_FPUTS_LITERAL (":\n", stdout);
2447 if (format == long_format || print_block_size)
2450 char buf[LONGEST_HUMAN_READABLE + 1];
2454 DIRED_FPUTS (p, stdout, strlen (p));
2455 DIRED_PUTCHAR (' ');
2456 p = human_readable (total_blocks, buf, human_output_opts,
2457 ST_NBLOCKSIZE, output_block_size);
2458 DIRED_FPUTS (p, stdout, strlen (p));
2459 DIRED_PUTCHAR ('\n');
2463 print_current_files ();
2466 /* Add `pattern' to the list of patterns for which files that match are
2470 add_ignore_pattern (const char *pattern)
2472 struct ignore_pattern *ignore;
2474 ignore = xmalloc (sizeof *ignore);
2475 ignore->pattern = pattern;
2476 /* Add it to the head of the linked list. */
2477 ignore->next = ignore_patterns;
2478 ignore_patterns = ignore;
2481 /* Return true if one of the PATTERNS matches FILE. */
2484 patterns_match (struct ignore_pattern const *patterns, char const *file)
2486 struct ignore_pattern const *p;
2487 for (p = patterns; p; p = p->next)
2488 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2493 /* Return true if FILE should be ignored. */
2496 file_ignored (char const *name)
2498 return ((ignore_mode != IGNORE_MINIMAL
2500 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2501 || (ignore_mode == IGNORE_DEFAULT
2502 && patterns_match (hide_patterns, name))
2503 || patterns_match (ignore_patterns, name));
2506 /* POSIX requires that a file size be printed without a sign, even
2507 when negative. Assume the typical case where negative sizes are
2508 actually positive values that have wrapped around. */
2511 unsigned_file_size (off_t size)
2513 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2516 /* Enter and remove entries in the table `cwd_file'. */
2518 /* Empty the table of files. */
2525 for (i = 0; i < cwd_n_used; i++)
2527 struct fileinfo *f = sorted_file[i];
2530 if (f->scontext != UNKNOWN_SECURITY_CONTEXT)
2531 freecon (f->scontext);
2535 any_has_acl = false;
2536 inode_number_width = 0;
2537 block_size_width = 0;
2543 major_device_number_width = 0;
2544 minor_device_number_width = 0;
2545 file_size_width = 0;
2548 /* Add a file to the current table of files.
2549 Verify that the file exists, and print an error message if it does not.
2550 Return the number of blocks that the file occupies. */
2553 gobble_file (char const *name, enum filetype type, ino_t inode,
2554 bool command_line_arg, char const *dirname)
2556 uintmax_t blocks = 0;
2559 /* An inode value prior to gobble_file necessarily came from readdir,
2560 which is not used for command line arguments. */
2561 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2563 if (cwd_n_used == cwd_n_alloc)
2565 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
2569 f = &cwd_file[cwd_n_used];
2570 memset (f, '\0', sizeof *f);
2571 f->stat.st_ino = inode;
2574 if (command_line_arg
2575 || format_needs_stat
2576 /* When coloring a directory (we may know the type from
2577 direct.d_type), we have to stat it in order to indicate
2578 sticky and/or other-writable attributes. */
2579 || (type == directory && print_with_color)
2580 /* When dereferencing symlinks, the inode and type must come from
2581 stat, but readdir provides the inode and type of lstat. */
2582 || ((print_inode || format_needs_type)
2583 && (type == symbolic_link || type == unknown)
2584 && (dereference == DEREF_ALWAYS
2585 || (command_line_arg && dereference != DEREF_NEVER)
2586 || color_symlink_as_referent || check_symlink_color))
2587 /* Command line dereferences are already taken care of by the above
2588 assertion that the inode number is not yet known. */
2589 || (print_inode && inode == NOT_AN_INODE_NUMBER)
2590 || (format_needs_type
2591 && (type == unknown || command_line_arg
2592 /* --indicator-style=classify (aka -F)
2593 requires that we stat each regular file
2594 to see if it's executable. */
2595 || (type == normal && (indicator_style == classify
2596 /* This is so that --color ends up
2597 highlighting files with the executable
2598 bit set even when options like -F are
2600 || (print_with_color
2601 && is_colored (C_EXEC))
2605 /* Absolute name of this file. */
2606 char *absolute_name;
2610 if (name[0] == '/' || dirname[0] == 0)
2611 absolute_name = (char *) name;
2614 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
2615 attach (absolute_name, dirname, name);
2618 switch (dereference)
2621 err = stat (absolute_name, &f->stat);
2625 case DEREF_COMMAND_LINE_ARGUMENTS:
2626 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
2627 if (command_line_arg)
2630 err = stat (absolute_name, &f->stat);
2633 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
2636 need_lstat = (err < 0
2638 : ! S_ISDIR (f->stat.st_mode));
2642 /* stat failed because of ENOENT, maybe indicating a dangling
2643 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
2644 directory, and --dereference-command-line-symlink-to-dir is
2645 in effect. Fall through so that we call lstat instead. */
2648 default: /* DEREF_NEVER */
2649 err = lstat (absolute_name, &f->stat);
2656 /* Failure to stat a command line argument leads to
2657 an exit status of 2. For other files, stat failure
2658 provokes an exit status of 1. */
2659 file_failure (command_line_arg,
2660 _("cannot access %s"), absolute_name);
2661 if (command_line_arg)
2664 f->name = xstrdup (name);
2672 if (format == long_format || print_scontext)
2674 bool have_acl = false;
2675 int attr_len = (do_deref
2676 ? getfilecon (absolute_name, &f->scontext)
2677 : lgetfilecon (absolute_name, &f->scontext));
2678 err = (attr_len < 0);
2680 /* Contrary to its documented API, getfilecon may return 0,
2681 yet set f->scontext to NULL (on at least Debian's libselinux1
2682 2.0.15-2+b1), so work around that bug.
2683 FIXME: remove this work-around in 2011, or whenever affected
2684 versions of libselinux are long gone. */
2688 f->scontext = xstrdup ("unlabeled");
2692 have_acl = ! STREQ ("unlabeled", f->scontext);
2695 f->scontext = UNKNOWN_SECURITY_CONTEXT;
2697 /* When requesting security context information, don't make
2698 ls fail just because the file (even a command line argument)
2699 isn't on the right type of file system. I.e., a getfilecon
2700 failure isn't in the same class as a stat failure. */
2701 if (errno == ENOTSUP || errno == ENODATA)
2705 if (err == 0 && ! have_acl && format == long_format)
2707 int n = file_has_acl (absolute_name, &f->stat);
2712 f->have_acl = have_acl;
2713 any_has_acl |= have_acl;
2716 error (0, errno, "%s", quotearg_colon (absolute_name));
2719 if (S_ISLNK (f->stat.st_mode)
2720 && (format == long_format || check_symlink_color))
2723 struct stat linkstats;
2725 get_link_name (absolute_name, f, command_line_arg);
2726 linkname = make_link_name (absolute_name, f->linkname);
2728 /* Avoid following symbolic links when possible, ie, when
2729 they won't be traced and when no indicator is needed. */
2731 && (file_type <= indicator_style || check_symlink_color)
2732 && stat (linkname, &linkstats) == 0)
2736 /* Symbolic links to directories that are mentioned on the
2737 command line are automatically traced if not being
2739 if (!command_line_arg || format == long_format
2740 || !S_ISDIR (linkstats.st_mode))
2742 /* Get the linked-to file's mode for the filetype indicator
2743 in long listings. */
2744 f->linkmode = linkstats.st_mode;
2750 /* When not distinguishing types of symlinks, pretend we know that
2751 it is stat'able, so that it will be colored as a regular symlink,
2752 and not as an orphan. */
2753 if (S_ISLNK (f->stat.st_mode) && !check_symlink_color)
2756 if (S_ISLNK (f->stat.st_mode))
2757 f->filetype = symbolic_link;
2758 else if (S_ISDIR (f->stat.st_mode))
2760 if (command_line_arg & !immediate_dirs)
2761 f->filetype = arg_directory;
2763 f->filetype = directory;
2766 f->filetype = normal;
2768 blocks = ST_NBLOCKS (f->stat);
2769 if (format == long_format || print_block_size)
2771 char buf[LONGEST_HUMAN_READABLE + 1];
2772 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
2773 ST_NBLOCKSIZE, output_block_size),
2775 if (block_size_width < len)
2776 block_size_width = len;
2779 if (format == long_format)
2783 int len = format_user_width (f->stat.st_uid);
2784 if (owner_width < len)
2790 int len = format_group_width (f->stat.st_gid);
2791 if (group_width < len)
2797 int len = format_user_width (f->stat.st_author);
2798 if (author_width < len)
2805 int len = strlen (f->scontext);
2806 if (scontext_width < len)
2807 scontext_width = len;
2810 if (format == long_format)
2812 char b[INT_BUFSIZE_BOUND (uintmax_t)];
2813 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
2814 if (nlink_width < b_len)
2815 nlink_width = b_len;
2817 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
2819 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2820 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
2821 if (major_device_number_width < len)
2822 major_device_number_width = len;
2823 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
2824 if (minor_device_number_width < len)
2825 minor_device_number_width = len;
2826 len = major_device_number_width + 2 + minor_device_number_width;
2827 if (file_size_width < len)
2828 file_size_width = len;
2832 char buf[LONGEST_HUMAN_READABLE + 1];
2833 uintmax_t size = unsigned_file_size (f->stat.st_size);
2834 int len = mbswidth (human_readable (size, buf, human_output_opts,
2835 1, file_output_block_size),
2837 if (file_size_width < len)
2838 file_size_width = len;
2845 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
2846 int len = strlen (umaxtostr (f->stat.st_ino, buf));
2847 if (inode_number_width < len)
2848 inode_number_width = len;
2851 f->name = xstrdup (name);
2857 /* Return true if F refers to a directory. */
2859 is_directory (const struct fileinfo *f)
2861 return f->filetype == directory || f->filetype == arg_directory;
2864 /* Put the name of the file that FILENAME is a symbolic link to
2865 into the LINKNAME field of `f'. COMMAND_LINE_ARG indicates whether
2866 FILENAME is a command-line argument. */
2869 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
2871 f->linkname = areadlink_with_size (filename, f->stat.st_size);
2872 if (f->linkname == NULL)
2873 file_failure (command_line_arg, _("cannot read symbolic link %s"),
2877 /* If `linkname' is a relative name and `name' contains one or more
2878 leading directories, return `linkname' with those directories
2879 prepended; otherwise, return a copy of `linkname'.
2880 If `linkname' is zero, return zero. */
2883 make_link_name (char const *name, char const *linkname)
2891 if (*linkname == '/')
2892 return xstrdup (linkname);
2894 /* The link is to a relative name. Prepend any leading directory
2895 in `name' to the link name. */
2896 linkbuf = strrchr (name, '/');
2898 return xstrdup (linkname);
2900 bufsiz = linkbuf - name + 1;
2901 linkbuf = xmalloc (bufsiz + strlen (linkname) + 1);
2902 strncpy (linkbuf, name, bufsiz);
2903 strcpy (linkbuf + bufsiz, linkname);
2907 /* Return true if the last component of NAME is `.' or `..'
2908 This is so we don't try to recurse on `././././. ...' */
2911 basename_is_dot_or_dotdot (const char *name)
2913 char const *base = last_component (name);
2914 return dot_or_dotdot (base);
2917 /* Remove any entries from CWD_FILE that are for directories,
2918 and queue them to be listed as directories instead.
2919 DIRNAME is the prefix to prepend to each dirname
2920 to make it correct relative to ls's working dir;
2921 if it is null, no prefix is needed and "." and ".." should not be ignored.
2922 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
2923 This is desirable when processing directories recursively. */
2926 extract_dirs_from_files (char const *dirname, bool command_line_arg)
2930 bool ignore_dot_and_dot_dot = (dirname != NULL);
2932 if (dirname && LOOP_DETECT)
2934 /* Insert a marker entry first. When we dequeue this marker entry,
2935 we'll know that DIRNAME has been processed and may be removed
2936 from the set of active directories. */
2937 queue_directory (NULL, dirname, false);
2940 /* Queue the directories last one first, because queueing reverses the
2942 for (i = cwd_n_used; i-- != 0; )
2944 struct fileinfo *f = sorted_file[i];
2946 if (is_directory (f)
2947 && (! ignore_dot_and_dot_dot
2948 || ! basename_is_dot_or_dotdot (f->name)))
2950 if (!dirname || f->name[0] == '/')
2951 queue_directory (f->name, f->linkname, command_line_arg);
2954 char *name = file_name_concat (dirname, f->name, NULL);
2955 queue_directory (name, f->linkname, command_line_arg);
2958 if (f->filetype == arg_directory)
2963 /* Now delete the directories from the table, compacting all the remaining
2966 for (i = 0, j = 0; i < cwd_n_used; i++)
2968 struct fileinfo *f = sorted_file[i];
2970 j += (f->filetype != arg_directory);
2975 /* Use strcoll to compare strings in this locale. If an error occurs,
2976 report an error and longjmp to failed_strcoll. */
2978 static jmp_buf failed_strcoll;
2981 xstrcoll (char const *a, char const *b)
2985 diff = strcoll (a, b);
2988 error (0, errno, _("cannot compare file names %s and %s"),
2989 quote_n (0, a), quote_n (1, b));
2990 set_exit_status (false);
2991 longjmp (failed_strcoll, 1);
2996 /* Comparison routines for sorting the files. */
2998 typedef void const *V;
2999 typedef int (*qsortFunc)(V a, V b);
3001 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
3002 The do { ... } while(0) makes it possible to use the macro more like
3003 a statement, without violating C89 rules: */
3004 #define DIRFIRST_CHECK(a, b) \
3007 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
3008 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
3009 if (a_is_dir && !b_is_dir) \
3010 return -1; /* a goes before b */ \
3011 if (!a_is_dir && b_is_dir) \
3012 return 1; /* b goes before a */ \
3016 /* Define the 8 different sort function variants required for each sortkey.
3017 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
3018 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
3019 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
3020 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
3021 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
3022 /* direct, non-dirfirst versions */ \
3023 static int xstrcoll_##key_name (V a, V b) \
3024 { return key_cmp_func (a, b, xstrcoll); } \
3025 static int strcmp_##key_name (V a, V b) \
3026 { return key_cmp_func (a, b, strcmp); } \
3028 /* reverse, non-dirfirst versions */ \
3029 static int rev_xstrcoll_##key_name (V a, V b) \
3030 { return key_cmp_func (b, a, xstrcoll); } \
3031 static int rev_strcmp_##key_name (V a, V b) \
3032 { return key_cmp_func (b, a, strcmp); } \
3034 /* direct, dirfirst versions */ \
3035 static int xstrcoll_df_##key_name (V a, V b) \
3036 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
3037 static int strcmp_df_##key_name (V a, V b) \
3038 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
3040 /* reverse, dirfirst versions */ \
3041 static int rev_xstrcoll_df_##key_name (V a, V b) \
3042 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
3043 static int rev_strcmp_df_##key_name (V a, V b) \
3044 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
3047 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3048 int (*cmp) (char const *, char const *))
3050 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3051 get_stat_ctime (&a->stat));
3052 return diff ? diff : cmp (a->name, b->name);
3056 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3057 int (*cmp) (char const *, char const *))
3059 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3060 get_stat_mtime (&a->stat));
3061 return diff ? diff : cmp (a->name, b->name);
3065 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3066 int (*cmp) (char const *, char const *))
3068 int diff = timespec_cmp (get_stat_atime (&b->stat),
3069 get_stat_atime (&a->stat));
3070 return diff ? diff : cmp (a->name, b->name);
3074 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3075 int (*cmp) (char const *, char const *))
3077 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3078 return diff ? diff : cmp (a->name, b->name);
3082 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3083 int (*cmp) (char const *, char const *))
3085 return cmp (a->name, b->name);
3088 /* Compare file extensions. Files with no extension are `smallest'.
3089 If extensions are the same, compare by filenames instead. */
3092 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3093 int (*cmp) (char const *, char const *))
3095 char const *base1 = strrchr (a->name, '.');
3096 char const *base2 = strrchr (b->name, '.');
3097 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3098 return diff ? diff : cmp (a->name, b->name);
3101 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3102 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3103 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3104 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3105 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3106 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3108 /* Compare file versions.
3109 Unlike all other compare functions above, cmp_version depends only
3110 on strverscmp, which does not fail (even for locale reasons), and does not
3111 need a secondary sort key.
3112 All the other sort options, in fact, need xstrcoll and strcmp variants,
3113 because they all use a string comparison (either as the primary or secondary
3114 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3115 locale reasons. Last, strverscmp is ALWAYS available in coreutils,
3116 thanks to the gnulib library. */
3118 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3120 return strverscmp (a->name, b->name);
3123 static int xstrcoll_version (V a, V b)
3124 { return cmp_version (a, b); }
3125 static int rev_xstrcoll_version (V a, V b)
3126 { return cmp_version (b, a); }
3127 static int xstrcoll_df_version (V a, V b)
3128 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3129 static int rev_xstrcoll_df_version (V a, V b)
3130 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3133 /* We have 2^3 different variants for each sortkey function
3134 (for 3 independent sort modes).
3135 The function pointers stored in this array must be dereferenced as:
3137 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3139 Note that the order in which sortkeys are listed in the function pointer
3140 array below is defined by the order of the elements in the time_type and
3143 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3146 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3147 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3150 { strcmp_##key_name, strcmp_df_##key_name }, \
3151 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3155 static qsortFunc sort_functions[][2][2][2] =
3157 LIST_SORTFUNCTION_VARIANTS (name),
3158 LIST_SORTFUNCTION_VARIANTS (extension),
3159 LIST_SORTFUNCTION_VARIANTS (size),
3163 { xstrcoll_version, xstrcoll_df_version },
3164 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3167 /* We use NULL for the strcmp variants of version comparison
3168 since as explained in cmp_version definition, version comparison
3169 does not rely on xstrcoll, so it will never longjmp, and never
3170 need to try the strcmp fallback. */
3177 /* last are time sort functions */
3178 LIST_SORTFUNCTION_VARIANTS (mtime),
3179 LIST_SORTFUNCTION_VARIANTS (ctime),
3180 LIST_SORTFUNCTION_VARIANTS (atime)
3183 /* The number of sortkeys is calculated as
3184 the number of elements in the sort_type enum (i.e. sort_numtypes) +
3185 the number of elements in the time_type enum (i.e. time_numtypes) - 1
3186 This is because when sort_type==sort_time, we have up to
3187 time_numtypes possible sortkeys.
3189 This line verifies at compile-time that the array of sort functions has been
3190 initialized for all possible sortkeys. */
3191 verify (ARRAY_CARDINALITY (sort_functions)
3192 == sort_numtypes + time_numtypes - 1 );
3194 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
3197 initialize_ordering_vector (void)
3200 for (i = 0; i < cwd_n_used; i++)
3201 sorted_file[i] = &cwd_file[i];
3204 /* Sort the files now in the table. */
3211 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
3214 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
3215 sorted_file_alloc = 3 * cwd_n_used;
3218 initialize_ordering_vector ();
3220 if (sort_type == sort_none)
3223 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3224 ignore strcoll failures, as a failing strcoll might be a
3225 comparison function that is not a total order, and if we ignored
3226 the failure this might cause qsort to dump core. */
3228 if (! setjmp (failed_strcoll))
3229 use_strcmp = false; /* strcoll() succeeded */
3233 assert (sort_type != sort_version);
3234 initialize_ordering_vector ();
3237 /* When sort_type == sort_time, use time_type as subindex. */
3238 mpsort ((void const **) sorted_file, cwd_n_used,
3239 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
3240 [use_strcmp][sort_reverse]
3241 [directories_first]);
3244 /* List all the files now in the table. */
3247 print_current_files (void)
3254 for (i = 0; i < cwd_n_used; i++)
3256 print_file_name_and_frills (sorted_file[i]);
3262 print_many_per_line ();
3266 print_horizontal ();
3270 print_with_commas ();
3274 for (i = 0; i < cwd_n_used; i++)
3276 print_long_format (sorted_file[i]);
3277 DIRED_PUTCHAR ('\n');
3283 /* Return the expected number of columns in a long-format time stamp,
3284 or zero if it cannot be calculated. */
3287 long_time_expected_width (void)
3289 static int width = -1;
3294 struct tm const *tm = localtime (&epoch);
3295 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3297 /* In case you're wondering if localtime can fail with an input time_t
3298 value of 0, let's just say it's very unlikely, but not inconceivable.
3299 The TZ environment variable would have to specify a time zone that
3300 is 2**31-1900 years or more ahead of UTC. This could happen only on
3301 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3302 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3303 their implementations limit the offset to 167:59 and 24:00, resp. */
3307 nstrftime (buf, sizeof buf, long_time_format[0], tm, 0, 0);
3309 width = mbsnwidth (buf, len, 0);
3319 /* Print the user or group name NAME, with numeric id ID, using a
3320 print width of WIDTH columns. */
3323 format_user_or_group (char const *name, unsigned long int id, int width)
3329 int width_gap = width - mbswidth (name, 0);
3330 int pad = MAX (0, width_gap);
3331 fputs (name, stdout);
3332 len = strlen (name) + pad;
3340 printf ("%*lu ", width, id);
3344 dired_pos += len + 1;
3347 /* Print the name or id of the user with id U, using a print width of
3351 format_user (uid_t u, int width, bool stat_ok)
3353 format_user_or_group (! stat_ok ? "?" :
3354 (numeric_ids ? NULL : getuser (u)), u, width);
3357 /* Likewise, for groups. */
3360 format_group (gid_t g, int width, bool stat_ok)
3362 format_user_or_group (! stat_ok ? "?" :
3363 (numeric_ids ? NULL : getgroup (g)), g, width);
3366 /* Return the number of columns that format_user_or_group will print. */
3369 format_user_or_group_width (char const *name, unsigned long int id)
3373 int len = mbswidth (name, 0);
3374 return MAX (0, len);
3378 char buf[INT_BUFSIZE_BOUND (unsigned long int)];
3379 sprintf (buf, "%lu", id);
3380 return strlen (buf);
3384 /* Return the number of columns that format_user will print. */
3387 format_user_width (uid_t u)
3389 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3392 /* Likewise, for groups. */
3395 format_group_width (gid_t g)
3397 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3401 /* Print information about F in long format. */
3404 print_long_format (const struct fileinfo *f)
3408 [LONGEST_HUMAN_READABLE + 1 /* inode */
3409 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3410 + sizeof (modebuf) - 1 + 1 /* mode string */
3411 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3412 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3413 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3414 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3418 struct timespec when_timespec;
3419 struct tm *when_local;
3421 /* Compute the mode string, except remove the trailing space if no
3422 file in this directory has an ACL or SELinux security context. */
3424 filemodestring (&f->stat, modebuf);
3427 modebuf[0] = filetype_letter[f->filetype];
3428 memset (modebuf + 1, '?', 10);
3433 else if (f->have_acl)
3439 when_timespec = get_stat_ctime (&f->stat);
3442 when_timespec = get_stat_mtime (&f->stat);
3445 when_timespec = get_stat_atime (&f->stat);
3455 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3456 sprintf (p, "%*s ", inode_number_width,
3457 (f->stat.st_ino == NOT_AN_INODE_NUMBER
3459 : umaxtostr (f->stat.st_ino, hbuf)));
3460 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3461 The latter is wrong when inode_number_width is zero. */
3465 if (print_block_size)
3467 char hbuf[LONGEST_HUMAN_READABLE + 1];
3468 char const *blocks =
3471 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3472 ST_NBLOCKSIZE, output_block_size));
3474 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3476 while ((*p++ = *blocks++))
3481 /* The last byte of the mode string is the POSIX
3482 "optional alternate access method flag". */
3484 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3485 sprintf (p, "%s %*s ", modebuf, nlink_width,
3486 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3488 /* Increment by strlen (p) here, rather than by, e.g.,
3489 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3490 The latter is wrong when nlink_width is zero. */
3495 if (print_owner | print_group | print_author | print_scontext)
3497 DIRED_FPUTS (buf, stdout, p - buf);
3500 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3503 format_group (f->stat.st_gid, group_width, f->stat_ok);
3506 format_user (f->stat.st_author, author_width, f->stat_ok);
3509 format_user_or_group (f->scontext, 0, scontext_width);
3515 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3517 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3518 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3519 int blanks_width = (file_size_width
3520 - (major_device_number_width + 2
3521 + minor_device_number_width));
3522 sprintf (p, "%*s, %*s ",
3523 major_device_number_width + MAX (0, blanks_width),
3524 umaxtostr (major (f->stat.st_rdev), majorbuf),
3525 minor_device_number_width,
3526 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3527 p += file_size_width + 1;
3531 char hbuf[LONGEST_HUMAN_READABLE + 1];
3535 : human_readable (unsigned_file_size (f->stat.st_size),
3536 hbuf, human_output_opts, 1, file_output_block_size));
3538 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3540 while ((*p++ = *size++))
3545 when_local = localtime (&when_timespec.tv_sec);
3549 if (f->stat_ok && when_local)
3551 struct timespec six_months_ago;
3555 /* If the file appears to be in the future, update the current
3556 time, in case the file happens to have been modified since
3557 the last time we checked the clock. */
3558 if (timespec_cmp (current_time, when_timespec) < 0)
3560 /* Note that gettime may call gettimeofday which, on some non-
3561 compliant systems, clobbers the buffer used for localtime's result.
3562 But it's ok here, because we use a gettimeofday wrapper that
3563 saves and restores the buffer around the gettimeofday call. */
3564 gettime (¤t_time);
3567 /* Consider a time to be recent if it is within the past six
3568 months. A Gregorian year has 365.2425 * 24 * 60 * 60 ==
3569 31556952 seconds on the average. Write this value as an
3570 integer constant to avoid floating point hassles. */
3571 six_months_ago.tv_sec = current_time.tv_sec - 31556952 / 2;
3572 six_months_ago.tv_nsec = current_time.tv_nsec;
3574 recent = (timespec_cmp (six_months_ago, when_timespec) < 0
3575 && (timespec_cmp (when_timespec, current_time) < 0));
3576 fmt = long_time_format[recent];
3578 /* We assume here that all time zones are offset from UTC by a
3579 whole number of seconds. */
3580 s = nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
3581 when_local, 0, when_timespec.tv_nsec);
3589 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
3594 /* The time cannot be converted using the desired format, so
3595 print it as a huge integer number of seconds. */
3596 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
3597 sprintf (p, "%*s ", long_time_expected_width (),
3600 : (TYPE_SIGNED (time_t)
3601 ? imaxtostr (when_timespec.tv_sec, hbuf)
3602 : umaxtostr (when_timespec.tv_sec, hbuf))));
3603 /* FIXME: (maybe) We discarded when_timespec.tv_nsec. */
3607 DIRED_FPUTS (buf, stdout, p - buf);
3608 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3609 f->stat_ok, f->filetype, &dired_obstack);
3611 if (f->filetype == symbolic_link)
3615 DIRED_FPUTS_LITERAL (" -> ", stdout);
3616 print_name_with_quoting (f->linkname, f->linkmode, f->linkok - 1,
3617 f->stat_ok, f->filetype, NULL);
3618 if (indicator_style != none)
3619 print_type_indicator (true, f->linkmode, unknown);
3622 else if (indicator_style != none)
3623 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3626 /* Output to OUT a quoted representation of the file name NAME,
3627 using OPTIONS to control quoting. Produce no output if OUT is NULL.
3628 Store the number of screen columns occupied by NAME's quoted
3629 representation into WIDTH, if non-NULL. Return the number of bytes
3633 quote_name (FILE *out, const char *name, struct quoting_options const *options,
3636 char smallbuf[BUFSIZ];
3637 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
3639 size_t displayed_width IF_LINT (= 0);
3641 if (len < sizeof smallbuf)
3645 buf = alloca (len + 1);
3646 quotearg_buffer (buf, len + 1, name, -1, options);
3649 if (qmark_funny_chars)
3654 char const *p = buf;
3655 char const *plimit = buf + len;
3657 displayed_width = 0;
3662 case ' ': case '!': case '"': case '#': case '%':
3663 case '&': case '\'': case '(': case ')': case '*':
3664 case '+': case ',': case '-': case '.': case '/':
3665 case '0': case '1': case '2': case '3': case '4':
3666 case '5': case '6': case '7': case '8': case '9':
3667 case ':': case ';': case '<': case '=': case '>':
3669 case 'A': case 'B': case 'C': case 'D': case 'E':
3670 case 'F': case 'G': case 'H': case 'I': case 'J':
3671 case 'K': case 'L': case 'M': case 'N': case 'O':
3672 case 'P': case 'Q': case 'R': case 'S': case 'T':
3673 case 'U': case 'V': case 'W': case 'X': case 'Y':
3675 case '[': case '\\': case ']': case '^': case '_':
3676 case 'a': case 'b': case 'c': case 'd': case 'e':
3677 case 'f': case 'g': case 'h': case 'i': case 'j':
3678 case 'k': case 'l': case 'm': case 'n': case 'o':
3679 case 'p': case 'q': case 'r': case 's': case 't':
3680 case 'u': case 'v': case 'w': case 'x': case 'y':
3681 case 'z': case '{': case '|': case '}': case '~':
3682 /* These characters are printable ASCII characters. */
3684 displayed_width += 1;
3687 /* If we have a multibyte sequence, copy it until we
3688 reach its end, replacing each non-printable multibyte
3689 character with a single question mark. */
3691 mbstate_t mbstate = { 0, };
3698 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
3700 if (bytes == (size_t) -1)
3702 /* An invalid multibyte sequence was
3703 encountered. Skip one input byte, and
3704 put a question mark. */
3707 displayed_width += 1;
3711 if (bytes == (size_t) -2)
3713 /* An incomplete multibyte character
3714 at the end. Replace it entirely with
3718 displayed_width += 1;
3723 /* A null wide character was encountered. */
3729 /* A printable multibyte character.
3731 for (; bytes > 0; --bytes)
3733 displayed_width += w;
3737 /* An unprintable multibyte character.
3738 Replace it entirely with a question
3742 displayed_width += 1;
3745 while (! mbsinit (&mbstate));
3750 /* The buffer may have shrunk. */
3757 char const *plimit = buf + len;
3761 if (! isprint (to_uchar (*p)))
3765 displayed_width = len;
3768 else if (width != NULL)
3772 displayed_width = mbsnwidth (buf, len, 0);
3776 char const *p = buf;
3777 char const *plimit = buf + len;
3779 displayed_width = 0;
3782 if (isprint (to_uchar (*p)))
3790 fwrite (buf, 1, len, out);
3792 *width = displayed_width;
3797 print_name_with_quoting (const char *p, mode_t mode, int linkok,
3798 bool stat_ok, enum filetype type,
3799 struct obstack *stack)
3801 bool used_color_this_time
3803 && print_color_indicator (p, mode, linkok, stat_ok, type));
3806 PUSH_CURRENT_DIRED_POS (stack);
3808 dired_pos += quote_name (stdout, p, filename_quoting_options, NULL);
3811 PUSH_CURRENT_DIRED_POS (stack);
3813 if (used_color_this_time)
3816 prep_non_filename_text ();
3821 prep_non_filename_text (void)
3823 if (color_indicator[C_END].string != NULL)
3824 put_indicator (&color_indicator[C_END]);
3827 put_indicator (&color_indicator[C_LEFT]);
3828 put_indicator (&color_indicator[C_RESET]);
3829 put_indicator (&color_indicator[C_RIGHT]);
3833 /* Print the file name of `f' with appropriate quoting.
3834 Also print file size, inode number, and filetype indicator character,
3835 as requested by switches. */
3838 print_file_name_and_frills (const struct fileinfo *f)
3840 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
3843 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
3844 umaxtostr (f->stat.st_ino, buf));
3846 if (print_block_size)
3847 printf ("%*s ", format == with_commas ? 0 : block_size_width,
3848 human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
3849 ST_NBLOCKSIZE, output_block_size));
3852 printf ("%*s ", format == with_commas ? 0 : scontext_width, f->scontext);
3854 print_name_with_quoting (f->name, FILE_OR_LINK_MODE (f), f->linkok,
3855 f->stat_ok, f->filetype, NULL);
3857 if (indicator_style != none)
3858 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
3861 /* Given these arguments describing a file, return the single-byte
3862 type indicator, or 0. */
3864 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3868 if (stat_ok ? S_ISREG (mode) : type == normal)
3870 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
3877 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
3879 else if (indicator_style == slash)
3881 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
3883 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
3885 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
3887 else if (stat_ok && S_ISDOOR (mode))
3896 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
3898 char c = get_type_indicator (stat_ok, mode, type);
3903 /* Returns whether any color sequence was printed. */
3905 print_color_indicator (const char *name, mode_t mode, int linkok,
3906 bool stat_ok, enum filetype filetype)
3909 struct color_ext_type *ext; /* Color extension */
3910 size_t len; /* Length of name */
3912 /* Is this a nonexistent file? If so, linkok == -1. */
3914 if (linkok == -1 && color_indicator[C_MISSING].string != NULL)
3918 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
3919 type = filetype_indicator[filetype];
3926 if ((mode & S_ISUID) != 0)
3928 else if ((mode & S_ISGID) != 0)
3930 else if ((mode & S_IXUGO) != 0)
3933 else if (S_ISDIR (mode))
3935 if ((mode & S_ISVTX) && (mode & S_IWOTH))
3936 type = C_STICKY_OTHER_WRITABLE;
3937 else if ((mode & S_IWOTH) != 0)
3938 type = C_OTHER_WRITABLE;
3939 else if ((mode & S_ISVTX) != 0)
3944 else if (S_ISLNK (mode))
3945 type = ((!linkok && color_indicator[C_ORPHAN].string)
3946 ? C_ORPHAN : C_LINK);
3947 else if (S_ISFIFO (mode))
3949 else if (S_ISSOCK (mode))
3951 else if (S_ISBLK (mode))
3953 else if (S_ISCHR (mode))
3955 else if (S_ISDOOR (mode))
3959 /* Classify a file of some other type as C_ORPHAN. */
3964 /* Check the file's suffix only if still classified as C_FILE. */
3968 /* Test if NAME has a recognized suffix. */
3970 len = strlen (name);
3971 name += len; /* Pointer to final \0. */
3972 for (ext = color_ext_list; ext != NULL; ext = ext->next)
3974 if (ext->ext.len <= len
3975 && strncmp (name - ext->ext.len, ext->ext.string,
3982 const struct bin_str *const s
3983 = ext ? &(ext->seq) : &color_indicator[type];
3984 if (s->string != NULL)
3986 put_indicator (&color_indicator[C_LEFT]);
3988 put_indicator (&color_indicator[C_RIGHT]);
3996 /* Output a color indicator (which may contain nulls). */
3998 put_indicator (const struct bin_str *ind)
4006 prep_non_filename_text ();
4011 for (i = ind->len; i != 0; --i)
4016 length_of_file_name_and_frills (const struct fileinfo *f)
4020 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4023 len += 1 + (format == with_commas
4024 ? strlen (umaxtostr (f->stat.st_ino, buf))
4025 : inode_number_width);
4027 if (print_block_size)
4028 len += 1 + (format == with_commas
4029 ? strlen (human_readable (ST_NBLOCKS (f->stat), buf,
4030 human_output_opts, ST_NBLOCKSIZE,
4032 : block_size_width);
4035 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
4037 quote_name (NULL, f->name, filename_quoting_options, &name_width);
4040 if (indicator_style != none)
4042 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4050 print_many_per_line (void)
4052 size_t row; /* Current row. */
4053 size_t cols = calculate_columns (true);
4054 struct column_info const *line_fmt = &column_info[cols - 1];
4056 /* Calculate the number of rows that will be in each column except possibly
4057 for a short column on the right. */
4058 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
4060 for (row = 0; row < rows; row++)
4063 size_t filesno = row;
4066 /* Print the next row. */
4069 struct fileinfo const *f = sorted_file[filesno];
4070 size_t name_length = length_of_file_name_and_frills (f);
4071 size_t max_name_length = line_fmt->col_arr[col++];
4072 print_file_name_and_frills (f);
4075 if (filesno >= cwd_n_used)
4078 indent (pos + name_length, pos + max_name_length);
4079 pos += max_name_length;
4086 print_horizontal (void)
4090 size_t cols = calculate_columns (false);
4091 struct column_info const *line_fmt = &column_info[cols - 1];
4092 struct fileinfo const *f = sorted_file[0];
4093 size_t name_length = length_of_file_name_and_frills (f);
4094 size_t max_name_length = line_fmt->col_arr[0];
4096 /* Print first entry. */
4097 print_file_name_and_frills (f);
4100 for (filesno = 1; filesno < cwd_n_used; ++filesno)
4102 size_t col = filesno % cols;
4111 indent (pos + name_length, pos + max_name_length);
4112 pos += max_name_length;
4115 f = sorted_file[filesno];
4116 print_file_name_and_frills (f);
4118 name_length = length_of_file_name_and_frills (f);
4119 max_name_length = line_fmt->col_arr[col];
4125 print_with_commas (void)
4130 for (filesno = 0; filesno < cwd_n_used; filesno++)
4132 struct fileinfo const *f = sorted_file[filesno];
4133 size_t len = length_of_file_name_and_frills (f);
4139 if (pos + len + 2 < line_length)
4151 putchar (separator);
4154 print_file_name_and_frills (f);
4160 /* Assuming cursor is at position FROM, indent up to position TO.
4161 Use a TAB character instead of two or more spaces whenever possible. */
4164 indent (size_t from, size_t to)
4168 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4171 from += tabsize - from % tabsize;
4181 /* Put DIRNAME/NAME into DEST, handling `.' and `/' properly. */
4182 /* FIXME: maybe remove this function someday. See about using a
4183 non-malloc'ing version of file_name_concat. */
4186 attach (char *dest, const char *dirname, const char *name)
4188 const char *dirnamep = dirname;
4190 /* Copy dirname if it is not ".". */
4191 if (dirname[0] != '.' || dirname[1] != 0)
4194 *dest++ = *dirnamep++;
4195 /* Add '/' if `dirname' doesn't already end with it. */
4196 if (dirnamep > dirname && dirnamep[-1] != '/')
4204 /* Allocate enough column info suitable for the current number of
4205 files and display columns, and initialize the info to represent the
4206 narrowest possible columns. */
4209 init_column_info (void)
4212 size_t max_cols = MIN (max_idx, cwd_n_used);
4214 /* Currently allocated columns in column_info. */
4215 static size_t column_info_alloc;
4217 if (column_info_alloc < max_cols)
4219 size_t new_column_info_alloc;
4222 if (max_cols < max_idx / 2)
4224 /* The number of columns is far less than the display width
4225 allows. Grow the allocation, but only so that it's
4226 double the current requirements. If the display is
4227 extremely wide, this avoids allocating a lot of memory
4228 that is never needed. */
4229 column_info = xnrealloc (column_info, max_cols,
4230 2 * sizeof *column_info);
4231 new_column_info_alloc = 2 * max_cols;
4235 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4236 new_column_info_alloc = max_idx;
4239 /* Allocate the new size_t objects by computing the triangle
4240 formula n * (n + 1) / 2, except that we don't need to
4241 allocate the part of the triangle that we've already
4242 allocated. Check for address arithmetic overflow. */
4244 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4245 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4246 size_t t = s * column_info_growth;
4247 if (s < new_column_info_alloc || t / column_info_growth != s)
4249 p = xnmalloc (t / 2, sizeof *p);
4252 /* Grow the triangle by parceling out the cells just allocated. */
4253 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4255 column_info[i].col_arr = p;
4259 column_info_alloc = new_column_info_alloc;
4262 for (i = 0; i < max_cols; ++i)
4266 column_info[i].valid_len = true;
4267 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4268 for (j = 0; j <= i; ++j)
4269 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4273 /* Calculate the number of columns needed to represent the current set
4274 of files in the current display width. */
4277 calculate_columns (bool by_columns)
4279 size_t filesno; /* Index into cwd_file. */
4280 size_t cols; /* Number of files across. */
4282 /* Normally the maximum number of columns is determined by the
4283 screen width. But if few files are available this might limit it
4285 size_t max_cols = MIN (max_idx, cwd_n_used);
4287 init_column_info ();
4289 /* Compute the maximum number of possible columns. */
4290 for (filesno = 0; filesno < cwd_n_used; ++filesno)
4292 struct fileinfo const *f = sorted_file[filesno];
4293 size_t name_length = length_of_file_name_and_frills (f);
4296 for (i = 0; i < max_cols; ++i)
4298 if (column_info[i].valid_len)
4300 size_t idx = (by_columns
4301 ? filesno / ((cwd_n_used + i) / (i + 1))
4302 : filesno % (i + 1));
4303 size_t real_length = name_length + (idx == i ? 0 : 2);
4305 if (column_info[i].col_arr[idx] < real_length)
4307 column_info[i].line_len += (real_length
4308 - column_info[i].col_arr[idx]);
4309 column_info[i].col_arr[idx] = real_length;
4310 column_info[i].valid_len = (column_info[i].line_len
4317 /* Find maximum allowed columns. */
4318 for (cols = max_cols; 1 < cols; --cols)
4320 if (column_info[cols - 1].valid_len)
4330 if (status != EXIT_SUCCESS)
4331 fprintf (stderr, _("Try `%s --help' for more information.\n"),
4335 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4337 List information about the FILEs (the current directory by default).\n\
4338 Sort entries alphabetically if none of -cftuvSUX nor --sort.\n\
4342 Mandatory arguments to long options are mandatory for short options too.\n\
4345 -a, --all do not ignore entries starting with .\n\
4346 -A, --almost-all do not list implied . and ..\n\
4347 --author with -l, print the author of each file\n\
4348 -b, --escape print octal escapes for nongraphic characters\n\
4351 --block-size=SIZE use SIZE-byte blocks\n\
4352 -B, --ignore-backups do not list implied entries ending with ~\n\
4353 -c with -lt: sort by, and show, ctime (time of last\n\
4354 modification of file status information)\n\
4355 with -l: show ctime and sort by name\n\
4356 otherwise: sort by ctime\n\
4359 -C list entries by columns\n\
4360 --color[=WHEN] control whether color is used to distinguish file\n\
4361 types. WHEN may be `never', `always', or `auto'\n\
4362 -d, --directory list directory entries instead of contents,\n\
4363 and do not dereference symbolic links\n\
4364 -D, --dired generate output designed for Emacs' dired mode\n\
4367 -f do not sort, enable -aU, disable -ls --color\n\
4368 -F, --classify append indicator (one of */=>@|) to entries\n\
4369 --file-type likewise, except do not append `*'\n\
4370 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4371 single-column -1, verbose -l, vertical -C\n\
4372 --full-time like -l --time-style=full-iso\n\
4375 -g like -l, but do not list owner\n\
4378 --group-directories-first\n\
4379 group directories before files.\n\
4380 augment with a --sort option, but any\n\
4381 use of --sort=none (-U) disables grouping\n\
4384 -G, --no-group in a long listing, don't print group names\n\
4385 -h, --human-readable with -l, print sizes in human readable format\n\
4386 (e.g., 1K 234M 2G)\n\
4387 --si likewise, but use powers of 1000 not 1024\n\
4390 -H, --dereference-command-line\n\
4391 follow symbolic links listed on the command line\n\
4392 --dereference-command-line-symlink-to-dir\n\
4393 follow each command line symbolic link\n\
4394 that points to a directory\n\
4395 --hide=PATTERN do not list implied entries matching shell PATTERN\n\
4396 (overridden by -a or -A)\n\
4399 --indicator-style=WORD append indicator with style WORD to entry names:\n\
4400 none (default), slash (-p),\n\
4401 file-type (--file-type), classify (-F)\n\
4402 -i, --inode print the index number of each file\n\
4403 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\n\
4404 -k like --block-size=1K\n\
4407 -l use a long listing format\n\
4408 -L, --dereference when showing file information for a symbolic\n\
4409 link, show information for the file the link\n\
4410 references rather than for the link itself\n\
4411 -m fill width with a comma separated list of entries\n\
4414 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4415 -N, --literal print raw entry names (don't treat e.g. control\n\
4416 characters specially)\n\
4417 -o like -l, but do not list group information\n\
4418 -p, --indicator-style=slash\n\
4419 append / indicator to directories\n\
4422 -q, --hide-control-chars print ? instead of non graphic characters\n\
4423 --show-control-chars show non graphic characters as-is (default\n\
4424 unless program is `ls' and output is a terminal)\n\
4425 -Q, --quote-name enclose entry names in double quotes\n\
4426 --quoting-style=WORD use quoting style WORD for entry names:\n\
4427 literal, locale, shell, shell-always, c, escape\n\
4430 -r, --reverse reverse order while sorting\n\
4431 -R, --recursive list subdirectories recursively\n\
4432 -s, --size print the size of each file, in blocks\n\
4435 -S sort by file size\n\
4436 --sort=WORD sort by WORD instead of name: none -U,\n\
4437 extension -X, size -S, time -t, version -v\n\
4438 --time=WORD with -l, show time as WORD instead of modification\n\
4439 time: atime -u, access -u, use -u, ctime -c,\n\
4440 or status -c; use specified time as sort key\n\
4444 --time-style=STYLE with -l, show times using style STYLE:\n\
4445 full-iso, long-iso, iso, locale, +FORMAT.\n\
4446 FORMAT is interpreted like `date'; if FORMAT is\n\
4447 FORMAT1<newline>FORMAT2, FORMAT1 applies to\n\
4448 non-recent files and FORMAT2 to recent files;\n\
4449 if STYLE is prefixed with `posix-', STYLE\n\
4450 takes effect only outside the POSIX locale\n\
4453 -t sort by modification time\n\
4454 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4457 -u with -lt: sort by, and show, access time\n\
4458 with -l: show access time and sort by name\n\
4459 otherwise: sort by access time\n\
4460 -U do not sort; list entries in directory order\n\
4461 -v sort by version\n\
4464 -w, --width=COLS assume screen width instead of current value\n\
4465 -x list entries by lines instead of by columns\n\
4466 -X sort alphabetically by entry extension\n\
4467 -Z, --context print any SELinux security context of each file\n\
4468 -1 list one file per line\n\
4470 fputs (HELP_OPTION_DESCRIPTION, stdout);
4471 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4473 SIZE may be (or may be an integer optionally followed by) one of following:\n\
4474 kB 1000, K 1024, MB 1000*1000, M 1024*1024, and so on for G, T, P, E, Z, Y.\n\
4478 By default, color is not used to distinguish types of files. That is\n\
4479 equivalent to using --color=none. Using the --color option without the\n\
4480 optional WHEN argument is equivalent to using --color=always. With\n\
4481 --color=auto, color codes are output only if standard output is connected\n\
4482 to a terminal (tty). The environment variable LS_COLORS can influence the\n\
4483 colors, and can be set easily by the dircolors command.\n\
4487 Exit status is 0 if OK, 1 if minor problems, 2 if serious trouble.\n\
4489 emit_bug_reporting_address ();