thodg/libgit2/src/git/tag.h

• Show log

  Commit

• Hash : 58519018
  Author :
  Date : 2010-10-28T02:07:18
  

  Fix internal memory management on the library String mememory is now managed in a much more sane manner. Fixes include: - git_person email and name is no longer limited to 64 characters - git_tree_entry filename is no longer limited to 255 characters - raw objects are properly opened & closed the minimum amount of times required for parsing - unit tests no longer leak - removed 5 other misc memory leaks as reported by Valgrind - tree writeback no longer segfaults on rare ocassions The git_person struct is no longer public. It is now managed by the library, and getter methods are in place to access its internal attributes. Signed-off-by: Vicent Marti <tanoku@gmail.com>

Download

• src/git/tag.h

• #ifndef INCLUDE_git_tag_h__
  #define INCLUDE_git_tag_h__
  
  #include "common.h"
  #include "oid.h"
  #include "tree.h"
  #include "repository.h"
  
  /**
   * @file git/tag.h
   * @brief Git tag parsing routines
   * @defgroup git_tag Git tag management
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /** Parsed representation of a tag object. */
  typedef struct git_tag git_tag;
  
  /**
   * Lookup a tag object from the repository.
   * The generated tag object is owned by the revision
   * repo and shall not be freed by the user.
   *
   * @param repo the repo to use when locating the tag.
   * @param id identity of the tag to locate.
   * @return the tag; NULL if the tag could not be created
   */
  GIT_EXTERN(git_tag *) git_tag_lookup(git_repository *repo, const git_oid *id);
  
  /**
   * Create a new in-memory git_tag.
   *
   * The tag object must be manually filled using
   * setter methods before it can be written to its
   * repository.
   *
   * @param repo The repository where the object will reside
   * @return the object if creation was possible; NULL otherwise
   */
  GIT_EXTERN(git_tag *) git_tag_new(git_repository *repo);
  
  /**
   * Get the id of a tag.
   * @param tag a previously loaded tag.
   * @return object identity for the tag.
   */
  GIT_EXTERN(const git_oid *) git_tag_id(git_tag *tag);
  
  /**
   * Get the tagged object of a tag
   * @param tag a previously loaded tag.
   * @return reference to a repository object
   */
  GIT_EXTERN(const git_object *) git_tag_target(git_tag *t);
  
  /**
   * Get the type of a tag's tagged object
   * @param tag a previously loaded tag.
   * @return type of the tagged object
   */
  GIT_EXTERN(git_otype) git_tag_type(git_tag *t);
  
  /**
   * Get the name of a tag
   * @param tag a previously loaded tag.
   * @return name of the tag
   */
  GIT_EXTERN(const char *) git_tag_name(git_tag *t);
  
  /**
   * Get the tagger (author) of a tag
   * @param tag a previously loaded tag.
   * @return reference to the tag's author
   */
  GIT_EXTERN(const git_person *) git_tag_tagger(git_tag *t);
  
  /**
   * Get the message of a tag
   * @param tag a previously loaded tag.
   * @return message of the tag
   */
  GIT_EXTERN(const char *) git_tag_message(git_tag *t);
  
  /**
   * Set the target of a tag (i.e. the object that the tag points to)
   * @param tag The tag to modify
   * @param target the new tagged target
   */
  GIT_EXTERN(void) git_tag_set_target(git_tag *tag, git_object *target);
  
  /**
   * Set the name of a tag
   * @param tag The tag to modify
   * @param name the new name for the tag
   */
  GIT_EXTERN(void) git_tag_set_name(git_tag *tag, const char *name);
  
  /**
   * Set the tagger of a tag
   * @param tag The tag to modify
   * @param name the name of the new tagger
   * @param email the email of the new tagger
   * @param time the time when the tag was created
   */
  GIT_EXTERN(void) git_tag_set_tagger(git_tag *tag, const char *name, const char *email, time_t time);
  
  /**
   * Set the message of a tag
   * @param tag The tag to modify
   * @param message the new tagger for the tag
   */
  GIT_EXTERN(void) git_tag_set_message(git_tag *tag, const char *message);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download