trace-util.h

Go to the documentation of this file.

 
#ifndef TRACE_UTIL_H
#define TRACE_UTIL_H
 
/* size_t (trace_hex_write / trace_hex_writef で使用) */
#include <stddef.h>
/* int64_t (trace_modify_name で使用) */
#include <inttypes.h>
 
/* 内部で使用するプラットフォーム固有ヘッダー */
#ifdef _WIN32
#include <trace-etw-util.h>
#else /* !_WIN32 */
#include <trace-syslog-util.h>
#endif /* _WIN32 */
 
/* ===== デフォルトプロバイダ定義 (Windows) ===== */
 
#ifdef _WIN32

#define TRACE_DEFAULT_PROVIDER_NAME "Company.Product"

#define TRACE_DEFAULT_PROVIDER_GUID \
    (0xc3a7b5d1, 0x4e2f, 0x4a89, 0x96, 0xc8, 0xd7, 0xe9, 0xf1, 0xa2, 0xb3, 0xc4)

#define TRACE_DEFAULT_PROVIDER_GUID_STR \
    "c3a7b5d1-4e2f-4a89-96c8-d7e9f1a2b3c4"
 
#endif /* _WIN32 */
 
/* ===== DLL エクスポート / インポート制御マクロ ===== */
 
#ifdef DOXYGEN

#define TRACE_UTIL_EXPORT

#define TRACE_UTIL_API
 
#else /* !DOXYGEN */
 
#ifndef _WIN32
    #define TRACE_UTIL_EXPORT
    #define TRACE_UTIL_API
#else /* _WIN32 */
    #ifndef __INTELLISENSE__
        #ifndef TRACE_UTIL_STATIC
            #ifdef TRACE_UTIL_EXPORTS
                #define TRACE_UTIL_EXPORT __declspec(dllexport)
            #else /* !TRACE_UTIL_EXPORTS */
                #define TRACE_UTIL_EXPORT __declspec(dllimport)
            #endif /* TRACE_UTIL_EXPORTS */
        #else      /* TRACE_UTIL_STATIC */
            #define TRACE_UTIL_EXPORT
        #endif /* TRACE_UTIL_STATIC */
    #else      /* __INTELLISENSE__ */
        #define TRACE_UTIL_EXPORT
    #endif /* __INTELLISENSE__ */
    #ifndef TRACE_UTIL_API
        #define TRACE_UTIL_API __stdcall
    #endif /* TRACE_UTIL_API */
#endif     /* _WIN32 */
 
#endif /* DOXYGEN */
 
/* ===== メッセージ長制限 ===== */

#define TRACE_MESSAGE_MAX_BYTES 1024

#define TRACE_HEX_MAX_DATA_BYTES 341
 
/* ===== 共通トレースレベル ===== */

enum trace_level
{
    TRACE_LV_CRITICAL = 0, 
    TRACE_LV_ERROR    = 1, 
    TRACE_LV_WARNING  = 2, 
    TRACE_LV_INFO     = 3, 
    TRACE_LV_VERBOSE  = 4, 
    TRACE_LV_NONE     = 5  
};
 
/* ===== デフォルトトレースレベル ===== */

#define TRACE_DEFAULT_OS_LEVEL   TRACE_LV_INFO

#define TRACE_DEFAULT_FILE_LEVEL TRACE_LV_ERROR

#define TRACE_DEFAULT_STDERR_LEVEL TRACE_LV_NONE
 
/* ===== 不透明ハンドル型 ===== */

typedef struct trace_provider trace_provider_t;
 
/* ===== API 関数 ===== */
 
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */

    TRACE_UTIL_EXPORT trace_provider_t *TRACE_UTIL_API
        trace_init(void);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_start(trace_provider_t *handle);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_stop(trace_provider_t *handle);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_write(trace_provider_t *handle, enum trace_level level, const char *message);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_writef(trace_provider_t *handle, enum trace_level level, const char *format, ...);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_hex_write(trace_provider_t *handle, enum trace_level level,
                      const void *data, size_t size, const char *message);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_hex_writef(trace_provider_t *handle, enum trace_level level,
                       const void *data, size_t size, const char *format, ...);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_modify_name(trace_provider_t *handle, const char *name, int64_t identifier);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_modify_ostrc(trace_provider_t *handle, enum trace_level level);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_modify_filetrc(trace_provider_t *handle, const char *path,
                             enum trace_level level, size_t max_bytes, int generations);

    TRACE_UTIL_EXPORT int TRACE_UTIL_API
        trace_modify_stderrtrc(trace_provider_t *handle, enum trace_level level);

    TRACE_UTIL_EXPORT enum trace_level TRACE_UTIL_API
        trace_get_ostrc(trace_provider_t *handle);

    TRACE_UTIL_EXPORT enum trace_level TRACE_UTIL_API
        trace_get_filetrc(trace_provider_t *handle);

    TRACE_UTIL_EXPORT enum trace_level TRACE_UTIL_API
        trace_get_stderrtrc(trace_provider_t *handle);

    TRACE_UTIL_EXPORT void TRACE_UTIL_API
        trace_dispose(trace_provider_t *handle);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* TRACE_UTIL_H */