kdebug.h File Reference

---

Detailed Description

Definition in file kdebug.h.

#include <fbxfilesdk/fbxfilesdk_def.h>
#include <fbxfilesdk/components/kbaselib/klib/ktime.h>
#include <fbxfilesdk/fbxfilesdk_nsbegin.h>
#include <fbxfilesdk/fbxfilesdk_nsend.h>

Include dependency graph for kdebug.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	KDebugTimeEvent
struct	KFbxIncompatibleWithKArrayTemplate
Defines
#define	KAlwaysTrace   KTraceFnc
	To debug in both Debug and Release, all calls to this function must be removed before shipping.
#define	KSTRINGITIZE(a)   (a)
	Add another indirection level, so that in can work in conjunction with the __FILE__ usage.
#define	K_ASSERT(pCondition)   ((void)0)
#define	K_ASSERT_MSG_NOW(pMessage)   ((void)0)
#define	K_ASSERT_MSG(pCondition,pMessage)   ((void)0)
#define	K_ASSERT_MSG_NOT_IMPLEMENTED   ((void)0)
#define	K_STATIC_ASSERT(pCondition)
#define	KTrace   KNoTraceFnc
#define	K_CHECKRTNV(condition, value)
	Checks the condition, if it evaluates to false asserts and returns value.
#define	K_CHECKRTN(condition)
	Checks the condition, if it evaluates to false asserts and returns.
#define	KFBX_INCOMPATIBLE_WITH_KARRAYTEMPLATE(T)
#define	KFBX_IS_INCOMPATIBLE_WITH_KARRAYTEMPLATE(T)   ((bool) KFbxIncompatibleWithKArrayTemplate<T>::value)
Constants
#define	K_NO_TRACE   0
	Tracing disabled, this level must not be used with the KTrace function/.
#define	K_ASSERT_ONLY_TRACE   1
	Show only assert traces.
#define	K_NORMAL_TRACE   3
	Descriptive trace.
#define	K_ALL_TRACE   4
	Highly detailed level of trace.
#define	K_DEFAULT_TRACE   20
	Default value, K_TRACE_LEVEL environment variable is used when level TraceLevel is set to that value Never use this value as an argument to KTrace.
Enumerations
enum	{    KTRACE_SYNC = -1,    KTRACE_START = -1,    KTRACE_END = -2 }
Functions
KFBX_DLL void	KRegisterAssertStubFct (int(*pFct)(const char *pFileName, const char *pFunctionName, kULong pLineNumber, const char *pMessage, bool pAbortEnabled))
KFBX_DLL void *	KGetAssertStubFct ()
KFBX_DLL void	KAssertFailed (const char *pFileName, const char *pFunctionName, kULong pLineNumber, const char *pMessage=NULL, bool *pHideForEver=NULL)
KFBX_DLL void	KAssertFailedWithLevel (const char *pFileName, const char *pFunctionName, kULong pLineNumber, kULong pLevel, const char *pMessage=NULL, bool *pHideForEver=NULL)
KFBX_DLL void	ShowLastError (char *pOperation)
KFBX_DLL void	KTraceFnc (char *pStr,...)
void	KNoTraceFnc (char *,...)
KFBX_DLL bool	KIsAssertDisplayed ()
KFBX_DLL void	KTimerTrace_Start ()
KFBX_DLL int	KTimerTrace_GetId (char *pName, bool pProfile=false)
KFBX_DLL int	KTimerTrace (int pId, KTime pTime, KTime pScheduledTime, int LastId, float R, float G, float B, char *pStr, bool pCopy=false)
KFBX_DLL int	KTimerPrintf (int pId, KTime pTime, KTime pScheduledTime, int LastId, float R, float G, float B, char *pStr,...)
KFBX_DLL void	KTimerTrace_Stop ()
KFBX_DLL void	KTimerTrace_Release ()
KFBX_DLL int	KTimerTrace_GetEventCount ()
KFBX_DLL KDebugTimeEvent *	KTimerTrace_GetEvent (int pIndex)
KFBX_DLL int	KTimerTrace_GetIdCount ()
KFBX_DLL char *	KTimerTrace_GetIdName (int pId)

---

Define Documentation

#define K_ALL_TRACE   4

Highly detailed level of trace.

Definition at line 67 of file kdebug.h.

#define K_ASSERT

(

pCondition

)

((void)0)

Definition at line 154 of file kdebug.h.

Referenced by KBaseArray< KBaseArraySizeType< KXRefManagerProject * > >::AddMultiple(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::CheckLeavesBlackDepth(), fbxCopy(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::FixNodesAfterRemoval(), KFbxLayerElementTemplate< KFbxSurfaceMaterial * >::GetDirectArray(), KArrayTemplate< KLayerInfo * >::GetFirst(), KFbxLayerElementTemplate< KFbxSurfaceMaterial * >::GetIndexArray(), KArrayTemplate< KLayerInfo * >::GetLast(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::Insert(), KDynamicArray::Insert(), KBaseArray< KBaseArraySizeType< KXRefManagerProject * > >::InsertAt(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::IsSane(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::IsSubTreeSane(), KFCurve::KeyGetBreak(), KFCurve::KeyGetConstantMode(), KFCurve::KeyGetDataDouble(), KFCurve::KeyGetDataFloat(), KFCurve::KeyGetDataPtr(), KFCurve::KeyGetInterpolation(), KFCurve::KeyGetMarkedForManipulation(), KFCurve::KeyGetSelected(), KFCurve::KeyGetTangeantMode(), KFCurve::KeyGetTangeantVelocityMode(), KFCurve::KeyGetTangeantVisibility(), KFCurve::KeyGetTangeantWeightMode(), KFCurve::KeyGetTime(), KFCurve::KeyGetValue(), KFCurve::KeyIncTime(), KFCurve::KeyIncValue(), KFCurve::KeyMultTangeant(), KFCurve::KeyMultValue(), KFCurve::KeySetBreak(), KFCurve::KeySetConstantMode(), KFCurve::KeySetDataDouble(), KFCurve::KeySetDataFloat(), KFCurve::KeySetInterpolation(), KFCurve::KeySetMarkedForManipulation(), KFCurve::KeySetSelected(), KFCurve::KeySetTangeantMode(), KFCurve::KeySetTangeantVelocityMode(), KFCurve::KeySetTangeantVisibility(), KFCurve::KeySetTangeantWeightMode(), KFCurve::KeySetTime(), KFbxAnimCurveKey::KFbxAnimCurveKey(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::LeftRotate(), KScopedPtr< T, FbxSdkDeletionPolicy< T > >::operator*(), RedBack_ConstIteratorType::operator*(), RedBack_IteratorType::operator*(), RedBack_ConstIteratorType::operator++(), RedBack_IteratorType::operator++(), RedBack_ConstIteratorType::operator--(), RedBack_IteratorType::operator--(), KScopedPtr< T, FbxSdkDeletionPolicy< T > >::operator->(), RedBack_ConstIteratorType::operator->(), RedBack_IteratorType::operator->(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::operator=(), KFbxLayerElementTemplate< KFbxSurfaceMaterial * >::operator=(), KFbxAnimCurveKey::operator=(), KDynamicArray::PopBack(), KDynamicArray::PushBack(), KDynamicArray::Remove(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::RemoveNode(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::ReplaceNode(), KBaseArray< KBaseArraySizeType< KXRefManagerProject * > >::Reserve(), KScopedPtr< T, FbxSdkDeletionPolicy< T > >::Reset(), KBaseArray< KBaseArraySizeType< KXRefManagerProject * > >::Resize(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::RightRotate(), KFCurveKey::Set(), KPriFCurveKeyAttr::Set(), and KFbxAnimCurveKey::~KFbxAnimCurveKey().

#define K_ASSERT_MSG	(	pCondition,
		pMessage		)	((void)0)

Definition at line 156 of file kdebug.h.

Referenced by KFCurveKey::GetBreak(), KPriFCurveKeyAttr::GetBreak(), KStaticArray2d::operator[](), KBaseStaticArray::operator[](), KFCurveKey::SetBreak(), KPriFCurveKeyAttr::SetBreak(), KFCurveKey::SetConstantMode(), KPriFCurveKeyAttr::SetConstantMode(), KFCurveKey::SetInterpolation(), KPriFCurveKeyAttr::SetInterpolation(), KFCurveKey::SetTangeantMode(), KPriFCurveKeyAttr::SetTangeantMode(), KFCurveKey::SetTangeantVisibility(), KPriFCurveKeyAttr::SetTangeantVisibility(), KFCurveKey::SetTime(), and KPriFCurveKey::SetTime().

#define K_ASSERT_MSG_NOT_IMPLEMENTED   ((void)0)

Definition at line 157 of file kdebug.h.

#define K_ASSERT_MSG_NOW

(

pMessage

)

((void)0)

Definition at line 155 of file kdebug.h.

Referenced by fbxCompare(), fbxCopy(), FbxTypeOf(), KArrayTemplate< KLayerInfo * >::FindAfter(), KArrayTemplate< KLayerInfo * >::FindBefore(), KFbxLayerElementUserData::GetArrayCount(), KFbxLayerElementUserData::GetDirectArrayVoid(), KFbxLayerElementUserData::operator=(), KFbxLayerElementUserData::RemoveFromAllDirectArrays(), KRedBlackTree< KKeyValuePair, KFbxMapKStringCompare, KBaseAllocator >::RemoveNode(), KFbxLayerElementUserData::ResizeAllDirectArrays(), KBaseArray< KBaseArraySizeType< KXRefManagerProject * > >::SetCount(), KFbxLayerElementHole::SetReferenceMode(), KFbxLayerElementCrease::SetReferenceMode(), KFbxLayerElementSmoothing::SetReferenceMode(), and KBaseArray< KBaseArraySizeType< KXRefManagerProject * > >::ValidateIndex().

#define K_ASSERT_ONLY_TRACE   1

Show only assert traces.

Definition at line 59 of file kdebug.h.

#define K_CHECKRTN

(

condition

)

Value:

if( !(condition) ){                     \
        K_ASSERT_MSG_NOW( #condition );     \
        return;                             \
    }

Checks the condition, if it evaluates to false asserts and returns.

Definition at line 202 of file kdebug.h.

#define K_CHECKRTNV	(	condition,
		value		)

Value:

if( !(condition) ){                     \
        K_ASSERT_MSG_NOW( #condition );     \
        return value;                       \
    }

Checks the condition, if it evaluates to false asserts and returns value.

Definition at line 193 of file kdebug.h.

#define K_DEFAULT_TRACE   20

Default value, K_TRACE_LEVEL environment variable is used when level TraceLevel is set to that value Never use this value as an argument to KTrace.

Definition at line 73 of file kdebug.h.

#define K_NO_TRACE   0

Tracing disabled, this level must not be used with the KTrace function/.

Definition at line 55 of file kdebug.h.

#define K_NORMAL_TRACE   3

Descriptive trace.

Definition at line 63 of file kdebug.h.

#define K_STATIC_ASSERT

(

pCondition

)

Definition at line 158 of file kdebug.h.

#define KAlwaysTrace   KTraceFnc

To debug in both Debug and Release, all calls to this function must be removed before shipping.

Definition at line 94 of file kdebug.h.

#define KFBX_INCOMPATIBLE_WITH_KARRAYTEMPLATE

(

T

)

Value:

template<> struct KFbxIncompatibleWithKArrayTemplate<T> {   \
        union {                                                 \
            T t();                                              \
        } catcherr;                                             \
        enum {value = 1};                                       \
    }

Definition at line 213 of file kdebug.h.

#define KFBX_IS_INCOMPATIBLE_WITH_KARRAYTEMPLATE

(

T

)

((bool) KFbxIncompatibleWithKArrayTemplate<T>::value)

Definition at line 221 of file kdebug.h.

#define KSTRINGITIZE

(

a

)

(a)

Add another indirection level, so that in can work in conjunction with the __FILE__ usage.

Definition at line 98 of file kdebug.h.

#define KTrace   KNoTraceFnc

Definition at line 160 of file kdebug.h.

---

Enumeration Type Documentation

anonymous enum

Enumerator:

KTRACE_SYNC
KTRACE_START
KTRACE_END

Definition at line 176 of file kdebug.h.

---

Function Documentation

KFBX_DLL void KAssertFailed	(	const char *	pFileName,
		const char *	pFunctionName,
		kULong	pLineNumber,
		const char *	pMessage = NULL,
		bool *	pHideForEver = NULL
	)

KFBX_DLL void KAssertFailedWithLevel	(	const char *	pFileName,
		const char *	pFunctionName,
		kULong	pLineNumber,
		kULong	pLevel,
		const char *	pMessage = NULL,
		bool *	pHideForEver = NULL
	)

KFBX_DLL void* KGetAssertStubFct

(

)

KFBX_DLL bool KIsAssertDisplayed

(

)

void KNoTraceFnc	(	char *	,
			...
	)			[inline]

Definition at line 88 of file kdebug.h.

KFBX_DLL void KRegisterAssertStubFct

(

int(*)(const char *pFileName, const char *pFunctionName, kULong pLineNumber, const char *pMessage, bool pAbortEnabled)

pFct

)

KFBX_DLL int KTimerPrintf	(	int	pId,
		KTime	pTime,
		KTime	pScheduledTime,
		int	LastId,
		float	R,
		float	G,
		float	B,
		char *	pStr,
			...
	)

KFBX_DLL int KTimerTrace	(	int	pId,
		KTime	pTime,
		KTime	pScheduledTime,
		int	LastId,
		float	R,
		float	G,
		float	B,
		char *	pStr,
		bool	pCopy = false
	)

KFBX_DLL KDebugTimeEvent* KTimerTrace_GetEvent

(

int

pIndex

)

KFBX_DLL int KTimerTrace_GetEventCount

(

)

KFBX_DLL int KTimerTrace_GetId	(	char *	pName,
		bool	pProfile = false
	)

KFBX_DLL int KTimerTrace_GetIdCount

(

)

KFBX_DLL char* KTimerTrace_GetIdName

(

int

pId

)

KFBX_DLL void KTimerTrace_Release

(

)

KFBX_DLL void KTimerTrace_Start

(

)

KFBX_DLL void KTimerTrace_Stop

(

)

KFBX_DLL void KTraceFnc	(	char *	pStr,
			...
	)

KFBX_DLL void ShowLastError

(

char *

pOperation

)