Package com.intellij.psi

Interface PsiLanguageInjectionHost

All Superinterfaces:

Iconable, PsiElement, UserDataHolder

All Known Subinterfaces:

GrLiteral, GrLiteralContainer, GrRegex, GrString, GrStringContent, PyStringLiteralExpression, YAMLBlockScalar, YAMLQuotedText, YAMLScalar, YAMLScalarList, YAMLScalarText

All Known Implementing Classes:

GrAbstractLiteral, GrLiteralImpl, GrRegexImpl, GrStringContentImpl, GrStringImpl, JsonStringLiteralMixin, MarkdownCodeFenceImpl, PropertyImpl, PsiCommentImpl, PsiCoreCommentImpl, PsiLiteralExpressionImpl, PyStringLiteralExpressionImpl, RestLine, XmlAttributeValueImpl, XmlCommentImpl, XmlTextImpl, YAMLBlockScalarImpl, YAMLPlainTextImpl, YAMLQuotedTextImpl, YAMLScalarImpl, YAMLScalarListImpl, YAMLScalarTextImpl

public interface PsiLanguageInjectionHost
extends PsiElement

Marks PSI element as (potentially) containing text in other language. Injected language PSI does not embed into the PSI tree of the hosting element, but is used by the IDE for highlighting, completion and other code insight actions.

In order to do the injection, you have to

• Implement LanguageInjector to describe exact place where injection should occur.
• Register injection in LanguageInjector.EXTENSION_POINT_NAME extension point.

Currently, language can be injected into string literals, XML tag contents and XML attributes.

You don't have to implement PsiLanguageInjectionHost by yourself, unless you want to inject something into your own custom PSI. For all returned injected PSI elements, InjectedLanguageManager.getInjectionHost(PsiElement) returns PsiLanguageInjectionHost they were injected into.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PsiLanguageInjectionHost.InjectedPsiVisitor
static interface	PsiLanguageInjectionHost.Shred

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY, EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Method Summary

Modifier and Type	Method and Description
LiteralTextEscaper<? extends PsiLanguageInjectionHost>	createLiteralTextEscaper()
boolean	isValidHost()
PsiLanguageInjectionHost	updateText(java.lang.String text) Update the host element using the provided text of the injected file.

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray, toString

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

getUserData, putUserData

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

getIcon

Method Detail

isValidHost

boolean isValidHost()

Returns:

true if this instance can accept injections, false otherwise

updateText

PsiLanguageInjectionHost updateText(java.lang.String text)

Update the host element using the provided text of the injected file. It may be required to escape characters from text in accordance with the host language syntax. The implementation may delegate to ElementManipulators.handleContentChange(PsiElement, String) if ElementManipulator implementation is registered for this element class.

Parameters:

text - text of the injected file

Returns:

the updated instance

createLiteralTextEscaper

LiteralTextEscaper<? extends PsiLanguageInjectionHost> createLiteralTextEscaper()

Returns:

LiteralTextEscaper instance which will be used to convert the content of this host element to the content of injected file