开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Windows编程 > 系统编程 > 查看源码
debug.h
资源名称：shell.rar　[点击查看]
上传用户：xhy777
上传日期：2007-02-14
资源大小：24088k
文件大小：8k
源码类别：

系统编程

开发平台：

Visual C++

debug.h：源码内容
  1. /*
  2.  * debug.h - Debug macros and their retail translations.
  3.  */
  6. /* Macros
  7.  *********/
  9. /* debug output macros */
  11. /*
  12.  * Do not call SPEW_OUT directly.  Instead, call TRACE_OUT, WARNING_OUT,
  13.  * ERROR_OUT, or FATAL_OUT.
  14.  */
  16. /*
  17.  * call like printf(), but with an extra pair of parentheses:
  18.  *
  19.  * ERROR_OUT(("'%s' too big by %d bytes.", pszName, nExtra));
  20.  */
  22. #ifdef DEBUG
  24. #define SPEW_OUT(args) 
  25.    ((void)(GpcszSpewFile = TEXT(__FILE__), GuSpewLine = __LINE__, SpewOut args, 0))
  27. #define PLAIN_TRACE_OUT(args) 
  28.    (GdwSpewFlags = 0, GuSpewSev = SPEW_TRACE, SPEW_OUT(args))
  30. #define TRACE_OUT(args) 
  31.    (GdwSpewFlags = SPEW_FL_SPEW_PREFIX, GuSpewSev = SPEW_TRACE, SPEW_OUT(args))
  33. #define WARNING_OUT(args) 
  34.    (GdwSpewFlags = SPEW_FL_SPEW_PREFIX | SPEW_FL_SPEW_LOCATION, GuSpewSev = SPEW_WARNING, SPEW_OUT(args))
  36. #define ERROR_OUT(args) 
  37.    (GdwSpewFlags = SPEW_FL_SPEW_PREFIX | SPEW_FL_SPEW_LOCATION, GuSpewSev = SPEW_ERROR, SPEW_OUT(args))
  39. #define FATAL_OUT(args) 
  40.    (GdwSpewFlags = SPEW_FL_SPEW_PREFIX | SPEW_FL_SPEW_LOCATION, GuSpewSev = SPEW_FATAL, SPEW_OUT(args))
  42. #else
  44. #define PLAIN_TRACE_OUT(args)
  45. #define TRACE_OUT(args)
  46. #define WARNING_OUT(args)
  47. #define ERROR_OUT(args)
  48. #define FATAL_OUT(args)
  50. #endif
  52. /* parameter validation macros */
  54. /*
  55.  * call as:
  56.  *
  57.  * bPTwinOK = IS_VALID_READ_PTR(ptwin, CTWIN);
  58.  *
  59.  * bHTwinOK = IS_VALID_HANDLE(htwin, TWIN);
  60.  */
  62. #ifdef DEBUG
  64. #define IS_VALID_READ_PTR(ptr, type) 
  65.    (IsBadReadPtr((ptr), sizeof(type)) ? 
  66.     (ERROR_OUT((TEXT("invalid %s read pointer - %#08lx"), (LPCTSTR)TEXT("P")TEXT(#type), (ptr))), FALSE) : 
  67.     TRUE)
  69. #define IS_VALID_WRITE_PTR(ptr, type) 
  70.    (IsBadWritePtr((PVOID)(ptr), sizeof(type)) ? 
  71.     (ERROR_OUT((TEXT("invalid %s write pointer - %#08lx"), (LPCTSTR)TEXT("P")TEXT(#type), (ptr))), FALSE) : 
  72.     TRUE)
  74. #define IS_VALID_STRING_PTRA(ptr, type) 
  75.    (IsBadStringPtrA((ptr), (UINT)-1) ? 
  76.     (ERROR_OUT((TEXT("invalid %s pointer - %#08lx"), (LPCTSTR)TEXT("P")TEXT(#type), (ptr))), FALSE) : 
  77.     TRUE)
  79. #define IS_VALID_STRING_PTRW(ptr, type) 
  80.    (IsBadStringPtrW((ptr), (UINT)-1) ? 
  81.     (ERROR_OUT((TEXT("invalid %s pointer - %#08lx"), (LPCTSTR)TEXT("P")TEXT(#type), (ptr))), FALSE) : 
  82.     TRUE)
  84. #ifdef UNICODE
  85. #define IS_VALID_STRING_PTR(ptr, type) IS_VALID_STRING_PTRW(ptr, type)
  86. #else
  87. #define IS_VALID_STRING_PTR(ptr, type) IS_VALID_STRING_PTRA(ptr, type)
  88. #endif
  90. #define IS_VALID_CODE_PTR(ptr, type) 
  91.    (IsBadCodePtr((PROC)(ptr)) ? 
  92.     (ERROR_OUT((TEXT("invalid %s code pointer - %#08lx"), (LPCTSTR)TEXT(#type), (ptr))), FALSE) : 
  93.     TRUE)
  95. #define IS_VALID_READ_BUFFER_PTR(ptr, type, len) 
  96.    (IsBadReadPtr((ptr), len) ? 
  97.     (ERROR_OUT((TEXT("invalid %s read pointer - %#08lx"), (LPCTSTR)TEXT("P")TEXT(#type), (ptr))), FALSE) : 
  98.     TRUE)
  100. #define IS_VALID_WRITE_BUFFER_PTR(ptr, type, len) 
  101.    (IsBadWritePtr((ptr), len) ? 
  102.     (ERROR_OUT((TEXT("invalid %s write pointer - %#08lx"), (LPCTSTR)TEXT("P")TEXT(#type), (ptr))), FALSE) : 
  103.     TRUE)
  105. #define FLAGS_ARE_VALID(dwFlags, dwAllFlags) 
  106.    (((dwFlags) & (~(dwAllFlags))) ? 
  107.     (ERROR_OUT((TEXT("invalid flags set - %#08lx"), ((dwFlags) & (~(dwAllFlags))))), FALSE) : 
  108.     TRUE)
  110. #else
  112. #define IS_VALID_READ_PTR(ptr, type) 
  113.    (! IsBadReadPtr((ptr), sizeof(type)))
  115. #define IS_VALID_WRITE_PTR(ptr, type) 
  116.    (! IsBadWritePtr((PVOID)(ptr), sizeof(type)))
  118. #define IS_VALID_STRING_PTR(ptr, type) 
  119.    (! IsBadStringPtr((ptr), (UINT)-1))
  121. #define IS_VALID_CODE_PTR(ptr, type) 
  122.    (! IsBadCodePtr((PROC)(ptr)))
  124. #define IS_VALID_READ_BUFFER_PTR(ptr, type, len) 
  125.    (! IsBadReadPtr((ptr), len))
  127. #define IS_VALID_WRITE_BUFFER_PTR(ptr, type, len) 
  128.    (! IsBadWritePtr((ptr), len))
  130. #define FLAGS_ARE_VALID(dwFlags, dwAllFlags) 
  131.    (((dwFlags) & (~(dwAllFlags))) ? FALSE : TRUE)
  133. #endif
  135. /* handle validation macros */
  137. #define IS_VALID_HANDLE(hnd, type) 
  138.    (IsValidH##type(hnd))
  140. /* structure validation macros */
  142. #ifdef VSTF
  144. #ifdef DEBUG
  146. #define IS_VALID_STRUCT_PTR(ptr, type) 
  147.    (IsValidP##type(ptr) ? 
  148.     TRUE : 
  149.     (ERROR_OUT((TEXT("invalid %s pointer - %#08lx"), (LPCTSTR)TEXT("P")TEXT(#type), (ptr))), FALSE))
  151. #else
  153. #define IS_VALID_STRUCT_PTR(ptr, type) 
  154.    (IsValidP##type(ptr))
  156. #endif
  158. #else
  160. #define IS_VALID_STRUCT_PTR(ptr, type) 
  161.    (! IsBadReadPtr((ptr), sizeof(type)))
  163. #endif
  165. /* debug assertion macro */
  167. /*
  168.  * ASSERT() may only be used as a statement, not as an expression.
  169.  *
  170.  * call as:
  171.  *
  172.  * ASSERT(pszRest);
  173.  */
  175. #ifdef DEBUG
  177. #define ASSERT(exp) 
  178.    if (exp) 
  179.       ; 
  180.    else 
  181.       ERROR_OUT((TEXT("assertion failed '%s'"), (LPCTSTR)TEXT(#exp)))
  183. #else
  185. #define ASSERT(exp)
  187. #endif
  189. /* debug evaluation macro */
  191. /*
  192.  * EVAL() may be used as an expression.
  193.  *
  194.  * call as:
  195.  *
  196.  * if (EVAL(pszFoo))
  197.  *    bResult = TRUE;
  198.  */
  200. #ifdef DEBUG
  202. #define EVAL(exp) 
  203.    ((exp) || (ERROR_OUT((TEXT("evaluation failed '%s'"), (LPCTSTR)TEXT(#exp))), 0))
  205. #else
  207. #define EVAL(exp) 
  208.    (exp)
  210. #endif
  212. /* debug break */
  214. #ifndef DEBUG
  216. #define DebugBreak()
  218. #endif
  220. /* debug exported function entry */
  222. #ifdef DEBUG
  224. #define DebugEntry(szFunctionName) 
  225.    (TRACE_OUT((TEXT(#szFunctionName) TEXT("() entered."))), StackEnter())
  227. #else
  229. #define DebugEntry(szFunctionName)
  231. #endif
  233. /* debug exported function exit */
  235. #ifdef DEBUG
  237. #define DebugExitVOID(szFunctionName) 
  238.    (StackLeave(), TRACE_OUT((TEXT("%s() exiting."), TEXT(#szFunctionName))))
  240. #define DebugExit(szFunctionName, szResult) 
  241.    (StackLeave(), TRACE_OUT((TEXT("%s() exiting, returning %s."), TEXT(#szFunctionName), szResult)))
  243. #define DebugExitINT(szFunctionName, n) 
  244.    DebugExit(szFunctionName, GetINTString(n))
  246. #define DebugExitULONG(szFunctionName, ul) 
  247.    DebugExit(szFunctionName, GetULONGString(ul))
  249. #define DebugExitBOOL(szFunctionName, bool) 
  250.    DebugExit(szFunctionName, GetBOOLString(bool))
  252. #define DebugExitHRESULT(szFunctionName, hr) 
  253.    DebugExit(szFunctionName, GetHRESULTString(hr))
  255. #define DebugExitCOMPARISONRESULT(szFunctionName, cr) 
  256.    DebugExit(szFunctionName, GetCOMPARISONRESULTString(cr))
  258. #define DebugExitTWINRESULT(szFunctionName, tr) 
  259.    DebugExit(szFunctionName, GetTWINRESULTString(tr))
  261. #define DebugExitRECRESULT(szFunctionName, rr) 
  262.    DebugExit(szFunctionName, GetRECRESULTString(rr))
  264. #else
  266. #define DebugExitVOID(szFunctionName)
  267. #define DebugExit(szFunctionName, szResult)
  268. #define DebugExitINT(szFunctionName, n)
  269. #define DebugExitULONG(szFunctionName, ul)
  270. #define DebugExitBOOL(szFunctionName, bool)
  271. #define DebugExitHRESULT(szFunctionName, hr)
  272. #define DebugExitCOMPARISONRESULT(szFunctionName, cr)
  273. #define DebugExitTWINRESULT(szFunctionName, tr)
  274. #define DebugExitRECRESULT(szFunctionName, rr)
  276. #endif
  279. /* Types
  280.  ********/
  282. /* GdwSpewFlags flags */
  284. typedef enum _spewflags
  285. {
  286.    SPEW_FL_SPEW_PREFIX     = 0x0001,
  288.    SPEW_FL_SPEW_LOCATION   = 0x0002,
  290.    ALL_SPEW_FLAGS          = (SPEW_FL_SPEW_PREFIX |
  291.                               SPEW_FL_SPEW_LOCATION)
  292. }
  293. SPEWFLAGS;
  295. /* GuSpewSev values */
  297. typedef enum _spewsev
  298. {
  299.    SPEW_TRACE              = 1,
  301.    SPEW_WARNING            = 2,
  303.    SPEW_ERROR              = 3,
  305.    SPEW_FATAL              = 4
  306. }
  307. SPEWSEV;
  310. /* Prototypes
  311.  *************/
  313. /* debug.c */
  315. #ifdef DEBUG
  317. extern BOOL SetDebugModuleIniSwitches(void);
  318. extern BOOL InitDebugModule(void);
  319. extern void ExitDebugModule(void);
  320. extern void StackEnter(void);
  321. extern void StackLeave(void);
  322. extern ULONG GetStackDepth(void);
  323. extern void __cdecl SpewOut(LPCTSTR pcszFormat, ...);
  325. #endif
  328. /* Global Variables
  329.  *******************/
  331. #ifdef DEBUG
  333. /* debug.c */
  335. extern DWORD GdwSpewFlags;
  336. extern UINT GuSpewSev;
  337. extern UINT GuSpewLine;
  338. extern LPCTSTR GpcszSpewFile;
  340. /* defined by client */
  342. extern LPCTSTR GpcszSpewModule;
  344. #endif