org.vishia.header2Reflection

Class BinOutPrep

java.lang.Object

org.vishia.header2Reflection.BinOutPrep

public class BinOutPrep
extends java.lang.Object

This class prepares the binary output.

Since:

2010-01-11

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	BinOutPrep.TypeBinPosition
private static class	BinOutPrep.TypeNeedInBinOut Position and type of a usage of type in a field.

Field Summary

Fields

Modifier and Type	Field and Description
private Class_Jc	binClass
private Field_Jc	binField
private ObjectArray_Jc	binFieldArray
private ObjectArray_Jc	binOutClassArray Access to binary class Array data for fileBin.
private byte[]	binOutClassArrayData Binary data for fileBin.
private byte[]	binOutData Binary data for fileBin.
private ExtReflection_Insp_h.ExtReflection_Insp	binOutHead Access to binary head data for fileBin.
private byte[]	binOutHeadData Binary data for fileBin.
private RawDataAccess	binOutRefl Access to binary data for fileBin.
private ObjectArray_Jc	binOutSuperArray
private SuperclassIfc_idxMtblJc_ByteDataAccess	binSuperClass
private java.io.OutputStream	fileBin If setOutBin is called, this writer is present, else it is null.
private java.util.Map<java.lang.String,java.lang.Integer>	missingClasses
private int	nrofClasses
private int	nrofFieldsInClass Counts the number of fields in 1 class.
private int	nrofRelocEntries
private java.util.Map<java.lang.String,BinOutPrep.TypeBinPosition>	posClassesInBuffer
private java.lang.String	sFileBin
private java.lang.String	sFileList
private java.util.List<BinOutPrep.TypeNeedInBinOut>	typeBinNeed
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
BinOutPrep(java.lang.String sFileBin, java.lang.String sFileList, boolean fileBinBigEndian, boolean hexOutput, int sign) Constructor to create a binary reflection file.

Method Summary

Modifier and Type	Method and Description
int	addClass(java.lang.String sCppClassName, java.lang.String sCppClassNameShow) Adds a ClassJc-entry in the bin Data.
void	addField(java.lang.String sAttributeNameShow, int typeAddress, java.lang.String sType, int mModifier, int nrofArrayElements) Adds a field to the binFieldArray via ByteDataAccessBase.
void	addFieldHead() Adds space for the fields to binOutRefl as child binFieldArray and clears the child.
int	addSuperclass(java.lang.String sName) Adds the bin data for a ObjectArrayJc of SuperclassIfc_idxMtblJc_ByteDataAccess with the given super field.
void	close()
void	closeAddClass()
void	postProcessBinOut()
(package private) void	setAttributRef(int nrofAttributes) Sets the reference from the class to its fields.
void	setClassBasedOnObjectJc()
(package private) void	setClassSuperclass(int pos)
private void	setRelocEntry(int posReloc) Sets a position in binFile as relocate position.
(package private) void	stop()
void	writeAsCfile(java.io.File out)

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.

• 2018-12-31 Hartmut set Field_Jc.EModifier#kEmbedded_Modifier_reflectJc to the addSuperclass(String) using SuperclassIfc_idxMtblJc_ByteDataAccess.set_Field(String)
• 2018-12-28 Hartmut Now writes more Information of ObjectJc base data to help detection of instance types in the binary data. It is used for BinOutShow.
• 2018-12-18 Hartmut new: Support for inheritance (derivation) for target-proxy-concept: usage of SuperclassIfc_idxMtblJc_ByteDataAccess.
• 2018-09-08 Hartmut missingClasses for report.
• 2018-08-29 Hartmut improved, commented, using for Reflection generation binary with JZtxtcmd-script.
• 2010-01-11 Hartmut new: for Header2Reflection, binary output

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

fileBin

private java.io.OutputStream fileBin

If setOutBin is called, this writer is present, else it is null.

sFileBin

private final java.lang.String sFileBin

sFileList

private final java.lang.String sFileList

binOutData

private final byte[] binOutData

Binary data for fileBin. If setOutBin is called, this array is present, else it is null. The head data contains all relocatable addresses.

binOutHeadData

private final byte[] binOutHeadData

Binary data for fileBin. If setOutBin is called, this array is present, else it is null. The head data contains all relocatable addresses.

binOutClassArrayData

private final byte[] binOutClassArrayData

Binary data for fileBin. If setOutBin is called, this array is present, else it is null. The head data contains all relocatable addresses.

binOutRefl

private final RawDataAccess binOutRefl

Access to binary data for fileBin. If setOutBin is called, this array is present, else it is null. This Data contains fields and classes.

binOutHead

private final ExtReflection_Insp_h.ExtReflection_Insp binOutHead

Access to binary head data for fileBin. If setOutBin is called, this array is present, else it is null. This data contains all relocatable addresses in binOut.

binOutClassArray

private final ObjectArray_Jc binOutClassArray

Access to binary class Array data for fileBin. If setOutBin is called, this array is present, else it is null. This data contains all references to the classes as relative pointers (offset).

binClass

private final Class_Jc binClass

binOutSuperArray

private final ObjectArray_Jc binOutSuperArray

binSuperClass

private final SuperclassIfc_idxMtblJc_ByteDataAccess binSuperClass

binFieldArray

private final ObjectArray_Jc binFieldArray

binField

private final Field_Jc binField

nrofRelocEntries

private int nrofRelocEntries

nrofClasses

private int nrofClasses

nrofFieldsInClass

private int nrofFieldsInClass

Counts the number of fields in 1 class. Set to 0 in addClass(String, String). Used for the index in position.

posClassesInBuffer

private final java.util.Map<java.lang.String,BinOutPrep.TypeBinPosition> posClassesInBuffer

missingClasses

private final java.util.Map<java.lang.String,java.lang.Integer> missingClasses

typeBinNeed

private final java.util.List<BinOutPrep.TypeNeedInBinOut> typeBinNeed

Constructor Detail

BinOutPrep

public BinOutPrep(java.lang.String sFileBin,
                  java.lang.String sFileList,
                  boolean fileBinBigEndian,
                  boolean hexOutput,
                  int sign)
           throws java.io.FileNotFoundException

Constructor to create a binary reflection file.

Parameters:

sFileBin - The path to the binfile to create

sFileList - if not null then the content of the binfile will be reported there.

fileBinBigEndian -

hexOutput -

sign -

Throws:

java.io.FileNotFoundException

Method Detail

setRelocEntry

private void setRelocEntry(int posReloc)
                    throws java.lang.IllegalArgumentException

Sets a position in binFile as relocate position. The address there is organized from 0 relative to the binfile data. On loading the binFile the load address should be added to build a correct memory address.

Parameters:

posReloc - Position in binFile.

Throws:

java.lang.IllegalArgumentException

addSuperclass

public int addSuperclass(java.lang.String sName)
                  throws java.lang.IllegalArgumentException

Adds the bin data for a ObjectArrayJc of SuperclassIfc_idxMtblJc_ByteDataAccess with the given super field.

Parameters:

sName - Type name of the super class

Returns:

Throws:

java.lang.IllegalArgumentException

addClass

public int addClass(java.lang.String sCppClassName,
                    java.lang.String sCppClassNameShow)
             throws java.lang.IllegalArgumentException

Adds a ClassJc-entry in the bin Data. The bin-data of this class can be filled with access to binClass with the appropriate operations.

Throws:

java.lang.IllegalArgumentException

setClassSuperclass

void setClassSuperclass(int pos)

setClassBasedOnObjectJc

public void setClassBasedOnObjectJc()

addFieldHead

public void addFieldHead()
                  throws java.lang.IllegalArgumentException

Adds space for the fields to binOutRefl as child binFieldArray and clears the child. It is separated from addClass(String, String) because not any class has fields. Invoke only if fields are found, before the first field will be written.

Throws:

java.lang.IllegalArgumentException

addField

public void addField(java.lang.String sAttributeNameShow,
                     int typeAddress,
                     java.lang.String sType,
                     int mModifier,
                     int nrofArrayElements)
              throws java.lang.IllegalArgumentException

Adds a field to the binFieldArray via ByteDataAccessBase. The binFieldArray is a ObjectArray_Jc instance for ByteDataAccess. It presents the Fields in Reflection in binary presentation.

Parameters:

sAttributeNameShow -

typeAddress - either -1 for yet unknown or the enum ScalarTypes_ClassJc (see emC/Object_emC.h) for standard (primitive) types. Note: all other than primitive types are gotten via typeBinNeed. Note: In the old Header2Reflection the situation seems to be unchanged but not documented. Test if necessary.

sType - The identifier of the type. Without _t on forward declaration.

mModifier -

nrofArrayElements -

Throws:

java.lang.IllegalArgumentException

setAttributRef

void setAttributRef(int nrofAttributes)
             throws java.lang.IllegalArgumentException

Sets the reference from the class to its fields.

Parameters:

nrofAttributes - The number of the fields written.

Throws:

java.lang.IllegalArgumentException

closeAddClass

public void closeAddClass()

postProcessBinOut

public void postProcessBinOut()
                       throws java.io.IOException,
                              java.lang.IllegalArgumentException

Throws:

java.io.IOException

java.lang.IllegalArgumentException

writeAsCfile

public void writeAsCfile(java.io.File out)

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

stop

void stop()