utrace.h

Go to the documentation of this file.

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
*
*   Copyright (C) 2003-2013, International Business Machines
*   Corporation and others.  All Rights Reserved.
*
*******************************************************************************
*   file name:  utrace.h
*   encoding:   UTF-8
*   tab size:   8 (not used)
*   indentation:4
*
*   created on: 2003aug06
*   created by: Markus W. Scherer
*
*   Definitions for ICU tracing/logging.
*
*/
 
#ifndef __UTRACE_H__
#define __UTRACE_H__
 
#include <stdarg.h>
#include "unicode/utypes.h"

 
U_CDECL_BEGIN

typedef enum UTraceLevel {
    UTRACE_OFF=-1,
    UTRACE_ERROR=0,
    UTRACE_WARNING=3,
    UTRACE_OPEN_CLOSE=5,
    UTRACE_INFO=7,
    UTRACE_VERBOSE=9
} UTraceLevel;

typedef enum UTraceFunctionNumber {
    UTRACE_FUNCTION_START=0,
    UTRACE_U_INIT=UTRACE_FUNCTION_START,
    UTRACE_U_CLEANUP,
 
#ifndef U_HIDE_DEPRECATED_API
    UTRACE_FUNCTION_LIMIT,
#endif  // U_HIDE_DEPRECATED_API
 
    UTRACE_CONVERSION_START=0x1000,
    UTRACE_UCNV_OPEN=UTRACE_CONVERSION_START,
    UTRACE_UCNV_OPEN_PACKAGE,
    UTRACE_UCNV_OPEN_ALGORITHMIC,
    UTRACE_UCNV_CLONE,
    UTRACE_UCNV_CLOSE,
    UTRACE_UCNV_FLUSH_CACHE,
    UTRACE_UCNV_LOAD,
    UTRACE_UCNV_UNLOAD,
 
#ifndef U_HIDE_DEPRECATED_API
    UTRACE_CONVERSION_LIMIT,
#endif  // U_HIDE_DEPRECATED_API
 
    UTRACE_COLLATION_START=0x2000,
    UTRACE_UCOL_OPEN=UTRACE_COLLATION_START,
    UTRACE_UCOL_CLOSE,
    UTRACE_UCOL_STRCOLL,
    UTRACE_UCOL_GET_SORTKEY,
    UTRACE_UCOL_GETLOCALE,
    UTRACE_UCOL_NEXTSORTKEYPART,
    UTRACE_UCOL_STRCOLLITER,
    UTRACE_UCOL_OPEN_FROM_SHORT_STRING,
    UTRACE_UCOL_STRCOLLUTF8, 
 
#ifndef U_HIDE_DEPRECATED_API
    UTRACE_COLLATION_LIMIT,
#endif  // U_HIDE_DEPRECATED_API
 
#ifndef U_HIDE_DRAFT_API

    UTRACE_UDATA_START=0x3000,

    UTRACE_UDATA_RESOURCE=UTRACE_UDATA_START,

    UTRACE_UDATA_BUNDLE,

    UTRACE_UDATA_DATA_FILE,

    UTRACE_UDATA_RES_FILE,
 
#endif  // U_HIDE_DRAFT_API
 
#ifndef U_HIDE_INTERNAL_API
    UTRACE_RES_DATA_LIMIT,
#endif  // U_HIDE_INTERNAL_API
 
#ifndef U_HIDE_DRAFT_API
    UTRACE_UBRK_START=0x4000,

    UTRACE_UBRK_CREATE_CHARACTER = UTRACE_UBRK_START,

    UTRACE_UBRK_CREATE_WORD,

    UTRACE_UBRK_CREATE_LINE,

    UTRACE_UBRK_CREATE_SENTENCE,

    UTRACE_UBRK_CREATE_TITLE,

    UTRACE_UBRK_CREATE_BREAK_ENGINE,
 
#endif  // U_HIDE_DRAFT_API
 
#ifndef U_HIDE_INTERNAL_API
    UTRACE_UBRK_LIMIT,
#endif  // U_HIDE_INTERNAL_API
 
} UTraceFunctionNumber;

U_STABLE void U_EXPORT2
utrace_setLevel(int32_t traceLevel);

U_STABLE int32_t U_EXPORT2
utrace_getLevel(void);
 
/* Trace function pointers types  ----------------------------- */

typedef void U_CALLCONV
UTraceEntry(const void *context, int32_t fnNumber);

typedef void U_CALLCONV
UTraceExit(const void *context, int32_t fnNumber, 
           const char *fmt, va_list args);

typedef void U_CALLCONV
UTraceData(const void *context, int32_t fnNumber, int32_t level,
           const char *fmt, va_list args);

U_STABLE void U_EXPORT2
utrace_setFunctions(const void *context,
                    UTraceEntry *e, UTraceExit *x, UTraceData *d);

U_STABLE void U_EXPORT2
utrace_getFunctions(const void **context,
                    UTraceEntry **e, UTraceExit **x, UTraceData **d);
 
 
 
/*
 *
 * ICU trace format string syntax
 *
 * Format Strings are passed to UTraceData functions, and define the
 * number and types of the trace data being passed on each call.
 *
 * The UTraceData function, which is supplied by the application,
 * not by ICU, can either forward the trace data (passed via
 * varargs) and the format string back to ICU for formatting into
 * a displayable string, or it can interpret the format itself,
 * and do as it wishes with the trace data.
 *
 *
 * Goals for the format string
 * - basic data output
 * - easy to use for trace programmer
 * - sufficient provision for data types for trace output readability
 * - well-defined types and binary portable APIs
 *
 * Non-goals
 * - printf compatibility
 * - fancy formatting
 * - argument reordering and other internationalization features
 *
 * ICU trace format strings contain plain text with argument inserts,
 * much like standard printf format strings.
 * Each insert begins with a '%', then optionally contains a 'v',
 * then exactly one type character.
 * Two '%' in a row represent a '%' instead of an insert.
 * The trace format strings need not have \n at the end.
 *
 *
 * Types
 * -----
 *
 * Type characters:
 * - c A char character in the default codepage.
 * - s A NUL-terminated char * string in the default codepage.
 * - S A UChar * string.  Requires two params, (ptr, length).  Length=-1 for nul term.
 * - b A byte (8-bit integer).
 * - h A 16-bit integer.  Also a 16 bit Unicode code unit.
 * - d A 32-bit integer.  Also a 20 bit Unicode code point value. 
 * - l A 64-bit integer.
 * - p A data pointer.
 *
 * Vectors
 * -------
 *
 * If the 'v' is not specified, then one item of the specified type
 * is passed in.
 * If the 'v' (for "vector") is specified, then a vector of items of the
 * specified type is passed in, via a pointer to the first item
 * and an int32_t value for the length of the vector.
 * Length==-1 means zero or NUL termination.  Works for vectors of all types.
 *
 * Note:  %vS is a vector of (UChar *) strings.  The strings must
 *        be nul terminated as there is no way to provide a
 *        separate length parameter for each string.  The length
 *        parameter (required for all vectors) is the number of
 *        strings, not the length of the strings.
 *
 * Examples
 * --------
 *
 * These examples show the parameters that will be passed to an application's
 *   UTraceData() function for various formats.
 *
 * - the precise formatting is up to the application!
 * - the examples use type casts for arguments only to _show_ the types of
 *   arguments without needing variable declarations in the examples;
 *   the type casts will not be necessary in actual code
 *
 * UTraceDataFunc(context, fnNumber, level,
 *              "There is a character %c in the string %s.",   // Format String 
 *              (char)c, (const char *)s);                     // varargs parameters
 * ->   There is a character 0x42 'B' in the string "Bravo".
 *
 * UTraceDataFunc(context, fnNumber, level,
 *              "Vector of bytes %vb vector of chars %vc",
 *              (const uint8_t *)bytes, (int32_t)bytesLength,
 *              (const char *)chars, (int32_t)charsLength);
 * ->  Vector of bytes
 *      42 63 64 3f [4]
 *     vector of chars
 *      "Bcd?"[4]
 *
 * UTraceDataFunc(context, fnNumber, level,
 *              "An int32_t %d and a whole bunch of them %vd",
 *              (int32_t)-5, (const int32_t *)ints, (int32_t)intsLength);
 * ->   An int32_t 0xfffffffb and a whole bunch of them
 *      fffffffb 00000005 0000010a [3]
 *
 */
 
 

U_STABLE int32_t U_EXPORT2
utrace_vformat(char *outBuf, int32_t capacity,
              int32_t indent, const char *fmt,  va_list args);

U_STABLE int32_t U_EXPORT2
utrace_format(char *outBuf, int32_t capacity,
              int32_t indent, const char *fmt,  ...);
 
 
 
/* Trace function numbers --------------------------------------------------- */

U_STABLE const char * U_EXPORT2
utrace_functionName(int32_t fnNumber);
 
U_CDECL_END
 
#endif