]> git.proxmox.com Git - libgit2.git/blobdiff - src/filter.h
New upstream version 1.4.3+dfsg.1
[libgit2.git] / src / filter.h
index 66e370aef5a976bbcb4d3854e7a44c46718c4f22..58cb4b42407c96ef49270c21ee02cbc421a71407 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2012 the libgit2 contributors
+ * Copyright (C) the libgit2 contributors. All rights reserved.
  *
  * This file is part of libgit2, distributed under the GNU GPL v2 with
  * a Linking Exception. For full terms see the included COPYING file.
 #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;
+#include "attr_file.h"
+#include "git2/filter.h"
+#include "git2/sys/filter.h"
 
-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;
+/* Amount of file to examine for NUL byte when checking binary-ness */
+#define GIT_FILTER_BYTES_TO_CHECK_NUL 8000
 
 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);
+       git_filter_options options;
+       git_attr_session *attr_session;
+       git_str *temp_buf;
+} git_filter_session;
+
+#define GIT_FILTER_SESSION_INIT {GIT_FILTER_OPTIONS_INIT, 0}
+
+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_session *filter_session);
+
+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);
 
 /*
- * 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 0 on success, an error code otherwise
+ * The given input buffer will be converted to the given output buffer.
+ * The input buffer will be freed (_if_ it was allocated).
  */
-extern int git_filters_apply(git_buf *dest, git_buf *source, git_vector *filters);
+extern int git_filter_list__convert_buf(
+       git_str *out,
+       git_filter_list *filters,
+       git_str *in);
 
-/*
- * 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);
+extern int git_filter_list__apply_to_file(
+       git_str *out,
+       git_filter_list *filters,
+       git_repository *repo,
+       const char *path);
 
 /*
  * 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);
+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