Package org.jline.utils

Class InfoCmp

java.lang.Object

org.jline.utils.InfoCmp

public final class InfoCmp
extends Object

Utility class for terminal capability handling and terminfo database access.

The InfoCmp class provides utilities for working with terminal capabilities and accessing the terminfo database. It includes functionality for parsing terminfo entries, accessing capability values, and formatting capability strings with parameters.

Terminal capabilities are properties that describe what a terminal can do, such as moving the cursor, changing colors, or clearing the screen. These capabilities are typically stored in a terminfo database and are accessed by terminal type (e.g., "xterm", "vt100").

This class defines three types of capabilities:

• Boolean capabilities - Indicate whether a terminal supports a feature
• Numeric capabilities - Provide numeric values for terminal properties
• String capabilities - Define escape sequences for terminal operations

The class is named after the "infocmp" utility found in Unix-like systems, which is used to compare or print terminfo descriptions. It provides similar functionality for accessing and comparing terminal capabilities in Java.

This class is used extensively throughout JLine to determine terminal capabilities and generate appropriate escape sequences for terminal operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InfoCmp.Capability

Method Summary

Modifier and Type	Method	Description
static Map<String,InfoCmp.Capability>	getCapabilitiesByName()
static String	getDefaultInfoCmp(String terminal)
static String	getInfoCmp(String terminal)
static String	getLoadedInfoCmp(String terminal)
static void	parseInfoCmp(String capabilities, Set<InfoCmp.Capability> bools, Map<InfoCmp.Capability,Integer> ints, Map<InfoCmp.Capability,String> strings)
static void	setDefaultInfoCmp(String terminal, String caps)
static void	setDefaultInfoCmp(String terminal, Supplier<String> caps)
static void	setLoadedInfoCmp(String terminal, String caps)
static void	setLoadedInfoCmp(String terminal, Supplier<String> caps)

Methods inherited from class java.lang.Object

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

Method Details

getCapabilitiesByName

public static Map<String,InfoCmp.Capability> getCapabilitiesByName()

setDefaultInfoCmp

public static void setDefaultInfoCmp(String terminal,
 String caps)

setDefaultInfoCmp

public static void setDefaultInfoCmp(String terminal,
 Supplier<String> caps)

getDefaultInfoCmp

public static String getDefaultInfoCmp(String terminal)

setLoadedInfoCmp

public static void setLoadedInfoCmp(String terminal,
 String caps)

setLoadedInfoCmp

public static void setLoadedInfoCmp(String terminal,
 Supplier<String> caps)

getLoadedInfoCmp

public static String getLoadedInfoCmp(String terminal)

getInfoCmp

public static String getInfoCmp(String terminal)
                         throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

parseInfoCmp

public static void parseInfoCmp(String capabilities,
 Set<InfoCmp.Capability> bools,
 Map<InfoCmp.Capability,Integer> ints,
 Map<InfoCmp.Capability,String> strings)