thodg/libgit2/src/config.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/config.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_config_h__
  #define INCLUDE_config_h__
  
  #include "common.h"
  
  #include "git2.h"
  #include "git2/config.h"
  #include "vector.h"
  #include "repository.h"
  
  #define GIT_CONFIG_FILENAME_PROGRAMDATA "config"
  #define GIT_CONFIG_FILENAME_SYSTEM "gitconfig"
  #define GIT_CONFIG_FILENAME_GLOBAL ".gitconfig"
  #define GIT_CONFIG_FILENAME_XDG    "config"
  
  #define GIT_CONFIG_FILENAME_INREPO "config"
  #define GIT_CONFIG_FILE_MODE 0666
  
  struct git_config {
  	git_refcount rc;
  	git_vector backends;
  };
  
  extern int git_config__global_location(git_str *buf);
  
  extern int git_config__find_global(git_str *path);
  extern int git_config__find_xdg(git_str *path);
  extern int git_config__find_system(git_str *path);
  extern int git_config__find_programdata(git_str *path);
  
  extern int git_config_rename_section(
  	git_repository *repo,
  	const char *old_section_name,	/* eg "branch.dummy" */
  	const char *new_section_name);	/* NULL to drop the old section */
  
  extern int git_config__normalize_name(const char *in, char **out);
  
  /* internal only: does not normalize key and sets out to NULL if not found */
  extern int git_config__lookup_entry(
  	git_config_entry **out,
  	const git_config *cfg,
  	const char *key,
  	bool no_errors);
  
  /* internal only: update and/or delete entry string with constraints */
  extern int git_config__update_entry(
  	git_config *cfg,
  	const char *key,
  	const char *value,
  	bool overwrite_existing,
  	bool only_if_existing);
  
  int git_config__get_path(
  	git_str *out,
  	const git_config *cfg,
  	const char *name);
  
  int git_config__get_string_buf(
  	git_str *out, const git_config *cfg, const char *name);
  
  /*
   * Lookup functions that cannot fail.  These functions look up a config
   * value and return a fallback value if the value is missing or if any
   * failures occur while trying to access the value.
   */
  
  extern char *git_config__get_string_force(
  	const git_config *cfg, const char *key, const char *fallback_value);
  
  extern int git_config__get_bool_force(
  	const git_config *cfg, const char *key, int fallback_value);
  
  extern int git_config__get_int_force(
  	const git_config *cfg, const char *key, int fallback_value);
  
  /* API for repository configmap-style lookups from config - not cached, but
   * uses configmap value maps and fallbacks
   */
  extern int git_config__configmap_lookup(
  	int *out, git_config *config, git_configmap_item item);
  
  /**
   * The opposite of git_config_lookup_map_value, we take an enum value
   * and map it to the string or bool value on the config.
   */
  int git_config_lookup_map_enum(git_configmap_t *type_out,
  	const char **str_out, const git_configmap *maps,
  	size_t map_n, int enum_val);
  
  /**
   * Unlock the backend with the highest priority
   *
   * Unlocking will allow other writers to updat the configuration
   * file. Optionally, any changes performed since the lock will be
   * applied to the configuration.
   *
   * @param cfg the configuration
   * @param commit boolean which indicates whether to commit any changes
   * done since locking
   * @return 0 or an error code
   */
  GIT_EXTERN(int) git_config_unlock(git_config *cfg, int commit);
  
  #endif
  

Download