thodg/libgit2/src/filter.h

• Show log

  Commit

• Hash : f0e693b1
  Author :
  Date : 2021-09-07T17:53:49
  

  str: introduce `git_str` for internal, `git_buf` is external libgit2 has two distinct requirements that were previously solved by `git_buf`. We require: 1. A general purpose string class that provides a number of utility APIs for manipulating data (eg, concatenating, truncating, etc). 2. A structure that we can use to return strings to callers that they can take ownership of. By using a single class (`git_buf`) for both of these purposes, we have confused the API to the point that refactorings are difficult and reasoning about correctness is also difficult. Move the utility class `git_buf` to be called `git_str`: this represents its general purpose, as an internal string buffer class. The name also is an homage to Junio Hamano ("gitstr"). The public API remains `git_buf`, and has a much smaller footprint. It is generally only used as an "out" param with strict requirements that follow the documentation. (Exceptions exist for some legacy APIs to avoid breaking callers unnecessarily.) Utility functions exist to convert a user-specified `git_buf` to a `git_str` so that we can call internal functions, then converting it back again.

Download

• src/filter.h

• /*
   * 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.
   */
  #ifndef INCLUDE_filter_h__
  #define INCLUDE_filter_h__
  
  #include "common.h"
  
  #include "attr_file.h"
  #include "git2/filter.h"
  #include "git2/sys/filter.h"
  
  /* Amount of file to examine for NUL byte when checking binary-ness */
  #define GIT_FILTER_BYTES_TO_CHECK_NUL 8000
  
  typedef struct {
  	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);
  
  /*
   * 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_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
  

Download