net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/text/java/JavaStringAutoIndentStrategySQ.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package net.sourceforge.phpdt.internal.ui.text.java;
  12
  13 import net.sourceforge.phpdt.ui.PreferenceConstants;
  14 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
  15
  16 import org.eclipse.jface.preference.IPreferenceStore;
  17 import org.eclipse.jface.text.BadLocationException;
  18 import org.eclipse.jface.text.DefaultIndentLineAutoEditStrategy;
  19 import org.eclipse.jface.text.DocumentCommand;
  20 import org.eclipse.jface.text.IDocument;
  21 import org.eclipse.jface.text.IRegion;
  22 import org.eclipse.jface.text.ITypedRegion;
  23 import org.eclipse.jface.text.TextUtilities;
  24 import org.eclipse.ui.IEditorPart;
  25 import org.eclipse.ui.IWorkbenchPage;
  26 import org.eclipse.ui.texteditor.ITextEditorExtension3;
  27
  28 /**
  29  * Auto indent strategy for single quoted PHP strings
  30  */
  31 public class JavaStringAutoIndentStrategySQ extends
  32                 DefaultIndentLineAutoEditStrategy {
  33
  34         private String fPartitioning;
  35
  36         /**
  37          * The input string doesn't contain any line delimiter.
  38          *
  39          * @param inputString
  40          *            the given input string
  41          * @return the displayable string.
  42          */
  43         private String displayString (String inputString, String indentation, String delimiter) {
  44                 int length = inputString.length();
  45                 StringBuffer buffer = new StringBuffer(length);
  46                 java.util.StringTokenizer tokenizer =
  47                                 new java.util.StringTokenizer (inputString, "\n\r", true); //$NON-NLS-1$
  48
  49                 while (tokenizer.hasMoreTokens ()) {
  50                         String token = tokenizer.nextToken ();
  51
  52                         if (token.equals("\r")) { //$NON-NLS-1$
  53                                 buffer.append("\\r"); //$NON-NLS-1$
  54                                 if (tokenizer.hasMoreTokens()) {
  55                                         token = tokenizer.nextToken();
  56                                         if (token.equals("\n")) { //$NON-NLS-1$
  57                                                 buffer.append("\\n"); //$NON-NLS-1$
  58                                                 buffer.append("\" . " + delimiter); //$NON-NLS-1$
  59                                                 buffer.append(indentation);
  60                                                 buffer.append("\'"); //$NON-NLS-1$
  61                                                 continue;
  62                                         } else {
  63                                                 buffer.append("\' . " + delimiter); //$NON-NLS-1$
  64                                                 buffer.append(indentation);
  65                                                 buffer.append("\'"); //$NON-NLS-1$
  66                                         }
  67                                 } else {
  68                                         continue;
  69                                 }
  70                         } else if (token.equals("\n")) { //$NON-NLS-1$
  71                                 buffer.append("\\n"); //$NON-NLS-1$
  72                                 buffer.append("\' . " + delimiter); //$NON-NLS-1$
  73                                 buffer.append(indentation);
  74                                 buffer.append("\'"); //$NON-NLS-1$
  75                                 continue;
  76                         }
  77
  78                         StringBuffer tokenBuffer = new StringBuffer();
  79
  80                         for (int i = 0; i < token.length(); i++) {
  81                                 char c = token.charAt(i);
  82                                 switch (c) {
  83                                 case '\r':
  84                                         tokenBuffer.append("\\r"); //$NON-NLS-1$
  85                                         break;
  86                                 case '\n':
  87                                         tokenBuffer.append("\\n"); //$NON-NLS-1$
  88                                         break;
  89                                 case '\b':
  90                                         tokenBuffer.append("\\b"); //$NON-NLS-1$
  91                                         break;
  92                                 case '\t':
  93                                         // keep tabs verbatim
  94                                         tokenBuffer.append("\t"); //$NON-NLS-1$
  95                                         break;
  96                                 case '\f':
  97                                         tokenBuffer.append("\\f"); //$NON-NLS-1$
  98                                         break;
  99                                 case '\"':
 100                                         tokenBuffer.append("\\\""); //$NON-NLS-1$
 101                                         break;
 102                                 case '\'':
 103                                         tokenBuffer.append("\\'"); //$NON-NLS-1$
 104                                         break;
 105                                 case '\\':
 106                                         tokenBuffer.append("\\\\"); //$NON-NLS-1$
 107                                         break;
 108                                 default:
 109                                         tokenBuffer.append(c);
 110                                 }
 111                         }
 112                         buffer.append(tokenBuffer);
 113                 }
 114
 115                 return buffer.toString();
 116         }
 117
 118         /**
 119          * Creates a new Java string auto indent strategy for the given document
 120          * partitioning.
 121          *
 122          * @param partitioning
 123          *            the document partitioning
 124          */
 125         public JavaStringAutoIndentStrategySQ (String partitioning) {
 126                 super();
 127                 fPartitioning = partitioning;
 128         }
 129
 130         /**
 131          * Check whether the 'text' is one of the allowed line delimiters (e.g. \n \r)
 132          *
 133          * @param document The document object for which we do the check
 134          * @param text     The text with the possible delimiter
 135          * @return
 136          *  - true if 'text' is a valid delimiter
 137          *  - false if 'text' is not a valid delimiter
 138          */
 139         private boolean isLineDelimiter(IDocument document, String text) {
 140                 String[] delimiters = document.getLegalLineDelimiters();
 141
 142                 if (delimiters != null) {
 143                         return TextUtilities.equals(delimiters, text) > -1;
 144                 }
 145
 146                 return false;
 147         }
 148
 149         /**
 150          * Get back the indentation of the line to which the offset belongs.
 151          *
 152          * It searches the first occurrence of a white space (non space/non tab)
 153          *
 154          * @param document
 155          * @param offset
 156          * @return
 157          * @throws BadLocationException
 158          */
 159         private String getLineIndentation(IDocument document, int offset)
 160                         throws BadLocationException {
 161                 String indentation = "";
 162                 int    start;
 163                 int    end;
 164                 int    length = 0;
 165
 166                 // find start of line
 167                 int adjustedOffset = (offset == document.getLength() ? offset - 1 : offset);// Check whether the offset is not at the end of file
 168                 IRegion line = document.getLineInformationOfOffset (adjustedOffset);            // Get the start and the length of the line
 169
 170                 start = line.getOffset ();                                                                      // Get the start of the line
 171                 end = findStringStart (document, start, offset);
 172
 173                 IPreferenceStore preferenceStore = PHPeclipsePlugin.getDefault().getPreferenceStore();
 174
 175                 int tabWidth = preferenceStore.getInt (PreferenceConstants.EDITOR_TAB_WIDTH);
 176
 177                 for (int pos = start; pos < end; pos++) {
 178                         if (document.getChar (pos) == '\t') {           // If the character is a tab
 179                                 length += tabWidth;                                             // take the tab width for calculating the indentation length
 180                         }
 181                         else {                                                                          // If it's just a space
 182                                 length++;                                                               // add one character to the indentation length
 183                         }
 184                 }
 185
 186                 if (preferenceStore.getBoolean (PreferenceConstants.EDITOR_SPACES_FOR_TABS)) {  // Indentation with spaces only
 187                         if (length > 0) {
 188                                 indentation = String.format ("%" + length + "s", "");
 189                         }
 190                 }
 191                 else {                                                                                                                                                  // Indentation with tabs
 192                         if (length > 0) {
 193                                 int spaces;
 194                                 int tabs;
 195
 196                                 tabs   = length / tabWidth;
 197                                 spaces = length % tabWidth;
 198
 199                                 indentation  = new String (new char[tabs]).replace('\0', '\t');
 200
 201                                 if (spaces > 0) {
 202                                         indentation += String.format ("%" + spaces + "s", "");
 203                                 }
 204                         }
 205                 }
 206
 207                 return indentation;
 208         }
 209
 210         /**
 211          * Return the position of the string start (first occurrence of a quote or double quote)
 212          *
 213          * @param offset
 214          * @param start
 215          * @param document
 216          * @return
 217          */
 218         private int findStringStart(IDocument document, int offset, int end) throws BadLocationException {
 219                 while (offset < end) {
 220                         char c = document.getChar (offset);
 221
 222                         if ((c == '\'') || (c == '\"')) {
 223                                 return offset;
 224                         }
 225
 226                         offset++;
 227                 }
 228
 229                 return end;
 230         }
 231
 232         /**
 233          *
 234          * @param string
 235          * @param indentation
 236          * @param delimiter
 237          * @return
 238          * @throws BadLocationException
 239          */
 240         private String getModifiedText (String string, String indentation, String delimiter)
 241                         throws BadLocationException {
 242                 return displayString(string, indentation, delimiter);
 243         }
 244
 245         /**
 246          *
 247          * @param document
 248          * @param command
 249          * @throws BadLocationException
 250          */
 251         private void javaStringIndentAfterNewLine (IDocument document, DocumentCommand command) throws BadLocationException {
 252                 ITypedRegion partition = TextUtilities.getPartition (document, fPartitioning, command.offset, false);
 253                 int offset = partition.getOffset();
 254                 int length = partition.getLength();
 255
 256                 if (command.offset == offset) {
 257                         // we are really just before the string partition -> feet the event
 258                         // through the java indenter
 259                         // new
 260                         // JavaAutoIndentStrategy(fPartitioning).customizeDocumentCommand(document,
 261                         // command);
 262                         return;
 263                 }
 264
 265                 if ((command.offset == offset + length) &&
 266                         (document.getChar (offset + length - 1) == '\'')) {
 267                         return;
 268                 }
 269
 270                 String indentation = getLineIndentation(document, command.offset);
 271                 String delimiter = TextUtilities.getDefaultLineDelimiter(document);
 272
 273                 IRegion line = document.getLineInformationOfOffset(offset);
 274                 String string = document.get (line.getOffset(),
 275                                                       offset - line.getOffset());               // Get the current line as string
 276 /*
 277                 if (string.trim().length() != 0) {
 278                         indentation += String.valueOf("\t\t"); //$NON-NLS-1$
 279                 }
 280 */
 281                 IPreferenceStore preferenceStore = PHPeclipsePlugin.getDefault ().getPreferenceStore();
 282
 283                 if (isLineDelimiter (document, command.text)) {
 284                         command.text = "\' ." + command.text + indentation + "\'"; //$NON-NLS-1$//$NON-NLS-2$
 285                 }
 286                 else if ((command.text.length() > 1) &&
 287                                  preferenceStore.getBoolean (PreferenceConstants.EDITOR_ESCAPE_STRINGS_SQ)) {
 288                         command.text = getModifiedText(command.text, indentation, delimiter);
 289         }
 290         }
 291
 292         /**
 293          *
 294          * @return
 295          */
 296         private boolean isSmartMode() {
 297                 IWorkbenchPage page = PHPeclipsePlugin.getActivePage();
 298
 299                 if (page != null) {
 300                         IEditorPart part = page.getActiveEditor();
 301
 302                         if (part instanceof ITextEditorExtension3) {
 303                                 ITextEditorExtension3 extension = (ITextEditorExtension3) part;
 304                                 return extension.getInsertMode() == ITextEditorExtension3.SMART_INSERT;
 305                         }
 306                 }
 307
 308                 return false;
 309         }
 310
 311         /*
 312          * @see org.eclipse.jface.text.IAutoIndentStrategy#customizeDocumentCommand(IDocument,
 313          *      DocumentCommand)
 314          */
 315         public void customizeDocumentCommand(IDocument document, DocumentCommand command) {
 316                 try {
 317                         if ((command.length != 0) ||
 318                 (command.text == null)) {
 319                                 return;
 320             }
 321
 322                         IPreferenceStore preferenceStore = PHPeclipsePlugin.getDefault().getPreferenceStore();
 323
 324                         if (preferenceStore.getBoolean (PreferenceConstants.EDITOR_WRAP_STRINGS_SQ) && isSmartMode()) {
 325                                 javaStringIndentAfterNewLine(document, command);
 326             }
 327
 328                 } catch (BadLocationException e) {
 329                 }
 330         }
 331 }