FilesExpand file tree

development

/

filter.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

119 lines (102 loc) · 3.43 KB

development

/

filter.h

Copy path

Top

File metadata and controls

• Code
• Blame

119 lines (102 loc) · 3.43 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

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

/*

* Copyright (C) 2009-2012 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_filter_h__

#define INCLUDE_filter_h__

#include "common.h"

#include "buffer.h"

#include "git2/odb.h"

#include "git2/repository.h"

typedef struct git_filter {

int (*apply)(struct git_filter *self, git_buf *dest, const git_buf *source);

void (*do_free)(struct git_filter *self);

} git_filter;

typedef enum {

GIT_FILTER_TO_WORKTREE,

GIT_FILTER_TO_ODB

} git_filter_mode;

typedef enum {

GIT_CRLF_GUESS = -1,

GIT_CRLF_BINARY = 0,

GIT_CRLF_TEXT,

GIT_CRLF_INPUT,

GIT_CRLF_CRLF,

GIT_CRLF_AUTO,

} git_crlf_t;

typedef struct {

/* NUL, CR, LF and CRLF counts */

unsigned int nul, cr, lf, crlf;

/* These are just approximations! */

unsigned int printable, nonprintable;

} git_text_stats;

/*

* FILTER API

*/

/*

* For any given path in the working directory, fill the `filters`

* array with the relevant filters that need to be applied.

*

* Mode is either `GIT_FILTER_TO_WORKTREE` if you need to load the

* filters that will be used when checking out a file to the working

* directory, or `GIT_FILTER_TO_ODB` for the filters used when writing

* a file to the ODB.

*

* @param filters Vector where to store all the loaded filters

* @param repo Repository object that contains `path`

* @param path Relative path of the file to be filtered

* @param mode Filtering direction (WT->ODB or ODB->WT)

* @return the number of filters loaded for the file (0 if the file

* doesn't need filtering), or a negative error code

*/

extern int git_filters_load(git_vector *filters, git_repository *repo, const char *path, int mode);

/*

* Apply one or more filters to a file.

*

* The file must have been loaded as a `git_buf` object. Both the `source`

* and `dest` buffers are owned by the caller and must be freed once

* they are no longer needed.

*

* NOTE: Because of the double-buffering schema, the `source` buffer that contains

* the original file may be tampered once the filtering is complete. Regardless,

* the `dest` buffer will always contain the final result of the filtering

*

* @param dest Buffer to store the result of the filtering

* @param source Buffer containing the document to filter

* @param filters A non-empty vector of filters as supplied by `git_filters_load`

* @return GIT_SUCCESS on success, an error code otherwise

*/

extern int git_filters_apply(git_buf *dest, git_buf *source, git_vector *filters);

/*

* Free the `filters` array generated by `git_filters_load`.

*

* Note that this frees both the array and its contents. The array will

* be clean/reusable after this call.

*

* @param filters A filters array as supplied by `git_filters_load`

*/

extern void git_filters_free(git_vector *filters);

/*

* Available filters

*/

/* Strip CRLF, from Worktree to ODB */

extern int git_filter_add__crlf_to_odb(git_vector *filters, git_repository *repo, const char *path);

/*

* PLAINTEXT API

*/

/*

* Gather stats for a piece of text

*

* Fill the `stats` structure with information on the number of

* unreadable characters, carriage returns, etc, so it can be

* used in heuristics.

*/

extern void git_text_gather_stats(git_text_stats *stats, const git_buf *text);

/*

* Process `git_text_stats` data generated by `git_text_stat` to see

* if it qualifies as a binary file

*/

extern int git_text_is_binary(git_text_stats *stats);

#endif