org.vishia.fbcl

Class Prj_FBcl

java.lang.Object

org.vishia.fbcl.Prj_FBcl

public class Prj_FBcl
extends java.lang.Object

This is a common class to organize reading source files for Library and submodule usage.
Contains especially reference to already read FBlocks:

• stdFBlocks: all common used FBlocks.
• idxAllFBlockType all already read library or other modules.

Both indices have a simple String as key, and FBtype_FBcl as member. The String is the type name.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	Prj_FBcl.CmdCfg

Field Summary

Fields

Modifier and Type	Field and Description
OFBconv.CmdArgs	args
(package private) boolean	bLogOperationOfCluster
private AliasImport_FBcl	codegenTypeReplace Contains types generated from any module as key and the real to use type for generated code.
static java.lang.String	dbgNameClass
static java.lang.String	dbgNameOperation
static java.lang.String	dbgNameStepOperation
static java.lang.String	debugBlock
static java.lang.String	debugBlockGlobalNameTypePropagation
static java.lang.String	debugBlockname_toProcess
static java.lang.String	debugBlockNameInLib_ReplaceConnections
static java.lang.String	debugBlocknameSortBlocks
static java.lang.String	debugBlockNameTypePropagation
static java.lang.String	debugCallBlockForTranslation
static java.lang.String	debugClassForTranslation
static java.lang.String	debugConNameGenExpr
static java.lang.String	debugCreateBlockOfOperations
static java.lang.String	debugGenJavaOperationname
static java.lang.String	debugLibBlock
static java.lang.String	debugLibBlockLibName
static java.lang.String	debugModuleForTranslation
static java.lang.String	debugModuleNamePrepareFromSlx
static java.lang.String	debugModuleNameTypePropagation
static java.lang.String	debugNameClassVar
static java.lang.String	debugNameOutblockPart
static java.lang.String	debugNameOutVariable
static java.lang.String	debugNamePredefBlock
static java.lang.String	debugNameTypePropSubmodule
static java.lang.String	debugSignalnameOutportCompleteFBlock_Operation
static java.lang.String	debugSlxBlockType
static java.lang.String	debugSlxLineName
static java.lang.String	debugSlxName
static java.lang.String	debugSlxName2
static java.lang.String	debugSubmodulename_toSearchAndTranslate
(package private) java.lang.Exception	excLog
private int	exitCode
WriterFBCL	fbclWriter
private FBtype_FBcl.Ctor	fBlockType_ctor This is an agent instance to access to the protected ctor of FBtype_FBcl.
java.util.Map<java.lang.String,FBtype_FBcl>	idxAllFBlockType All library blocks should be translated first or read from an interface file.
java.util.Map<java.lang.String,FBlock_FBcl>	idxCodegenDoneFB Storage for all Modules which are code generated already.
java.util.Map<java.lang.String,FBlock_FBcl>	idxCodegenFB Storage for all FBlocks for which code generation should do for a specific FBlock environment.
java.util.Map<java.lang.String,Module_FBcl>	idxModulesDTypesNonDeterministic Storage for all translated modules with non deterministic DTypes.
java.util.Map<java.lang.String,Write_Module_FBwr>	idxWriteModules Storage for all already read and converted sub modules working in progress (... to write).
java.util.List<java.lang.String>	listInclude
LogMessage	log
int	maxRecursionSubmodule
Module_FBcl	mdlPrj
(package private) int	nIdent
ReaderFBcl	readerFBcl All library blocks should be translated first or read from an interface file (TODO).
(package private) java.lang.String	sIdent
private static Prj_FBcl	singleton
StdLibFBlocks_FBcl	stdFBlocks
(package private) java.lang.StringBuilder	sTranslationInfo The default data type for all not determined inputs, which are open.
TranslationScripts	trlScripts
java.util.Map<java.lang.String,DType_FBcl>	userDataTypes User data types are not presented by a FBlock.
java.util.Map<java.lang.String,DTypeBase_FBcl>	userDTypeBase User data types are not presented by a FBlock.
WriterDataFBcl	wrDataFBcl
WriterFBclData	wrFBclData
WriterCodegen	writerCodegen

Constructor Summary

Constructors

Constructor and Description
Prj_FBcl(LogMessage cmdlog, OFBconv.CmdArgs args) Constructor for the singleton project data of the translator.

Method Summary

Modifier and Type	Method and Description
void	addCodegenCfgCommon(java.lang.String sNameModule, java.lang.String sKind, java.lang.String sImportPath) Adds the own header of the module to the project wide alias-header- codegenTypeReplace So that usage of this Module FBtype imports the header.
void	close()
(package private) void	dataTypeError(DinoutType_FBcl con1, DinoutType_FBcl con2)
void	errorMsg(java.lang.String msg, java.lang.Object... params)
void	errorMsgAdd(java.lang.String msg, java.lang.Object... params)
AliasImport_FBcl	getCodegenCfgCommon()
FBtype_FBcl	getCreateFBlockType(FBlock_FBcl.Blocktype kind, java.lang.String name, Module_FBcl mdl, java.lang.String sDefiningMdl) Gets an already created FBlockType or creates an empty new one.
DType_FBcl	getCreateUserDataType(FBtype_FBcl fbref) Gets or creates a reference type associated to a FBtype_FBcl
DTypeBase_FBcl	getCreateUserDType(java.lang.String name)
DType_FBcl	getCreateUserStructType(FBtype_FBcl fbref) Gets or creates a structure type associated to a FBtype_FBcl
int	getExitCode()
FBtype_FBcl	getFBlockType(java.lang.String name) Gets an already created FBlockType or returns null.
FBtype_FBcl	getTypeFB(java.lang.String name)
void	infoMsg(java.lang.String msg, java.lang.Object... params)
DType_FBcl.DtIxfb	OnlySlx_getCreateDataType(java.lang.String sDType, java.lang.String sDTypeKey, int[] sizeArray) Deprecated.
static void	readCodegenCfg(AliasImport_FBcl codegenTypeReplace, java.io.File fileCfg, LogMessage log)
private static void	readCodegenCfgImportline(java.lang.String sLine, int start, int end, java.util.Map<java.lang.String,java.util.List<java.lang.String>> imports)
void	readCommonCfg(java.util.List<java.io.File> listFileCfg)
void	readSpecificLibFiles() Reads that files which are specific named by command line args, especially -ifbd:path/to*file.fbd to read IEC61499 source files which describes the interface to S-Functions in target language.
void	setExitCode(int level)
static Prj_FBcl	singleton()
void	throwModelError(FBlock_FBcl block, DinoutType_FBcl con, java.lang.String nameConn, java.lang.String msg)
void	writeError(java.lang.String error, java.lang.Exception exc) Central routine to write any error message.
void	writeTranslationInfo(java.lang.String error)
DType_FBcl	XXXgetCreateUserDataType(java.lang.String sType) Deprecated. see Write_Module_FBwr.getCreateDType(String) The module should manage all specific data types.

Methods inherited from class java.lang.Object

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

Field Detail

singleton

private static Prj_FBcl singleton

trlScripts

public final TranslationScripts trlScripts

args

public final OFBconv.CmdArgs args

exitCode

private int exitCode

stdFBlocks

public final StdLibFBlocks_FBcl stdFBlocks

listInclude

public final java.util.List<java.lang.String> listInclude

codegenTypeReplace

private AliasImport_FBcl codegenTypeReplace

Contains types generated from any module as key and the real to use type for generated code.

idxModulesDTypesNonDeterministic

public final java.util.Map<java.lang.String,Module_FBcl> idxModulesDTypesNonDeterministic

Storage for all translated modules with non deterministic DTypes.

idxWriteModules

public final java.util.Map<java.lang.String,Write_Module_FBwr> idxWriteModules

Storage for all already read and converted sub modules working in progress (... to write).

idxCodegenFB

public final java.util.Map<java.lang.String,FBlock_FBcl> idxCodegenFB

Storage for all FBlocks for which code generation should do for a specific FBlock environment. The key is the name of the code generated file, derived from the module's name.

idxCodegenDoneFB

public final java.util.Map<java.lang.String,FBlock_FBcl> idxCodegenDoneFB

Storage for all Modules which are code generated already. The key is the name of the code generated file, derived from the module's name. If the code was already generated, then the value is null.

idxAllFBlockType

public java.util.Map<java.lang.String,FBtype_FBcl> idxAllFBlockType

All library blocks should be translated first or read from an interface file.

userDataTypes

public java.util.Map<java.lang.String,DType_FBcl> userDataTypes

User data types are not presented by a FBlock. There may be given internally in generated code only.

userDTypeBase

public java.util.Map<java.lang.String,DTypeBase_FBcl> userDTypeBase

User data types are not presented by a FBlock. There may be given internally in generated code only.

readerFBcl

public final ReaderFBcl readerFBcl

All library blocks should be translated first or read from an interface file (TODO).

fbclWriter

public final WriterFBCL fbclWriter

writerCodegen

public final WriterCodegen writerCodegen

wrDataFBcl

public final WriterDataFBcl wrDataFBcl

wrFBclData

public final WriterFBclData wrFBclData

mdlPrj

public final Module_FBcl mdlPrj

sTranslationInfo

java.lang.StringBuilder sTranslationInfo

The default data type for all not determined inputs, which are open.

log

public final LogMessage log

excLog

java.lang.Exception excLog

maxRecursionSubmodule

public int maxRecursionSubmodule

debugNamePredefBlock

public static java.lang.String debugNamePredefBlock

debugSlxBlockType

public static java.lang.String debugSlxBlockType

debugSlxName

public static java.lang.String debugSlxName

debugSlxLineName

public static java.lang.String debugSlxLineName

debugSlxName2

public static java.lang.String debugSlxName2

debugModuleNamePrepareFromSlx

public static java.lang.String debugModuleNamePrepareFromSlx

debugNameTypePropSubmodule

public static java.lang.String debugNameTypePropSubmodule

debugLibBlock

public static java.lang.String debugLibBlock

debugCallBlockForTranslation

public static java.lang.String debugCallBlockForTranslation

debugClassForTranslation

public static java.lang.String debugClassForTranslation

debugModuleForTranslation

public static java.lang.String debugModuleForTranslation

debugLibBlockLibName

public static java.lang.String debugLibBlockLibName

debugBlockNameTypePropagation

public static java.lang.String debugBlockNameTypePropagation

debugBlockGlobalNameTypePropagation

public static java.lang.String debugBlockGlobalNameTypePropagation

debugModuleNameTypePropagation

public static java.lang.String debugModuleNameTypePropagation

debugConNameGenExpr

public static java.lang.String debugConNameGenExpr

debugBlockname_toProcess

public static java.lang.String debugBlockname_toProcess

debugSubmodulename_toSearchAndTranslate

public static java.lang.String debugSubmodulename_toSearchAndTranslate

debugBlockNameInLib_ReplaceConnections

public static java.lang.String debugBlockNameInLib_ReplaceConnections

debugBlocknameSortBlocks

public static java.lang.String debugBlocknameSortBlocks

debugSignalnameOutportCompleteFBlock_Operation

public static java.lang.String debugSignalnameOutportCompleteFBlock_Operation

debugGenJavaOperationname

public static java.lang.String debugGenJavaOperationname

debugCreateBlockOfOperations

public static java.lang.String debugCreateBlockOfOperations

debugNameOutVariable

public static java.lang.String debugNameOutVariable

debugNameOutblockPart

public static java.lang.String debugNameOutblockPart

debugNameClassVar

public static java.lang.String debugNameClassVar

debugBlock

public static java.lang.String debugBlock

dbgNameStepOperation

public static java.lang.String dbgNameStepOperation

dbgNameClass

public static java.lang.String dbgNameClass

dbgNameOperation

public static java.lang.String dbgNameOperation

bLogOperationOfCluster

boolean bLogOperationOfCluster

sIdent

java.lang.String sIdent

nIdent

int nIdent

fBlockType_ctor

private FBtype_FBcl.Ctor fBlockType_ctor

This is an agent instance to access to the protected ctor of FBtype_FBcl. Only inside this Prj_FBcl FBlockType instances should be cretated and also registered. The only operation is #getCreateFBlockType(String).

Constructor Detail

Prj_FBcl

public Prj_FBcl(LogMessage cmdlog,
                OFBconv.CmdArgs args)
         throws java.text.ParseException,
                java.lang.InstantiationException,
                java.io.IOException

Constructor for the singleton project data of the translator. If some stuff in initialization fails, especially translating otx scripts from template, then an exception is thrown here. The exception should be catched outside and should abort the translator.

Parameters:

args - command line calling arguments, are filled already.

fileLog -

Throws:

java.text.ParseException

java.lang.InstantiationException

java.io.IOException

Method Detail

singleton

public static Prj_FBcl singleton()

setExitCode

public void setExitCode(int level)

getExitCode

public int getExitCode()

readCommonCfg

public void readCommonCfg(java.util.List<java.io.File> listFileCfg)

getCodegenCfgCommon

public AliasImport_FBcl getCodegenCfgCommon()

readCodegenCfg

public static void readCodegenCfg(AliasImport_FBcl codegenTypeReplace,
                                  java.io.File fileCfg,
                                  LogMessage log)

addCodegenCfgCommon

public void addCodegenCfgCommon(java.lang.String sNameModule,
                                java.lang.String sKind,
                                java.lang.String sImportPath)

Adds the own header of the module to the project wide alias-header- codegenTypeReplace So that usage of this Module FBtype imports the header.

Parameters:

sNameModule - identifier of the FBtype is the name of the module.

sKind - kind of header for key in AliasImport_FBcl.Elem#importsType

sImportPath - The path as should be used in relation with the sKind.

readCodegenCfgImportline

private static void readCodegenCfgImportline(java.lang.String sLine,
                                             int start,
                                             int end,
                                             java.util.Map<java.lang.String,java.util.List<java.lang.String>> imports)

readSpecificLibFiles

public void readSpecificLibFiles()

Reads that files which are specific named by command line args, especially -ifbd:path/to*file.fbd to read IEC61499 source files which describes the interface to S-Functions in target language.

Since:

2023-09-23 created.

writeTranslationInfo

public void writeTranslationInfo(java.lang.String error)

XXXgetCreateUserDataType

@Deprecated
public DType_FBcl XXXgetCreateUserDataType(java.lang.String sType)

Deprecated. see Write_Module_FBwr.getCreateDType(String) The module should manage all specific data types.

Parameters:

sType -

Returns:

getCreateUserDataType

public DType_FBcl getCreateUserDataType(FBtype_FBcl fbref)

Gets or creates a reference type associated to a FBtype_FBcl

Parameters:

fbref - given FBtype_FBcl

Returns:

registered data type TODO rename to getCreateUserRefType

getCreateUserStructType

public DType_FBcl getCreateUserStructType(FBtype_FBcl fbref)

Gets or creates a structure type associated to a FBtype_FBcl

Parameters:

fbref - given FBtype_FBcl

Returns:

registered data type

getCreateUserDType

public DTypeBase_FBcl getCreateUserDType(java.lang.String name)

OnlySlx_getCreateDataType

@Deprecated
public DType_FBcl.DtIxfb OnlySlx_getCreateDataType(java.lang.String sDType,
                                                                java.lang.String sDTypeKey,
                                                                int[] sizeArray)

Deprecated.

Tries to get the sType from the DType_FBcl.getStdType(String). If not successfull, first

Parameters:

sDType -

sizeArray -

Returns:

getCreateFBlockType

public FBtype_FBcl getCreateFBlockType(FBlock_FBcl.Blocktype kind,
                                       java.lang.String name,
                                       Module_FBcl mdl,
                                       java.lang.String sDefiningMdl)

Gets an already created FBlockType or creates an empty new one.

Parameters:

name -

kind - FBlock_FBcl.Blocktype.Libmodule

mdl -

Returns:

getFBlockType

public FBtype_FBcl getFBlockType(java.lang.String name)

Gets an already created FBlockType or returns null.

Parameters:

name -

Returns:

dataTypeError

void dataTypeError(DinoutType_FBcl con1,
                   DinoutType_FBcl con2)

throwModelError

public void throwModelError(FBlock_FBcl block,
                            DinoutType_FBcl con,
                            java.lang.String nameConn,
                            java.lang.String msg)

getTypeFB

public FBtype_FBcl getTypeFB(java.lang.String name)

writeError

public void writeError(java.lang.String error,
                       java.lang.Exception exc)

Central routine to write any error message.

Parameters:

error -

exc - if not null build a ExcUtil#exceptionInfo(CharSequence, Throwable, int, int).

errorMsg

public void errorMsg(java.lang.String msg,
                     java.lang.Object... params)

errorMsgAdd

public void errorMsgAdd(java.lang.String msg,
                        java.lang.Object... params)

infoMsg

public void infoMsg(java.lang.String msg,
                    java.lang.Object... params)

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException