thodg/libgit2/src/net.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/net.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_net_h__
  #define INCLUDE_net_h__
  
  #include "common.h"
  
  typedef struct git_net_url {
  	char *scheme;
  	char *host;
  	char *port;
  	char *path;
  	char *query;
  	char *username;
  	char *password;
  } git_net_url;
  
  #define GIT_NET_URL_INIT { NULL }
  
  /** Duplicate a URL */
  extern int git_net_url_dup(git_net_url *out, git_net_url *in);
  
  /** Parses a string containing a URL into a structure.  */
  extern int git_net_url_parse(git_net_url *url, const char *str);
  
  /** Appends a path and/or query string to the given URL */
  extern int git_net_url_joinpath(
  	git_net_url *out,
  	git_net_url *in,
  	const char *path);
  
  /** Ensures that a URL is minimally valid (contains a host, port and path) */
  extern bool git_net_url_valid(git_net_url *url);
  
  /** Returns true if the URL is on the default port. */
  extern bool git_net_url_is_default_port(git_net_url *url);
  
  /** Returns true if the host portion of the URL is an ipv6 address. */
  extern bool git_net_url_is_ipv6(git_net_url *url);
  
  /* Applies a redirect to the URL with a git-aware service suffix. */
  extern int git_net_url_apply_redirect(
  	git_net_url *url,
  	const char *redirect_location,
  	const char *service_suffix);
  
  /** Swaps the contents of one URL for another.  */
  extern void git_net_url_swap(git_net_url *a, git_net_url *b);
  
  /** Places the URL into the given buffer. */
  extern int git_net_url_fmt(git_str *out, git_net_url *url);
  
  /** Place the path and query string into the given buffer. */
  extern int git_net_url_fmt_path(git_str *buf, git_net_url *url);
  
  /** Determines if the url matches given pattern or pattern list */
  extern bool git_net_url_matches_pattern(
  	git_net_url *url,
  	const char *pattern);
  extern bool git_net_url_matches_pattern_list(
  	git_net_url *url,
  	const char *pattern_list);
  
  /** Disposes the contents of the structure. */
  extern void git_net_url_dispose(git_net_url *url);
  
  #endif
  

Download