Package com.intellij.psi.impl

Class PsiDocumentManagerBase

java.lang.Object

com.intellij.psi.PsiDocumentManager

com.intellij.psi.impl.PsiDocumentManagerBase

All Implemented Interfaces:

Disposable, DocumentListener, java.util.EventListener

Direct Known Subclasses:

PsiDocumentManagerImpl

public abstract class PsiDocumentManagerBase
extends PsiDocumentManager
implements DocumentListener, Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PsiDocumentManagerBase.PriorityEventCollector

Nested classes/interfaces inherited from class com.intellij.psi.PsiDocumentManager

PsiDocumentManager.Listener

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentCommitProcessor	myDocumentCommitProcessor
protected Project	myProject

Fields inherited from interface com.intellij.openapi.editor.event.DocumentListener

ARRAY_FACTORY, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PsiDocumentManagerBase(Project project)

Method Summary

Modifier and Type	Method and Description
void	addListener(PsiDocumentManager.Listener listener)
static void	addRunOnCommit(Document document, java.lang.Runnable action)
void	associatePsi(Document document, PsiFile file)
void	beforeDocumentChange(DocumentEvent event) Called before the text of the document is changed.
protected void	beforeDocumentChangeOnUnlockedDocument(FileViewProvider viewProvider)
void	bulkUpdateFinished(Document document) Notifies about bulk mode being disabled.
void	bulkUpdateStarting(Document document) Notifies about bulk mode being enabled.
static void	cachePsi(Document document, PsiFile file) Deprecated.
boolean	cancelAndRunWhenAllCommitted(java.lang.Object key, java.lang.Runnable action) Cancel previously registered action and schedules (new) action to be executed when all documents are committed.
static boolean	checkConsistency(PsiFile psiFile, Document document)
void	clearUncommittedDocuments()
void	commitAllDocuments() Commits (updates the PSI tree for) all modified but not committed documents.
boolean	commitAllDocumentsUnderProgress() Commits all modified but not committed documents under modal dialog (see PsiDocumentManager.commitAllDocuments() Should be called in UI thread and outside of write-action
<T> T	commitAndRunReadAction(Computable<T> computation) Commits the documents and runs the specified operation, which returns a value, in a read action.
void	commitAndRunReadAction(java.lang.Runnable runnable) Commits the documents and runs the specified operation, which does not return a value, in a read action.
void	commitDocument(Document doc) Updates the PSI tree for the specified document.
void	disableBackgroundCommit(Disposable parentDisposable)
void	dispose() Usually not invoked directly, see class javadoc.
boolean	doCommitWithoutReparse(Document document)
void	documentChanged(DocumentEvent event) Called after the text of the document has been changed.
void	doPostponedOperationsAndUnblockDocument(Document doc) Applies pending changes made through the PSI to the specified document.
protected boolean	finishCommitInWriteAction(Document document, java.util.List<? extends BooleanRunnable> finishProcessors, java.util.List<? extends BooleanRunnable> reparseInjectedProcessors, boolean synchronously, boolean forceNoPsiCommit)
protected DocumentWindow	freezeWindow(DocumentWindow document)
Document	getCachedDocument(PsiFile file) Returns the cached document for the specified PSI file.
PsiFile	getCachedPsiFile(Document document) Returns the cached PSI file for the specified document.
Document	getDocument(PsiFile file) Returns the document for the specified PSI file.
java.util.List<DocumentEvent>	getEventsSinceCommit(Document document)
DocumentEx	getLastCommittedDocument(Document document)
Document	getLastCommittedDocument(PsiFile file) Returns the document for specified PsiFile intended to be used when working with committed PSI, e.g.
long	getLastCommittedStamp(Document document)
java.lang.CharSequence	getLastCommittedText(Document document)
PsiFile	getPsiFile(Document document) Returns the PSI file for the specified document.
PsiToDocumentSynchronizer	getSynchronizer()
Document []	getUncommittedDocuments() Returns the list of documents which have been modified but not committed.
boolean	hasEventSystemEnabledUncommittedDocuments()
boolean	hasUncommitedDocuments() Checks if any modified documents have not been committed.
boolean	isCommitInProgress()
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).
boolean	isDefaultProject()
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.
static boolean	isFullReparseInProgress()
boolean	isUncommited(Document document) Checks if the specified document has been committed.
void	performForCommittedDocument(Document doc, java.lang.Runnable action) If the document is committed, runs action synchronously, otherwise schedules to execute it right after it has been committed.
void	performLaterWhenAllCommitted(java.lang.Runnable runnable) Same as PsiDocumentManager.performLaterWhenAllCommitted(Runnable, ModalityState) using ModalityState.defaultModalityState()
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.
boolean	performWhenAllCommitted(java.lang.Runnable action) Schedules action to be executed when all documents are committed.
void	removeListener(PsiDocumentManager.Listener listener)
void	reparseFileFromText(PsiFileImpl file)
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 com.intellij.psi.PsiDocumentManager

getInstance

Methods inherited from class java.lang.Object

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

Field Detail

myProject

protected final Project myProject

myDocumentCommitProcessor

protected final DocumentCommitProcessor myDocumentCommitProcessor

Constructor Detail

PsiDocumentManagerBase

protected PsiDocumentManagerBase(Project project)

Method Detail

getPsiFile

public PsiFile getPsiFile(Document document)

Description copied from class: PsiDocumentManager

Returns the PSI file for the specified document.

Specified by:

getPsiFile in class PsiDocumentManager

Parameters:

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

Returns:

the PSI file instance.

cachePsi

@Deprecated
public static void cachePsi(Document document,
                            PsiFile file)

Deprecated.

associatePsi

public void associatePsi(Document document,
                         PsiFile file)

getCachedPsiFile

public PsiFile getCachedPsiFile(Document document)

Description copied from class: PsiDocumentManager

Returns the cached PSI file for the specified document.

Specified by:

getCachedPsiFile in class PsiDocumentManager

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 Document getDocument(PsiFile file)

Description copied from class: PsiDocumentManager

Returns the document for the specified PSI file.

Specified by:

getDocument in class PsiDocumentManager

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 Document getCachedDocument(PsiFile file)

Description copied from class: PsiDocumentManager

Returns the cached document for the specified PSI file.

Specified by:

getCachedDocument in class PsiDocumentManager

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 void commitAllDocuments()

Description copied from class: PsiDocumentManager

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)

Specified by:

commitAllDocuments in class PsiDocumentManager

commitAllDocumentsUnderProgress

public boolean commitAllDocumentsUnderProgress()

Description copied from class: PsiDocumentManager

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

Specified by:

commitAllDocumentsUnderProgress in class PsiDocumentManager

Returns:

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

doCommitWithoutReparse

public boolean doCommitWithoutReparse(Document document)

performForCommittedDocument

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

Description copied from class: PsiDocumentManager

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

Specified by:

performForCommittedDocument in class PsiDocumentManager

cancelAndRunWhenAllCommitted

public boolean cancelAndRunWhenAllCommitted(java.lang.Object key,
                                            java.lang.Runnable action)

Cancel previously registered action and schedules (new) action to be executed when all documents are committed.

Parameters:

key - the (unique) id of the action.

action - The action to be executed after automatic commit. This action will overwrite any action which was registered under this key earlier. The action will be executed in EDT.

Returns:

true if action has been run immediately, or false if action was scheduled for execution later.

addRunOnCommit

public static void addRunOnCommit(Document document,
                                  java.lang.Runnable action)

commitDocument

public void commitDocument(Document doc)

Description copied from class: PsiDocumentManager

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.

Specified by:

commitDocument in class PsiDocumentManager

Parameters:

doc - the document to commit.

finishCommitInWriteAction

protected boolean finishCommitInWriteAction(Document document,
                                            java.util.List<? extends BooleanRunnable> finishProcessors,
                                            java.util.List<? extends BooleanRunnable> reparseInjectedProcessors,
                                            boolean synchronously,
                                            boolean forceNoPsiCommit)

isCommitInProgress

public boolean isCommitInProgress()

isFullReparseInProgress

public static boolean isFullReparseInProgress()

commitAndRunReadAction

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

Description copied from class: PsiDocumentManager

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.

Specified by:

commitAndRunReadAction in class PsiDocumentManager

Parameters:

computation - the operation to execute.

Returns:

the value returned by the operation.

reparseFiles

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

Description copied from class: PsiDocumentManager

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).

Specified by:

reparseFiles in class PsiDocumentManager

Parameters:

files - the files to reparse.

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

commitAndRunReadAction

public void commitAndRunReadAction(java.lang.Runnable runnable)

Description copied from class: PsiDocumentManager

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.

Specified by:

commitAndRunReadAction in class PsiDocumentManager

Parameters:

runnable - the operation to execute.

performWhenAllCommitted

public boolean performWhenAllCommitted(java.lang.Runnable action)

Schedules action to be executed when all documents are committed.

Specified by:

performWhenAllCommitted in class PsiDocumentManager

Parameters:

action - to run when all documents committed

Returns:

true if action has been run immediately, or false if action was scheduled for execution later.

performLaterWhenAllCommitted

public void performLaterWhenAllCommitted(java.lang.Runnable runnable)

Description copied from class: PsiDocumentManager

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

Specified by:

performLaterWhenAllCommitted in class PsiDocumentManager

performLaterWhenAllCommitted

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

Description copied from class: PsiDocumentManager

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.

Specified by:

performLaterWhenAllCommitted in class PsiDocumentManager

hasEventSystemEnabledUncommittedDocuments

public boolean hasEventSystemEnabledUncommittedDocuments()

addListener

public void addListener(PsiDocumentManager.Listener listener)

Specified by:

addListener in class PsiDocumentManager

removeListener

public void removeListener(PsiDocumentManager.Listener listener)

Specified by:

removeListener in class PsiDocumentManager

isDocumentBlockedByPsi

public boolean isDocumentBlockedByPsi(Document doc)

Description copied from class: PsiDocumentManager

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 PsiDocumentManager.doPostponedOperationsAndUnblockDocument(com.intellij.openapi.editor.Document).

Specified by:

isDocumentBlockedByPsi in class PsiDocumentManager

Parameters:

doc - the document to check.

Returns:

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

doPostponedOperationsAndUnblockDocument

public void doPostponedOperationsAndUnblockDocument(Document doc)

Description copied from class: PsiDocumentManager

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

Specified by:

doPostponedOperationsAndUnblockDocument in class PsiDocumentManager

Parameters:

doc - the document to apply the changes to.

getLastCommittedText

public java.lang.CharSequence getLastCommittedText(Document document)

Specified by:

getLastCommittedText in class PsiDocumentManager

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 long getLastCommittedStamp(Document document)

Specified by:

getLastCommittedStamp in class PsiDocumentManager

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 Document getLastCommittedDocument(PsiFile file)

Description copied from class: PsiDocumentManager

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

Specified by:

getLastCommittedDocument in class PsiDocumentManager

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 PsiDocumentManager.getDocument(PsiFile). For uncommitted documents, the text is PsiDocumentManager.getLastCommittedText(Document) and the modification stamp is PsiDocumentManager.getLastCommittedStamp(Document).

getLastCommittedDocument

public DocumentEx getLastCommittedDocument(Document document)

freezeWindow

protected DocumentWindow freezeWindow(DocumentWindow document)

getEventsSinceCommit

public java.util.List<DocumentEvent> getEventsSinceCommit(Document document)

getUncommittedDocuments

public Document [] getUncommittedDocuments()

Description copied from class: PsiDocumentManager

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

Specified by:

getUncommittedDocuments in class PsiDocumentManager

Returns:

the list of uncommitted documents.

See Also:

PsiDocumentManager.commitDocument(Document)

isUncommited

public boolean isUncommited(Document document)

Description copied from class: PsiDocumentManager

Checks if the specified document has been committed.

Specified by:

isUncommited in class PsiDocumentManager

Parameters:

document - the document to check.

Returns:

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

See Also:

PsiDocumentManager.commitDocument(Document)

isCommitted

public boolean isCommitted(Document document)

Description copied from class: PsiDocumentManager

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

Specified by:

isCommitted in class PsiDocumentManager

Parameters:

document - the document to check.

Returns:

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

hasUncommitedDocuments

public boolean hasUncommitedDocuments()

Description copied from class: PsiDocumentManager

Checks if any modified documents have not been committed.

Specified by:

hasUncommitedDocuments in class PsiDocumentManager

Returns:

true if there are uncommitted documents, false otherwise

beforeDocumentChange

public void beforeDocumentChange(DocumentEvent event)

Description copied from interface: DocumentListener

Called before the text of the document is changed.

Specified by:

beforeDocumentChange in interface DocumentListener

Parameters:

event - the event containing the information about the change.

beforeDocumentChangeOnUnlockedDocument

protected void beforeDocumentChangeOnUnlockedDocument(FileViewProvider viewProvider)

documentChanged

public void documentChanged(DocumentEvent event)

Description copied from interface: DocumentListener

Called after the text of the document has been changed.

Specified by:

documentChanged in interface DocumentListener

Parameters:

event - the event containing the information about the change.

bulkUpdateStarting

public void bulkUpdateStarting(Document document)

Description copied from interface: DocumentListener

Notifies about bulk mode being enabled.

Specified by:

bulkUpdateStarting in interface DocumentListener

bulkUpdateFinished

public void bulkUpdateFinished(Document document)

Description copied from interface: DocumentListener

Notifies about bulk mode being disabled.

Specified by:

bulkUpdateFinished in interface DocumentListener

checkConsistency

public static boolean checkConsistency(PsiFile psiFile,
                                       Document document)

clearUncommittedDocuments

public void clearUncommittedDocuments()

disableBackgroundCommit

public void disableBackgroundCommit(Disposable parentDisposable)

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getSynchronizer

public PsiToDocumentSynchronizer getSynchronizer()

reparseFileFromText

public void reparseFileFromText(PsiFileImpl file)

isDefaultProject

public boolean isDefaultProject()