ignore.h 1.74 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3 4 5 6 7 8 9 10 11
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
#ifndef INCLUDE_ignore_h__
#define INCLUDE_ignore_h__

#include "repository.h"
#include "vector.h"
12 13 14 15 16
#include "attr_file.h"

#define GIT_IGNORE_FILE			".gitignore"
#define GIT_IGNORE_FILE_INREPO	"info/exclude"
#define GIT_IGNORE_FILE_XDG		"ignore"
17

18 19 20 21 22 23 24
/* The git_ignores structure maintains three sets of ignores:
 * - internal ignores
 * - per directory ignores
 * - global ignores (at lower priority than the others)
 * As you traverse from one directory to another, you can push and pop
 * directories onto git_ignores list efficiently.
 */
25 26
typedef struct {
	git_repository *repo;
27
	git_buf dir; /* current directory reflected in ign_path */
28 29 30
	git_attr_file *ign_internal;
	git_vector ign_path;
	git_vector ign_global;
31
	int ignore_case;
32 33
} git_ignores;

34 35
extern int git_ignore__for_path(
	git_repository *repo, const char *path, git_ignores *ign);
36 37

extern int git_ignore__push_dir(git_ignores *ign, const char *dir);
38

39 40 41
extern int git_ignore__pop_dir(git_ignores *ign);

extern void git_ignore__free(git_ignores *ign);
42

43
extern int git_ignore__lookup(git_ignores *ign, const char *path, int *ignored);
44

45 46 47 48 49 50 51 52 53
/* command line Git sometimes generates an error message if given a
 * pathspec that contains an exact match to an ignored file (provided
 * --force isn't also given).  This makes it easy to check it that has
 * happened.  Returns GIT_EINVALIDSPEC if the pathspec contains ignored
 * exact matches (that are not already present in the index).
 */
extern int git_ignore__check_pathspec_for_exact_ignores(
	git_repository *repo, git_vector *pathspec, bool no_fnmatch);

54
#endif