Package com.intellij.lang.injection

Class InjectedLanguageManager

java.lang.Object

com.intellij.lang.injection.InjectedLanguageManager

Direct Known Subclasses:

CoreInjectedLanguageManager, InjectedLanguageManagerImpl

public abstract class InjectedLanguageManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	FRANKENSTEIN_INJECTION
protected static NotNullLazyKey<InjectedLanguageManager,Project>	INSTANCE_CACHE

Constructor Summary

Constructors

Constructor and Description
InjectedLanguageManager()

Method Summary

Modifier and Type	Method and Description
abstract void	dropFileCaches(PsiFile file)
abstract void	enumerate(PsiElement host, PsiLanguageInjectionHost.InjectedPsiVisitor visitor)
abstract void	enumerateEx(PsiElement host, PsiFile containingFile, boolean probeUp, PsiLanguageInjectionHost.InjectedPsiVisitor visitor)
abstract PsiElement	findInjectedElementAt(PsiFile hostFile, int hostDocumentOffset) Finds PSI element in injected fragment (if any) at the given offset in the host file. E.g.
abstract DocumentWindow	freezeWindow(DocumentWindow document)
abstract java.util.List<DocumentWindow>	getCachedInjectedDocumentsInRange(PsiFile hostPsiFile, TextRange range)
abstract java.util.List<Pair<PsiElement,TextRange>>	getInjectedPsiFiles(PsiElement host)
abstract PsiLanguageInjectionHost	getInjectionHost(FileViewProvider injectedProvider)
abstract PsiLanguageInjectionHost	getInjectionHost(PsiElement injectedElement)
static InjectedLanguageManager	getInstance(Project project)
abstract java.util.List<TextRange>	getNonEditableFragments(DocumentWindow window)
abstract PsiFile	getTopLevelFile(PsiElement element)
abstract java.lang.String	getUnescapedText(PsiElement injectedNode)
abstract int	injectedToHost(PsiElement injectedContext, int injectedOffset)
abstract int	injectedToHost(PsiElement injectedContext, int injectedOffset, boolean minHostOffset)
abstract TextRange	injectedToHost(PsiElement injectedContext, TextRange injectedTextRange)
abstract java.util.List<TextRange>	intersectWithAllEditableFragments(PsiFile injectedPsi, TextRange rangeToEdit)
abstract boolean	isInjectedFragment(PsiFile injectedFile)
abstract boolean	mightHaveInjectedFragmentAtOffset(Document hostDocument, int hostOffset) This method can be invoked on an uncommitted document, before performing commit and using other methods here (which don't work for uncommitted document).
abstract void	registerMultiHostInjector(MultiHostInjector injector) Deprecated. use extension point for production and registerMultiHostInjector(MultiHostInjector, Disposable) for tests
abstract void	registerMultiHostInjector(MultiHostInjector injector, Disposable parentDisposable)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE_CACHE

protected static final NotNullLazyKey<InjectedLanguageManager,Project> INSTANCE_CACHE

FRANKENSTEIN_INJECTION

public static final Key<java.lang.Boolean> FRANKENSTEIN_INJECTION

Constructor Detail

InjectedLanguageManager

public InjectedLanguageManager()

Method Detail

getInstance

public static InjectedLanguageManager getInstance(Project project)

getInjectionHost

public abstract PsiLanguageInjectionHost getInjectionHost(FileViewProvider injectedProvider)

getInjectionHost

public abstract PsiLanguageInjectionHost getInjectionHost(PsiElement injectedElement)

injectedToHost

public abstract TextRange injectedToHost(PsiElement injectedContext,
                                         TextRange injectedTextRange)

injectedToHost

public abstract int injectedToHost(PsiElement injectedContext,
                                   int injectedOffset)

injectedToHost

public abstract int injectedToHost(PsiElement injectedContext,
                                   int injectedOffset,
                                   boolean minHostOffset)

registerMultiHostInjector

@Deprecated
public abstract void registerMultiHostInjector(MultiHostInjector injector)

Deprecated. use extension point for production and registerMultiHostInjector(MultiHostInjector, Disposable) for tests

registerMultiHostInjector

public abstract void registerMultiHostInjector(MultiHostInjector injector,
                                               Disposable parentDisposable)

getUnescapedText

public abstract java.lang.String getUnescapedText(PsiElement injectedNode)

intersectWithAllEditableFragments

public abstract java.util.List<TextRange> intersectWithAllEditableFragments(PsiFile injectedPsi,
                                                                            TextRange rangeToEdit)

isInjectedFragment

public abstract boolean isInjectedFragment(PsiFile injectedFile)

findInjectedElementAt

public abstract PsiElement findInjectedElementAt(PsiFile hostFile,
                                                 int hostDocumentOffset)

Finds PSI element in injected fragment (if any) at the given offset in the host file.

E.g. if you injected XML "<xxx/>" into Java string literal "String s = "<xxx/>";" and the caret is at "xxx" then this method will return XmlToken(XML_TAG_START) with the text "xxx".
Invocation of this method on uncommitted hostFile can lead to unexpected results, including throwing an exception!

getInjectedPsiFiles

public abstract java.util.List<Pair<PsiElement,TextRange>> getInjectedPsiFiles(PsiElement host)

dropFileCaches

public abstract void dropFileCaches(PsiFile file)

getTopLevelFile

public abstract PsiFile getTopLevelFile(PsiElement element)

getCachedInjectedDocumentsInRange

public abstract java.util.List<DocumentWindow> getCachedInjectedDocumentsInRange(PsiFile hostPsiFile,
                                                                                 TextRange range)

enumerate

public abstract void enumerate(PsiElement host,
                               PsiLanguageInjectionHost.InjectedPsiVisitor visitor)

enumerateEx

public abstract void enumerateEx(PsiElement host,
                                 PsiFile containingFile,
                                 boolean probeUp,
                                 PsiLanguageInjectionHost.InjectedPsiVisitor visitor)

getNonEditableFragments

public abstract java.util.List<TextRange> getNonEditableFragments(DocumentWindow window)

Returns:

the ranges in this document window that correspond to prefix/suffix injected text fragments and thus can't be edited and are not visible in the editor.

mightHaveInjectedFragmentAtOffset

public abstract boolean mightHaveInjectedFragmentAtOffset(Document hostDocument,
                                                          int hostOffset)

This method can be invoked on an uncommitted document, before performing commit and using other methods here (which don't work for uncommitted document).

freezeWindow

public abstract DocumentWindow freezeWindow(DocumentWindow document)