OdgReader

java.lang.Object
- org.vishia.fbcl.readOdg.OdgReader

public class OdgReader
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) OFBconv.CmdArgs`	`args`
`(package private) static java.util.Comparator<XY_FBcl>`	`compareX`
`(package private) static java.util.Comparator<XY_FBcl>`	`compareX2`
`(package private) int`	`currPage`
`static java.util.Map<java.lang.String,FBkind_FBcl>`	`idxFBkindFromStyle` Assignment between style string in LibreOffice odg and the `EBlock`
`(package private) java.util.Map<java.lang.String,OdgModule>`	`idxOdgMdl` Index of all Modules which are available here.
`static java.util.Map<java.lang.String,PinKind_FBcl>`	`idxPinKindFromStyle` Assignment between style string in LibreOffice odg and the `PinKind`
`(package private) java.util.List<OdgGBlock>`	`listBlocks_x` List sorted to left top positions of all graphic block frames.
`(package private) java.util.List<OdgGBlock>`	`listBlocks_y` List sorted to left top positions of all graphic block frames.
`(package private) LogMessage`	`log`
`private OdgModule`	`odgMdlCurr` The current module of the page, also valid for the next pages without module name.
`(package private) Prj_FBcl`	`prj`
`(package private) long`	`timeEnd`
`(package private) long`	`timeGatherGraphic`
`(package private) long`	`timeOutFBcl`
`(package private) long`	`timeReadXml`
`(package private) long`	`timeSortData`
`(package private) long`	`timeStart`
`static java.lang.String`	`version` Version, License and History: Use own `OdgModule#idxGExprVarByName` for variable after expression and their free usage in the module's graphic.
`protected XmlJzReader`	`xmlReader`
`private XmlForOdg`	`xOdgCurr`

Constructor Summary

Constructors
Constructor and Description

OdgReader(Prj_FBcl prj, OFBconv.CmdArgs args, LogMessage log)

Constructors
Constructor and Description
`OdgReader(Prj_FBcl prj, OFBconv.CmdArgs args, LogMessage log)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private OdgGPin`	`addExprInput(OdgGBlock fbg, OdgShape shape, OdgModule odgMdl)` Adds an expression part or an expression connection input.
`private void`	`addExprOutVar(OdgShape shape, OdgModule odgMdl)`
`private void`	`addFbgxy(OdgGBlock fbg)` Adds a `OdgGBlock` with positions to the lists `listBlocks_x` and `listBlocks_y`.
`private OdgGPin`	`addGPinToGBlock(PinKind_FBcl pinKind, OdgGBlock fbg, OdgShape shape, OdgModule odgMdl)` Before used only as addExprOutput Adds a pin to the FBexpr `OdgGBlock`
`private OdgGPin`	`addTHIZexpr(OdgGBlock fbg, OdgShape shape, OdgModule odgMdl)`
`static void`	`analyzeXmlStruct(java.io.File fXmlIn)` Analyzes the given XML file example and creates a proper xmlcfg.xml file from that.
`private void`	`assignFBlockNameTypeIdCreateFBlock(OdgShape shape, OdgGBlock fbg, OdgModule odgMdl)` Creates the FBlock(s) due to the GBlock either with given text in GBlock or with the extra provided ofnClassTypeName shape
`private void`	`assignFreeVarToExpr(OdgNameTypeArray freeVar, OdgModule odgMdl)` Merge pins which presents free variables with the OdgPinInstance used as variable after expression or as variable as output of return and reference pins.
`private void`	`associateColumnsToFbg()`
`static int`	`binarySearchX(java.util.List<OdgGBlock> list, int x)` Note: Use only one position, x1 for both comparison
`static int`	`binarySearchY(java.util.List<OdgGBlock> list, int y)`
`private void`	`checkStateEnclosing(OdgGState gState, OdgModule odgMdl)` Adds the `OdgGBlock.sName` of a found enclosing state to the given state.
`void`	`completeLastModuleBuildFBclData(XmlForOdg xOdg)` Completes the full read module last module after read all files.
`private void`	`createXref(java.lang.String name, java.lang.String id, java.lang.String sPosxy, XY_FBcl xy, OdgModule odgMdl)` Gets or creates a `OdgXref` in `OdgModule#idxXrefByName` and creates a `OdgGBlock` which refers the Xref als fbb and stores the `OdgGBlock` in `#idxGBlockById` to find it for connections and stores it in `#idxXrefGraphicByName` to find it for output-odg (only for report).
`private static java.lang.String`	`detectFuncSpec(java.lang.String name, char[] spec)`
`void`	`errorMsg(java.lang.String msg, java.lang.Object... params)`
`private void`	`gatherConnection(OdgPage page, OdgModule odgMdl, XmlForOdg.Draw_connector xmlConnection, XmlForOdg xOdg, java.util.Map<java.lang.String,java.lang.String> idxStyle)` Read out the connection info from the odg graphic.
`private void`	`gatherDemuxPin(OdgGBlock fbg, OdgShape shape, OdgModule odgMdl, XmlForOdg xOdg)`
`private void`	`gatherExprPin(OdgGBlock fbg, OdgShape shape, OdgModule odgMdl, XmlForOdg xOdg)` Reads out the data for an expression in from the given shape.
`private void`	`gatherFBlockPin(OdgGBlock fbg, OdgShape shape, OdgModule odgMdl)` Processes a shape which has `OdgShape.ePin` recognized as FBlock pin.
`private OdgGBlock`	`gatherFBlockShape(OdgShape shape, OdgModule odgMdl)` Gather a main block shapes in the graphic.
`private void`	`gatherFreeText_drawFrame_inGroup(XmlForOdg.Draw_g group, XmlForOdg xOdg, OdgGBlock fbi, java.util.Map<java.lang.String,java.lang.String> idxStyle)` A free text field in a group.
`void`	`gatherGraphic(XmlForOdg xOdg, java.lang.String fName)` Evaluates the content from the parsed XML file stored in XmlForOdg and builds GBlocks and GPins.
`private void`	`gatherStates(OdgPage page, OdgModule odgMdl)`
`void`	`infoMsg(java.lang.String msg, java.lang.Object... params)`
`java.lang.Iterable<OdgModule>`	`iterOdgModule()`
`private OdgGPin`	`prcFBexprOutput(OdgGBlock fbsrc, OdgGPin piDst, XY_FBcl posXY, java.lang.String text, java.lang.String posXySrc, OdgModule odgMdl)` This operation is called in `#gatherConnection(org.vishia.fbcl.readOdg.xml.XmlForOdg.Draw_connector, XmlForOdg)` for a connection for output from an expression without extra pin.
`private void`	`prepareAlias(java.lang.String sAliasLines, XY_FBcl xy, OdgModule odgMdl, java.lang.String sXmlId)` Read the content of a 'ofbAlias' shape.
`private void`	`processGraphicConnectionsOfAllModulePages(OdgModule odgMdl, XmlForOdg xOdg)` Processes all graphic connections from XML and associated it to the `OdgGBlock` pins.
`XmlForOdg`	`readOdgFile(java.io.File fIn)` Reads one odg file and converts it in the adequate `OdgModule` instances as controlled by the ofpTitle shape.
`private XmlForOdg`	`readXml(java.io.File fInOdg)` Reads completely the content.xml from the given odg file and stores the data in the returned instance.
`(package private) OdgGBlock`	`searchEnclosingGBlock(XY_FBcl pos)` Search a block which encloses full the pos, for state in state etc.
`(package private) OdgGBlock`	`searchFbg(XY_FBcl pos)` Searches a given graphic block with positions pos in the `listBlocks_x`, `listBlocks_y` to associated this graphic element to the found block The Algorith searches in the `listBlocks_x` etc with `binarySearchX(List, int)` and `binarySearchY(List, int)` with the right bottom edge first.
`private void`	`storeConnectorId(XmlForOdg.Draw_connector conn, XmlForOdg xOdg, OdgModule odgMdl, int page)`

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, License and History:
    - Use own OdgModule#idxGExprVarByName for variable after expression and their free usage in the module's graphic. See version text in OdgReader. The problem is, that the expressions to the variable has not unique name strategies, hence use the variable name as key. Changed in
      gatherExprPin(OdgGBlock, OdgShape, OdgModule, XmlForOdg): their the variable after expression is first detected with its correct name as graphic pin.
      assignFreeVarToExpr(OdgNameTypeArray, OdgModule): here the free variable are correct associated.
    - ... some more
    - 2022-06-29 created with first analyzing xml file.
    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
  - idxFBkindFromStyle
```
public static final java.util.Map<java.lang.String,FBkind_FBcl> idxFBkindFromStyle
```
    Assignment between style string in LibreOffice odg and the EBlock
  - idxPinKindFromStyle
```
public static final java.util.Map<java.lang.String,PinKind_FBcl> idxPinKindFromStyle
```
    Assignment between style string in LibreOffice odg and the PinKind
  - log
```
final LogMessage log
```
  - args
```
final OFBconv.CmdArgs args
```
  - prj
```
final Prj_FBcl prj
```
  - xmlReader
```
protected final XmlJzReader xmlReader
```
  - odgMdlCurr
```
private OdgModule odgMdlCurr
```
    The current module of the page, also valid for the next pages without module name. It comes from #gatherofbTitle(org.vishia.fbcl.readOdg.xml.XmlForOdg.Draw_custom_shape, XmlForOdg) or the style "ofpTitle".
  - xOdgCurr
```
private XmlForOdg xOdgCurr
```
  - idxOdgMdl
```
final java.util.Map<java.lang.String,OdgModule> idxOdgMdl
```
    Index of all Modules which are available here. Important if different modules are contained on different pages.
  - currPage
```
int currPage
```
  - timeStart
```
long timeStart
```
  - timeReadXml
```
long timeReadXml
```
  - timeGatherGraphic
```
long timeGatherGraphic
```
  - timeSortData
```
long timeSortData
```
  - timeOutFBcl
```
long timeOutFBcl
```
  - timeEnd
```
long timeEnd
```
  - listBlocks_x
```
java.util.List<OdgGBlock> listBlocks_x
```
    List sorted to left top positions of all graphic block frames. It enables associations of other blocks (pins, expressionParts) to the frame block (Expression, FBlock) due to its position.
    
    See Also:
    
    #addFbgxy(org.vishia.fbcl.readOdg.XY_FBcl), It is cleaned on any new page!
  - listBlocks_y
```
java.util.List<OdgGBlock> listBlocks_y
```
    List sorted to left top positions of all graphic block frames. It enables associations of other blocks (pins, expressionParts) to the frame block (Expression, FBlock) due to its position.
    
    See Also:
    
    #addFbgxy(org.vishia.fbcl.readOdg.XY_FBcl), It is cleaned on any new page!
  - compareX
```
static java.util.Comparator<XY_FBcl> compareX
```
  - compareX2
```
static java.util.Comparator<XY_FBcl> compareX2
```
- Constructor Detail
  - OdgReader
```
public OdgReader(Prj_FBcl prj,
                 OFBconv.CmdArgs args,
                 LogMessage log)
          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - analyzeXmlStruct
```
public static void analyzeXmlStruct(java.io.File fXmlIn)
                             throws java.io.IOException
```
    Analyzes the given XML file example and creates a proper xmlcfg.xml file from that. This is a test for improving the cfg file. In 2023-05 it is started but then not finished. Goal is, using a text template instead the maybe sophisticated xml template as config to read Xml files.
    
    Parameters:
    
    fXmlIn - The example file. The xmlCfg will be write beside as xmlcfg.xml
    
    Throws:
    
    java.io.IOException
  - readOdgFile
```
public XmlForOdg readOdgFile(java.io.File fIn)
```
    Reads one odg file and converts it in the adequate OdgModule instances as controlled by the ofpTitle shape.
    
    Parameters:
    
    fIn - The file to read (OpenOffice standard)
  - iterOdgModule
```
public java.lang.Iterable<OdgModule> iterOdgModule()
```
  - readXml
```
private XmlForOdg readXml(java.io.File fInOdg)
                   throws java.io.IOException
```
    Reads completely the content.xml from the given odg file and stores the data in the returned instance.
    
    Parameters:
    
    fInOdg - The file to read
    
    Returns:
    
    the read data from XML
    
    Throws:
    
    java.io.IOException - On file read problems
  - gatherGraphic
```
public void gatherGraphic(XmlForOdg xOdg,
                          java.lang.String fName)
```
    Evaluates the content from the parsed XML file stored in XmlForOdg and builds GBlocks and GPins. That are the counterparts for XML data in the graphic, it is still Graphic representation. But for a completed module (a new module comes in the next page) OdgModule.buildFBclData() is called, which builds the graphic independent mapping of the FBlock data.
    The first build graphic mapping is done in:
    - OdgGBlock stored in OdgModule.idxGBlock and also OdgModule.idxGBlockById etc. for connections
    - OdgGPin stored firstly to the GBlock in OdgGBlock.idxPin with detection of affiliation because of its graphic position into or near to the GBlock, and also in OdgModule.idxGMdlPins for module pins and also OdgModule.idxGPinById for connections
    But with detected names on OdgGBlock also the FBcl-instances of the FBlock_FBcl are created or associated, referenced by Write_FBlock_FBwr, and they are aggregated in the Write_Module_FBwr.
    
    With detected type names on OdgGBlock also the instances of the FBtype_FBcl referenced by Write_FBtype_FBwr are created and they are aggregated in the FBlock_FBcl.
    
    First the FBlock_FBcl, also FBtype_FBcl are not completed, and also the Pin_FBcl are not firstly created yet. The pins will be created in the called OdgModule.buildFBclData() for each module after parsing of all its pages.
    
    called from readOdgFile(File) XmlForOdg.Draw_page_Base#
    calls:
    - read page per page from XML: xOdg: XmlForOdg.getContent() => drawing : XmlForOdg.Office_drawing __getContent__
      FOR: drawing: XmlForOdg.Office_drawing#get_draw_page() => XmlForOdg.Draw_page __xpage__
    - page = new OdgPage.OdgPage(int, org.vishia.fbcl.readOdg.xml.XmlForOdg.Draw_page, XmlForOdg) __newPage__
    - page: OdgPage#gatherTitle(org.vishia.fbcl.readOdg.xml.XmlForOdg.Draw_page, XmlForOdg) __gatherTitle__
    - IF checks whether it is a new module, if so, then call for the last module:
      processGraphicConnectionsOfAllModulePages(OdgModule, XmlForOdg) __prcGraphicConn__
      OdgModule.buildFBclData() __buildFBcl__
    - LOG: '==== gather graphic page: %d, module name = %s'
    - CHECK OdgPage.shTitle if starts with '#', ignore page. __TitleDisabled__
    - else do for the XML-page:
    - page: OdgPage#gatherDisabledAreas(org.vishia.fbcl.readOdg.xml.XmlForOdg.Draw_page, XmlForOdg) __gthDisAreas__
    - page: OdgPage#gatherShapes(org.vishia.fbcl.readOdg.xml.XmlForOdg.Draw_page, XmlForOdg), it ignores all shapes inside in disable areas: __gthShapes__
    - If the odgMdlCurr is null then create the new OdgModule for the page and next pages, but check whether the module is already existing: idxOdgMdl. Then we have a faulty page order. __newOdgModule__
    - Add the page to OdgModule.listPage __addListPage__
    - FOR: OdgPage.shImport => #prepareAlias(String, String, OdgModule) __shImport__
    - FOR: OdgPage.shExpr, FOR: OdgPage.shMdlPins, FOR: OdgPage.shDemux, FOR: OdgPage.shFBlock, FOR: OdgPage.shReq, FOR: OdgPage.shDocu
      for all this one after another: => gatherFBlockShape(OdgShape, OdgModule) __gthFBlockShapes__
    - FOR: OdgPage.shFBname => __gthFBname__
      OdgGBlock fbg = #searchFbg(OdgShape, String)
      IF not found, LOG:'dangling ofnClassTypeName ignored'
      IF FBlock with same name always created: LOG: 'ERROR graphic, has already a fbname designation, ofnClassTypeName ignored:'
      assignFBlockNameTypeIdCreateFBlock(OdgShape, OdgGBlock, OdgModule)
      Then the FBlock is created. Note: The FBlock is also created in gatherFBlockShape(OdgShape, OdgModule) if a name is detected in its GBlock shape.
    - FOR: all OdgPage.shEvPin: __shEvinPins__
      OdgGBlock fbg = #searchFbg(OdgShape, String)
      IF: fbg not found, error msg.
      ELSE: gatherFBlockPin(OdgGBlock, OdgShape, OdgModule) as event pin.
    - FOR: OdgPage.shCBlock => do adequate, that are the small connection points to a FBlock instead GBlock glue points: __shCBlock__
    - FOR: OdgPage.shPin => #prepareAlias(String, String, OdgModule) __shPins__ Here TODO do not create the pins here!! Do it later after connection.
      OdgGBlock fbg = #searchFbg(OdgShape, String)
      IF: fbg not found, then kind == 'V' 'Z': addExprOutVar(OdgShape, OdgModule), a free variable to access.
      ELSE: check OdgGBlock.eKindBlock: The style in graphic:
      'ofbAccess': #gatherAccessPin(OdgGBlock, OdgShape, OdgModule, XmlForOdg)
      'ofbExpr': gatherExprPin(OdgGBlock, OdgShape, OdgModule, XmlForOdg)
      'ofbFBlock': gatherFBlockPin(OdgGBlock, OdgShape, OdgModule)
      'ofbMdlPin': gatherFBlockPin(OdgGBlock, OdgShape, OdgModule)
      else: gatherFBlockPin(OdgGBlock, OdgShape, OdgModule)
    - do adequate: FOR: OdgPage.shDemuxPin FOR: OdgPage.shExprPart
    - FOR: OdgPage.shExprOut FOR: OdgPage.shXref FOR: OdgPage.shConnPoint
    - FOR: OdgPage.shAttr
    - FOR: XmlForOdg.Draw_page#get_draw_connector(): __storeConn__
      storeConnectorId(org.vishia.fbcl.readOdg.xml.XmlForOdg.Draw_connector, XmlForOdg, OdgModule, int)
      It is for connections immediately of connector end points in draw.
    - associateColumnsToFbg()
    - processGraphicConnectionsOfAllModulePages(OdgModule, XmlForOdg) for the last module, but this is faulty here because the module can be continued with the next file: TODO
    Parameters:
    
    xOdg - The whole paresed and prepared XML data
    
    fName - file name for log
  - gatherStates
```
private void gatherStates(OdgPage page,
                          OdgModule odgMdl)
```
  - gatherFBlockShape
```
private OdgGBlock gatherFBlockShape(OdgShape shape,
                                    OdgModule odgMdl)
```
    Gather a main block shapes in the graphic. It is ofbComment, ofbRequirement, ofbAlias, ofbFBlock, ofbExpression, ofbMdlPins
    
    Parameters:
    
    eBlock - it is the style of the graphic converted to this enum. Used: P O C X D R I ( FBkind_FBcl.cfn ) other should not applied, test it before.
    
    shape - The shape read from XML
    
    odgMdl - module to store results.
    
    Returns:
  - assignFBlockNameTypeIdCreateFBlock
```
private void assignFBlockNameTypeIdCreateFBlock(OdgShape shape,
                                                OdgGBlock fbg,
                                                OdgModule odgMdl)
```
    Creates the FBlock(s) due to the GBlock either with given text in GBlock or with the extra provided ofnClassTypeName shape
    
    Parameters:
    
    shape - either the ofbFBlock or the ofnCalssTypeName shape.
    
    fbg - The GBlock already created.
    
    odgMdl - The module
  - gatherFBlockPin
```
private void gatherFBlockPin(OdgGBlock fbg,
                             OdgShape shape,
                             OdgModule odgMdl)
```
    Processes a shape which has OdgShape.ePin recognized as FBlock pin.
    
    Parameters:
    
    fbg - The found OdgGBlock where the pin shape is localized to or member of a group The Block in the graphic appearance, may be a FBlockType or a FBlock. Note that both a FBlock and a FBlockType can be occur more as one time in the graphic. But the instance of FBlock_FBcl in OdgGBlock.fbw and the associated type instance of FBtype_FBcl in OdgGBlock.fbtw is unique, searched by name. This is done because the rectangle of the FBlock (style "ofbFBlock") and the name (style "ofnClassTypeName" and style "ofnClassObjName") is gathered before, builds the fbg instance.
    
    shape - The shape which has OdgShape.ePin recognized as FBlock pin
    
    odgMdl - the module
  - gatherDemuxPin
```
private void gatherDemuxPin(OdgGBlock fbg,
                            OdgShape shape,
                            OdgModule odgMdl,
                            XmlForOdg xOdg)
```
  - gatherExprPin
```
private void gatherExprPin(OdgGBlock fbg,
                           OdgShape shape,
                           OdgModule odgMdl,
                           XmlForOdg xOdg)
```
    Reads out the data for an expression in from the given shape. It can also be an event pin on the expression. See OdgModule#completePins(OdgReader)
    
    Parameters:
    
    xShape - the shape in the xml data
    
    fbg - used only for new OdgGPin
    
    xOdg - all xml data, only used: XmlForOdg#getStyleFromid(String).
  - gatherFreeText_drawFrame_inGroup
```
private void gatherFreeText_drawFrame_inGroup(XmlForOdg.Draw_g group,
                                              XmlForOdg xOdg,
                                              OdgGBlock fbi,
                                              java.util.Map<java.lang.String,java.lang.String> idxStyle)
```
    A free text field in a group. "ofnClassTypeName" and "ofnClassObjName" are already gathered and ignored here. All other cause an error yet. Possible: Define more text field types for some more properties. But this is deprecated. It is better to have a rectangle with text. Hence delete it!
    
    Parameters:
    
    group -
    
    xOdg -
    
    fbi -
  - prepareAlias
```
private void prepareAlias(java.lang.String sAliasLines,
                          XY_FBcl xy,
                          OdgModule odgMdl,
                          java.lang.String sXmlId)
```
    Read the content of a 'ofbAlias' shape.
    - One per line, it creates an entry in Prj_FBcl#idxAlias
    Parameters:
    
    listImport -
    
    posxy -
    
    odgMdl -
  - createXref
```
private void createXref(java.lang.String name,
                        java.lang.String id,
                        java.lang.String sPosxy,
                        XY_FBcl xy,
                        OdgModule odgMdl)
```
    Gets or creates a OdgXref in OdgModule#idxXrefByName and creates a OdgGBlock which refers the Xref als fbb and stores the OdgGBlock in #idxGBlockById to find it for connections and stores it in #idxXrefGraphicByName to find it for output-odg (only for report). It returns nothing, the Xref will be found on connection.
    
    Parameters:
    
    name -
    
    id -
    
    sPosxy -
  - storeConnectorId
```
private void storeConnectorId(XmlForOdg.Draw_connector conn,
                              XmlForOdg xOdg,
                              OdgModule odgMdl,
                              int page)
```
  - detectFuncSpec
```
private static java.lang.String detectFuncSpec(java.lang.String name,
                                               char[] spec)
```
  - gatherConnection
```
private void gatherConnection(OdgPage page,
                              OdgModule odgMdl,
                              XmlForOdg.Draw_connector xmlConnection,
                              XmlForOdg xOdg,
                              java.util.Map<java.lang.String,java.lang.String> idxStyle)
```
    Read out the connection info from the odg graphic.
    - At last it stores the connection in OdgGPin.connections via OdgGPin.addConnection(OdgConnection, LogMessage).
    - The OdgConnection.eKind is adjusted by the OdgGPin.kind of the source pin and also the destination pin. Hence a simple "Default drawing style" is possible to use if the kind of pins can determine the kind of the connection.
    - For some connections to the OdgGBlock not an OdgGBlock.fbPinDst is created, instead the dedicated pin is created due to the kind of connection:
      
      evin "set" for any incoming connection to a state
      ... TODO for deveopment and docu, sometimes 'piDst = fbdst.fbPinDst = new OdgGPin(...) is called,
      but sometimes also the OdgGPin.pinType is set.
      this should be systematized, proper arranged in a unique kind.
    - creation of OdgGPin is never be done here, because information about connections via XRef and Demux are not evaluated here. It is better always use the OdgGBlock.fbPinDst to connect first, and create the pins later after OdgModule#connectViaDemuxXref(OdgGPin, OdgGPin, String, String, int, int).
    Parameters:
    
    page - It works page by page with the given page stored in OdgModule.listPage. This list was filled in gatherGraphic(XmlForOdg, String) for this module.
    
    odgMdl - the module
    
    xmlConnection - data of connection from odg.xml, this is element of OdgPage.xpage and their XmlForOdg.Draw_page#get_draw_connector(). It is one connection on the page.
    
    xOdg - whole xml result only used to get the style TODO shift to calling env.
    
    xmlStyle - Association of the inner style id to the common style id in styles.xml, it is the resolving from direct formatted styles.
  - prcFBexprOutput
```
private OdgGPin prcFBexprOutput(OdgGBlock fbsrc,
                                OdgGPin piDst,
                                XY_FBcl posXY,
                                java.lang.String text,
                                java.lang.String posXySrc,
                                OdgModule odgMdl)
```
    This operation is called in #gatherConnection(org.vishia.fbcl.readOdg.xml.XmlForOdg.Draw_connector, XmlForOdg) for a connection for output from an expression without extra pin. It is either a constant expression or a PinKind_FBcl.Dout.
    
    Parameters:
    
    fbsrc - the graphic block which is connected as source
    
    piDst - the dst of the connection to enter a constant value.
    
    text - on the connection, usual null
    
    posXySrc - TODO ??
    
    Returns:
  - associateColumnsToFbg
```
private void associateColumnsToFbg()
```
  - binarySearchX
```
public static int binarySearchX(java.util.List<OdgGBlock> list,
                                int x)
```
    Note: Use only one position, x1 for both comparison
    
    Parameters:
    
    list -
    
    Returns:
  - binarySearchY
```
public static int binarySearchY(java.util.List<OdgGBlock> list,
                                int y)
```
  - addFbgxy
```
private void addFbgxy(OdgGBlock fbg)
```
    Adds a OdgGBlock with positions to the lists listBlocks_x and listBlocks_y. It adds sorted using Collections.binarySearch(List, Object, Comparator) using the compareX and #compareY
    
    Parameters:
    
    fbg - add this instance.
    
    Since:
    
    2025-08-19: for searchEnclosingGBlock(...) if some blocks have the same x1-position: The order is now the y-position. It means it founds a GBlock as enclosing as inner GBlock first backwards, if it have a greater y position. This is usual an inner GBlock of the inner GBlock outside for both, and hence the more correct. This algorithm can be improved by checking completely, whether a found block with same x1 is an inner GBlock of already stored GBlocks.
  - checkStateEnclosing
```
private void checkStateEnclosing(OdgGState gState,
                                 OdgModule odgMdl)
```
    Adds the OdgGBlock.sName of a found enclosing state to the given state. It searches the enclosing state using searchFbg(XY_FBcl). As result:
    - All states are listed by name in OdgGState#idxGStateByName with the name as written in the graphic inclusively completion of the name with the parent state due to nesting. If a state with same name would be twice, it is stored with name-parent*77 with a number. This is a unique state name for each GState block.
    - For the enclosing state the OdgGState.gStateChildren and OdgGState.gStateDefaultChildren are filled.
    Parameters:
    
    gState - called for all states of this page only.
  - searchFbg
```
OdgGBlock searchFbg(XY_FBcl pos)
```
    Searches a given graphic block with positions pos in the listBlocks_x, listBlocks_y to associated this graphic element to the found block
    The Algorith searches in the listBlocks_x etc with binarySearchX(List, int) and binarySearchY(List, int) with the right bottom edge first. It means the first block found is that FBlock which top left position is less or equal the right bottom edge of pos
```
                 +--+                   
                 |  | pos               
                 +--+....+-------------+
                    :    |listFBlocks_y|
                    :    +-------------+
                    :
                    +-------------+        
                    |listFBlocks_x|        
                    +-------------+
 
```
    To assure that both pos.x2 and pos.y2 touch the same block, now it is iterated backward first one step over listBlocks_x and in this step over the whole range of listBlocks_y backward, etc:
```
   +-------------+       
   |listFBlocks_x|       
   +-------------+
+-------------+  :
|listFBlocks_y|  :
+-------------+..+--+                                   
                 |  | pos                 
                 +--+                  
 
```
    till the same block is found in both lists, which touches both the pos.
```
    +-------------+
    |  FBlock    ++-+
    +------------++ | pos
                 +--+     
 
```
    Because the first binary search, and break if the same block is found, this search needs not too much time. The number of blocks in one page may be in range 100. Unfortunately the lists does not contain the right bottom border to limit search, hence it should go till 0. Because on position 0 they may be a block with right bottom edge touching the pos. This can be improved by notation the most right position of all blocks before in each block, maybe with an extra array (can be done in future to optimize).
    Parameters:
    
    pos - The area should only overlap one of the given graphic blocks. If the given block with pos overlaps two or more blocks, one of them is found. It means the behavior is not very deterministic. Avoid such situations in the graphic.
    
    Returns:
    
    null if no OdgGBlock exists with proper positions, else the proper graphic block
  - searchEnclosingGBlock
```
OdgGBlock searchEnclosingGBlock(XY_FBcl pos)
```
    Search a block which encloses full the pos, for state in state etc.
    
    Parameters:
    
    pos -
    
    Returns:
    
    FBlock encloses pos
  - addExprInput
```
private OdgGPin addExprInput(OdgGBlock fbg,
                             OdgShape shape,
                             OdgModule odgMdl)
```
    Adds an expression part or an expression connection input.
    
    Parameters:
    
    fbg - The graphic GBlock
    
    shape - The shape describing the ofpExprPart
    
    odgMdl - the module
    
    Returns:
    
    the pin for this FBlock_FBcl.din but first with odg specific data.
  - addTHIZexpr
```
private OdgGPin addTHIZexpr(OdgGBlock fbg,
                            OdgShape shape,
                            OdgModule odgMdl)
```
  - addGPinToGBlock
```
private OdgGPin addGPinToGBlock(PinKind_FBcl pinKind,
                                OdgGBlock fbg,
                                OdgShape shape,
                                OdgModule odgMdl)
```
    Before used only as addExprOutput Adds a pin to the FBexpr OdgGBlock
    
    Parameters:
    
    fbg - the GBlock
    
    shape - the shape
    
    odgMdl - the module
    
    Returns:
    
    the pin which is already added using OdgGBlock#putPin(OdgGPin, XY_FBcl) in OdgGBlock#idxPinInstance.
  - addExprOutVar
```
private void addExprOutVar(OdgShape shape,
                           OdgModule odgMdl)
```
  - assignFreeVarToExpr
```
private void assignFreeVarToExpr(OdgNameTypeArray freeVar,
                                 OdgModule odgMdl)
```
    Merge pins which presents free variables with the OdgPinInstance used as variable after expression or as variable as output of return and reference pins. Before: a pin which is used as variable is stored in this index. See addExprOutVar(OdgShape, OdgModule), all Shapes which's OdgShape.ePin is 'D', 'V' or 'Z' (ofpVout... or ofpZout) and which are not assigned to an expression shape, are stored in OdgModule.listFreeVar which its XML connection id in OdgNameTypeArray.pinC, and the name in this instance ...#descr. Because of the name, the OdgGPin with this name is searched in OdgModule.idxVarGPinByName, and the XML connection id is stored with the OdgGPin in OdgModule.idxGPinById
    
    Though, the variable pin is found by the XML connection id of the before free Shape.
    
    Parameters:
    
    freeVar - the description of the variable pin, OdgNameTypeArray.descr contains the name, OdgNameTypeArray.pinC contains the id. Due to OdgModule.listFreeVar.
    
    odgMdl - the module
  - processGraphicConnectionsOfAllModulePages
```
private void processGraphicConnectionsOfAllModulePages(OdgModule odgMdl,
                                                       XmlForOdg xOdg)
```
    Processes all graphic connections from XML and associated it to the OdgGBlock pins. First all connections in the XML are stored page by page in OdgPage.xpage of type XmlForOdg.Draw_page. This are the data original read from the content.xml via the config.xml. It contains the XML data for the element Reads all connections from XML file, for all pages of this module, because connections using Xref are related to different pages. TODO is it really necessary to handle connections via Xref here? Problem is, if a Module is dispersed over some files. Then the idxStyle is not the same over all. Hence this algorithm must call only from only one XML input file-
  - completeLastModuleBuildFBclData
```
public void completeLastModuleBuildFBclData(XmlForOdg xOdg)
```
    Completes the full read module last module after read all files. Hint: If one file begins with another module, then OdgModule.buildFBclData() is called for this current finished module. Then one file can contain exact one module, or also more as one modules, also if more as one files are read. But if a module uses more as one file, it is finished only after read all files.
  - errorMsg
```
public void errorMsg(java.lang.String msg,
                     java.lang.Object... params)
```
  - infoMsg
```
public void infoMsg(java.lang.String msg,
                    java.lang.Object... params)
```

Class OdgReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

idxFBkindFromStyle

idxPinKindFromStyle

log

args

prj

xmlReader

odgMdlCurr

xOdgCurr

idxOdgMdl

currPage

timeStart

timeReadXml

timeGatherGraphic

timeSortData

timeOutFBcl

timeEnd

listBlocks_x

listBlocks_y

compareX

compareX2

Constructor Detail

OdgReader

Method Detail

analyzeXmlStruct

readOdgFile

iterOdgModule

readXml

gatherGraphic

gatherStates

gatherFBlockShape

assignFBlockNameTypeIdCreateFBlock

gatherFBlockPin

gatherDemuxPin

gatherExprPin

gatherFreeText_drawFrame_inGroup

prepareAlias

createXref

storeConnectorId

detectFuncSpec

gatherConnection

prcFBexprOutput

associateColumnsToFbg

binarySearchX

binarySearchY

addFbgxy

checkStateEnclosing

searchFbg

searchEnclosingGBlock

addExprInput

addTHIZexpr

addGPinToGBlock

addExprOutVar

assignFreeVarToExpr

processGraphicConnectionsOfAllModulePages

completeLastModuleBuildFBclData

errorMsg

infoMsg