thodg/libgit2/src/git/tree.h

• Show log

  Commit

• Hash : f49a2e49
  Author :
  Date : 2010-09-19T03:21:06
  

  Give object structures more descriptive names The 'git_obj' structure is now called 'git_rawobj', since it represents a raw object read from the ODB. The 'git_repository_object' structure is now called 'git_object', since it's the base object class for all objects. Signed-off-by: Vicent Marti <tanoku@gmail.com>

Download

• src/git/tree.h

• #ifndef INCLUDE_git_tree_h__
  #define INCLUDE_git_tree_h__
  
  #include "common.h"
  #include "oid.h"
  #include "repository.h"
  
  /**
   * @file git/tree.h
   * @brief Git tree parsing, loading routines
   * @defgroup git_tree Git tree parsing, loading routines
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  
  /** Representation of each one of the entries in a tree object. */
  typedef struct git_tree_entry git_tree_entry;
  
  /** Representation of a tree object. */
  typedef struct git_tree git_tree;
  
  /**
   * Lookup a tree object from the repository.
   * The generated tree object is owned by the revision
   * repo and shall not be freed by the user.
   *
   * @param repo the repo to use when locating the tree.
   * @param id identity of the tree to locate.
   * @return the tree; NULL if the tree could not be created
   */
  GIT_EXTERN(git_tree *) git_tree_lookup(git_repository *repo, const git_oid *id);
  
  /**
   * Get the id of a tree.
   * @param tree a previously loaded tree.
   * @return object identity for the tree.
   */
  GIT_EXTERN(const git_oid *) git_tree_id(git_tree *tree);
  
  
  /**
   * Get the number of entries listed in a tree
   * @param tree a previously loaded tree.
   * @return the number of entries in the tree
   */
  GIT_EXTERN(size_t) git_tree_entrycount(git_tree *tree);
  
  /**
   * Lookup a tree entry by its filename
   * @param tree a previously loaded tree.
   * @param filename the filename of the desired entry
   * @return the tree entry; NULL if not found
   */
  GIT_EXTERN(const git_tree_entry *) git_tree_entry_byname(git_tree *tree, const char *filename);
  
  /**
   * Lookup a tree entry by its position in the tree
   * @param tree a previously loaded tree.
   * @param idx the position in the entry list
   * @return the tree entry; NULL if not found
   */
  GIT_EXTERN(const git_tree_entry *) git_tree_entry_byindex(git_tree *tree, int idx);
  
  /**
   * Get the UNIX file attributes of a tree entry
   * @param entry a tree entry
   * @return attributes as an integer
   */
  GIT_EXTERN(unsigned int) git_tree_entry_attributes(const git_tree_entry *entry);
  
  /**
   * Get the filename of a tree entry
   * @param entry a tree entry
   * @return the name of the file
   */
  GIT_EXTERN(const char *) git_tree_entry_name(const git_tree_entry *entry);
  
  /**
   * Get the id of the object pointed by the entry
   * @param entry a tree entry
   * @return the oid of the object
   */
  GIT_EXTERN(const git_oid *) git_tree_entry_id(const git_tree_entry *entry);
  
  /**
   * Convert a tree entry to the git_object it points too.
   * @param entry a tree entry
   * @return a reference to the pointed object in the repository
   */
  GIT_EXTERN(git_object *) git_tree_entry_2object(const git_tree_entry *entry);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download