thodg/libgit2/include/git2/signature.h

• Show log

  Commit

• Hash : e3dcaca5
  Author :
  Date : 2018-03-17T18:15:01
  

  mailmap: Integrate mailmaps with blame and signatures

Download

• include/git2/signature.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_git_signature_h__
  #define INCLUDE_git_signature_h__
  
  #include "common.h"
  #include "types.h"
  
  /**
   * @file git2/signature.h
   * @brief Git signature creation
   * @defgroup git_signature Git signature creation
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * Create a new action signature.
   *
   * Call `git_signature_free()` to free the data.
   *
   * Note: angle brackets ('<' and '>') characters are not allowed
   * to be used in either the `name` or the `email` parameter.
   *
   * @param out new signature, in case of error NULL
   * @param name name of the person
   * @param email email of the person
   * @param time time when the action happened
   * @param offset timezone offset in minutes for the time
   * @return 0 or an error code
   */
  GIT_EXTERN(int) git_signature_new(git_signature **out, const char *name, const char *email, git_time_t time, int offset);
  
  /**
   * Create a new action signature with a timestamp of 'now'.
   *
   * Call `git_signature_free()` to free the data.
   *
   * @param out new signature, in case of error NULL
   * @param name name of the person
   * @param email email of the person
   * @return 0 or an error code
   */
  GIT_EXTERN(int) git_signature_now(git_signature **out, const char *name, const char *email);
  
  /**
   * Create a new action signature with default user and now timestamp.
   *
   * This looks up the user.name and user.email from the configuration and
   * uses the current time as the timestamp, and creates a new signature
   * based on that information.  It will return GIT_ENOTFOUND if either the
   * user.name or user.email are not set.
   *
   * @param out new signature
   * @param repo repository pointer
   * @return 0 on success, GIT_ENOTFOUND if config is missing, or error code
   */
  GIT_EXTERN(int) git_signature_default(git_signature **out, git_repository *repo);
  
  /**
   * Create a new signature by parsing the given buffer, which is
   * expected to be in the format "Real Name <email> timestamp tzoffset",
   * where `timestamp` is the number of seconds since the Unix epoch and
   * `tzoffset` is the timezone offset in `hhmm` format (note the lack
   * of a colon separator).
   *
   * @param out new signature
   * @param buf signature string
   * @return 0 on success, or an error code
   */
  GIT_EXTERN(int) git_signature_from_buffer(git_signature **out, const char *buf);
  
  /**
   * Create a signature with names updated respecting the mailmap.
   *
   * Call `git_signature_free()` to free the data.
   *
   * @param out new signature
   * @param sig signature to resolve
   * @param mailmap mailmap to resolve with
   * @return 0 or an error code
   */
  GIT_EXTERN(int) git_signature_with_mailmap(git_signature **out, const git_signature *sig, const git_mailmap *mailmap);
  
  /**
   * Create a copy of an existing signature.  All internal strings are also
   * duplicated.
   *
   * Call `git_signature_free()` to free the data.
   *
   * @param dest pointer where to store the copy
   * @param sig signature to duplicate
   * @return 0 or an error code
   */
  GIT_EXTERN(int) git_signature_dup(git_signature **dest, const git_signature *sig);
  
  /**
   * Free an existing signature.
   *
   * Because the signature is not an opaque structure, it is legal to free it
   * manually, but be sure to free the "name" and "email" strings in addition
   * to the structure itself.
   *
   * @param sig signature to free
   */
  GIT_EXTERN(void) git_signature_free(git_signature *sig);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download