thodg/libgit2/src/remote.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/remote.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_remote_h__
  #define INCLUDE_remote_h__
  
  #include "common.h"
  
  #include "git2/remote.h"
  #include "git2/transport.h"
  #include "git2/sys/transport.h"
  
  #include "refspec.h"
  #include "vector.h"
  #include "net.h"
  
  #define GIT_REMOTE_ORIGIN "origin"
  
  struct git_remote {
  	char *name;
  	char *url;
  	char *pushurl;
  	git_vector refs;
  	git_vector refspecs;
  	git_vector active_refspecs;
  	git_vector passive_refspecs;
  	git_transport *transport;
  	git_repository *repo;
  	git_push *push;
  	git_indexer_progress stats;
  	unsigned int need_pack;
  	git_remote_autotag_option_t download_tags;
  	int prune_refs;
  	int passed_refspecs;
  };
  
  typedef struct git_remote_connection_opts {
  	const git_strarray *custom_headers;
  	const git_proxy_options *proxy;
  } git_remote_connection_opts;
  
  #define GIT_REMOTE_CONNECTION_OPTIONS_INIT { NULL, NULL }
  
  int git_remote__connect(git_remote *remote, git_direction direction, const git_remote_callbacks *callbacks, const git_remote_connection_opts *conn);
  
  int git_remote__urlfordirection(git_str *url_out, struct git_remote *remote, int direction, const git_remote_callbacks *callbacks);
  int git_remote__http_proxy(char **out, git_remote *remote, git_net_url *url);
  
  git_refspec *git_remote__matching_refspec(git_remote *remote, const char *refname);
  git_refspec *git_remote__matching_dst_refspec(git_remote *remote, const char *refname);
  
  int git_remote__default_branch(git_str *out, git_remote *remote);
  
  #endif
  

Download