Mercurial > hg4j

changeset 632:54e16ab771ec v1.1rc2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Progress/cancel for HgDiffCommand. Renamed execute method
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Thu, 30 May 2013 16:13:43 +0200
parents 8a5cdcb27b8f
children e66788de0cf8
files src/org/tmatesoft/hg/core/HgDiffCommand.java src/org/tmatesoft/hg/repo/HgDataFile.java test/org/tmatesoft/hg/test/TestBlame.java
diffstat 3 files changed, 53 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/core/HgDiffCommand.java	Thu May 30 15:24:17 2013 +0200
+++ b/src/org/tmatesoft/hg/core/HgDiffCommand.java	Thu May 30 16:13:43 2013 +0200
@@ -21,23 +21,31 @@
 
 import org.tmatesoft.hg.internal.BlameHelper;
 import org.tmatesoft.hg.internal.CsetParamKeeper;
-import org.tmatesoft.hg.internal.Experimental;
 import org.tmatesoft.hg.internal.FileHistory;
 import org.tmatesoft.hg.internal.FileRevisionHistoryChunk;
 import org.tmatesoft.hg.repo.HgDataFile;
 import org.tmatesoft.hg.repo.HgRepository;
 import org.tmatesoft.hg.repo.HgRuntimeException;
+import org.tmatesoft.hg.util.CancelSupport;
 import org.tmatesoft.hg.util.CancelledException;
 import org.tmatesoft.hg.util.Path;
+import org.tmatesoft.hg.util.ProgressSupport;
 
 /**
- * 'hg diff' counterpart, with similar, diff-based, functionality
+ * 'hg diff' counterpart, with similar, although not identical, functionality.
+ * Despite both 'hg diff' and this command are diff-based, implementation
+ * peculiarities may lead to slightly different diff results. Either is valid
+ * as there's no strict diff specification. 
+ * 
+ * <p>
+ * <strong>Note</strong>, at the moment this command annotates single file only. Diff over
+ * complete repository (all the file changed in a given changeset) might
+ * be added later.
  * 
  * @since 1.1
  * @author Artem Tikhomirov
  * @author TMate Software Ltd.
  */
-@Experimental(reason="#execute* methods might get renamed")
 public class HgDiffCommand extends HgAbstractCommand<HgDiffCommand> {
 
 	private final HgRepository repo;
@@ -86,7 +94,7 @@
 	}
 	
 	/**
-	 * Selects revision for {@link #executeAnnotateSingleRevision(HgBlameInspector)}, the one 
+	 * Selects revision for {@link #executeParentsAnnotate(HgBlameInspector)}, the one 
 	 * to diff against its parents. 
 	 * 
 	 * Besides, it is handy when range of interest spans up to the very beginning of the file history 
@@ -107,7 +115,7 @@
 	 * annotating {@link #range(int, int) range} of changesets with
 	 * {@link #executeAnnotate(HgBlameInspector)}.
 	 * <p>
-	 * This method doesn't affect {@link #executeAnnotateSingleRevision(HgBlameInspector)} and
+	 * This method doesn't affect {@link #executeParentsAnnotate(HgBlameInspector)} and
 	 * {@link #executeDiff(HgBlameInspector)}
 	 * 
 	 * @param order desired iteration order 
@@ -117,8 +125,6 @@
 		iterateDirection = order;
 		return this;
 	}
-
-	// FIXME progress and cancellation
 	
 	/**
 	 * Diff two revisions selected with {@link #range(int, int)} against each other.
@@ -130,14 +136,23 @@
 	 */
 	public void executeDiff(HgBlameInspector insp) throws HgCallbackTargetException, CancelledException, HgException {
 		checkFile();
+		final ProgressSupport progress = getProgressSupport(insp);
+		progress.start(2);
 		try {
+			final CancelSupport cancel = getCancelSupport(insp, true);
 			int fileRevIndex1 = fileRevIndex(df, clogRevIndexStart.get());
 			int fileRevIndex2 = fileRevIndex(df, clogRevIndexEnd.get());
 			BlameHelper bh = new BlameHelper(insp);
 			bh.prepare(df, clogRevIndexStart.get(), clogRevIndexEnd.get());
+			progress.worked(1);
+			cancel.checkCancelled();
 			bh.diff(fileRevIndex1, clogRevIndexStart.get(), fileRevIndex2, clogRevIndexEnd.get());
+			progress.worked(1);
+			cancel.checkCancelled();
 		} catch (HgRuntimeException ex) {
 			throw new HgLibraryFailureException(ex);
+		} finally {
+			progress.done();
 		}
 	}
 
@@ -150,13 +165,24 @@
 	 */
 	public void executeAnnotate(HgBlameInspector insp) throws HgCallbackTargetException, CancelledException, HgException {
 		checkFile();
+		ProgressSupport progress = null;
 		try {
 			if (!df.exists()) {
 				return;
 			}
+			final CancelSupport cancel = getCancelSupport(insp, true);
 			BlameHelper bh = new BlameHelper(insp);
 			FileHistory fileHistory = bh.prepare(df, clogRevIndexStart.get(), clogRevIndexEnd.get());
-	
+			//
+			cancel.checkCancelled();
+			int totalWork = 0;
+			for (FileRevisionHistoryChunk fhc : fileHistory.iterate(iterateDirection)) {
+				totalWork += fhc.revisionCount();
+			}
+			progress = getProgressSupport(insp);
+			progress.start(totalWork + 1);
+			progress.worked(1); // BlameHelper.prepare
+			//
 			int[] fileClogParentRevs = new int[2];
 			int[] fileParentRevs = new int[2];
 			for (FileRevisionHistoryChunk fhc : fileHistory.iterate(iterateDirection)) {
@@ -168,10 +194,16 @@
 					fhc.fillFileParents(fri, fileParentRevs);
 					fhc.fillCsetParents(fri, fileClogParentRevs);
 					bh.annotateChange(fri, clogRevIndex, fileParentRevs, fileClogParentRevs);
+					progress.worked(1);
+					cancel.checkCancelled();
 				}
 			}
 		} catch (HgRuntimeException ex) {
 			throw new HgLibraryFailureException(ex);
+		} finally {
+			if (progress != null) {
+				progress.done();
+			}
 		}
 	}
 
@@ -184,9 +216,12 @@
 	 * @throws CancelledException if execution of the command was cancelled
 	 * @throws HgException subclass thereof to indicate specific issue with the command arguments or repository state
 	 */
-	public void executeAnnotateSingleRevision(HgBlameInspector insp) throws HgCallbackTargetException, CancelledException, HgException {
+	public void executeParentsAnnotate(HgBlameInspector insp) throws HgCallbackTargetException, CancelledException, HgException {
 		checkFile();
+		final ProgressSupport progress = getProgressSupport(insp);
+		progress.start(2);
 		try {
+			final CancelSupport cancel = getCancelSupport(insp, true);
 			int changelogRevisionIndex = clogRevIndexEnd.get();
 			// TODO detect if file is text/binary (e.g. looking for chars < ' ' and not \t\r\n\f
 			int fileRevIndex = fileRevIndex(df, changelogRevisionIndex);
@@ -201,9 +236,15 @@
 			BlameHelper bh = new BlameHelper(insp);
 			int clogIndexStart = fileClogParentRevs[0] == NO_REVISION ? (fileClogParentRevs[1] == NO_REVISION ? 0 : fileClogParentRevs[1]) : fileClogParentRevs[0];
 			bh.prepare(df, clogIndexStart, changelogRevisionIndex);
+			progress.worked(1);
+			cancel.checkCancelled();
 			bh.annotateChange(fileRevIndex, changelogRevisionIndex, fileRevParents, fileClogParentRevs);
+			progress.worked(1);
+			cancel.checkCancelled();
 		} catch (HgRuntimeException ex) {
 			throw new HgLibraryFailureException(ex);
+		} finally {
+			progress.done();
 		}
 	}
 
--- a/src/org/tmatesoft/hg/repo/HgDataFile.java	Thu May 30 15:24:17 2013 +0200
+++ b/src/org/tmatesoft/hg/repo/HgDataFile.java	Thu May 30 16:13:43 2013 +0200
@@ -466,7 +466,7 @@
 	@Deprecated
 	public void annotateSingleRevision(int changelogRevisionIndex, HgBlameInspector insp) throws HgRuntimeException, HgCallbackTargetException {
 		try {
-			new HgDiffCommand(getRepo()).file(this).changeset(changelogRevisionIndex).executeAnnotateSingleRevision(insp);
+			new HgDiffCommand(getRepo()).file(this).changeset(changelogRevisionIndex).executeParentsAnnotate(insp);
 		} catch (HgLibraryFailureException ex) {
 			throw ex.getCause();
 		} catch (HgException ex) {
--- a/test/org/tmatesoft/hg/test/TestBlame.java	Thu May 30 15:24:17 2013 +0200
+++ b/test/org/tmatesoft/hg/test/TestBlame.java	Thu May 30 16:13:43 2013 +0200
@@ -77,7 +77,7 @@
 		ByteArrayOutputStream bos = new ByteArrayOutputStream();
 		HgDiffCommand diffCmd = new HgDiffCommand(repo);
 		diffCmd.file(df).changeset(checkChangeset);
-		diffCmd.executeAnnotateSingleRevision(new DiffOutInspector(new PrintStream(bos)));
+		diffCmd.executeParentsAnnotate(new DiffOutInspector(new PrintStream(bos)));
 		LineGrepOutputParser gp = new LineGrepOutputParser("^@@.+");
 		ExecHelper eh = new ExecHelper(gp, null);
 		eh.run("hg", "diff", "-c", String.valueOf(checkChangeset), "-U", "0", fname);
@@ -307,7 +307,7 @@
 		//
 		ByteArrayOutputStream bos = new ByteArrayOutputStream();
 		HgDiffCommand diffCmd = new HgDiffCommand(repo).file(df);
-		diffCmd.changeset(0).executeAnnotateSingleRevision(new DiffOutInspector(new PrintStream(bos)));
+		diffCmd.changeset(0).executeParentsAnnotate(new DiffOutInspector(new PrintStream(bos)));
 		//
 		String[] apiResult = splitLines(bos.toString());
 		String[] expected = splitLines(gp.result());