org.jboss.aesh.parser

Class Parser

java.lang.Object

org.jboss.aesh.parser.Parser

public class Parser
extends java.lang.Object

String/Parser util methods

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.regex.Pattern	ansiPattern
static char	BACK_SLASH
static char	DOLLAR
static char	DOUBLE_QUOTE
private static char	NULL_CHAR
static char	SINGLE_QUOTE
static java.lang.String	SPACE
static char	SPACE_CHAR
private static java.lang.String	spaceEscapedMatcher
private static java.util.regex.Pattern	spaceEscapedPattern
private static java.util.regex.Pattern	spacePattern

Constructor Summary

Constructors

Constructor and Description
Parser()

Method Summary

Modifier and Type	Method and Description
private static int[]	calculateColumnSizes(java.util.List<TerminalString> displayList, int numColumns, int numRows, int termWidth)
private static boolean	canDisplayColumns(java.util.List<TerminalString> displayList, int numRows, int terminalWidth) Decides if it's possible to format provided Strings into calculated number of columns while the output will not exceed terminal width
static boolean	containsNonEscapedDollar(java.lang.String buffer)
static boolean	doesStringContainOpenQuote(java.lang.String text) Check if a string contain open quotes.
static boolean	doWordContainEscapedSpace(java.lang.String word)
static boolean	doWordContainOnlyEscapedSpace(java.lang.String word)
static int	findAllOccurrences(java.lang.String word, java.lang.String pattern)
static AeshLine	findAllWords(java.lang.String text) Split up the text into words, escaped spaces and quotes are handled
static java.lang.String	findCurrentWordFromCursor(java.lang.String text, int cursor) Return the word "connected" to cursor, the word ends at cursor position.
static java.lang.String	findEscapedSpaceWordCloseToEnd(java.lang.String text) Search backwards for a non-escaped space and only return work containing non-escaped space
static java.lang.String	findFirstWord(java.lang.String buffer) If string contain space, return the text before the first space.
static boolean	findIfWordEndWithSpace(java.lang.String word)
static int	findNumberOfSpacesInWord(java.lang.String word) find number of spaces in the given word.
static java.lang.String	findStartsWith(java.util.List<java.lang.String> completionList) Return the biggest common startsWith string
static java.lang.String	findStartsWithOperation(java.util.List<CompleteOperation> coList) If there is any common start string in the completion list, return it
static java.lang.String	findStartsWithTerminalString(java.util.List<TerminalString> completionList) Return the biggest common startsWith string
static java.lang.String	findWordClosestToCursor(java.lang.String text, int cursor)
static java.lang.String	formatDisplayCompactListTerminalString(java.util.List<TerminalString> displayList, int termWidth) Format output to columns with flexible sizes and no redundant space between them
static java.lang.String	formatDisplayList(java.util.List<java.lang.String> displayList, int termHeight, int termWidth) Format completions so that they look similar to GNU Readline
static java.lang.String	formatDisplayList(java.lang.String[] displayList, int termHeight, int termWidth) Format completions so that they look similar to GNU Readline
static java.lang.String	formatDisplayListTerminalString(java.util.List<TerminalString> displayList, int termHeight, int termWidth) Format completions so that they look similar to GNU Readline
static java.lang.String	padLeft(int n, java.lang.String s)
static java.lang.String	padRight(int n, java.lang.String s)
static java.util.List<java.lang.String>	splitBySizeKeepWords(java.lang.String words, int size)
private static boolean	startsWith(java.lang.String criteria, java.util.List<java.lang.String> completionList)
private static boolean	startsWithTerminalString(java.lang.String criteria, java.util.List<TerminalString> completionList)
static java.lang.String	stripAwayAnsiCodes(java.lang.String text)
static java.util.List<java.lang.String>	switchEscapedSpacesToSpacesInList(java.util.List<java.lang.String> list)
static void	switchEscapedSpacesToSpacesInTerminalStringList(java.util.List<TerminalString> list)
static java.lang.String	switchEscapedSpacesToSpacesInWord(java.lang.String word)
static java.lang.String	switchSpacesToEscapedSpacesInWord(java.lang.String word)
static java.lang.String	trim(java.lang.String buffer) Similar to String.trim(), but do not remove spaces that are escaped
static java.lang.String	trimInFront(java.lang.String buffer) Only trim space in front of the word
static java.lang.String	trimOptionName(java.lang.String word) remove leading dashes from word

Methods inherited from class java.lang.Object

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

Field Detail

spaceEscapedMatcher

private static final java.lang.String spaceEscapedMatcher

See Also:

Constant Field Values

SPACE

public static final java.lang.String SPACE

See Also:

Constant Field Values

SPACE_CHAR

public static final char SPACE_CHAR

See Also:

Constant Field Values

BACK_SLASH

public static final char BACK_SLASH

See Also:

Constant Field Values

SINGLE_QUOTE

public static final char SINGLE_QUOTE

See Also:

Constant Field Values

DOUBLE_QUOTE

public static final char DOUBLE_QUOTE

See Also:

Constant Field Values

DOLLAR

public static final char DOLLAR

See Also:

Constant Field Values

spaceEscapedPattern

private static final java.util.regex.Pattern spaceEscapedPattern

spacePattern

private static final java.util.regex.Pattern spacePattern

ansiPattern

private static final java.util.regex.Pattern ansiPattern

NULL_CHAR

private static final char NULL_CHAR

See Also:

Constant Field Values

Constructor Detail

Parser

public Parser()

Method Detail

formatDisplayList

public static java.lang.String formatDisplayList(java.lang.String[] displayList,
                                                 int termHeight,
                                                 int termWidth)

Format completions so that they look similar to GNU Readline

Parameters:

displayList - to format

termHeight - max height

termWidth - max width

Returns:

formatted string to be outputted

formatDisplayList

public static java.lang.String formatDisplayList(java.util.List<java.lang.String> displayList,
                                                 int termHeight,
                                                 int termWidth)

Format completions so that they look similar to GNU Readline

Parameters:

displayList - to format

termHeight - max height

termWidth - max width

Returns:

formatted string to be outputted

formatDisplayListTerminalString

public static java.lang.String formatDisplayListTerminalString(java.util.List<TerminalString> displayList,
                                                               int termHeight,
                                                               int termWidth)

Format completions so that they look similar to GNU Readline

Parameters:

displayList - to format

termHeight - max height

termWidth - max width

Returns:

formatted string to be outputted

formatDisplayCompactListTerminalString

public static java.lang.String formatDisplayCompactListTerminalString(java.util.List<TerminalString> displayList,
                                                                      int termWidth)

Format output to columns with flexible sizes and no redundant space between them

Parameters:

displayList - to format

termWidth - max width

Returns:

formatted string to be outputted

canDisplayColumns

private static boolean canDisplayColumns(java.util.List<TerminalString> displayList,
                                         int numRows,
                                         int terminalWidth)

Decides if it's possible to format provided Strings into calculated number of columns while the output will not exceed terminal width

Parameters:

displayList -

numRows -

terminalWidth -

Returns:

true if it's possible to format strings to columns and false otherwise.

calculateColumnSizes

private static int[] calculateColumnSizes(java.util.List<TerminalString> displayList,
                                          int numColumns,
                                          int numRows,
                                          int termWidth)

padRight

public static java.lang.String padRight(int n,
                                        java.lang.String s)

padLeft

public static java.lang.String padLeft(int n,
                                       java.lang.String s)

splitBySizeKeepWords

public static java.util.List<java.lang.String> splitBySizeKeepWords(java.lang.String words,
                                                                    int size)

trimOptionName

public static java.lang.String trimOptionName(java.lang.String word)

remove leading dashes from word

findIfWordEndWithSpace

public static boolean findIfWordEndWithSpace(java.lang.String word)

findStartsWithOperation

public static java.lang.String findStartsWithOperation(java.util.List<CompleteOperation> coList)

If there is any common start string in the completion list, return it

Parameters:

coList - completion list

Returns:

common start string

findStartsWith

public static java.lang.String findStartsWith(java.util.List<java.lang.String> completionList)

Return the biggest common startsWith string

Parameters:

completionList - list to compare

Returns:

biggest common startsWith string

startsWith

private static boolean startsWith(java.lang.String criteria,
                                  java.util.List<java.lang.String> completionList)

findStartsWithTerminalString

public static java.lang.String findStartsWithTerminalString(java.util.List<TerminalString> completionList)

Return the biggest common startsWith string

Parameters:

completionList - list to compare

Returns:

biggest common startsWith string

startsWithTerminalString

private static boolean startsWithTerminalString(java.lang.String criteria,
                                                java.util.List<TerminalString> completionList)

findWordClosestToCursor

public static java.lang.String findWordClosestToCursor(java.lang.String text,
                                                       int cursor)

findCurrentWordFromCursor

public static java.lang.String findCurrentWordFromCursor(java.lang.String text,
                                                         int cursor)

Return the word "connected" to cursor, the word ends at cursor position. Note that cursor position starts at 0

Parameters:

text - to parse

cursor - position

Returns:

word connected to cursor

findEscapedSpaceWordCloseToEnd

public static java.lang.String findEscapedSpaceWordCloseToEnd(java.lang.String text)

Search backwards for a non-escaped space and only return work containing non-escaped space

Parameters:

text - text

Returns:

text with only non-escaped space

doesStringContainOpenQuote

public static boolean doesStringContainOpenQuote(java.lang.String text)

Check if a string contain open quotes. Escaped quotes does not count.

Parameters:

text - text

Returns:

true if it contains open quotes, else false

findAllWords

public static AeshLine findAllWords(java.lang.String text)

Split up the text into words, escaped spaces and quotes are handled

Parameters:

text - test

Returns:

aeshline with all the words

doWordContainOnlyEscapedSpace

public static boolean doWordContainOnlyEscapedSpace(java.lang.String word)

doWordContainEscapedSpace

public static boolean doWordContainEscapedSpace(java.lang.String word)

findNumberOfSpacesInWord

public static int findNumberOfSpacesInWord(java.lang.String word)

find number of spaces in the given word. escaped spaces are not counted

Parameters:

word - to check

Returns:

number of spaces

findAllOccurrences

public static int findAllOccurrences(java.lang.String word,
                                     java.lang.String pattern)

switchEscapedSpacesToSpacesInList

public static java.util.List<java.lang.String> switchEscapedSpacesToSpacesInList(java.util.List<java.lang.String> list)

switchEscapedSpacesToSpacesInTerminalStringList

public static void switchEscapedSpacesToSpacesInTerminalStringList(java.util.List<TerminalString> list)

switchSpacesToEscapedSpacesInWord

public static java.lang.String switchSpacesToEscapedSpacesInWord(java.lang.String word)

switchEscapedSpacesToSpacesInWord

public static java.lang.String switchEscapedSpacesToSpacesInWord(java.lang.String word)

trim

public static java.lang.String trim(java.lang.String buffer)

Similar to String.trim(), but do not remove spaces that are escaped

Parameters:

buffer - input

Returns:

trimmed buffer

trimInFront

public static java.lang.String trimInFront(java.lang.String buffer)

Only trim space in front of the word

Parameters:

buffer - input

Returns:

trimmed buffer

findFirstWord

public static java.lang.String findFirstWord(java.lang.String buffer)

If string contain space, return the text before the first space. Spaces in the beginning and end is removed with Parser.trim(..)

Parameters:

buffer - input

Returns:

first word

containsNonEscapedDollar

public static boolean containsNonEscapedDollar(java.lang.String buffer)

stripAwayAnsiCodes

public static java.lang.String stripAwayAnsiCodes(java.lang.String text)