thodg/libgit2/src/iterator.h

• Show log

  Commit

• Hash : da337c80
  Author :
  Date : 2012-02-22T11:22:33
  

  Iterator improvements from diff implementation
  
  This makes two changes to iterator behavior: first, advance
  can optionally do the work of returning the new current value.
  This is such a common pattern that it really cleans up usage.
  
  Second, for workdir iterators, this removes automatically
  iterating into directories.  That seemed like a good idea,
  but when an entirely new directory hierarchy is introduced
  into the workdir, there is no reason to iterate into it if
  there are no corresponding entries in the tree/index that it
  is being compared to.
  
  This second change actually wasn't a lot of code because not
  descending into directories was already the behavior for
  ignored directories.  This just extends that to all directories.
  

Download

• src/iterator.h

• /*
   * Copyright (C) 2009-2012 the libgit2 contributors
   *
   * 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_iterator_h__
  #define INCLUDE_iterator_h__
  
  #include "common.h"
  #include "git2/index.h"
  
  typedef struct git_iterator git_iterator;
  
  typedef enum {
  	GIT_ITERATOR_TREE = 1,
  	GIT_ITERATOR_INDEX = 2,
  	GIT_ITERATOR_WORKDIR = 3
  } git_iterator_type_t;
  
  struct git_iterator {
  	git_iterator_type_t type;
  	int (*current)(git_iterator *, const git_index_entry **);
  	int (*at_end)(git_iterator *);
  	int (*advance)(git_iterator *, const git_index_entry **);
  	void (*free)(git_iterator *);
  };
  
  int git_iterator_for_tree(
  	git_repository *repo, git_tree *tree, git_iterator **iter);
  
  int git_iterator_for_index(
  	git_repository *repo, git_iterator **iter);
  
  int git_iterator_for_workdir(
  	git_repository *repo, git_iterator **iter);
  
  /* Entry is not guaranteed to be fully populated.  For a tree iterator,
   * we will only populate the mode, oid and path, for example.  For a workdir
   * iterator, we will not populate the oid.
   *
   * You do not need to free the entry.  It is still "owned" by the iterator.
   * Once you call `git_iterator_advance`, then content of the old entry is
   * no longer guaranteed to be valid.
   */
  GIT_INLINE(int) git_iterator_current(
  	git_iterator *iter, const git_index_entry **entry)
  {
  	return iter->current(iter, entry);
  }
  
  GIT_INLINE(int) git_iterator_at_end(git_iterator *iter)
  {
  	return iter->at_end(iter);
  }
  
  GIT_INLINE(int) git_iterator_advance(
  	git_iterator *iter, const git_index_entry **entry)
  {
  	return iter->advance(iter, entry);
  }
  
  GIT_INLINE(void) git_iterator_free(git_iterator *iter)
  {
  	iter->free(iter);
  	git__free(iter);
  }
  
  GIT_INLINE(git_iterator_type_t) git_iterator_type(git_iterator *iter)
  {
  	return iter->type;
  }
  
  extern int git_iterator_current_tree_entry(
  	git_iterator *iter, const git_tree_entry **tree_entry);
  
  extern int git_iterator_current_is_ignored(git_iterator *iter);
  
  /**
   * Iterate into a workdir directory.
   *
   * Workdir iterators do not automatically descend into directories (so that
   * when comparing two iterator entries you can detect a newly created
   * directory in the workdir).  As a result, you may get S_ISDIR items from
   * a workdir iterator.  If you wish to iterate over the contents of the
   * directories you encounter, then call this function when you encounter
   * a directory.
   *
   * If there are no files in the directory, this will end up acting like a
   * regular advance and will skip past the directory, so you should be
   * prepared for that case.
   *
   * On non-workdir iterators or if not pointing at a directory, this is a
   * no-op and will not advance the iterator.
   */
  extern int git_iterator_advance_into_directory(
  	git_iterator *iter, const git_index_entry **entry);
  
  #endif
  

Download