thodg/libgit2/src/zstream.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/zstream.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_zstream_h__
  #define INCLUDE_zstream_h__
  
  #include "common.h"
  
  #include <zlib.h>
  
  #include "str.h"
  
  typedef enum {
  	GIT_ZSTREAM_INFLATE,
  	GIT_ZSTREAM_DEFLATE,
  } git_zstream_t;
  
  typedef struct {
  	z_stream z;
  	git_zstream_t type;
  	const char *in;
  	size_t in_len;
  	int flush;
  	int zerr;
  } git_zstream;
  
  #define GIT_ZSTREAM_INIT {{0}}
  
  int git_zstream_init(git_zstream *zstream, git_zstream_t type);
  void git_zstream_free(git_zstream *zstream);
  
  int git_zstream_set_input(git_zstream *zstream, const void *in, size_t in_len);
  
  size_t git_zstream_suggest_output_len(git_zstream *zstream);
  
  /* get as much output as is available in the input buffer */
  int git_zstream_get_output_chunk(
  	void *out, size_t *out_len, git_zstream *zstream);
  
  /* get all the output from the entire input buffer */
  int git_zstream_get_output(void *out, size_t *out_len, git_zstream *zstream);
  
  bool git_zstream_done(git_zstream *zstream);
  bool git_zstream_eos(git_zstream *zstream);
  
  void git_zstream_reset(git_zstream *zstream);
  
  int git_zstream_deflatebuf(git_str *out, const void *in, size_t in_len);
  int git_zstream_inflatebuf(git_str *out, const void *in, size_t in_len);
  
  #endif
  

Download