thodg/libgit2/src/hash.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/hash.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_hash_h__
  #define INCLUDE_hash_h__
  
  #include "common.h"
  
  #include "git2/oid.h"
  #include "hash/sha1.h"
  
  typedef struct {
  	void *data;
  	size_t len;
  } git_str_vec;
  
  typedef enum {
  	GIT_HASH_ALGORITHM_NONE = 0,
  	GIT_HASH_ALGORITHM_SHA1
  } git_hash_algorithm_t;
  
  typedef struct git_hash_ctx {
  	union {
  		git_hash_sha1_ctx sha1;
  	} ctx;
  	git_hash_algorithm_t algorithm;
  } git_hash_ctx;
  
  int git_hash_global_init(void);
  
  int git_hash_ctx_init(git_hash_ctx *ctx, git_hash_algorithm_t algorithm);
  void git_hash_ctx_cleanup(git_hash_ctx *ctx);
  
  int git_hash_init(git_hash_ctx *c);
  int git_hash_update(git_hash_ctx *c, const void *data, size_t len);
  int git_hash_final(unsigned char *out, git_hash_ctx *c);
  
  int git_hash_buf(unsigned char *out, const void *data, size_t len, git_hash_algorithm_t algorithm);
  int git_hash_vec(unsigned char *out, git_str_vec *vec, size_t n, git_hash_algorithm_t algorithm);
  
  #endif
  

Download