org.vishia.cmd

Class JZtxtcmdScript.Subroutine

java.lang.Object

org.vishia.cmd.JZtxtcmdScript.JZcmditem

org.vishia.cmd.JZtxtcmdScript.Subroutine

All Implemented Interfaces:

SetLineColumn_ifc

Enclosing class:

JZtxtcmdScript

public static class JZtxtcmdScript.Subroutine
extends JZtxtcmdScript.JZcmditem

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addLocals If set the subroutine gets all local variables as copy.
java.util.List<JZtxtcmdScript.DefVariable>	formalArgs
java.lang.String	name
(package private) JZtxtcmdScript	theScript
boolean	useLocals If set the subroutine uses the local variables of the calling level immediately.

Fields inherited from class org.vishia.cmd.JZtxtcmdScript.JZcmditem

conversion, dataAccess, elementType, expression, parentList, sindentA, srcColumn, srcFile, srcLine, statementlist, subitem, textArg

Fields inherited from interface org.vishia.util.SetLineColumn_ifc

mColumn, mFile, mLine

Constructor Summary

Constructors

Constructor and Description
Subroutine(JZtxtcmdScript.JZcmdClass parentList)

Method Summary

Modifier and Type	Method and Description
void	add_DefBoolVar(JZtxtcmdScript.DefVariable val)
void	add_DefClassVar(JZtxtcmdScript.DefVariable val)
void	add_DefFilepath(JZtxtcmdScript.DefVariable val)
void	add_DefFileset(JZtxtcmdScript.UserFileset val)
void	add_DefMapVar(JZtxtcmdScript.DefVariable val)
void	add_DefNumVar(JZtxtcmdScript.DefVariable val)
void	add_DefObjVar(JZtxtcmdScript.DefVariable val)
void	add_formalArgument(JZtxtcmdScript.Subroutine val) Set from ZBNF: \<*subtext:name: { ?
void	add_List(JZtxtcmdScript.DefContainerVariable val)
void	add_setEnvVar(JZtxtcmdScript.DefVariable val) Defines or changes an environment variable with value. set NAME = TEXT; Handle in the same kind like a String variable but appends a '$' to the first name.
void	add_textVariable(JZtxtcmdScript.DefVariable val)
JZtxtcmdScript.DefVariable	new_ClassObjVar()
JZtxtcmdScript.DefVariable	new_DefBoolVar()
JZtxtcmdScript.DefVariable	new_DefFilepath()
JZtxtcmdScript.UserFileset	new_DefFileset()
JZtxtcmdScript.DefVariable	new_DefMapVar()
JZtxtcmdScript.DefVariable	new_DefNumVar()
JZtxtcmdScript.DefVariable	new_DefObjVar()
JZtxtcmdScript.Subroutine	new_formalArgument()
JZtxtcmdScript.DefContainerVariable	new_List() Defines a variable which is able to use as container.
JZtxtcmdScript.DefVariable	new_setEnvVar() Defines or changes an environment variable with value. set NAME = TEXT; Handle in the same kind like a String variable
JZtxtcmdScript.DefVariable	new_textVariable()
void	set_addLocals()
void	set_name(java.lang.String name)
void	set_useLocals()
(package private) void	writeStructAdd(int indent, java.lang.Appendable out) Prepares information in following lines if necessary.
(package private) void	writeStructLine(java.lang.Appendable out) Prepares the information about the JZcmditem in one line.

Methods inherited from class org.vishia.cmd.JZtxtcmdScript.JZcmditem

add_boolExpr, add_dataAccess, add_dataStruct, add_Filepath, add_filesetAccess, add_numExpr, add_statementBlock, add_textExpr, elementType, isEmpty, new_boolExpr, new_dataAccess, new_dataStruct, new_Filepath, new_filesetAccess, new_numExpr, new_statementBlock, new_textExpr, scriptException, set_plainText, set_text, setLineColumnFile, setLineColumnFileMode, statementlist, toString, writeStruct, XXXadd_File, XXXnew_File

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

addLocals

public boolean addLocals

If set the subroutine gets all local variables as copy.

useLocals

public boolean useLocals

If set the subroutine uses the local variables of the calling level immediately. It does not use an extra calling level. The the subroutine has no formalArgs.

formalArgs

public java.util.List<JZtxtcmdScript.DefVariable> formalArgs

theScript

final JZtxtcmdScript theScript

Constructor Detail

Subroutine

Subroutine(JZtxtcmdScript.JZcmdClass parentList)

Parameters:

parentList - It is neccessary that parentList is instanceof JZcmdClass, for JZtxtcmdExecuter

Method Detail

set_name

public void set_name(java.lang.String name)

set_useLocals

public void set_useLocals()

set_addLocals

public void set_addLocals()

new_formalArgument

public JZtxtcmdScript.Subroutine new_formalArgument()

add_formalArgument

public void add_formalArgument(JZtxtcmdScript.Subroutine val)

Set from ZBNF: \<*subtext:name: { ?,} \>

new_DefObjVar

public JZtxtcmdScript.DefVariable new_DefObjVar()

add_DefObjVar

public void add_DefObjVar(JZtxtcmdScript.DefVariable val)

new_List

public JZtxtcmdScript.DefContainerVariable new_List()

Defines a variable which is able to use as container.

add_List

public void add_List(JZtxtcmdScript.DefContainerVariable val)

new_ClassObjVar

public JZtxtcmdScript.DefVariable new_ClassObjVar()

add_DefClassVar

public void add_DefClassVar(JZtxtcmdScript.DefVariable val)

new_DefNumVar

public JZtxtcmdScript.DefVariable new_DefNumVar()

add_DefNumVar

public void add_DefNumVar(JZtxtcmdScript.DefVariable val)

new_DefBoolVar

public JZtxtcmdScript.DefVariable new_DefBoolVar()

add_DefBoolVar

public void add_DefBoolVar(JZtxtcmdScript.DefVariable val)

new_textVariable

public JZtxtcmdScript.DefVariable new_textVariable()

add_textVariable

public void add_textVariable(JZtxtcmdScript.DefVariable val)

new_DefMapVar

public JZtxtcmdScript.DefVariable new_DefMapVar()

add_DefMapVar

public void add_DefMapVar(JZtxtcmdScript.DefVariable val)

new_DefFilepath

public JZtxtcmdScript.DefVariable new_DefFilepath()

add_DefFilepath

public void add_DefFilepath(JZtxtcmdScript.DefVariable val)

new_DefFileset

public JZtxtcmdScript.UserFileset new_DefFileset()

add_DefFileset

public void add_DefFileset(JZtxtcmdScript.UserFileset val)

new_setEnvVar

public JZtxtcmdScript.DefVariable new_setEnvVar()

Defines or changes an environment variable with value. set NAME = TEXT; Handle in the same kind like a String variable

add_setEnvVar

public void add_setEnvVar(JZtxtcmdScript.DefVariable val)

Defines or changes an environment variable with value. set NAME = TEXT; Handle in the same kind like a String variable but appends a '$' to the first name.

writeStructAdd

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

Description copied from class: JZtxtcmdScript.JZcmditem

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.

Overrides:

writeStructAdd in class JZtxtcmdScript.JZcmditem

Throws:

java.io.IOException

writeStructLine

void writeStructLine(java.lang.Appendable out)

Description copied from class: JZtxtcmdScript.JZcmditem

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

Overrides:

writeStructLine in class JZtxtcmdScript.JZcmditem