thodg/libgit2/src/commit.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/commit.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_commit_h__
  #define INCLUDE_commit_h__
  
  #include "common.h"
  
  #include "git2/commit.h"
  #include "tree.h"
  #include "repository.h"
  #include "array.h"
  
  #include <time.h>
  
  struct git_commit {
  	git_object object;
  
  	git_array_t(git_oid) parent_ids;
  	git_oid tree_id;
  
  	git_signature *author;
  	git_signature *committer;
  
  	char *message_encoding;
  	char *raw_message;
  	char *raw_header;
  
  	char *summary;
  	char *body;
  };
  
  int git_commit__header_field(
  	git_str *out,
  	const git_commit *commit,
  	const char *field);
  
  int git_commit__extract_signature(
  	git_str *signature,
  	git_str *signed_data,
  	git_repository *repo,
  	git_oid *commit_id,
  	const char *field);
  
  int git_commit__create_buffer(
  	git_str *out,
  	git_repository *repo,
  	const git_signature *author,
  	const git_signature *committer,
  	const char *message_encoding,
  	const char *message,
  	const git_tree *tree,
  	size_t parent_count,
  	const git_commit *parents[]);
  
  void git_commit__free(void *commit);
  int git_commit__parse(void *commit, git_odb_object *obj);
  int git_commit__parse_raw(void *commit, const char *data, size_t size);
  
  typedef enum {
  	GIT_COMMIT_PARSE_QUICK = (1 << 0), /**< Only parse parents and committer info */
  } git_commit__parse_flags;
  
  int git_commit__parse_ext(git_commit *commit, git_odb_object *odb_obj, unsigned int flags);
  
  #endif
  

Download