view src/org/tmatesoft/hg/core/HgChangeset.java @ 148:1a7a9a20e1f9

Exceptions, javadoc. Initial cancel and progress support
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Wed, 23 Feb 2011 22:36:28 +0100
parents 37a34044e6bd
children ba2bf656f00f
line wrap: on
line source
/*
 * Copyright (c) 2011 TMate Software Ltd
 *  
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * For information on how to redistribute this software under
 * the terms of a license other than GNU General Public License
 * contact TMate Software at support@hg4j.com
 */
package org.tmatesoft.hg.core;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.tmatesoft.hg.core.HgLogCommand.FileRevision;
import org.tmatesoft.hg.repo.HgChangelog.Changeset;
import org.tmatesoft.hg.repo.HgRepository;
import org.tmatesoft.hg.repo.HgStatusCollector;
import org.tmatesoft.hg.util.Path;


/**
 * Record in the Mercurial changelog, describing single commit.
 * 
 * Not thread-safe, don't try to read from different threads
 * 
 * @author Artem Tikhomirov
 * @author TMate Software Ltd.
 */
public class HgChangeset implements Cloneable {
	private final HgStatusCollector statusHelper;
	private final Path.Source pathHelper;

	//
	private Changeset changeset;
	private Nodeid nodeid;

	//
	private List<FileRevision> modifiedFiles, addedFiles;
	private List<Path> deletedFiles;
	private int revNumber;

	// XXX consider CommandContext with StatusCollector, PathPool etc. Commands optionally get CC through a cons or create new
	// and pass it around
	/*package-local*/HgChangeset(HgStatusCollector statusCollector, Path.Source pathFactory) {
		statusHelper = statusCollector;
		pathHelper = pathFactory;
	}
	
	/*package-local*/
	void init(int localRevNumber, Nodeid nid, Changeset rawChangeset) {
		revNumber = localRevNumber;
		nodeid = nid;
		changeset = rawChangeset;
		modifiedFiles = addedFiles = null;
		deletedFiles = null;
	}
	public int getRevision() {
		return revNumber;
	}
	public Nodeid getNodeid() {
		return nodeid;
	}
	public String getUser() {
		return changeset.user();
	}
	public String getComment() {
		return changeset.comment();
	}
	public String getBranch() {
		return changeset.branch();
	}
	public String getDate() {
		return changeset.dateString();
	}
	public Nodeid getManifestRevision() {
		return changeset.manifest();
	}

	public List<Path> getAffectedFiles() {
		// reports files as recorded in changelog. Note, merge revisions may have no
		// files listed, and thus this method would return empty list, while
		// #getModifiedFiles() would return list with merged file(s) (because it uses status to get 'em, not
		// what #files() gives).
		ArrayList<Path> rv = new ArrayList<Path>(changeset.files().size());
		for (String name : changeset.files()) {
			rv.add(pathHelper.path(name));
		}
		return rv;
	}

	public List<FileRevision> getModifiedFiles() {
		if (modifiedFiles == null) {
			initFileChanges();
		}
		return modifiedFiles;
	}

	public List<FileRevision> getAddedFiles() {
		if (addedFiles == null) {
			initFileChanges();
		}
		return addedFiles;
	}

	public List<Path> getRemovedFiles() {
		if (deletedFiles == null) {
			initFileChanges();
		}
		return deletedFiles;
	}

	public boolean isMerge() {
		return !Nodeid.NULL.equals(getSecondParentRevision());
	}
	
	public Nodeid getFirstParentRevision() {
		// XXX may read once for both p1 and p2 
		// or use ParentWalker to minimize reads even more.
		byte[] p1 = new byte[20];
		statusHelper.getRepo().getChangelog().parents(revNumber, new int[2], p1, null);
		return Nodeid.fromBinary(p1, 0);
	}
	
	public Nodeid getSecondParentRevision() {
		byte[] p2 = new byte[20];
		statusHelper.getRepo().getChangelog().parents(revNumber, new int[2], null, p2);
		return Nodeid.fromBinary(p2, 0);
	}

	@Override
	public HgChangeset clone() {
		try {
			HgChangeset copy = (HgChangeset) super.clone();
			copy.changeset = changeset.clone();
			return copy;
		} catch (CloneNotSupportedException ex) {
			throw new InternalError(ex.toString());
		}
	}

	private /*synchronized*/ void initFileChanges() {
		ArrayList<Path> deleted = new ArrayList<Path>();
		ArrayList<FileRevision> modified = new ArrayList<FileRevision>();
		ArrayList<FileRevision> added = new ArrayList<FileRevision>();
		HgStatusCollector.Record r = new HgStatusCollector.Record();
		statusHelper.change(revNumber, r);
		final HgRepository repo = statusHelper.getRepo();
		for (Path s : r.getModified()) {
			Nodeid nid = r.nodeidAfterChange(s);
			if (nid == null) {
				throw new HgBadStateException();
			}
			modified.add(new FileRevision(repo, nid, s));
		}
		for (Path s : r.getAdded()) {
			Nodeid nid = r.nodeidAfterChange(s);
			if (nid == null) {
				throw new HgBadStateException();
			}
			added.add(new FileRevision(repo, nid, s));
		}
		for (Path s : r.getRemoved()) {
			// with Path from getRemoved, may just copy
			deleted.add(s);
		}
		modified.trimToSize();
		added.trimToSize();
		deleted.trimToSize();
		modifiedFiles = Collections.unmodifiableList(modified);
		addedFiles = Collections.unmodifiableList(added);
		deletedFiles = Collections.unmodifiableList(deleted);
	}
}