Woolz Image Processing  Version 1.8.3
WlzDebug

Files

file  WlzDebug.c
 Default debugging text and object output functions for the Woolz library flag based debugging system.
 
file  WlzDebug.h
 Defines the Woolz debug masks and function prototypes.
 
file  WlzFacts.c
 Text description (facts) of Woolz objects.
 
file  WlzVersion.c
 Simple Woolz versioning.
 

Enumerations

enum  _WlzDbgMask {
  WLZ_DBG_NONE = (0),
  WLZ_DBG_LVL_1 = (1),
  WLZ_DBG_LVL_2 = (1<<1),
  WLZ_DBG_LVL_3 = (1<<2),
  WLZ_DBG_LVL_FN = (1<<3),
  WLZ_DBG_ALLOC = (1<<4)
}
 Woolz debug bit masks. Typedef: WlzDbgMask. More...
 

Functions

WlzErrorNum WlzDbgWrite (char *fmt,...)
 Writes out the given debug message to the debug file. More...
 
WlzErrorNum WlzDbgObjWrite (WlzObject *obj, int freeFlg)
 Writes out the given debug Woolz object to the woolz debug file. More...
 
WlzErrorNum WlzObjectFacts (WlzObject *obj, FILE *factsFile, char **dstStr, int verbose)
 The external facts interface function. Creates the facts data structure and then produces a text description of the given object. More...
 
const char * WlzVersion ()
 Returns the current version of Woolz. More...
 

Detailed Description

Enumeration Type Documentation

◆ _WlzDbgMask

Woolz debug bit masks. Typedef: WlzDbgMask.

Enumerator
WLZ_DBG_NONE 

No debug output

WLZ_DBG_LVL_1 

Least debug output

WLZ_DBG_LVL_2 

Intermediate debug output

WLZ_DBG_LVL_3 

Most debug output

WLZ_DBG_LVL_FN 

Function entry and return

WLZ_DBG_ALLOC 

Allocation and freeing

Function Documentation

◆ WlzDbgWrite()

WlzErrorNum WlzDbgWrite ( char *  fmt,
  ... 
)

Writes out the given debug message to the debug file.

Returns
Woolz error code.
Parameters
fmtFormat for printing message.

References WLZ_ERR_NONE, WLZ_ERR_UNSPECIFIED, and wlzDbgData.

◆ WlzDbgObjWrite()

WlzErrorNum WlzDbgObjWrite ( WlzObject obj,
int  freeFlg 
)

Writes out the given debug Woolz object to the woolz debug file.

Returns
Woolz error code.
Parameters
objWoolz debug object for output.
freeFlgIf non zero free the object after writing it.

References WLZ_ERR_NONE, WLZ_ERR_UNSPECIFIED, wlzDbgObjData, WlzFreeObj(), and WlzWriteObj().

◆ WlzObjectFacts()

WlzErrorNum WlzObjectFacts ( WlzObject obj,
FILE *  factsFile,
char **  dstStr,
int  verbose 
)

The external facts interface function. Creates the facts data structure and then produces a text description of the given object.

Returns
Woolz error code.
Parameters
objThe given object.
factsFileIf non-NULL the text is written to the given file.
dstStrIf non-NULL the pointer is set to an allocated text string, which should be free'd using AlcFree().
verboseVerbose output if non-zero.

References AlcMalloc(), WlzObjFactsData::fFile, WlzObjFactsData::fStr, WlzObjFactsData::fStrInc, WlzObjFactsData::fStrLen, WlzObjFactsData::fStrMax, WlzObjFactsData::indent, WlzObjFactsData::verbose, WLZ_ERR_MEM_ALLOC, and WLZ_ERR_NONE.

Referenced by WlzPatchFacts().

◆ WlzVersion()

const char* WlzVersion ( )

Returns the current version of Woolz.

Returns
Woolz version string.