org.vishia.cmd

Class JZtxtcmdExecuter.ExecuteLevel

java.lang.Object

org.vishia.cmd.JZtxtcmdExecuter.ExecuteLevel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, javax.script.ScriptContext, FilePath.FilePathEnvAccess

Enclosing class:

JZtxtcmdExecuter

public static final class JZtxtcmdExecuter.ExecuteLevel
extends java.lang.Object
implements javax.script.ScriptContext, FilePath.FilePathEnvAccess, java.io.Closeable

Wrapper to generate a script with specified localVariables. A new Wrapper is created on any subroutine level. It is used in a CalculatorExpr.calcDataAccess(Map, Object...) to generate an expression independent of an environment.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bForHasNext Used while a for-container loop runs.
boolean	bWriteErrorInOutput Flag, write error in the current output if set to true.
int	cmdErrorlevel The error level which is returned from an operation system cmd invocation.
CmdExecuter	cmdExecuter Initialize firstly on demand.
(package private) int	ctNesting Counts nesting of #execute(org.vishia.cmd.JZtxtcmdScript.StatementList, StringFormatter, int, boolean, Map, int) 1->0: leaf execution of this level, close cmdExecuter
java.io.File	currdir The current directory of this level.
private boolean	debug_dataAccessArguments
(package private) JZtxtcmdScript.JZcmdClass	jzClass
(package private) JZtxtcmdExecuter.JzTcMain	jzcmdMain
java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>>	localVariables Generated content of local variables in this nested level including the JZtxtcmdExecuter.scriptLevel().
JZtxtcmdExecuter.ExecuteLevel	parent Not used yet.
(package private) java.lang.String	sCurrdir The current directory of this level.
(package private) JZtxtcmdScript.Subroutine	subRoutine
(package private) JZtxtcmdThreadData	threadData

Fields inherited from interface javax.script.ScriptContext

ENGINE_SCOPE, GLOBAL_SCOPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExecuteLevel(JZtxtcmdExecuter.JzTcMain acc, JZtxtcmdScript.Subroutine subRoutine, JZtxtcmdScript.JZcmdClass jzClass, JZtxtcmdThreadData threadData, JZtxtcmdExecuter.ExecuteLevel parent, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> parentVariables) Constructs data for a local execution level.
protected	ExecuteLevel(JZtxtcmdExecuter.JzTcMain acc, JZtxtcmdThreadData threadData) Constructs data for the script execution level.

Method Summary

Modifier and Type	Method and Description
(package private) short	appendExpr(JZtxtcmdScript.AssignExpr statement) Executes a appendExpr::= [{ < datapath?
private short	assignObj(JZtxtcmdScript.AssignExpr statement, java.lang.Object val, boolean bEval) Executes a assignment::= [{ < datapath?
private short	assignStatement(JZtxtcmdScript.JZcmditem statement)
private void	calculateArguments(DataAccess dataAccess)
private CalculatorExpr.Value	calculateExpression(CalculatorExpr expr) This routine invokes CalculatorExpr.calcDataAccess(Map, Object...), but before the arguments of all operations will be calculated if necessary.
protected void	changeCurrDir(java.lang.CharSequence arg) Executes the cd command: changes the directory in this execution level.
void	close()
(package private) JZtxtcmdFilepath	convert2FilePath(java.lang.Object osrc) Check whether osrc is a filepath, or create one.
java.lang.String	currdir() Returns the absolute canonical path of the currdir variable. currdir is a File.
(package private) java.lang.Object	dataAccess(JZtxtcmdScript.JZcmdDataAccess dataAccess, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> dataPool, boolean accessPrivate, boolean bContainer, boolean bVariable, DataAccess.Dst dst) Accesses the data.
void	debug_dataAccessArguments()
(package private) void	debug()
(package private) int	debug(JZtxtcmdScript.JZcmditem statement)
(package private) short	defineExpr(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables, JZtxtcmdScript.DefVariable statement) Executes a DefObjVar::= < variable?
private void	endExecution()
boolean	evalCondition(JZtxtcmdScript.JZcmditem arg)
java.lang.Object	evalDatapathOrExpr(JZtxtcmdScript.Argument arg) Checks either the JZtxtcmdScript.JZcmditem.dataAccess or, if it is null, the JZtxtcmdScript.JZcmditem.expression.
java.lang.Object	evalObject(JZtxtcmdScript.JZcmditem arg, boolean bContainer) Gets the value of the given Argument.
java.lang.CharSequence	evalString(JZtxtcmdScript.JZcmditem arg)
java.lang.Object	evalSubroutine(JZtxtcmdScript.Subroutine substatement, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args, StringFormatter out, int indentOut) This routine is called only from org.vishia.zcmd.JZcmd#evalSub(....) which may be not used in praxis?.
CalculatorExpr.Value	evalValue(JZtxtcmdScript.JZcmditem arg, boolean bContainer) Gets the value of the given Argument.
java.lang.CharSequence	excStacktraceinfo() Returns a one-line-information about the last Exception with Stacktrace information (max 20 levels).
protected short	exec_addClassLoader(JZtxtcmdScript.DefClasspathVariable statement, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables)
private short	exec_Call(JZtxtcmdScript.CallStatement callStatement, java.util.List<DataAccess.Variable<java.lang.Object>> additionalArgs, StringFormatter out, int indentOut, int nDebug)
(package private) short	exec_ChangeCurrDir(JZtxtcmdScript.JZcmditem statement)
(package private) short	exec_CmdError(JZtxtcmdScript.Onerror statement, StringFormatter out, int indentOut)
private void	exec_cmdline(JZtxtcmdScript.CmdInvoke statement) Executes 'start cmdline', 'cmd cmdline' or 'shell cmdline' TODO shell It starts a process in Java and executes then the given command.
(package private) void	exec_Copy(JZtxtcmdScript.FileOpArg statement)
(package private) short	exec_createFilepath(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables, JZtxtcmdScript.DefVariable statement)
(package private) short	exec_createFileSet(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables, JZtxtcmdScript.UserFileset statement)
private short	exec_Datatext(JZtxtcmdScript.DataText statement, StringFormatter out, int indentOut, int nDebug) Inserts <&a_Datapath> in the out.
(package private) short	exec_DebugOp(JZtxtcmdScript.JZcmditem statement)
protected short	exec_DefClassVariable(JZtxtcmdScript.DefClassVariable statement, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables)
(package private) void	exec_DefCodeblockVariable(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables, JZtxtcmdScript.Subroutine statement, boolean isConst) It defines a variable type 'X' and stores the given subroutine reference to execute that statements on evaluating the variable
protected short	exec_DefList(JZtxtcmdScript.DefContainerVariable statement, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables)
protected short	exec_DefMapVariable(JZtxtcmdScript.DefVariable statement, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables)
(package private) void	exec_DefVariable(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables, JZtxtcmdScript.DefVariable statement, char type, java.lang.Object valueArg, boolean isConst)
(package private) void	exec_Delete(JZtxtcmdScript.FileOpArg statement)
(package private) short	exec_dowhileStatement(JZtxtcmdScript.CondStatement whileStatement, StringFormatter out, int indentOut, int nDebug) Executes a dowhile statement.
private short	exec_forContainer(JZtxtcmdScript.ForStatement statement, StringFormatter out, int indentOut, int nDebug)
(package private) short	exec_hasNext(JZtxtcmdScript.JZcmditem statement, StringFormatter out, int indentOut, int nDebug) Executes the statements or output the text if in textArg if a for-container has a next element.
(package private) short	exec_IfStatement(JZtxtcmdScript.IfStatement ifStatement, StringFormatter out, int indentOut, int nDebug) it contains maybe more as one if block and else.
(package private) short	exec_MkDir(JZtxtcmdScript.JZcmditem statement)
(package private) void	exec_Move(JZtxtcmdScript.FileOpArg statement)
private short	exec_NestedLevel(JZtxtcmdScript.JZcmditem script, StringFormatter out, int indentOut, int nDebug) Executes an internal statement block.
(package private) short	exec_Openfile(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables, JZtxtcmdScript.DefVariable statement) Creates a new FileWriter with the given name #evalString(org.vishia.cmd.JZtxtcmdScript.Argument) of the statement.
(package private) StringFormatter	exec_OpenTextOut(JZtxtcmdScript.JZcmditem statement, StringFormatter outTextprev, boolean bAppend) Closes an existing text out and opens a new one with the given name in the current directory.
(package private) void	exec_SetColumn(JZtxtcmdScript.TextColumn statement, StringFormatter out)
private short	exec_Subroutine(JZtxtcmdScript.Subroutine statement, JZtxtcmdExecuter.ExecuteLevel sublevel, java.util.List<JZtxtcmdScript.Argument> actualArgs, java.util.List<DataAccess.Variable<java.lang.Object>> additionalArgs, StringFormatter out, int indentOut, int nDebug) Core routine to execute a sub routine.
short	exec_Subroutine(JZtxtcmdScript.Subroutine subroutine, java.util.List<DataAccess.Variable<java.lang.Object>> args, StringFormatter out, int indentOut) Executes a subroutine invoked from user space, with given JZtxtcmdExecuter.ExecuteLevel as this.
short	exec_Subroutine(JZtxtcmdScript.Subroutine subroutine, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args, StringFormatter out, int indentOut) Executes a subroutine invoked from user space, with given JZtxtcmdExecuter.ExecuteLevel as this.
(package private) void	exec_Text(JZtxtcmdScript.JZcmditem statement, java.lang.Appendable out, int indentOut) Outputs the given constant text
(package private) short	exec_TextAppendToOut(JZtxtcmdScript.JZcmditem statement, StringFormatter out, int nDebug) Invocation for <:>text<.+>.
(package private) short	exec_TextAppendToVar(JZtxtcmdScript.TextOut statement, int nDebug) Invocation for <+name>text<.+>.
private short	exec_Thread(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables, JZtxtcmdScript.ThreadBlock statement) executes statements in another thread.
(package private) void	exec_Throw(JZtxtcmdScript.JZcmditem statement)
(package private) void	exec_Throwonerror(JZtxtcmdScript.Onerror statement) Throws an JZtxtcmdExecuter.CmdErrorLevelException if the errorlevel is >= statement.errorLevel.
(package private) short	exec_whileStatement(JZtxtcmdScript.CondStatement whileStatement, StringFormatter out, int indentOut, int nDebug) Executes a while statement.
private short	exec_zmake(JZtxtcmdScript.Zmake statement, StringFormatter out, int indentOut, int nDebug) Executes a Zmake subroutine call.
(package private) short	execute(JZtxtcmdScript.StatementList statementList, StringFormatter outText, int indentOutArg, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables, int nDebugP) Processes the statement of the current node in the JZcmditem.
short	executeNewlevel(JZtxtcmdScript.StatementList contentScript, StringFormatter out, int indentOut, int nDebug) Executes an inner script part maybe with a new level of nested local variables.
JZtxtcmdExecuter.JzTcMain	executer()
protected void	finishThread(JZtxtcmdThreadData thread)
java.lang.Object	getAttribute(java.lang.String name)
java.lang.Object	getAttribute(java.lang.String name, int scope)
int	getAttributesScope(java.lang.String name)
javax.script.Bindings	getBindings(int scope)
java.lang.CharSequence	getCurrentDir() Returns the current directory of the context necessary to build an absolute path in FilePath.
java.io.Writer	getErrorWriter()
java.io.Reader	getReader()
java.util.List<java.lang.Integer>	getScopes()
java.lang.Object	getValue(java.lang.String variable) Returns the Object which is addressed by the name.
java.io.Writer	getWriter()
JZtxtcmdExecuter.ExecuteLevel	levelForSubroutine(JZtxtcmdScript.Subroutine subroutine) Creates a new level for the subroutine with this given level.
LogMessage	log() Returns the log interface from the environment class.
java.lang.Object	removeAttribute(java.lang.String name, int scope)
protected void	runThread(JZtxtcmdExecuter.ExecuteLevel executeLevel, JZtxtcmdScript.ThreadBlock statement, JZtxtcmdThreadData threadVar)
JZtxtcmdEngine	scriptEngine()
void	setAttribute(java.lang.String name, java.lang.Object value, int scope)
void	setBindings(javax.script.Bindings bindings, int scope)
void	setCmdExecuter(CmdExecuter executer) Use the given CmdExecuter especially for a JZtxtcmdExecuter#execSub(org.vishia.cmd.JZtxtcmdScript.Subroutine, List, boolean, Appendable, File) after levelForSubroutine(org.vishia.cmd.JZtxtcmdScript.Subroutine).
void	setErrorWriter(java.io.Writer writer)
void	setLocalVariable(java.lang.String name, char type, java.lang.Object content, boolean isConst)
void	setReader(java.io.Reader reader)
void	setWriter(java.io.Writer writer)
(package private) void	storeValue(DataAccess dataAccess, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> dataPool, java.lang.Object value, boolean accessPrivate)
(package private) void	throwIllegalDstArgument(java.lang.CharSequence text, DataAccess dst, JZtxtcmdScript.JZcmditem statement)

Methods inherited from class java.lang.Object

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

Field Detail

jzcmdMain

final JZtxtcmdExecuter.JzTcMain jzcmdMain

parent

public final JZtxtcmdExecuter.ExecuteLevel parent

Not used yet. Only for debug!

ctNesting

int ctNesting

Counts nesting of #execute(org.vishia.cmd.JZtxtcmdScript.StatementList, StringFormatter, int, boolean, Map, int) 1->0: leaf execution of this level, close cmdExecuter

threadData

final JZtxtcmdThreadData threadData

jzClass

final JZtxtcmdScript.JZcmdClass jzClass

subRoutine

final JZtxtcmdScript.Subroutine subRoutine

currdir

public java.io.File currdir

The current directory of this level. It is an absolute normalized but not Unix-canonical path. Note that a Unix-canonical path have to resolved symbolic links.

sCurrdir

java.lang.String sCurrdir

The current directory of this level. It is an absolute normalized but not Unix-canonical path. Note that a Unix-canonical path have to resolved symbolic links.

bWriteErrorInOutput

public boolean bWriteErrorInOutput

Flag, write error in the current output if set to true.

localVariables

public final java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> localVariables

Generated content of local variables in this nested level including the JZtxtcmdExecuter.scriptLevel().localVariables. The variables are type invariant on language level. The type is checked and therefore errors are detected on runtime only.

cmdExecuter

public CmdExecuter cmdExecuter

Initialize firstly on demand. Don't close to speed up following cmd invocations. It is necessary to have one executer per level because different environment variables.

bForHasNext

private boolean bForHasNext

Used while a for-container loop runs.

debug_dataAccessArguments

private boolean debug_dataAccessArguments

cmdErrorlevel

public int cmdErrorlevel

The error level which is returned from an operation system cmd invocation. It is used for the #execCmdError(org.vishia.cmd.JZtxtcmdScript.Onerror).

Constructor Detail

ExecuteLevel

protected ExecuteLevel(JZtxtcmdExecuter.JzTcMain acc,
                       JZtxtcmdScript.Subroutine subRoutine,
                       JZtxtcmdScript.JZcmdClass jzClass,
                       JZtxtcmdThreadData threadData,
                       JZtxtcmdExecuter.ExecuteLevel parent,
                       java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> parentVariables)

Constructs data for a local execution level.

Parameters:

parentVariables - if given this variable are copied to the local ones. They contains the script variables too. If not given (null), only the script variables are copied into the localVariables. Note that subroutines do not know the local variables of its calling routine! This argument is only set if nested statement blocks are to execute.

ExecuteLevel

protected ExecuteLevel(JZtxtcmdExecuter.JzTcMain acc,
                       JZtxtcmdThreadData threadData)

Constructs data for the script execution level.

Method Detail

setCmdExecuter

public void setCmdExecuter(CmdExecuter executer)

Use the given CmdExecuter especially for a JZtxtcmdExecuter#execSub(org.vishia.cmd.JZtxtcmdScript.Subroutine, List, boolean, Appendable, File) after levelForSubroutine(org.vishia.cmd.JZtxtcmdScript.Subroutine).

Parameters:

executer - may be opened, should not be in process, will be used then.

executer

public JZtxtcmdExecuter.JzTcMain executer()

scriptEngine

public JZtxtcmdEngine scriptEngine()

log

public LogMessage log()

Returns the log interface from the environment class.

setLocalVariable

public void setLocalVariable(java.lang.String name,
                             char type,
                             java.lang.Object content,
                             boolean isConst)
                      throws java.lang.IllegalAccessException

Throws:

java.lang.IllegalAccessException

executeNewlevel

public short executeNewlevel(JZtxtcmdScript.StatementList contentScript,
                             StringFormatter out,
                             int indentOut,
                             int nDebug)
                      throws java.lang.Exception

Executes an inner script part maybe with a new level of nested local variables. If the contentScript does not contain any variable definition (see @link JZtxtcmdScript.StatementList.bContainsVariableDef) then this level is used, it prevents a non necessary instantiation of an JZtxtcmdExecuter.ExecuteLevel and copying of local variables. If new variables are to build in the statements, a new instance of JZtxtcmdExecuter.ExecuteLevel is created and all variables of this.localVariables are copied to it. It means the nested level knows the same variables but it can add new variables without effect to this level. Changing of existing variables effects all outer levels. That is necessary, an outer-defined variable can be changed in an inner level. That is guaranteed because only the reference is changed.

Parameters:

contentScript - of the inner level.

out - The main output

bContainerHasNext - only used for for-statement

Returns:

an error hint.

Throws:

java.io.IOException

java.lang.Exception

execute

short execute(JZtxtcmdScript.StatementList statementList,
              StringFormatter outText,
              int indentOutArg,
              java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables,
              int nDebugP)

Processes the statement of the current node in the JZcmditem.

Parameters:

statementList -

outText - The current output. Either it is a special output channel for <+channel>...<.+> or it is the threadData.out or it is null if threadData.out is not initialized yet.

indentOutArg - The indentation in the script.

bContainerHasNext - Especially for <:for:element:container>SCRIPT<.for> to implement <:hasNext>

newVariables - Destination instance for newly created variables. It is localVariables usual but in special cases new variables are stored in an own Map, especially on { }.

nDebugP -

Returns:

JZtxtcmdExecuter.kSuccess ==0, JZtxtcmdExecuter.kBreak, JZtxtcmdExecuter.kReturn or JZtxtcmdExecuter.kException

Throws:

java.lang.Exception

endExecution

private void endExecution()

exec_Text

void exec_Text(JZtxtcmdScript.JZcmditem statement,
               java.lang.Appendable out,
               int indentOut)
        throws java.io.IOException

Outputs the given constant text

Parameters:

statement - contains the text

out - out channel to append

indentOut - Number of characters in a new line which are skipped from begin. Indentation in the script, no indentation in outputted text

Throws:

java.io.IOException

exec_SetColumn

void exec_SetColumn(JZtxtcmdScript.TextColumn statement,
                    StringFormatter out)
             throws java.lang.Exception

Throws:

java.lang.Exception

exec_DefVariable

void exec_DefVariable(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables,
                      JZtxtcmdScript.DefVariable statement,
                      char type,
                      java.lang.Object valueArg,
                      boolean isConst)
               throws java.lang.Exception

Parameters:

newVariables -

statement - JZtxtcmdScript.DefVariable.defVariable contains the type.

type - unused, see statement

value -

isConst -

Throws:

java.lang.Exception

exec_DefCodeblockVariable

void exec_DefCodeblockVariable(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables,
                               JZtxtcmdScript.Subroutine statement,
                               boolean isConst)
                        throws java.lang.Exception

It defines a variable type 'X' and stores the given subroutine reference to execute that statements on evaluating the variable

Parameters:

newVariables -

statement - Subroutine reference

type - not used, type is 'C'

value -

isConst -

Throws:

java.lang.Exception

exec_DefList

protected short exec_DefList(JZtxtcmdScript.DefContainerVariable statement,
                             java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables)
                      throws java.lang.Exception

Throws:

java.lang.Exception

exec_DefMapVariable

protected short exec_DefMapVariable(JZtxtcmdScript.DefVariable statement,
                                    java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables)
                             throws java.lang.Exception

Throws:

java.lang.Exception

exec_DefClassVariable

protected short exec_DefClassVariable(JZtxtcmdScript.DefClassVariable statement,
                                      java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables)
                               throws java.lang.Exception

Throws:

java.lang.Exception

exec_addClassLoader

protected short exec_addClassLoader(JZtxtcmdScript.DefClasspathVariable statement,
                                    java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables)
                             throws java.lang.Exception

Throws:

java.lang.Exception

exec_createFilepath

short exec_createFilepath(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables,
                          JZtxtcmdScript.DefVariable statement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

exec_createFileSet

short exec_createFileSet(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables,
                         JZtxtcmdScript.UserFileset statement)
                  throws java.lang.Exception

Throws:

java.lang.Exception

exec_forContainer

private short exec_forContainer(JZtxtcmdScript.ForStatement statement,
                                StringFormatter out,
                                int indentOut,
                                int nDebug)
                         throws java.lang.Exception

Throws:

java.lang.Exception

exec_hasNext

short exec_hasNext(JZtxtcmdScript.JZcmditem statement,
                   StringFormatter out,
                   int indentOut,
                   int nDebug)
            throws java.lang.Exception

Executes the statements or output the text if in textArg if a for-container has a next element.

Parameters:

statement - the hasnext-Statement.

out -

indentOut -

nDebug -

Returns:

Throws:

java.lang.Exception

exec_IfStatement

short exec_IfStatement(JZtxtcmdScript.IfStatement ifStatement,
                       StringFormatter out,
                       int indentOut,
                       int nDebug)
                throws java.lang.Exception

it contains maybe more as one if block and else.

Returns:

JZtxtcmdExecuter.kBreak if a break statement was found.

Throws:

java.lang.Exception

exec_whileStatement

short exec_whileStatement(JZtxtcmdScript.CondStatement whileStatement,
                          StringFormatter out,
                          int indentOut,
                          int nDebug)
                   throws java.lang.Exception

Executes a while statement.

Throws:

java.lang.Exception

exec_dowhileStatement

short exec_dowhileStatement(JZtxtcmdScript.CondStatement whileStatement,
                            StringFormatter out,
                            int indentOut,
                            int nDebug)
                     throws java.lang.Exception

Executes a dowhile statement.

Throws:

java.lang.Exception

exec_TextAppendToOut

short exec_TextAppendToOut(JZtxtcmdScript.JZcmditem statement,
                           StringFormatter out,
                           int nDebug)
                    throws java.lang.Exception

Invocation for <:>text<.+>. It gets the Appendable from the assign variable and executes execute(JZtxtcmdScript.StatementList, StringFormatter, int, Map, int) with it. The arg 'indentOutArg' is set from the JZtxtcmdScript.JZcmditem.srcColumn of the statement.

Parameters:

statement - the statement

Throws:

java.lang.Exception

exec_TextAppendToVar

short exec_TextAppendToVar(JZtxtcmdScript.TextOut statement,
                           int nDebug)
                    throws java.lang.Exception

Invocation for <+name>text<.+>. It gets the Appendable from the assign variable and executes execute(JZtxtcmdScript.StatementList, StringFormatter, int, Map, int) with it. The arg 'indentOutArg' is set from the JZtxtcmdScript.JZcmditem.srcColumn of the statement.

Parameters:

statement - the statement

Throws:

java.lang.Exception

exec_Call

private short exec_Call(JZtxtcmdScript.CallStatement callStatement,
                        java.util.List<DataAccess.Variable<java.lang.Object>> additionalArgs,
                        StringFormatter out,
                        int indentOut,
                        int nDebug)
                 throws java.lang.IllegalArgumentException,
                        java.lang.Exception

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

evalSubroutine

public java.lang.Object evalSubroutine(JZtxtcmdScript.Subroutine substatement,
                                       java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args,
                                       StringFormatter out,
                                       int indentOut)
                                throws javax.script.ScriptException

This routine is called only from org.vishia.zcmd.JZcmd#evalSub(....) which may be not used in praxis?.

Parameters:

substatement -

args -

out -

indentOut -

Returns:

Throws:

javax.script.ScriptException

exec_Subroutine

public short exec_Subroutine(JZtxtcmdScript.Subroutine subroutine,
                             java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args,
                             StringFormatter out,
                             int indentOut)

Executes a subroutine invoked from user space, with given JZtxtcmdExecuter.ExecuteLevel as this. This routine should be used if args are given as Map of Variable. Internally the #exec_Subroutine(Subroutine, List, StringFormatter, int) is called.

Parameters:

substatement - Statement of the subroutine

args - Any given arguments in form of a map. It is proper to build a Map with JZcmd script features better than a list. The execution needs a List of Variables, the Variables of the map are copied to a temporary List instance.

out - output

indentOut -

Returns:

null on success, an error message on parameter error

Throws:

java.lang.Exception

exec_Subroutine

public short exec_Subroutine(JZtxtcmdScript.Subroutine subroutine,
                             java.util.List<DataAccess.Variable<java.lang.Object>> args,
                             StringFormatter out,
                             int indentOut)

Executes a subroutine invoked from user space, with given JZtxtcmdExecuter.ExecuteLevel as this. This routine should be used if args are given as List of Variable. The routine creates an own level to execute the sub routine unless the subroutine is marked with JZtxtcmdScript.Subroutine.useLocals. It calls levelForSubroutine(org.vishia.cmd.JZtxtcmdScript.Subroutine) therefore. Internally the private #exec_Subroutine(org.vishia.cmd.JZtxtcmdScript.Subroutine, ExecuteLevel, List, List, StringFormatter, int, int) is called.

Parameters:

substatement - Statement of the subroutine

args - Any given arguments in form of a List. It is proper for user calling.

out - output

indentOut -

Returns:

null on success, an error message on parameter error

Throws:

java.lang.Exception

Since:

2023-08, before only the #exec_Subroutine(Subroutine, Map, StringFormatter, int) was existing and contains this content.

levelForSubroutine

public final JZtxtcmdExecuter.ExecuteLevel levelForSubroutine(JZtxtcmdScript.Subroutine subroutine)

Creates a new level for the subroutine with this given level. If the subroutine designates JZtxtcmdScript.Subroutine.useLocals then a new level is not created, instead this is returned.

Parameters:

subroutine -

Returns:

exec_Subroutine

private short exec_Subroutine(JZtxtcmdScript.Subroutine statement,
                              JZtxtcmdExecuter.ExecuteLevel sublevel,
                              java.util.List<JZtxtcmdScript.Argument> actualArgs,
                              java.util.List<DataAccess.Variable<java.lang.Object>> additionalArgs,
                              StringFormatter out,
                              int indentOut,
                              int nDebug)
                       throws java.lang.Exception

Core routine to execute a sub routine.

Parameters:

statement -

sublevel -

actualArgs -

additionalArgs -

out -

indentOut -

nDebug -

Returns:

Throws:

java.lang.Exception

exec_zmake

private short exec_zmake(JZtxtcmdScript.Zmake statement,
                         StringFormatter out,
                         int indentOut,
                         int nDebug)
                  throws java.lang.IllegalArgumentException,
                         java.lang.Exception

Executes a Zmake subroutine call. Additional to exec_Call(org.vishia.cmd.JZtxtcmdScript.CallStatement, List, StringFormatter, int, int) a ZmakeTarget will be prepared and stored as 'target' in the localVariables of the sublevel.

Parameters:

statement -

out -

indentOut -

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

exec_Thread

private short exec_Thread(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables,
                          JZtxtcmdScript.ThreadBlock statement)
                   throws java.lang.Exception

executes statements in another thread.

Throws:

java.lang.Exception

exec_NestedLevel

private short exec_NestedLevel(JZtxtcmdScript.JZcmditem script,
                               StringFormatter out,
                               int indentOut,
                               int nDebug)
                        throws java.lang.Exception

Executes an internal statement block. If the Statementlist has local variables, a new instance of this is created. Elsewhere the same instance is used.

Parameters:

script -

out -

Returns:

continue information for the calling level, see return of #execute(org.vishia.cmd.JZtxtcmdScript.StatementList, Appendable, int, boolean) A JZtxtcmdExecuter.kBreak inside the statementlist is not returned. The break is only valid inside the block. All other return values of execute are returned.

Throws:

java.io.IOException

java.lang.Exception

exec_cmdline

private void exec_cmdline(JZtxtcmdScript.CmdInvoke statement)
                   throws java.lang.IllegalArgumentException,
                          java.lang.Exception

Executes 'start cmdline', 'cmd cmdline' or 'shell cmdline' TODO shell It starts a process in Java and executes then the given command.

Parameters:

statement -

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

exec_CmdError

short exec_CmdError(JZtxtcmdScript.Onerror statement,
                    StringFormatter out,
                    int indentOut)
             throws java.lang.Exception

Throws:

java.lang.Exception

exec_DebugOp

short exec_DebugOp(JZtxtcmdScript.JZcmditem statement)
            throws java.lang.Exception

Throws:

java.lang.Exception

exec_ChangeCurrDir

short exec_ChangeCurrDir(JZtxtcmdScript.JZcmditem statement)
                  throws java.lang.Exception

Throws:

java.lang.Exception

exec_MkDir

short exec_MkDir(JZtxtcmdScript.JZcmditem statement)
          throws java.lang.Exception

Throws:

java.lang.Exception

exec_OpenTextOut

StringFormatter exec_OpenTextOut(JZtxtcmdScript.JZcmditem statement,
                                 StringFormatter outTextprev,
                                 boolean bAppend)
                          throws java.lang.Exception

Closes an existing text out and opens a new one with the given name in the current directory. It is suppressed in initializing phase if another JZtxtcmdExecuter.JzTcMain.outFromCmdlineArg is given than System.out. Elsewhere it closes the given output and opens the new one if possible.

Parameters:

statement - builds a path

outTextprev - previously used textOut, it is returned if it is not changed. Because it is used locally in the script execution.

bAppend - for <+:append>path/to...

Returns:

null on exception of evalString(org.vishia.cmd.JZtxtcmdScript.JZcmditem) of the statement. elsewhere the new outText or the given outTextprev

Throws:

java.lang.Exception

Since:

2018-09 returns the new outText to use immediately

changeCurrDir

protected void changeCurrDir(java.lang.CharSequence arg)
                      throws java.lang.IllegalAccessException,
                             java.io.FileNotFoundException

Executes the cd command: changes the directory in this execution level.

Parameters:

arg - maybe a relative path. If it is a StringBuilder, it will be changed on normalizePath.

Throws:

java.lang.IllegalAccessException

java.io.FileNotFoundException

exec_Datatext

private short exec_Datatext(JZtxtcmdScript.DataText statement,
                            StringFormatter out,
                            int indentOut,
                            int nDebug)
                     throws java.lang.IllegalArgumentException,
                            java.lang.Exception

Inserts <&a_Datapath> in the out.

Parameters:

statement - The statement which contains the access path etc.

out -

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

exec_Move

void exec_Move(JZtxtcmdScript.FileOpArg statement)
        throws java.lang.IllegalArgumentException,
               java.lang.Exception

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

exec_Copy

void exec_Copy(JZtxtcmdScript.FileOpArg statement)
        throws java.lang.Exception

Throws:

java.lang.Exception

exec_Delete

void exec_Delete(JZtxtcmdScript.FileOpArg statement)
          throws java.lang.Exception

Throws:

java.lang.Exception

exec_Openfile

short exec_Openfile(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables,
                    JZtxtcmdScript.DefVariable statement)
             throws java.lang.IllegalArgumentException,
                    java.lang.Exception

Creates a new FileWriter with the given name #evalString(org.vishia.cmd.JZtxtcmdScript.Argument) of the statement. If the file name is local, the actual value of $CD is set as pre-path. The current directory of the file system is not proper to use because the current directory of this execution level should be taken therefore. If the path is faulty or another exception is thrown, the exception is forwarded to the execution level (onerror-statement).

Parameters:

statement -

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

assignStatement

private short assignStatement(JZtxtcmdScript.JZcmditem statement)
                       throws java.lang.IllegalArgumentException,
                              java.lang.Exception

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

assignObj

private short assignObj(JZtxtcmdScript.AssignExpr statement,
                        java.lang.Object val,
                        boolean bEval)
                 throws java.lang.IllegalArgumentException,
                        java.lang.Exception

Executes a assignment::= [{ < datapath?assign > = }] < expression > ;.. If the datapath to assign is only a localVariable (one simple name), then the expression is assigned to this local variable, a new variable will be created. If the datapath to assign is more complex, the object which is described with it will be gotten. Then an assignment will be done depending on its type:

• Appendable: appends the gotten expression.toString(). An Appendable may be especially
• All others cause an error.

Parameters:

statement -

val - value to assign. If not null then bEval should be false.

bEval - if true then the value will be evaluate from the statement.

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

defineExpr

short defineExpr(java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> newVariables,
                 JZtxtcmdScript.DefVariable statement)
          throws java.lang.IllegalArgumentException,
                 java.lang.Exception

Executes a DefObjVar::= < variable?defVariable> [ = < objExpr?>]. If the datapath to assign is only a localVariable (one simple name), then the expression is assigned to this local variable, a new variable will be created. If the datapath to assign is more complex, the object which is described with it will be gotten. Then an assignment will be done depending on its type:

• Appendable: appends the gotten expression.toString(). An Appendable may be especially
• All others cause an error.

Parameters:

statement -

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

appendExpr

short appendExpr(JZtxtcmdScript.AssignExpr statement)
          throws java.lang.IllegalArgumentException,
                 java.lang.Exception

Executes a appendExpr::= [{ < datapath?assign > += }] < expression > ;..

Parameters:

statement -

Throws:

java.lang.IllegalArgumentException

java.lang.Exception

exec_Throw

void exec_Throw(JZtxtcmdScript.JZcmditem statement)
         throws java.lang.Exception

Throws:

java.lang.Exception

exec_Throwonerror

void exec_Throwonerror(JZtxtcmdScript.Onerror statement)
                throws JZtxtcmdExecuter.CmdErrorLevelException

Throws an JZtxtcmdExecuter.CmdErrorLevelException if the errorlevel is >= statement.errorLevel.

Parameters:

statement -

Throws:

JZtxtcmdExecuter.CmdErrorLevelException

evalDatapathOrExpr

public java.lang.Object evalDatapathOrExpr(JZtxtcmdScript.Argument arg)
                                    throws java.lang.Exception

Checks either the JZtxtcmdScript.JZcmditem.dataAccess or, if it is null, the JZtxtcmdScript.JZcmditem.expression. Returns either the Object which is gotten by the DataAccess#access(Map, boolean, boolean) or which is calculated by the expression. Returns an instance of CalculatorExpr.Value if it is a result by an expression.

Parameters:

arg -

Returns:

Throws:

java.lang.Exception

evalString

public java.lang.CharSequence evalString(JZtxtcmdScript.JZcmditem arg)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

dataAccess

java.lang.Object dataAccess(JZtxtcmdScript.JZcmdDataAccess dataAccess,
                            java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> dataPool,
                            boolean accessPrivate,
                            boolean bContainer,
                            boolean bVariable,
                            DataAccess.Dst dst)
                     throws java.lang.Exception

Accesses the data. Before execution all arguments of methods inside the #datapath() are calculated with the capability of JZcmd.

Parameters:

dataPool -

accessPrivate -

bContainer -

bVariable -

dst -

Returns:

Throws:

java.lang.Exception

storeValue

void storeValue(DataAccess dataAccess,
                java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> dataPool,
                java.lang.Object value,
                boolean accessPrivate)
         throws java.lang.Exception

Throws:

java.lang.Exception

calculateExpression

private CalculatorExpr.Value calculateExpression(CalculatorExpr expr)
                                          throws java.lang.Exception

This routine invokes CalculatorExpr.calcDataAccess(Map, Object...), but before the arguments of all operations will be calculated if necessary. All operations are gotten with CalculatorExpr.listOperations(). with that dataPath calculateArguments(DataAccess) is called. with

Parameters:

expr -

Returns:

Throws:

java.lang.Exception

calculateArguments

private void calculateArguments(DataAccess dataAccess)
                         throws java.lang.Exception

Throws:

java.lang.Exception

evalObject

public java.lang.Object evalObject(JZtxtcmdScript.JZcmditem arg,
                                   boolean bContainer)
                            throws java.lang.Exception

Gets the value of the given Argument. Either it is a

• String from JZtxtcmdScript.JZcmditem.textArg
• Object from JZtxtcmdScript.JZcmditem.dataAccess
• String from JZtxtcmdScript.JZcmditem.statementlist if not 'M'
• Map from statementlist if the arg.JZtxtcmdScript.JZcmditem.elementType == 'M'. it is d 'dataStruct'.
• Object from JZtxtcmdScript.JZcmditem.expression.
• If the arg is instanceof JZtxtcmdScript.Argument - an argument of a call subroutine, then
  • If the JZtxtcmdScript.Argument#filepath is set, then that FilePath is transfered to a JZtxtcmdFilepath and returned. A JZtxtcmdFilepath contains the reference to this execution level.
  • If the JZtxtcmdScript.Argument#accessFileset is set, then that JZtxtcmdScript.AccessFilesetname is transfered to an instance of JZtxtcmdAccessFileset and that instance is returned.

Parameters:

arg -

Returns:

Object adequate the arg, maybe null

Throws:

java.lang.Exception - any Exception while evaluating.

evalValue

public CalculatorExpr.Value evalValue(JZtxtcmdScript.JZcmditem arg,
                                      boolean bContainer)
                               throws java.lang.Exception

Gets the value of the given Argument. It is a JZtxtcmdScript.JZcmditem.expression

Parameters:

arg -

Returns:

Throws:

java.lang.Exception

evalCondition

public boolean evalCondition(JZtxtcmdScript.JZcmditem arg)
                      throws java.lang.Exception

Throws:

java.lang.Exception

convert2FilePath

JZtxtcmdFilepath convert2FilePath(java.lang.Object osrc)

Check whether osrc is a filepath, or create one.

Parameters:

osrc -

Returns:

runThread

protected void runThread(JZtxtcmdExecuter.ExecuteLevel executeLevel,
                         JZtxtcmdScript.ThreadBlock statement,
                         JZtxtcmdThreadData threadVar)

finishThread

protected void finishThread(JZtxtcmdThreadData thread)

currdir

public java.lang.String currdir()

Returns the absolute canonical path of the currdir variable. currdir is a File. The file separator is '/'.

debug

int debug(JZtxtcmdScript.JZcmditem statement)

debug_dataAccessArguments

public void debug_dataAccessArguments()

debug

void debug()

excStacktraceinfo

public java.lang.CharSequence excStacktraceinfo()

Returns a one-line-information about the last Exception with Stacktrace information (max 20 levels).

throwIllegalDstArgument

void throwIllegalDstArgument(java.lang.CharSequence text,
                             DataAccess dst,
                             JZtxtcmdScript.JZcmditem statement)
                      throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getAttribute

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

Specified by:

getAttribute in interface javax.script.ScriptContext

getAttribute

public java.lang.Object getAttribute(java.lang.String name,
                                     int scope)

Specified by:

getAttribute in interface javax.script.ScriptContext

getAttributesScope

public int getAttributesScope(java.lang.String name)

Specified by:

getAttributesScope in interface javax.script.ScriptContext

getBindings

public javax.script.Bindings getBindings(int scope)

Specified by:

getBindings in interface javax.script.ScriptContext

getErrorWriter

public java.io.Writer getErrorWriter()

Specified by:

getErrorWriter in interface javax.script.ScriptContext

getReader

public java.io.Reader getReader()

Specified by:

getReader in interface javax.script.ScriptContext

getScopes

public java.util.List<java.lang.Integer> getScopes()

Specified by:

getScopes in interface javax.script.ScriptContext

getWriter

public java.io.Writer getWriter()

Specified by:

getWriter in interface javax.script.ScriptContext

removeAttribute

public java.lang.Object removeAttribute(java.lang.String name,
                                        int scope)

Specified by:

removeAttribute in interface javax.script.ScriptContext

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value,
                         int scope)

Specified by:

setAttribute in interface javax.script.ScriptContext

setBindings

public void setBindings(javax.script.Bindings bindings,
                        int scope)

Specified by:

setBindings in interface javax.script.ScriptContext

setErrorWriter

public void setErrorWriter(java.io.Writer writer)

Specified by:

setErrorWriter in interface javax.script.ScriptContext

setReader

public void setReader(java.io.Reader reader)

Specified by:

setReader in interface javax.script.ScriptContext

setWriter

public void setWriter(java.io.Writer writer)

Specified by:

setWriter in interface javax.script.ScriptContext

getCurrentDir

public java.lang.CharSequence getCurrentDir()

Description copied from interface: FilePath.FilePathEnvAccess

Returns the current directory of the context necessary to build an absolute path in FilePath.

Specified by:

getCurrentDir in interface FilePath.FilePathEnvAccess

getValue

public java.lang.Object getValue(java.lang.String variable)
                          throws java.lang.NoSuchFieldException

Description copied from interface: FilePath.FilePathEnvAccess

Returns the Object which is addressed by the name. It may be a script variable, able to find in one or more container sorted by name.

Specified by:

getValue in interface FilePath.FilePathEnvAccess

Parameters:

variable - The name

Returns:

either an instance of FilePath or a CharSequence or null if the variable is not found (optional, instead Exception).

Throws:

java.lang.NoSuchFieldException - if the variable is not found (optional, recommended).

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable