thodg/libgit2/src/trace.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/trace.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_trace_h__
  #define INCLUDE_trace_h__
  
  #include "common.h"
  
  #include <git2/trace.h>
  #include "str.h"
  
  #ifdef GIT_TRACE
  
  struct git_trace_data {
  	git_trace_level_t level;
  	git_trace_cb callback;
  };
  
  extern struct git_trace_data git_trace__data;
  
  GIT_INLINE(void) git_trace__write_fmt(
  	git_trace_level_t level,
  	const char *fmt,
  	va_list ap)
  {
  	git_trace_cb callback = git_trace__data.callback;
  	git_str message = GIT_STR_INIT;
  
  	git_str_vprintf(&message, fmt, ap);
  
  	callback(level, git_str_cstr(&message));
  
  	git_str_dispose(&message);
  }
  
  #define git_trace_level()	(git_trace__data.level)
  
  GIT_INLINE(void) git_trace(git_trace_level_t level, const char *fmt, ...)
  {
  	if (git_trace__data.level >= level &&
  	    git_trace__data.callback != NULL) {
  		va_list ap;
  
  		va_start(ap, fmt);
  		git_trace__write_fmt(level, fmt, ap);
  		va_end(ap);
  	}
  }
  
  #else
  
  GIT_INLINE(void) git_trace__null(
  	git_trace_level_t level,
  	const char *fmt, ...)
  {
  	GIT_UNUSED(level);
  	GIT_UNUSED(fmt);
  }
  
  #define git_trace_level()	((git_trace_level_t)0)
  #define git_trace		git_trace__null
  
  #endif
  
  #endif
  

Download