Package com.intellij.psi.impl.source.tree.injected

Class CommentLiteralEscaper

java.lang.Object

com.intellij.psi.LiteralTextEscaper<PsiCommentImpl>

com.intellij.psi.impl.source.tree.injected.CommentLiteralEscaper

public class CommentLiteralEscaper
extends LiteralTextEscaper<PsiCommentImpl>

Field Summary

Fields inherited from class com.intellij.psi.LiteralTextEscaper

myHost

Constructor Summary

Constructors

Constructor and Description
CommentLiteralEscaper(PsiCommentImpl host)

Method Summary

Modifier and Type	Method and Description
boolean	decode(TextRange rangeInsideHost, java.lang.StringBuilder outChars) Add decoded and unescaped characters from the host element to outChars buffer.
int	getOffsetInHost(int offsetInDecoded, TextRange rangeInsideHost) This method is called only after LiteralTextEscaper.decode(com.intellij.openapi.util.TextRange, java.lang.StringBuilder), so it's possible to prepare necessary data in LiteralTextEscaper.decode(com.intellij.openapi.util.TextRange, java.lang.StringBuilder) and then use it here.
boolean	isOneLine()

Methods inherited from class com.intellij.psi.LiteralTextEscaper

createSimple, getRelevantTextRange

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentLiteralEscaper

public CommentLiteralEscaper(PsiCommentImpl host)

Method Detail

decode

public boolean decode(TextRange rangeInsideHost,
                      java.lang.StringBuilder outChars)

Description copied from class: LiteralTextEscaper

Add decoded and unescaped characters from the host element to outChars buffer. If it's impossible to properly decode some chars from the specified range (e.g. if the range starts or ends inside escaped sequence), decode the longest acceptable prefix of the range and return false

Specified by:

decode in class LiteralTextEscaper<PsiCommentImpl>

Parameters:

rangeInsideHost - range to be decoded. It's guarantied to be inside LiteralTextEscaper.getRelevantTextRange()

outChars - buffer for output chars. Use append methods only, it's forbidden to modify or remove existing characters

Returns:

true if whole range was successfully decoded, false otherwise

getOffsetInHost

public int getOffsetInHost(int offsetInDecoded,
                           TextRange rangeInsideHost)

Description copied from class: LiteralTextEscaper

This method is called only after LiteralTextEscaper.decode(com.intellij.openapi.util.TextRange, java.lang.StringBuilder), so it's possible to prepare necessary data in LiteralTextEscaper.decode(com.intellij.openapi.util.TextRange, java.lang.StringBuilder) and then use it here.

Specified by:

getOffsetInHost in class LiteralTextEscaper<PsiCommentImpl>

Parameters:

offsetInDecoded - offset in the parsed injected file

rangeInsideHost - range where injection is performed, E.g. if some language fragment xyz was injected into string literal expression "xyz", then rangeInsideHost = (1,4)

Returns:

offset in the host PSI element, or -1 if offset is out of host range. E.g. if some language fragment xyz was injected into string literal expression "xyz", then getOffsetInHost(0)==1 (there is an 'x' at offset 0 in injected fragment, and that 'x' occurs in "xyz" string literal at offset 1 since string literal expression "xyz" starts with double quote) getOffsetInHost(1)==2 getOffsetInHost(2)==3 getOffsetInHost(3)==-1 (out of range) Similarly, for some language fragment xyz being injected into xml text inside xml tag 'tag': xyz getOffsetInHost(0)==0 (there is an 'x' at offset 0 in injected fragment, and that 'x' occurs in xyz xml text at offset 0) getOffsetInHost(1)==1 getOffsetInHost(2)==2 getOffsetInHost(3)==-1 (out of range)

isOneLine

public boolean isOneLine()

Specified by:

isOneLine in class LiteralTextEscaper<PsiCommentImpl>

Returns:

true if the host cannot accept multiline content, false otherwise