Altair EEvision™

EDB Json API

The C Language API

The EDB Json API consists of two query functions, that are defined in the C header file edbjson.h (use #include "edbquery.h" to include the header file into your C application).

enum EdbPrintJsonFlags {
     EdbPrintJsonFUTF8 = 0x01,
     EdbPrintJsonFFlat = 0x02
};
EdbBool  EdbPrintJsonObj(  FILE*, Edb*, unsigned flags, EdbObject*);
EdbBool  EdbPrintJsonList( FILE*, Edb*, unsigned flags, unsigned otypes);
EdbBool  EdbPrintJsonOList(FILE*, Edb*, unsigned flags, EdbObjectList*, unsigned otypes);
EdbBool  EdbPrintJsonListByName(FILE*,Edb*,unsigned flags,const char*,unsigned otypes);
EdbBool  EdbPrintJson150(FILE*, Edb*, unsigned flags, int argc, const char* argv[]);

All functions accept an FILE pointer to an open writable file (e.g. from fopen) and a pointer to the Edb data-base and "flags", that can be 0 or an or-combination of EdbPrintJsonFUTF8 and EdbPrintJsonFFlat. The EdbPrintJsonObj gets a pointer to the EdbObject to be printed. The EdbPrintJsonList gets an "otypes" bit-vector defining the object types to be printed. The EdbPrintJsonOList gets a list of pointers to EdbObjects to be printed (plus an optional "otypes" bit-vector for additional filtering). All three functions support these flags:

EdbPrintJsonFUTF8

print all non-ascii characters in UTF-8 instead of printing the unicode characters in the standard Json "\uxxxx" syntax.

EdbPrintJsonFFlat

don't print the containment of objects, just print each object by itself; but without this flag, "contained" objects are printed in-place in a nested way: Components contain all its Connectors; Connectors contain all its Cavities; Multicore contain all its sub-node Multicore forming a Multicore-tree.

The EdbPrintJsonObj

Print the given EdbObject as a Json object with key-value pairs. Here is an output example for an EdbConnector (with the EdbPrintJsonFFlat flag):

  {
    "otype": "connector",
    "id": 8,
    "name": "P10",
    "partner": 11,
    "parent": 7,
    "cavities": [9,10]
  }

Here is an output example for the same EdbConnector (but without the EdbPrintJsonFFlat flag, so you can see the contained Cavities are also printed in-place):

  {
    "otype": "connector",
    "id": 8,
    "name": "P10",
    "partner": 11,
    "parent": 7,
    "cavities": [{
        "otype": "cavity",
        "id": 9,
        "name": "4",
        "partner": 12,
        "parent": 8,
        "joined": [17]
      }, {
        "otype": "cavity",
        "id": 10,
        "name": "5",
        "parent": 8
      }]
  }

Json key-value pairs

A Json object (that turns into a JavaScript object when it is parsed) is basically a set of key-value pairs. Each Edb Object is printed as a Json object. There is a set of fields common to all Edb Objects:

    "attrs": {
        "power": "5V",
        "notes": ["A", "B", "C"],
        "descr": "Master Power",
      }

A Component object provides these additional fields:

A Connector object provides these additional fields:

A Cavity object provides these additional fields:

A Wire object provides these additional fields:

A Multicore object provides these additional fields:

A Module object provides these additional fields:

The EdbPrintJsonList

Print a Json list with all Edb Objects that matches the object type(s) as given by the "otypes" bit-vector argument. If "otypes" is 0, then print all Edb Objects, that means print the full Edb data-base. If e.g. the bit (1<<OTWire) is set in otypes, then print all Edb Wire objects. If e.g. the bits (1<<OTWire) and (1<<OTComponent) are set in otypes, then print all Edb Components and all Edb Wires.

The flag EdbPrintJsonFFlat defines if the containment is printed in-place or not, as described above. If EdbPrintJsonFFlat is not set, then the containment is printed as Components contain Connectors and Connectors contain Cavities with these consequences: if Components are not marked in otypes, then neither Connectors nor Cavities can be printed (regardless if they are marked in otypes or not); if Connectors are not marked in otypes, then Cavities can not be printed (regardless if they are marked in otypes or not).

The list of Json objects are printed according to the description above.

The EdbPrintJsonOList

Print a Json list with all Edb Objects that are given in the list argument (if the "otypes" bit-vector argument is non-zero, then non-matching objects are skipped). The flag EdbPrintJsonFFlat defines if the containment is printed in-place or not, as described above. The list of Json objects are printed according to the description above.

The EdbPrintJsonListByName

Similar to EdbPrintJsonList above, print a Json list with all Edb Objects that matches the object type(s) as given by the "otypes" bit-vector argument. and matches the given name.

The EdbPrintJson150

Print a Json list with the strings, as given by argv - followed by those config-module that don't have an expr attribute. There is only one caller for this PrintJson150() that will pass the expr attribute's Boolean variables through the argv argument.

The Tcl Language API

set edb [edb new]

We assume $edb “points” to a loaded database.

$edb json flags -obj $obj fname
$edb json flags  -id $id  fname
$edb json flags                    fname
$edb json flags             otypes fname
$edb json flags -name $name        fname
$edb json flags -name $name otypes fname

These Tcl commands will print Json format into the file given as file-name fname by calling EdbPrintJsonObj(), EdbPrintJsonList() or EdbPrintJsonListByName().

The first and second commands will call EdbPrintJsonObj(). The third command will call EdbPrintJsonList() with otypes = 0 (print all). The forth command will call EdbPrintJsonList() with otypes set from an or-combinations of bits corresponding to the otypes options. The fifth and sixth commands will call EdbPrintJsonListByName().

Here is a list of the supported flags and otypes:

$edb json flags -olist $list        fname
$edb json flags -olist $list otypes fname

These Tcl commands will print Json format into the file given as file-name fname by calling EdbPrintJsonOList() with $list expected to be a Tcl list of data-base objects. In this mode, the otypes is usually empty (but can be set to filter certain objects by types).

$edb json flags -j150 $arg1 $arg2 ... fname

This Tcl command will call EdbPrintJson150().