ReadStructure

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

```
public class ReadStructure
extends java.lang.Object
```
An instance of this class is filled with the result of parsing an *.stc file which contains the structure informations of a already translated file.
Such a file is parsed inside #readStructToClassData(String sClassFileName) called inside Java2C_Main#runrunFirstPass(java.io.File javaFile, boolean), if either the source *.java is not present to parse (for basics) or the destination file should not be generated because it exists and the source *.java file isn't newer than the already translated destination.

That routine parses the result and calls org.vishia.zbnf.ZbnfJavaOutput#setOutputStrict(Object result, ZbnfParseResultItem, Report). The result is this instance.
The syntax of parsing is given in the outside file Java2Cstc.zbnf in form:
```
 Structure::= J2C: structure of file-class: <$?fileName> { class  } \e.
 
 ClassData::= <*; ?nameJava> ; <$?nameC> ; 
 \{ [ fieldIdents \{ [{ field;  }] \}]
    [ typeIdents \{ [{  | class  }] \}]
    [ methods \{ [{  }] \}]
    [ InnerClass \{ [{ class  }] \}]
 \}.
 
 field::= <1*?modeAccess><1*?modeArrayElement><1*?modeStatic>;
          [{\[ [\?\?|<*\]?fixArraySizes>]\]}] ;
          <*; ?typeJava> ; <$?typeC> ; <$?name> ; 
          .
          
 type::= type; <$?typeName>.
 
 method::= method ; <*;?keyName> ; <$?javaName> ; <$?CName> ;
           return ;  
           [{ param (  ) }]
           .
 
```
. All syntax/semantic elements have a representation in this class, because org.vishia.zbnf.ZbnfJavaOutput#setOutputStrict(Object result, ZbnfParseResultItem, Report). sets the result of parsing directly in the instance result of this class.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ReadStructure.Zbnf_Cast`
`static class`	`ReadStructure.Zbnf_ClassData` Subclass to pour in the result of the `ClassData::=...` subsyntax.
`static class`	`ReadStructure.Zbnf_EnvIdent`
`static class`	`ReadStructure.Zbnf_Field` Subclass to pour in the result of the `field::=...` subsyntax.
`static class`	`ReadStructure.Zbnf_Method` Subclass to pour in the result of the `method::=...` subsyntax.
`static class`	`ReadStructure.ZbnfToplevel`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String sVersion
Version, history and license.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`sVersion` Version, history and license.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`postPrepare(ReadStructure.ZbnfToplevel zbnfToplevel)` Build the classData of the read stc-data.
`void`	`prepareCastTo(ReadStructure.Zbnf_Cast value, org.vishia.java2C.ClassData classData)`
`void`	`prepareClassData(ReadStructure.Zbnf_ClassData zbnfInput, ReadStructure.ZbnfToplevel zbnfToplevel, org.vishia.java2C.ClassData outerClassData)`
`FieldData`	`prepareField(ReadStructure.Zbnf_Field field, org.vishia.java2C.ClassData classData)`
`void`	`prepareMethod(ReadStructure.Zbnf_Method m, org.vishia.java2C.ClassData classData)`
`FieldData`	`prepareParam(ReadStructure.Zbnf_Field param, org.vishia.java2C.ClassData classData)`
`void`	`readStructToClassData(JavaSrcTreeFile javaSrc, java.lang.String sClassFileName, java.io.File fileStruct)` reads the structure of a class from a *.stc-File and save it to the `#userTypes`-`ClassData`.

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

Field Detail
- sVersion
```
public static final java.lang.String sVersion
```
  Version, history and license.
  - 2014-08-16 Hartmut chg: prepareClassData(Zbnf_ClassData, ZbnfToplevel, ClassData) invokes recursively for inner classes at end of routine, because the ClassData should be known for the inner classes via fileLevelIdents.
  - 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

Method Detail

readStructToClassData

public void readStructToClassData(JavaSrcTreeFile javaSrc,
                         java.lang.String sClassFileName,
                         java.io.File fileStruct)
                           throws java.io.FileNotFoundException,
                                  java.io.IOException,
                                  java.lang.IllegalArgumentException,
                                  java.lang.IllegalAccessException,
                                  java.lang.InstantiationException,
                                  java.text.ParseException

reads the structure of a class from a *.stc-File and save it to the #userTypes-ClassData.

Parameters:: sClassFileName - The name of the Java class.
Throws:: java.io.FileNotFoundException; java.io.IOException; java.lang.IllegalArgumentException; java.lang.IllegalAccessException; java.lang.InstantiationException; java.text.ParseException

postPrepare

public void postPrepare(ReadStructure.ZbnfToplevel zbnfToplevel)
                 throws java.lang.IllegalArgumentException,
                        java.lang.IllegalAccessException,
                        java.lang.InstantiationException,
                        java.text.ParseException,
                        java.io.FileNotFoundException,
                        java.io.IOException

Build the classData of the read stc-data.

Throws:: java.text.ParseException; java.lang.InstantiationException; java.lang.IllegalAccessException; java.lang.IllegalArgumentException; java.io.IOException; java.io.FileNotFoundException

prepareClassData

public void prepareClassData(ReadStructure.Zbnf_ClassData zbnfInput,
                    ReadStructure.ZbnfToplevel zbnfToplevel,
                    org.vishia.java2C.ClassData outerClassData)
                      throws java.lang.IllegalArgumentException,
                             java.lang.IllegalAccessException,
                             java.lang.InstantiationException,
                             java.text.ParseException

Throws:: java.lang.IllegalArgumentException; java.lang.IllegalAccessException; java.lang.InstantiationException; java.text.ParseException

prepareField

public FieldData prepareField(ReadStructure.Zbnf_Field field,
                     org.vishia.java2C.ClassData classData)
                       throws java.lang.IllegalArgumentException,
                              java.lang.IllegalAccessException,
                              java.lang.InstantiationException,
                              java.text.ParseException

Throws:: java.lang.IllegalArgumentException; java.lang.IllegalAccessException; java.lang.InstantiationException; java.text.ParseException

prepareMethod

public void prepareMethod(ReadStructure.Zbnf_Method m,
                 org.vishia.java2C.ClassData classData)
                   throws java.io.FileNotFoundException,
                          java.lang.IllegalArgumentException,
                          java.io.IOException,
                          java.lang.IllegalAccessException,
                          java.lang.InstantiationException,
                          java.text.ParseException

Throws:: java.io.FileNotFoundException; java.lang.IllegalArgumentException; java.io.IOException; java.lang.IllegalAccessException; java.lang.InstantiationException; java.text.ParseException

prepareCastTo

public void prepareCastTo(ReadStructure.Zbnf_Cast value,
                 org.vishia.java2C.ClassData classData)
                   throws java.text.ParseException

Throws:: java.text.ParseException

prepareParam

public FieldData prepareParam(ReadStructure.Zbnf_Field param,
                     org.vishia.java2C.ClassData classData)
                       throws java.io.FileNotFoundException,
                              java.lang.IllegalArgumentException,
                              java.io.IOException,
                              java.lang.IllegalAccessException,
                              java.lang.InstantiationException,
                              java.text.ParseException

Throws:: java.io.FileNotFoundException; java.lang.IllegalArgumentException; java.io.IOException; java.lang.IllegalAccessException; java.lang.InstantiationException; java.text.ParseException

Class ReadStructure

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sVersion

Method Detail

readStructToClassData

postPrepare

prepareClassData

prepareField

prepareMethod

prepareCastTo

prepareParam