Files
openide/java/java-tests/testSrc/com/intellij/psi/impl/smartPointers/SmartPsiElementPointersTest.java
Tagir Valeev df1679571e Some 'Result of method call ignored' warnings fixed or suppressed
GitOrigin-RevId: 757e7bc0b1d7cb7cbf4a13c35e4f5c1fc375e0a4
2024-06-18 20:08:54 +00:00

1213 lines
48 KiB
Java

// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.psi.impl.smartPointers;
import com.intellij.JavaTestUtil;
import com.intellij.codeInsight.JavaCodeInsightTestCase;
import com.intellij.ide.highlighter.HtmlFileType;
import com.intellij.ide.highlighter.JavaFileType;
import com.intellij.ide.highlighter.XmlFileType;
import com.intellij.lang.FileASTNode;
import com.intellij.lang.java.JavaLanguage;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.application.WriteAction;
import com.intellij.openapi.command.WriteCommandAction;
import com.intellij.openapi.diagnostic.DefaultLogger;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.EditorFactory;
import com.intellij.openapi.editor.EditorModificationUtil;
import com.intellij.openapi.editor.event.DocumentEvent;
import com.intellij.openapi.editor.event.DocumentListener;
import com.intellij.openapi.editor.event.EditorEventMulticaster;
import com.intellij.openapi.editor.ex.DocumentEx;
import com.intellij.openapi.editor.impl.FrozenDocument;
import com.intellij.openapi.fileEditor.FileDocumentManager;
import com.intellij.openapi.fileTypes.PlainTextFileType;
import com.intellij.openapi.util.Key;
import com.intellij.openapi.util.Segment;
import com.intellij.openapi.util.TextRange;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.*;
import com.intellij.psi.impl.source.PostprocessReformattingAspect;
import com.intellij.psi.impl.source.PsiFileImpl;
import com.intellij.psi.impl.source.PsiJavaFileImpl;
import com.intellij.psi.impl.source.tree.FileElement;
import com.intellij.psi.search.GlobalSearchScope;
import com.intellij.psi.stubs.StubElement;
import com.intellij.psi.stubs.StubTree;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.psi.util.PsiUtil;
import com.intellij.psi.util.PsiUtilBase;
import com.intellij.psi.xml.XmlFile;
import com.intellij.psi.xml.XmlTag;
import com.intellij.testFramework.*;
import com.intellij.tools.ide.metrics.benchmark.PerformanceTestUtil;
import com.intellij.util.FileContentUtil;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.ref.GCUtil;
import com.intellij.util.ref.GCWatcher;
import org.intellij.lang.annotations.Language;
import org.jetbrains.annotations.NotNull;
import org.junit.Assert;
import java.util.*;
@HeavyPlatformTestCase.WrapInCommand
@SkipSlowTestLocally
public class SmartPsiElementPointersTest extends JavaCodeInsightTestCase {
private VirtualFile myRoot;
@Override
protected void setUp() throws Exception {
super.setUp();
String root = JavaTestUtil.getJavaTestDataPath() + "/codeEditor/smartPsiElementPointers";
PsiTestUtil.removeAllRoots(myModule, IdeaTestUtil.getMockJdk17());
myRoot = createTestProjectStructure( root);
}
public void testChangeInDocument() {
PsiClass aClass = myJavaFacade.findClass("AClass", GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
SmartPsiElementPointer pointer = createPointer(aClass);
Document document = PsiDocumentManager.getInstance(myProject).getDocument(aClass.getContainingFile());
int offset = aClass.getTextOffset();
insertString(document, offset, "/**/");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
PsiElement element = pointer.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiClass);
assertTrue(element.isValid());
}
private static void insertString(Document document, int offset, String s) {
ApplicationManager.getApplication().runWriteAction(() -> document.insertString(offset, s));
}
// This test is unfair. If pointer would be asked for getElement() between commits it'll never restore again anyway.
//
public void testChangeInDocumentTwice() {
PsiClass aClass = myJavaFacade.findClass("AClass",GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
SmartPsiElementPointer pointer = createPointer(aClass);
Document document = PsiDocumentManager.getInstance(myProject).getDocument(aClass.getContainingFile());
int offset = aClass.getTextOffset();
insertString(document, offset, "/*");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
insertString(document, offset + 2, "*/");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
PsiElement element = pointer.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiClass);
assertTrue(element.isValid());
}
public void testGetElementWhenDocumentModified() {
PsiClass aClass = myJavaFacade.findClass("AClass",GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
SmartPsiElementPointer pointer = createPointer(aClass);
Document document = PsiDocumentManager.getInstance(myProject).getDocument(aClass.getContainingFile());
int offset = aClass.getTextOffset();
insertString(document, offset, "/**/");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
insertString(document, offset, "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");
PsiElement element = pointer.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiClass);
assertTrue(element.isValid());
}
public void testKeepBeltWhenDocumentModified() {
PsiClass aClass = myJavaFacade.findClass("AClass",GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
SmartPsiElementPointer pointer = createPointer(aClass);
Document document = PsiDocumentManager.getInstance(myProject).getDocument(aClass.getContainingFile());
int offset = aClass.getTextOffset();
insertString(document, offset, "/******/");
pointer.getElement();
insertString(document, offset, "/**/");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
PsiElement element = pointer.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiClass);
assertTrue(element.isValid());
}
public void testRetrieveOnUncommittedDocument() {
ApplicationManager.getApplication().runWriteAction(() -> {
PsiClass aClass = myJavaFacade.findClass("AClass", GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
PsiDocumentManager documentManager = PsiDocumentManager.getInstance(myProject);
Document document = documentManager.getDocument(aClass.getContainingFile());
document.insertString(0, "/******/");
SmartPointerEx pointer = createPointer(aClass.getNameIdentifier());
document.insertString(0, "/**/");
documentManager.commitAllDocuments();
PsiElement element = pointer.getElement();
assertNotNull(element);
assertTrue(element.getParent() instanceof PsiClass);
assertTrue(element.isValid());
});
}
public void testNoAstLoadingWithoutDocumentChanges() {
PsiClass aClass = myJavaFacade.findClass("Test",GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
PsiFileImpl file = (PsiFileImpl)aClass.getContainingFile();
createEditor(file.getVirtualFile());
assertFalse(file.isContentsLoaded());
SmartPointerEx pointer = createPointer(aClass);
assertFalse(file.isContentsLoaded());
//noinspection UnusedAssignment
aClass = null;
gcPointerCache(pointer);
assertNotNull(pointer.getElement());
assertFalse(file.isContentsLoaded());
}
private static void gcPointerCache(SmartPsiElementPointer<?>... pointers) {
GCWatcher.tracking(ContainerUtil.map(pointers, p -> ((SmartPointerEx<?>) p).getCachedElement())).ensureCollected();
for (SmartPsiElementPointer<?> pointer : pointers) {
assertNull(((SmartPointerEx<?>)pointer).getCachedElement());
}
}
public void testTextFileClearingDoesNotCrash() {
configureByText(PlainTextFileType.INSTANCE, "foo bar goo\n");
SmartPsiElementPointer pointer = createPointer(myFile.getFirstChild());
GCWatcher.tracking(myFile.getNode()).ensureCollected();
assertEquals(myFile.getFirstChild(), pointer.getElement());
Document document = myFile.getViewProvider().getDocument();
ApplicationManager.getApplication().runWriteAction(() -> {
document.deleteString(0, document.getTextLength());
GCWatcher.tracking(myFile.getNode()).ensureCollected();
assertEquals(myFile.getFirstChild(), pointer.getElement());
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
});
GCWatcher.tracking(myFile.getNode()).ensureCollected();
assertEquals(myFile.getFirstChild(), pointer.getElement());
}
public void testChangeInPsi() {
PsiClass aClass = myJavaFacade.findClass("AClass",GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
SmartPsiElementPointer pointer = createPointer(aClass);
Document document = PsiDocumentManager.getInstance(myProject).getDocument(aClass.getContainingFile());
int offset = aClass.getTextOffset();
insertString(document, offset, "/**/");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
PsiElement element = pointer.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiClass);
assertTrue(element.isValid());
}
public void testPsiChangesWithLazyPointers() {
PsiClass aClass = myJavaFacade.findClass("AClass", GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
final SmartPsiElementPointer<PsiIdentifier> pointer =
createPointer(aClass.getNameIdentifier());
final PsiComment javadoc =
JavaPsiFacade.getElementFactory(aClass.getProject()).createCommentFromText("/** javadoc */", aClass);
ApplicationManager.getApplication().runWriteAction(() -> {
aClass.getParent().addBefore(javadoc, aClass);
});
final PsiIdentifier elt = pointer.getElement();
assertNotNull(elt);
assertSame(elt, aClass.getNameIdentifier());
}
public void testTypePointer() {
PsiClass aClass = myJavaFacade.findClass("AClass",GlobalSearchScope.allScope(getProject()));
final PsiTypeElement typeElement = myJavaFacade.findClass("Test",GlobalSearchScope.allScope(getProject())).getFields()[0].getTypeElement();
SmartPsiElementPointer typePointer = createPointer(typeElement);
SmartPsiElementPointer classPointer = createPointer(aClass);
Document aClassDocument = PsiDocumentManager.getInstance(myProject).getDocument(aClass.getContainingFile());
Document testDocument = PsiDocumentManager.getInstance(myProject).getDocument(typeElement.getContainingFile());
assertNotSame(aClassDocument, testDocument);
insertString(aClassDocument, aClass.getTextOffset(), "/**/");
insertString(testDocument, typeElement.getTextOffset(), "/**/");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
PsiElement element = typePointer.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiTypeElement);
assertTrue(element.isValid());
assertEquals(classPointer.getElement(), PsiUtil.resolveClassInType(((PsiTypeElement)element).getType()));
}
public void testCreatePointerInBeforeDocumentChange() {
final PsiClass aClass = myJavaFacade.findClass("AClass",GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
Document document = PsiDocumentManager.getInstance(myProject).getDocument(aClass.getContainingFile());
final SmartPsiElementPointer[] pointer = new SmartPsiElementPointer[1];
int offset = aClass.getTextOffset();
DocumentListener listener = new DocumentListener() {
@Override
public void beforeDocumentChange(@NotNull DocumentEvent event) {
pointer[0] = createPointer(aClass);
}
};
EditorEventMulticaster multicaster = EditorFactory.getInstance().getEventMulticaster();
multicaster.addDocumentListener(listener, getTestRootDisposable());
try {
insertString(document, offset, "/******/");
}
finally {
multicaster.removeDocumentListener(listener);
}
pointer[0].getElement();
insertString(document, 0, "/**/");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
PsiElement element = pointer[0].getElement();
assertNotNull(element);
assertTrue(element instanceof PsiClass);
assertTrue(element.isValid());
}
public void testCreatePointerWhenNoPsiFile() {
// to use weak refs
myPsiManager.runInBatchFilesMode(() -> {
final PsiClass aClass = myJavaFacade.findClass("AClass",GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
VirtualFile vFile = myRoot.findChild("AClass.java");
assertNotNull(vFile);
PsiDocumentManager psiDocumentManager = PsiDocumentManager.getInstance(myProject);
Document document = FileDocumentManager.getInstance().getDocument(vFile);
final SmartPsiElementPointer pointer = createPointer(aClass);
System.gc();
/*
PsiFile psiFile = myPsiManager.getFileManager().getCachedPsiFile(vFile);
assertNull(psiFile);
*/
insertString(document, 0, "class Foo{}\n");
PsiElement element = pointer.getElement();
assertEquals(aClass, element);
insertString(document, 0, "/**/");
psiDocumentManager.commitAllDocuments();
if (aClass.isValid()) {
assertNotNull(aClass.getChildren()); // trigger PSI loading
}
element = pointer.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiClass);
assertTrue(element.isValid());
return null;
});
}
public void testReplaceFile() {
VirtualFile vfile = createChildData(myRoot, "X.java");
@Language("JAVA")
String text = "public class X { public int X; }";
setFileText(vfile, text);
PsiClass aClass = myJavaFacade.findClass("X", GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
assertTrue(aClass.isValid());
SmartPsiElementPointer classp = createPointer(aClass);
SmartPsiElementPointer filep = createPointer(aClass.getContainingFile());
FileContentUtil.reparseFiles(myProject, Collections.singleton(vfile), true);
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
assertFalse(aClass.isValid());
PsiElement element = classp.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiClass);
assertTrue(element.isValid());
assertEquals(vfile, element.getContainingFile().getVirtualFile());
element = filep.getElement();
assertNotNull(element);
assertTrue(element instanceof PsiFile);
assertTrue(element.isValid());
assertEquals(vfile, element.getContainingFile().getVirtualFile());
}
public void testCreatePointerDoesNotLoadPsiTree() {
VirtualFile vfile = createChildData(myRoot, "X.java");
@Language("JAVA")
String text = "public class X { public int X; }";
setFileText(vfile, text);
PsiClass aClass = myJavaFacade.findClass("X", GlobalSearchScope.allScope(getProject()));
assertNotNull(aClass);
assertTrue(aClass.isValid());
PsiFileImpl file = (PsiFileImpl)aClass.getContainingFile();
assertTreeLoaded(file, false);
SmartPsiElementPointer p = createPointer(aClass);
assertNotNull(p);
assertTreeLoaded(file, false);
assertInstanceOf(p.getElement(), PsiClass.class);
assertTreeLoaded(file, false);
PsiDocumentManager documentManager = PsiDocumentManager.getInstance(myProject);
Document document = documentManager.getDocument(file);
insertString(document, 0, "/** asdasd */");
documentManager.commitAllDocuments();
// loaded tree
assertTreeLoaded(file, true);
assertInstanceOf(p.getElement(), PsiClass.class);
assertTreeLoaded(file, true);
}
private static void assertTreeLoaded(PsiFileImpl file, boolean loaded) {
FileElement treeElement = file.getTreeElement();
assertEquals(loaded, treeElement != null);
StubTree stubTree = file.getStubTree();
assertEquals(loaded, stubTree == null);
}
public void testPointerDisambiguationAfterDupLine() {
String text = """
class XXX{ void foo() {\s
<caret>foo();
}}""";
PsiJavaFile file = (PsiJavaFile)configureByText(JavaFileType.INSTANCE, text);
PsiClass aClass = file.getClasses()[0];
assertNotNull(aClass);
PsiReferenceExpression ref1 = PsiTreeUtil.getParentOfType(PsiUtilBase.getElementAtCaret(getEditor()), PsiReferenceExpression.class);
SmartPsiElementPointer pointer1 = createPointer(ref1);
ctrlD();
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
Set<PsiReferenceExpression> refs = new HashSet<>();
int offset=0;
while (true) {
offset = getEditor().getDocument().getText().indexOf("foo();", offset+1);
if (offset == -1) break;
PsiReferenceExpression ref2 = PsiTreeUtil.getParentOfType(getFile().findElementAt(offset), PsiReferenceExpression.class);
refs.add(ref2);
}
refs.remove(ref1);
assertEquals(1, refs.size());
PsiReferenceExpression ref2 = refs.iterator().next();
assertNotSame(ref1, ref2);
SmartPsiElementPointer pointer2 = createPointer(ref2);
assertNotSame(pointer1, pointer2);
PsiElement element1 = pointer1.getElement();
PsiElement element2 = pointer2.getElement();
assertNotNull(element1);
assertNotNull(element2);
assertNotSame(element1, element2);
assertFalse(getPointerManager().pointToTheSameElement(pointer1, pointer2));
}
public void testPointersRefCount() {
@Language("JAVA")
String text = "class X{}";
PsiFile file = configureByText(JavaFileType.INSTANCE, text);
PsiClass aClass = ((PsiClassOwner)file).getClasses()[0];
SmartPointerManagerImpl smartPointerManager = getPointerManager();
SmartPsiElementPointer pointer1 = createPointer(aClass);
SmartPsiElementPointer pointer2 = createPointer(aClass);
assertSame(pointer1, pointer2);
assertNotNull(pointer1.getRange());
smartPointerManager.removePointer(pointer2);
assertNotNull(pointer1.getRange());
smartPointerManager.removePointer(pointer1);
assertNull(pointer1.getRange());
}
private SmartPointerManagerImpl getPointerManager() {
return (SmartPointerManagerImpl)SmartPointerManager.getInstance(myProject);
}
public void testPointersRefCountSaturated() {
@Language("JAVA")
String text = "class X{}";
PsiFile file = configureByText(JavaFileType.INSTANCE, text);
PsiClass aClass = ((PsiClassOwner)file).getClasses()[0];
SmartPointerManagerImpl smartPointerManager = getPointerManager();
SmartPsiElementPointerImpl pointer1 = (SmartPsiElementPointerImpl)createPointer(aClass);
for (int i=0; i<1000; i++) {
SmartPsiElementPointer<PsiClass> pointer2 = createPointer(aClass);
assertSame(pointer1, pointer2);
}
assertNotNull(pointer1.getRange());
assertEquals(Byte.MAX_VALUE, pointer1.incrementAndGetReferenceCount(0));
for (int i=0; i<1100; i++) {
smartPointerManager.removePointer(pointer1);
Assert.assertNotNull(pointer1.getRange());
}
}
public void testSmartPointerCreationDoesNotLoadDocument() {
PsiPackage aPackage = myJavaFacade.findPackage("java.io");
for (PsiClass aClass : aPackage.getClasses()) {
PsiDocumentManager documentManager = PsiDocumentManager.getInstance(myProject);
PsiFile file = aClass.getContainingFile();
Document document = documentManager.getCachedDocument(file);
if (document == null) { //ignore already loaded documents
createPointer(aClass);
assertNull(documentManager.getCachedDocument(file));
//System.out.println("file = " + file);
}
else {
LOG.debug("already loaded file = " + file);
}
}
}
public void testSmartPointersSurvivePsiFileUnload() {
final VirtualFile vfile = createChildData(myRoot, "X.txt");
String xxx = "xxx";
String text = xxx + " " + xxx + " " + xxx;
setFileText(vfile, text);
PsiFile psiFile = PsiManager.getInstance(getProject()).findFile(vfile);
assertTrue(String.valueOf(psiFile), psiFile instanceof PsiPlainTextFile);
SmartPointerManagerImpl manager = getPointerManager();
TextRange range1 = TextRange.from(0, xxx.length());
SmartPsiFileRange pointer1 = manager.createSmartPsiFileRangePointer(psiFile, range1);
TextRange range2 = TextRange.from(text.lastIndexOf(xxx), xxx.length());
SmartPsiFileRange pointer2 = manager.createSmartPsiFileRangePointer(psiFile, range2);
assertNotNull(FileDocumentManager.getInstance().getCachedDocument(vfile));
GCWatcher watcher = GCWatcher.tracking(psiFile, FileDocumentManager.getInstance().getDocument(vfile));
//noinspection UnusedAssignment
psiFile = null;
watcher.ensureCollected();
assertNull(FileDocumentManager.getInstance().getCachedDocument(vfile));
assertEquals(pointer1.getRange(), range1);
WriteCommandAction.runWriteCommandAction(getProject(), () -> insertString(FileDocumentManager.getInstance().getDocument(vfile), 0, " "));
assertEquals(range1.shiftRight(1), pointer1.getRange());
assertEquals(range2.shiftRight(1), pointer2.getRange());
}
public void testInXml() {
@Language("HTML")
String text = """
<!doctype html>
<html>
<fieldset></fieldset>
<select></select>
<caret>
</html>""";
final PsiFile file = configureByText(HtmlFileType.INSTANCE,
text
);
final XmlTag fieldSet = PsiTreeUtil.getParentOfType(file.findElementAt(file.getText().indexOf("fieldset")), XmlTag.class);
assertNotNull(fieldSet);
assertEquals("fieldset", fieldSet.getName());
final XmlTag select = PsiTreeUtil.getParentOfType(file.findElementAt(file.getText().indexOf("select")), XmlTag.class);
assertNotNull(select);
assertEquals("select", select.getName());
final SmartPsiElementPointer<XmlTag> fieldSetPointer = createPointer(fieldSet);
final SmartPsiElementPointer<XmlTag> selectPointer = createPointer(select);
WriteCommandAction.runWriteCommandAction(getProject(), () -> insertString(getEditor().getDocument(), getEditor().getCaretModel().getOffset(), "<a></a>"));
PsiDocumentManager.getInstance(getProject()).commitAllDocuments();
final XmlTag newFieldSet = fieldSetPointer.getElement();
assertNotNull(newFieldSet);
assertEquals("fieldset", newFieldSet.getName());
final XmlTag newSelect = selectPointer.getElement();
assertNotNull(newSelect);
assertEquals("select", newSelect.getName());
}
public void testInXml2() {
String text = """
<html>
<ul class="dropdown-menu">
<li><a href="#">One more separated link</a></li>
</ul>
<caret>
</html>""";
final PsiFile file = configureByText(XmlFileType.INSTANCE,
text
);
final XmlTag ul = PsiTreeUtil.getParentOfType(file.findElementAt(file.getText().indexOf("ul")), XmlTag.class);
assertNotNull(ul);
assertEquals("ul", ul.getName());
assertEquals("dropdown-menu", ul.getAttributeValue("class"));
SmartPsiElementPointer<XmlTag> ulPointer = createPointer(ul);
WriteCommandAction.runWriteCommandAction(getProject(), () -> {
int offset = getEditor().getCaretModel().getOffset();
insertString(getEditor().getDocument(), offset, """
<ul class="nav navbar-nav navbar-right">
</ul>
""");
});
PsiDocumentManager.getInstance(getProject()).commitAllDocuments();
final XmlTag newUl = ulPointer.getElement();
assertNotNull(newUl);
assertEquals("ul", newUl.getName());
assertEquals("dropdown-menu", newUl.getAttributeValue("class"));
}
public void testInsertImport() {
@Language("JAVA")
String text = "class S {\n" +
"}";
final PsiFile file = configureByText(JavaFileType.INSTANCE,
text);
PsiClass aClass = ((PsiJavaFile)file).getClasses()[0];
WriteCommandAction.runWriteCommandAction(getProject(), () -> insertString(getEditor().getDocument(), 0, "import java.util.Map;\n"));
PsiDocumentManager.getInstance(getProject()).commitAllDocuments();
PsiClass aClass2 = ((PsiJavaFile)file).getClasses()[0];
assertSame(aClass, aClass2);
}
public void testEqualPointerRangesWhenCreatedFromStubAndAST() {
@Language("JAVA")
String text = "class S {\n" +
"}";
final PsiFile file = configureByText(JavaFileType.INSTANCE,
text);
PsiClass aClass = ((PsiJavaFile)file).getClasses()[0];
assertNotNull(((PsiFileImpl)file).getStubTree());
final SmartPointerManager manager = getPointerManager();
final SmartPsiElementPointer<PsiClass> pointer1 = createPointer(aClass);
Segment range1 = pointer1.getRange();
manager.removePointer(pointer1);
final FileASTNode node = file.getNode();
final SmartPsiElementPointer<PsiClass> pointer2 = createPointer(aClass);
assertEquals(range1, pointer2.getRange());
assertNotNull(node);
}
public void testEqualPointersWhenCreatedFromStubAndAST() {
PsiJavaFile file = (PsiJavaFile)myJavaFacade.findClass("AClass", GlobalSearchScope.allScope(getProject())).getContainingFile();
int hash1 = file.getClasses()[0].hashCode();
final SmartPsiElementPointer<PsiClass> pointer1 = createPointer(file.getClasses()[0]);
assertNotNull(((PsiFileImpl)file).getStubTree());
GCWatcher.tracking(((PsiFileImpl)file).getStubTree(), file.getClasses()[0]).ensureCollected();
final FileASTNode node = file.getNode();
final SmartPsiElementPointer<PsiClass> pointer2 = createPointer(file.getClasses()[0]);
assertFalse(hash1 == file.getClasses()[0].hashCode());
assertEquals(pointer1, pointer2);
assertEquals(pointer1.getRange(), pointer2.getRange());
assertNotNull(node);
}
public void testLargeFileWithManyChangesPerformance() throws Exception {
String text = StringUtil.repeat("foo foo \n", 50000);
PsiFile file = createFile("a.txt", text);
final TextRange range = TextRange.from(10, 10);
final SmartPsiFileRange pointer = getPointerManager().createSmartPsiFileRangePointer(file, range);
final Document document = file.getViewProvider().getDocument();
assertNotNull(document);
WriteAction.run(() -> PerformanceTestUtil.newPerformanceTest("smart pointer range update", () -> {
for (int i = 0; i < 10000; i++) {
document.insertString(i * 20 + 100, "x\n");
assertFalse(PsiDocumentManager.getInstance(myProject).isCommitted(document));
assertEquals(range, pointer.getRange());
}
}).setup(() -> {
document.setText(text);
assertEquals(range, pointer.getRange());
}).start());
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
assertEquals(range, pointer.getRange());
}
public void testConvergingRanges() {
configureByText(PlainTextFileType.INSTANCE, "aba");
final Document document = myFile.getViewProvider().getDocument();
assertNotNull(document);
SmartPsiFileRange range1 = getPointerManager().createSmartPsiFileRangePointer(myFile, TextRange.create(0, 2));
SmartPsiFileRange range2 = getPointerManager().createSmartPsiFileRangePointer(myFile, TextRange.create(1, 3));
ApplicationManager.getApplication().runWriteAction(() -> {
document.deleteString(0, 1);
document.deleteString(1, 2);
});
assertEquals(TextRange.create(0, 1), range1.getRange());
assertEquals(TextRange.create(0, 1), range2.getRange());
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
assertEquals(TextRange.create(0, 1), range1.getRange());
assertEquals(TextRange.create(0, 1), range2.getRange());
insertString(document, 0, "a");
assertEquals(TextRange.create(1, 2), range1.getRange());
assertEquals(TextRange.create(1, 2), range2.getRange());
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
assertEquals(TextRange.create(1, 2), range1.getRange());
assertEquals(TextRange.create(1, 2), range2.getRange());
}
public void testMoveText() {
@Language("JAVA")
String text = "class C1{}\nclass C2 {}";
PsiJavaFile file = (PsiJavaFile)configureByText(JavaFileType.INSTANCE, text);
DocumentEx document = (DocumentEx)file.getViewProvider().getDocument();
SmartPsiElementPointer<PsiClass> pointer1 =
createPointer(file.getClasses()[0]);
SmartPsiElementPointer<PsiClass> pointer2 =
createPointer(file.getClasses()[1]);
assertEquals("C1", pointer1.getElement().getName());
assertEquals("C2", pointer2.getElement().getName());
gcPointerCache(pointer1, pointer2);
TextRange range = file.getClasses()[1].getTextRange();
ApplicationManager.getApplication().runWriteAction(() -> document.moveText(range.getStartOffset(), range.getEndOffset(), 0));
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
assertEquals("C1", pointer1.getElement().getName());
assertEquals("C2", pointer2.getElement().getName());
}
public void testNonPhysicalFile() {
PsiJavaFile file = (PsiJavaFile)myJavaFacade.findClass("AClass", GlobalSearchScope.allScope(getProject())).getContainingFile().copy();
SmartPsiFileRange pointer = getPointerManager().createSmartPsiFileRangePointer(file, TextRange.create(1, 2));
insertString(file.getViewProvider().getDocument(), 0, " ");
assertEquals(TextRange.create(2, 3), pointer.getRange());
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
assertEquals(TextRange.create(2, 3), pointer.getRange());
}
public void testUpdateAfterInsertingIdenticalText() {
String text = """
class Foo {
void m() {
}
<caret>}
""";
PsiJavaFile file = (PsiJavaFile)configureByText(JavaFileType.INSTANCE, text);
PsiMethod method = file.getClasses()[0].getMethods()[0];
TextRange originalRange = method.getTextRange();
SmartPsiElementPointer pointer = createPointer(method);
ApplicationManager.getApplication().runWriteAction(() -> EditorModificationUtil.insertStringAtCaret(myEditor, """
void m() {
}
"""));
PsiDocumentManager.getInstance(myProject).commitDocument(myEditor.getDocument());
PsiElement element = pointer.getElement();
assertNotNull(element);
TextRange newRange = element.getTextRange();
assertEquals(originalRange, newRange);
}
public void testAnchorInfoSurvivesPsiChange() {
@Language("JAVA")
String text = "class C1{}\nclass C2 {}";
PsiJavaFile file = (PsiJavaFile)configureByText(JavaFileType.INSTANCE, text);
SmartPsiElementPointer<PsiClass> pointer = createPointer(file.getClasses()[1]);
gcPointerCache(pointer);
ApplicationManager.getApplication().runWriteAction(() -> file.getClasses()[0].delete());
assertNotNull(pointer.getElement());
}
public void testPointerToEmptyElement() {
@Language("JAVA")
String text = """
class Foo {
Test<String> test = new Test<>();
}""";
PsiFile file = configureByText(JavaFileType.INSTANCE, text);
PsiJavaCodeReferenceElement ref = PsiTreeUtil.findElementOfClassAtOffset(file, file.getText().indexOf("<>"), PsiJavaCodeReferenceElement.class, false);
SmartPointerEx pointer = createPointer(ref.getParameterList().getTypeParameterElements()[0]);
//noinspection UnusedAssignment
ref = null;
gcPointerCache(pointer);
assertInstanceOf(pointer.getElement(), PsiTypeElement.class);
}
public void testPointerToEmptyElement2() {
@Language("JAVA")
String text = """
class Foo {
void foo() {}
}""";
PsiFile file = configureByText(JavaFileType.INSTANCE, text);
PsiMethod method = PsiTreeUtil.findElementOfClassAtOffset(file, file.getText().indexOf("void"), PsiMethod.class, false);
SmartPointerEx pointer1 = createPointer(method.getModifierList());
SmartPointerEx pointer2 = createPointer(method.getTypeParameterList());
//noinspection UnusedAssignment
method = null;
gcPointerCache(pointer1, pointer2);
assertInstanceOf(pointer1.getElement(), PsiModifierList.class);
assertInstanceOf(pointer2.getElement(), PsiTypeParameterList.class);
}
public void testPointerToReferenceSurvivesRename() {
@Language("JAVA")
String text = "class Foo extends Bar {}";
PsiFile file = configureByText(JavaFileType.INSTANCE, text);
PsiJavaCodeReferenceElement ref = PsiTreeUtil.findElementOfClassAtOffset(file, file.getText().indexOf("Bar"), PsiJavaCodeReferenceElement.class, false);
SmartPointerEx pointer = createPointer(ref);
//noinspection UnusedAssignment
ref = null;
gcPointerCache(pointer);
ref = PsiTreeUtil.findElementOfClassAtOffset(file, file.getText().indexOf("Bar"), PsiJavaCodeReferenceElement.class, false);
final PsiJavaCodeReferenceElement finalRef = ref;
ApplicationManager.getApplication().runWriteAction(() -> {
finalRef.handleElementRename("BarImpl");
});
assertNotNull(pointer.getElement());
}
public void testNonAnchoredStubbedElement() {
@Language("JAVA")
String text = "class Foo { { @NotNull String foo; } }";
PsiFile file = configureByText(JavaFileType.INSTANCE, text);
StubTree stubTree = ((PsiFileImpl)file).getStubTree();
assertNotNull(stubTree);
PsiElement anno = stubTree.getPlainList().stream().map(StubElement::getPsi).filter(psiElement -> psiElement instanceof PsiAnnotation).findFirst().get();
SmartPsiElementPointer<PsiElement> pointer = createPointer(anno);
assertNotNull(((PsiFileImpl)file).getStubTree());
//noinspection UnusedAssignment
stubTree = null;
//noinspection UnusedAssignment
anno = null;
gcPointerCache(pointer);
insertString(file.getViewProvider().getDocument(), 0, " ");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
assertNotNull(pointer.getElement());
}
public void testManyPsiChangesWithManySmartPointersPerformance() throws Exception {
String eachTag = "<a>\n" + StringUtil.repeat(" <a> </a>\n", 9) + "</a>\n";
XmlFile file = (XmlFile)createFile("a.xml", "<root>\n" + StringUtil.repeat(eachTag, 500) + "</root>");
List<XmlTag> tags = new ArrayList<>(PsiTreeUtil.findChildrenOfType(file.getDocument(), XmlTag.class));
List<SmartPsiElementPointer> pointers = ContainerUtil.map(tags, this::createPointer);
ApplicationManager.getApplication().runWriteAction(() -> PerformanceTestUtil.newPerformanceTest("smart pointer range update after PSI change", () -> {
for (int i = 0; i < tags.size(); i++) {
XmlTag tag = tags.get(i);
SmartPsiElementPointer pointer = pointers.get(i);
assertEquals(tag.getName().length(), TextRange.create(pointer.getRange()).getLength());
assertEquals(tag.getName().length(), TextRange.create(pointer.getPsiRange()).getLength());
tag.setName("bar1" + (i % 10));
assertEquals(tag.getName().length(), TextRange.create(pointer.getRange()).getLength());
assertEquals(tag.getName().length(), TextRange.create(pointer.getPsiRange()).getLength());
}
PostprocessReformattingAspect.getInstance(myProject).doPostponedFormatting();
}).start());
}
@NotNull
private <T extends PsiElement> SmartPointerEx<T> createPointer(T element) {
return (SmartPointerEx<T>)getPointerManager().createSmartPsiElementPointer(element);
}
public void testCommentingField() throws Exception {
@Language("JAVA")
String text = """
class A {
int x;
int y;
}""";
PsiJavaFile file = (PsiJavaFile)createFile("a.java", text);
PsiField[] fields = file.getClasses()[0].getFields();
SmartPointerEx<PsiField> pointer0 = createPointer(fields[0]);
SmartPointerEx<PsiField> pointer1 = createPointer(fields[1]);
WriteCommandAction.runWriteCommandAction(myProject, () -> {
Document document = file.getViewProvider().getDocument();
assert document != null;
document.insertString(file.getText().indexOf("int"), "//");
commitDocument(document);
});
assertNull(pointer0.getElement());
assertEquals("y", pointer1.getElement().getName());
}
public void testAnchorInfoHasRange() throws Exception {
@Language("JAVA")
String text = "class C1{}";
PsiJavaFile file = (PsiJavaFile)createFile("a.java", text);
assertNotNull(((PsiFileImpl) file).getStubTree());
PsiClass psiClass = file.getClasses()[0];
Segment range = createPointer(psiClass).getRange();
assertNotNull(range);
assertEquals(psiClass.getNameIdentifier().getTextRange(), TextRange.create(range));
file = (PsiJavaFile)createFile("b.java", "class C2{}");
assertNotNull(((PsiFileImpl) file).getStubTree());
psiClass = file.getClasses()[0];
range = createPointer(psiClass).getPsiRange();
assertNotNull(range);
assertEquals(psiClass.getNameIdentifier().getTextRange(), TextRange.create(range));
}
public void testManySmartPointersCreationDeletionPerformance() throws Exception {
String text = StringUtil.repeatSymbol(' ', 100000);
PsiFile file = createFile("a.txt", text);
PerformanceTestUtil.newPerformanceTest(getTestName(false), () -> {
List<SmartPsiFileRange> pointers = new ArrayList<>();
for (int i = 0; i < text.length() - 1; i++) {
pointers.add(getPointerManager().createSmartPsiFileRangePointer(file, new TextRange(i, i + 1)));
}
Collections.shuffle(pointers);
for (SmartPsiFileRange pointer : pointers) {
getPointerManager().removePointer(pointer);
}
}).start();
}
public void testDifferentHashCodesForDifferentElementsInOneFile() throws Exception {
@Language("JAVA")
String text = "class Foo { void foo(); }";
PsiClass clazz = ((PsiJavaFile)createFile("a.java", text)).getClasses()[0];
assertFalse(createPointer(clazz).hashCode() == createPointer(clazz.getMethods()[0]).hashCode());
}
public void testImportListPointerSurvivesImportAddition() throws Exception {
@Language("JAVA")
String text = "import foo.Bar;\nclass Foo {}";
PsiJavaFile file = (PsiJavaFile)createFile("a.java", text);
SmartPointerEx<PsiImportList> pointer = createPointer(file.getImportList());
Document document = file.getViewProvider().getDocument();
WriteCommandAction.runWriteCommandAction(myProject, () -> {
document.insertString(document.getText().indexOf("class"), "import foo.Goo;\n");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
});
assertEquals(file.getImportList(), pointer.getElement());
assertSize(2, file.getImportList().getImportStatements());
WriteCommandAction.runWriteCommandAction(myProject, () -> {
document.insertString(0, " ");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
document.deleteString(0, document.getText().indexOf("\nimport"));
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
});
assertEquals(file.getImportList(), pointer.getElement());
assertSize(1, file.getImportList().getImportStatements());
}
public void testNoAstLoadingOnFileRename() throws Exception {
@Language("JAVA")
String text = "class A {}";
PsiFile psiFile = createFile("a.java", text);
SmartPointerEx<PsiClass> pointer = createPointer(((PsiJavaFile)psiFile).getClasses()[0]);
assertFalse(((PsiFileImpl)psiFile).isContentsLoaded());
VirtualFile file = psiFile.getVirtualFile();
WriteAction.run(() -> file.rename(this, "b.java"));
assertTrue(psiFile.isValid());
assertEquals(((PsiJavaFile)psiFile).getClasses()[0], pointer.getElement());
assertFalse(((PsiFileImpl)psiFile).isContentsLoaded());
}
public void testDoubleRemoveIsAnError() throws Exception {
DefaultLogger.disableStderrDumping(getTestRootDisposable());
@Language("JAVA")
String text = "class A {}";
SmartPointerEx<PsiFile> pointer = createPointer(createFile("a.java", text));
getPointerManager().removePointer(pointer);
try {
getPointerManager().removePointer(pointer);
fail("Should have failed");
}
catch (AssertionError e) {
assertTrue(e.getMessage(), e.getMessage().contains("Double smart pointer removal"));
}
}
public void testStubSmartPointersAreCreatedEvenInAstPresence() throws Exception {
@Language("JAVA")
String text = "class A {}";
PsiJavaFileImpl file = (PsiJavaFileImpl)createFile("a.java", text);
assertNotNull(file.getNode());
SmartPointerEx<PsiClass> pointer = createPointer(file.getClasses()[0]);
GCWatcher.tracking(file.getNode()).ensureCollected();
assertNull(file.getTreeElement());
assertNotNull(pointer.getElement());
assertNull(file.getTreeElement());
}
public void testSurviveAfterWholeTextReplace() throws Exception {
@Language("JAVA")
String text = """
class A {void foo() {
//comment
}
void bar() {}
void bar2() {}
void bar3() {}
void bar4() {}
}""";
PsiJavaFileImpl file = (PsiJavaFileImpl)createFile("a.java", text);
SmartPointerEx<PsiMethod> pointer = createPointer(file.getClasses()[0].getMethods()[1]);
WriteCommandAction.runWriteCommandAction(myProject, () -> {
file.getViewProvider().getDocument().setText(text.replace("//comment", "//a\n//multiline\n// comment"));
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
});
assertEquals(file.getClasses()[0].getMethods()[1], pointer.getElement());
}
public void testRangePointerSurvivesLanguageChange() throws Exception {
PsiFile file = createFile("a.java", "abc");
SmartPsiFileRange pointer = getPointerManager().createSmartPsiFileRangePointer(file, TextRange.from(0, 1));
assertInstanceOf(pointer.getElement(), PsiJavaFile.class);
WriteCommandAction.runWriteCommandAction(myProject, () -> {
Document document = file.getViewProvider().getDocument();
file.setName("a.txt");
document.insertString(0, "ddd");
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
});
assertInstanceOf(pointer.getElement(), PsiPlainTextFile.class);
assertEquals(TextRange.from(3, 1), TextRange.create(pointer.getRange()));
}
public void testFileRangeWithUnicode() throws Exception {
PsiFile file = createFile("a.java", "\u042b");
assertEquals(1, file.getTextLength());
SmartPsiFileRange pointer = getPointerManager().createSmartPsiFileRangePointer(file, TextRange.from(0, file.getTextLength()));
assertEquals(TextRange.from(0, 1), TextRange.create(pointer.getPsiRange()));
assertEquals(TextRange.from(0, 1), TextRange.create(pointer.getRange()));
}
public void testSurviveOnDocumentChangeAround() throws Exception {
@Language("JAVA")
String text = "class Foo {}";
PsiFile file = createFile("a.java", text);
SmartPointerEx<PsiClass> pointer = createPointer(((PsiJavaFile)file).getClasses()[0]);
WriteCommandAction.runWriteCommandAction(myProject, () -> {
@Language("JAVA")
String text2 = " class Foo {} ";
file.getViewProvider().getDocument().setText(text2);
PsiDocumentManager.getInstance(myProject).commitAllDocuments();
});
assertNotNull(pointer.getElement());
}
// if the assertion is to be removed, please ensure that the test in IDEA-182567 passes
public void testCreatingPointerInsidePsiListenerProhibited() throws Exception {
DefaultLogger.disableStderrDumping(getTestRootDisposable());
@Language("JAVA")
String text = "class Foo { { int a; } }";
PsiFile file = createFile("a.java", text);
try {
WriteCommandAction.runWriteCommandAction(myProject, () -> {
PsiLocalVariable var = PsiTreeUtil.findElementOfClassAtOffset(file, file.getText().indexOf("int"), PsiLocalVariable.class, false);
PsiTreeChangeAdapter listener = new PsiTreeChangeAdapter() {
@Override
public void childAdded(@NotNull PsiTreeChangeEvent event) {
createPointer(var);
}
};
PsiManager.getInstance(getProject()).addPsiTreeChangeListener(listener);
try {
var.getModifierList().setModifierProperty(PsiModifier.FINAL, true);
}
finally {
PsiManager.getInstance(getProject()).removePsiTreeChangeListener(listener);
}
});
fail();
}
catch (AssertionError e) {
assertTrue(e.getMessage(), e.getMessage().contains("must not be created"));
}
}
public void testCanRestoreErrorElementsAtSameOffset() throws Exception {
String text = "class Foo { void foo() { if(IdeaLogger.ourErrorsOccurred != null) try(hrow IdeaLogger.ourErrorsOccurred; } }";
PsiFile file = createFile("a.java",
text);
for (PsiElement element : SyntaxTraverser.psiTraverser(file)) {
SmartPointerEx<PsiElement> pointer = createPointer(element);
assertEquals(element, pointer.getElement());
}
}
public void testDoNotLeakLightVirtualFileSmartPointersReachableViaDocument() {
Key<SmartPointerEx<PsiClass>> key = Key.create("smart pointer test");
Runnable createFileAndPointer = () -> {
PsiFile file = PsiFileFactory.getInstance(myProject).createFileFromText("a.java", JavaLanguage.INSTANCE, "class Foo {}", true, false);
SmartPointerEx<PsiClass> pointer = createPointer(((PsiJavaFile)file).getClasses()[0]);
file.getViewProvider().getDocument().putUserData(key, pointer);
};
createFileAndPointer.run();
GCUtil.tryGcSoftlyReachableObjects();
SmartPointerTracker.processQueue();
LeakHunter.checkLeak(LeakHunter.allRoots(), Document.class, d -> !(d instanceof FrozenDocument) && d.getUserData(key) != null);
}
public void testNonPhysicalPointersSurviveLikePhysical() {
String text = "class Foo { }";
PsiFile file = PsiFileFactory.getInstance(myProject).createFileFromText("a.java", JavaLanguage.INSTANCE, text, false, false);
Document document = file.getViewProvider().getDocument();
PsiWhiteSpace whiteSpace = assertInstanceOf(file.findElementAt(text.indexOf('{') + 1), PsiWhiteSpace.class);
SmartPointerEx<PsiWhiteSpace> pointer = createPointer(whiteSpace);
whiteSpace.replace(PsiParserFacade.getInstance(myProject).createWhiteSpaceFromText(" "));
assertFalse(whiteSpace.isValid());
assertSame(file.findElementAt(text.indexOf('{') + 1), pointer.getElement());
assertEquals("class Foo { }", document.getText());
}
public void testPointedBinaryFilesCanBeGcEd() throws Exception {
VirtualFile vFile = createFile("a.jar", "").getVirtualFile();
assertInstanceOf(getPsiManager().findFile(vFile), PsiBinaryFile.class);
SmartPointerEx<PsiFile> pointer = createPointer(getPsiManager().findFile(vFile));
GCWatcher.tracking(getPsiManager().findFile(vFile)).ensureCollected();
assertInstanceOf(pointer.getElement(), PsiBinaryFile.class);
}
public void testRangePointersSurviveNonPhysicalTextAddition() {
checkRangePointersSurviveNonPhysicalTextAddition(true);
checkRangePointersSurviveNonPhysicalTextAddition(false);
}
private void checkRangePointersSurviveNonPhysicalTextAddition(boolean eventSystemEnabled) {
String text1 = "import a.Foo1Bar;";
String text2 = "import a.Foo2Bar;";
PsiFileFactory factory = PsiFileFactory.getInstance(myProject);
PsiJavaFile file = (PsiJavaFile)factory
.createFileFromText("a.java", JavaLanguage.INSTANCE, text2, eventSystemEnabled, false);
Document document = file.getViewProvider().getDocument();
PsiImportStatement statement = file.getImportList().getImportStatements()[0];
SmartPsiFileRange pointer = getPointerManager().createSmartPsiFileRangePointer(file, statement.getImportReference().getTextRange());
WriteCommandAction.runWriteCommandAction(myProject, () -> {
file.getImportList().add(createImportFromText(text1));
});
assertEquals(text2, statement.getText());
assertEquals(statement.getImportReference().getTextRange(), pointer.getRange());
assertTrue(document.getText(), document.getText().startsWith(text1));
}
private PsiImportStatement createImportFromText(String text) {
return ((PsiJavaFile)PsiFileFactory.getInstance(myProject).createFileFromText("a.java", JavaLanguage.INSTANCE, text))
.getImportList().getImportStatements()[0];
}
}