git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[JGIT PATCH 11/14] Expose beginning of iterator indication from AbstractTreeIterator

From
Shawn O. Pearce <spearce@spearce.org>
Date
Aug 18, 2008, 23:53 UTC
Message-ID
<1219103602-32222-12-git-send-email-spearce@spearce.org>
In-Reply-To
<1219103602-32222-11-git-send-email-spearce@spearce.org>

Callers like TreeWalk need to know if back(1) is going to be a valid operation for a given AbstractTreeIterator before they try to make a call to move the iterator backwards. The new method first() returns true only if the iterator is already positioned on its first entry, in which case a call to back(n) (for any n) is invalid.

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
---
 .../spearce/jgit/dircache/DirCacheIterator.java    |   12 +++++++++++-
 .../jgit/treewalk/AbstractTreeIterator.java        |   13 +++++++++++++
 .../spearce/jgit/treewalk/CanonicalTreeParser.java |    5 +++++
 .../spearce/jgit/treewalk/EmptyTreeIterator.java   |    5 +++++
 .../spearce/jgit/treewalk/WorkingTreeIterator.java |    5 +++++
 5 files changed, 39 insertions(+), 1 deletions(-)
diff --git a/org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java b/org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java
index 84cefa5..8384723 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java
@@ -64,6 +64,9 @@
 	/** The tree this iterator is walking. */
 	private final DirCacheTree tree;
 
+	/** First position in this tree. */
+	private final int treeStart;
+
 	/** Last position in this tree. */
 	private final int treeEnd;
 
@@ -95,6 +98,7 @@
 	public DirCacheIterator(final DirCache dc) {
 		cache = dc;
 		tree = dc.getCacheTree(true);
+		treeStart = 0;
 		treeEnd = tree.getEntrySpan();
 		subtreeId = new byte[Constants.OBJECT_ID_LENGTH];
 		if (!eof())
@@ -105,7 +109,8 @@ protected DirCacheIterator(final DirCacheIterator p, final DirCacheTree dct) {
 		super(p, p.path, p.pathLen + 1);
 		cache = p.cache;
 		tree = dct;
-		treeEnd = p.ptr + tree.getEntrySpan();
+		treeStart = p.ptr;
+		treeEnd = treeStart + tree.getEntrySpan();
 		subtreeId = p.subtreeId;
 		ptr = p.ptr;
 		parseEntry();
@@ -139,6 +144,11 @@ public int idOffset() {
 	}
 
 	@Override
+	public boolean first() {
+		return ptr == treeStart;
+	}
+
+	@Override
 	public boolean eof() {
 		return ptr == treeEnd;
 	}
diff --git a/org.spearce.jgit/src/org/spearce/jgit/treewalk/AbstractTreeIterator.java b/org.spearce.jgit/src/org/spearce/jgit/treewalk/AbstractTreeIterator.java
index 8ec506c..c1b7ad8 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/treewalk/AbstractTreeIterator.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/treewalk/AbstractTreeIterator.java
@@ -340,6 +340,19 @@ public abstract AbstractTreeIterator createSubtreeIterator(Repository repo)
 			throws IncorrectObjectTypeException, IOException;
 
 	/**
+	 * Is this tree iterator positioned on its first entry?
+	 * <p>
+	 * An iterator is positioned on the first entry if <code>back(1)</code>
+	 * would be an invalid request as there is no entry before the current one.
+	 * <p>
+	 * An empty iterator (one with no entries) will be
+	 * <code>first() &amp;&amp; eof()</code>.
+	 * 
+	 * @return true if the iterator is positioned on the first entry.
+	 */
+	public abstract boolean first();
+
+	/**
 	 * Is this tree iterator at its EOF point (no more entries)?
 	 * <p>
 	 * An iterator is at EOF if there is no current entry.
diff --git a/org.spearce.jgit/src/org/spearce/jgit/treewalk/CanonicalTreeParser.java b/org.spearce.jgit/src/org/spearce/jgit/treewalk/CanonicalTreeParser.java
index 111d03b..dcc53cd 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/treewalk/CanonicalTreeParser.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/treewalk/CanonicalTreeParser.java
@@ -126,6 +126,11 @@ public int idOffset() {
 		return nextPtr - Constants.OBJECT_ID_LENGTH;
 	}
 
+	@Override
+	public boolean first() {
+		return currPtr == 0;
+	}
+
 	public boolean eof() {
 		return currPtr == raw.length;
 	}
diff --git a/org.spearce.jgit/src/org/spearce/jgit/treewalk/EmptyTreeIterator.java b/org.spearce.jgit/src/org/spearce/jgit/treewalk/EmptyTreeIterator.java
index 232e3b1..eaca04e 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/treewalk/EmptyTreeIterator.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/treewalk/EmptyTreeIterator.java
@@ -79,6 +79,11 @@ public int idOffset() {
 	}
 
 	@Override
+	public boolean first() {
+		return true;
+	}
+
+	@Override
 	public boolean eof() {
 		return true;
 	}
diff --git a/org.spearce.jgit/src/org/spearce/jgit/treewalk/WorkingTreeIterator.java b/org.spearce.jgit/src/org/spearce/jgit/treewalk/WorkingTreeIterator.java
index 41fd47b..9c53224 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/treewalk/WorkingTreeIterator.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/treewalk/WorkingTreeIterator.java
@@ -231,6 +231,11 @@ public int idOffset() {
 	}
 
 	@Override
+	public boolean first() {
+		return ptr == 0;
+	}
+
+	@Override
 	public boolean eof() {
 		return ptr == entryCnt;
 	}
-- 
1.6.0.87.g2858d
Previous: Shawn O. PearceNext: Shawn O. Pearce
Message 12 of 20 in “TreeWalk D/F conflict detection”
  1. 00/14 TreeWalk D/F conflict detectionShawn O. Pearce, Aug 18, 2008
  2. 01/14 Detect path names which overflow the name length field in the indexShawn O. Pearce, Aug 18, 2008
  3. 02/14 Fix NB.decodeUInt16 to correctly handle the high byteShawn O. Pearce, Aug 18, 2008
  4. 03/14 Add test cases for NB.encode and NB.decode family of routinesShawn O. Pearce, Aug 18, 2008
  5. 04/14 Fix DirCache's skip over null byte padding when reading a DIRC fileShawn O. Pearce, Aug 18, 2008
  6. 05/14 Fix usage of assertEquals in DirCacheIteratorTestShawn O. Pearce, Aug 18, 2008
  7. 06/14 Refactor AbstractTreeIterator.pathCompare to force another modeShawn O. Pearce, Aug 18, 2008
  8. 07/14 Micro-optimize AbstractTreeIterator.pathCompareShawn O. Pearce, Aug 18, 2008
  9. 08/14 Optimize path comparsion within subtrees during TreeWalkShawn O. Pearce, Aug 18, 2008
  10. 09/14 Refactor AbstractTreeIterator semantics to start on first entryShawn O. Pearce, Aug 18, 2008
  11. 10/14 Make all AbstractTreeIterator implementations bi-directionalShawn O. Pearce, Aug 18, 2008
  12. 11/14 Expose beginning of iterator indication from AbstractTreeIteratorShawn O. Pearce, Aug 18, 2008
  13. 12/14 Allow application code to set ObjectIds in DirCacheEntryShawn O. Pearce, Aug 18, 2008
  14. 13/14 Create NameConflictTreeWalk to transparently detect D/F conflictsShawn O. Pearce, Aug 18, 2008
  15. 14/14 Add test case for NameConflictTreeWalkShawn O. Pearce, Aug 18, 2008
  16. Junio C HamanoAug 19, 2008
  17. Robin RosenbergAug 19, 2008
  18. Shawn O. PearceAug 19, 2008
  19. David WoodhouseAug 19, 2008
  20. Shawn O. PearceAug 19, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.