| [6] | 1 | /**
|
|---|
| [26] | 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 | * (단, 콜스택의 푸시/팝은 컨텍스트를 이용해야만 사용 가능)
|
|---|
| [34] | 13 | *
|
|---|
| [35] | 14 | * @example debug.c
|
|---|
| [6] | 15 | */
|
|---|
| 16 | #ifndef __CF_DEBUG_H__
|
|---|
| 17 | #define __CF_DEBUG_H__
|
|---|
| 18 |
|
|---|
| 19 | #include "cf_base.h"
|
|---|
| 20 |
|
|---|
| [16] | 21 | #include <stdio.h>
|
|---|
| 22 |
|
|---|
| [26] | 23 | /** Windows 함수 이름 매크로 재정의 */
|
|---|
| [50] | 24 | #if defined(_WIN32) || defined(_WIN64)
|
|---|
| [6] | 25 | # define __func__ __FUNCTION__
|
|---|
| 26 | #endif
|
|---|
| 27 |
|
|---|
| 28 | #ifdef _DEBUG
|
|---|
| [25] | 29 |
|
|---|
| [26] | 30 | /**
|
|---|
| 31 | * 디버그 메시지를 지정된 파일 포인터로 출력
|
|---|
| 32 | *
|
|---|
| [54] | 33 | & @param __fp 출력할 파일 포인터
|
|---|
| [26] | 34 | * @param __fmt 포맷 스트링
|
|---|
| 35 | * @param ... 가변 인자
|
|---|
| 36 | *
|
|---|
| 37 | * @see CF_Debug_Print
|
|---|
| 38 | */
|
|---|
| [16] | 39 | # define CF_DEBUG_PRINT(__fp,__fmt,...) \
|
|---|
| 40 | CF_Debug_Print (__fp,__FILE__,__func__,__LINE__,__fmt,##__VA_ARGS__)
|
|---|
| [25] | 41 |
|
|---|
| [26] | 42 | /**
|
|---|
| 43 | * 바이너리 데이터를 디버그 메시지와 함께 지정된 파일 포인터로 출력
|
|---|
| 44 | *
|
|---|
| [54] | 45 | & @param __fp 출력할 파일 포인터
|
|---|
| [26] | 46 | * @param __bin 바이너리 데이터
|
|---|
| 47 | * @param __len 바이너리 길이
|
|---|
| 48 | * @param __fmt 포맷 스트링
|
|---|
| 49 | * @param ... 가변 인자
|
|---|
| 50 | *
|
|---|
| 51 | * @see CF_Debug_PrintBin
|
|---|
| 52 | */
|
|---|
| [16] | 53 | # define CF_DEBUG_PRINT_BIN(__fp,__bin,__len,__fmt,...) \
|
|---|
| 54 | CF_Debug_PrintBin (__fp,__FILE__,__func__,__LINE__,__bin,__len,__fmt,##__VA_ARGS__)
|
|---|
| [25] | 55 |
|
|---|
| [26] | 56 | /**
|
|---|
| [62] | 57 | * 디버깅 모듈 초기화
|
|---|
| 58 | *
|
|---|
| 59 | * @see CF_Debug_Initialize
|
|---|
| 60 | */
|
|---|
| 61 | # define CF_DEBUG_INITIALIZE \
|
|---|
| 62 | CF_Debug_Initialize ()
|
|---|
| 63 |
|
|---|
| 64 | /**
|
|---|
| 65 | * 디버깅 모듈 해제
|
|---|
| 66 | *
|
|---|
| 67 | * @see CF_Debug_Finalize
|
|---|
| 68 | */
|
|---|
| 69 | # define CF_DEBUG_FINALIZE \
|
|---|
| 70 | CF_Debug_Finalize ()
|
|---|
| 71 |
|
|---|
| 72 | /**
|
|---|
| [51] | 73 | * 함수에 진입
|
|---|
| [26] | 74 | *
|
|---|
| [51] | 75 | * @see CF_Debug_EnterFunction
|
|---|
| [26] | 76 | */
|
|---|
| [62] | 77 | # define CF_DEBUG_BEGIN_FUNCTION \
|
|---|
| [51] | 78 | CF_Debug_EnterFunction (__FILE__,__func__,__LINE__)
|
|---|
| [25] | 79 |
|
|---|
| [26] | 80 | /**
|
|---|
| [63] | 81 | * 함수에서 리턴
|
|---|
| [26] | 82 | *
|
|---|
| [51] | 83 | * @see CF_Debug_LeaveFunction
|
|---|
| [26] | 84 | */
|
|---|
| [62] | 85 | # define CF_DEBUG_END_FUNCTION \
|
|---|
| [51] | 86 | CF_Debug_LeaveFunction ()
|
|---|
| [25] | 87 |
|
|---|
| [63] | 88 | /**
|
|---|
| 89 | * 콜스택 을 지정된 파일 포인터로 출력
|
|---|
| 90 | *
|
|---|
| 91 | * @see CF_Debug_PrintCallStack
|
|---|
| 92 | */
|
|---|
| 93 | # define CF_DEBUG_PRINT_CALLSTACK(__fp) \
|
|---|
| 94 | CF_Debug_PrintCallStack (__fp)
|
|---|
| 95 |
|
|---|
| [6] | 96 | #else // #ifdef _DEBUG
|
|---|
| [25] | 97 | # define CF_DEBUG_PRINT(__fp,__fmt,...)
|
|---|
| 98 | # define CF_DEBUG_PRINT_BIN(__fp,__bin,__len,__fmt,...)
|
|---|
| [62] | 99 | # define CF_DEBUG_INITIALIZE
|
|---|
| 100 | # define CF_DEBUG_FINALIZE
|
|---|
| [51] | 101 | # define CF_DEBUG_BEGIN_FUNCTION
|
|---|
| 102 | # define CF_DEBUG_END_FUNCTION
|
|---|
| [63] | 103 | # define CF_DEBUG_PRINT_CALLSTACK(__fp)
|
|---|
| [6] | 104 | #endif // #ifdef _DEBUG
|
|---|
| 105 |
|
|---|
| 106 | #ifdef __cplusplus
|
|---|
| 107 | extern "C" {
|
|---|
| 108 | #endif
|
|---|
| 109 |
|
|---|
| 110 | CF_EXPORT int
|
|---|
| [16] | 111 | CF_Debug_Print (FILE * fp,
|
|---|
| 112 | const char * file,
|
|---|
| 113 | const char * func,
|
|---|
| 114 | const int line,
|
|---|
| 115 | const char * fmt, ...);
|
|---|
| 116 |
|
|---|
| [26] | 117 | CF_EXPORT int
|
|---|
| [16] | 118 | CF_Debug_PrintBin (FILE * fp,
|
|---|
| 119 | const char * file,
|
|---|
| 120 | const char * func,
|
|---|
| 121 | const int line,
|
|---|
| 122 | const unsigned char * bin,
|
|---|
| 123 | const int len,
|
|---|
| 124 | const char * fmt, ...);
|
|---|
| 125 |
|
|---|
| 126 | CF_EXPORT int
|
|---|
| [62] | 127 | CF_Debug_Initialize (void);
|
|---|
| 128 |
|
|---|
| 129 | CF_EXPORT int
|
|---|
| 130 | CF_Debug_Finalize (void);
|
|---|
| 131 |
|
|---|
| 132 | CF_EXPORT int
|
|---|
| [51] | 133 | CF_Debug_PrintCallStack (FILE * fp);
|
|---|
| [6] | 134 |
|
|---|
| 135 | CF_EXPORT int
|
|---|
| [51] | 136 | CF_Debug_EnterFunction (const char * file,
|
|---|
| 137 | const char * func,
|
|---|
| 138 | const int line);
|
|---|
| [6] | 139 |
|
|---|
| 140 | CF_EXPORT int
|
|---|
| [51] | 141 | CF_Debug_LeaveFunction (void);
|
|---|
| [6] | 142 |
|
|---|
| [10] | 143 | #ifdef __cplusplus
|
|---|
| 144 | }
|
|---|
| 145 | #endif
|
|---|
| 146 |
|
|---|
| [6] | 147 | #endif // #ifndef __CF_DEBUG_H__
|
|---|
