Package com.intellij.psi

Class AbstractFileViewProvider

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.AbstractFileViewProvider

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, FileViewProvider, java.lang.Cloneable

Direct Known Subclasses:

DummyHolderViewProvider, MultiplePsiFilesPerDocumentFileViewProvider, SingleRootFileViewProvider

public abstract class AbstractFileViewProvider
extends UserDataHolderBase
implements FileViewProvider

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Object>	FREE_THREADED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileViewProvider(PsiManager manager, VirtualFile virtualFile, boolean eventSystemEnabled)

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.
protected PsiFile	createFile(Language lang)
protected PsiFile	createFile(Project project, VirtualFile file, FileType fileType)
protected PsiFile	createFile(VirtualFile file, FileType fileType, Language language)
PsiElement	findElementAt(int offset, Language language)
static PsiElement	findElementAt(PsiElement psiFile, int offset)
PsiReference	findReferenceAt(int offset, Language language)
protected static PsiReference	findReferenceAt(PsiFile psiFile, int offset)
abstract PsiFile	getCachedPsi(Language target)
abstract java.util.List<PsiFile>	getCachedPsiFiles()
java.lang.CharSequence	getContents()
Document	getDocument()
PsiLock	getFilePsiLock()
FileType	getFileType()
abstract java.util.List<FileElement>	getKnownTreeRoots()
PsiManagerEx	getManager()
long	getModificationStamp()
PsiFile	getPsi(Language target)
protected abstract PsiFile	getPsiInner(Language target)
PsiFile	getStubBindingRoot()
VirtualFile	getVirtualFile()
boolean	isEventSystemEnabled()
static boolean	isFreeThreaded(FileViewProvider provider)
protected boolean	isIgnored()
boolean	isPhysical()
void	markInvalidated()
void	markPossiblyInvalidated()
void	onContentReload()
void	registerAsCopy(AbstractFileViewProvider copy)
void	rootChanged(PsiFile psiFile) Invoked when any PSI change happens in any of the PSI files corresponding to this view provider.
protected boolean	shouldCreatePsi()
boolean	supportsIncrementalReparse(Language rootLanguage)
java.lang.String	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

createCopy, findElementAt, findElementAt, findReferenceAt, getAllFiles, getBaseLanguage, 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

FREE_THREADED

public static final Key<java.lang.Object> FREE_THREADED

Constructor Detail

AbstractFileViewProvider

protected AbstractFileViewProvider(PsiManager manager,
                                   VirtualFile virtualFile,
                                   boolean eventSystemEnabled)

Method Detail

shouldCreatePsi

protected boolean shouldCreatePsi()

isFreeThreaded

public static boolean isFreeThreaded(FileViewProvider provider)

getFilePsiLock

public PsiLock getFilePsiLock()

isIgnored

protected final boolean isIgnored()

createFile

protected PsiFile createFile(Project project,
                             VirtualFile file,
                             FileType fileType)

createFile

protected PsiFile createFile(VirtualFile file,
                             FileType fileType,
                             Language language)

createFile

protected PsiFile createFile(Language lang)

getManager

public final PsiManagerEx getManager()

Specified by:

getManager in interface FileViewProvider

Returns:

this project's PsiManager

getContents

public java.lang.CharSequence getContents()

Specified by:

getContents in interface FileViewProvider

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:

FileViewProvider.getDocument(), PsiDocumentManager.isUncommited(Document)

getVirtualFile

public VirtualFile getVirtualFile()

Specified by:

getVirtualFile in interface FileViewProvider

Returns:

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

getDocument

public Document getDocument()

Specified by:

getDocument in interface FileViewProvider

Returns:

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

See Also:

FileType.isBinary(), PsiBinaryFile, FileViewProvider.isEventSystemEnabled()

getPsi

public final PsiFile getPsi(Language target)

Specified by:

getPsi in interface FileViewProvider

Returns:

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

getPsiInner

protected abstract PsiFile getPsiInner(Language target)

clone

public FileViewProvider clone()

Specified by:

clone in interface FileViewProvider

Overrides:

clone in class UserDataHolderBase

Returns:

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

See Also:

FileViewProvider.isPhysical(), FileViewProvider.isEventSystemEnabled(), FileViewProvider.createCopy(VirtualFile)

findElementAt

public PsiElement findElementAt(int offset,
                                Language language)

Specified by:

findElementAt in interface FileViewProvider

Returns:

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

See Also:

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

findReferenceAt

public PsiReference findReferenceAt(int offset,
                                    Language language)

Specified by:

findReferenceAt in interface FileViewProvider

Returns:

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

See Also:

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

findReferenceAt

protected static PsiReference findReferenceAt(PsiFile psiFile,
                                              int offset)

findElementAt

public static PsiElement findElementAt(PsiElement psiFile,
                                       int offset)

beforeContentsSynchronized

public void beforeContentsSynchronized()

Description copied from interface: FileViewProvider

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

Specified by:

beforeContentsSynchronized in interface FileViewProvider

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

See Also:

FileViewProvider.getLanguages()

onContentReload

public final void onContentReload()

rootChanged

public void rootChanged(PsiFile psiFile)

Description copied from interface: FileViewProvider

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

Specified by:

rootChanged in interface FileViewProvider

Parameters:

psiFile - the file where PSI has just been changed.

isEventSystemEnabled

public boolean isEventSystemEnabled()

Specified by:

isEventSystemEnabled in interface FileViewProvider

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

public boolean isPhysical()

Specified by:

isPhysical in interface FileViewProvider

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:

FileViewProvider.isEventSystemEnabled(), PsiElement.isPhysical()

getModificationStamp

public long getModificationStamp()

Specified by:

getModificationStamp in interface FileViewProvider

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

public boolean supportsIncrementalReparse(Language rootLanguage)

Specified by:

supportsIncrementalReparse in interface FileViewProvider

Returns:

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

See Also:

FileViewProvider.getLanguages()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCachedPsi

public abstract PsiFile getCachedPsi(Language target)

getCachedPsiFiles

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

getKnownTreeRoots

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

markInvalidated

public final void markInvalidated()

markPossiblyInvalidated

public final void markPossiblyInvalidated()

registerAsCopy

public final void registerAsCopy(AbstractFileViewProvider copy)

getStubBindingRoot

public PsiFile getStubBindingRoot()

Specified by:

getStubBindingRoot in interface FileViewProvider

Returns:

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

See Also:

FileViewProvider.getBaseLanguage()

getFileType

public final FileType getFileType()

Specified by:

getFileType in interface FileViewProvider

Returns:

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