source: libcf/trunk/include/cf_debug.h@ 54

Last change on this file since 54 was 54, checked in by cheese, 11 years ago

#1 fix doxygen

File size: 2.8 KB
Line 
1/**
2 * @file cf_debug.h
3 * @author myusgun <myusgun@gmail.com>
4 * @version 0.1
5 *
6 * @remark
7 * 디버그 함수를 직접 호출하지 않고 정의된 매크로를 사용하면,
8 * Preprocessor에 _DEBUG가 정의되어 있는 경우에 만
9 * 디버그 코드가 동작하도록 할 수 있음 <br />
10 * 디버그 메시지는 stdout 및 stderr를 이용한 파일 포인터 출력을 지원하고,
11 * 환경에 적합하도록 사용자가 구성한 컨텍스트를 이용하여 사용할 수도 있음 <br />
12 * (단, 콜스택의 푸시/팝은 컨텍스트를 이용해야만 사용 가능)
13 *
14 * @example debug.c
15 */
16#ifndef __CF_DEBUG_H__
17#define __CF_DEBUG_H__
18
19#include "cf_base.h"
20
21#include <stdio.h>
22
23/** Windows 함수 이름 매크로 재정의 */
24#if defined(_WIN32) || defined(_WIN64)
25# define __func__ __FUNCTION__
26#endif
27
28#ifdef _DEBUG
29
30/**
31 * 디버그 메시지를 지정된 파일 포인터로 출력
32 *
33 & @param __fp 출력할 파일 포인터
34 * @param __fmt 포맷 스트링
35 * @param ... 가변 인자
36 *
37 * @see CF_Debug_Print
38 */
39# define CF_DEBUG_PRINT(__fp,__fmt,...) \
40 CF_Debug_Print (__fp,__FILE__,__func__,__LINE__,__fmt,##__VA_ARGS__)
41
42/**
43 * 바이너리 데이터를 디버그 메시지와 함께 지정된 파일 포인터로 출력
44 *
45 & @param __fp 출력할 파일 포인터
46 * @param __bin 바이너리 데이터
47 * @param __len 바이너리 길이
48 * @param __fmt 포맷 스트링
49 * @param ... 가변 인자
50 *
51 * @see CF_Debug_PrintBin
52 */
53# define CF_DEBUG_PRINT_BIN(__fp,__bin,__len,__fmt,...) \
54 CF_Debug_PrintBin (__fp,__FILE__,__func__,__LINE__,__bin,__len,__fmt,##__VA_ARGS__)
55
56/**
57 * 함수에 진입
58 *
59 * @see CF_Debug_EnterFunction
60 */
61# define CF_DEBUG_BEGIN_FUNCTION \
62 CF_Debug_EnterFunction (__FILE__,__func__,__LINE__)
63
64/**
65 * 함수에서 종료
66 *
67 * @see CF_Debug_LeaveFunction
68 */
69# define CF_DEBUG_END_FUNCTION \
70 CF_Debug_LeaveFunction ()
71
72#else // #ifdef _DEBUG
73# define CF_DEBUG_PRINT(__fp,__fmt,...)
74# define CF_DEBUG_PRINT_BIN(__fp,__bin,__len,__fmt,...)
75# define CF_DEBUG_BEGIN_FUNCTION
76# define CF_DEBUG_END_FUNCTION
77#endif // #ifdef _DEBUG
78
79#ifdef __cplusplus
80extern "C" {
81#endif
82
83CF_EXPORT int
84CF_Debug_Print (FILE * fp,
85 const char * file,
86 const char * func,
87 const int line,
88 const char * fmt, ...);
89
90CF_EXPORT int
91CF_Debug_PrintBin (FILE * fp,
92 const char * file,
93 const char * func,
94 const int line,
95 const unsigned char * bin,
96 const int len,
97 const char * fmt, ...);
98
99CF_EXPORT int
100CF_Debug_PrintCallStack (FILE * fp);
101
102CF_EXPORT int
103CF_Debug_EnterFunction (const char * file,
104 const char * func,
105 const int line);
106
107CF_EXPORT int
108CF_Debug_LeaveFunction (void);
109
110#ifdef __cplusplus
111}
112#endif
113
114#endif // #ifndef __CF_DEBUG_H__
Note: See TracBrowser for help on using the repository browser.