DebugClassUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Provides some debug-only utilities to get a prefix name from an id.
// 
// Third party prefixes are in DeveloperPrefix.h
// 
//========================================================================================

#ifndef _DebugClassUtils_H
#define _DebugClassUtils_H

#ifdef ID_ENABLE_DEBUGGING

#include "OMTypes.h"
#include "ShuksanID.h"

enum kDebugClassUtilsBufferSizeEnum {kDebugClassUtilsBufferSize = 512} ;
typedef char DebugClassUtilsBuffer[kDebugClassUtilsBufferSize];

class ModelThreadLocal_DebugClassUtilsBuffer
 {
 public:
 DebugClassUtilsBuffer* Get()
 {
 return &fThreadLocalBuffer.Get()->fBuffer;
 }
 private:
 struct DebugClassUtilsBufferWrapper
 {
 DebugClassUtilsBuffer fBuffer;
 };
 
 IDThreading::ThreadLocalManagedObject<DebugClassUtilsBufferWrapper> fThreadLocalBuffer;
 };

 class DebugClassUtils
 {
 public:

 static const char* GetPluginName( DebugClassUtilsBuffer *pName, PluginID id );
 
 static const char* GetPluginName( DebugClassUtilsBuffer *pName, int32 id );
 
 
 static int32 GetPrefix(int32 id);

 static int32 GetOffset(int32 id);
 
 
 static bool16 IsPrefixReserved(int32 prefix);
 
 
 static const char * GetIDSpaceName( DebugClassUtilsBuffer *pName, int32 idspace );
 
 static const char * GetIDName( DebugClassUtilsBuffer *pName, int32 id, int32 idspace = kClassIDSpace, bool16 appendGetIDString = kFalse );
 
 static const char *GetIDName( DebugClassUtilsBuffer *pName, ClassID id, bool16 appendGetIDString = kFalse ) ;
 static const char *GetIDName( DebugClassUtilsBuffer *pName, PMIID id, bool16 appendGetIDString = kFalse );

 static const char *GetIDName( DebugClassUtilsBuffer *pName, ImplementationID id, bool16 appendGetIDString = kFalse );

 static const char *GetIDName( DebugClassUtilsBuffer *pName, WidgetID id, bool16 appendGetIDString = kFalse );

 static const char *GetIDName( DebugClassUtilsBuffer *pName, ActionID id, bool16 appendGetIDString = kFalse );

 static const char *GetIDName( DebugClassUtilsBuffer *pName, ServiceID id, bool16 appendGetIDString = kFalse );

 static const char *GetIDName( DebugClassUtilsBuffer *pName, PluginID id, bool16 appendGetIDString = kFalse );

 static const char *GetIDName( DebugClassUtilsBuffer *pName, ScriptElementID id, bool16 appendGetIDString = kFalse );

 static void ValidateOMId(int32 idSpace, int32 id);
 
 static void ValidateAllClassIds();
 
 private:
 static const char* GetIDString( DebugClassUtilsBuffer *pName, int32 id);
 };

#endif


#endif /* _DebugClassUtils_H */