thodg/libgit2/src/config.h

• Show log

  Commit

• Hash : 9f77b3f6
  Author :
  Date : 2013-11-25T14:21:34
  

  Add config read fns with controlled error behavior
  
  This adds `git_config__lookup_entry` which will look up a key in
  a config and return either the entry or NULL if the key was not
  present.  Optionally, it can either suppress all errors or can
  return them (although not finding the key is not an error for this
  function).  Unlike other accessors, this does not normalize the
  config key string, so it must only be used when the key is known
  to be in normalized form (i.e. all lower-case before the first dot
  and after the last dot, with no invalid characters).
  
  This also adds three high-level helper functions to look up config
  values with no errors and a fallback value.  The three functions
  are for string, bool, and int values, and will resort to the
  fallback value for any error that arises.  They are:
  
  * `git_config__get_string_force`
  * `git_config__get_bool_force`
  * `git_config__get_int_force`
  
  None of them normalize the config `key` either, so they can only
  be used for internal cases where the key is known to be in normal
  format.
  

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 "git2.h"
  #include "git2/config.h"
  #include "vector.h"
  #include "repository.h"
  
  #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 files;
  };
  
  extern int git_config_find_global_r(git_buf *global_config_path);
  extern int git_config_find_xdg_r(git_buf *system_config_path);
  extern int git_config_find_system_r(git_buf *system_config_path);
  
  
  extern int git_config__global_location(git_buf *buf);
  
  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 */
  
  /**
   * Create a configuration file backend for ondisk files
   *
   * These are the normal `.gitconfig` files that Core Git
   * processes. Note that you first have to add this file to a
   * configuration object before you can query it for configuration
   * variables.
   *
   * @param out the new backend
   * @param path where the config file is located
   */
  extern int git_config_file__ondisk(git_config_backend **out, const char *path);
  
  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(
  	const git_config_entry **out,
  	const git_config *cfg,
  	const char *key,
  	bool no_errors);
  
  /*
   * 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 const 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);
  
  #endif
  

Download