From f130e364c428e542e60cadc5336646fe44e38553 Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Mon, 11 Aug 2008 18:07:58 -0700 Subject: [PATCH] Support using a DirCache within a TreeWalk Being able to include the .git/index file as part of a parallel TreeWalk which also covers one or more canonical tree objects from the database and the working directory makes it much easier to handle differences or merges between the various states. This iterator implementation adapts a loaded DirCache instance into a tree structure that the TreeWalk can iterate. Since TreeWalk wants to use a hierarchical structure and the DirCache is flat we force the TREE extension to load (or generate) and work off that. Signed-off-by: Shawn O. Pearce Signed-off-by: Robin Rosenberg --- .../spearce/jgit/dircache/DirCacheIterator.java | 205 +++++++++++++++++++++ 1 file changed, 205 insertions(+) create mode 100644 org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java diff --git a/org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java b/org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java new file mode 100644 index 00000000..c093bb2c --- /dev/null +++ b/org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java @@ -0,0 +1,205 @@ +/* + * Copyright (C) 2008, Shawn O. Pearce + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Git Development Community nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +package org.spearce.jgit.dircache; + +import java.io.IOException; +import java.util.Arrays; + +import org.spearce.jgit.errors.CorruptObjectException; +import org.spearce.jgit.errors.IncorrectObjectTypeException; +import org.spearce.jgit.lib.Constants; +import org.spearce.jgit.lib.FileMode; +import org.spearce.jgit.lib.Repository; +import org.spearce.jgit.treewalk.AbstractTreeIterator; + +/** + * Iterate a {@link DirCache} as part of a TreeWalk. + *

+ * This is an iterator to adapt a loaded DirCache instance (such as + * read from an existing .git/index file) to the tree structure + * used by a TreeWalk, making it possible for applications to walk + * over any combination of tree objects already in the object database, index + * files, or working directories. + * + * @see org.spearce.jgit.treewalk.TreeWalk + */ +public class DirCacheIterator extends AbstractTreeIterator { + /** The cache this iterator was created to walk. */ + protected final DirCache cache; + + /** The tree this iterator is walking. */ + private final DirCacheTree tree; + + /** Special buffer to hold the ObjectId of {@link #currentSubtree}. */ + private final byte[] subtreeId; + + /** Index of entry within {@link #cache}. */ + protected int cachePos; + + /** Position of entry within {@link #tree}'s entry span. */ + private int treePos; + + /** Next subtree to consider within {@link #tree}. */ + private int subtreeIdx; + + /** The current file entry from {@link #cache}, matching {@link #cachePos}. */ + protected DirCacheEntry currentEntry; + + /** The subtree containing {@link #currentEntry} if this is first entry. */ + protected DirCacheTree currentSubtree; + + /** + * Create a new iterator for an already loaded DirCache instance. + *

+ * The iterator implementation may copy part of the cache's data during + * construction, so the cache must be read in prior to creating the + * iterator. + * + * @param dc + * the cache to walk. It must be already loaded into memory. + */ + public DirCacheIterator(final DirCache dc) { + cache = dc; + tree = dc.getCacheTree(true); + subtreeId = new byte[Constants.OBJECT_ID_LENGTH]; + cachePos = -1; + treePos = -1; + } + + protected DirCacheIterator(final DirCacheIterator p, final DirCacheTree dct) { + super(p, p.path, p.pathLen + 1); + cache = p.cache; + tree = dct; + subtreeId = p.subtreeId; + cachePos = p.cachePos - 1; // back up so first next() call enters it + treePos = -1; + } + + @Override + public AbstractTreeIterator createSubtreeIterator(final Repository repo) + throws IncorrectObjectTypeException, IOException { + if (currentSubtree == null) + throw new IncorrectObjectTypeException(getEntryObjectId(), + Constants.TYPE_TREE); + return new DirCacheIterator(this, currentSubtree); + } + + @Override + public byte[] idBuffer() { + if (currentSubtree != null) + return subtreeId; + if (currentEntry != null) + return currentEntry.idBuffer(); + return zeroid; + } + + @Override + public int idOffset() { + if (currentSubtree != null) + return 0; + if (currentEntry != null) + return currentEntry.idOffset(); + return 0; + } + + @Override + public boolean eof() { + return treePos >= tree.getEntrySpan(); + } + + @Override + public void next() throws CorruptObjectException { + if (currentSubtree != null) { + // If our last position was a subtree we need to skip over + // its entire span to get to the item after the subtree. + // + final int n = currentSubtree.getEntrySpan(); + cachePos += n; + treePos += n; + currentSubtree = null; + } else { + // Our last position was a file/symlink/gitlink, so we + // only skip the one entry. + // + cachePos++; + treePos++; + } + + if (treePos >= tree.getEntrySpan()) + return; // this iterator is now at EOF. + + currentEntry = cache.getEntry(cachePos); + final byte[] cep = currentEntry.path; + if (subtreeIdx < tree.getChildCount()) { + final DirCacheTree s = tree.getChild(subtreeIdx); + if (s.contains(cep, pathOffset, cep.length)) { + // The current position is the first file of this subtree. + // Use the subtree instead as the current position. + // + currentSubtree = s; + subtreeIdx++; + + if (s.isValid()) + s.getObjectId().copyRawTo(subtreeId, 0); + else + Arrays.fill(subtreeId, (byte) 0); + mode = FileMode.TREE.getBits(); + path = cep; + pathLen = pathOffset + s.nameLength(); + return; + } + } + + // The current position is a file/symlink/gitlink so we + // do not have a subtree located here. + // + mode = currentEntry.getRawMode(); + path = cep; + pathLen = cep.length; + } + + /** + * Get the DirCacheEntry for the current file. + * + * @return the current cache entry, if this iterator is positioned on a + * non-tree. + */ + public DirCacheEntry getDirCacheEntry() { + return currentSubtree == null ? currentEntry : null; + } +} -- 2.11.4.GIT