Mercurial > projects > dwt-addons
annotate dwtx/jface/text/reconciler/AbstractReconcileStep.d @ 158:25f1f92fa3df
...
| author | Frank Benoit <benoit@tionex.de> |
|---|---|
| date | Tue, 26 Aug 2008 02:46:34 +0200 |
| parents | f70d9508c95c |
| children | 1a5b8f8129df |
| rev | line source |
|---|---|
| 129 | 1 /******************************************************************************* |
| 2 * Copyright (c) 2000, 2006 IBM Corporation and others. | |
| 3 * All rights reserved. This program and the accompanying materials | |
| 4 * are made available under the terms of the Eclipse Public License v1.0 | |
| 5 * which accompanies this distribution, and is available at | |
| 6 * http://www.eclipse.org/legal/epl-v10.html | |
| 7 * | |
| 8 * Contributors: | |
| 9 * IBM Corporation - initial API and implementation | |
| 10 * Port to the D programming language: | |
| 11 * Frank Benoit <benoit@tionex.de> | |
| 12 *******************************************************************************/ | |
| 13 module dwtx.jface.text.reconciler.AbstractReconcileStep; | |
| 14 | |
| 131 | 15 import dwtx.jface.text.reconciler.IReconciler; // packageimport |
| 16 import dwtx.jface.text.reconciler.DirtyRegionQueue; // packageimport | |
| 17 import dwtx.jface.text.reconciler.IReconcilingStrategy; // packageimport | |
| 18 import dwtx.jface.text.reconciler.IReconcilingStrategyExtension; // packageimport | |
| 19 import dwtx.jface.text.reconciler.MonoReconciler; // packageimport | |
| 20 import dwtx.jface.text.reconciler.IReconcileStep; // packageimport | |
| 21 import dwtx.jface.text.reconciler.AbstractReconciler; // packageimport | |
| 22 import dwtx.jface.text.reconciler.Reconciler; // packageimport | |
| 23 import dwtx.jface.text.reconciler.IReconcilableModel; // packageimport | |
| 24 import dwtx.jface.text.reconciler.DirtyRegion; // packageimport | |
| 25 import dwtx.jface.text.reconciler.IReconcileResult; // packageimport | |
| 26 import dwtx.jface.text.reconciler.IReconcilerExtension; // packageimport | |
| 27 | |
| 28 | |
| 129 | 29 import dwt.dwthelper.utils; |
| 30 | |
|
153
f70d9508c95c
Fix java Collection imports
Frank Benoit <benoit@tionex.de>
parents:
133
diff
changeset
|
31 import dwtx.dwtxhelper.Collection; |
|
f70d9508c95c
Fix java Collection imports
Frank Benoit <benoit@tionex.de>
parents:
133
diff
changeset
|
32 |
|
f70d9508c95c
Fix java Collection imports
Frank Benoit <benoit@tionex.de>
parents:
133
diff
changeset
|
33 |
| 129 | 34 |
| 35 import dwtx.core.runtime.Assert; | |
| 36 import dwtx.core.runtime.IProgressMonitor; | |
| 37 import dwtx.jface.text.IRegion; | |
| 38 | |
| 39 | |
| 40 /** | |
| 41 * Abstract implementation of a reconcile step. | |
| 42 * | |
| 43 * @since 3.0 | |
| 44 */ | |
| 45 public abstract class AbstractReconcileStep : IReconcileStep { | |
| 46 | |
| 47 private IReconcileStep fNextStep; | |
| 48 private IReconcileStep fPreviousStep; | |
| 49 private IProgressMonitor fProgressMonitor; | |
| 50 protected IReconcilableModel fInputModel; | |
| 51 | |
| 52 /** | |
| 53 * Creates an intermediate reconcile step which adds | |
| 54 * the given step to the pipe. | |
| 55 * | |
| 56 * @param step the reconcile step | |
| 57 */ | |
|
133
7d818bd32d63
Fix ctors to this with gvim regexp
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
58 public this(IReconcileStep step) { |
| 129 | 59 Assert.isNotNull(step); |
| 60 fNextStep= step; | |
| 61 fNextStep.setPreviousStep(this); | |
| 62 } | |
| 63 | |
| 64 /** | |
| 65 * Creates the last reconcile step of the pipe. | |
| 66 */ | |
|
133
7d818bd32d63
Fix ctors to this with gvim regexp
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
67 public this() { |
| 129 | 68 } |
| 69 | |
| 70 public bool isLastStep() { | |
| 71 return fNextStep is null; | |
| 72 } | |
| 73 | |
| 74 public bool isFirstStep() { | |
| 75 return fPreviousStep is null; | |
| 76 } | |
| 77 | |
| 78 /* | |
| 79 * @see dwtx.text.reconcilerpipe.IReconcilerResultCollector#setProgressMonitor(dwtx.core.runtime.IProgressMonitor) | |
| 80 */ | |
| 81 public void setProgressMonitor(IProgressMonitor monitor) { | |
| 82 fProgressMonitor= monitor; | |
| 83 | |
| 84 if (!isLastStep()) | |
| 85 fNextStep.setProgressMonitor(monitor); | |
| 86 } | |
| 87 | |
| 88 /* | |
| 89 * @see dwtx.jface.text.reconciler.IReconcileStep#getProgressMonitor() | |
| 90 */ | |
| 91 public IProgressMonitor getProgressMonitor() { | |
| 92 return fProgressMonitor; | |
| 93 } | |
| 94 | |
| 95 /* | |
| 96 * @see IReconcileStep#reconcile(IRegion) | |
| 97 */ | |
| 98 public final IReconcileResult[] reconcile(IRegion partition) { | |
| 99 IReconcileResult[] result= reconcileModel(null, partition); | |
| 100 if (!isLastStep()) { | |
| 101 fNextStep.setInputModel(getModel()); | |
| 102 IReconcileResult[] nextResult= fNextStep.reconcile(partition); | |
| 103 return merge(result, convertToInputModel(nextResult)); | |
| 104 } | |
| 105 return result; | |
| 106 } | |
| 107 | |
| 108 /* | |
| 109 * @see IReconcileStep#reconcile(dwtx.jface.text.reconciler.DirtyRegion, dwtx.jface.text.IRegion) | |
| 110 */ | |
| 111 public final IReconcileResult[] reconcile(DirtyRegion dirtyRegion, IRegion subRegion) { | |
| 112 IReconcileResult[] result= reconcileModel(dirtyRegion, subRegion); | |
| 113 if (!isLastStep()) { | |
| 114 fNextStep.setInputModel(getModel()); | |
| 115 IReconcileResult[] nextResult= fNextStep.reconcile(dirtyRegion, subRegion); | |
| 116 return merge(result, convertToInputModel(nextResult)); | |
| 117 } | |
| 118 return result; | |
| 119 } | |
| 120 | |
| 121 | |
| 122 /** | |
| 123 * Reconciles the model of this reconcile step. The | |
| 124 * result is based on the input model. | |
| 125 * | |
| 126 * @param dirtyRegion the document region which has been changed | |
| 127 * @param subRegion the sub region in the dirty region which should be reconciled | |
| 128 * @return an array with reconcile results | |
| 129 */ | |
| 130 abstract protected IReconcileResult[] reconcileModel(DirtyRegion dirtyRegion, IRegion subRegion); | |
| 131 | |
| 132 /** | |
| 133 * Adapts the given an array with reconcile results to | |
| 134 * this step's input model and returns it. | |
| 135 * | |
| 136 * @param inputResults an array with reconcile results | |
| 137 * @return an array with the reconcile results adapted to the input model | |
| 138 */ | |
| 139 protected IReconcileResult[] convertToInputModel(IReconcileResult[] inputResults) { | |
| 140 return inputResults; | |
| 141 } | |
| 142 | |
| 143 /** | |
| 144 * Merges the two reconcile result arrays. | |
| 145 * | |
| 146 * @param results1 an array with reconcile results | |
| 147 * @param results2 an array with reconcile results | |
| 148 * @return an array with the merged reconcile results | |
| 149 */ | |
| 150 private IReconcileResult[] merge(IReconcileResult[] results1, IReconcileResult[] results2) { | |
| 151 if (results1 is null) | |
| 152 return results2; | |
| 153 | |
| 154 if (results2 is null) | |
| 155 return results1; | |
| 156 | |
| 157 // XXX: not yet performance optimized | |
| 158 Collection collection= new ArrayList(Arrays.asList(results1)); | |
| 159 collection.addAll(Arrays.asList(results2)); | |
| 158 | 160 return arraycast!(IReconcileResult)(collection.toArray()); |
| 129 | 161 } |
| 162 | |
| 163 /* | |
| 164 * @see IProgressMonitor#isCanceled() | |
| 165 */ | |
| 166 protected final bool isCanceled() { | |
| 167 return fProgressMonitor !is null && fProgressMonitor.isCanceled(); | |
| 168 } | |
| 169 | |
| 170 /* | |
| 171 * @see IReconcileStep#setPreviousStep(IReconcileStep) | |
| 172 */ | |
| 173 public void setPreviousStep(IReconcileStep step) { | |
| 174 Assert.isNotNull(step); | |
| 175 Assert.isTrue(fPreviousStep is null); | |
| 176 fPreviousStep= step; | |
| 177 } | |
| 178 | |
| 179 /* | |
| 180 * @see IReconcileStep#setInputModel(Object) | |
| 181 */ | |
| 182 public void setInputModel(IReconcilableModel inputModel) { | |
| 183 fInputModel= inputModel; | |
| 184 | |
| 185 if (!isLastStep()) | |
| 186 fNextStep.setInputModel(getModel()); | |
| 187 } | |
| 188 | |
| 189 /** | |
| 190 * Returns the reconcilable input model. | |
| 191 * | |
| 192 * @return the reconcilable input model. | |
| 193 */ | |
| 194 public IReconcilableModel getInputModel() { | |
| 195 return fInputModel; | |
| 196 } | |
| 197 | |
| 198 /** | |
| 199 * Returns the reconcilable model. | |
| 200 * | |
| 201 * @return the reconcilable model | |
| 202 */ | |
| 203 abstract public IReconcilableModel getModel(); | |
| 204 } |