Copyright (c) 2000, 2005 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2000, 2005 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.filebuffers.manipulation;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;

import org.eclipse.text.edits.MalformedTreeException;
import org.eclipse.text.edits.MultiTextEdit;
import org.eclipse.text.edits.TextEdit;
import org.eclipse.text.edits.UndoEdit;

import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;

Multi-text edit with progress reporting.
Since:
3.1/**
 * Multi-text edit with progress reporting.
 *
 * @since 3.1
 */
public class MultiTextEditWithProgress extends MultiTextEdit {

	IProgressMonitor fProgressMonitor;
	private final String fTaskName;

	public MultiTextEditWithProgress(String taskName) {
		fTaskName= taskName;
	}

	/*
	 * @see TextEdit#apply(IDocument)
	 */
	public final UndoEdit apply(IDocument document, IProgressMonitor progressMonitor) throws MalformedTreeException, BadLocationException {
		return apply(document, CREATE_UNDO | UPDATE_REGIONS, progressMonitor);
	}

	/*
	 * @see TextEdit#apply(IDocument, int)
	 */
	public final UndoEdit apply(IDocument document, int style, IProgressMonitor progressMonitor) throws MalformedTreeException, BadLocationException {
		fProgressMonitor= progressMonitor;
		try {

			int count= getChildrenSize();
			if ((style & TextEdit.UPDATE_REGIONS) != 0)
				count= 2*count;

			fProgressMonitor.beginTask(fTaskName, count);
			try {
				return super.apply(document, style);
			} finally {
				fProgressMonitor.done();
			}

		} finally {
			fProgressMonitor= null;
		}
	}

	@Override
	protected void childDocumentUpdated() {
		if (fProgressMonitor.isCanceled())
			throw new OperationCanceledException();
		fProgressMonitor.worked(1);
	}

	@Override
	protected void childRegionUpdated() {
		if (fProgressMonitor.isCanceled())
			throw new OperationCanceledException();
		fProgressMonitor.worked(1);
	}
}