FilesExpand file tree

development

/

status.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

79 lines (69 loc) · 2.62 KB

development

/

status.h

Copy path

Top

File metadata and controls

• Code
• Blame

79 lines (69 loc) · 2.62 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

/*

* Copyright (C) 2009-2011 the libgit2 contributors

*

* 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_git_status_h__

#define INCLUDE_git_status_h__

#include "common.h"

#include "types.h"

/**

* @file git2/status.h

* @brief Git file status routines

* @defgroup git_status Git file status routines

* @ingroup Git

* @{

*/

GIT_BEGIN_DECL

#define GIT_STATUS_CURRENT 0

/** Flags for index status */

#define GIT_STATUS_INDEX_NEW (1 << 0)

#define GIT_STATUS_INDEX_MODIFIED (1 << 1)

#define GIT_STATUS_INDEX_DELETED (1 << 2)

/** Flags for worktree status */

#define GIT_STATUS_WT_NEW (1 << 3)

#define GIT_STATUS_WT_MODIFIED (1 << 4)

#define GIT_STATUS_WT_DELETED (1 << 5)

#define GIT_STATUS_IGNORED (1 << 6)

/**

* Gather file statuses and run a callback for each one.

*

* The callback is passed the path of the file, the status and the data pointer

* passed to this function. If the callback returns something other than

* GIT_SUCCESS, this function will return that value.

*

* @param repo a repository object

* @param callback the function to call on each file

* @return GIT_SUCCESS or the return value of the callback which did not return GIT_SUCCESS

*/

GIT_EXTERN(int) git_status_foreach(git_repository *repo, int (*callback)(const char *, unsigned int, void *), void *payload);

/**

* Get file status for a single file

*

* @param status_flags the status value

* @param repo a repository object

* @param path the file to retrieve status for, rooted at the repo's workdir

* @return GIT_EINVALIDPATH when `path` points at a folder, GIT_ENOTFOUND when

* the file doesn't exist in any of HEAD, the index or the worktree,

* GIT_SUCCESS otherwise

*/

GIT_EXTERN(int) git_status_file(unsigned int *status_flags, git_repository *repo, const char *path);

/**

* Test if the ignore rules apply to a given file.

*

* This function simply checks the ignore rules to see if they would apply

* to the given file. Unlike git_status_file(), this indicates if the file

* would be ignored regardless of whether the file is already in the index

* or in the repository.

*

* @param repo a repository object

* @param path the file to check ignores for, rooted at the repo's workdir

* @param ignored boolean returning 0 if the file is not ignored, 1 if it is

* @return GIT_SUCCESS if the ignore rules could be processed for the file

* (regardless of whether it exists or not), or an error < 0 if they could not.

*/

GIT_EXTERN(int) git_status_should_ignore(git_repository *repo, const char *path, int *ignored);

/** @} */

GIT_END_DECL

#endif