2 ************************************************************************
3 * Copyright (c) 2008-2010, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 ************************************************************************
8 /** C Utilities to aid in debugging **/
13 #include "unicode/utypes.h"
17 UDBG_UDebugEnumType
= 0, /* Self-referential, strings for UDebugEnumType. Count=ENUM_COUNT. */
18 #if !UCONFIG_NO_FORMATTING
19 UDBG_UCalendarDateFields
, /* UCalendarDateFields. Count=UCAL_FIELD_COUNT. Unsupported if UCONFIG_NO_FORMATTING. */
20 UDBG_UCalendarMonths
, /* UCalendarMonths. Count= (UCAL_UNDECIMBER+1) */
21 UDBG_UDateFormatStyle
, /* Count = UDAT_SHORT=1 */
23 UDBG_UPlugReason
, /* Count = UPLUG_REASON_COUNT */
24 UDBG_UPlugLevel
, /* COUNT = UPLUG_LEVEL_COUNT */
25 UDBG_UAcceptResult
, /* Count = ULOC_ACCEPT_FALLBACK+1=3 */
27 /* All following enums may be discontiguous. */
29 #if !UCONFIG_NO_COLLATION
30 UDBG_UColAttributeValue
, /* UCOL_ATTRIBUTE_VALUE_COUNT */
33 UDBG_HIGHEST_CONTIGUOUS_ENUM
= UDBG_UAcceptResult
, /**< last enum in this list with contiguous (testable) values. */
34 UDBG_INVALID_ENUM
= -1 /** Invalid enum value **/
37 typedef enum UDebugEnumType UDebugEnumType
;
40 * @param type the type of enum
41 * Print how many enums are contained for this type.
42 * Should be equal to the appropriate _COUNT constant or there is an error. Return -1 if unsupported.
44 U_CAPI
int32_t U_EXPORT2
udbg_enumCount(UDebugEnumType type
);
47 * Convert an enum to a string
48 * @param type type of enum
49 * @param field field number
50 * @return string of the format "ERA", "YEAR", etc, or NULL if out of range or unsupported
52 U_CAPI
const char * U_EXPORT2
udbg_enumName(UDebugEnumType type
, int32_t field
);
55 * for consistency checking
56 * @param type the type of enum
57 * Print how many enums should be contained for this type.
58 * This is equal to the appropriate _COUNT constant or there is an error. Returns -1 if unsupported.
60 U_CAPI
int32_t U_EXPORT2
udbg_enumExpectedCount(UDebugEnumType type
);
63 * For consistency checking, returns the expected enum ordinal value for the given index value.
64 * @param type which type
65 * @param field field number
66 * @return should be equal to 'field' or -1 if out of range.
68 U_CAPI
int32_t U_EXPORT2
udbg_enumArrayValue(UDebugEnumType type
, int32_t field
);
71 * Locate the specified field value by name.
72 * @param type which type
73 * @param name name of string (case sensitive)
74 * @return should be a field value or -1 if not found.
76 U_CAPI
int32_t U_EXPORT2
udbg_enumByName(UDebugEnumType type
, const char *name
);