Package com.intellij.psi.util

Class PsiLiteralUtil

java.lang.Object

com.intellij.psi.util.PsiLiteralUtil

public class PsiLiteralUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_2_IN_31
static java.lang.String	_2_IN_63
static java.lang.String	BIN_PREFIX
static java.lang.String	HEX_PREFIX

Constructor Summary

Constructors

Constructor and Description
PsiLiteralUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	escapeBackSlashesInTextBlock(java.lang.String str) Escapes backslashes in a text block (even if they're represented as an escape sequence).
static java.lang.String	escapeTextBlockCharacters(java.lang.String s) Converts given string to text block content.
static java.lang.String	escapeTextBlockCharacters(java.lang.String s, boolean escapeStartQuote, boolean escapeEndQuote, boolean escapeSpacesInTheEnd) Converts given string to text block content.
static int	getTextBlockIndent(java.lang.String [] lines) Determines how many whitespaces would be excluded at the beginning of each line of text block content.
static int	getTextBlockIndent(java.lang.String [] lines, boolean preserveContent, boolean ignoreLastLine)
static boolean	isUnsafeLiteral(PsiLiteralExpression expression) Returns true if given literal expression is invalid and reusing its text representation in refactorings/quick-fixes may result in parse errors.
static TextRange	mapBackStringRange(java.lang.String text, int from, int to) Maps the substring range inside Java String literal value back into the source code range.
static TextRange	mapBackTextBlockRange(java.lang.String text, int from, int to, int indent) Maps the substring range inside Java Text Block literal value back into the source code range.
static int	parseBackSlash(java.lang.String str, int idx) Parse backslash at given index.
static long	parseDigits(java.lang.String text, int bitsInRadix, int maxBits)
static java.lang.Double	parseDouble(java.lang.String text)
static java.lang.Float	parseFloat(java.lang.String text)
static java.lang.Integer	parseInteger(java.lang.String text)
static java.lang.Integer	parseIntegerNoPrefix(java.lang.String text)
static java.lang.Long	parseLong(java.lang.String text)
static java.lang.String	stringForCharLiteral(java.lang.String charLiteral) Converts passed character literal (like 'a') to string literal (like "a").

Methods inherited from class java.lang.Object

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

Field Detail

HEX_PREFIX

public static final java.lang.String HEX_PREFIX

See Also:

Constant Field Values

BIN_PREFIX

public static final java.lang.String BIN_PREFIX

See Also:

Constant Field Values

_2_IN_31

public static final java.lang.String _2_IN_31

_2_IN_63

public static final java.lang.String _2_IN_63

Constructor Detail

PsiLiteralUtil

public PsiLiteralUtil()

Method Detail

parseInteger

public static java.lang.Integer parseInteger(java.lang.String text)

parseIntegerNoPrefix

public static java.lang.Integer parseIntegerNoPrefix(java.lang.String text)

parseLong

public static java.lang.Long parseLong(java.lang.String text)

parseFloat

public static java.lang.Float parseFloat(java.lang.String text)

parseDouble

public static java.lang.Double parseDouble(java.lang.String text)

parseDigits

public static long parseDigits(java.lang.String text,
                               int bitsInRadix,
                               int maxBits)
                        throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

stringForCharLiteral

public static java.lang.String stringForCharLiteral(java.lang.String charLiteral)

Converts passed character literal (like 'a') to string literal (like "a").

Parameters:

charLiteral - character literal to convert.

Returns:

resulting string literal

isUnsafeLiteral

public static boolean isUnsafeLiteral(PsiLiteralExpression expression)

Returns true if given literal expression is invalid and reusing its text representation in refactorings/quick-fixes may result in parse errors.

Parameters:

expression - a literal expression to check

Returns:

true if the literal text cannot be safely used to build refactored expression

escapeTextBlockCharacters

public static java.lang.String escapeTextBlockCharacters(java.lang.String s)

Converts given string to text block content. String is converted as a last string in a text block.

Parameters:

s - original text

See Also:

escapeTextBlockCharacters(String, boolean, boolean, boolean)

escapeTextBlockCharacters

public static java.lang.String escapeTextBlockCharacters(java.lang.String s,
                                                         boolean escapeStartQuote,
                                                         boolean escapeEndQuote,
                                                         boolean escapeSpacesInTheEnd)

Converts given string to text block content.

During conversion:

All escaped quotes are unescaped. Every third quote is escaped. If escapeStartQuote / escapeEndQuote is set then start / end quote is also escaped. All spaces before \n are converted to \040 escape sequence. This is required since spaces in the end of the line are trimmed by default (see JEP 368). If escapeSpacesInTheEnd is set, then all spaces before the end of the line are converted even if new line in the end is missing. All new line escape sequences are interpreted. Rest of the content is processed as is.

Parameters:

s - original text

escapeStartQuote - true if first quote should be escaped (e.g. when copy-pasting into text block after two quotes)

escapeEndQuote - true if last quote should be escaped (e.g. inserting text into text block before closing quotes)

escapeSpacesInTheEnd - true if spaces in the end of the line should be preserved even if no new line in the end is present

escapeBackSlashesInTextBlock

public static java.lang.String escapeBackSlashesInTextBlock(java.lang.String str)

Escapes backslashes in a text block (even if they're represented as an escape sequence).

parseBackSlash

public static int parseBackSlash(java.lang.String str,
                                 int idx)

Parse backslash at given index. It will be parsed even in case when backslash is represented as unicode escape sequence.

Parameters:

str - text

idx - parse from

Returns:

index where next char starts, -1 otherwise

getTextBlockIndent

public static int getTextBlockIndent(java.lang.String [] lines)

Determines how many whitespaces would be excluded at the beginning of each line of text block content. See JEP 368 for more details.

Parameters:

lines - text block content

getTextBlockIndent

public static int getTextBlockIndent(java.lang.String [] lines,
                                     boolean preserveContent,
                                     boolean ignoreLastLine)

See Also:

getTextBlockIndent(String[])

mapBackStringRange

public static TextRange mapBackStringRange(java.lang.String text,
                                           int from,
                                           int to)

Maps the substring range inside Java String literal value back into the source code range.

Parameters:

text - string literal as present in source code (including quotes)

from - start offset inside the represented string

to - end offset inside the represented string

Returns:

the range which represents the corresponding substring inside source representation, or null if from/to values are out of bounds.

mapBackTextBlockRange

public static TextRange mapBackTextBlockRange(java.lang.String text,
                                              int from,
                                              int to,
                                              int indent)

Maps the substring range inside Java Text Block literal value back into the source code range.

Parameters:

indent - text block indent

Returns:

range in source code representation, null when from/to out of bounds or given text block source code representation is invalid