Package com.intellij.psi

Class PsiDocumentManager

java.lang.Object

com.intellij.psi.PsiDocumentManager

Direct Known Subclasses:

PsiDocumentManagerBase

public abstract class PsiDocumentManager
extends java.lang.Object

Manages the relationship between documents and PSI trees.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PsiDocumentManager.Listener Listener for receiving notifications about creation of Document and PsiFile instances.

Constructor Summary

Constructors

Constructor and Description
PsiDocumentManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addListener(PsiDocumentManager.Listener listener) Deprecated. Use message bus Listener#TOPIC.
abstract void	commitAllDocuments() Commits (updates the PSI tree for) all modified but not committed documents.
abstract boolean	commitAllDocumentsUnderProgress() Commits all modified but not committed documents under modal dialog (see commitAllDocuments() Should be called in UI thread and outside of write-action
abstract <T> T	commitAndRunReadAction(Computable<T> computation) Commits the documents and runs the specified operation, which returns a value, in a read action.
abstract void	commitAndRunReadAction(java.lang.Runnable runnable) Commits the documents and runs the specified operation, which does not return a value, in a read action.
abstract void	commitDocument(Document document) Updates the PSI tree for the specified document.
abstract void	doPostponedOperationsAndUnblockDocument(Document doc) Applies pending changes made through the PSI to the specified document.
abstract Document	getCachedDocument(PsiFile file) Returns the cached document for the specified PSI file.
abstract PsiFile	getCachedPsiFile(Document document) Returns the cached PSI file for the specified document.
abstract Document	getDocument(PsiFile file) Returns the document for the specified PSI file.
static PsiDocumentManager	getInstance(Project project) Returns the document manager instance for the specified project.
abstract Document	getLastCommittedDocument(PsiFile file) Returns the document for specified PsiFile intended to be used when working with committed PSI, e.g.
abstract long	getLastCommittedStamp(Document document)
abstract java.lang.CharSequence	getLastCommittedText(Document document)
abstract PsiFile	getPsiFile(Document document) Returns the PSI file for the specified document.
abstract Document []	getUncommittedDocuments() Returns the list of documents which have been modified but not committed.
abstract boolean	hasUncommitedDocuments() Checks if any modified documents have not been committed.
abstract boolean	isCommitted(Document document) Checks if the PSI tree for the specified document is up to date (its state reflects the latest changes made to the document content).
abstract boolean	isDocumentBlockedByPsi(Document doc) Checks if the PSI tree corresponding to the specified document has been modified and the changes have not yet been applied to the document.
abstract boolean	isUncommited(Document document) Checks if the specified document has been committed.
abstract void	performForCommittedDocument(Document document, java.lang.Runnable action) If the document is committed, runs action synchronously, otherwise schedules to execute it right after it has been committed.
abstract void	performLaterWhenAllCommitted(java.lang.Runnable runnable) Same as performLaterWhenAllCommitted(Runnable, ModalityState) using ModalityState.defaultModalityState()
abstract void	performLaterWhenAllCommitted(java.lang.Runnable runnable, ModalityState modalityState) Schedule the runnable to be executed on Swing thread when all the documents with event-system-enabled PSI are committed at some later moment in a given modality state.
abstract boolean	performWhenAllCommitted(java.lang.Runnable action) Defer action until all documents with event-system-enabled PSI are committed.
abstract void	removeListener(PsiDocumentManager.Listener listener) Deprecated. Use message bus Listener#TOPIC.
abstract void	reparseFiles(java.util.Collection<? extends VirtualFile> files, boolean includeOpenFiles) Reparses the specified set of files after an external configuration change that would cause them to be parsed differently (for example, a language level change in the settings).

Methods inherited from class java.lang.Object

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

Constructor Detail

PsiDocumentManager

public PsiDocumentManager()

Method Detail

isCommitted

public abstract boolean isCommitted(Document document)

Checks if the PSI tree for the specified document is up to date (its state reflects the latest changes made to the document content).

Parameters:

document - the document to check.

Returns:

true if the PSI tree for the document is up to date, false otherwise.

getInstance

public static PsiDocumentManager getInstance(Project project)

Returns the document manager instance for the specified project.

Parameters:

project - the project for which the document manager is requested.

Returns:

the document manager instance.

getPsiFile

public abstract PsiFile getPsiFile(Document document)

Returns the PSI file for the specified document.

Parameters:

document - the document for which the PSI file is requested.

Returns:

the PSI file instance.

getCachedPsiFile

public abstract PsiFile getCachedPsiFile(Document document)

Returns the cached PSI file for the specified document.

Parameters:

document - the document for which the PSI file is requested.

Returns:

the PSI file instance, or null if there is currently no cached PSI tree for the file.

getDocument

public abstract Document getDocument(PsiFile file)

Returns the document for the specified PSI file.

Parameters:

file - the file for which the document is requested.

Returns:

the document instance, or null if the file is binary or has no associated document.

getCachedDocument

public abstract Document getCachedDocument(PsiFile file)

Returns the cached document for the specified PSI file.

Parameters:

file - the file for which the document is requested.

Returns:

the document instance, or null if there is currently no cached document for the file.

commitAllDocuments

public abstract void commitAllDocuments()

Commits (updates the PSI tree for) all modified but not committed documents. Before a modified document is committed, accessing its PSI may return elements corresponding to original (unmodified) state of the document.

Should be called in UI thread in a write-safe context (see TransactionGuard)

commitAllDocumentsUnderProgress

public abstract boolean commitAllDocumentsUnderProgress()

Commits all modified but not committed documents under modal dialog (see commitAllDocuments() Should be called in UI thread and outside of write-action

Returns:

true if the operation completed successfully, false if it was cancelled.

performForCommittedDocument

public abstract void performForCommittedDocument(Document document,
                                                 java.lang.Runnable action)

If the document is committed, runs action synchronously, otherwise schedules to execute it right after it has been committed.

commitDocument

public abstract void commitDocument(Document document)

Updates the PSI tree for the specified document. Before a modified document is committed, accessing its PSI may return elements corresponding to original (unmodified) state of the document.

For documents with event-system-enabled PSI (FileViewProvider.isEventSystemEnabled()), should be called in UI thread in a write-safe context (see TransactionGuard). For other documents, can be called in background thread with read access. It's the responsibility of the caller to properly synchronize that PSI and ensure no other threads are reading or modifying it concurrently.

Parameters:

document - the document to commit.

getLastCommittedText

public abstract java.lang.CharSequence getLastCommittedText(Document document)

Returns:

the document text that PSI should be based upon. For changed documents, it's their old text until the document is committed. This sequence is immutable.

See Also:

ImmutableCharSequence

getLastCommittedStamp

public abstract long getLastCommittedStamp(Document document)

Returns:

for uncommitted documents, the last stamp before the document change: the same stamp that current PSI should have. For committed documents, just their stamp.

See Also:

Document.getModificationStamp(), FileViewProvider.getModificationStamp()

getLastCommittedDocument

public abstract Document getLastCommittedDocument(PsiFile file)

Returns the document for specified PsiFile intended to be used when working with committed PSI, e.g. outside dispatch thread.

Parameters:

file - the file for which the document is requested.

Returns:

an immutable document corresponding to the current PSI state. For committed documents, the contents and timestamp are equal to the ones of getDocument(PsiFile). For uncommitted documents, the text is getLastCommittedText(Document) and the modification stamp is getLastCommittedStamp(Document).

getUncommittedDocuments

public abstract Document [] getUncommittedDocuments()

Returns the list of documents which have been modified but not committed.

Returns:

the list of uncommitted documents.

See Also:

commitDocument(Document)

isUncommited

public abstract boolean isUncommited(Document document)

Checks if the specified document has been committed.

Parameters:

document - the document to check.

Returns:

true if the document was modified but not committed, false otherwise

See Also:

commitDocument(Document)

hasUncommitedDocuments

public abstract boolean hasUncommitedDocuments()

Checks if any modified documents have not been committed.

Returns:

true if there are uncommitted documents, false otherwise

commitAndRunReadAction

public abstract void commitAndRunReadAction(java.lang.Runnable runnable)

Commits the documents and runs the specified operation, which does not return a value, in a read action. Can be called from a thread other than the Swing dispatch thread.

Parameters:

runnable - the operation to execute.

commitAndRunReadAction

public abstract <T> T commitAndRunReadAction(Computable<T> computation)

Commits the documents and runs the specified operation, which returns a value, in a read action. Can be called from a thread other than the Swing dispatch thread.

Parameters:

computation - the operation to execute.

Returns:

the value returned by the operation.

reparseFiles

public abstract void reparseFiles(java.util.Collection<? extends VirtualFile> files,
                                  boolean includeOpenFiles)

Reparses the specified set of files after an external configuration change that would cause them to be parsed differently (for example, a language level change in the settings).

Parameters:

files - the files to reparse.

includeOpenFiles - if true, the files opened in editor tabs will also be reparsed.

addListener

@Deprecated
public abstract void addListener(PsiDocumentManager.Listener listener)

Deprecated. Use message bus Listener#TOPIC.

removeListener

@Deprecated
public abstract void removeListener(PsiDocumentManager.Listener listener)

Deprecated. Use message bus Listener#TOPIC.

isDocumentBlockedByPsi

public abstract boolean isDocumentBlockedByPsi(Document doc)

Checks if the PSI tree corresponding to the specified document has been modified and the changes have not yet been applied to the document. Documents in that state cannot be modified directly, because such changes would conflict with the pending PSI changes. Changes made through PSI are always applied in the end of a write action, and can be applied in the middle of a write action by calling doPostponedOperationsAndUnblockDocument(com.intellij.openapi.editor.Document).

Parameters:

doc - the document to check.

Returns:

true if the corresponding PSI has changes that haven't been applied to the document.

doPostponedOperationsAndUnblockDocument

public abstract void doPostponedOperationsAndUnblockDocument(Document doc)

Applies pending changes made through the PSI to the specified document.

Parameters:

doc - the document to apply the changes to.

performWhenAllCommitted

public abstract boolean performWhenAllCommitted(java.lang.Runnable action)

Defer action until all documents with event-system-enabled PSI are committed. Must be called from the EDT only.

Parameters:

action - to run when all documents committed

Returns:

true if action was run immediately (i.e. all documents are already committed)

performLaterWhenAllCommitted

public abstract void performLaterWhenAllCommitted(java.lang.Runnable runnable)

Same as performLaterWhenAllCommitted(Runnable, ModalityState) using ModalityState.defaultModalityState()

performLaterWhenAllCommitted

public abstract void performLaterWhenAllCommitted(java.lang.Runnable runnable,
                                                  ModalityState modalityState)

Schedule the runnable to be executed on Swing thread when all the documents with event-system-enabled PSI are committed at some later moment in a given modality state. The runnable is guaranteed to be invoked when no write action is running, and not immediately. If the project is disposed before such moment, the runnable is not run.