]> git.proxmox.com Git - libgit2.git/blobdiff - src/filter.h
New upstream version 1.4.3+dfsg.1
[libgit2.git] / src / filter.h
index a4ee2172d7b541aa8ca774c558be81e2da2cc3b8..58cb4b42407c96ef49270c21ee02cbc421a71407 100644 (file)
@@ -8,81 +8,78 @@
 #define INCLUDE_filter_h__
 
 #include "common.h"
-#include "buffer.h"
-#include "array.h"
-#include "git2/odb.h"
-#include "git2/repository.h"
+
+#include "attr_file.h"
 #include "git2/filter.h"
 #include "git2/sys/filter.h"
 
-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;
+/* Amount of file to examine for NUL byte when checking binary-ness */
+#define GIT_FILTER_BYTES_TO_CHECK_NUL 8000
 
-typedef struct git_filter_list git_filter_list;
+typedef struct {
+       git_filter_options options;
+       git_attr_session *attr_session;
+       git_str *temp_buf;
+} git_filter_session;
 
-/*
- * FILTER API
- */
+#define GIT_FILTER_SESSION_INIT {GIT_FILTER_OPTIONS_INIT, 0}
 
-/*
- * For any given path in the working directory, create a `git_filter_list`
- * with the relevant filters that need to be applied.
- *
- * This will return 0 (success) but set the output git_filter_list to NULL
- * if no filters are requested for the given file.
- *
- * @param filters Output newly created git_filter_list (or NULL)
- * @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 0 on success (which could still return NULL if no filters are
- *         needed for the requested file), <0 on error
- */
-extern int git_filter_list_load(
+extern int git_filter_global_init(void);
+
+extern void git_filter_free(git_filter *filter);
+
+extern int git_filter_list__load(
        git_filter_list **filters,
        git_repository *repo,
+       git_blob *blob, /* can be NULL */
        const char *path,
-       git_filter_mode_t mode);
+       git_filter_mode_t mode,
+       git_filter_session *filter_session);
 
-/*
- * Apply one or more filters to a data buffer.
- *
- * The source data 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 An already loaded git_filter_list
- * @return 0 on success, an error code otherwise
- */
-extern int git_filter_list_apply(
-       git_buf *dest,
-       git_buf *source,
-       git_filter_list *filters);
+int git_filter_list__apply_to_buffer(
+       git_str *out,
+       git_filter_list *filters,
+       const char *in,
+       size_t in_len);
+int git_filter_list__apply_to_file(
+       git_str *out,
+       git_filter_list *filters,
+       git_repository *repo,
+       const char *path);
+int git_filter_list__apply_to_blob(
+       git_str *out,
+       git_filter_list *filters,
+       git_blob *blob);
 
 /*
- * Free the git_filter_list
- *
- * @param filters A git_filter_list created by `git_filter_list_load`
+ * The given input buffer will be converted to the given output buffer.
+ * The input buffer will be freed (_if_ it was allocated).
  */
-extern void git_filter_list_free(git_filter_list *filters);
+extern int git_filter_list__convert_buf(
+       git_str *out,
+       git_filter_list *filters,
+       git_str *in);
+
+extern int git_filter_list__apply_to_file(
+       git_str *out,
+       git_filter_list *filters,
+       git_repository *repo,
+       const char *path);
 
 /*
  * Available filters
  */
 
 extern git_filter *git_crlf_filter_new(void);
+extern git_filter *git_ident_filter_new(void);
+
+extern int git_filter_buffered_stream_new(
+       git_writestream **out,
+       git_filter *filter,
+       int (*write_fn)(git_filter *, void **, git_str *, const git_str *, const git_filter_source *),
+       git_str *temp_buf,
+       void **payload,
+       const git_filter_source *source,
+       git_writestream *target);
 
 #endif