src/filter.h

   1 /*
   2  * Copyright (C) the libgit2 contributors. All rights reserved.
   3  *
   4  * This file is part of libgit2, distributed under the GNU GPL v2 with
   5  * a Linking Exception. For full terms see the included COPYING file.
   6  */
   7 #ifndef INCLUDE_filter_h__
   8 #define INCLUDE_filter_h__
   9
  10 #include "common.h"
  11
  12 #include "attr_file.h"
  13 #include "git2/filter.h"
  14 #include "git2/sys/filter.h"
  15
  16 /* Amount of file to examine for NUL byte when checking binary-ness */
  17 #define GIT_FILTER_BYTES_TO_CHECK_NUL 8000
  18
  19 typedef struct {
  20         git_filter_options options;
  21         git_attr_session *attr_session;
  22         git_str *temp_buf;
  23 } git_filter_session;
  24
  25 #define GIT_FILTER_SESSION_INIT {GIT_FILTER_OPTIONS_INIT, 0}
  26
  27 extern int git_filter_global_init(void);
  28
  29 extern void git_filter_free(git_filter *filter);
  30
  31 extern int git_filter_list__load(
  32         git_filter_list **filters,
  33         git_repository *repo,
  34         git_blob *blob, /* can be NULL */
  35         const char *path,
  36         git_filter_mode_t mode,
  37         git_filter_session *filter_session);
  38
  39 int git_filter_list__apply_to_buffer(
  40         git_str *out,
  41         git_filter_list *filters,
  42         const char *in,
  43         size_t in_len);
  44 int git_filter_list__apply_to_file(
  45         git_str *out,
  46         git_filter_list *filters,
  47         git_repository *repo,
  48         const char *path);
  49 int git_filter_list__apply_to_blob(
  50         git_str *out,
  51         git_filter_list *filters,
  52         git_blob *blob);
  53
  54 /*
  55  * The given input buffer will be converted to the given output buffer.
  56  * The input buffer will be freed (_if_ it was allocated).
  57  */
  58 extern int git_filter_list__convert_buf(
  59         git_str *out,
  60         git_filter_list *filters,
  61         git_str *in);
  62
  63 extern int git_filter_list__apply_to_file(
  64         git_str *out,
  65         git_filter_list *filters,
  66         git_repository *repo,
  67         const char *path);
  68
  69 /*
  70  * Available filters
  71  */
  72
  73 extern git_filter *git_crlf_filter_new(void);
  74 extern git_filter *git_ident_filter_new(void);
  75
  76 extern int git_filter_buffered_stream_new(
  77         git_writestream **out,
  78         git_filter *filter,
  79         int (*write_fn)(git_filter *, void **, git_str *, const git_str *, const git_filter_source *),
  80         git_str *temp_buf,
  81         void **payload,
  82         const git_filter_source *source,
  83         git_writestream *target);
  84
  85 #endif