2 * This handles recursive filename detection with exclude
3 * files, index knowledge etc..
5 * See Documentation/technical/api-directory-listing.txt
7 * Copyright (C) Linus Torvalds, 2005-2006
8 * Junio Hamano, 2005-2006
13 #include "wildmatch.h"
16 struct path_simplify
{
22 * Tells read_directory_recursive how a file or directory should be treated.
23 * Values are ordered by significance, e.g. if a directory contains both
24 * excluded and untracked files, it is listed as untracked because
25 * path_untracked > path_excluded.
34 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
35 const char *path
, int len
, struct untracked_cache_dir
*untracked
,
36 int check_only
, const struct path_simplify
*simplify
);
37 static int get_dtype(struct dirent
*de
, const char *path
, int len
);
39 /* helper string functions with support for the ignore_case flag */
40 int strcmp_icase(const char *a
, const char *b
)
42 return ignore_case
? strcasecmp(a
, b
) : strcmp(a
, b
);
45 int strncmp_icase(const char *a
, const char *b
, size_t count
)
47 return ignore_case
? strncasecmp(a
, b
, count
) : strncmp(a
, b
, count
);
50 int fnmatch_icase(const char *pattern
, const char *string
, int flags
)
52 return wildmatch(pattern
, string
,
53 flags
| (ignore_case
? WM_CASEFOLD
: 0),
57 int git_fnmatch(const struct pathspec_item
*item
,
58 const char *pattern
, const char *string
,
62 if (ps_strncmp(item
, pattern
, string
, prefix
))
67 if (item
->flags
& PATHSPEC_ONESTAR
) {
68 int pattern_len
= strlen(++pattern
);
69 int string_len
= strlen(string
);
70 return string_len
< pattern_len
||
71 ps_strcmp(item
, pattern
,
72 string
+ string_len
- pattern_len
);
74 if (item
->magic
& PATHSPEC_GLOB
)
75 return wildmatch(pattern
, string
,
77 (item
->magic
& PATHSPEC_ICASE
? WM_CASEFOLD
: 0),
80 /* wildmatch has not learned no FNM_PATHNAME mode yet */
81 return wildmatch(pattern
, string
,
82 item
->magic
& PATHSPEC_ICASE
? WM_CASEFOLD
: 0,
86 static int fnmatch_icase_mem(const char *pattern
, int patternlen
,
87 const char *string
, int stringlen
,
91 struct strbuf pat_buf
= STRBUF_INIT
;
92 struct strbuf str_buf
= STRBUF_INIT
;
93 const char *use_pat
= pattern
;
94 const char *use_str
= string
;
96 if (pattern
[patternlen
]) {
97 strbuf_add(&pat_buf
, pattern
, patternlen
);
98 use_pat
= pat_buf
.buf
;
100 if (string
[stringlen
]) {
101 strbuf_add(&str_buf
, string
, stringlen
);
102 use_str
= str_buf
.buf
;
106 flags
|= WM_CASEFOLD
;
107 match_status
= wildmatch(use_pat
, use_str
, flags
, NULL
);
109 strbuf_release(&pat_buf
);
110 strbuf_release(&str_buf
);
115 static size_t common_prefix_len(const struct pathspec
*pathspec
)
121 * ":(icase)path" is treated as a pathspec full of
122 * wildcard. In other words, only prefix is considered common
123 * prefix. If the pathspec is abc/foo abc/bar, running in
124 * subdir xyz, the common prefix is still xyz, not xuz/abc as
127 GUARD_PATHSPEC(pathspec
,
135 for (n
= 0; n
< pathspec
->nr
; n
++) {
136 size_t i
= 0, len
= 0, item_len
;
137 if (pathspec
->items
[n
].magic
& PATHSPEC_EXCLUDE
)
139 if (pathspec
->items
[n
].magic
& PATHSPEC_ICASE
)
140 item_len
= pathspec
->items
[n
].prefix
;
142 item_len
= pathspec
->items
[n
].nowildcard_len
;
143 while (i
< item_len
&& (n
== 0 || i
< max
)) {
144 char c
= pathspec
->items
[n
].match
[i
];
145 if (c
!= pathspec
->items
[0].match
[i
])
151 if (n
== 0 || len
< max
) {
161 * Returns a copy of the longest leading path common among all
164 char *common_prefix(const struct pathspec
*pathspec
)
166 unsigned long len
= common_prefix_len(pathspec
);
168 return len
? xmemdupz(pathspec
->items
[0].match
, len
) : NULL
;
171 int fill_directory(struct dir_struct
*dir
, const struct pathspec
*pathspec
)
176 * Calculate common prefix for the pathspec, and
177 * use that to optimize the directory walk
179 len
= common_prefix_len(pathspec
);
181 /* Read the directory and prune it */
182 read_directory(dir
, pathspec
->nr
? pathspec
->_raw
[0] : "", len
, pathspec
);
186 int within_depth(const char *name
, int namelen
,
187 int depth
, int max_depth
)
189 const char *cp
= name
, *cpe
= name
+ namelen
;
195 if (depth
> max_depth
)
201 #define DO_MATCH_EXCLUDE 1
202 #define DO_MATCH_DIRECTORY 2
205 * Does 'match' match the given name?
206 * A match is found if
208 * (1) the 'match' string is leading directory of 'name', or
209 * (2) the 'match' string is a wildcard and matches 'name', or
210 * (3) the 'match' string is exactly the same as 'name'.
212 * and the return value tells which case it was.
214 * It returns 0 when there is no match.
216 static int match_pathspec_item(const struct pathspec_item
*item
, int prefix
,
217 const char *name
, int namelen
, unsigned flags
)
219 /* name/namelen has prefix cut off by caller */
220 const char *match
= item
->match
+ prefix
;
221 int matchlen
= item
->len
- prefix
;
224 * The normal call pattern is:
225 * 1. prefix = common_prefix_len(ps);
226 * 2. prune something, or fill_directory
227 * 3. match_pathspec()
229 * 'prefix' at #1 may be shorter than the command's prefix and
230 * it's ok for #2 to match extra files. Those extras will be
233 * Suppose the pathspec is 'foo' and '../bar' running from
234 * subdir 'xyz'. The common prefix at #1 will be empty, thanks
235 * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
236 * user does not want XYZ/foo, only the "foo" part should be
237 * case-insensitive. We need to filter out XYZ/foo here. In
238 * other words, we do not trust the caller on comparing the
239 * prefix part when :(icase) is involved. We do exact
240 * comparison ourselves.
242 * Normally the caller (common_prefix_len() in fact) does
243 * _exact_ matching on name[-prefix+1..-1] and we do not need
244 * to check that part. Be defensive and check it anyway, in
245 * case common_prefix_len is changed, or a new caller is
246 * introduced that does not use common_prefix_len.
248 * If the penalty turns out too high when prefix is really
249 * long, maybe change it to
250 * strncmp(match, name, item->prefix - prefix)
252 if (item
->prefix
&& (item
->magic
& PATHSPEC_ICASE
) &&
253 strncmp(item
->match
, name
- prefix
, item
->prefix
))
256 /* If the match was just the prefix, we matched */
258 return MATCHED_RECURSIVELY
;
260 if (matchlen
<= namelen
&& !ps_strncmp(item
, match
, name
, matchlen
)) {
261 if (matchlen
== namelen
)
262 return MATCHED_EXACTLY
;
264 if (match
[matchlen
-1] == '/' || name
[matchlen
] == '/')
265 return MATCHED_RECURSIVELY
;
266 } else if ((flags
& DO_MATCH_DIRECTORY
) &&
267 match
[matchlen
- 1] == '/' &&
268 namelen
== matchlen
- 1 &&
269 !ps_strncmp(item
, match
, name
, namelen
))
270 return MATCHED_EXACTLY
;
272 if (item
->nowildcard_len
< item
->len
&&
273 !git_fnmatch(item
, match
, name
,
274 item
->nowildcard_len
- prefix
))
275 return MATCHED_FNMATCH
;
281 * Given a name and a list of pathspecs, returns the nature of the
282 * closest (i.e. most specific) match of the name to any of the
285 * The caller typically calls this multiple times with the same
286 * pathspec and seen[] array but with different name/namelen
287 * (e.g. entries from the index) and is interested in seeing if and
288 * how each pathspec matches all the names it calls this function
289 * with. A mark is left in the seen[] array for each pathspec element
290 * indicating the closest type of match that element achieved, so if
291 * seen[n] remains zero after multiple invocations, that means the nth
292 * pathspec did not match any names, which could indicate that the
293 * user mistyped the nth pathspec.
295 static int do_match_pathspec(const struct pathspec
*ps
,
296 const char *name
, int namelen
,
297 int prefix
, char *seen
,
300 int i
, retval
= 0, exclude
= flags
& DO_MATCH_EXCLUDE
;
311 if (!ps
->recursive
||
312 !(ps
->magic
& PATHSPEC_MAXDEPTH
) ||
314 return MATCHED_RECURSIVELY
;
316 if (within_depth(name
, namelen
, 0, ps
->max_depth
))
317 return MATCHED_EXACTLY
;
325 for (i
= ps
->nr
- 1; i
>= 0; i
--) {
328 if ((!exclude
&& ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
) ||
329 ( exclude
&& !(ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
)))
332 if (seen
&& seen
[i
] == MATCHED_EXACTLY
)
335 * Make exclude patterns optional and never report
336 * "pathspec ':(exclude)foo' matches no files"
338 if (seen
&& ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
)
339 seen
[i
] = MATCHED_FNMATCH
;
340 how
= match_pathspec_item(ps
->items
+i
, prefix
, name
,
343 (ps
->magic
& PATHSPEC_MAXDEPTH
) &&
344 ps
->max_depth
!= -1 &&
345 how
&& how
!= MATCHED_FNMATCH
) {
346 int len
= ps
->items
[i
].len
;
347 if (name
[len
] == '/')
349 if (within_depth(name
+len
, namelen
-len
, 0, ps
->max_depth
))
350 how
= MATCHED_EXACTLY
;
357 if (seen
&& seen
[i
] < how
)
364 int match_pathspec(const struct pathspec
*ps
,
365 const char *name
, int namelen
,
366 int prefix
, char *seen
, int is_dir
)
368 int positive
, negative
;
369 unsigned flags
= is_dir
? DO_MATCH_DIRECTORY
: 0;
370 positive
= do_match_pathspec(ps
, name
, namelen
,
371 prefix
, seen
, flags
);
372 if (!(ps
->magic
& PATHSPEC_EXCLUDE
) || !positive
)
374 negative
= do_match_pathspec(ps
, name
, namelen
,
376 flags
| DO_MATCH_EXCLUDE
);
377 return negative
? 0 : positive
;
381 * Return the length of the "simple" part of a path match limiter.
383 int simple_length(const char *match
)
388 unsigned char c
= *match
++;
390 if (c
== '\0' || is_glob_special(c
))
395 int no_wildcard(const char *string
)
397 return string
[simple_length(string
)] == '\0';
400 void parse_exclude_pattern(const char **pattern
,
405 const char *p
= *pattern
;
410 *flags
|= EXC_FLAG_NEGATIVE
;
414 if (len
&& p
[len
- 1] == '/') {
416 *flags
|= EXC_FLAG_MUSTBEDIR
;
418 for (i
= 0; i
< len
; i
++) {
423 *flags
|= EXC_FLAG_NODIR
;
424 *nowildcardlen
= simple_length(p
);
426 * we should have excluded the trailing slash from 'p' too,
427 * but that's one more allocation. Instead just make sure
428 * nowildcardlen does not exceed real patternlen
430 if (*nowildcardlen
> len
)
431 *nowildcardlen
= len
;
432 if (*p
== '*' && no_wildcard(p
+ 1))
433 *flags
|= EXC_FLAG_ENDSWITH
;
438 void add_exclude(const char *string
, const char *base
,
439 int baselen
, struct exclude_list
*el
, int srcpos
)
446 parse_exclude_pattern(&string
, &patternlen
, &flags
, &nowildcardlen
);
447 if (flags
& EXC_FLAG_MUSTBEDIR
) {
449 x
= xmalloc(sizeof(*x
) + patternlen
+ 1);
451 memcpy(s
, string
, patternlen
);
452 s
[patternlen
] = '\0';
455 x
= xmalloc(sizeof(*x
));
458 x
->patternlen
= patternlen
;
459 x
->nowildcardlen
= nowildcardlen
;
461 x
->baselen
= baselen
;
464 ALLOC_GROW(el
->excludes
, el
->nr
+ 1, el
->alloc
);
465 el
->excludes
[el
->nr
++] = x
;
469 static void *read_skip_worktree_file_from_index(const char *path
, size_t *size
,
470 struct sha1_stat
*sha1_stat
)
474 enum object_type type
;
478 pos
= cache_name_pos(path
, len
);
481 if (!ce_skip_worktree(active_cache
[pos
]))
483 data
= read_sha1_file(active_cache
[pos
]->sha1
, &type
, &sz
);
484 if (!data
|| type
!= OBJ_BLOB
) {
490 memset(&sha1_stat
->stat
, 0, sizeof(sha1_stat
->stat
));
491 hashcpy(sha1_stat
->sha1
, active_cache
[pos
]->sha1
);
497 * Frees memory within el which was allocated for exclude patterns and
498 * the file buffer. Does not free el itself.
500 void clear_exclude_list(struct exclude_list
*el
)
504 for (i
= 0; i
< el
->nr
; i
++)
505 free(el
->excludes
[i
]);
514 static void trim_trailing_spaces(char *buf
)
516 char *p
, *last_space
= NULL
;
518 for (p
= buf
; *p
; p
++)
538 * Given a subdirectory name and "dir" of the current directory,
539 * search the subdir in "dir" and return it, or create a new one if it
540 * does not exist in "dir".
542 * If "name" has the trailing slash, it'll be excluded in the search.
544 static struct untracked_cache_dir
*lookup_untracked(struct untracked_cache
*uc
,
545 struct untracked_cache_dir
*dir
,
546 const char *name
, int len
)
549 struct untracked_cache_dir
*d
;
552 if (len
&& name
[len
- 1] == '/')
556 while (last
> first
) {
557 int cmp
, next
= (last
+ first
) >> 1;
559 cmp
= strncmp(name
, d
->name
, len
);
560 if (!cmp
&& strlen(d
->name
) > len
)
572 d
= xmalloc(sizeof(*d
) + len
+ 1);
573 memset(d
, 0, sizeof(*d
));
574 memcpy(d
->name
, name
, len
);
577 ALLOC_GROW(dir
->dirs
, dir
->dirs_nr
+ 1, dir
->dirs_alloc
);
578 memmove(dir
->dirs
+ first
+ 1, dir
->dirs
+ first
,
579 (dir
->dirs_nr
- first
) * sizeof(*dir
->dirs
));
581 dir
->dirs
[first
] = d
;
586 * Given a file with name "fname", read it (either from disk, or from
587 * the index if "check_index" is non-zero), parse it and store the
588 * exclude rules in "el".
590 * If "ss" is not NULL, compute SHA-1 of the exclude file and fill
591 * stat data from disk (only valid if add_excludes returns zero). If
592 * ss_valid is non-zero, "ss" must contain good value as input.
594 static int add_excludes(const char *fname
, const char *base
, int baselen
,
595 struct exclude_list
*el
, int check_index
,
596 struct sha1_stat
*sha1_stat
)
599 int fd
, i
, lineno
= 1;
603 fd
= open(fname
, O_RDONLY
);
604 if (fd
< 0 || fstat(fd
, &st
) < 0) {
606 warn_on_inaccessible(fname
);
610 (buf
= read_skip_worktree_file_from_index(fname
, &size
, sha1_stat
)) == NULL
)
616 if (buf
[size
-1] != '\n') {
617 buf
= xrealloc(buf
, size
+1);
621 size
= xsize_t(st
.st_size
);
624 fill_stat_data(&sha1_stat
->stat
, &st
);
625 hashcpy(sha1_stat
->sha1
, EMPTY_BLOB_SHA1_BIN
);
626 sha1_stat
->valid
= 1;
631 buf
= xmalloc(size
+1);
632 if (read_in_full(fd
, buf
, size
) != size
) {
641 if (sha1_stat
->valid
&&
642 !match_stat_data(&sha1_stat
->stat
, &st
))
643 ; /* no content change, ss->sha1 still good */
644 else if (check_index
&&
645 (pos
= cache_name_pos(fname
, strlen(fname
))) >= 0 &&
646 !ce_stage(active_cache
[pos
]) &&
647 ce_uptodate(active_cache
[pos
]) &&
648 !would_convert_to_git(fname
))
649 hashcpy(sha1_stat
->sha1
, active_cache
[pos
]->sha1
);
651 hash_sha1_file(buf
, size
, "blob", sha1_stat
->sha1
);
652 fill_stat_data(&sha1_stat
->stat
, &st
);
653 sha1_stat
->valid
= 1;
659 for (i
= 0; i
< size
; i
++) {
660 if (buf
[i
] == '\n') {
661 if (entry
!= buf
+ i
&& entry
[0] != '#') {
662 buf
[i
- (i
&& buf
[i
-1] == '\r')] = 0;
663 trim_trailing_spaces(entry
);
664 add_exclude(entry
, base
, baselen
, el
, lineno
);
673 int add_excludes_from_file_to_list(const char *fname
, const char *base
,
674 int baselen
, struct exclude_list
*el
,
677 return add_excludes(fname
, base
, baselen
, el
, check_index
, NULL
);
680 struct exclude_list
*add_exclude_list(struct dir_struct
*dir
,
681 int group_type
, const char *src
)
683 struct exclude_list
*el
;
684 struct exclude_list_group
*group
;
686 group
= &dir
->exclude_list_group
[group_type
];
687 ALLOC_GROW(group
->el
, group
->nr
+ 1, group
->alloc
);
688 el
= &group
->el
[group
->nr
++];
689 memset(el
, 0, sizeof(*el
));
695 * Used to set up core.excludesfile and .git/info/exclude lists.
697 static void add_excludes_from_file_1(struct dir_struct
*dir
, const char *fname
,
698 struct sha1_stat
*sha1_stat
)
700 struct exclude_list
*el
;
701 el
= add_exclude_list(dir
, EXC_FILE
, fname
);
702 if (add_excludes(fname
, "", 0, el
, 0, sha1_stat
) < 0)
703 die("cannot use %s as an exclude file", fname
);
706 void add_excludes_from_file(struct dir_struct
*dir
, const char *fname
)
708 add_excludes_from_file_1(dir
, fname
, NULL
);
711 int match_basename(const char *basename
, int basenamelen
,
712 const char *pattern
, int prefix
, int patternlen
,
715 if (prefix
== patternlen
) {
716 if (patternlen
== basenamelen
&&
717 !strncmp_icase(pattern
, basename
, basenamelen
))
719 } else if (flags
& EXC_FLAG_ENDSWITH
) {
720 /* "*literal" matching against "fooliteral" */
721 if (patternlen
- 1 <= basenamelen
&&
722 !strncmp_icase(pattern
+ 1,
723 basename
+ basenamelen
- (patternlen
- 1),
727 if (fnmatch_icase_mem(pattern
, patternlen
,
728 basename
, basenamelen
,
735 int match_pathname(const char *pathname
, int pathlen
,
736 const char *base
, int baselen
,
737 const char *pattern
, int prefix
, int patternlen
,
744 * match with FNM_PATHNAME; the pattern has base implicitly
747 if (*pattern
== '/') {
754 * baselen does not count the trailing slash. base[] may or
755 * may not end with a trailing slash though.
757 if (pathlen
< baselen
+ 1 ||
758 (baselen
&& pathname
[baselen
] != '/') ||
759 strncmp_icase(pathname
, base
, baselen
))
762 namelen
= baselen
? pathlen
- baselen
- 1 : pathlen
;
763 name
= pathname
+ pathlen
- namelen
;
767 * if the non-wildcard part is longer than the
768 * remaining pathname, surely it cannot match.
770 if (prefix
> namelen
)
773 if (strncmp_icase(pattern
, name
, prefix
))
776 patternlen
-= prefix
;
781 * If the whole pattern did not have a wildcard,
782 * then our prefix match is all we need; we
783 * do not need to call fnmatch at all.
785 if (!patternlen
&& !namelen
)
789 return fnmatch_icase_mem(pattern
, patternlen
,
795 * Scan the given exclude list in reverse to see whether pathname
796 * should be ignored. The first match (i.e. the last on the list), if
797 * any, determines the fate. Returns the exclude_list element which
798 * matched, or NULL for undecided.
800 static struct exclude
*last_exclude_matching_from_list(const char *pathname
,
802 const char *basename
,
804 struct exclude_list
*el
)
809 return NULL
; /* undefined */
811 for (i
= el
->nr
- 1; 0 <= i
; i
--) {
812 struct exclude
*x
= el
->excludes
[i
];
813 const char *exclude
= x
->pattern
;
814 int prefix
= x
->nowildcardlen
;
816 if (x
->flags
& EXC_FLAG_MUSTBEDIR
) {
817 if (*dtype
== DT_UNKNOWN
)
818 *dtype
= get_dtype(NULL
, pathname
, pathlen
);
819 if (*dtype
!= DT_DIR
)
823 if (x
->flags
& EXC_FLAG_NODIR
) {
824 if (match_basename(basename
,
825 pathlen
- (basename
- pathname
),
826 exclude
, prefix
, x
->patternlen
,
832 assert(x
->baselen
== 0 || x
->base
[x
->baselen
- 1] == '/');
833 if (match_pathname(pathname
, pathlen
,
834 x
->base
, x
->baselen
? x
->baselen
- 1 : 0,
835 exclude
, prefix
, x
->patternlen
, x
->flags
))
838 return NULL
; /* undecided */
842 * Scan the list and let the last match determine the fate.
843 * Return 1 for exclude, 0 for include and -1 for undecided.
845 int is_excluded_from_list(const char *pathname
,
846 int pathlen
, const char *basename
, int *dtype
,
847 struct exclude_list
*el
)
849 struct exclude
*exclude
;
850 exclude
= last_exclude_matching_from_list(pathname
, pathlen
, basename
, dtype
, el
);
852 return exclude
->flags
& EXC_FLAG_NEGATIVE
? 0 : 1;
853 return -1; /* undecided */
856 static struct exclude
*last_exclude_matching_from_lists(struct dir_struct
*dir
,
857 const char *pathname
, int pathlen
, const char *basename
,
861 struct exclude_list_group
*group
;
862 struct exclude
*exclude
;
863 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
864 group
= &dir
->exclude_list_group
[i
];
865 for (j
= group
->nr
- 1; j
>= 0; j
--) {
866 exclude
= last_exclude_matching_from_list(
867 pathname
, pathlen
, basename
, dtype_p
,
877 * Loads the per-directory exclude list for the substring of base
878 * which has a char length of baselen.
880 static void prep_exclude(struct dir_struct
*dir
, const char *base
, int baselen
)
882 struct exclude_list_group
*group
;
883 struct exclude_list
*el
;
884 struct exclude_stack
*stk
= NULL
;
885 struct untracked_cache_dir
*untracked
;
888 group
= &dir
->exclude_list_group
[EXC_DIRS
];
891 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
892 * which originate from directories not in the prefix of the
893 * path being checked.
895 while ((stk
= dir
->exclude_stack
) != NULL
) {
896 if (stk
->baselen
<= baselen
&&
897 !strncmp(dir
->basebuf
.buf
, base
, stk
->baselen
))
899 el
= &group
->el
[dir
->exclude_stack
->exclude_ix
];
900 dir
->exclude_stack
= stk
->prev
;
902 free((char *)el
->src
); /* see strbuf_detach() below */
903 clear_exclude_list(el
);
908 /* Skip traversing into sub directories if the parent is excluded */
913 * Lazy initialization. All call sites currently just
914 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
915 * them seems lots of work for little benefit.
917 if (!dir
->basebuf
.buf
)
918 strbuf_init(&dir
->basebuf
, PATH_MAX
);
920 /* Read from the parent directories and push them down. */
921 current
= stk
? stk
->baselen
: -1;
922 strbuf_setlen(&dir
->basebuf
, current
< 0 ? 0 : current
);
924 untracked
= stk
? stk
->ucd
: dir
->untracked
->root
;
928 while (current
< baselen
) {
930 struct sha1_stat sha1_stat
;
932 stk
= xcalloc(1, sizeof(*stk
));
937 cp
= strchr(base
+ current
+ 1, '/');
939 die("oops in prep_exclude");
942 lookup_untracked(dir
->untracked
, untracked
,
944 cp
- base
- current
);
946 stk
->prev
= dir
->exclude_stack
;
947 stk
->baselen
= cp
- base
;
948 stk
->exclude_ix
= group
->nr
;
949 stk
->ucd
= untracked
;
950 el
= add_exclude_list(dir
, EXC_DIRS
, NULL
);
951 strbuf_add(&dir
->basebuf
, base
+ current
, stk
->baselen
- current
);
952 assert(stk
->baselen
== dir
->basebuf
.len
);
954 /* Abort if the directory is excluded */
957 dir
->basebuf
.buf
[stk
->baselen
- 1] = 0;
958 dir
->exclude
= last_exclude_matching_from_lists(dir
,
959 dir
->basebuf
.buf
, stk
->baselen
- 1,
960 dir
->basebuf
.buf
+ current
, &dt
);
961 dir
->basebuf
.buf
[stk
->baselen
- 1] = '/';
963 dir
->exclude
->flags
& EXC_FLAG_NEGATIVE
)
966 dir
->exclude_stack
= stk
;
971 /* Try to read per-directory file */
972 hashclr(sha1_stat
.sha1
);
974 if (dir
->exclude_per_dir
) {
976 * dir->basebuf gets reused by the traversal, but we
977 * need fname to remain unchanged to ensure the src
978 * member of each struct exclude correctly
979 * back-references its source file. Other invocations
980 * of add_exclude_list provide stable strings, so we
981 * strbuf_detach() and free() here in the caller.
983 struct strbuf sb
= STRBUF_INIT
;
984 strbuf_addbuf(&sb
, &dir
->basebuf
);
985 strbuf_addstr(&sb
, dir
->exclude_per_dir
);
986 el
->src
= strbuf_detach(&sb
, NULL
);
987 add_excludes(el
->src
, el
->src
, stk
->baselen
, el
, 1,
988 untracked
? &sha1_stat
: NULL
);
991 hashcpy(untracked
->exclude_sha1
, sha1_stat
.sha1
);
993 dir
->exclude_stack
= stk
;
994 current
= stk
->baselen
;
996 strbuf_setlen(&dir
->basebuf
, baselen
);
1000 * Loads the exclude lists for the directory containing pathname, then
1001 * scans all exclude lists to determine whether pathname is excluded.
1002 * Returns the exclude_list element which matched, or NULL for
1005 struct exclude
*last_exclude_matching(struct dir_struct
*dir
,
1006 const char *pathname
,
1009 int pathlen
= strlen(pathname
);
1010 const char *basename
= strrchr(pathname
, '/');
1011 basename
= (basename
) ? basename
+1 : pathname
;
1013 prep_exclude(dir
, pathname
, basename
-pathname
);
1016 return dir
->exclude
;
1018 return last_exclude_matching_from_lists(dir
, pathname
, pathlen
,
1023 * Loads the exclude lists for the directory containing pathname, then
1024 * scans all exclude lists to determine whether pathname is excluded.
1025 * Returns 1 if true, otherwise 0.
1027 int is_excluded(struct dir_struct
*dir
, const char *pathname
, int *dtype_p
)
1029 struct exclude
*exclude
=
1030 last_exclude_matching(dir
, pathname
, dtype_p
);
1032 return exclude
->flags
& EXC_FLAG_NEGATIVE
? 0 : 1;
1036 static struct dir_entry
*dir_entry_new(const char *pathname
, int len
)
1038 struct dir_entry
*ent
;
1040 ent
= xmalloc(sizeof(*ent
) + len
+ 1);
1042 memcpy(ent
->name
, pathname
, len
);
1047 static struct dir_entry
*dir_add_name(struct dir_struct
*dir
, const char *pathname
, int len
)
1049 if (cache_file_exists(pathname
, len
, ignore_case
))
1052 ALLOC_GROW(dir
->entries
, dir
->nr
+1, dir
->alloc
);
1053 return dir
->entries
[dir
->nr
++] = dir_entry_new(pathname
, len
);
1056 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
, const char *pathname
, int len
)
1058 if (!cache_name_is_other(pathname
, len
))
1061 ALLOC_GROW(dir
->ignored
, dir
->ignored_nr
+1, dir
->ignored_alloc
);
1062 return dir
->ignored
[dir
->ignored_nr
++] = dir_entry_new(pathname
, len
);
1066 index_nonexistent
= 0,
1072 * Do not use the alphabetically sorted index to look up
1073 * the directory name; instead, use the case insensitive
1076 static enum exist_status
directory_exists_in_index_icase(const char *dirname
, int len
)
1078 const struct cache_entry
*ce
= cache_dir_exists(dirname
, len
);
1079 unsigned char endchar
;
1082 return index_nonexistent
;
1083 endchar
= ce
->name
[len
];
1086 * The cache_entry structure returned will contain this dirname
1087 * and possibly additional path components.
1090 return index_directory
;
1093 * If there are no additional path components, then this cache_entry
1094 * represents a submodule. Submodules, despite being directories,
1095 * are stored in the cache without a closing slash.
1097 if (!endchar
&& S_ISGITLINK(ce
->ce_mode
))
1098 return index_gitdir
;
1100 /* This should never be hit, but it exists just in case. */
1101 return index_nonexistent
;
1105 * The index sorts alphabetically by entry name, which
1106 * means that a gitlink sorts as '\0' at the end, while
1107 * a directory (which is defined not as an entry, but as
1108 * the files it contains) will sort with the '/' at the
1111 static enum exist_status
directory_exists_in_index(const char *dirname
, int len
)
1116 return directory_exists_in_index_icase(dirname
, len
);
1118 pos
= cache_name_pos(dirname
, len
);
1121 while (pos
< active_nr
) {
1122 const struct cache_entry
*ce
= active_cache
[pos
++];
1123 unsigned char endchar
;
1125 if (strncmp(ce
->name
, dirname
, len
))
1127 endchar
= ce
->name
[len
];
1131 return index_directory
;
1132 if (!endchar
&& S_ISGITLINK(ce
->ce_mode
))
1133 return index_gitdir
;
1135 return index_nonexistent
;
1139 * When we find a directory when traversing the filesystem, we
1140 * have three distinct cases:
1143 * - see it as a directory
1146 * and which one we choose depends on a combination of existing
1147 * git index contents and the flags passed into the directory
1148 * traversal routine.
1150 * Case 1: If we *already* have entries in the index under that
1151 * directory name, we always recurse into the directory to see
1154 * Case 2: If we *already* have that directory name as a gitlink,
1155 * we always continue to see it as a gitlink, regardless of whether
1156 * there is an actual git directory there or not (it might not
1157 * be checked out as a subproject!)
1159 * Case 3: if we didn't have it in the index previously, we
1160 * have a few sub-cases:
1162 * (a) if "show_other_directories" is true, we show it as
1163 * just a directory, unless "hide_empty_directories" is
1164 * also true, in which case we need to check if it contains any
1165 * untracked and / or ignored files.
1166 * (b) if it looks like a git directory, and we don't have
1167 * 'no_gitlinks' set we treat it as a gitlink, and show it
1169 * (c) otherwise, we recurse into it.
1171 static enum path_treatment
treat_directory(struct dir_struct
*dir
,
1172 struct untracked_cache_dir
*untracked
,
1173 const char *dirname
, int len
, int exclude
,
1174 const struct path_simplify
*simplify
)
1176 /* The "len-1" is to strip the final '/' */
1177 switch (directory_exists_in_index(dirname
, len
-1)) {
1178 case index_directory
:
1179 return path_recurse
;
1184 case index_nonexistent
:
1185 if (dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
)
1187 if (!(dir
->flags
& DIR_NO_GITLINKS
)) {
1188 unsigned char sha1
[20];
1189 if (resolve_gitlink_ref(dirname
, "HEAD", sha1
) == 0)
1190 return path_untracked
;
1192 return path_recurse
;
1195 /* This is the "show_other_directories" case */
1197 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
1198 return exclude
? path_excluded
: path_untracked
;
1200 untracked
= lookup_untracked(dir
->untracked
, untracked
, dirname
, len
);
1201 return read_directory_recursive(dir
, dirname
, len
,
1202 untracked
, 1, simplify
);
1206 * This is an inexact early pruning of any recursive directory
1207 * reading - if the path cannot possibly be in the pathspec,
1208 * return true, and we'll skip it early.
1210 static int simplify_away(const char *path
, int pathlen
, const struct path_simplify
*simplify
)
1214 const char *match
= simplify
->path
;
1215 int len
= simplify
->len
;
1221 if (!memcmp(path
, match
, len
))
1231 * This function tells us whether an excluded path matches a
1232 * list of "interesting" pathspecs. That is, whether a path matched
1233 * by any of the pathspecs could possibly be ignored by excluding
1234 * the specified path. This can happen if:
1236 * 1. the path is mentioned explicitly in the pathspec
1238 * 2. the path is a directory prefix of some element in the
1241 static int exclude_matches_pathspec(const char *path
, int len
,
1242 const struct path_simplify
*simplify
)
1245 for (; simplify
->path
; simplify
++) {
1246 if (len
== simplify
->len
1247 && !memcmp(path
, simplify
->path
, len
))
1249 if (len
< simplify
->len
1250 && simplify
->path
[len
] == '/'
1251 && !memcmp(path
, simplify
->path
, len
))
1258 static int get_index_dtype(const char *path
, int len
)
1261 const struct cache_entry
*ce
;
1263 ce
= cache_file_exists(path
, len
, 0);
1265 if (!ce_uptodate(ce
))
1267 if (S_ISGITLINK(ce
->ce_mode
))
1270 * Nobody actually cares about the
1271 * difference between DT_LNK and DT_REG
1276 /* Try to look it up as a directory */
1277 pos
= cache_name_pos(path
, len
);
1281 while (pos
< active_nr
) {
1282 ce
= active_cache
[pos
++];
1283 if (strncmp(ce
->name
, path
, len
))
1285 if (ce
->name
[len
] > '/')
1287 if (ce
->name
[len
] < '/')
1289 if (!ce_uptodate(ce
))
1290 break; /* continue? */
1296 static int get_dtype(struct dirent
*de
, const char *path
, int len
)
1298 int dtype
= de
? DTYPE(de
) : DT_UNKNOWN
;
1301 if (dtype
!= DT_UNKNOWN
)
1303 dtype
= get_index_dtype(path
, len
);
1304 if (dtype
!= DT_UNKNOWN
)
1306 if (lstat(path
, &st
))
1308 if (S_ISREG(st
.st_mode
))
1310 if (S_ISDIR(st
.st_mode
))
1312 if (S_ISLNK(st
.st_mode
))
1317 static enum path_treatment
treat_one_path(struct dir_struct
*dir
,
1318 struct untracked_cache_dir
*untracked
,
1319 struct strbuf
*path
,
1320 const struct path_simplify
*simplify
,
1321 int dtype
, struct dirent
*de
)
1324 int has_path_in_index
= !!cache_file_exists(path
->buf
, path
->len
, ignore_case
);
1326 if (dtype
== DT_UNKNOWN
)
1327 dtype
= get_dtype(de
, path
->buf
, path
->len
);
1329 /* Always exclude indexed files */
1330 if (dtype
!= DT_DIR
&& has_path_in_index
)
1334 * When we are looking at a directory P in the working tree,
1335 * there are three cases:
1337 * (1) P exists in the index. Everything inside the directory P in
1338 * the working tree needs to go when P is checked out from the
1341 * (2) P does not exist in the index, but there is P/Q in the index.
1342 * We know P will stay a directory when we check out the contents
1343 * of the index, but we do not know yet if there is a directory
1344 * P/Q in the working tree to be killed, so we need to recurse.
1346 * (3) P does not exist in the index, and there is no P/Q in the index
1347 * to require P to be a directory, either. Only in this case, we
1348 * know that everything inside P will not be killed without
1351 if ((dir
->flags
& DIR_COLLECT_KILLED_ONLY
) &&
1352 (dtype
== DT_DIR
) &&
1353 !has_path_in_index
&&
1354 (directory_exists_in_index(path
->buf
, path
->len
) == index_nonexistent
))
1357 exclude
= is_excluded(dir
, path
->buf
, &dtype
);
1360 * Excluded? If we don't explicitly want to show
1361 * ignored files, ignore it
1363 if (exclude
&& !(dir
->flags
& (DIR_SHOW_IGNORED
|DIR_SHOW_IGNORED_TOO
)))
1364 return path_excluded
;
1370 strbuf_addch(path
, '/');
1371 return treat_directory(dir
, untracked
, path
->buf
, path
->len
, exclude
,
1375 return exclude
? path_excluded
: path_untracked
;
1379 static enum path_treatment
treat_path(struct dir_struct
*dir
,
1380 struct untracked_cache_dir
*untracked
,
1382 struct strbuf
*path
,
1384 const struct path_simplify
*simplify
)
1388 if (is_dot_or_dotdot(de
->d_name
) || !strcmp(de
->d_name
, ".git"))
1390 strbuf_setlen(path
, baselen
);
1391 strbuf_addstr(path
, de
->d_name
);
1392 if (simplify_away(path
->buf
, path
->len
, simplify
))
1396 return treat_one_path(dir
, untracked
, path
, simplify
, dtype
, de
);
1399 static void add_untracked(struct untracked_cache_dir
*dir
, const char *name
)
1403 ALLOC_GROW(dir
->untracked
, dir
->untracked_nr
+ 1,
1404 dir
->untracked_alloc
);
1405 dir
->untracked
[dir
->untracked_nr
++] = xstrdup(name
);
1409 * Read a directory tree. We currently ignore anything but
1410 * directories, regular files and symlinks. That's because git
1411 * doesn't handle them at all yet. Maybe that will change some
1414 * Also, we ignore the name ".git" (even if it is not a directory).
1415 * That likely will not change.
1417 * Returns the most significant path_treatment value encountered in the scan.
1419 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
1420 const char *base
, int baselen
,
1421 struct untracked_cache_dir
*untracked
, int check_only
,
1422 const struct path_simplify
*simplify
)
1425 enum path_treatment state
, subdir_state
, dir_state
= path_none
;
1427 struct strbuf path
= STRBUF_INIT
;
1429 strbuf_add(&path
, base
, baselen
);
1431 fdir
= opendir(path
.len
? path
.buf
: ".");
1436 untracked
->check_only
= !!check_only
;
1438 while ((de
= readdir(fdir
)) != NULL
) {
1439 /* check how the file or directory should be treated */
1440 state
= treat_path(dir
, untracked
, de
, &path
, baselen
, simplify
);
1442 if (state
> dir_state
)
1445 /* recurse into subdir if instructed by treat_path */
1446 if (state
== path_recurse
) {
1447 struct untracked_cache_dir
*ud
;
1448 ud
= lookup_untracked(dir
->untracked
, untracked
,
1450 path
.len
- baselen
);
1452 read_directory_recursive(dir
, path
.buf
, path
.len
,
1453 ud
, check_only
, simplify
);
1454 if (subdir_state
> dir_state
)
1455 dir_state
= subdir_state
;
1459 /* abort early if maximum state has been reached */
1460 if (dir_state
== path_untracked
) {
1462 add_untracked(untracked
, path
.buf
+ baselen
);
1465 /* skip the dir_add_* part */
1469 /* add the path to the appropriate result list */
1472 if (dir
->flags
& DIR_SHOW_IGNORED
)
1473 dir_add_name(dir
, path
.buf
, path
.len
);
1474 else if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) ||
1475 ((dir
->flags
& DIR_COLLECT_IGNORED
) &&
1476 exclude_matches_pathspec(path
.buf
, path
.len
,
1478 dir_add_ignored(dir
, path
.buf
, path
.len
);
1481 case path_untracked
:
1482 if (dir
->flags
& DIR_SHOW_IGNORED
)
1484 dir_add_name(dir
, path
.buf
, path
.len
);
1486 add_untracked(untracked
, path
.buf
+ baselen
);
1495 strbuf_release(&path
);
1500 static int cmp_name(const void *p1
, const void *p2
)
1502 const struct dir_entry
*e1
= *(const struct dir_entry
**)p1
;
1503 const struct dir_entry
*e2
= *(const struct dir_entry
**)p2
;
1505 return name_compare(e1
->name
, e1
->len
, e2
->name
, e2
->len
);
1508 static struct path_simplify
*create_simplify(const char **pathspec
)
1511 struct path_simplify
*simplify
= NULL
;
1516 for (nr
= 0 ; ; nr
++) {
1518 ALLOC_GROW(simplify
, nr
+ 1, alloc
);
1519 match
= *pathspec
++;
1522 simplify
[nr
].path
= match
;
1523 simplify
[nr
].len
= simple_length(match
);
1525 simplify
[nr
].path
= NULL
;
1526 simplify
[nr
].len
= 0;
1530 static void free_simplify(struct path_simplify
*simplify
)
1535 static int treat_leading_path(struct dir_struct
*dir
,
1536 const char *path
, int len
,
1537 const struct path_simplify
*simplify
)
1539 struct strbuf sb
= STRBUF_INIT
;
1540 int baselen
, rc
= 0;
1542 int old_flags
= dir
->flags
;
1544 while (len
&& path
[len
- 1] == '/')
1549 dir
->flags
&= ~DIR_SHOW_OTHER_DIRECTORIES
;
1551 cp
= path
+ baselen
+ !!baselen
;
1552 cp
= memchr(cp
, '/', path
+ len
- cp
);
1556 baselen
= cp
- path
;
1557 strbuf_setlen(&sb
, 0);
1558 strbuf_add(&sb
, path
, baselen
);
1559 if (!is_directory(sb
.buf
))
1561 if (simplify_away(sb
.buf
, sb
.len
, simplify
))
1563 if (treat_one_path(dir
, NULL
, &sb
, simplify
,
1564 DT_DIR
, NULL
) == path_none
)
1565 break; /* do not recurse into it */
1566 if (len
<= baselen
) {
1568 break; /* finished checking */
1571 strbuf_release(&sb
);
1572 dir
->flags
= old_flags
;
1576 int read_directory(struct dir_struct
*dir
, const char *path
, int len
, const struct pathspec
*pathspec
)
1578 struct path_simplify
*simplify
;
1581 * Check out create_simplify()
1584 GUARD_PATHSPEC(pathspec
,
1592 if (has_symlink_leading_path(path
, len
))
1596 * exclude patterns are treated like positive ones in
1597 * create_simplify. Usually exclude patterns should be a
1598 * subset of positive ones, which has no impacts on
1599 * create_simplify().
1601 simplify
= create_simplify(pathspec
? pathspec
->_raw
: NULL
);
1602 if (!len
|| treat_leading_path(dir
, path
, len
, simplify
))
1603 read_directory_recursive(dir
, path
, len
,
1604 dir
->untracked
? dir
->untracked
->root
: NULL
,
1606 free_simplify(simplify
);
1607 qsort(dir
->entries
, dir
->nr
, sizeof(struct dir_entry
*), cmp_name
);
1608 qsort(dir
->ignored
, dir
->ignored_nr
, sizeof(struct dir_entry
*), cmp_name
);
1612 int file_exists(const char *f
)
1615 return lstat(f
, &sb
) == 0;
1619 * Given two normalized paths (a trailing slash is ok), if subdir is
1620 * outside dir, return -1. Otherwise return the offset in subdir that
1621 * can be used as relative path to dir.
1623 int dir_inside_of(const char *subdir
, const char *dir
)
1627 assert(dir
&& subdir
&& *dir
&& *subdir
);
1629 while (*dir
&& *subdir
&& *dir
== *subdir
) {
1635 /* hel[p]/me vs hel[l]/yeah */
1636 if (*dir
&& *subdir
)
1640 return !*dir
? offset
: -1; /* same dir */
1642 /* foo/[b]ar vs foo/[] */
1643 if (is_dir_sep(dir
[-1]))
1644 return is_dir_sep(subdir
[-1]) ? offset
: -1;
1646 /* foo[/]bar vs foo[] */
1647 return is_dir_sep(*subdir
) ? offset
+ 1 : -1;
1650 int is_inside_dir(const char *dir
)
1659 rc
= (dir_inside_of(cwd
, dir
) >= 0);
1664 int is_empty_dir(const char *path
)
1666 DIR *dir
= opendir(path
);
1673 while ((e
= readdir(dir
)) != NULL
)
1674 if (!is_dot_or_dotdot(e
->d_name
)) {
1683 static int remove_dir_recurse(struct strbuf
*path
, int flag
, int *kept_up
)
1687 int ret
= 0, original_len
= path
->len
, len
, kept_down
= 0;
1688 int only_empty
= (flag
& REMOVE_DIR_EMPTY_ONLY
);
1689 int keep_toplevel
= (flag
& REMOVE_DIR_KEEP_TOPLEVEL
);
1690 unsigned char submodule_head
[20];
1692 if ((flag
& REMOVE_DIR_KEEP_NESTED_GIT
) &&
1693 !resolve_gitlink_ref(path
->buf
, "HEAD", submodule_head
)) {
1694 /* Do not descend and nuke a nested git work tree. */
1700 flag
&= ~REMOVE_DIR_KEEP_TOPLEVEL
;
1701 dir
= opendir(path
->buf
);
1703 if (errno
== ENOENT
)
1704 return keep_toplevel
? -1 : 0;
1705 else if (errno
== EACCES
&& !keep_toplevel
)
1707 * An empty dir could be removable even if it
1710 return rmdir(path
->buf
);
1714 if (path
->buf
[original_len
- 1] != '/')
1715 strbuf_addch(path
, '/');
1718 while ((e
= readdir(dir
)) != NULL
) {
1720 if (is_dot_or_dotdot(e
->d_name
))
1723 strbuf_setlen(path
, len
);
1724 strbuf_addstr(path
, e
->d_name
);
1725 if (lstat(path
->buf
, &st
)) {
1726 if (errno
== ENOENT
)
1728 * file disappeared, which is what we
1733 } else if (S_ISDIR(st
.st_mode
)) {
1734 if (!remove_dir_recurse(path
, flag
, &kept_down
))
1735 continue; /* happy */
1736 } else if (!only_empty
&&
1737 (!unlink(path
->buf
) || errno
== ENOENT
)) {
1738 continue; /* happy, too */
1741 /* path too long, stat fails, or non-directory still exists */
1747 strbuf_setlen(path
, original_len
);
1748 if (!ret
&& !keep_toplevel
&& !kept_down
)
1749 ret
= (!rmdir(path
->buf
) || errno
== ENOENT
) ? 0 : -1;
1752 * report the uplevel that it is not an error that we
1753 * did not rmdir() our directory.
1759 int remove_dir_recursively(struct strbuf
*path
, int flag
)
1761 return remove_dir_recurse(path
, flag
, NULL
);
1764 void setup_standard_excludes(struct dir_struct
*dir
)
1769 dir
->exclude_per_dir
= ".gitignore";
1770 path
= git_path("info/exclude");
1771 if (!excludes_file
) {
1772 home_config_paths(NULL
, &xdg_path
, "ignore");
1773 excludes_file
= xdg_path
;
1775 if (!access_or_warn(path
, R_OK
, 0))
1776 add_excludes_from_file_1(dir
, path
,
1777 dir
->untracked
? &dir
->ss_info_exclude
: NULL
);
1778 if (excludes_file
&& !access_or_warn(excludes_file
, R_OK
, 0))
1779 add_excludes_from_file_1(dir
, excludes_file
,
1780 dir
->untracked
? &dir
->ss_excludes_file
: NULL
);
1783 int remove_path(const char *name
)
1787 if (unlink(name
) && errno
!= ENOENT
&& errno
!= ENOTDIR
)
1790 slash
= strrchr(name
, '/');
1792 char *dirs
= xstrdup(name
);
1793 slash
= dirs
+ (slash
- name
);
1796 } while (rmdir(dirs
) == 0 && (slash
= strrchr(dirs
, '/')));
1803 * Frees memory within dir which was allocated for exclude lists and
1804 * the exclude_stack. Does not free dir itself.
1806 void clear_directory(struct dir_struct
*dir
)
1809 struct exclude_list_group
*group
;
1810 struct exclude_list
*el
;
1811 struct exclude_stack
*stk
;
1813 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
1814 group
= &dir
->exclude_list_group
[i
];
1815 for (j
= 0; j
< group
->nr
; j
++) {
1818 free((char *)el
->src
);
1819 clear_exclude_list(el
);
1824 stk
= dir
->exclude_stack
;
1826 struct exclude_stack
*prev
= stk
->prev
;
1830 strbuf_release(&dir
->basebuf
);