ICU 67.1 67.1

utrace.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 *
6 * Copyright (C) 2003-2013, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 *******************************************************************************
10 * file name: utrace.h
11 * encoding: UTF-8
12 * tab size: 8 (not used)
13 * indentation:4
14 *
15 * created on: 2003aug06
16 * created by: Markus W. Scherer
17 *
18 * Definitions for ICU tracing/logging.
19 *
20 */
21
22 #ifndef __UTRACE_H__
23 #define __UTRACE_H__
24
25 #include <stdarg.h>
26 #include "unicode/utypes.h"
27
39 U_CDECL_BEGIN
40
46 typedef enum UTraceLevel {
48 UTRACE_OFF=-1,
50 UTRACE_ERROR=0,
52 UTRACE_WARNING=3,
54 UTRACE_OPEN_CLOSE=5,
56 UTRACE_INFO=7,
58 UTRACE_VERBOSE=9
59 } UTraceLevel;
60
65 typedef enum UTraceFunctionNumber {
66 UTRACE_FUNCTION_START=0,
67 UTRACE_U_INIT=UTRACE_FUNCTION_START,
68 UTRACE_U_CLEANUP,
69
70 #ifndef U_HIDE_DEPRECATED_API
71
75 UTRACE_FUNCTION_LIMIT,
76 #endif // U_HIDE_DEPRECATED_API
77
78 UTRACE_CONVERSION_START=0x1000,
79 UTRACE_UCNV_OPEN=UTRACE_CONVERSION_START,
80 UTRACE_UCNV_OPEN_PACKAGE,
81 UTRACE_UCNV_OPEN_ALGORITHMIC,
82 UTRACE_UCNV_CLONE,
83 UTRACE_UCNV_CLOSE,
84 UTRACE_UCNV_FLUSH_CACHE,
85 UTRACE_UCNV_LOAD,
86 UTRACE_UCNV_UNLOAD,
87
88 #ifndef U_HIDE_DEPRECATED_API
89
93 UTRACE_CONVERSION_LIMIT,
94 #endif // U_HIDE_DEPRECATED_API
95
96 UTRACE_COLLATION_START=0x2000,
97 UTRACE_UCOL_OPEN=UTRACE_COLLATION_START,
98 UTRACE_UCOL_CLOSE,
99 UTRACE_UCOL_STRCOLL,
100 UTRACE_UCOL_GET_SORTKEY,
101 UTRACE_UCOL_GETLOCALE,
102 UTRACE_UCOL_NEXTSORTKEYPART,
103 UTRACE_UCOL_STRCOLLITER,
104 UTRACE_UCOL_OPEN_FROM_SHORT_STRING,
105 UTRACE_UCOL_STRCOLLUTF8,
107 #ifndef U_HIDE_DEPRECATED_API
108
112 UTRACE_COLLATION_LIMIT,
113 #endif // U_HIDE_DEPRECATED_API
114
115 #ifndef U_HIDE_DRAFT_API
116
121 UTRACE_UDATA_START=0x3000,
122
138 UTRACE_UDATA_RESOURCE=UTRACE_UDATA_START,
139
146 UTRACE_UDATA_BUNDLE,
147
155 UTRACE_UDATA_DATA_FILE,
156
168 UTRACE_UDATA_RES_FILE,
169
170 #endif // U_HIDE_DRAFT_API
171
172 #ifndef U_HIDE_INTERNAL_API
173
177 UTRACE_RES_DATA_LIMIT,
178 #endif // U_HIDE_INTERNAL_API
179
180 #ifndef U_HIDE_DRAFT_API
181
185 UTRACE_UBRK_START=0x4000,
186
192 UTRACE_UBRK_CREATE_CHARACTER = UTRACE_UBRK_START,
193
199 UTRACE_UBRK_CREATE_WORD,
200
209 UTRACE_UBRK_CREATE_LINE,
210
216 UTRACE_UBRK_CREATE_SENTENCE,
217
223 UTRACE_UBRK_CREATE_TITLE,
224
233 UTRACE_UBRK_CREATE_BREAK_ENGINE,
234
235 #endif // U_HIDE_DRAFT_API
236
237 #ifndef U_HIDE_INTERNAL_API
238
242 UTRACE_UBRK_LIMIT,
243 #endif // U_HIDE_INTERNAL_API
244
245 } UTraceFunctionNumber;
246
252 U_STABLE void U_EXPORT2
253 utrace_setLevel(int32_t traceLevel);
254
260 U_STABLE int32_t U_EXPORT2
261 utrace_getLevel(void);
262
263 /* Trace function pointers types ----------------------------- */
264
271 typedef void U_CALLCONV
272 UTraceEntry(const void *context, int32_t fnNumber);
273
287 typedef void U_CALLCONV
288 UTraceExit(const void *context, int32_t fnNumber,
289 const char *fmt, va_list args);
290
302 typedef void U_CALLCONV
303 UTraceData(const void *context, int32_t fnNumber, int32_t level,
304 const char *fmt, va_list args);
305
334 U_STABLE void U_EXPORT2
335 utrace_setFunctions(const void *context,
336 UTraceEntry *e, UTraceExit *x, UTraceData *d);
337
348 U_STABLE void U_EXPORT2
349 utrace_getFunctions(const void **context,
350 UTraceEntry **e, UTraceExit **x, UTraceData **d);
351
352
353
354 /*
355 *
356 * ICU trace format string syntax
357 *
358 * Format Strings are passed to UTraceData functions, and define the
359 * number and types of the trace data being passed on each call.
360 *
361 * The UTraceData function, which is supplied by the application,
362 * not by ICU, can either forward the trace data (passed via
363 * varargs) and the format string back to ICU for formatting into
364 * a displayable string, or it can interpret the format itself,
365 * and do as it wishes with the trace data.
366 *
367 *
368 * Goals for the format string
369 * - basic data output
370 * - easy to use for trace programmer
371 * - sufficient provision for data types for trace output readability
372 * - well-defined types and binary portable APIs
373 *
374 * Non-goals
375 * - printf compatibility
376 * - fancy formatting
377 * - argument reordering and other internationalization features
378 *
379 * ICU trace format strings contain plain text with argument inserts,
380 * much like standard printf format strings.
381 * Each insert begins with a '%', then optionally contains a 'v',
382 * then exactly one type character.
383 * Two '%' in a row represent a '%' instead of an insert.
384 * The trace format strings need not have \n at the end.
385 *
386 *
387 * Types
388 * -----
389 *
390 * Type characters:
391 * - c A char character in the default codepage.
392 * - s A NUL-terminated char * string in the default codepage.
393 * - S A UChar * string. Requires two params, (ptr, length). Length=-1 for nul term.
394 * - b A byte (8-bit integer).
395 * - h A 16-bit integer. Also a 16 bit Unicode code unit.
396 * - d A 32-bit integer. Also a 20 bit Unicode code point value.
397 * - l A 64-bit integer.
398 * - p A data pointer.
399 *
400 * Vectors
401 * -------
402 *
403 * If the 'v' is not specified, then one item of the specified type
404 * is passed in.
405 * If the 'v' (for "vector") is specified, then a vector of items of the
406 * specified type is passed in, via a pointer to the first item
407 * and an int32_t value for the length of the vector.
408 * Length==-1 means zero or NUL termination. Works for vectors of all types.
409 *
410 * Note: %vS is a vector of (UChar *) strings. The strings must
411 * be nul terminated as there is no way to provide a
412 * separate length parameter for each string. The length
413 * parameter (required for all vectors) is the number of
414 * strings, not the length of the strings.
415 *
416 * Examples
417 * --------
418 *
419 * These examples show the parameters that will be passed to an application's
420 * UTraceData() function for various formats.
421 *
422 * - the precise formatting is up to the application!
423 * - the examples use type casts for arguments only to _show_ the types of
424 * arguments without needing variable declarations in the examples;
425 * the type casts will not be necessary in actual code
426 *
427 * UTraceDataFunc(context, fnNumber, level,
428 * "There is a character %c in the string %s.", // Format String
429 * (char)c, (const char *)s); // varargs parameters
430 * -> There is a character 0x42 'B' in the string "Bravo".
431 *
432 * UTraceDataFunc(context, fnNumber, level,
433 * "Vector of bytes %vb vector of chars %vc",
434 * (const uint8_t *)bytes, (int32_t)bytesLength,
435 * (const char *)chars, (int32_t)charsLength);
436 * -> Vector of bytes
437 * 42 63 64 3f [4]
438 * vector of chars
439 * "Bcd?"[4]
440 *
441 * UTraceDataFunc(context, fnNumber, level,
442 * "An int32_t %d and a whole bunch of them %vd",
443 * (int32_t)-5, (const int32_t *)ints, (int32_t)intsLength);
444 * -> An int32_t 0xfffffffb and a whole bunch of them
445 * fffffffb 00000005 0000010a [3]
446 *
447 */
448
449
450
470 U_STABLE int32_t U_EXPORT2
471 utrace_vformat(char *outBuf, int32_t capacity,
472 int32_t indent, const char *fmt, va_list args);
473
491 U_STABLE int32_t U_EXPORT2
492 utrace_format(char *outBuf, int32_t capacity,
493 int32_t indent, const char *fmt, ...);
494
495
496
497 /* Trace function numbers --------------------------------------------------- */
498
508 U_STABLE const char * U_EXPORT2
509 utrace_functionName(int32_t fnNumber);
510
511 U_CDECL_END
512
513 #endif
UTraceLevel
UTraceLevel
Trace severity levels.
Definition: utrace.h:46
UTRACE_UCOL_STRCOLLUTF8
Definition: utrace.h:105
UTRACE_UBRK_LIMIT
One more than the highest normal break iterator trace location.
Definition: utrace.h:242
UTRACE_UBRK_CREATE_TITLE
Indicates that a title instance of break iterator was created.
Definition: utrace.h:223
UTRACE_FUNCTION_LIMIT
One more than the highest normal collation trace location.
Definition: utrace.h:75
UTRACE_VERBOSE
Trace the maximum number of ICU operations.
Definition: utrace.h:58
UTraceEntry
void UTraceEntry(const void *context, int32_t fnNumber)
Type signature for the trace function to be called when entering a function.
Definition: utrace.h:272
UTRACE_UBRK_START
The lowest break iterator location.
Definition: utrace.h:185
U_CALLCONV
#define U_CALLCONV
Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...
Definition: platform.h:870
UTraceExit
void UTraceExit(const void *context, int32_t fnNumber, const char *fmt, va_list args)
Type signature for the trace function to be called when exiting from a function.
Definition: utrace.h:288
UTRACE_UDATA_START
The lowest resource/data location.
Definition: utrace.h:121
utrace_getLevel
int32_t utrace_getLevel(void)
Getter for the trace level.
UTRACE_ERROR
Trace error conditions only.
Definition: utrace.h:50
U_CDECL_BEGIN
#define U_CDECL_BEGIN
This is used to begin a declaration of a library private ICU C API.
Definition: umachine.h:84
UTRACE_UBRK_CREATE_CHARACTER
Indicates that a character instance of break iterator was created.
Definition: utrace.h:192
UTRACE_INFO
Trace an intermediate number of ICU operations.
Definition: utrace.h:56
UTRACE_COLLATION_LIMIT
One more than the highest normal collation trace location.
Definition: utrace.h:112
UTRACE_RES_DATA_LIMIT
One more than the highest normal resource/data trace location.
Definition: utrace.h:177
UTRACE_UDATA_BUNDLE
Indicates that a resource bundle was opened.
Definition: utrace.h:146
UTraceData
void UTraceData(const void *context, int32_t fnNumber, int32_t level, const char *fmt, va_list args)
Type signature for the trace function to be called from within an ICU function to display data or mes...
Definition: utrace.h:303
UTRACE_UDATA_DATA_FILE
Indicates that a data file was opened, but not *.res files.
Definition: utrace.h:155
utrace_setLevel
void utrace_setLevel(int32_t traceLevel)
Setter for the trace level.
UTRACE_CONVERSION_LIMIT
One more than the highest normal collation trace location.
Definition: utrace.h:93
utrace_functionName
const char * utrace_functionName(int32_t fnNumber)
Get the name of a function from its trace function number.
UTRACE_UBRK_CREATE_BREAK_ENGINE
Indicates that an internal dictionary break engine was created.
Definition: utrace.h:233
UTRACE_WARNING
Trace errors and warnings.
Definition: utrace.h:52
utrace_setFunctions
void utrace_setFunctions(const void *context, UTraceEntry *e, UTraceExit *x, UTraceData *d)
Set ICU Tracing functions.
utrace_format
int32_t utrace_format(char *outBuf, int32_t capacity, int32_t indent, const char *fmt,...)
Trace output Formatter.
UTraceFunctionNumber
UTraceFunctionNumber
These are the ICU functions that will be traced when tracing is enabled.
Definition: utrace.h:65
UTRACE_UDATA_RESOURCE
Indicates that a value was read from a resource bundle.
Definition: utrace.h:138
U_CDECL_END
#define U_CDECL_END
This is used to end a declaration of a library private ICU C API.
Definition: umachine.h:85
UTRACE_UDATA_RES_FILE
Indicates that a *.res file was opened.
Definition: utrace.h:168
UTRACE_OFF
Disable all tracing.
Definition: utrace.h:48
UTRACE_UBRK_CREATE_WORD
Indicates that a word instance of break iterator was created.
Definition: utrace.h:199
UTRACE_UBRK_CREATE_SENTENCE
Indicates that a sentence instance of break iterator was created.
Definition: utrace.h:216
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UTRACE_OPEN_CLOSE
Trace opens and closes of ICU services.
Definition: utrace.h:54
utrace_vformat
int32_t utrace_vformat(char *outBuf, int32_t capacity, int32_t indent, const char *fmt, va_list args)
Trace output Formatter.
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111
utrace_getFunctions
void utrace_getFunctions(const void **context, UTraceEntry **e, UTraceExit **x, UTraceData **d)
Get the currently installed ICU tracing functions.
UTRACE_UBRK_CREATE_LINE
Indicates that a line instance of break iterator was created.
Definition: utrace.h:209