Action borrowed from cfeclipse: "remove trailing spaces at end of file"
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / actions / RTrimAction.java
1 /*
2  * Created on Oct 15, 2004
3  *
4  * The MIT License
5  * Copyright (c) 2004 Stephen Milligan
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a 
8  * copy of this software and associated documentation files (the "Software"), 
9  * to deal in the Software without restriction, including without limitation 
10  * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
11  * and/or sell copies of the Software, and to permit persons to whom the Software 
12  * is furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in 
15  * all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
23  * SOFTWARE.
24  */
25 package net.sourceforge.phpeclipse.phpeditor.actions;
26
27 import org.eclipse.jface.action.IAction;
28 import org.eclipse.jface.text.IDocument;
29 import org.eclipse.jface.text.ITextSelection;
30 import org.eclipse.jface.text.TextSelection;
31 import org.eclipse.jface.viewers.ISelection;
32 import org.eclipse.ui.IEditorActionDelegate;
33 import org.eclipse.ui.IEditorPart;
34 import org.eclipse.ui.texteditor.ITextEditor;
35
36 /**
37  * @author Stephen Milligan
38  */
39 public class RTrimAction implements IEditorActionDelegate {
40
41         ITextEditor editor = null;
42
43         /**
44          *  
45          */
46         public RTrimAction() {
47                 super();
48         }
49
50         public void setActiveEditor(IAction action, IEditorPart targetEditor) {
51
52                 if (targetEditor instanceof ITextEditor) {
53                         editor = (ITextEditor) targetEditor;
54                 }
55         }
56
57         /**
58          * this gets called for every action
59          */
60         public void run(IAction action) {
61                 IDocument doc = editor.getDocumentProvider().getDocument(editor.getEditorInput());
62                 ITextSelection sel = (ITextSelection) editor.getSelectionProvider().getSelection();
63
64                 int currentLine = 0;
65                 int originalCursorOffset = sel.getOffset();
66                 int cursorOffset = originalCursorOffset;
67                 int originalSelectionLength = sel.getLength();
68                 int selectionLength = originalSelectionLength;
69                 String oldText;
70                 int     lineEnd;
71                 
72                 try {
73
74                         while (currentLine < doc.getNumberOfLines()) {
75                                 int offset = doc.getLineOffset(currentLine);
76                                 int length = doc.getLineLength(currentLine);
77                                 oldText = doc.get(offset, length);
78                                 
79                                 //-- Starts at the end of the line, looking for the first non-first 'white space'
80                                 //-- it then breaks out. No point in carrying on, as we have found our true line end
81                                 for (lineEnd=oldText.length(); lineEnd > 0; --lineEnd ){
82                                         if ( oldText.charAt(lineEnd-1) != '\t' && oldText.charAt(lineEnd-1) != ' ' ){
83                                                 break;
84                                         }
85                                 }
86                                 
87                                 //-- Only replace the line if the lengths are different
88                                 if ( lineEnd != oldText.length() ) {
89                                         String newText = oldText.substring(0, lineEnd);
90                                         doc.replace(offset, length, newText);
91
92                                         if (offset + length <= cursorOffset) {
93                                                 if (oldText.length() != newText.length()) {
94                                                         cursorOffset -= oldText.length() - newText.length();
95                                                 }
96                                         } else if (offset <= cursorOffset + selectionLength     && selectionLength > 0) {
97                                                 selectionLength -= oldText.length() - newText.length();
98                                         }       else if (offset + length == cursorOffset + 2) { // Check if the cursor is at the end of the line.
99                                                 cursorOffset -= 2;
100                                         }
101                                 }
102                                 currentLine++;
103                         }
104
105                         TextSelection selection = new TextSelection(doc, cursorOffset, selectionLength);
106                         editor.getSelectionProvider().setSelection(selection);
107                 } catch (Exception blx) {
108                         blx.printStackTrace();
109                 }
110         }
111
112         public void selectionChanged(IAction action, ISelection selection) {
113         }
114 }