Package com.intellij.psi

Interface FileViewProvider

All Superinterfaces:

java.lang.Cloneable, UserDataHolder, UserDataHolderEx

All Known Subinterfaces:

ConfigurableTemplateLanguageFileViewProvider, InjectedFileViewProvider, JspFileViewProvider, JspxFileViewProvider, TemplateLanguageFileViewProvider

All Known Implementing Classes:

AbstractFileViewProvider, ClassFileViewProvider, DummyHolderViewProvider, MultiplePsiFilesPerDocumentFileViewProvider, RestFileViewProvider, SingleRootFileViewProvider

public interface FileViewProvider
extends java.lang.Cloneable, UserDataHolderEx

Manages language-specific access to PSI for a single file.

Custom providers are registered via FileViewProviderFactory.

Please see File View Providers for high-level overview.

See Also:

PsiFile.getViewProvider(), PsiManager.findViewProvider(VirtualFile)

Method Summary

Modifier and Type	Method and Description
void	beforeContentsSynchronized() Invoked before document or VFS changes are processed that affect PSI inside the corresponding file.
FileViewProvider	clone()
void	contentsSynchronized() Invoked after PSI in the corresponding file is synchronized with the corresponding document, which can happen after VFS, document or PSI changes.
FileViewProvider	createCopy(VirtualFile copy) Creates a copy of this view provider linked with the given (typically light) file.
PsiElement	findElementAt(int offset)
PsiElement	findElementAt(int offset, java.lang.Class<? extends Language> lang)
PsiElement	findElementAt(int offset, Language language)
PsiReference	findReferenceAt(int offset)
PsiReference	findReferenceAt(int offset, Language language)
java.util.List<PsiFile>	getAllFiles()
Language	getBaseLanguage()
java.lang.CharSequence	getContents()
Document	getDocument()
FileType	getFileType()
java.util.Set<Language>	getLanguages()
PsiManager	getManager()
long	getModificationStamp()
PsiFile	getPsi(Language target)
PsiFile	getStubBindingRoot()
VirtualFile	getVirtualFile()
default boolean	hasLanguage(Language language) Check if given language is supported.
boolean	isEventSystemEnabled()
boolean	isPhysical()
void	rootChanged(PsiFile psiFile) Invoked when any PSI change happens in any of the PSI files corresponding to this view provider.
boolean	supportsIncrementalReparse(Language rootLanguage)

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

putUserDataIfAbsent, replace

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

getUserData, putUserData

Method Detail

getManager

PsiManager getManager()

Returns:

this project's PsiManager

getDocument

Document getDocument()

Returns:

the document corresponding to this file. Can be null for binary or files without events enabled.

See Also:

FileType.isBinary(), PsiBinaryFile, isEventSystemEnabled()

getContents

java.lang.CharSequence getContents()

Returns:

the contents of this file view provider, which are parsed into PSI trees. May or may not be equal to the contents of the corresponding document. The latter happens for non-committed documents. If the document is modified but not yet committed, the result is equivalent to PsiDocumentManager.getLastCommittedText(Document).

See Also:

getDocument(), PsiDocumentManager.isUncommited(Document)

getVirtualFile

VirtualFile getVirtualFile()

Returns:

the virtual file corresponding to this view provider. Physical or an instance of LightVirtualFile for most non-physical files.

getBaseLanguage

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.

getLanguages

java.util.Set<Language> getLanguages()

Returns:

all languages this file supports, in no particular order.

See Also:

getPsi(Language)

hasLanguage

default boolean hasLanguage(Language language)

Check if given language is supported. Implementations may provide more effective way to check without getting all languages.

getPsi

PsiFile getPsi(Language target)

Returns:

PsiFile for given language, or null if the language is not present

getAllFiles

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 getLanguages(). The main file which corresponds to getBaseLanguage(), should be the first one. Otherwise the order is non-deterministic and should not be relied upon.

isEventSystemEnabled

boolean isEventSystemEnabled()

Returns:

whether PSI events are fired when changes occur inside PSI in this view provider. true for physical files and for some non-physical as well.

See Also:

PsiTreeChangeListener, PsiFileFactory.createFileFromText(String, FileType, CharSequence, long, boolean), PsiElement.isPhysical()

isPhysical

boolean isPhysical()

Returns:

whether this file corresponds to a file on a disk. For such files, PsiFile.getVirtualFile() returns non-null. Not to be confused with PsiElement.isPhysical() which (for historical reasons) returns getViewProvider().isEventSystemEnabled()

See Also:

isEventSystemEnabled(), PsiElement.isPhysical()

getModificationStamp

long getModificationStamp()

Returns:

a number to quickly check if contents of this view provider have diverged from the corresponding VirtualFile or Document. If a document is modified but not yet committed, the result is the same as PsiDocumentManager.getLastCommittedStamp(Document)

See Also:

VirtualFile.getModificationStamp(), Document.getModificationStamp()

supportsIncrementalReparse

boolean supportsIncrementalReparse(Language rootLanguage)

Returns:

whether the PSI file with the specified root language supports incremental reparse.

See Also:

getLanguages()

rootChanged

void rootChanged(PsiFile psiFile)

Invoked when any PSI change happens in any of the PSI files corresponding to this view provider.

Parameters:

psiFile - the file where PSI has just been changed.

beforeContentsSynchronized

void beforeContentsSynchronized()

Invoked before document or VFS changes are processed that affect PSI inside the corresponding file.

contentsSynchronized

void contentsSynchronized()

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.

See Also:

getLanguages()

clone

FileViewProvider clone()

Returns:

a copy of this view provider, built on a LightVirtualFile, not physical and with PSI events disabled.

See Also:

isPhysical(), isEventSystemEnabled(), createCopy(VirtualFile)

findElementAt

PsiElement findElementAt(int offset)

Returns:

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

See Also:

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

findReferenceAt

PsiReference findReferenceAt(int offset)

Returns:

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

See Also:

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

findElementAt

PsiElement findElementAt(int offset,
                         Language language)

Returns:

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

See Also:

getBaseLanguage(), findElementAt(int)

findElementAt

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:

getBaseLanguage(), findElementAt(int)

findReferenceAt

PsiReference findReferenceAt(int offset,
                             Language language)

Returns:

a reference in the PSI tree with the specified root language at the specified offset.

See Also:

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

createCopy

FileViewProvider createCopy(VirtualFile copy)

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, isEventSystemEnabled()

getStubBindingRoot

PsiFile getStubBindingRoot()

Returns:

the PSI root for which stubs are to be built if supported. By default it's the main root.

See Also:

getBaseLanguage()

getFileType

FileType getFileType()

Returns:

the same as getVirtualFile().getFileType(), but cached.