org.vishia.cmd

Class JZtxtcmdScript.JZcmditem

java.lang.Object

org.vishia.cmd.JZtxtcmdScript.JZcmditem

All Implemented Interfaces:

SetLineColumn_ifc

Direct Known Subclasses:

JZtxtcmdScript.AccessFilesetname, JZtxtcmdScript.Argument, JZtxtcmdScript.AssignExpr, JZtxtcmdScript.CondStatement, JZtxtcmdScript.DataText, JZtxtcmdScript.DefVariable, JZtxtcmdScript.ExitStatement, JZtxtcmdScript.FileOpArg, JZtxtcmdScript.IfStatement, JZtxtcmdScript.JZcmdInclude, JZtxtcmdScript.Onerror, JZtxtcmdScript.Subroutine, JZtxtcmdScript.TextColumn, JZtxtcmdScript.TextOut, JZtxtcmdScript.ThreadBlock

Enclosing class:

JZtxtcmdScript

public static class JZtxtcmdScript.JZcmditem
extends java.lang.Object
implements SetLineColumn_ifc

Common Superclass for a JZcmd script item. A script item is either a statement maybe with sub statements, or an expression, or an access to data or a constant text. Therefore only one of the associations statementlist, dataAccess, expression or textArg is set.

Field Summary

Fields

Modifier and Type	Field and Description
protected char	conversion Designation of a conversion from given value to a destination instance.
JZtxtcmdScript.JZcmdDataAccess	dataAccess Any access to an Object, maybe content of a variable, maybe access to any Java data, maybe invocation of a Java routine.
protected char	elementType Designation what presents the element.
CalculatorExpr	expression Any calculation of data.
(package private) JZtxtcmdScript.StatementList	parentList Necessary for throwing exceptions with the JZtxtcmdScript.StatementList.srcFile in its text.
(package private) static java.lang.String	sindentA
(package private) int	srcColumn Hint to the source of this parsed argument or statement.
(package private) java.lang.String	srcFile
(package private) int	srcLine Hint to the source of this parsed argument or statement.
JZtxtcmdScript.StatementList	statementlist If need, sub statements, maybe null.
(package private) JZtxtcmdScript.JZcmditem	subitem Any special sub item if necessary, see conversion.
java.lang.String	textArg From Zbnf <""?

Fields inherited from interface org.vishia.util.SetLineColumn_ifc

mColumn, mFile, mLine

Constructor Summary

Constructors

Constructor and Description
JZcmditem(JZtxtcmdScript.StatementList parentList, char whatisit)

Method Summary

Modifier and Type	Method and Description
void	add_boolExpr(JZtxtcmdScript.JZcmdCalculatorExpr val)
void	add_dataAccess(JZtxtcmdScript.JZcmdDataAccess val)
void	add_dataStruct(JZtxtcmdScript.StatementList val)
void	add_Filepath(JZtxtcmdScript.JZcmditem val)
void	add_filesetAccess(JZtxtcmdScript.AccessFilesetname val)
void	add_numExpr(JZtxtcmdScript.JZcmdCalculatorExpr val)
void	add_statementBlock(JZtxtcmdScript.StatementList val)
void	add_textExpr(JZtxtcmdScript.StatementList val)
private void	checkEmpty()
(package private) char	elementType()
protected boolean	isEmpty()
JZtxtcmdScript.JZcmdCalculatorExpr	new_boolExpr()
JZtxtcmdScript.JZcmdDataAccess	new_dataAccess()
JZtxtcmdScript.StatementList	new_dataStruct() For ZbnfJavaOutput: Creates a statementlist for a dataStruct.
JZtxtcmdScript.JZcmditem	new_Filepath()
JZtxtcmdScript.AccessFilesetname	new_filesetAccess()
JZtxtcmdScript.JZcmdCalculatorExpr	new_numExpr()
JZtxtcmdScript.StatementList	new_statementBlock() For ZbnfJavaOutput: All block statements in if, while etc.
JZtxtcmdScript.StatementList	new_textExpr(ZbnfParseResultItem zbnfItem) Define the whole item as a statement block which is a text expression.
javax.script.ScriptException	scriptException(java.lang.String text) Builds a ScriptException with the given text and the srcFile, line, column of this item.
void	set_plainText(java.lang.String text)
void	set_text(java.lang.String text)
void	setLineColumnFile(int line, int column, java.lang.String sFile)
int	setLineColumnFileMode() Returns wheter only the line or only the column should be set.
JZtxtcmdScript.StatementList	statementlist()
java.lang.String	toString()
(package private) void	writeStruct(int indent, java.lang.Appendable out) Writes a complete readable information about this item with all nested information.
(package private) void	writeStructAdd(int indent, java.lang.Appendable out) Prepares information in following lines if necessary.
(package private) void	writeStructLine(java.lang.Appendable u) Prepares the information about the JZcmditem in one line.
void	XXXadd_File(JZtxtcmdScript.JZcmditem val)
JZtxtcmdScript.JZcmditem	XXXnew_File() For ZbnfJavaOutput: An < objExpr> is designated as "File : < textValue?

Methods inherited from class java.lang.Object

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

Field Detail

elementType

protected char elementType

Designation what presents the element.

c	what is it
t	simple constant text
n	simple newline text
T	textual output to any variable or file
l	add to list
i	content of the input, textArg describes the build-prescript, see ZmakeGenerator#getPartsFromFilepath(org.vishia.zmake.ZmakeUserScript.Filepath, String)
o	content of the output, textArg describes the build-prescript, see ZmakeGenerator#getPartsFromFilepath(org.vishia.zmake.ZmakeUserScript.Filepath, String)
e	A datatext, from <*expression> or such.
XXXg	content of a data path starting with an internal variable (reference) or value of the variable.
s	call of a subtext by name. textArg==null, statementlist == null.
j	call of a static java method. #identArgJbat==its name, statementlist == null.
c	cmd line invocation.
d	cd change current directory.
J	Object variable #identArgJbat==its name, statementlist == null.
P	Pipe variable, textArg contains the name of the variable
U	Buffer variable, textArg contains the name of the variable
S	String variable, textArg contains the name of the variable
K	Numeric variable, textArg contains the name of the variable
Q	Bool variable, textArg contains the name of the variable
L	Container variable, a list
W	Opened file, a Writer in Java
F	FilePath
G	FileSet
=	assignment of an expression to a variable.
B	statement block
C	<:for:path> statementlist contains build.script for any list element,
E	<:else> statementlist contains build.script for any list element,
?? F	<:if:condition:path> statementlist contains build.script for any list element,
?? G	<:elsif:condition:path> statementlist contains build.script for any list element,
w	while(cond) statementlist contains build.script for any list element,
b	break
?	<:if:...?gt> compare-operation in if
D	debug: break at a defined break point in JZtxtcmdExecuter
H	debugOp: break on invocation of an operation (method) in DataAccess before evaluating the arguments or if operation not found.
Z	a target,
Y	the file
xxxX	a subtext definition

conversion

protected char conversion

Designation of a conversion from given value to a destination instance. old: 'E' to java.io.File '~' complete a CharSequence with the current directory if it is relative. 'F' to FilePath 'G' to JZtxtcmdScript.UserFileset

srcLine

int srcLine

Hint to the source of this parsed argument or statement.

srcColumn

int srcColumn

Hint to the source of this parsed argument or statement.

srcFile

java.lang.String srcFile

parentList

final JZtxtcmdScript.StatementList parentList

Necessary for throwing exceptions with the JZtxtcmdScript.StatementList.srcFile in its text.

statementlist

public JZtxtcmdScript.StatementList statementlist

If need, sub statements, maybe null. An argument may need a StatementList to calculate the value of the argument if is is more complex. Alternatively an Argument can be calculated with the expression or with dataAccess or it is a simple textArg.

dataAccess

public JZtxtcmdScript.JZcmdDataAccess dataAccess

Any access to an Object, maybe content of a variable, maybe access to any Java data, maybe invocation of a Java routine.

expression

public CalculatorExpr expression

Any calculation of data.

subitem

JZtxtcmdScript.JZcmditem subitem

Any special sub item if necessary, see conversion.

textArg

public java.lang.String textArg

From Zbnf <""?textInStatement>, constant text, null if not used.

sindentA

static java.lang.String sindentA

Constructor Detail

JZcmditem

JZcmditem(JZtxtcmdScript.StatementList parentList,
          char whatisit)

Method Detail

setLineColumnFile

public void setLineColumnFile(int line,
                              int column,
                              java.lang.String sFile)

Specified by:

setLineColumnFile in interface SetLineColumn_ifc

setLineColumnFileMode

public int setLineColumnFileMode()

Returns wheter only the line or only the column should be set. It can save calculation time if one of the components are not necessary.

Specified by:

setLineColumnFileMode in interface SetLineColumn_ifc

Returns:

'c' if only column, 'l' if only line, any other: set both.

elementType

char elementType()

statementlist

public JZtxtcmdScript.StatementList statementlist()

checkEmpty

private void checkEmpty()

isEmpty

protected boolean isEmpty()

new_dataAccess

public JZtxtcmdScript.JZcmdDataAccess new_dataAccess()

add_dataAccess

public void add_dataAccess(JZtxtcmdScript.JZcmdDataAccess val)

set_plainText

public void set_plainText(java.lang.String text)

set_text

public void set_text(java.lang.String text)

new_dataStruct

public JZtxtcmdScript.StatementList new_dataStruct()

For ZbnfJavaOutput: Creates a statementlist for a dataStruct.

 objExpr::= \\{  \\} | <\"\"?text> | ....
 dataStruct::= {  ; }.\n"
 

add_dataStruct

public void add_dataStruct(JZtxtcmdScript.StatementList val)

new_statementBlock

public JZtxtcmdScript.StatementList new_statementBlock()

For ZbnfJavaOutput: All block statements in if, while etc.

 ifBlock::= (  ) \\{  \\} .
 ...
 statementBlock::= {  }."
 

add_statementBlock

public void add_statementBlock(JZtxtcmdScript.StatementList val)

new_textExpr

public JZtxtcmdScript.StatementList new_textExpr(ZbnfParseResultItem zbnfItem)

Define the whole item as a statement block which is a text expression. See also JZtxtcmdScript.StatementList.new_textExpr(ZbnfParseResultItem): There such an item is declared inside a longer statement list. The difference is less, both have the same effect. This list does only contain text expression statements.

add_textExpr

public void add_textExpr(JZtxtcmdScript.StatementList val)

new_numExpr

public JZtxtcmdScript.JZcmdCalculatorExpr new_numExpr()

add_numExpr

public void add_numExpr(JZtxtcmdScript.JZcmdCalculatorExpr val)

new_boolExpr

public JZtxtcmdScript.JZcmdCalculatorExpr new_boolExpr()

add_boolExpr

public void add_boolExpr(JZtxtcmdScript.JZcmdCalculatorExpr val)

XXXnew_File

public JZtxtcmdScript.JZcmditem XXXnew_File()

For ZbnfJavaOutput: An < objExpr> is designated as "File : < textValue?File>"

Returns:

this, the conversion is set.

XXXadd_File

public void XXXadd_File(JZtxtcmdScript.JZcmditem val)

new_Filepath

public JZtxtcmdScript.JZcmditem new_Filepath()

add_Filepath

public void add_Filepath(JZtxtcmdScript.JZcmditem val)

new_filesetAccess

public JZtxtcmdScript.AccessFilesetname new_filesetAccess()

add_filesetAccess

public void add_filesetAccess(JZtxtcmdScript.AccessFilesetname val)

scriptException

public javax.script.ScriptException scriptException(java.lang.String text)

Builds a ScriptException with the given text and the srcFile, line, column of this item.

Parameters:

text - message of the ScriptException

writeStruct

final void writeStruct(int indent,
                       java.lang.Appendable out)
                throws java.io.IOException

Writes a complete readable information about this item with all nested information.

Parameters:

indent -

out -

Throws:

java.io.IOException

writeStructAdd

void writeStructAdd(int indent,
                    java.lang.Appendable out)
             throws java.io.IOException

Prepares information in following lines if necessary. It is possible to append in the only one line too. This routine have to be append a newline at last.

Parameters:

indent -

out -

Throws:

java.io.IOException

writeStructLine

void writeStructLine(java.lang.Appendable u)

Prepares the information about the JZcmditem in one line. A newline is not appended here! This routine is called in toString() and in writeStruct(int, Appendable). It should be called in all overridden routines with super.writeStructLine for the derived statement types.

Parameters:

u -

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object