Java tutorial
/* * Copyright 2000-2014 JetBrains s.r.o. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.intellij.testFramework; import com.intellij.ide.DataManager; import com.intellij.openapi.actionSystem.*; import com.intellij.openapi.application.Result; import com.intellij.openapi.command.WriteCommandAction; import com.intellij.openapi.editor.*; import com.intellij.openapi.editor.actionSystem.EditorActionHandler; import com.intellij.openapi.editor.actionSystem.EditorActionManager; import com.intellij.openapi.editor.actionSystem.TypedAction; import com.intellij.openapi.editor.ex.EditorEx; import com.intellij.openapi.editor.ex.util.EditorUtil; import com.intellij.openapi.editor.highlighter.EditorHighlighter; import com.intellij.openapi.editor.highlighter.HighlighterIterator; import com.intellij.openapi.editor.impl.DefaultEditorTextRepresentationHelper; import com.intellij.openapi.editor.impl.SoftWrapModelImpl; import com.intellij.openapi.editor.impl.softwrap.mapping.SoftWrapApplianceManager; import com.intellij.openapi.util.TextRange; import com.intellij.openapi.util.registry.Registry; import com.intellij.openapi.util.text.StringUtil; import com.intellij.psi.tree.IElementType; import junit.framework.Assert; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import java.awt.*; import java.util.ArrayList; import java.util.List; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; /** * User: Maxim.Mossienko * Date: 15.03.2010 * Time: 21:00:49 */ public class EditorTestUtil { public static final String CARET_TAG = "<caret>"; public static final String CARET_TAG_PREFIX = CARET_TAG.substring(0, CARET_TAG.length() - 1); public static final String SELECTION_START_TAG = "<selection>"; public static final String SELECTION_END_TAG = "</selection>"; public static final String BLOCK_SELECTION_START_TAG = "<block>"; public static final String BLOCK_SELECTION_END_TAG = "</block>"; public static final char BACKSPACE_FAKE_CHAR = '\uFFFF'; public static final char SMART_ENTER_FAKE_CHAR = '\uFFFE'; public static final char SMART_LINE_SPLIT_CHAR = '\uFFFD'; public static void performTypingAction(Editor editor, char c) { EditorActionManager actionManager = EditorActionManager.getInstance(); if (c == BACKSPACE_FAKE_CHAR) { EditorActionHandler actionHandler = actionManager.getActionHandler(IdeActions.ACTION_EDITOR_BACKSPACE); actionHandler.execute(editor, DataManager.getInstance().getDataContext()); } else if (c == SMART_ENTER_FAKE_CHAR) { EditorActionHandler actionHandler = actionManager .getActionHandler(IdeActions.ACTION_EDITOR_COMPLETE_STATEMENT); actionHandler.execute(editor, DataManager.getInstance().getDataContext()); } else if (c == SMART_LINE_SPLIT_CHAR) { EditorActionHandler actionHandler = actionManager.getActionHandler(IdeActions.ACTION_EDITOR_SPLIT); actionHandler.execute(editor, DataManager.getInstance().getDataContext()); } else if (c == '\n') { EditorActionHandler actionHandler = actionManager.getActionHandler(IdeActions.ACTION_EDITOR_ENTER); actionHandler.execute(editor, DataManager.getInstance().getDataContext()); } else { TypedAction action = actionManager.getTypedAction(); action.actionPerformed(editor, c, DataManager.getInstance().getDataContext()); } } public static void performReferenceCopy(DataContext dataContext) { ActionManager actionManager = ActionManager.getInstance(); AnAction action = actionManager.getAction(IdeActions.ACTION_COPY_REFERENCE); AnActionEvent event = new AnActionEvent(null, dataContext, "", action.getTemplatePresentation(), ActionManager.getInstance(), 0); action.update(event); Assert.assertTrue(event.getPresentation().isEnabled()); action.actionPerformed(event); } public static void performPaste(Editor editor) { EditorActionManager actionManager = EditorActionManager.getInstance(); EditorActionHandler actionHandler = actionManager.getActionHandler(IdeActions.ACTION_EDITOR_PASTE); actionHandler.execute(editor, DataManager.getInstance().getDataContext()); } public static List<IElementType> getAllTokens(EditorHighlighter highlighter) { List<IElementType> tokens = new ArrayList<IElementType>(); HighlighterIterator iterator = highlighter.createIterator(0); while (!iterator.atEnd()) { tokens.add(iterator.getTokenType()); iterator.advance(); } return tokens; } public static int getCaretPosition(@NotNull final String content) { return getCaretAndSelectionPosition(content)[0]; } public static int[] getCaretAndSelectionPosition(@NotNull final String content) { int caretPosInSourceFile = content.indexOf(CARET_TAG_PREFIX); int caretEndInSourceFile = content.indexOf(">", caretPosInSourceFile); int caretLength = caretEndInSourceFile - caretPosInSourceFile; int visualColumnOffset = 0; if (caretPosInSourceFile >= 0) { String visualOffsetString = content.substring(caretPosInSourceFile + CARET_TAG_PREFIX.length(), caretEndInSourceFile); if (visualOffsetString.length() > 1) { visualColumnOffset = Integer.parseInt(visualOffsetString.substring(1)); } } int selectionStartInSourceFile = content.indexOf(SELECTION_START_TAG); int selectionEndInSourceFile = content.indexOf(SELECTION_END_TAG); if (selectionStartInSourceFile >= 0) { if (caretPosInSourceFile >= 0) { if (caretPosInSourceFile < selectionStartInSourceFile) { selectionStartInSourceFile -= caretLength; selectionEndInSourceFile -= caretLength; } else { if (caretPosInSourceFile < selectionEndInSourceFile) { caretPosInSourceFile -= SELECTION_START_TAG.length(); } else { caretPosInSourceFile -= SELECTION_START_TAG.length() + SELECTION_END_TAG.length(); } } } selectionEndInSourceFile -= SELECTION_START_TAG.length(); } return new int[] { caretPosInSourceFile, visualColumnOffset, selectionStartInSourceFile, selectionEndInSourceFile }; } /** * Configures given editor to wrap at given character count. * * @return whether any actual wraps of editor contents were created as a result of turning on soft wraps */ public static boolean configureSoftWraps(Editor editor, final int charCountToWrapAt) { int charWidthInPixels = 7; // we're adding 1 to charCountToWrapAt, to account for wrap character width, and 1 to overall width to overcome wrapping logic subtleties return configureSoftWraps(editor, (charCountToWrapAt + 1) * charWidthInPixels + 1, charWidthInPixels); } /** * Configures given editor to wrap at given width, assuming characters are of given width * * @return whether any actual wraps of editor contents were created as a result of turning on soft wraps */ public static boolean configureSoftWraps(Editor editor, final int visibleWidth, final int charWidthInPixels) { editor.getSettings().setUseSoftWraps(true); SoftWrapModelImpl model = (SoftWrapModelImpl) editor.getSoftWrapModel(); model.reinitSettings(); SoftWrapApplianceManager applianceManager = model.getApplianceManager(); applianceManager.setWidthProvider(new SoftWrapApplianceManager.VisibleAreaWidthProvider() { @Override public int getVisibleAreaWidth() { return visibleWidth; } }); model.setEditorTextRepresentationHelper(new DefaultEditorTextRepresentationHelper(editor) { @Override public int charWidth(char c, int fontType) { return charWidthInPixels; } }); applianceManager.registerSoftWrapIfNecessary(); return !model.getRegisteredSoftWraps().isEmpty(); } public static void setEditorVisibleSize(Editor editor, int widthInChars, int heightInChars) { Dimension size = new Dimension(widthInChars * EditorUtil.getSpaceWidth(Font.PLAIN, editor), heightInChars * editor.getLineHeight()); ((EditorEx) editor).getScrollPane().getViewport().setExtentSize(size); } /** * Equivalent to <code>extractCaretAndSelectionMarkers(document, true)</code>. * * @see #extractCaretAndSelectionMarkers(com.intellij.openapi.editor.Document, boolean) */ public static CaretAndSelectionState extractCaretAndSelectionMarkers(Document document) { return extractCaretAndSelectionMarkers(document, true); } /** * Removes <caret>, <selection> and </selection> tags from document and returns a list of caret positions and selection * ranges for each caret. Both caret positions and selection ranges can be null in the returned data. * * @param processBlockSelection if <code>true</code>, <block> and </block> tags describing a block selection state will also be extracted. */ public static CaretAndSelectionState extractCaretAndSelectionMarkers(final Document document, final boolean processBlockSelection) { return new WriteCommandAction<CaretAndSelectionState>(null) { @Override public void run(@NotNull Result<CaretAndSelectionState> actionResult) { final CaretAndSelectionState result = new CaretAndSelectionState(); String fileText = document.getText(); RangeMarker blockSelectionStartMarker = null; RangeMarker blockSelectionEndMarker = null; if (processBlockSelection) { int blockSelectionStart = fileText.indexOf(BLOCK_SELECTION_START_TAG); int blockSelectionEnd = fileText.indexOf(BLOCK_SELECTION_END_TAG); if ((blockSelectionStart ^ blockSelectionEnd) < 0) { throw new IllegalArgumentException( "Both block selection opening and closing tag must be present"); } if (blockSelectionStart >= 0) { blockSelectionStartMarker = document.createRangeMarker(blockSelectionStart, blockSelectionStart); blockSelectionEndMarker = document.createRangeMarker(blockSelectionEnd, blockSelectionEnd); document.deleteString(blockSelectionStartMarker.getStartOffset(), blockSelectionStartMarker.getStartOffset() + BLOCK_SELECTION_START_TAG.length()); document.deleteString(blockSelectionEndMarker.getStartOffset(), blockSelectionEndMarker.getStartOffset() + BLOCK_SELECTION_END_TAG.length()); } } boolean multiCaret = StringUtil.getOccurrenceCount(document.getText(), CARET_TAG) > 1 || StringUtil.getOccurrenceCount(document.getText(), SELECTION_START_TAG) > 1; int pos = 0; while (pos < document.getTextLength()) { fileText = document.getText(); int caretIndex = fileText.indexOf(CARET_TAG, pos); int selStartIndex = fileText.indexOf(SELECTION_START_TAG, pos); int selEndIndex = fileText.indexOf(SELECTION_END_TAG, pos); if ((selStartIndex ^ selEndIndex) < 0) { selStartIndex = -1; selEndIndex = -1; } if (0 <= selEndIndex && selEndIndex < selStartIndex) { throw new IllegalArgumentException("Wrong order of selection opening and closing tags"); } if (caretIndex < 0 && selStartIndex < 0 && selEndIndex < 0) { break; } if (multiCaret && 0 <= caretIndex && caretIndex < selStartIndex) { selStartIndex = -1; selEndIndex = -1; } if (multiCaret && caretIndex > selEndIndex && selEndIndex >= 0) { caretIndex = -1; } final RangeMarker caretMarker = caretIndex >= 0 ? document.createRangeMarker(caretIndex, caretIndex) : null; final RangeMarker selStartMarker = selStartIndex >= 0 ? document.createRangeMarker(selStartIndex, selStartIndex) : null; final RangeMarker selEndMarker = selEndIndex >= 0 ? document.createRangeMarker(selEndIndex, selEndIndex) : null; if (caretMarker != null) { document.deleteString(caretMarker.getStartOffset(), caretMarker.getStartOffset() + CARET_TAG.length()); } if (selStartMarker != null) { document.deleteString(selStartMarker.getStartOffset(), selStartMarker.getStartOffset() + SELECTION_START_TAG.length()); } if (selEndMarker != null) { document.deleteString(selEndMarker.getStartOffset(), selEndMarker.getStartOffset() + SELECTION_END_TAG.length()); } LogicalPosition caretPosition = null; if (caretMarker != null) { int line = document.getLineNumber(caretMarker.getStartOffset()); int column = caretMarker.getStartOffset() - document.getLineStartOffset(line); caretPosition = new LogicalPosition(line, column); } result.carets .add(new CaretInfo(caretPosition, selStartMarker == null || selEndMarker == null ? null : new TextRange(selStartMarker.getStartOffset(), selEndMarker.getEndOffset()))); pos = Math.max(caretMarker == null ? -1 : caretMarker.getStartOffset(), selEndMarker == null ? -1 : selEndMarker.getEndOffset()); } if (result.carets.isEmpty()) { result.carets.add(new CaretInfo(null, null)); } if (blockSelectionStartMarker != null) { result.blockSelection = new TextRange(blockSelectionStartMarker.getStartOffset(), blockSelectionEndMarker.getStartOffset()); } actionResult.setResult(result); } }.execute().getResultObject(); } /** * Applies given caret/selection state to the editor. Editor text must have been set up previously. */ public static void setCaretsAndSelection(Editor editor, CaretAndSelectionState caretsState) { CaretModel caretModel = editor.getCaretModel(); if (caretModel.supportsMultipleCarets()) { List<CaretState> states = new ArrayList<CaretState>(caretsState.carets.size()); for (CaretInfo caret : caretsState.carets) { states.add( new CaretState( caret.position == null ? null : editor.offsetToLogicalPosition( caret.getCaretOffset(editor.getDocument())), caret.selection == null ? null : editor.offsetToLogicalPosition(caret.selection.getStartOffset()), caret.selection == null ? null : editor.offsetToLogicalPosition(caret.selection.getEndOffset()))); } caretModel.setCaretsAndSelections(states); } else { assertEquals("Multiple carets are not supported by the model", 1, caretsState.carets.size()); CaretInfo caret = caretsState.carets.get(0); if (caret.position != null) { caretModel.moveToOffset(caret.getCaretOffset(editor.getDocument())); } if (caret.selection != null) { editor.getSelectionModel().setSelection(caret.selection.getStartOffset(), caret.selection.getEndOffset()); } else { editor.getSelectionModel().removeSelection(); } } if (caretsState.blockSelection != null) { editor.getSelectionModel().setBlockSelection( editor.offsetToLogicalPosition(caretsState.blockSelection.getStartOffset()), editor.offsetToLogicalPosition(caretsState.blockSelection.getEndOffset())); } } public static void verifyCaretAndSelectionState(Editor editor, CaretAndSelectionState caretState) { verifyCaretAndSelectionState(editor, caretState, null); } public static void verifyCaretAndSelectionState(Editor editor, CaretAndSelectionState caretState, String message) { boolean hasChecks = false; for (int i = 0; i < caretState.carets.size(); i++) { EditorTestUtil.CaretInfo expected = caretState.carets.get(i); if (expected.position != null || expected.selection != null) { hasChecks = true; break; } } if (!hasChecks) { return; // nothing to check, so we skip caret/selection assertions } String messageSuffix = message == null ? "" : (message + ": "); CaretModel caretModel = editor.getCaretModel(); List<Caret> allCarets = new ArrayList<Caret>(caretModel.getAllCarets()); assertEquals(messageSuffix + " Unexpected number of carets", caretState.carets.size(), allCarets.size()); for (int i = 0; i < caretState.carets.size(); i++) { String caretDescription = caretState.carets.size() == 1 ? "" : "caret " + (i + 1) + "/" + caretState.carets.size() + " "; Caret currentCaret = allCarets.get(i); int actualCaretLine = editor.getDocument().getLineNumber(currentCaret.getOffset()); int actualCaretColumn = currentCaret.getOffset() - editor.getDocument().getLineStartOffset(actualCaretLine); LogicalPosition actualCaretPosition = new LogicalPosition(actualCaretLine, actualCaretColumn); int[] selectionStarts = editor.getSelectionModel().getBlockSelectionStarts(); int[] selectionEnds = editor.getSelectionModel().getBlockSelectionEnds(); int selectionStart = editor.getSelectionModel().hasBlockSelection() ? selectionStarts[selectionStarts.length - 1] : currentCaret.getSelectionStart(); int selectionEnd = editor.getSelectionModel().hasBlockSelection() ? selectionEnds[selectionEnds.length - 1] : currentCaret.getSelectionEnd(); LogicalPosition actualSelectionStart = editor.offsetToLogicalPosition(selectionStart); LogicalPosition actualSelectionEnd = editor.offsetToLogicalPosition(selectionEnd); CaretInfo expected = caretState.carets.get(i); if (expected.position != null) { assertEquals(messageSuffix + caretDescription + "unexpected caret position", expected.position, actualCaretPosition); } if (expected.selection != null) { LogicalPosition expectedSelectionStart = editor .offsetToLogicalPosition(expected.selection.getStartOffset()); LogicalPosition expectedSelectionEnd = editor .offsetToLogicalPosition(expected.selection.getEndOffset()); assertEquals(messageSuffix + caretDescription + "unexpected selection start", expectedSelectionStart, actualSelectionStart); assertEquals(messageSuffix + caretDescription + "unexpected selection end", expectedSelectionEnd, actualSelectionEnd); } else { assertFalse( messageSuffix + caretDescription + "should has no selection, but was: (" + actualSelectionStart + ", " + actualSelectionEnd + ")", currentCaret.hasSelection()); } } } public static void enableMultipleCarets() { Registry.get("editor.allow.multiple.carets").setValue(true); } public static void disableMultipleCarets() { Registry.get("editor.allow.multiple.carets").setValue(false); } public static class CaretAndSelectionState { public final List<CaretInfo> carets = new ArrayList<CaretInfo>(); @Nullable public TextRange blockSelection; } public static class CaretInfo { @Nullable public final LogicalPosition position; // column number in this position is calculated in terms of characters, // not in terms of visual position // so Tab character always increases the column number by 1 @Nullable public final TextRange selection; public CaretInfo(@Nullable LogicalPosition position, @Nullable TextRange selection) { this.position = position; this.selection = selection; } public int getCaretOffset(Document document) { return document.getLineStartOffset(position.line) + position.column; } } }