FieldData

java.lang.Object
- org.vishia.java2C.FieldData

```
public class FieldData
extends java.lang.Object
```
This class holds the data of one variable in a local context respectively a field of a class, see LocalIdents or describe the access to a instance, see CCodeData.

Field Summary

Fields
Modifier and Type	Field and Description
`org.vishia.java2C.ClassData`	`declaringClazz` The class where the identifier is member of, null if it is a local identifier.
`org.vishia.java2C.ClassData`	`elementClazz` The type of a elements of a generic container type.
`java.lang.String[]`	`fixArraySizes` If the identifier is an array with fix size, programmed in java in form of
`org.vishia.java2C.ClassData`	`instanceClazz` If this field is set, the instance referenced in the described field is guaranteed an instance of that type, nor from a derived type.
`org.vishia.java2C.ClassData`	`keyClazz` The type of a key if it is a generic container type of keys and values.
`char`	`modeAccess` Kind of the instance.
`char`	`modeArrayElement` Kind of the access to an element, if it is an array.
`char`	`modeStatic` Char to indicate the location and kind of definition.
`static java.lang.String`	`sVersion` version, history and license.
`org.vishia.java2C.ClassData`	`typeClazz` The type respectively reference type of the field.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`gen_Declaration(org.vishia.java2C.iWriteContent generateFile)` Generates the C type declaration appropriate to the type info in this FieldData.
`int`	`getClassLevel()` level of the affiliation to a class in the inheritance level.
`int`	`getDimensionArray()` Returns 0 if it isn't an array, 1..
`int`	`getFixSizeStringBuffer()` Returns the size >0 if the type is a StringBuffer with a immediate String with fix size, else 0.
`java.lang.String`	`getName()` returns the name of the element.
`int`	`getOuterLevel()` level of the affiliation to a class in the outer class relation.
`java.lang.String`	`getTypeChar()`
`java.lang.String`	`getTypeName()` returns the name of the type of the element.
`java.lang.String`	`testAndcast(CCodeData src, char modeAccessDst)` Tests whether a cast to the given FieldData type is necessary and executes it.
`static java.lang.String`	`testAndChangeAccess(char modeAccessDst, java.lang.String sSrc1, char modeAccessSrc)` Changes the access.
`java.lang.String`	`toString()` builds a String representation especially to test under eclipse.
`java.lang.String`	`writeStruct()` Writes the structure of this instance to a `*.stc`-file.
`java.lang.String`	`xxxwriteStruct()` Writes the structure of this instance to a `*.stc`-file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sVersion
```
public static final java.lang.String sVersion
```
version, history and license.
- 2014-09-05 Hartmut new: modeAccess can have value 'M' for a PtrVal access. Regarded for C-generation.
- 2008 Hartmut created:
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

typeClazz
```
public final org.vishia.java2C.ClassData typeClazz
```
The type respectively reference type of the field.

keyClazz
```
public org.vishia.java2C.ClassData keyClazz
```
The type of a key if it is a generic container type of keys and values. Elsewhere null.

elementClazz
```
public org.vishia.java2C.ClassData elementClazz
```
The type of a elements of a generic container type. Elsewhere null.

instanceClazz
```
public final org.vishia.java2C.ClassData instanceClazz
```
If this field is set, the instance referenced in the described field is guaranteed an instance of that type, nor from a derived type. It means, no dynamic linked call is necessary, methods can called static using this instance type. This property saves some calculation times, while calling override-able methods of the referenced class.
If references are used as interface references for Java test and software design (including the documentation aspect), but the implementation uses the named instance in any case, this feature should be used.
For a reference variable this behavior is possible to control with @ java2c=instanceType:TYPE. This behavior is also set at embedded instance automatically. This field is null, if the instance isn't predefined.

declaringClazz
```
public final org.vishia.java2C.ClassData declaringClazz
```
The class where the identifier is member of, null if it is a local identifier.

modeStatic
```
public final char modeStatic
```
Char to indicate the location and kind of definition.
- 'S' static constant
- 's' static non constant
- 'd' immediate constant with define
- 'n' stack-locally Field which stores a reference to a new created instance, to activate for garbage collection.
- 'r' nonPersistent.
- 't' not used, TODO used 'r' String, which may be non persistent. Maybe return value with buffer in Thread-Context.
- '.' non static, no special functionality.

fixArraySizes
```
public final java.lang.String[] fixArraySizes
```
If the identifier is an array with fix size, programmed in java in form of
```
 Type[][] myArray = new Type[expr][expr];
 
```
The expr translated in C-Form are stored here. This expr should be a simple value in C. There are used to generate the initialization of an array.
null if it isn't an array or it is a dynamic array.

modeArrayElement
```
public final char modeArrayElement
```
Kind of the access to an element, if it is an array. The adequate chars are used see modeAccess. Special case: If it is 'B', the field describes a StringBufferJc with a fix size. In that case the dimensionArrayOrFixSize contains the number of chars inclusive the 4 chars storing in the StringBufferJc-instance with immediate buffer.

modeAccess

public final char modeAccess

Kind of the instance. For non-arrays:

$	an embedded struct
%	a variable of basic primitive type such as int32, float, char, but also an embedded indivisible struct like StringJc, MemC, OS_TimeStamp, whose elements aren't accessed in Java.
*	a simple reference, pointer in C, used for non-GC-controlled associations.
@	an enhanced reference, for GC (garbage collector) -controlled associations.
m	an method table-reference.
t	a StringJc, it is an enhanced reference ~REF also, but with special accesses
&	an method-table reference ~MTB, containing C-jump-table with index. This type is only used for stack-local variables. GC is not possible
~	ythis as reference (call own method
+	A variable argument list

if dimensionArrayOrFixSize >0, this element describes the access to the array head. The kind of elements respectively the access to the data of the elements are described in modeArrayElement. with the same key chars as shown above. Independent of the kind of referencing the array the elements may be embedded struct ('$'), references ('*') etc., see modeArrayElement.

M	Reference to an array with a PtrVal in C. A PtrVal is a `struct { Type* ptr__; int32 value__}` whereby `Type` is the type of the reference. The `value__` contains the number of elements of the array. The array is 1-dimensional. In Java it is any array `@Java4C=PtrVal Type[]`.
B	A ByteStringJc. It is similar as StringJc, but it references bytes, not chars. In Java it is a byte[] with java2c=ByteStringJc-designation. Hint: A ByteStringJc is designated in this class with `dimensionArrayOrFixSize`=1. It is an array with 1 dimension. It is similar MemC (pointer to memory and size).
P	A simple reference to the array elements without head, pointer in C, used for non-GC-controlled associations.
Q	An embedded array without head. All elements are embedded. The `#fixArraySize` is set.
X	A simple reference to `ObjectArrayJc` head informations, pointer in C, to an array type, used for non-GC-controlled associations.
Y	An embedded array with `ObjectArrayJc` head informations. All elements are embedded. The `#fixArraySize` is set.
@	an enhanced reference to an array type, starting with ObjectArrayJc, for GC (garbage collector) -controlled associations.

Method Detail
- getClassLevel
```
public int getClassLevel()
```
  level of the affiliation to a class in the inheritance level. 0= it is a local visible variable. 1=element of this class, 2=element of super class etc.
- getDimensionArray
```
public int getDimensionArray()
```
  Returns 0 if it isn't an array, 1.. for number of array dimension.
- getFixSizeStringBuffer
```
public int getFixSizeStringBuffer()
```
  Returns the size >0 if the type is a StringBuffer with a immediate String with fix size, else 0.
- getOuterLevel
```
public int getOuterLevel()
```
  level of the affiliation to a class in the outer class relation. 0= it is a local visible variable. 1=element of this class, 2=element of outer class etc.
- getName
```
public java.lang.String getName()
```
  returns the name of the element.
- getTypeName
```
public java.lang.String getTypeName()
```
  returns the name of the type of the element.
- getTypeChar
```
public java.lang.String getTypeChar()
```
- gen_Declaration
```
public java.lang.String gen_Declaration(org.vishia.java2C.iWriteContent generateFile)
```
  Generates the C type declaration appropriate to the type info in this FieldData. It is the type code used for definition of the variable.
  - Simple embedded Arrays: At example type int. It returns only int because the complete definition is int name[123] or int name[] = { 1, 2, 3}
  If it is an simple array, the type code designating the pointer to the elements requires an additional '*'
  Returns:
  String with C type declaration.
- xxxwriteStruct
```
public java.lang.String xxxwriteStruct()
```
  Writes the structure of this instance to a *.stc-file. It is an class level identifier, see ClassData.classLevelIdents, or a return type or argument of a method, because only for such FieldData this method is called. See LocalIdents#writeStruct(int) and ClassData.Method#writeStruct()
  
  Returns:
  The content to write to *.stc-file. The form of string is the same described in the syntax Java2Cstc.zbnf.
- writeStruct
```
public java.lang.String writeStruct()
```
  Writes the structure of this instance to a *.stc-file. It is an class level identifier, see ClassData.classLevelIdents, or a return type or argument of a method, because only for such FieldData this method is called. See LocalIdents#writeStruct(int) and ClassData.Method#writeStruct()
  
  Returns:
  The content to write to *.stc-file. The form of string is the same described in the syntax Java2Cstc.zbnf.
- testAndcast
```
public java.lang.String testAndcast(CCodeData src,
                           char modeAccessDst)
```
  Tests whether a cast to the given FieldData type is necessary and executes it. The cast consists of two parts:
  - cast of type, for example to a base class type or another cast-able type
  - cast of access, for example from an enhanced reference to the reference
  If srcType is the same as this, no cast occurs, the value is returned direct. If srcType is a derive-able type of this, the cast is get with TODO.
  
  The cast of access is gotten calling testAndChangeAccess(char, String, char).
  
  This method prepares the access to a value. For assignments this method is used too, but the assignment has to produce code for setting, see StatementBlock.gen_AssignCheckCast(CCodeData, String, CCodeData).
  Parameters:
  srcType - The type of the value
  value - The value string.
  src - The Expression with its type and access modes
  modeAccessDst - A deviating mode of access for the destination or '.'. If '.', the #modeAcess of this is valid.
  
  Returns:
  The value itself if no cast is necessary
- testAndChangeAccess
```
public static java.lang.String testAndChangeAccess(char modeAccessDst,
                                   java.lang.String sSrc1,
                                   char modeAccessSrc)
```
  Changes the access. The '@' is handled like '*', because the building of enhanced reference is done outside.
  
  Parameters:
  modeAccessDst - Necessary access, ones of chars &*@~%?, see modeAccess
  sSrc1 - The cCode of src
  modeAccessSrc - Existing access of sSrc1
  
  Returns:
- toString
```
public java.lang.String toString()
```
  builds a String representation especially to test under eclipse.
  
  Overrides:
  
  toString in class java.lang.Object

Class FieldData

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sVersion

typeClazz

keyClazz

elementClazz

instanceClazz

declaringClazz

modeStatic

fixArraySizes

modeArrayElement

modeAccess

Method Detail

getClassLevel

getDimensionArray

getFixSizeStringBuffer

getOuterLevel

getName

getTypeName

getTypeChar

gen_Declaration

xxxwriteStruct

writeStruct

testAndcast

testAndChangeAccess

toString