Package org.jline.console.impl

Class ConsoleEngineImpl

java.lang.Object

org.jline.console.impl.AbstractCommandRegistry

org.jline.console.impl.JlineCommandRegistry

org.jline.console.impl.ConsoleEngineImpl

All Implemented Interfaces:

CommandRegistry, ConsoleEngine

public class ConsoleEngineImpl
extends JlineCommandRegistry
implements ConsoleEngine

Manage console variables, commands and script execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ConsoleEngineImpl.AliasValueCompleter
static class	ConsoleEngineImpl.Command
private class	ConsoleEngineImpl.ScriptFile

Nested classes/interfaces inherited from interface org.jline.console.CommandRegistry

CommandRegistry.CommandSession

Nested classes/interfaces inherited from interface org.jline.console.ConsoleEngine

ConsoleEngine.ExecutionResult, ConsoleEngine.WidgetCreator

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,java.lang.String>	aliases
private java.nio.file.Path	aliasFile
private static java.lang.String	END_HELP
private ScriptEngine	engine
private java.lang.Exception	exception
private boolean	executing
private static int	HELP_MAX_SIZE
private static java.lang.String[]	OPTION_HELP
private static java.lang.String	OPTION_VERBOSE
private java.util.Map<java.lang.String,java.util.List<java.lang.String>>	pipes
private Printer	printer
private LineReader	reader
private java.lang.String	scriptExtension
private static java.lang.String	SLURP_FORMAT_TEXT
private SystemRegistry	systemRegistry
private static java.lang.String	VAR_CONSOLE_OPTIONS
private static java.lang.String	VAR_PATH
private java.util.function.Supplier<java.nio.file.Path>	workDir

Constructor Summary

Constructors

Constructor	Description
ConsoleEngineImpl(java.util.Set<ConsoleEngineImpl.Command> commands, ScriptEngine engine, Printer printer, java.util.function.Supplier<java.nio.file.Path> workDir, ConfigurationPath configPath)
ConsoleEngineImpl(ScriptEngine engine, Printer printer, java.util.function.Supplier<java.nio.file.Path> workDir, ConfigurationPath configPath)

Method Summary

Modifier and Type	Method	Description
private java.lang.Object	aliascmd(CommandInput input)
private java.util.List<Completer>	aliasCompleter(java.lang.String command)
private java.util.Set<java.lang.String>	commandAliasNames()
private boolean	consoleOption(java.lang.String option)
<T> T	consoleOption(java.lang.String option, T defval)	Read console option value
private java.util.Map<java.lang.String,java.lang.Object>	consoleOptions()
private java.lang.Object	del(CommandInput input)
private java.lang.Object	doc(CommandInput input)
private java.util.List<Completer>	docCompleter(java.lang.String command)
private java.util.List<java.lang.String>	docs()
private void	error(java.lang.String message)
java.lang.Object	execute(java.io.File script, java.lang.String cmdLine, java.lang.String[] args)	Executes either JLine or ScriptEngine script.
java.lang.Object	execute(java.lang.String cmd, java.lang.String line, java.lang.String[] args)	Executes command line that does not contain known command by the system registry.
boolean	executeWidget(java.lang.Object function)	Execute widget function
java.lang.String	expandCommandLine(java.lang.String line)	Substitutes command line with system registry invoke method call.
private java.lang.String	expandName(java.lang.String name)
java.lang.Object[]	expandParameters(java.lang.String[] args)	Substituting args references with their values.
private java.lang.String	expandToList(java.lang.String[] args)
java.lang.String	expandToList(java.util.List<java.lang.String> params)	Expands parameter list to string
java.lang.String	getAlias(java.lang.String name)	Returns alias 'name' value
java.util.List<java.lang.String>	getNamedPipes()	Returns named pipe names
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getPipes()	Returns defined pipes
java.lang.Object	getVariable(java.lang.String name)	Get variable value
boolean	hasAlias(java.lang.String name)	Returns true if alias 'name' exists
boolean	hasVariable(java.lang.String name)	Test if variable with name exists
java.lang.Object	invoke(CommandRegistry.CommandSession session, java.lang.String command, java.lang.Object... args)	Execute a command.
private boolean	isCodeBlock(java.lang.String line)
private boolean	isCommandLine(java.lang.String line)
boolean	isExecuting()
private boolean	isNumber(java.lang.String str)
private Parser	parser()
void	persist(java.nio.file.Path file, java.lang.Object object)	Persist object to file
private java.lang.Object	pipe(CommandInput input)
ConsoleEngine.ExecutionResult	postProcess(java.lang.Object result)	Post processes execution result.
private ConsoleEngine.ExecutionResult	postProcess(java.lang.String line, java.lang.Object result)
ConsoleEngine.ExecutionResult	postProcess(java.lang.String line, java.lang.Object result, java.lang.String output)	Post processes execution result.
void	println(java.lang.Object object)	Print object.
private java.lang.Object	prnt(CommandInput input)
private java.util.List<Completer>	prntCompleter(java.lang.String command)
void	purge()	Delete temporary console variables
void	putVariable(java.lang.String name, java.lang.Object value)	Create console variable
private java.lang.String	quote(java.lang.String var)
private int	saveResult(java.lang.String var, java.lang.Object result)
java.util.List<Completer>	scriptCompleters()	Returns script and variable completers
private java.util.List<java.lang.String>	scriptExtensions()
private java.util.Set<java.lang.String>	scriptNames()
java.util.Map<java.lang.String,java.lang.Boolean>	scripts()	Returns all scripts found from PATH
void	setLineReader(LineReader reader)	Sets lineReader
void	setScriptExtension(java.lang.String extension)	Sets file name extension used by console scripts
void	setSystemRegistry(SystemRegistry systemRegistry)	Sets systemRegistry
private java.lang.Object	show(CommandInput input)
java.lang.Object	slurp(java.nio.file.Path file)	Read object from file
private java.lang.Object	slurp(java.nio.file.Path file, java.nio.charset.Charset encoding, java.lang.String format)
private java.lang.Object	slurpcmd(CommandInput input)
private java.util.List<Completer>	slurpCompleter(java.lang.String command)
private Terminal	terminal()
void	trace(java.lang.Object object)
private java.lang.Object	unalias(CommandInput input)
private java.util.List<Completer>	unaliasCompleter(java.lang.String command)
private boolean	urlExists(java.lang.String weburl)
private java.util.List<Completer>	variableCompleter(java.lang.String command)
private java.util.List<java.lang.String>	variableReferences()

Methods inherited from class org.jline.console.impl.JlineCommandRegistry

commandDescription, commandInfo, commandOptions, compileCommandDescription, compileCommandInfo, compileCommandOptions, defaultCompleter, parseOptions

Methods inherited from class org.jline.console.impl.AbstractCommandRegistry

alias, commandAliases, commandNames, compileCompleters, doHelpDesc, getCommandMethods, hasCommand, registerCommands, registerCommands, registeredCommand, rename, saveException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.console.CommandRegistry

commandAliases, commandDescription, commandInfo, commandNames, compileCompleters, hasCommand, name

Methods inherited from interface org.jline.console.ConsoleEngine

execute

Field Detail

VAR_CONSOLE_OPTIONS

private static final java.lang.String VAR_CONSOLE_OPTIONS

See Also:

Constant Field Values

VAR_PATH

private static final java.lang.String VAR_PATH

See Also:

Constant Field Values

OPTION_HELP

private static final java.lang.String[] OPTION_HELP

OPTION_VERBOSE

private static final java.lang.String OPTION_VERBOSE

See Also:

Constant Field Values

SLURP_FORMAT_TEXT

private static final java.lang.String SLURP_FORMAT_TEXT

See Also:

Constant Field Values

END_HELP

private static final java.lang.String END_HELP

See Also:

Constant Field Values

HELP_MAX_SIZE

private static final int HELP_MAX_SIZE

See Also:

Constant Field Values

engine

private final ScriptEngine engine

exception

private java.lang.Exception exception

systemRegistry

private SystemRegistry systemRegistry

scriptExtension

private java.lang.String scriptExtension

workDir

private final java.util.function.Supplier<java.nio.file.Path> workDir

aliases

private final java.util.Map<java.lang.String,java.lang.String> aliases

pipes

private final java.util.Map<java.lang.String,java.util.List<java.lang.String>> pipes

aliasFile

private java.nio.file.Path aliasFile

reader

private LineReader reader

executing

private boolean executing

printer

private final Printer printer

Constructor Detail

ConsoleEngineImpl

public ConsoleEngineImpl(ScriptEngine engine,
                         Printer printer,
                         java.util.function.Supplier<java.nio.file.Path> workDir,
                         ConfigurationPath configPath)
                  throws java.io.IOException

Throws:

java.io.IOException

ConsoleEngineImpl

public ConsoleEngineImpl(java.util.Set<ConsoleEngineImpl.Command> commands,
                         ScriptEngine engine,
                         Printer printer,
                         java.util.function.Supplier<java.nio.file.Path> workDir,
                         ConfigurationPath configPath)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setLineReader

public void setLineReader(LineReader reader)

Description copied from interface: ConsoleEngine

Sets lineReader

Specified by:

setLineReader in interface ConsoleEngine

Parameters:

reader - LineReader

parser

private Parser parser()

terminal

private Terminal terminal()

isExecuting

public boolean isExecuting()

Specified by:

isExecuting in interface ConsoleEngine

Returns:

true if consoleEngine is executing script

setSystemRegistry

public void setSystemRegistry(SystemRegistry systemRegistry)

Description copied from interface: ConsoleEngine

Sets systemRegistry

Specified by:

setSystemRegistry in interface ConsoleEngine

Parameters:

systemRegistry - SystemRegistry

setScriptExtension

public void setScriptExtension(java.lang.String extension)

Description copied from interface: ConsoleEngine

Sets file name extension used by console scripts

Specified by:

setScriptExtension in interface ConsoleEngine

Parameters:

extension - console script file extension

hasAlias

public boolean hasAlias(java.lang.String name)

Description copied from interface: ConsoleEngine

Returns true if alias 'name' exists

Specified by:

hasAlias in interface ConsoleEngine

Parameters:

name - alias name

Returns:

true if alias exists

getAlias

public java.lang.String getAlias(java.lang.String name)

Description copied from interface: ConsoleEngine

Returns alias 'name' value

Specified by:

getAlias in interface ConsoleEngine

Parameters:

name - alias name

Returns:

value of alias

getPipes

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getPipes()

Description copied from interface: ConsoleEngine

Returns defined pipes

Specified by:

getPipes in interface ConsoleEngine

Returns:

map of defined pipes

getNamedPipes

public java.util.List<java.lang.String> getNamedPipes()

Description copied from interface: ConsoleEngine

Returns named pipe names

Specified by:

getNamedPipes in interface ConsoleEngine

Returns:

list of named pipe names

scriptCompleters

public java.util.List<Completer> scriptCompleters()

Description copied from interface: ConsoleEngine

Returns script and variable completers

Specified by:

scriptCompleters in interface ConsoleEngine

Returns:

script and variable completers

commandAliasNames

private java.util.Set<java.lang.String> commandAliasNames()

scriptNames

private java.util.Set<java.lang.String> scriptNames()

scripts

public java.util.Map<java.lang.String,java.lang.Boolean> scripts()

Description copied from interface: ConsoleEngine

Returns all scripts found from PATH

Specified by:

scripts in interface ConsoleEngine

Returns:

map keys have script file names and value is true if it is console script

expandParameters

public java.lang.Object[] expandParameters(java.lang.String[] args)
                                    throws java.lang.Exception

Description copied from interface: ConsoleEngine

Substituting args references with their values.

Specified by:

expandParameters in interface ConsoleEngine

Parameters:

args - the arguments to be expanded

Returns:

expanded arguments

Throws:

java.lang.Exception - in case of error

expandToList

private java.lang.String expandToList(java.lang.String[] args)

expandToList

public java.lang.String expandToList(java.util.List<java.lang.String> params)

Description copied from interface: ConsoleEngine

Expands parameter list to string

Specified by:

expandToList in interface ConsoleEngine

Parameters:

params - list of script parameters

Returns:

expanded parameters list

expandName

private java.lang.String expandName(java.lang.String name)

isNumber

private boolean isNumber(java.lang.String str)

isCodeBlock

private boolean isCodeBlock(java.lang.String line)

isCommandLine

private boolean isCommandLine(java.lang.String line)

quote

private java.lang.String quote(java.lang.String var)

scriptExtensions

private java.util.List<java.lang.String> scriptExtensions()

execute

public java.lang.Object execute(java.io.File script,
                                java.lang.String cmdLine,
                                java.lang.String[] args)
                         throws java.lang.Exception

Description copied from interface: ConsoleEngine

Executes either JLine or ScriptEngine script.

Specified by:

execute in interface ConsoleEngine

Parameters:

script - script file

cmdLine - raw command line

args - script arguments

Returns:

script execution result

Throws:

java.lang.Exception - in case of error

expandCommandLine

public java.lang.String expandCommandLine(java.lang.String line)

Description copied from interface: ConsoleEngine

Substitutes command line with system registry invoke method call.

Specified by:

expandCommandLine in interface ConsoleEngine

Parameters:

line - command line to be expanded

Returns:

expanded command line

execute

public java.lang.Object execute(java.lang.String cmd,
                                java.lang.String line,
                                java.lang.String[] args)
                         throws java.lang.Exception

Description copied from interface: ConsoleEngine

Executes command line that does not contain known command by the system registry. If the line is neither JLine or ScriptEngine script it will be evaluated as ScriptEngine statement.

Specified by:

execute in interface ConsoleEngine

Parameters:

cmd - parsed command/script name

line - raw command line

args - parsed arguments of the command

Returns:

command line execution result

Throws:

java.lang.Exception - in case of error

purge

public void purge()

Description copied from interface: ConsoleEngine

Delete temporary console variables

Specified by:

purge in interface ConsoleEngine

putVariable

public void putVariable(java.lang.String name,
                        java.lang.Object value)

Description copied from interface: ConsoleEngine

Create console variable

Specified by:

putVariable in interface ConsoleEngine

Parameters:

name - name of the variable

value - value of the variable

getVariable

public java.lang.Object getVariable(java.lang.String name)

Description copied from interface: ConsoleEngine

Get variable value

Specified by:

getVariable in interface ConsoleEngine

Parameters:

name - name of the variable

Returns:

variable value

hasVariable

public boolean hasVariable(java.lang.String name)

Description copied from interface: ConsoleEngine

Test if variable with name exists

Specified by:

hasVariable in interface ConsoleEngine

Parameters:

name - name of the variable

Returns:

true if variable with name exists

executeWidget

public boolean executeWidget(java.lang.Object function)

Description copied from interface: ConsoleEngine

Execute widget function

Specified by:

executeWidget in interface ConsoleEngine

Parameters:

function - to execute

Returns:

true on success

consoleOptions

private java.util.Map<java.lang.String,java.lang.Object> consoleOptions()

consoleOption

public <T> T consoleOption(java.lang.String option,
                           T defval)

Description copied from interface: ConsoleEngine

Read console option value

Specified by:

consoleOption in interface ConsoleEngine

Type Parameters:

T - option type

Parameters:

option - option name

defval - default value

Returns:

option value

consoleOption

private boolean consoleOption(java.lang.String option)

postProcess

public ConsoleEngine.ExecutionResult postProcess(java.lang.String line,
                                                 java.lang.Object result,
                                                 java.lang.String output)

Description copied from interface: ConsoleEngine

Post processes execution result. If result is to be assigned to the console variable then method will return null.

Specified by:

postProcess in interface ConsoleEngine

Parameters:

line - command line

result - command result to process

output - command redirected output

Returns:

processed result

postProcess

private ConsoleEngine.ExecutionResult postProcess(java.lang.String line,
                                                  java.lang.Object result)

postProcess

public ConsoleEngine.ExecutionResult postProcess(java.lang.Object result)

Description copied from interface: ConsoleEngine

Post processes execution result.

Specified by:

postProcess in interface ConsoleEngine

Parameters:

result - command result to process

Returns:

processed result

saveResult

private int saveResult(java.lang.String var,
                       java.lang.Object result)

invoke

public java.lang.Object invoke(CommandRegistry.CommandSession session,
                               java.lang.String command,
                               java.lang.Object... args)
                        throws java.lang.Exception

Description copied from interface: CommandRegistry

Execute a command.

Specified by:

invoke in interface CommandRegistry

Overrides:

invoke in class AbstractCommandRegistry

Parameters:

session - the data of the current command session

command - the name of the command

args - arguments of the command

Returns:

result of the command execution

Throws:

java.lang.Exception - in case of error

trace

public void trace(java.lang.Object object)

Specified by:

trace in interface ConsoleEngine

Parameters:

object - object to print

error

private void error(java.lang.String message)

println

public void println(java.lang.Object object)

Description copied from interface: ConsoleEngine

Print object.

Specified by:

println in interface ConsoleEngine

Parameters:

object - object to print

show

private java.lang.Object show(CommandInput input)

del

private java.lang.Object del(CommandInput input)

prnt

private java.lang.Object prnt(CommandInput input)

slurpcmd

private java.lang.Object slurpcmd(CommandInput input)

persist

public void persist(java.nio.file.Path file,
                    java.lang.Object object)

Description copied from interface: ConsoleEngine

Persist object to file

Specified by:

persist in interface ConsoleEngine

Parameters:

file - file where object should be written

object - object to persist

slurp

public java.lang.Object slurp(java.nio.file.Path file)
                       throws java.io.IOException

Description copied from interface: ConsoleEngine

Read object from file

Specified by:

slurp in interface ConsoleEngine

Parameters:

file - file from where object should be read

Returns:

object

Throws:

java.io.IOException - in case of error

slurp

private java.lang.Object slurp(java.nio.file.Path file,
                               java.nio.charset.Charset encoding,
                               java.lang.String format)
                        throws java.io.IOException

Throws:

java.io.IOException

aliascmd

private java.lang.Object aliascmd(CommandInput input)

unalias

private java.lang.Object unalias(CommandInput input)

pipe

private java.lang.Object pipe(CommandInput input)

doc

private java.lang.Object doc(CommandInput input)

urlExists

private boolean urlExists(java.lang.String weburl)

slurpCompleter

private java.util.List<Completer> slurpCompleter(java.lang.String command)

variableCompleter

private java.util.List<Completer> variableCompleter(java.lang.String command)

variableReferences

private java.util.List<java.lang.String> variableReferences()

prntCompleter

private java.util.List<Completer> prntCompleter(java.lang.String command)

aliasCompleter

private java.util.List<Completer> aliasCompleter(java.lang.String command)

unaliasCompleter

private java.util.List<Completer> unaliasCompleter(java.lang.String command)

docs

private java.util.List<java.lang.String> docs()

docCompleter

private java.util.List<Completer> docCompleter(java.lang.String command)