org.vishia.fbcl.writeFBcl

Class WriterCodegen

java.lang.Object

org.vishia.fbcl.writeFBcl.WriterCodegen

public class WriterCodegen
extends java.lang.Object

This class organizes the code generation for any languages. It is controlled by the scripts given with #readTpl(Class, String). Depending of the data structure different otx scripts are called. With the otx scripts the adaption to any target language can be done, and also to any desired style. The otx scripts are able to give from outside. The adaption can be done without changing the Java sources and also without study the Java sources.
But in the scripts frequently operations given in this class should be used, which call inside otx scripts again (can be adapted). For that the javadoc of this operations should be studied.

This system is universal as much as possible. But maybe specific approaches needs adaption of the Java sources. This adaption should be done increasing the universality of the universal approach. All adaption to the target language should be possible to do only with the otx scripts.

The whole code generation is called calling writeCode(File, File, String, Module_FBcl, LogMessage). This operation writes all defined output files. General the script for the whole output file for a target language starts with:

The frequently used operations in otx scripts are:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	WriterCodegen.CondNode Contains data saved in a stack for next sibling node after a condition node.
static class	WriterCodegen.OtxWorkData
(package private) static class	WriterCodegen.XXXECondCode

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bVerboseCode
java.lang.Class<FBaccess_FBcl>	class_FBaccess_FBcl Used for quest '?
java.util.Map<java.lang.String,java.lang.String>	cmprOp Map operators of OFB (compatible IEC61499) to target language C/++, Java Note due IEC61499 '=' is equal and '<>' is not equal from graphic
java.util.Map<java.lang.String,java.lang.String>	cmprOpReverse Note '>' is translated to '<=' etc. because the relation is to the input, but the operator is written left side, regarded als compare between left and this value.
(package private) java.util.Map<java.lang.String,java.lang.Object>	idxConstData This map can be filled by the script especially with String-String associations.
(package private) java.util.Map<java.lang.String,org.vishia.util.OutTextPreparer.DataTextPreparer>	idxOtdata
(package private) java.util.TreeMap<java.lang.String,org.vishia.util.OutTextPreparer>	idxOtx Index with all scripts to write, filled after creation of this class calling #readTpl(Class, String).
static java.util.List<Din_FBcl>	iterDinEmpty Is used for the first evChain entry, it has the module din.
java.util.Map<java.lang.String,java.lang.String>	numOp
java.util.Map<java.lang.String,java.lang.String>	numOpFirst
(package private) org.vishia.util.OutTextPreparer	otx_defineLocalVar_FBexpr This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_evMdlOutEnd This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_evMdlOutStart This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_exprCondBitsIf Called if a condition bit change is found.
(package private) org.vishia.util.OutTextPreparer	otx_exprCondIf Called if an event output true is found.
(package private) org.vishia.util.OutTextPreparer	otx_setMdlOutArrayCpy This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_setMdlOutArrayExpr This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_setMdlOutScalar This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_setMdlOutStructCpy This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_setVar_FBexpr This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_setVarArrayElem This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_setVarStruct This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_setVarX_Array This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otx_setVarX_Elem This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otxAccessFBdout This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otxCallFB_evin This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otxCtorFB_evin This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otxCtorObjFB_evin This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otxEvChainExprSetvar This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otxExprAccessElement This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otxExprCondBitsEndif Called if a condition bit change is found.
(package private) org.vishia.util.OutTextPreparer	otxExprElse Called if an event output true is found.
(package private) org.vishia.util.OutTextPreparer	otxExprEndif Called if the chain of an event output true is finished, means the next event given before executing the "true" is found, or on end of all events.
(package private) org.vishia.util.OutTextPreparer	otxExprEv_OFB_Variable Called if an event output true is found.
(package private) org.vishia.util.OutTextPreparer	otxExprIf Called if an event output true is found.
(package private) org.vishia.util.OutTextPreparer	otxExprTerm This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) org.vishia.util.OutTextPreparer	otxInitFB_evin This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).
(package private) Prj_FBCLrd	prj
(package private) java.lang.String	sDbgFBexpr
(package private) java.lang.String	sDbgFBexprEvin
java.lang.String	sNewlineIndent
(package private) java.lang.String	testData
java.util.Map<java.lang.String,java.lang.String>	unaryOp
static java.lang.String	version Version, history and license.
(package private) org.vishia.util.OutTextPreparer	XXXotx_exprSetCond Called if an event output true is found.

Constructor Summary

Constructors

Constructor and Description
WriterCodegen(Prj_FBCLrd prj)

Method Summary

Modifier and Type	Method and Description
private void	callFBoper(FBexpr_FBcl fbx, long[] condBits, Dout_FBcl dout, WriterCodegen.OtxWorkData wd, java.lang.Appendable wr) Generates the code for a called operation of an FBexpr as FBoper if it contains a FBexpr_FBcl.getFunction().
boolean	checkSetLocalVariable(java.lang.String name, WriterCodegen.OtxWorkData wd)
void	doInsert(WriterCodegen.OtxWorkData wd, java.lang.StringBuilder OUT)
private void	genAccessGet(Dout_FBcl doutAccess, long[] condBits, FBaccess_FBcl fba, java.lang.String ref, java.lang.String cacc, WriterCodegen.OtxWorkData wd, java.lang.StringBuilder sb, int recursion) Generates the term due to the given expression.
java.lang.String	genDinAccess(Din_FBcl din, PinConnect_FBcl conn, long[] condBits, java.lang.String sVariant, java.lang.String ref, int ix, java.lang.String cacc, WriterCodegen.OtxWorkData wd, java.lang.StringBuilder out) Generates the access String for an input of any FBlock.
void	genDinAccessConn(Din_FBcl din, PinConnect_FBcl connSrc, java.lang.String cacc, long[] condBits, java.lang.String ref, WriterCodegen.OtxWorkData wd, java.lang.StringBuilder out) Generates the code for a given Din_FBcl for a given connection PinConnect_FBcl
private void	genExprIn(DinExpr_FBcl din, FBexpr_FBcl fbx, long[] condBits, java.lang.String sOperatorLeftArg, java.lang.String sOperator, java.lang.String sUnaryOp, java.lang.String ref, int ix, java.lang.String caccArg, WriterCodegen.OtxWorkData wd, java.lang.StringBuilder sb, int recursion) Generate the code of an expression input regarding constant values and K parts.
private void	genExprOut(Dout_FBcl doutExpr, java.lang.String selDinElemDst, FBexpr_FBcl fbx, long[] condBits, java.lang.String ref, int ix, java.lang.String cacc, WriterCodegen.OtxWorkData wd, java.lang.StringBuilder sb, int recursion) Generates the term due to the given expression.
private void	genExprTerm(java.lang.StringBuilder sb, java.lang.String selDinElemDst, FBexpr_FBcl fbx, long[] condBits, java.lang.String ref, int ix, java.lang.String cacc, WriterCodegen.OtxWorkData wd, int recursion) Generates an expression determined by its inputs with its operators and K inputs.
private void	genExprTermCmpr(java.lang.StringBuilder sb, java.lang.String selDinElemDst, FBexpr_FBcl fbx, java.lang.Iterable<DinExpr_FBcl> dinValues, long[] condBits, java.lang.String ref, int ix, java.lang.String cacc, WriterCodegen.OtxWorkData wd, int recursion)
java.lang.String	genRefIn(PinRef_FBcl din, long[] condBits, java.lang.String ref, java.lang.String cacc, WriterCodegen.OtxWorkData wd, java.lang.StringBuilder out, int recursion) Generates the access String for a reference of a FBlock for direct connected port output.
java.lang.String	genValueDin(Din_FBcl din, long[] condBits, java.lang.String ref, java.lang.String cacc, WriterCodegen.OtxWorkData wd) Generates the access String for an input of a FBlock maybe through some combinatoric expressions.
void	genValueDout(Dout_FBcl dout, long[] condBits, java.lang.String ref, java.lang.String cacc, WriterCodegen.OtxWorkData wd, java.lang.StringBuilder sb, int recursion) Generates the access String to data from the given output pin of any FBlock_FBcl, also an FBexpr_FBcl or a Variable after expression.
void	genVarAccessSet(Dout_FBcl doutVar, Dout_FBcl doutExpr, FBaccess_FBcl fba, long[] condBits, java.lang.String varAcc, WriterCodegen.OtxWorkData wd, java.lang.CharSequence nli, java.lang.StringBuilder sb)
void	genVarExpr(Dout_FBcl doutVar, Dout_FBcl doutExpr, FBlock_FBcl fb, long[] condBits, java.lang.String ref, int ix, java.lang.String cacc, WriterCodegen.OtxWorkData wd, java.lang.StringBuilder sb) Called in otx (VarX_OFB) to set the variable after expression or access.
void	genVariableDef(Module_FBcl mdl, WriterCodegen.OtxWorkData wd, java.lang.Appendable out) Generates a proper code for variable definitions (usual in header file) for all variables on output on expressions.
(package private) org.vishia.util.OutTextPreparer.DataTextPreparer	getCreateOtxData(org.vishia.util.OutTextPreparer otx, WriterCodegen.OtxWorkData wd) Gets the proper instance of DataTextPreparer to run OutTextPreparer.exec(Appendable, org.vishia.util.OutTextPreparer.DataTextPreparer) running repeatedly in the same thread.
void	insertPoint(WriterCodegen.OtxWorkData wd, java.lang.StringBuilder OUT)
static java.lang.Iterable<java.lang.Integer>	iterBits(long[] bitArray)
void	parseScripts(org.vishia.msgDispatch.LogMessage log) Translates the script to otx, second pass of translation It translates idxOtx and set otxCallFB_evin.
private void	prc_setVar_FBexpr(FBexpr_FBcl fbx, Evout_FBcl evSrc, Evin_FBcl evinDst, Dout_FBcl doutExpr, Dinout_FBcl varExpr, java.util.List<Dout_FBcl> listVarOut, long[] condBits, WriterCodegen.OtxWorkData wd, java.lang.Appendable out) Generates code for the input event of an expression which is immediately before a variable.
void	prcEvchainOperation(EvtreeNode_FBcl nodeRoot, Evout_FBcl evStartArg, Module_FBcl mdl, WriterCodegen.OtxWorkData wd, java.lang.Appendable out) This operation follows the EvtreeNode_FBcl from evStart to generate the code for this event as operation.
private void	prcEvinFBaccess(Evout_FBcl evSrc, Evin_FBcl evinDst, long[] condBits, WriterCodegen.OtxWorkData wd, java.lang.Appendable wr) Process the next FBlock as FBaccess.
private void	prcEvinFBexpr(Evout_FBcl evSrc, Evin_FBcl evinDst, long[] condBits, WriterCodegen.OtxWorkData wd, java.lang.Appendable wr) Process the next FBlock as FBexpr.
private void	prcEvinFBlock(Evout_FBcl evinMdl, Evout_FBcl evoutSrc, Evin_FBcl evinDst, long[] condBitsSrc, java.lang.String sVariant, WriterCodegen.OtxWorkData wd, Module_FBcl mdl, java.lang.Appendable out) Processes one evin to one FBlock.
private void	prcEvNode(Evout_FBcl evinMdl, EvtreeNode_FBcl evNode, long[] condBitsSrc, EvtreeNode_FBcl.IteratorEvoutTree iterTree, Module_FBcl mdl, WriterCodegen.OtxWorkData wd, java.lang.Appendable out, int recursion) Generates the code due to one EvtreeNode_FBcl called in prcEvchainOperation(EvtreeNode_FBcl, Evout_FBcl, Module_FBcl, OtxWorkData, Appendable) following the event node chain.
private void	prcEvNodesBranch(Evout_FBcl evinMdl, EvtreeNode_FBcl evNode, Evout_FBcl evoutSrc, Evin_FBcl XXXevin, long[][] condBits, int ixCond, WriterCodegen.OtxWorkData wd, Module_FBcl mdl, java.lang.Appendable out, int recursion)
private void	prepareExprTextGiven(java.lang.StringBuilder out, FBexpr_FBcl fbx, long[] condBits, java.lang.String ref, java.lang.String sFn, WriterCodegen.OtxWorkData wd) Prepares any expression which is given in sFn.
void	readTpl(java.lang.Class<?> classInJar, java.lang.String pathTpl, org.vishia.msgDispatch.LogMessage log) Reads the script file in the first pass It fills idxOtx with empty instances of otx.
private boolean	testCondition(Din_FBcl din, long[] condBits) Test whether the given condition is met on any of the source pins if more connections are given.
private boolean	testCondition(Dout_FBcl doutSrc, long[] condBits) Test whether the condition is true for the given source pin.
private java.lang.String	translateOperatorToTargetLang(char dType, java.lang.String sGraphicOperator, java.util.Map<java.lang.String,java.lang.String> idxTrl, java.lang.String sDefault) check whether graphic operator with specific type should be translated.
void	writeCode(java.io.File dirout, java.io.File dirCmp, java.lang.String sMdlName, Module_FBcl mdl, org.vishia.msgDispatch.LogMessage log) General call of the write code for one output file with the scripts.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2023-12-08: Creation

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

class_FBaccess_FBcl

public java.lang.Class<FBaccess_FBcl> class_FBaccess_FBcl

Used for quest '?instanceof class_FBaccess_FBcl' in otx script.

iterDinEmpty

public static final java.util.List<Din_FBcl> iterDinEmpty

Is used for the first evChain entry, it has the module din.

cmprOpReverse

public final java.util.Map<java.lang.String,java.lang.String> cmprOpReverse

Note '>' is translated to '<=' etc. because the relation is to the input, but the operator is written left side, regarded als compare between left and this value. input > means, the input should be greater than the input before, should be translated to inputBefore <= input Note due IEC61499 '=' is equal and '<>' is not equal from graphic

cmprOp

public final java.util.Map<java.lang.String,java.lang.String> cmprOp

Map operators of OFB (compatible IEC61499) to target language C/++, Java Note due IEC61499 '=' is equal and '<>' is not equal from graphic

numOp

public final java.util.Map<java.lang.String,java.lang.String> numOp

numOpFirst

public final java.util.Map<java.lang.String,java.lang.String> numOpFirst

unaryOp

public final java.util.Map<java.lang.String,java.lang.String> unaryOp

sDbgFBexpr

final java.lang.String sDbgFBexpr

sDbgFBexprEvin

final java.lang.String sDbgFBexprEvin

prj

final Prj_FBCLrd prj

bVerboseCode

public boolean bVerboseCode

sNewlineIndent

public java.lang.String sNewlineIndent

idxOtx

final java.util.TreeMap<java.lang.String,org.vishia.util.OutTextPreparer> idxOtx

Index with all scripts to write, filled after creation of this class calling #readTpl(Class, String). The content comes from the script as argument pathTpl.

idxOtdata

final java.util.Map<java.lang.String,org.vishia.util.OutTextPreparer.DataTextPreparer> idxOtdata

idxConstData

final java.util.Map<java.lang.String,java.lang.Object> idxConstData

This map can be filled by the script especially with String-String associations. It uses the <:set:name:value> capability in a template. Especially the extensions for the files for more as one output files for code generation are contained here with the names "CodeGen..." where "..." is 1, 2 etc.

otxCallFB_evin

org.vishia.util.OutTextPreparer otxCallFB_evin

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otxCtorFB_evin

org.vishia.util.OutTextPreparer otxCtorFB_evin

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otxCtorObjFB_evin

org.vishia.util.OutTextPreparer otxCtorObjFB_evin

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otxInitFB_evin

org.vishia.util.OutTextPreparer otxInitFB_evin

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otxEvChainExprSetvar

org.vishia.util.OutTextPreparer otxEvChainExprSetvar

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otxExprTerm

org.vishia.util.OutTextPreparer otxExprTerm

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otxExprAccessElement

org.vishia.util.OutTextPreparer otxExprAccessElement

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setVar_FBexpr

org.vishia.util.OutTextPreparer otx_setVar_FBexpr

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_defineLocalVar_FBexpr

org.vishia.util.OutTextPreparer otx_defineLocalVar_FBexpr

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_evMdlOutStart

org.vishia.util.OutTextPreparer otx_evMdlOutStart

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_evMdlOutEnd

org.vishia.util.OutTextPreparer otx_evMdlOutEnd

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setMdlOutScalar

org.vishia.util.OutTextPreparer otx_setMdlOutScalar

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setMdlOutArrayCpy

org.vishia.util.OutTextPreparer otx_setMdlOutArrayCpy

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setMdlOutArrayExpr

org.vishia.util.OutTextPreparer otx_setMdlOutArrayExpr

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setMdlOutStructCpy

org.vishia.util.OutTextPreparer otx_setMdlOutStructCpy

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otxAccessFBdout

org.vishia.util.OutTextPreparer otxAccessFBdout

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setVarStruct

org.vishia.util.OutTextPreparer otx_setVarStruct

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setVarArrayElem

org.vishia.util.OutTextPreparer otx_setVarArrayElem

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setVarX_Array

org.vishia.util.OutTextPreparer otx_setVarX_Array

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otx_setVarX_Elem

org.vishia.util.OutTextPreparer otx_setVarX_Elem

This is the important OutTextPreparer for one event chain member proper to #prcEvChain(Evin_FBcl, Integer, Writer).

otxExprEv_OFB_Variable

org.vishia.util.OutTextPreparer otxExprEv_OFB_Variable

Called if an event output true is found. See #prcEvchainOperation(Evout_FBcl, Module_FBcl, Appendable)

otxExprIf

org.vishia.util.OutTextPreparer otxExprIf

Called if an event output true is found. See #prcEvchainOperation(Evout_FBcl, Module_FBcl, Appendable)

XXXotx_exprSetCond

org.vishia.util.OutTextPreparer XXXotx_exprSetCond

Called if an event output true is found.

otx_exprCondIf

org.vishia.util.OutTextPreparer otx_exprCondIf

Called if an event output true is found.

otxExprElse

org.vishia.util.OutTextPreparer otxExprElse

Called if an event output true is found.

otx_exprCondBitsIf

org.vishia.util.OutTextPreparer otx_exprCondBitsIf

Called if a condition bit change is found.

otxExprCondBitsEndif

org.vishia.util.OutTextPreparer otxExprCondBitsEndif

Called if a condition bit change is found.

otxExprEndif

org.vishia.util.OutTextPreparer otxExprEndif

Called if the chain of an event output true is finished, means the next event given before executing the "true" is found, or on end of all events. See #prcEvchainOperation(Evout_FBcl, Module_FBcl, Appendable)

testData

java.lang.String testData

Constructor Detail

WriterCodegen

public WriterCodegen(Prj_FBCLrd prj)

Method Detail

iterBits

public static java.lang.Iterable<java.lang.Integer> iterBits(long[] bitArray)

readTpl

public void readTpl(java.lang.Class<?> classInJar,
                    java.lang.String pathTpl,
                    org.vishia.msgDispatch.LogMessage log)

Reads the script file in the first pass It fills idxOtx with empty instances of otx.

Parameters:

classInJar - given then read from jar-File, null: read as file

pathTpl - relative path to classInJar or path in file system

Throws:

java.io.IOException

java.text.ParseException

parseScripts

public void parseScripts(org.vishia.msgDispatch.LogMessage log)

Translates the script to otx, second pass of translation It translates idxOtx and set otxCallFB_evin.

Throws:

java.text.ParseException

writeCode

public void writeCode(java.io.File dirout,
                      java.io.File dirCmp,
                      java.lang.String sMdlName,
                      Module_FBcl mdl,
                      org.vishia.msgDispatch.LogMessage log)

General call of the write code for one output file with the scripts.

Parameters:

fout - output file path for the code.

otxMain - name of the main script (distinction header and C-Implementation etc.)

argName - name of the one argument for otxMain

mdl - internal Java data for code generation, the module.

log - for error log

insertPoint

public void insertPoint(WriterCodegen.OtxWorkData wd,
                        java.lang.StringBuilder OUT)

doInsert

public void doInsert(WriterCodegen.OtxWorkData wd,
                     java.lang.StringBuilder OUT)

checkSetLocalVariable

public boolean checkSetLocalVariable(java.lang.String name,
                                     WriterCodegen.OtxWorkData wd)

getCreateOtxData

org.vishia.util.OutTextPreparer.DataTextPreparer getCreateOtxData(org.vishia.util.OutTextPreparer otx,
                                                                  WriterCodegen.OtxWorkData wd)

Gets the proper instance of DataTextPreparer to run OutTextPreparer.exec(Appendable, org.vishia.util.OutTextPreparer.DataTextPreparer) running repeatedly in the same thread. Hint: For more as one thread use different instances. Use the threadId also as key.

Parameters:

otx -

Returns:

data instance for the exec(...) call.

genVariableDef

public void genVariableDef(Module_FBcl mdl,
                           WriterCodegen.OtxWorkData wd,
                           java.lang.Appendable out)
                    throws java.io.IOException

Generates a proper code for variable definitions (usual in header file) for all variables on output on expressions. It iterates through all FBlocks, look whether FBlock_FBcl.kind() is == FBlock_FBcl.Blocktype#VarAfterExpr and then calls the otx script with the type name of the FBlock_FBcl.typeName() following by "_h".
It is <otx: VarZ_OFB_h ... or <otx: VarV_OFB_h ... or <otx: VarL_OFB_h ... whereby 'VarL_OFB' is a local variable, should not create a variable definition here, but can be used as comment docu line.
If the type is not found, otx:otxUndefFB_h is used.

Parameters:

mdl - Module's data

out - to write the source code

Throws:

java.io.IOException

prcEvchainOperation

public void prcEvchainOperation(EvtreeNode_FBcl nodeRoot,
                                Evout_FBcl evStartArg,
                                Module_FBcl mdl,
                                WriterCodegen.OtxWorkData wd,
                                java.lang.Appendable out)
                         throws java.io.IOException

This operation follows the EvtreeNode_FBcl from evStart to generate the code for this event as operation. This routine should be called inside the otx script for the implementation code.

Parameters:

evStart - The event which is the start event of the operation.

mdl - The module data

out - Output. It is anytime a StringBuilder, needs insertion points.

Throws:

java.io.IOException

prcEvNode

private void prcEvNode(Evout_FBcl evinMdl,
                       EvtreeNode_FBcl evNode,
                       long[] condBitsSrc,
                       EvtreeNode_FBcl.IteratorEvoutTree iterTree,
                       Module_FBcl mdl,
                       WriterCodegen.OtxWorkData wd,
                       java.lang.Appendable out,
                       int recursion)
                throws java.io.IOException

Generates the code due to one EvtreeNode_FBcl called in prcEvchainOperation(EvtreeNode_FBcl, Evout_FBcl, Module_FBcl, OtxWorkData, Appendable) following the event node chain. This follows the connection between two FBlocks or the module's evinMdl and evoutMdl.

Parameters:

evinMdl - The modules evin or the evin on start of this event chain

evNode - the TreeNode with the evin to the FBlock

condBitsSrc - null or maybe given bits for conditions, which are checked with input data.

iterTree - The iterator where the evNode is gotten from. Used to continue on sibling etc. if conditions given

mdl - The module

wd -

out -

recursion -

Throws:

java.io.IOException

prcEvNodesBranch

private void prcEvNodesBranch(Evout_FBcl evinMdl,
                              EvtreeNode_FBcl evNode,
                              Evout_FBcl evoutSrc,
                              Evin_FBcl XXXevin,
                              long[][] condBits,
                              int ixCond,
                              WriterCodegen.OtxWorkData wd,
                              Module_FBcl mdl,
                              java.lang.Appendable out,
                              int recursion)
                       throws java.io.IOException

Throws:

java.io.IOException

prcEvinFBlock

private void prcEvinFBlock(Evout_FBcl evinMdl,
                           Evout_FBcl evoutSrc,
                           Evin_FBcl evinDst,
                           long[] condBitsSrc,
                           java.lang.String sVariant,
                           WriterCodegen.OtxWorkData wd,
                           Module_FBcl mdl,
                           java.lang.Appendable out)
                    throws java.io.IOException

Processes one evin to one FBlock. This operation is only called in #prcEvchainOperation(Evout_FBcl, Module_FBcl, OtxWorkData, StringBuilder) for each event from the queue. It calls one of the described processing in the given order of the following list:

• First it checks whether a proper otx script with the FBlock_FBcl.typeName() is existing. Means, specific FBtype_FBcl can have there own source code generation script. The script is called with the arguments:
  • fb The FBlock_FBcl itself due to evin.fb
  • din Din_FBcl, the first din if given, or null if the fb has not an input. This helps on some simple FBlocks to access
  • dout Dout_FBcl, the first output if given, or null if the fb has not an output. This helps on some simple FBlocks to access
  • douttype. DoutType_FBcl, This helps on some simple FBlocks to access
  • evin Evin_FBcl the evinDst as argument of this operation, it is the original given evin from the event queue
  • evSrc Evout_FBcl the evSrc as argument of this operation, it is the source of the evin usable for comments in source code.
• For FBlock_FBcl.kind() == FBlock_FBcl.Blocktype#VarAfterExpr and the update pin is reached, in that kind point above <otx: VarZ_OFB_upd... is called for update source code. with the arguments shown in the point before.
• If the current FBlock is a FBaccess_FBcl then #prcEvinFBaccess(Evout_FBcl, Evin_FBcl, List, Map, Appendable) is called, see there.
• If the FBlock is in the Module_FBcl.idxFBlockTEST, then normally no code generation should be done for it in this operation. But on option -verbodeCode the <otx: infoFBtest ... is called to get an info about this FBlock as part of the event queue.
• If the evinDst is a output event of the module (PinKind_FBcl.isModulePin()) then <otx: evChainMdlOut... is called with the arguments
  • iterDin Evin_FBcl.iterAssocDin() all inputs to this event.
  • evout it is evoutSrc of this operation parameter
  • evin it is evinDst of this operation parameter
• else: First an otx-Script with the name of the evinDst and "FB_evin" is searched. This is especially for "initFB_evin", "ctorFB_evin" and also "ctorObjFB_evin", or possible for more specific evin names. If this is not found, <otx: callFB_evin:... is searched and should be found. This found otx is called with the same arguments as <otx: evChainMdlOut..., iterDin, evout and evin.

After processing the FBlock, after proper code generation, the correspond evout to the evin is put in the queueEvSrc.

• For Join, it depends from fulfilling of the events to join, as described above.
• For a TEST FBlock (member of Module_FBcl.idxFBlockTEST) evout are not considerate.
• For all other FBlock, the FBlock_FBcl.iterEvout(Evin_FBcl) is called to get the correspond evout, and they are put in the queue calling #addEventNextAll(List, Evin_FBcl, Appendable) to generate the code for this FBlocks afterwards in the event order. The event order is firstly regard immediately following events, later parallel events. This is done by "last in first out" organization of the queue.

Parameters:

evoutSrc - The source of this evin, only used for comment

evinDst - the evin to process

queueEvSrc - queue to add following evout of the FBlock.

idxEvStartChainCodegen - Hash Map stores the already used events for codeGen to prevent twice or circular code generation, may be caused only by an software error

mdl - The module's data

out - output for source code

Throws:

java.io.IOException

prcEvinFBaccess

private void prcEvinFBaccess(Evout_FBcl evSrc,
                             Evin_FBcl evinDst,
                             long[] condBits,
                             WriterCodegen.OtxWorkData wd,
                             java.lang.Appendable wr)
                      throws java.io.IOException

Process the next FBlock as FBaccess. Either it generated code for otx_setVarArrayElem or otx_setVarStruct or it does nothing because it is an AccessGet...OFB. Last one is processed backward. Anywhere the event is forwarded to all destinations.

Parameters:

evSrc - the evout before this FBlock, only for comment

evinDst - the relevant prep evin of the FBlock

queueEvSrc - queue to add new driven events

idxEvStartChainCodegen - Hash Map stores the already used events for codeGen to prevent twice or circular code generation, may be caused only by an software error

wr - output

Throws:

java.io.IOException

prcEvinFBexpr

private void prcEvinFBexpr(Evout_FBcl evSrc,
                           Evin_FBcl evinDst,
                           long[] condBits,
                           WriterCodegen.OtxWorkData wd,
                           java.lang.Appendable wr)
                    throws java.io.IOException

Process the next FBlock as FBexpr. The process depends from FBexpr_FBcl.cAccess which is also the first character in din[0] able to see in IEC61499 presentation as constant initializer of 'expr'

• '=', '$', : It sets all outputs to output variables, hence it is called as statement. The expression can have more as one output variable. If that are local ones, they are created as local variable inside the script <otx: setVar_FBexpr....
  Then the script is called with
  • evSrc Evout_FBcl only for comment
  • evinDst Evin_FBcl of the FBexpr
  • fbx FBexpr_FBcl the FBexpr itself
  • cOp char the FBexpr_FBcl.getOperation()
  • iterVout List with all outputs which are variable after the expression generated as local ones as PinKind_FBcl.Dout
  • varExpr FBlock_FBcl the FBlock of the variable after the dout which is type of DoutExpr_FBcl. It is null if the expression has not a connection on its DoutExpr_FBcl. Note: All other outputs of the expression are only Dout_FBcl.
  • doutExpr the DoutExpr_FBcl
• '~' '&' '@' '%' Nothing is generated. The FBexpr is used in line as expression term. That's why calling this operation is excluded before.

For the last variants where nothing is generated the inline access is done backward from inputs, which calls genExprTerm(StringBuilder, String, FBexpr_FBcl, long[], String, int, String, OtxWorkData, int) maybe with the correct component on complex or comprehensive types.

Parameters:

evSrc - the evout before this FBlock, only for comment

evinDst - the relevant prep evin of the FBlock

queueEvSrc - queue to add new driven events

idxEvStartChainCodegen - Hash Map stores the already used events for codeGen to prevent twice or circular code generation, may be caused only by an software error

wr - output

Throws:

java.io.IOException

prc_setVar_FBexpr

private void prc_setVar_FBexpr(FBexpr_FBcl fbx,
                               Evout_FBcl evSrc,
                               Evin_FBcl evinDst,
                               Dout_FBcl doutExpr,
                               Dinout_FBcl varExpr,
                               java.util.List<Dout_FBcl> listVarOut,
                               long[] condBits,
                               WriterCodegen.OtxWorkData wd,
                               java.lang.Appendable out)
                        throws java.io.IOException

Generates code for the input event of an expression which is immediately before a variable. This is the only one operation which calls otx otx_defineLocalVar_FBexpr, otx_setVar_FBexpr . This is an expression marked with FBexpr_FBcl.cAccess == one of "&=". The proper expression is detect in EvoutTreePrc_FBcl.

Parameters:

fbx -

evSrc -

evinDst -

doutExpr - The output of the expression itself, it is usual a

varExpr - The variable after the expression. It can be either a module's output, which is an Din_FBcl, an referenced input of a FbLock, or also the variable after expression given as Dout_FBcl.

listVarOut - a list of variable which are used in the expression and which should be defined as stack local variable.

condBits - to access inputs, the condition from the evSrc

wd -

out -

Throws:

java.io.IOException

callFBoper

private void callFBoper(FBexpr_FBcl fbx,
                        long[] condBits,
                        Dout_FBcl dout,
                        WriterCodegen.OtxWorkData wd,
                        java.lang.Appendable wr)
                 throws java.io.IOException

Generates the code for a called operation of an FBexpr as FBoper if it contains a FBexpr_FBcl.getFunction().

Note: The function can be contained in the expression either as text in the ofbExpression box or also as text in an Dout_FBcl of the expression. Note: Intrinsically this operation should be hold in the EvinType_FBcl pin but this is not possible because the expression is not determined by the type. Or think about, a special type is created for a specific expression since 2024-07-26 also because different data types.

If the expression contains a FBlock_FBcl.reference pin, then it is the reference to the associated FBlock where this operation is a member of. Hence the operation of the type is called, with the reference as this pointer.

If the expression does not contain a reference, it is a static operation, should be able to find by name in the target language.

If the expression contains more outputs than the given dout argument, then that are output reference variables (call by reference) to store the output values in. In C/++ that are usual pointers to local or variables of the module- In Java that are usual arrays with the [0] element as reference.

Parameters:

fbx - The FBoper

dout - presents the value of the expression, all other outputs are call by value arguments.

wr - to write the code.

Throws:

java.io.IOException

genValueDin

public java.lang.String genValueDin(Din_FBcl din,
                                    long[] condBits,
                                    java.lang.String ref,
                                    java.lang.String cacc,
                                    WriterCodegen.OtxWorkData wd)

Generates the access String for an input of a FBlock maybe through some combinatoric expressions. This operation is called from the otx script: <:set:dinVar=genValueDin(fbx.din[1],'', 0)> This example shows set a access variable string with generated access code to use it to set the components of the variable. Also it is called inside #prepareExprTextGiven(Appendable, FBexpr_FBcl, String) to replace the X1.. variables with the code on inputs.
Hence the content is not immediately written for the code generation, instead it is prepared in a StringBuilder and returned as String to use. It calls #genValueDout(Dout_FBcl, String, Appendable, int) with this StringBuilder if the input has a connection to an output.
Non connected input constant values are immediately returned.

Parameters:

din - The data input which is connected to any output or it has a Din_FBcl.sConstant

cacc - access to an element of an input variable, for example ".re" or "[1]"

ref - reference to the module data, it is often "thiz" inside the module, or a specific reference variable

Returns:

String as part of this access code.

genDinAccess

public java.lang.String genDinAccess(Din_FBcl din,
                                     PinConnect_FBcl conn,
                                     long[] condBits,
                                     java.lang.String sVariant,
                                     java.lang.String ref,
                                     int ix,
                                     java.lang.String cacc,
                                     WriterCodegen.OtxWorkData wd,
                                     java.lang.StringBuilder out)

Generates the access String for an input of any FBlock. This is called only inside the otx script for code generation. Hence should be public. It is called for ordinary FBlocks as also for Expression inputs and module's outputs.

• If the din is an DinExpr_FBcl, this is an input of an FBexpr_FBcl, then #genExprIn(DinExpr_FBcl, FBexpr_FBcl, String, String, Appendable, int) is called. This regards also the K.. input of an expression.
• otherwise, it is tested whether the input is connected to any Dout_FBcl as source for the input. If yes, It is also a type cast and an access to a struct or array element can be contained in the input string. This is regarded here. Then with the doutSrc #genValueDout(Dout_FBcl, String, String, Appendable, int) is called.
• If the input is not connected, but contains a constant value gotten with Din_FBcl.getConstant() then this constant value is used for the generated code for this input. TODO with the type of the din maybe a translation of the constant may be proper for example to create "3.14f" as float designation for C programming if "3.14" is given, or supplement with "" for a String input.
• If the input is not connected but also does not contain a constant, the constant "0" is used, maybe TODO adapted to the correct type.

or also for direct connected state outputs and constants. This operation is used frequently in otx scripts.
It calls #genValueDout(Dout_FBcl, String, int) from the connected source or taks the Din_FBcl.sConstant

Parameters:

din - The data input which is delivered from any output or it has a Din_FBcl.sConstant

conn - null or the specific connection from din. Then conn: PinConnect_FBcl.pinDst should == din.

ref - reference to the module data for the source of din, it is often "thiz" inside the module, or a specific reference variable

cacc - access to an element of an input variable, for example ".re" or "[1]"

out - the buffer to write the generated source code

Returns:

empty String "" or an error message. This is written after the produced output to out from the OutTextPreparer algorithm. An empty string produces no more output, but the error message occurs in the generated code and can be manually understand. It should produce a compiler error then on compiling the generated sources.

genDinAccessConn

public void genDinAccessConn(Din_FBcl din,
                             PinConnect_FBcl connSrc,
                             java.lang.String cacc,
                             long[] condBits,
                             java.lang.String ref,
                             WriterCodegen.OtxWorkData wd,
                             java.lang.StringBuilder out)
                      throws java.io.IOException

Generates the code for a given Din_FBcl for a given connection PinConnect_FBcl

Parameters:

din - It is the same as connSrc: PinConnect_FBcl.pinDst

connSrc - the given connection between dout and din

dtin - data type of din, same as din: Dinout_FBcl.dType()

cacc - access string to the

condBits - the condition bits necessary for backward selection of dout for inline expressions

ref -

wd - Write data

out - The output where to write the code.

Throws:

java.io.IOException

genRefIn

public java.lang.String genRefIn(PinRef_FBcl din,
                                 long[] condBits,
                                 java.lang.String ref,
                                 java.lang.String cacc,
                                 WriterCodegen.OtxWorkData wd,
                                 java.lang.StringBuilder out,
                                 int recursion)

Generates the access String for a reference of a FBlock for direct connected port output. This operation is used frequently in otx scripts.
It calls #genValueDout(Dout_FBcl, String, int) from the connected source, that is a PinPort_FBcl returnd by PinRef_FBcl.getConnPort() or takes the Din_FBcl.sConstant

Parameters:

din - The data input which is delivered from any output or it has a Din_FBcl.sConstant

cacc - access to an element of an input variable, for example ".re" or "[1]"

ref - reference to the module data, it is often "thiz" inside the module, or a specific reference variable

recursion -

Returns:

empty String "" or an error message. This is written after the produced output to out from the OutTextPreparer algorithm

genValueDout

public void genValueDout(Dout_FBcl dout,
                         long[] condBits,
                         java.lang.String ref,
                         java.lang.String cacc,
                         WriterCodegen.OtxWorkData wd,
                         java.lang.StringBuilder sb,
                         int recursion)
                  throws java.io.IOException

Generates the access String to data from the given output pin of any FBlock_FBcl, also an FBexpr_FBcl or a Variable after expression. It is called from genDinAccess(Din_FBcl, PinConnect_FBcl, long[], String, String, int, String, OtxWorkData, StringBuilder) for the backward connected output.

• First it is checked whether the given dout is an output of a specific FBtype. An otx script with the <typeName>_acc is searched. This is espcially for VarL_OFB_acc etc. to access the output of variables as output of an expression.
• Else it is tested whether this dout is a module's input pin. Its name is used immediately. For code generation this is correct if the module's input is used with the same event and hence it is part of the argument list of this generated operation.
• Else it checks whether the dout is an DoutExpr_FBcl, then #genExprOut(Dout_FBcl, FBexpr_FBcl, String, String, HashMap, Appendable, int) is called which regards all possibilies of expressions in the graphic.
• At least it is checked whether the dout.name is "THIS", means it is the whole FBlock as port reference. Then <otx: doutAccessThis ... is called, else <otx: doutAccessThis ... , with the following arguments:
  • sEvout String, name of the event for the dout
  • dout the dout itself from argument
  • fb FBlock_FBcl from dout.fb
  • fbtName type name of the FBlock_FBcl.typeName()
  • ref as given as argument of this operation
  • cacc as given as argument of this operation
  It should access the output of any FBlock. The simplest form presumes, that the output is part of a struct of the FBlock. It can be adapted in the otx script.

Parameters:

dout - The data output which delivers a value

sb - StringBuilder to write in

ref - reference to the module data, it is often "thiz" inside the module, or a specific reference variable

cacc - access to an element of an input variable, for example ".re" or "[1]"

recursion -

Throws:

java.io.IOException

genAccessGet

private void genAccessGet(Dout_FBcl doutAccess,
                          long[] condBits,
                          FBaccess_FBcl fba,
                          java.lang.String ref,
                          java.lang.String cacc,
                          WriterCodegen.OtxWorkData wd,
                          java.lang.StringBuilder sb,
                          int recursion)
                   throws java.io.IOException

Generates the term due to the given expression.
First it depends from the operation of the expression FBexpr_FBcl.getOperation() or FBexpr_FBcl.cOp what is done:

• '!': The expression has an expression text given in the FBexpr shape. This is handled by the specific #prepareExprTextGiven(Appendable, FBexpr_FBcl, String, String).
• '(': The FBexpr has named a function in its DoutExpr_FBcl (from the ofpExprOut pin style in odg diagram). In this case param doutExpr may be null if the ofpExprOut is not connected. This is detected by a before called #setVar_FBexpr(FBexpr_FBcl, Evout_FBcl, Evin_FBcl, Evout_FBcl, Appendable) to define expression output variables. In this case either for the given FBexpr_FBcl.getFunction() a specific otx script is found, then it is executed with the arguments:
  • sName String, the name in FBexpr_FBcl.getOperation() till the opened '('.
  • fbx FBexpr_FBcl the expression
  • cacc String, usual "" but possible set if an element of the output result should be accessed. This is not a normal case.
  If a otx for the function is not found, then #callFBoper(FBexpr_FBcl, Dout_FBcl, Appendable) is executed.
• ':' This is an access to one of the elements from the input value. The pin name of the given doutExpr determines the element. TODO access array, yet only for .re .im
• All other operators are used for ordinary expression terms, executed with genExprTerm(StringBuilder, String, FBexpr_FBcl, long[], String, int, String, OtxWorkData, int). The doutExpr should be given, not null.

• It is possible that some more output variables are set in the term in C/++ as "call by reference".
• It is possible that one reference input is given in the expression, then it is an operation of the referenced FBlock, hence a FBoper. In the otx script it is the argument "THIZ"
• It is possible that either some

Parameters:

doutExpr - It is the dout connected to either any input or to the variable which presents this output in the graphic. It can be null if one of the FBlock_FBcl.dout is type of DoutExpr_FBcl but has no connection, or it is null if all FBlock_FBcl.dout has variables on its outputs, hence the type of FBlock_FBcl.dout is only Dout_FBcl, and not DoutExpr_FBcl. This is detected by the before called #setVar_FBexpr(FBexpr_FBcl, Evout_FBcl, Evin_FBcl, Evout_FBcl, Appendable)

fbx - The expression

ref - reference to the module data, it is often "thiz" inside the module, or a specific reference variable

cacc - optional an access string added to any data input

sb - output buffer.

Throws:

java.io.IOException

genVarExpr

public void genVarExpr(Dout_FBcl doutVar,
                       Dout_FBcl doutExpr,
                       FBlock_FBcl fb,
                       long[] condBits,
                       java.lang.String ref,
                       int ix,
                       java.lang.String cacc,
                       WriterCodegen.OtxWorkData wd,
                       java.lang.StringBuilder sb)
                throws java.io.IOException

Called in otx (VarX_OFB) to set the variable after expression or access.

Parameters:

doutExpr -

fb -

condBits -

ref -

ix -

cacc -

wd -

sb -

recursion -

Throws:

java.io.IOException

genVarAccessSet

public void genVarAccessSet(Dout_FBcl doutVar,
                            Dout_FBcl doutExpr,
                            FBaccess_FBcl fba,
                            long[] condBits,
                            java.lang.String varAcc,
                            WriterCodegen.OtxWorkData wd,
                            java.lang.CharSequence nli,
                            java.lang.StringBuilder sb)
                     throws java.io.IOException

Throws:

java.io.IOException

genExprOut

private void genExprOut(Dout_FBcl doutExpr,
                        java.lang.String selDinElemDst,
                        FBexpr_FBcl fbx,
                        long[] condBits,
                        java.lang.String ref,
                        int ix,
                        java.lang.String cacc,
                        WriterCodegen.OtxWorkData wd,
                        java.lang.StringBuilder sb,
                        int recursion)
                 throws java.io.IOException

Generates the term due to the given expression.
First it depends from the operation of the expression FBexpr_FBcl.getOperation() or FBexpr_FBcl.cOp what is done:

• '!': The expression has an expression text given in the FBexpr shape. This is handled by the specific #prepareExprTextGiven(Appendable, FBexpr_FBcl, String, String).
• '(': The FBexpr has named a function in its DoutExpr_FBcl (from the ofpExprOut pin style in odg diagram). In this case param doutExpr may be null if the ofpExprOut is not connected. This is detected by a before called #setVar_FBexpr(FBexpr_FBcl, Evout_FBcl, Evin_FBcl, Evout_FBcl, Appendable) to define expression output variables. In this case either for the given FBexpr_FBcl.getFunction() a specific otx script is found, then it is executed with the arguments:
  • sName String, the name in FBexpr_FBcl.getOperation() till the opened '('.
  • fbx FBexpr_FBcl the expression
  • cacc String, usual "" but possible set if an element of the output result should be accessed. This is not a normal case.
  If a otx for the function is not found, then #callFBoper(FBexpr_FBcl, Dout_FBcl, Appendable) is executed.
• All other operators are used for ordinary expression terms, executed with genExprTerm(StringBuilder, String, FBexpr_FBcl, long[], String, int, String, OtxWorkData, int). The doutExpr should be given, not null.

• It is possible that some more output variables are set in the term in C/++ as "call by reference".
• It is possible that one reference input is given in the expression, then it is an operation of the referenced FBlock, hence a FBoper. In the otx script it is the argument "THIZ"
• It is possible that either some

Parameters:

doutExpr - It is the dout connected to either any input or to the variable which presents this output in the graphic. It can be null if one of the FBlock_FBcl.dout is type of DoutExpr_FBcl but has no connection, or it is null if all FBlock_FBcl.dout has variables on its outputs, hence the type of FBlock_FBcl.dout is only Dout_FBcl, and not DoutExpr_FBcl. This is detected by the before called #setVar_FBexpr(FBexpr_FBcl, Evout_FBcl, Evin_FBcl, Evout_FBcl, Appendable)

selDinElemDst - to select DinExpr due to PinConnect_FBcl#elemDst

ix - if >=0 then doutExpr is an array,

fbx - The expression

ref - reference to the module data, it is often "thiz" inside the module, or a specific reference variable

cacc - optional an access string added to any data input

sb - output buffer.

Throws:

java.io.IOException

genExprTerm

private void genExprTerm(java.lang.StringBuilder sb,
                         java.lang.String selDinElemDst,
                         FBexpr_FBcl fbx,
                         long[] condBits,
                         java.lang.String ref,
                         int ix,
                         java.lang.String cacc,
                         WriterCodegen.OtxWorkData wd,
                         int recursion)
                  throws java.io.IOException

Generates an expression determined by its inputs with its operators and K inputs.

Parameters:

sb - the output, usual a StringBuilder

fbx - the FBexpr itself

ref - reference to the module data, it is often "thiz" inside the module, or a specific reference variable

cacc - additional access String to access each the same sub element (".re", ".im", "[ix]")

recursion -

Throws:

java.io.IOException

translateOperatorToTargetLang

private java.lang.String translateOperatorToTargetLang(char dType,
                                                       java.lang.String sGraphicOperator,
                                                       java.util.Map<java.lang.String,java.lang.String> idxTrl,
                                                       java.lang.String sDefault)

check whether graphic operator with specific type should be translated.

Parameters:

dType - The data type chacter

sGraphicOperator - given operator in graphic

idxTrl - translator map. key may be dType + sGraphicOperator or only sGraphicOperator

Returns:

either found dType + sGraphicOperator, or only found sGraphicOperator translation, or sGraphicOperator non translated if not found.

genExprTermCmpr

private void genExprTermCmpr(java.lang.StringBuilder sb,
                             java.lang.String selDinElemDst,
                             FBexpr_FBcl fbx,
                             java.lang.Iterable<DinExpr_FBcl> dinValues,
                             long[] condBits,
                             java.lang.String ref,
                             int ix,
                             java.lang.String cacc,
                             WriterCodegen.OtxWorkData wd,
                             int recursion)
                      throws java.io.IOException

Throws:

java.io.IOException

genExprIn

private void genExprIn(DinExpr_FBcl din,
                       FBexpr_FBcl fbx,
                       long[] condBits,
                       java.lang.String sOperatorLeftArg,
                       java.lang.String sOperator,
                       java.lang.String sUnaryOp,
                       java.lang.String ref,
                       int ix,
                       java.lang.String caccArg,
                       WriterCodegen.OtxWorkData wd,
                       java.lang.StringBuilder sb,
                       int recursion)
                throws java.io.IOException

Generate the code of an expression input regarding constant values and K parts. The operator and also the unary operator is not regarded here. TODO handling unary operator.

Parameters:

din - One of the expression input

fbx - of this FBexpr

ref - reference to the module data, it is often "thiz" inside the module, or a specific reference variable

ix - -1 or >=0 if the expression is used as array expression.

cacc - possible access to component of variables

sb - output

recursion -

Throws:

java.io.IOException

prepareExprTextGiven

private void prepareExprTextGiven(java.lang.StringBuilder out,
                                  FBexpr_FBcl fbx,
                                  long[] condBits,
                                  java.lang.String ref,
                                  java.lang.String sFn,
                                  WriterCodegen.OtxWorkData wd)
                           throws java.io.IOException

Prepares any expression which is given in sFn. The expression can contain "X1", "X2" etc or only "X". That are replaced by the values of the inputs if the fbx. For the values of the inputs #genValueDin(Din_FBcl, String) is called which may invoke (depending on the input delivering FBlock) a proper otx Script.

Parameters:

fbx - The FBexpr using its FBlock_FBcl.din

ref - reference to the module data, it is often "thiz" inside the module, or a specific reference variable

sFn - the given function from FBexpr_FBcl.sFn

Throws:

java.io.IOException

testCondition

private boolean testCondition(Din_FBcl din,
                              long[] condBits)

Test whether the given condition is met on any of the source pins if more connections are given. Calls testCondition(Dout_FBcl, long[]) for all sources.

Parameters:

din - may have connections or not

condBits - maybe null

Returns:

true if condBits ==null or no connections, true if at least one connection met, false if it has condBits and connections but all does not met.

testCondition

private boolean testCondition(Dout_FBcl doutSrc,
                              long[] condBits)

Test whether the condition is true for the given source pin. The condition is tested on the evout pin corresponds to the doutSrc. Conditions are stored in Evinout_FBcl.condBits. Calls Evinout_FBcl.getConditionBits() to check and calls Bitfield.checkOrConditionMet(long[][], long[]) to test the condition.

Parameters:

doutSrc - the dout where the condition should met.

condBits - maybe null

Returns:

true if condBits ==null, true if condition mets.