thodg/libgit2/src/patch.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/patch.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_patch_h__
  #define INCLUDE_patch_h__
  
  #include "common.h"
  
  #include "git2/patch.h"
  #include "array.h"
  
  /* cached information about a hunk in a patch */
  typedef struct git_patch_hunk {
  	git_diff_hunk hunk;
  	size_t line_start;
  	size_t line_count;
  } git_patch_hunk;
  
  struct git_patch {
  	git_refcount rc;
  
  	git_repository *repo; /* may be null */
  
  	git_diff_options diff_opts;
  
  	git_diff_delta *delta;
  	git_diff_binary binary;
  	git_array_t(git_patch_hunk) hunks;
  	git_array_t(git_diff_line) lines;
  
  	size_t header_size;
  	size_t content_size;
  	size_t context_size;
  
  	void (*free_fn)(git_patch *patch);
  };
  
  extern int git_patch__invoke_callbacks(
  	git_patch *patch,
  	git_diff_file_cb file_cb,
  	git_diff_binary_cb binary_cb,
  	git_diff_hunk_cb hunk_cb,
  	git_diff_line_cb line_cb,
  	void *payload);
  
  extern int git_patch_line_stats(
  	size_t *total_ctxt,
  	size_t *total_adds,
  	size_t *total_dels,
  	const git_patch *patch);
  
  /** Options for parsing patch files. */
  typedef struct {
  	/**
  	 * The length of the prefix (in path segments) for the filenames.
  	 * This prefix will be removed when looking for files.  The default is 1.
  	 */
  	uint32_t prefix_len;
  } git_patch_options;
  
  #define GIT_PATCH_OPTIONS_INIT { 1 }
  
  extern int git_patch__to_buf(git_str *out, git_patch *patch);
  extern void git_patch_free(git_patch *patch);
  
  #endif
  

Download