projects/dwt2: org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.d annotate

annotate org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.d @ 105:bbe49769ec18

...

author	Frank Benoit <benoit@tionex.de>
date	Sun, 08 Nov 2009 12:42:30 +0100
parents	bc29606a740c
children

rev	line source
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	1 /*******************************************************************************
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	2 * Copyright (c) 2006, 2007 IBM Corporation and others.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	3 * All rights reserved. This program and the accompanying materials
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	4 * are made available under the terms of the Eclipse Public License v1.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	5 * which accompanies this distribution, and is available at
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	6 * http://www.eclipse.org/legal/epl-v10.html
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	7 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	8 * Contributors:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	9 * Stefan Xenos - initial API and implementation
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	10 * Stefan Xenos - bug 174539 - add a 1-argument convert(...) method
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	11 * Stefan Xenos - bug 174040 - SubMonitor#convert doesn't always set task name
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	12 * Stefan Xenos - bug 206942 - updated javadoc to recommend better constants for infinite progress
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	13 *******************************************************************************/
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	14 // Port to the D programming language:
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	15 // Frank Benoit <benoit@tionex.de>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	16 module org.eclipse.core.runtimeSubMonitor;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	17
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	18 import java.lang.all;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	19
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	20 import org.eclipse.core.runtimeIProgressMonitorWithBlocking; // packageimport
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	21 import org.eclipse.core.runtimeIProgressMonitor; // packageimport
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	22 import org.eclipse.core.runtimeIStatus; // packageimport
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	23 import org.eclipse.core.runtimeNullProgressMonitor; // packageimport
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	24
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	25 /**
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	26 * <p>A progress monitor that uses a given amount of work ticks from a parent monitor. This is intended as a
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	27 * safer, easier-to-use alternative to SubProgressMonitor. The main benefits of SubMonitor over
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	28 * SubProgressMonitor are:</p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	29 * <ul>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	30 * <li>It is not necessary to call beginTask() or done() on an instance of SubMonitor.</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	31 * <li>SubMonitor has a simpler syntax for creating nested monitors.</li>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	32 * <li>SubMonitor is more efficient for deep recursion chains.</li>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	33 * <li>SubMonitor has a setWorkRemining method that allows the remaining space on the monitor to be
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	34 * redistributed without reporting any work.</li>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	35 * <li>SubMonitor protects the caller from common progress reporting bugs in a called method. For example,
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	36 * if a called method fails to call done() on the given monitor or fails to consume all the ticks on
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	37 * the given monitor, the parent will correct the problem after the method returns.</li>
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	38 * </ul>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	39 * <p></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	40 * <p><b>USAGE:</b></p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	41 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	42 * <p>When implementing a method that accepts an IProgressMonitor:</p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	43 * <ul>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	44 * <li>At the start of your method, use <code>SubMonitor.convert(...).</code> to convert the IProgressMonitor
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	45 * into a SubMonitor. </li>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	46 * <li>Use <code>SubMonitor.newChild(...)</code> whenever you need to call another method that
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	47 * accepts an IProgressMonitor.</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	48 * </ul>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	49 * <p></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	50 * <p><b>DEFAULT BEHAVIOR:</b></p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	51 *
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	52 * <p>When writing JavaDoc for a method that accepts an IProgressMonitor, you should assume the
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	53 * following default behavior unless the method's JavaDoc says otherwise:</p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	54 * <ul>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	55 * <li>It WILL call beginTask on the IProgressMonitor.</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	56 * <li>It WILL NOT accept a null argument.</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	57 * <li>It WILL call done on the IProgressMonitor.</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	58 * </ul>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	59 * <p></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	60 * <p><b>BEST PRACTISES:</b></p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	61 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	62 * <p>We recommend that newly-written methods follow the given contract:</p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	63 * <ul>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	64 * <li>It WILL call beginTask on the IProgressMonitor.</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	65 * <li>It WILL accept a null argument, indicating that no progress should be reported and the operation cannot be cancelled.</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	66 * <li>It WILL NOT call done on the IProgressMonitor, leaving this responsibility up to the caller.</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	67 * </ul>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	68 * <p>If you wish to follow these conventions, you may copy and paste the following text into your method's JavaDoc:</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	69 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	70 * <pre>@param monitor the progress monitor to use for reporting progress to the user. It is the caller's responsibility
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	71 * to call done() on the given monitor. Accepts <code>null</code>, indicating that no progress should be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	72 * reported and that the operation cannot be cancelled.</pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	73 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	74 * <p></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	75 * <p><b>Example: Recommended usage</b></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	76 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	77 * <p>This example demonstrates how the recommended usage of <code>SubMonitor</code> makes it unnecessary to call
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	78 * IProgressMonitor.done() in most situations.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	79 *
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	80 * <p>It is never necessary to call done() on a monitor obtained from <code>convert</code> or <code>progress.newChild()</code>.
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	81 * In this example, there is no guarantee that <code>monitor</code> is an instance of <code>SubMonitor</code>, making it
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	82 * necessary to call <code>monitor.done()</code>. The JavaDoc contract makes this the responsibility of the caller.</p>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	83 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	84 * <pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	85 * // param monitor the progress monitor to use for reporting progress to the user. It is the caller's responsibility
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	86 * // to call done() on the given monitor. Accepts <code>null</code>, indicating that no progress should be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	87 * // reported and that the operation cannot be cancelled.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	88 * //
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	89 * void doSomething(IProgressMonitor monitor) {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	90 * // Convert the given monitor into a progress instance
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	91 * SubMonitor progress = SubMonitor.convert(monitor, 100);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	92 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	93 * // Use 30% of the progress to do some work
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	94 * doSomeWork(progress.newChild(30));
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	95 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	96 * // Advance the monitor by another 30%
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	97 * progress.worked(30);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	98 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	99 * // Use the remaining 40% of the progress to do some more work
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	100 * doSomeWork(progress.newChild(40));
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	101 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	102 * </pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	103 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	104 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	105 * <p></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	106 * <p><b>Example: Default usage</b></p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	107 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	108 * <p>You will often need to implement a method that does not explicitly stipulate that calling done() is the responsibility
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	109 * of the caller. In this case, you should use the following pattern:</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	110 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	111 * <pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	112 * // param monitor the progress monitor to use for reporting progress to the user, or <code>null</code> indicating
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	113 * // that no progress should be reported and the operation cannot be cancelled.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	114 * //
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	115 * void doSomething(IProgressMonitor monitor) {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	116 * // Convert the given monitor into a progress instance
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	117 * SubMonitor progress = SubMonitor.convert(monitor, 100);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	118 * try {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	119 * // Use 30% of the progress to do some work
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	120 * doSomeWork(progress.newChild(30));
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	121 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	122 * // Advance the monitor by another 30%
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	123 * progress.worked(30);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	124 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	125 * // Use the remaining 40% of the progress to do some more work
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	126 * doSomeWork(progress.newChild(40));
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	127 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	128 * } finally {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	129 * if (monitor != null) {
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	130 * monitor.done();
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	131 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	132 * }
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	133 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	134 * </pre>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	135 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	136 * <p></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	137 * <p><b>Example: Branches</b></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	138 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	139 * <p>This example demonstrates how to smoothly report progress in situations where some of the work is optional.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	140 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	141 * <pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	142 * void doSomething(IProgressMonitor monitor) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	143 * SubMonitor progress = SubMonitor.convert(monitor, 100);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	144 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	145 * if (condition) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	146 * // Use 50% of the progress to do some work
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	147 * doSomeWork(progress.newChild(50));
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	148 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	149 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	150 * // Don't report any work, but ensure that we have 50 ticks remaining on the progress monitor.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	151 * // If we already consumed 50 ticks in the above branch, this is a no-op. Otherwise, the remaining
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	152 * // space in the monitor is redistributed into 50 ticks.
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	153 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	154 * progress.setWorkRemaining(50);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	155 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	156 * // Use the remainder of the progress monitor to do the rest of the work
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	157 * doSomeWork(progress.newChild(50));
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	158 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	159 * </pre>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	160 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	161 * <p>Please beware of the following anti-pattern:</p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	162 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	163 * <pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	164 * if (condition) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	165 * // Use 50% of the progress to do some work
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	166 * doSomeWork(progress.newChild(50));
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	167 * } else {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	168 * // Bad: Causes the progress monitor to appear to start at 50%, wasting half of the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	169 * // space in the monitor.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	170 * progress.worked(50);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	171 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	172 * </pre>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	173 *
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	174 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	175 * <p></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	176 * <p><b>Example: Loops</b></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	177 *
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	178 * <p>This example demonstrates how to report progress in a loop.</p>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	179 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	180 * <pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	181 * void doSomething(IProgressMonitor monitor, Collection someCollection) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	182 * SubMonitor progress = SubMonitor.convert(monitor, 100);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	183 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	184 * // Create a new progress monitor that uses 70% of the total progress and will allocate one tick
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	185 * // for each element of the given collection.
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	186 * SubMonitor loopProgress = progress.newChild(70).setWorkRemaining(someCollection.size());
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	187 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	188 * for (Iterator iter = someCollection.iterator(); iter.hasNext();) {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	189 * Object next = iter.next();
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	190 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	191 * doWorkOnElement(next, loopProgress.newChild(1));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	192 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	193 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	194 * // Use the remaining 30% of the progress monitor to do some work outside the loop
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	195 * doSomeWork(progress.newChild(30));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	196 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	197 * </pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	198 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	199 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	200 * <p></p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	201 * <p><b>Example: Infinite progress</b></p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	202 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	203 * <p>This example demonstrates how to report logarithmic progress in situations where the number of ticks
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	204 * cannot be easily computed in advance.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	205 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	206 * <pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	207 * void doSomething(IProgressMonitor monitor, LinkedListNode node) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	208 * SubMonitor progress = SubMonitor.convert(monitor);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	209 *
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	210 * while (node !is null) {
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	211 * // Regardless of the amount of progress reported so far,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	212 * // use 0.01% of the space remaining in the monitor to process the next node.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	213 * progress.setWorkRemaining(10000);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	214 *
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	215 * doWorkOnElement(node, progress.newChild(1));
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	216 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	217 * node = node.next;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	218 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	219 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	220 * </pre>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	221 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	222 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	223 * This class can be used without OSGi running.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	224 * </p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	225 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	226 * @since org.eclipse.equinox.common 3.3
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	227 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	228 public final class SubMonitor : IProgressMonitorWithBlocking {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	229
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	230 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	231 * Minimum number of ticks to allocate when calling beginTask on an unknown IProgressMonitor.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	232 * Pick a number that is big enough such that, no matter where progress is being displayed,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	233 * the user would be unlikely to notice if progress were to be reported with higher accuracy.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	234 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	235 private static final int MINIMUM_RESOLUTION = 1000;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	236
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	237 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	238 * The RootInfo struct holds information about the root progress monitor. A SubMonitor and
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	239 * its active descendents share the same RootInfo struct.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	240 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	241 private static final class RootInfo {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	242 private final IProgressMonitor root;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	243
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	244 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	245 * Remembers the last task name. Prevents us from setting the same task name multiple
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	246 * times in a row.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	247 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	248 private String taskName = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	249
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	250 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	251 * Remembers the last subtask name. Prevents the SubMonitor from setting the same
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	252 * subtask string more than once in a row.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	253 */
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	254 private String subTask = null;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	255
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	256 /**
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	257 * Creates a RootInfo struct that delegates to the given progress
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	258 * monitor.
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	259 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	260 * @param root progress monitor to delegate to
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	261 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	262 public this(IProgressMonitor root) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	263 this.root = root;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	264 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	265
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	266 public bool isCanceled() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	267 return root.isCanceled();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	268 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	269
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	270 public void setCanceled(bool value) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	271 root.setCanceled(value);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	272 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	273
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	274 public void setTaskName(String taskName) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	275 if (eq(taskName, this.taskName)) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	276 return;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	277 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	278 this.taskName = taskName;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	279 root.setTaskName(taskName);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	280 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	281
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	282 public void subTask(String name) {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	283 if (eq(subTask, name)) {
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	284 return;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	285 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	286
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	287 this.subTask = name;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	288 root.subTask(name);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	289 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	290
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	291 public void worked(int i) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	292 root.worked(i);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	293 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	294
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	295 public void clearBlocked() {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	296 if ( null !is cast(IProgressMonitorWithBlocking)root )
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	297 (cast(IProgressMonitorWithBlocking) root).clearBlocked();
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	298 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	299
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	300 public void setBlocked(IStatus reason) {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	301 if ( null !is cast(IProgressMonitorWithBlocking)root )
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	302 (cast(IProgressMonitorWithBlocking) root).setBlocked(reason);
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	303 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	304
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	305 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	306
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	307 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	308 * Total number of ticks that this progress monitor is permitted to consume
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	309 * from the root.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	310 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	311 private int totalParent;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	312
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	313 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	314 * Number of ticks that this progress monitor has already reported in the root.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	315 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	316 private int usedForParent = 0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	317
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	318 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	319 * Number of ticks that have been consumed by this instance's children.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	320 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	321 private double usedForChildren = 0.0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	322
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	323 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	324 * Number of ticks allocated for this instance's children. This is the total number
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	325 * of ticks that may be passed into worked(int) or newChild(int).
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	326 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	327 private int totalForChildren;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	328
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	329 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	330 * Children created by newChild will be completed automatically the next time
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	331 * the parent progress monitor is touched. This points to the last incomplete child
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	332 * created with newChild.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	333 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	334 private IProgressMonitor lastSubMonitor = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	335
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	336 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	337 * Used to communicate with the root of this progress monitor tree
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	338 */
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	339 private final RootInfo root;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	340
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	341 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	342 * A bitwise combination of the SUPPRESS_* flags.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	343 */
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	344 private final int flags;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	345
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	346 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	347 * May be passed as a flag to newChild. Indicates that the calls
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	348 * to subTask on the child should be ignored. Without this flag,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	349 * calling subTask on the child will result in a call to subTask
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	350 * on its parent.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	351 */
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	352 public static final int SUPPRESS_SUBTASK = 0x0001;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	353
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	354 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	355 * May be passed as a flag to newChild. Indicates that strings
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	356 * passed into beginTask should be ignored. If this flag is
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	357 * specified, then the progress monitor instance will accept null
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	358 * as the first argument to beginTask. Without this flag, any
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	359 * string passed to beginTask will result in a call to
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	360 * setTaskName on the parent.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	361 */
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	362 public static final int SUPPRESS_BEGINTASK = 0x0002;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	363
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	364 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	365 * May be passed as a flag to newChild. Indicates that strings
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	366 * passed into setTaskName should be ignored. If this string
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	367 * is omitted, then a call to setTaskName on the child will
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	368 * result in a call to setTaskName on the parent.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	369 */
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	370 public static final int SUPPRESS_SETTASKNAME = 0x0004;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	371
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	372 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	373 * May be passed as a flag to newChild. Indicates that strings
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	374 * passed to setTaskName, subTask, and beginTask should all be ignored.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	375 */
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	376 public static final int SUPPRESS_ALL_LABELS = SUPPRESS_SETTASKNAME \| SUPPRESS_BEGINTASK \| SUPPRESS_SUBTASK;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	377
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	378 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	379 * May be passed as a flag to newChild. Indicates that strings
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	380 * passed to setTaskName, subTask, and beginTask should all be propogated
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	381 * to the parent.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	382 */
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	383 public static final int SUPPRESS_NONE = 0;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	384
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	385 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	386 * Creates a new SubMonitor that will report its progress via
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	387 * the given RootInfo.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	388 * @param rootInfo the root of this progress monitor tree
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	389 * @param totalWork total work to perform on the given progress monitor
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	390 * @param availableToChildren number of ticks allocated for this instance's children
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	391 * @param flags a bitwise combination of the SUPPRESS_* constants
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	392 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	393 private this(RootInfo rootInfo, int totalWork, int availableToChildren, int flags) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	394 root = rootInfo;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	395 totalParent = (totalWork > 0) ? totalWork : 0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	396 this.totalForChildren = availableToChildren;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	397 this.flags = flags;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	398 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	399
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	400 /**
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	401 * <p>Converts an unknown (possibly null) IProgressMonitor into a SubMonitor. It is
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	402 * not necessary to call done() on the result, but the caller is responsible for calling
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	403 * done() on the argument. Calls beginTask on the argument.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	404 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	405 * <p>This method should generally be called at the beginning of a method that accepts
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	406 * an IProgressMonitor in order to convert the IProgressMonitor into a SubMonitor.</p>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	407 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	408 * @param monitor monitor to convert to a SubMonitor instance or null. Treats null
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	409 * as a new instance of <code>NullProgressMonitor</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	410 * @return a SubMonitor instance that adapts the argument
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	411 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	412 public static SubMonitor convert(IProgressMonitor monitor) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	413 return convert(monitor, "", 0); //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	414 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	415
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	416 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	417 * <p>Converts an unknown (possibly null) IProgressMonitor into a SubMonitor allocated
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	418 * with the given number of ticks. It is not necessary to call done() on the result,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	419 * but the caller is responsible for calling done() on the argument. Calls beginTask
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	420 * on the argument.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	421 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	422 * <p>This method should generally be called at the beginning of a method that accepts
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	423 * an IProgressMonitor in order to convert the IProgressMonitor into a SubMonitor.</p>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	424 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	425 * @param monitor monitor to convert to a SubMonitor instance or null. Treats null
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	426 * as a new instance of <code>NullProgressMonitor</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	427 * @param work number of ticks that will be available in the resulting monitor
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	428 * @return a SubMonitor instance that adapts the argument
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	429 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	430 public static SubMonitor convert(IProgressMonitor monitor, int work) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	431 return convert(monitor, "", work); //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	432 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	433
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	434 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	435 * <p>Converts an unknown (possibly null) IProgressMonitor into a SubMonitor allocated
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	436 * with the given number of ticks. It is not necessary to call done() on the result,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	437 * but the caller is responsible for calling done() on the argument. Calls beginTask
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	438 * on the argument.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	439 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	440 * <p>This method should generally be called at the beginning of a method that accepts
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	441 * an IProgressMonitor in order to convert the IProgressMonitor into a SubMonitor.</p>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	442 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	443 * @param monitor to convert into a SubMonitor instance or null. If given a null argument,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	444 * the resulting SubMonitor will not report its progress anywhere.
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	445 * @param taskName user readable name to pass to monitor.beginTask. Never null.
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	446 * @param work initial number of ticks to allocate for children of the SubMonitor
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	447 * @return a new SubMonitor instance that is a child of the given monitor
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	448 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	449 public static SubMonitor convert(IProgressMonitor monitor, String taskName, int work) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	450 if (monitor is null)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	451 monitor = new NullProgressMonitor();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	452
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	453 // Optimization: if the given monitor already a SubMonitor, no conversion is necessary
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	454 if ( null !is cast(SubMonitor)monitor ) {
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	455 monitor.beginTask(taskName, work);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	456 return cast(SubMonitor) monitor;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	457 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	458
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	459 monitor.beginTask(taskName, MINIMUM_RESOLUTION);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	460 return new SubMonitor(new RootInfo(monitor), MINIMUM_RESOLUTION, work, SUPPRESS_NONE);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	461 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	462
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	463 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	464 * <p>Sets the work remaining for this SubMonitor instance. This is the total number
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	465 * of ticks that may be reported by all subsequent calls to worked(int), newChild(int), etc.
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	466 * This may be called many times for the same SubMonitor instance. When this method
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	467 * is called, the remaining space on the progress monitor is redistributed into the given
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	468 * number of ticks.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	469 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	470 * <p>It doesn't matter how much progress has already been reported with this SubMonitor
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	471 * instance. If you call setWorkRemaining(100), you will be able to report 100 more ticks of
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	472 * work before the progress meter reaches 100%.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	473 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	474 * @param workRemaining total number of remaining ticks
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	475 * @return the receiver
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	476 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	477 public SubMonitor setWorkRemaining(int workRemaining) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	478 // Ensure we don't try to allocate negative ticks
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	479 workRemaining = Math.max(0, workRemaining);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	480
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	481 // Ensure we don't cause division by zero
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	482 if (totalForChildren > 0 && totalParent > usedForParent) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	483 // Note: We want the following value to remain invariant after this method returns
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	484 double remainForParent = totalParent * (1.0d - (usedForChildren / totalForChildren));
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	485 usedForChildren = (workRemaining * (1.0d - remainForParent / (totalParent - usedForParent)));
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	486 } else
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	487 usedForChildren = 0.0d;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	488
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	489 totalParent = totalParent - usedForParent;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	490 usedForParent = 0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	491 totalForChildren = workRemaining;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	492 return this;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	493 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	494
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	495 /**
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	496 * Consumes the given number of child ticks, given as a double. Must only
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	497 * be called if the monitor is in floating-point mode.
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	498 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	499 * @param ticks the number of ticks to consume
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	500 * @return ticks the number of ticks to be consumed from parent
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	501 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	502 private int consume(double ticks) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	503 if (totalParent is 0 \|\| totalForChildren is 0) // this monitor has no available work to report
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	504 return 0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	505
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	506 usedForChildren += ticks;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	507
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	508 if (usedForChildren > totalForChildren)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	509 usedForChildren = totalForChildren;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	510 else if (usedForChildren < 0.0)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	511 usedForChildren = 0.0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	512
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	513 int parentPosition = cast(int) (totalParent * usedForChildren / totalForChildren);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	514 int delta = parentPosition - usedForParent;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	515
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	516 usedForParent = parentPosition;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	517 return delta;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	518 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	519
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	520 /* (non-Javadoc)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	521 * @see org.eclipse.core.runtime.IProgressMonitor#isCanceled()
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	522 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	523 public bool isCanceled() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	524 return root.isCanceled();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	525 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	526
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	527 /* (non-Javadoc)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	528 * @see org.eclipse.core.runtime.IProgressMonitor#setTaskName(java.lang.String)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	529 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	530 public void setTaskName(String name) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	531 if ((flags & SUPPRESS_SETTASKNAME) is 0)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	532 root.setTaskName(name);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	533 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	534
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	535 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	536 * Starts a new main task. The string argument is ignored
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	537 * if and only if the SUPPRESS_BEGINTASK flag has been set on this SubMonitor
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	538 * instance.
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	539 *
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	540 * <p>This method is equivalent calling setWorkRemaining(...) on the reciever. Unless
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	541 * the SUPPRESS_BEGINTASK flag is set, this will also be equivalent to calling
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	542 * setTaskName(...) on the parent.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	543 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	544 * @param name new main task name
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	545 * @param totalWork number of ticks to allocate
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	546 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	547 * @see org.eclipse.core.runtime.IProgressMonitor#beginTask(java.lang.String, int)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	548 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	549 public void beginTask(String name, int totalWork) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	550 if ((flags & SUPPRESS_BEGINTASK) is 0 && name !is null)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	551 root.setTaskName(name);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	552 setWorkRemaining(totalWork);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	553 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	554
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	555 /* (non-Javadoc)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	556 * @see org.eclipse.core.runtime.IProgressMonitor#done()
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	557 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	558 public void done() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	559 cleanupActiveChild();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	560 int delta = totalParent - usedForParent;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	561 if (delta > 0)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	562 root.worked(delta);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	563
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	564 totalParent = 0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	565 usedForParent = 0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	566 totalForChildren = 0;
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	567 usedForChildren = 0.0d;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	568 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	569
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	570 /* (non-Javadoc)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	571 * @see org.eclipse.core.runtime.IProgressMonitor#internalWorked(double)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	572 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	573 public void internalWorked(double work) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	574 cleanupActiveChild();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	575
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	576 int delta = consume((work > 0.0d) ? work : 0.0d);
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	577 if (delta !is 0)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	578 root.worked(delta);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	579 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	580
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	581 /* (non-Javadoc)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	582 * @see org.eclipse.core.runtime.IProgressMonitor#subTask(java.lang.String)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	583 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	584 public void subTask(String name) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	585 if ((flags & SUPPRESS_SUBTASK) is 0)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	586 root.subTask(name);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	587 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	588
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	589 /* (non-Javadoc)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	590 * @see org.eclipse.core.runtime.IProgressMonitor#worked(int)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	591 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	592 public void worked(int work) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	593 internalWorked(work);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	594 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	595
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	596 /* (non-Javadoc)
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	597 * @see org.eclipse.core.runtime.IProgressMonitor#setCanceled(boolean)
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	598 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	599 public void setCanceled(bool b) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	600 root.setCanceled(b);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	601 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	602
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	603 /**
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	604 * <p>Creates a sub progress monitor that will consume the given number of ticks from the
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	605 * receiver. It is not necessary to call <code>beginTask</code> or <code>done</code> on the
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	606 * result. However, the resulting progress monitor will not report any work after the first
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	607 * call to done() or before ticks are allocated. Ticks may be allocated by calling beginTask
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	608 * or setWorkRemaining.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	609 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	610 * <p>Each SubMonitor only has one active child at a time. Each time newChild() is called, the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	611 * result becomes the new active child and any unused progress from the previously-active child is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	612 * consumed.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	613 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	614 * <p>This is property makes it unnecessary to call done() on a SubMonitor instance, since child
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	615 * monitors are automatically cleaned up the next time the parent is touched.</p>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	616 *
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	617 * <code><pre>
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	618 * ////////////////////////////////////////////////////////////////////////////
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	619 * // Example 1: Typical usage of newChild
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	620 * void myMethod(IProgressMonitor parent) {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	621 * SubMonitor progress = SubMonitor.convert(parent, 100);
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	622 * doSomething(progress.newChild(50));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	623 * doSomethingElse(progress.newChild(50));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	624 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	625 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	626 * ////////////////////////////////////////////////////////////////////////////
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	627 * // Example 2: Demonstrates the function of active children. Creating children
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	628 * // is sufficient to smoothly report progress, even if worked(...) and done()
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	629 * // are never called.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	630 * void myMethod(IProgressMonitor parent) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	631 * SubMonitor progress = SubMonitor.convert(parent, 100);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	632 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	633 * for (int i = 0; i < 100; i++) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	634 * // Creating the next child monitor will clean up the previous one,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	635 * // causing progress to be reported smoothly even if we don't do anything
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	636 * // with the monitors we create
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	637 * progress.newChild(1);
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	638 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	639 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	640 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	641 * ////////////////////////////////////////////////////////////////////////////
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	642 * // Example 3: Demonstrates a common anti-pattern
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	643 * void wrongMethod(IProgressMonitor parent) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	644 * SubMonitor progress = SubMonitor.convert(parent, 100);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	645 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	646 * // WRONG WAY: Won't have the intended effect, as only one of these progress
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	647 * // monitors may be active at a time and the other will report no progress.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	648 * callMethod(progress.newChild(50), computeValue(progress.newChild(50)));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	649 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	650 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	651 * void rightMethod(IProgressMonitor parent) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	652 * SubMonitor progress = SubMonitor.convert(parent, 100);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	653 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	654 * // RIGHT WAY: Break up method calls so that only one SubMonitor is in use at a time.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	655 * Object someValue = computeValue(progress.newChild(50));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	656 * callMethod(progress.newChild(50), someValue);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	657 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	658 * </pre></code>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	659 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	660 * @param totalWork number of ticks to consume from the reciever
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	661 * @return new sub progress monitor that may be used in place of a new SubMonitor
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	662 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	663 public SubMonitor newChild(int totalWork) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	664 return newChild(totalWork, SUPPRESS_BEGINTASK);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	665 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	666
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	667 /**
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	668 * <p>Creates a sub progress monitor that will consume the given number of ticks from the
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	669 * receiver. It is not necessary to call <code>beginTask</code> or <code>done</code> on the
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	670 * result. However, the resulting progress monitor will not report any work after the first
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	671 * call to done() or before ticks are allocated. Ticks may be allocated by calling beginTask
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	672 * or setWorkRemaining.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	673 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	674 * <p>Each SubMonitor only has one active child at a time. Each time newChild() is called, the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	675 * result becomes the new active child and any unused progress from the previously-active child is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	676 * consumed.</p>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	677 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	678 * <p>This is property makes it unnecessary to call done() on a SubMonitor instance, since child
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	679 * monitors are automatically cleaned up the next time the parent is touched.</p>
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	680 *
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	681 * <code><pre>
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	682 * ////////////////////////////////////////////////////////////////////////////
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	683 * // Example 1: Typical usage of newChild
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	684 * void myMethod(IProgressMonitor parent) {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	685 * SubMonitor progress = SubMonitor.convert(parent, 100);
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	686 * doSomething(progress.newChild(50));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	687 * doSomethingElse(progress.newChild(50));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	688 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	689 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	690 * ////////////////////////////////////////////////////////////////////////////
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	691 * // Example 2: Demonstrates the function of active children. Creating children
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	692 * // is sufficient to smoothly report progress, even if worked(...) and done()
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	693 * // are never called.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	694 * void myMethod(IProgressMonitor parent) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	695 * SubMonitor progress = SubMonitor.convert(parent, 100);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	696 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	697 * for (int i = 0; i < 100; i++) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	698 * // Creating the next child monitor will clean up the previous one,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	699 * // causing progress to be reported smoothly even if we don't do anything
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	700 * // with the monitors we create
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	701 * progress.newChild(1);
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	702 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	703 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	704 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	705 * ////////////////////////////////////////////////////////////////////////////
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	706 * // Example 3: Demonstrates a common anti-pattern
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	707 * void wrongMethod(IProgressMonitor parent) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	708 * SubMonitor progress = SubMonitor.convert(parent, 100);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	709 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	710 * // WRONG WAY: Won't have the intended effect, as only one of these progress
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	711 * // monitors may be active at a time and the other will report no progress.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	712 * callMethod(progress.newChild(50), computeValue(progress.newChild(50)));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	713 * }
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	714 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	715 * void rightMethod(IProgressMonitor parent) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	716 * SubMonitor progress = SubMonitor.convert(parent, 100);
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	717 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	718 * // RIGHT WAY: Break up method calls so that only one SubMonitor is in use at a time.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	719 * Object someValue = computeValue(progress.newChild(50));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	720 * callMethod(progress.newChild(50), someValue);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	721 * }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	722 * </pre></code>
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	723 *
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	724 * @param totalWork number of ticks to consume from the reciever
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	725 * @return new sub progress monitor that may be used in place of a new SubMonitor
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	726 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	727 public SubMonitor newChild(int totalWork, int suppressFlags) {
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	728 double totalWorkDouble = (totalWork > 0) ? totalWork : 0.0d;
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	729 totalWorkDouble = Math.min(totalWorkDouble, totalForChildren - usedForChildren);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	730 cleanupActiveChild();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	731
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	732 // Compute the flags for the child. We want the net effect to be as though the child is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	733 // delegating to its parent, even though it is actually talking directly to the root.
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	734 // This means that we need to compute the flags such that - even if a label isn't
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	735 // suppressed by the child - if that same label would have been suppressed when the
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	736 // child delegated to its parent, the child must explicitly suppress the label.
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	737 int childFlags = SUPPRESS_NONE;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	738
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	739 if ((flags & SUPPRESS_SETTASKNAME) !is 0) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	740 // If the parent was ignoring labels passed to setTaskName, then the child will ignore
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	741 // labels passed to either beginTask or setTaskName - since both delegate to setTaskName
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	742 // on the parent
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	743 childFlags \|= SUPPRESS_SETTASKNAME \| SUPPRESS_BEGINTASK;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	744 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	745
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	746 if ((flags & SUPPRESS_SUBTASK) !is 0) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	747 // If the parent was suppressing labels passed to subTask, so will the child.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	748 childFlags \|= SUPPRESS_SUBTASK;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	749 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	750
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	751 // Note: the SUPPRESS_BEGINTASK flag does not affect the child since there
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	752 // is no method on the child that would delegate to beginTask on the parent.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	753 childFlags \|= suppressFlags;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	754
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	755 SubMonitor result = new SubMonitor(root, consume(totalWorkDouble), 0, childFlags);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	756 lastSubMonitor = result;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	757 return result;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	758 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	759
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	760 private void cleanupActiveChild() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	761 if (lastSubMonitor is null)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	762 return;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	763
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	764 IProgressMonitor child = lastSubMonitor;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	765 lastSubMonitor = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	766 child.done();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	767 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	768
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	769 /* (non-Javadoc)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	770 * @see org.eclipse.core.runtime.IProgressMonitorWithBlocking#clearBlocked()
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	771 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	772 public void clearBlocked() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	773 root.clearBlocked();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	774 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	775
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	776 /* (non-Javadoc)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	777 * @see org.eclipse.core.runtime.IProgressMonitorWithBlocking#setBlocked(org.eclipse.core.runtime.IStatus)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	778 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	779 public void setBlocked(IStatus reason) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	780 root.setBlocked(reason);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	781 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	782
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	783 protected static bool eq(Object o1, Object o2) {
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	784 if (o1 is null)
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	785 return (o2 is null);
bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	786 if (o2 is null)
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	787 return false;
105 bbe49769ec18 ... Frank Benoit <benoit@tionex.de> parents: 12 diff changeset	788 return o1.opEquals(o2);
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	789 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	790 }

Mercurial > projects > dwt2

annotate org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.d @ 105:bbe49769ec18