thodg/libgit2/tests/checkout/checkout_helpers.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

• tests/checkout/checkout_helpers.h

• #include "git2/object.h"
  #include "git2/repository.h"
  
  extern void assert_on_branch(git_repository *repo, const char *branch);
  extern void reset_index_to_treeish(git_object *treeish);
  
  #define check_file_contents(PATH,EXP) \
  	cl_assert_equal_file(EXP,0,PATH)
  
  #define check_file_contents_nocr(PATH,EXP) \
  	cl_assert_equal_file_ignore_cr(EXP,0,PATH)
  
  typedef struct {
  	int n_conflicts;
  	int n_dirty;
  	int n_updates;
  	int n_untracked;
  	int n_ignored;
  	int debug;
  } checkout_counts;
  
  extern int checkout_count_callback(
  	git_checkout_notify_t why,
  	const char *path,
  	const git_diff_file *baseline,
  	const git_diff_file *target,
  	const git_diff_file *workdir,
  	void *payload);
  
  extern void tick_index(git_index *index);
  

Download