new version with WorkingCopy Management
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / core / DeleteElementsOperation.java
diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/core/DeleteElementsOperation.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/core/DeleteElementsOperation.java
new file mode 100644 (file)
index 0000000..b79a550
--- /dev/null
@@ -0,0 +1,164 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials 
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * 
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package net.sourceforge.phpdt.internal.core;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+
+import net.sourceforge.phpdt.core.IBuffer;
+import net.sourceforge.phpdt.core.ICompilationUnit;
+import net.sourceforge.phpdt.core.IJavaElement;
+import net.sourceforge.phpdt.core.IJavaModelStatusConstants;
+import net.sourceforge.phpdt.core.IRegion;
+import net.sourceforge.phpdt.core.JavaModelException;
+import net.sourceforge.phpdt.core.compiler.CharOperation;
+import net.sourceforge.phpdt.core.jdom.DOMFactory;
+import net.sourceforge.phpdt.core.jdom.IDOMCompilationUnit;
+import net.sourceforge.phpdt.internal.core.jdom.DOMNode;
+import net.sourceforge.phpdt.internal.corext.Assert;
+
+/**
+ * This operation deletes a collection of elements (and
+ * all of their children).
+ * If an element does not exist, it is ignored.
+ *
+ * <p>NOTE: This operation only deletes elements contained within leaf resources -
+ * that is, elements within compilation units. To delete a compilation unit or
+ * a package, etc (which have an actual resource), a DeleteResourcesOperation
+ * should be used.
+ */
+public class DeleteElementsOperation extends MultiOperation {
+       /**
+        * The elements this operation processes grouped by compilation unit
+        * @see processElements(). Keys are compilation units,
+        * values are <code>IRegion</code>s of elements to be processed in each
+        * compilation unit.
+        */ 
+       protected Map fChildrenToRemove;
+       /**
+        * The <code>DOMFactory</code> used to manipulate the source code of
+        * <code>ICompilationUnit</code>s.
+        */
+       protected DOMFactory fFactory;
+       /**
+        * When executed, this operation will delete the given elements. The elements
+        * to delete cannot be <code>null</code> or empty, and must be contained within a
+        * compilation unit.
+        */
+       public DeleteElementsOperation(IJavaElement[] elementsToDelete, boolean force) {
+               super(elementsToDelete, force);
+               fFactory = new DOMFactory();
+       }
+       
+       /**
+        * @see MultiOperation
+        */
+       protected String getMainTaskName() {
+               return Util.bind("operation.deleteElementProgress"); //$NON-NLS-1$
+       }
+       /**
+        * Groups the elements to be processed by their compilation unit.
+        * If parent/child combinations are present, children are
+        * discarded (only the parents are processed). Removes any
+        * duplicates specified in elements to be processed.
+        */
+       protected void groupElements() throws JavaModelException {
+               fChildrenToRemove = new HashMap(1);
+               int uniqueCUs = 0;
+               for (int i = 0, length = fElementsToProcess.length; i < length; i++) {
+                       IJavaElement e = fElementsToProcess[i];
+                       ICompilationUnit cu = getCompilationUnitFor(e);
+                       if (cu == null) {
+                               throw new JavaModelException(new JavaModelStatus(JavaModelStatus.READ_ONLY, e));
+                       } else {
+                               IRegion region = (IRegion) fChildrenToRemove.get(cu);
+                               if (region == null) {
+                                       region = new Region();
+                                       fChildrenToRemove.put(cu, region);
+                                       uniqueCUs += 1;
+                               }
+                               region.add(e);
+                       }
+               }
+               fElementsToProcess = new IJavaElement[uniqueCUs];
+               Iterator iter = fChildrenToRemove.keySet().iterator();
+               int i = 0;
+               while (iter.hasNext()) {
+                       fElementsToProcess[i++] = (IJavaElement) iter.next();
+               }
+       }
+       /**
+        * Deletes this element from its compilation unit.
+        * @see MultiOperation
+        */
+       protected void processElement(IJavaElement element) throws JavaModelException {
+               ICompilationUnit cu = (ICompilationUnit) element;
+       
+               // keep track of the import statements - if all are removed, delete
+               // the import container (and report it in the delta)
+//             int numberOfImports = cu.getImports().length;
+       
+               IBuffer buffer = cu.getBuffer();
+               if (buffer == null) return;
+               JavaElementDelta delta = new JavaElementDelta(cu);
+               IJavaElement[] cuElements = ((IRegion) fChildrenToRemove.get(cu)).getElements();
+               for (int i = 0, length = cuElements.length; i < length; i++) {
+                       IJavaElement e = cuElements[i];
+                       if (e.exists()) {
+                               char[] contents = buffer.getCharacters();
+                               if (contents == null) continue;
+                               IDOMCompilationUnit cuDOM = fFactory.createCompilationUnit(contents, cu.getElementName());
+                               DOMNode node = (DOMNode)((JavaElement) e).findNode(cuDOM);
+                               if (node == null) Assert.isTrue(false, "Failed to locate " + e.getElementName() + " in " + cuDOM.getName()); //$NON-NLS-1$//$NON-NLS-2$
+
+                               int startPosition = node.getStartPosition();
+                               buffer.replace(startPosition, node.getEndPosition() - startPosition + 1, CharOperation.NO_CHAR);
+                               delta.removed(e);
+//                             if (e.getElementType() == IJavaElement.IMPORT_DECLARATION) {
+//                                     numberOfImports--;
+//                                     if (numberOfImports == 0) {
+//                                             delta.removed(cu.getImportContainer());
+//                                     }
+//                             }
+                       }
+               }
+               if (delta.getAffectedChildren().length > 0) {
+                       cu.save(getSubProgressMonitor(1), fForce);
+                       if (!cu.isWorkingCopy()) { // if unit is working copy, then save will have already fired the delta
+                               addDelta(delta);
+                               this.setAttribute(HAS_MODIFIED_RESOURCE_ATTR, TRUE);
+                       }
+               }
+       }
+       /**
+        * @see MultiOperation
+        * This method first group the elements by <code>ICompilationUnit</code>,
+        * and then processes the <code>ICompilationUnit</code>.
+        */
+       protected void processElements() throws JavaModelException {
+               groupElements();
+               super.processElements();
+       }
+       /**
+        * @see MultiOperation
+        */
+       protected void verify(IJavaElement element) throws JavaModelException {
+               IJavaElement[] children = ((IRegion) fChildrenToRemove.get(element)).getElements();
+               for (int i = 0; i < children.length; i++) {
+                       IJavaElement child = children[i];
+                       if (child.getCorrespondingResource() != null)
+                               error(IJavaModelStatusConstants.INVALID_ELEMENT_TYPES, child);
+                       if (child.isReadOnly())
+                               error(IJavaModelStatusConstants.READ_ONLY, child);
+               }
+       }
+}