Package com.intellij.psi

Class MultiplePsiFilesPerDocumentFileViewProvider

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.AbstractFileViewProvider

com.intellij.psi.MultiplePsiFilesPerDocumentFileViewProvider

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, FileViewProvider, java.lang.Cloneable

Direct Known Subclasses:

RestFileViewProvider

public abstract class MultiplePsiFilesPerDocumentFileViewProvider
extends AbstractFileViewProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ConcurrentMap<Language,PsiFileImpl>	myRoots

Fields inherited from class com.intellij.psi.AbstractFileViewProvider

FREE_THREADED

Constructor Summary

Constructors

Constructor and Description
MultiplePsiFilesPerDocumentFileViewProvider(PsiManager manager, VirtualFile virtualFile, boolean eventSystemEnabled)

Method Summary

Modifier and Type	Method and Description
void	checkAllTreesEqual()
protected abstract MultiplePsiFilesPerDocumentFileViewProvider	cloneInner(VirtualFile fileCopy)
void	contentsSynchronized() Invoked after PSI in the corresponding file is synchronized with the corresponding document, which can happen after VFS, document or PSI changes.
MultiplePsiFilesPerDocumentFileViewProvider	createCopy(VirtualFile fileCopy) Creates a copy of this view provider linked with the given (typically light) file.
protected PsiFileImpl	createPsiFileImpl(Language target)
PsiElement	findElementAt(int offset)
PsiElement	findElementAt(int offset, java.lang.Class<? extends Language> lang)
PsiReference	findReferenceAt(int offset)
java.util.List<PsiFile>	getAllFiles()
abstract Language	getBaseLanguage()
PsiFile	getCachedPsi(Language target)
java.util.List<PsiFile>	getCachedPsiFiles()
java.util.List<FileElement>	getKnownTreeRoots()
protected PsiFile	getPsiInner(Language target)
protected void	removeFile(Language language)

Methods inherited from class com.intellij.psi.AbstractFileViewProvider

beforeContentsSynchronized, clone, createFile, createFile, createFile, findElementAt, findElementAt, findReferenceAt, findReferenceAt, getContents, getDocument, getFilePsiLock, getFileType, getManager, getModificationStamp, getPsi, getStubBindingRoot, getVirtualFile, isEventSystemEnabled, isFreeThreaded, isIgnored, isPhysical, markInvalidated, markPossiblyInvalidated, onContentReload, registerAsCopy, rootChanged, shouldCreatePsi, supportsIncrementalReparse, toString

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.psi.FileViewProvider

getLanguages, hasLanguage

Methods inherited from interface com.intellij.openapi.util.UserDataHolderEx

putUserDataIfAbsent, replace

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Field Detail

myRoots

protected final java.util.concurrent.ConcurrentMap<Language,PsiFileImpl> myRoots

Constructor Detail

MultiplePsiFilesPerDocumentFileViewProvider

public MultiplePsiFilesPerDocumentFileViewProvider(PsiManager manager,
                                                   VirtualFile virtualFile,
                                                   boolean eventSystemEnabled)

Method Detail

getBaseLanguage

public abstract Language getBaseLanguage()

Returns:

the language of the main PSI tree (or the only one in a single-tree view providers). Used when returning a PsiFile from PsiManager.findFile(VirtualFile), PsiDocumentManager.getPsiFile(Document) etc.

getAllFiles

public java.util.List<PsiFile> getAllFiles()

Returns:

all PSI files for this view provider. In most cases, just one main file. For multi-root languages, several files. The files' languages should be the same as FileViewProvider.getLanguages(). The main file which corresponds to FileViewProvider.getBaseLanguage(), should be the first one. Otherwise the order is non-deterministic and should not be relied upon.

removeFile

protected final void removeFile(Language language)

getPsiInner

protected PsiFile getPsiInner(Language target)

Specified by:

getPsiInner in class AbstractFileViewProvider

createPsiFileImpl

protected PsiFileImpl createPsiFileImpl(Language target)

getCachedPsi

public final PsiFile getCachedPsi(Language target)

Specified by:

getCachedPsi in class AbstractFileViewProvider

getCachedPsiFiles

public final java.util.List<PsiFile> getCachedPsiFiles()

Specified by:

getCachedPsiFiles in class AbstractFileViewProvider

getKnownTreeRoots

public final java.util.List<FileElement> getKnownTreeRoots()

Specified by:

getKnownTreeRoots in class AbstractFileViewProvider

checkAllTreesEqual

public void checkAllTreesEqual()

createCopy

public final MultiplePsiFilesPerDocumentFileViewProvider createCopy(VirtualFile fileCopy)

Description copied from interface: FileViewProvider

Creates a copy of this view provider linked with the given (typically light) file. The result provider is required to be NOT event-system-enabled.

See Also:

LightVirtualFile, FileViewProvider.isEventSystemEnabled()

cloneInner

protected abstract MultiplePsiFilesPerDocumentFileViewProvider cloneInner(VirtualFile fileCopy)

findElementAt

public PsiElement findElementAt(int offset,
                                java.lang.Class<? extends Language> lang)

Returns:

the deepest (leaf) PSI element in the PSI tree with the specified root language class at the specified offset.

See Also:

FileViewProvider.getBaseLanguage(), FileViewProvider.findElementAt(int)

findElementAt

public PsiElement findElementAt(int offset)

Returns:

the deepest (leaf) PSI element in the main PSI tree at the specified offset.

See Also:

FileViewProvider.getBaseLanguage(), FileViewProvider.findElementAt(int, Class), FileViewProvider.findElementAt(int, Language), PsiElement.findElementAt(int)

findReferenceAt

public PsiReference findReferenceAt(int offset)

Returns:

a reference in the main PSI tree at the specified offset.

See Also:

FileViewProvider.getBaseLanguage(), PsiElement.findReferenceAt(int), FileViewProvider.findReferenceAt(int, Language)

contentsSynchronized

public void contentsSynchronized()

Description copied from interface: FileViewProvider

Invoked after PSI in the corresponding file is synchronized with the corresponding document, which can happen after VFS, document or PSI changes.

Multi-language file view providers may override this method to recalculate template data languages.

Specified by:

contentsSynchronized in interface FileViewProvider

Overrides:

contentsSynchronized in class AbstractFileViewProvider

See Also:

FileViewProvider.getLanguages()