WDB (Wave Database) API Header File to Create and Access a WDB

API Functions to create a file or in memory Wave Database and to process the waveform data.

WDB Datatypes

Time Data

All time data uses the WdbTime data type.

typedef zUInt64 WdbTime;
#define WdbTimeInvalid  ((WdbTime)(-1))
#define WdbTimeNoChange ((WdbTime)(-2))

typedef enum {
    WdbTimeUnitUndef  = 0,
    WdbTimeUnitSecond = 1,
    WdbTimeUnitMilli  = 2,
    WdbTimeUnitMicro  = 3,
    WdbTimeUnitNano   = 4,
    WdbTimeUnitPico   = 5,
    WdbTimeUnitFemto  = 6
} WdbTimeUnit;

Value Types

Signal value use the WdbValue enumeration.

typedef enum {
    WdbVx=0,
    WdbVz=1,
    WdbV0=2,
    WdbV1=3,
    WdbVv=4,
    WdbVw=5,
    WdbV_=6, /* no value */
    WdbV__=7 /* never stored */
} WdbValue;

Signal Number

The data type WdbSigNo is returned and used as arguments by the other API functions.

typedef int WdbSigNo;

#define WdbInvalidSigNo (-1)

Variable Types

Variable types use the WdbVarType enumeration.

typedef enum {
    WdbVarUnknown,
    WdbVarEvent,
    WdbVarInteger,
    WdbVarParameter,
    WdbVarReal,
    WdbVarReg,
    WdbVarSupply0,
    WdbVarSupply1,
    WdbVarTime,
    WdbVarTri,
    WdbVarTriand,
    WdbVarTrior,
    WdbVarTrireg,
    WdbVarTri0,
    WdbVarTri1,
    WdbVarWand,
    WdbVarWire,
    WdbVarWor,

    WdbVarGroup,
    WdbVarAlias,

    WdbVarInvalid
} WdbVarType;

Alias Types

Types of alias variables.

typedef enum {
    WdbAliasNone,
    WdbAliasPin,
    WdbAliasPort,
    WdbAliasNet,

    WdbAliasInvalid
} WdbAliasType;

Var Dir

Directions of variables.

typedef enum {
    WdbVarDirNone,
    WdbVarDirIn,
    WdbVarDirOut,
    WdbVarDirInOut,

    WdbVarDirInvalid
} WdbVarDir;

Signal Types

Type of a signal and it’s value.

typedef enum {
    WdbValUnknown,
    WdbValScalar,
    WdbValVector,
    WdbValReal,

    WdbValMember, /* of a vector or group */
    WdbValGroup,

    WdbValInvalid
} WdbValType;

Scope Types

Scope types use the WdbScopeType enumeration.

typedef enum {
    WdbScopeUnknown,
    WdbScopeModule,
    WdbScopeTask,
    WdbScopeFunction,
    WdbScopeBegin,
    WdbScopeFork,

    WdbScopeInvalid
} WdbScopeType;

String Conversion Helpers

Helper functions to convert types to strings.

const char*  WdbValue2Str(WdbValue value);
const char*  WdbVarType2Str(WdbVarType vartype);
const char*  WdbAliasType2Str(WdbAliasType aliastype);
const char*  WdbValType2Str(WdbValType valtype);
const char*  WdbScopeType2Str(WdbScopeType stype);
const char*  WdbVarDir2Str(WdbVarDir vardir);
WdbVarType   WdbStr2VarType(const char* str);
WdbAliasType WdbStr2AliasType(const char* str);
WdbValType   WdbStr2ValType(const char* str);
WdbScopeType WdbStr2ScopeType(const char* str);
WdbVarDir    WdbStr2VarDir(const char* str);
void         WdbVarTypeUsageList(const char*** list);
void         WdbAliasTypeUsageList(const char*** list);
void         WdbValTypeUsageList(const char*** list);
void         WdbScopeTypeUsageList(const char*** list);
void         WdbVarDirUsageList(const char*** list);

WDB-Read Datatypes

Scope ID

The opaque data type WdbReadScopeId is returned and used as arguments by the other API functions.

typedef int WdbReadScopeId;
#define WdbReadNullScopeId    (WdbReadScopeId)(-1)
#define WdbReadInvalidScopeId (WdbReadScopeId)(-2)
#define WdbReadScopeIdIsNull(scpId)    ((scpId) == WdbReadNullScopeId)
#define WdbReadScopeIdIsInvalid(scpId) ((scpId) == WdbReadInvalidScopeId)

Variable ID

The opaque data type WdbReadVarId is returned and used as arguments by the other API functions.

typedef struct {
    int id;
    int mem;
} WdbReadVarId;

#define WdbReadNullVarId     (-1)
#define WdbReadInvalidVarId  (-2)
#define WdbReadNullMem       (((unsigned)-1)>>2)

#define WdbReadVarIdIsNull(varId)    ((varId).id  == WdbReadNullVarId)
#define WdbReadVarIdIsInvalid(varId) ((varId).id  == WdbReadInvalidVarId)
#define WdbReadVarIdIsNullMem(varId) ((varId).mem == WdbReadNullMem)
#define WdbReadVarIdSet(varId,i,m)   ((varId).id  = (i), (varId).mem = (m))

Callbacks

Wdb util structure is used to generate progress information, error messages, message output, and debug info.

typedef struct {
    int         (*progress)   (const char* what, double percent);
    void        (*msg)        (zMessage_Type type, const char* fmt, va_list);
    void        (*printError) (const char* fmt, va_list);
    const char* (*getError)   (void);
    zBool       (*isDebug)    (void);
} WdbUtil;

Default Callbacks

Default functions for progress and messaging.

#define WdbUtilDefault ((WdbUtil*)1)

No Callbacks

No functions for progress and messaging.

#define WdbUtilNone ((WdbUtil*)NULL)

int         WdbUtilProgress(  WdbUtil*, const char* what, double percent);
void        WdbUtilMsg(       WdbUtil*, zMessage_Type, const char* fmt, ...);
void        WdbUtilPrintError(WdbUtil*, const char* fmt, ...);
const char* WdbUtilGetError(  WdbUtil*);
void        WdbUtilDbg(       WdbUtil* util, const char* fmt, ...);

WDB API Functions

Allocate A New Wdb

The WdbNew() function allocates a new Wdb.

If ok is set to zFalse there was an error - details are store via util→printError.

During execution the callback functions are called if the are not set to NULL.

Wdb* WdbNew(WdbUtil* util, WdbFuncs* funcs, WdbData* data);

Allocate A New Bindb

The WdbNewBindb() function allocates a new Bindb.

If ok is set to zFalse there was an error - details are store via util→printError.

During execution the callback functions are called if the are not set to NULL.

Wdb* WdbNewBindb(
    WdbUtil* util,
    zBool zip,
    zBool gcd,
    zBool skipDupl,
    zBool collapse,
    zBool skipLeadX,
    zBool enableStats,
    const char* outFname /* NULL -> create in memory */
);

Restore a Bindb

The WdbRestoreBindb() function restores a Bindb.

If ok is set to zFalse there was an error - details are store via util→printError.

During execution the callback functions are called if the are not set to NULL.

Wdb* WdbRestoreBindb(
    WdbUtil* util,
    zBool zip,
    zBool gcd,
    zBool skipDupl,
    zBool collapse,
    zBool skipLeadX,
    zBool enableStats,
    const char* fname
);

Close the WDB

The WdbClose() function empties all internal buffer, writes all pending data and close the database. The given handling is not valid anymore.