Gecko [ dallasfobana2023.variationbd.com ]

Name	Size	Permission
alphaindex.h	26.54 KB	-rw-r--r--
appendable.h	8.54 KB	-rw-r--r--
basictz.h	9.99 KB	-rw-r--r--
brkiter.h	27.83 KB	-rw-r--r--
bytestream.h	10.75 KB	-rw-r--r--
bytestrie.h	20.8 KB	-rw-r--r--
bytestriebuilder.h	7.48 KB	-rw-r--r--
calendar.h	107.68 KB	-rw-r--r--
caniter.h	7.53 KB	-rw-r--r--
casemap.h	25.42 KB	-rw-r--r--
char16ptr.h	7.22 KB	-rw-r--r--
chariter.h	23.79 KB	-rw-r--r--
choicfmt.h	23.99 KB	-rw-r--r--
coleitr.h	13.77 KB	-rw-r--r--
coll.h	56.28 KB	-rw-r--r--
compactdecimalformat.h	6.88 KB	-rw-r--r--
curramt.h	3.67 KB	-rw-r--r--
currpinf.h	7.3 KB	-rw-r--r--
currunit.h	4.02 KB	-rw-r--r--
datefmt.h	40.7 KB	-rw-r--r--
dbbi.h	1.19 KB	-rw-r--r--
dcfmtsym.h	20.93 KB	-rw-r--r--
decimfmt.h	87.46 KB	-rw-r--r--
displayoptions.h	7.08 KB	-rw-r--r--
docmain.h	7.46 KB	-rw-r--r--
dtfmtsym.h	38.21 KB	-rw-r--r--
dtintrv.h	3.84 KB	-rw-r--r--
dtitvfmt.h	48.87 KB	-rw-r--r--
dtitvinf.h	18.63 KB	-rw-r--r--
dtptngen.h	28.05 KB	-rw-r--r--
dtrule.h	8.66 KB	-rw-r--r--
edits.h	20.73 KB	-rw-r--r--
enumset.h	2.08 KB	-rw-r--r--
errorcode.h	4.84 KB	-rw-r--r--
fieldpos.h	8.69 KB	-rw-r--r--
filteredbrk.h	5.37 KB	-rw-r--r--
fmtable.h	24.36 KB	-rw-r--r--
format.h	12.5 KB	-rw-r--r--
formattednumber.h	6.28 KB	-rw-r--r--
formattedvalue.h	9.75 KB	-rw-r--r--
fpositer.h	3.03 KB	-rw-r--r--
gender.h	3.35 KB	-rw-r--r--
gregocal.h	30.3 KB	-rw-r--r--
icudataver.h	1.02 KB	-rw-r--r--
icuplug.h	12.1 KB	-rw-r--r--
idna.h	12.71 KB	-rw-r--r--
listformatter.h	8.59 KB	-rw-r--r--
localebuilder.h	11.08 KB	-rw-r--r--
localematcher.h	26.86 KB	-rw-r--r--
localpointer.h	19.55 KB	-rw-r--r--
locdspnm.h	7.12 KB	-rw-r--r--
locid.h	48.31 KB	-rw-r--r--
measfmt.h	11.41 KB	-rw-r--r--
measunit.h	108.23 KB	-rw-r--r--
measure.h	4.68 KB	-rw-r--r--
messageformat2.h	18.13 KB	-rw-r--r--
messageformat2_arguments.h	4.3 KB	-rw-r--r--
messageformat2_data_model.h	123 KB	-rw-r--r--
messageformat2_data_model_name...	784 B	-rw-r--r--
messageformat2_formattable.h	38.29 KB	-rw-r--r--
messageformat2_function_regist...	18 KB	-rw-r--r--
messagepattern.h	33.72 KB	-rw-r--r--
msgfmt.h	44.2 KB	-rw-r--r--
normalizer2.h	34.73 KB	-rw-r--r--
normlzr.h	30.79 KB	-rw-r--r--
nounit.h	2.24 KB	-rw-r--r--
numberformatter.h	90.74 KB	-rw-r--r--
numberrangeformatter.h	26.05 KB	-rw-r--r--
numfmt.h	50.16 KB	-rw-r--r--
numsys.h	7.22 KB	-rw-r--r--
parseerr.h	3.08 KB	-rw-r--r--
parsepos.h	5.56 KB	-rw-r--r--
platform.h	26.66 KB	-rw-r--r--
plurfmt.h	25.07 KB	-rw-r--r--
plurrule.h	20.63 KB	-rw-r--r--
ptypes.h	2.16 KB	-rw-r--r--
putil.h	6.32 KB	-rw-r--r--
rbbi.h	32.04 KB	-rw-r--r--
rbnf.h	50.53 KB	-rw-r--r--
rbtz.h	15.75 KB	-rw-r--r--
regex.h	84.45 KB	-rw-r--r--
region.h	9.2 KB	-rw-r--r--
reldatefmt.h	22.36 KB	-rw-r--r--
rep.h	9.38 KB	-rw-r--r--
resbund.h	18.03 KB	-rw-r--r--
schriter.h	6.09 KB	-rw-r--r--
scientificnumberformatter.h	6.44 KB	-rw-r--r--
search.h	22.21 KB	-rw-r--r--
selfmt.h	14.35 KB	-rw-r--r--
simpleformatter.h	12.58 KB	-rw-r--r--
simplenumberformatter.h	9.18 KB	-rw-r--r--
simpletz.h	45.62 KB	-rw-r--r--
smpdtfmt.h	57.06 KB	-rw-r--r--
sortkey.h	11.12 KB	-rw-r--r--
std_string.h	1.05 KB	-rw-r--r--
strenum.h	9.96 KB	-rw-r--r--
stringoptions.h	5.79 KB	-rw-r--r--
stringpiece.h	10.02 KB	-rw-r--r--
stringtriebuilder.h	15.5 KB	-rw-r--r--
stsearch.h	21.43 KB	-rw-r--r--
symtable.h	4.28 KB	-rw-r--r--
tblcoll.h	36.93 KB	-rw-r--r--
timezone.h	45.64 KB	-rw-r--r--
tmunit.h	3.4 KB	-rw-r--r--
tmutamt.h	4.9 KB	-rw-r--r--
tmutfmt.h	7.42 KB	-rw-r--r--
translit.h	65.8 KB	-rw-r--r--
tzfmt.h	42.95 KB	-rw-r--r--
tznames.h	16.85 KB	-rw-r--r--
tzrule.h	34.81 KB	-rw-r--r--
tztrans.h	6.11 KB	-rw-r--r--
ubidi.h	89.61 KB	-rw-r--r--
ubiditransform.h	12.71 KB	-rw-r--r--
ubrk.h	24.43 KB	-rw-r--r--
ucal.h	64.01 KB	-rw-r--r--
ucasemap.h	15.21 KB	-rw-r--r--
ucat.h	5.35 KB	-rw-r--r--
uchar.h	150.13 KB	-rw-r--r--
ucharstrie.h	22.56 KB	-rw-r--r--
ucharstriebuilder.h	7.48 KB	-rw-r--r--
uchriter.h	13.24 KB	-rw-r--r--
uclean.h	11.21 KB	-rw-r--r--
ucnv.h	83.34 KB	-rw-r--r--
ucnv_cb.h	6.58 KB	-rw-r--r--
ucnv_err.h	20.98 KB	-rw-r--r--
ucnvsel.h	6.24 KB	-rw-r--r--
ucol.h	62.7 KB	-rw-r--r--
ucoleitr.h	9.82 KB	-rw-r--r--
uconfig.h	12.56 KB	-rw-r--r--
ucpmap.h	5.54 KB	-rw-r--r--
ucptrie.h	22.51 KB	-rw-r--r--
ucsdet.h	14.69 KB	-rw-r--r--
ucurr.h	16.72 KB	-rw-r--r--
udat.h	62.36 KB	-rw-r--r--
udata.h	15.63 KB	-rw-r--r--
udateintervalformat.h	11.93 KB	-rw-r--r--
udatpg.h	30.13 KB	-rw-r--r--
udisplaycontext.h	5.94 KB	-rw-r--r--
udisplayoptions.h	8.86 KB	-rw-r--r--
uenum.h	7.79 KB	-rw-r--r--
ufieldpositer.h	4.41 KB	-rw-r--r--
uformattable.h	10.97 KB	-rw-r--r--
uformattednumber.h	8.09 KB	-rw-r--r--
uformattedvalue.h	12.25 KB	-rw-r--r--
ugender.h	2.06 KB	-rw-r--r--
uidna.h	33.43 KB	-rw-r--r--
uiter.h	22.75 KB	-rw-r--r--
uldnames.h	10.48 KB	-rw-r--r--
ulistformatter.h	10.78 KB	-rw-r--r--
uloc.h	55.38 KB	-rw-r--r--
ulocale.h	6.35 KB	-rw-r--r--
ulocbuilder.h	16.73 KB	-rw-r--r--
ulocdata.h	11.3 KB	-rw-r--r--
umachine.h	14.59 KB	-rw-r--r--
umisc.h	1.34 KB	-rw-r--r--
umsg.h	24.25 KB	-rw-r--r--
umutablecptrie.h	8.3 KB	-rw-r--r--
unifilt.h	4 KB	-rw-r--r--
unifunct.h	4.05 KB	-rw-r--r--
unimatch.h	6.1 KB	-rw-r--r--
unirepl.h	3.38 KB	-rw-r--r--
uniset.h	66.82 KB	-rw-r--r--
unistr.h	171.33 KB	-rw-r--r--
unorm.h	20.55 KB	-rw-r--r--
unorm2.h	25.71 KB	-rw-r--r--
unum.h	55.16 KB	-rw-r--r--
unumberformatter.h	19.68 KB	-rw-r--r--
unumberoptions.h	5.23 KB	-rw-r--r--
unumberrangeformatter.h	15.35 KB	-rw-r--r--
unumsys.h	7.26 KB	-rw-r--r--
uobject.h	10.66 KB	-rw-r--r--
upluralrules.h	8.79 KB	-rw-r--r--
uregex.h	71.99 KB	-rw-r--r--
uregion.h	9.81 KB	-rw-r--r--
ureldatefmt.h	16.98 KB	-rw-r--r--
urename.h	141.31 KB	-rw-r--r--
urep.h	5.38 KB	-rw-r--r--
ures.h	36.65 KB	-rw-r--r--
uscript.h	27.89 KB	-rw-r--r--
usearch.h	39.21 KB	-rw-r--r--
uset.h	45.56 KB	-rw-r--r--
usetiter.h	9.63 KB	-rw-r--r--
ushape.h	18 KB	-rw-r--r--
usimplenumberformatter.h	7.63 KB	-rw-r--r--
uspoof.h	80.32 KB	-rw-r--r--
usprep.h	8.19 KB	-rw-r--r--
ustdio.h	38.56 KB	-rw-r--r--
ustream.h	1.89 KB	-rw-r--r--
ustring.h	72.13 KB	-rw-r--r--
ustringtrie.h	3.15 KB	-rw-r--r--
utext.h	58.1 KB	-rw-r--r--
utf.h	7.87 KB	-rw-r--r--
utf16.h	23.35 KB	-rw-r--r--
utf32.h	763 B	-rw-r--r--
utf8.h	30.83 KB	-rw-r--r--
utf_old.h	45.8 KB	-rw-r--r--
utmscale.h	13.78 KB	-rw-r--r--
utrace.h	17.18 KB	-rw-r--r--
utrans.h	25.54 KB	-rw-r--r--
utypes.h	33.71 KB	-rw-r--r--
uvernum.h	6.33 KB	-rw-r--r--
uversion.h	5.99 KB	-rw-r--r--
vtzone.h	20.68 KB	-rw-r--r--

Code Editor : udatpg.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
*
*   Copyright (C) 2007-2015, International Business Machines
*   Corporation and others.  All Rights Reserved.
*
*******************************************************************************
*   file name:  udatpg.h
*   encoding:   UTF-8
*   tab size:   8 (not used)
*   indentation:4
*
*   created on: 2007jul30
*   created by: Markus W. Scherer
*/

#ifndef __UDATPG_H__
#define __UDATPG_H__

#include "unicode/utypes.h"
#include "unicode/udat.h"
#include "unicode/uenum.h"

#if U_SHOW_CPLUSPLUS_API
#include "unicode/localpointer.h"
#endif   // U_SHOW_CPLUSPLUS_API

/**
 * \file
 * \brief C API: Wrapper for icu::DateTimePatternGenerator (unicode/dtptngen.h).
 *
 * UDateTimePatternGenerator provides flexible generation of date format patterns, 
 * like "yy-MM-dd". The user can build up the generator by adding successive 
 * patterns. Once that is done, a query can be made using a "skeleton", which is 
 * a pattern which just includes the desired fields and lengths. The generator 
 * will return the "best fit" pattern corresponding to that skeleton.
 * The main method people will use is udatpg_getBestPattern, since normally
 * UDateTimePatternGenerator is pre-built with data from a particular locale. 
 * However, generators can be built directly from other data as well.
 * Issue: may be useful to also have a function that returns the list of 
 * fields in a pattern, in order, since we have that internally.
 * That would be useful for getting the UI order of field elements.
 */

/**
 * Opaque type for a date/time pattern generator object.
 * @stable ICU 3.8
 */
typedef void *UDateTimePatternGenerator;

/**
 * Field number constants for udatpg_getAppendItemFormats() and similar functions.
 * These constants are separate from UDateFormatField despite semantic overlap
 * because some fields are merged for the date/time pattern generator.
 * @stable ICU 3.8
 */
typedef enum UDateTimePatternField {
    /** @stable ICU 3.8 */
    UDATPG_ERA_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_YEAR_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_QUARTER_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_MONTH_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_WEEK_OF_YEAR_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_WEEK_OF_MONTH_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_WEEKDAY_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_DAY_OF_YEAR_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_DAY_OF_WEEK_IN_MONTH_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_DAY_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_DAYPERIOD_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_HOUR_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_MINUTE_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_SECOND_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_FRACTIONAL_SECOND_FIELD,
    /** @stable ICU 3.8 */
    UDATPG_ZONE_FIELD,

/* Do not conditionalize the following with #ifndef U_HIDE_DEPRECATED_API,
     * it is needed for layout of DateTimePatternGenerator object. */
#ifndef U_FORCE_HIDE_DEPRECATED_API
    /**
     * One more than the highest normal UDateTimePatternField value.
     * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
     */
    UDATPG_FIELD_COUNT
#endif  // U_FORCE_HIDE_DEPRECATED_API
} UDateTimePatternField;

/**
 * Field display name width constants for udatpg_getFieldDisplayName().
 * @stable ICU 61
 */
typedef enum UDateTimePGDisplayWidth {
    /** @stable ICU 61 */
    UDATPG_WIDE,
    /** @stable ICU 61 */
    UDATPG_ABBREVIATED,
    /** @stable ICU 61 */
    UDATPG_NARROW
} UDateTimePGDisplayWidth;

/**
 * Masks to control forcing the length of specified fields in the returned
 * pattern to match those in the skeleton (when this would not happen
 * otherwise). These may be combined to force the length of multiple fields.
 * Used with udatpg_getBestPatternWithOptions, udatpg_replaceFieldTypesWithOptions.
 * @stable ICU 4.4
 */
typedef enum UDateTimePatternMatchOptions {
 /** @stable ICU 4.4 */
 UDATPG_MATCH_NO_OPTIONS = 0,
 /** @stable ICU 4.4 */
 UDATPG_MATCH_HOUR_FIELD_LENGTH = 1 << UDATPG_HOUR_FIELD,
#ifndef U_HIDE_INTERNAL_API
 /** @internal ICU 4.4 */
 UDATPG_MATCH_MINUTE_FIELD_LENGTH = 1 << UDATPG_MINUTE_FIELD,
 /** @internal ICU 4.4 */
 UDATPG_MATCH_SECOND_FIELD_LENGTH = 1 << UDATPG_SECOND_FIELD,
#endif /* U_HIDE_INTERNAL_API */
 /** @stable ICU 4.4 */
 UDATPG_MATCH_ALL_FIELDS_LENGTH = (1 << UDATPG_FIELD_COUNT) - 1
} UDateTimePatternMatchOptions;

/**
 * Status return values from udatpg_addPattern().
 * @stable ICU 3.8
 */
typedef enum UDateTimePatternConflict {
    /** @stable ICU 3.8 */
    UDATPG_NO_CONFLICT,
    /** @stable ICU 3.8 */
    UDATPG_BASE_CONFLICT,
    /** @stable ICU 3.8 */
    UDATPG_CONFLICT,
#ifndef U_HIDE_DEPRECATED_API
    /**
     * One more than the highest normal UDateTimePatternConflict value.
     * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
     */
    UDATPG_CONFLICT_COUNT
#endif  // U_HIDE_DEPRECATED_API
} UDateTimePatternConflict;

/**
  * Open a generator according to a given locale.
  * @param locale
  * @param pErrorCode a pointer to the UErrorCode which must not indicate a
  *                   failure before the function call.
  * @return a pointer to UDateTimePatternGenerator.
  * @stable ICU 3.8
  */
U_CAPI UDateTimePatternGenerator * U_EXPORT2
udatpg_open(const char *locale, UErrorCode *pErrorCode);

/**
  * Open an empty generator, to be constructed with udatpg_addPattern(...) etc.
  * @param pErrorCode a pointer to the UErrorCode which must not indicate a
  *                   failure before the function call.
  * @return a pointer to UDateTimePatternGenerator.
  * @stable ICU 3.8
  */
U_CAPI UDateTimePatternGenerator * U_EXPORT2
udatpg_openEmpty(UErrorCode *pErrorCode);

/**
  * Close a generator.
  * @param dtpg a pointer to UDateTimePatternGenerator.
  * @stable ICU 3.8
  */
U_CAPI void U_EXPORT2
udatpg_close(UDateTimePatternGenerator *dtpg);

#if U_SHOW_CPLUSPLUS_API

U_NAMESPACE_BEGIN

/**
 * \class LocalUDateTimePatternGeneratorPointer
 * "Smart pointer" class, closes a UDateTimePatternGenerator via udatpg_close().
 * For most methods see the LocalPointerBase base class.
 *
 * @see LocalPointerBase
 * @see LocalPointer
 * @stable ICU 4.4
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUDateTimePatternGeneratorPointer, UDateTimePatternGenerator, udatpg_close);

U_NAMESPACE_END

#endif

/**
  * Create a copy pf a generator.
  * @param dtpg a pointer to UDateTimePatternGenerator to be copied.
  * @param pErrorCode a pointer to the UErrorCode which must not indicate a
  *                   failure before the function call.
  * @return a pointer to a new UDateTimePatternGenerator.
  * @stable ICU 3.8
 */
U_CAPI UDateTimePatternGenerator * U_EXPORT2
udatpg_clone(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode);

/**
 * Get the best pattern matching the input skeleton. It is guaranteed to
 * have all of the fields in the skeleton.
 * 
 * Note that this function uses a non-const UDateTimePatternGenerator:
 * It uses a stateful pattern parser which is set up for each generator object,
 * rather than creating one for each function call.
 * Consecutive calls to this function do not affect each other,
 * but this function cannot be used concurrently on a single generator object.
 * 
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param skeleton
 *            The skeleton is a pattern containing only the variable fields.
 *            For example, "MMMdd" and "mmhh" are skeletons.
 * @param length the length of skeleton
 * @param bestPattern
 *            The best pattern found from the given skeleton.
 * @param capacity the capacity of bestPattern.
 * @param pErrorCode a pointer to the UErrorCode which must not indicate a
 *                   failure before the function call.
 * @return the length of bestPattern.
 * @stable ICU 3.8
 */
U_CAPI int32_t U_EXPORT2
udatpg_getBestPattern(UDateTimePatternGenerator *dtpg,
                      const UChar *skeleton, int32_t length,
                      UChar *bestPattern, int32_t capacity,
                      UErrorCode *pErrorCode);

/**
 * Get the best pattern matching the input skeleton. It is guaranteed to
 * have all of the fields in the skeleton.
 * 
 * Note that this function uses a non-const UDateTimePatternGenerator:
 * It uses a stateful pattern parser which is set up for each generator object,
 * rather than creating one for each function call.
 * Consecutive calls to this function do not affect each other,
 * but this function cannot be used concurrently on a single generator object.
 * 
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param skeleton
 *            The skeleton is a pattern containing only the variable fields.
 *            For example, "MMMdd" and "mmhh" are skeletons.
 * @param length the length of skeleton
 * @param options
 *            Options for forcing the length of specified fields in the
 *            returned pattern to match those in the skeleton (when this
 *            would not happen otherwise). For default behavior, use
 *            UDATPG_MATCH_NO_OPTIONS.
 * @param bestPattern
 *            The best pattern found from the given skeleton.
 * @param capacity
 *            the capacity of bestPattern.
 * @param pErrorCode
 *            a pointer to the UErrorCode which must not indicate a
 *            failure before the function call.
 * @return the length of bestPattern.
 * @stable ICU 4.4
 */
U_CAPI int32_t U_EXPORT2
udatpg_getBestPatternWithOptions(UDateTimePatternGenerator *dtpg,
                                 const UChar *skeleton, int32_t length,
                                 UDateTimePatternMatchOptions options,
                                 UChar *bestPattern, int32_t capacity,
                                 UErrorCode *pErrorCode);

/**
  * Get a unique skeleton from a given pattern. For example,
  * both "MMM-dd" and "dd/MMM" produce the skeleton "MMMdd".
  * 
  * Note that this function uses a non-const UDateTimePatternGenerator:
  * It uses a stateful pattern parser which is set up for each generator object,
  * rather than creating one for each function call.
  * Consecutive calls to this function do not affect each other,
  * but this function cannot be used concurrently on a single generator object.
  *
  * @param unusedDtpg     a pointer to UDateTimePatternGenerator.
  *    This parameter is no longer used. Callers may pass NULL.
  * @param pattern  input pattern, such as "dd/MMM".
  * @param length   the length of pattern.
  * @param skeleton such as "MMMdd"
  * @param capacity the capacity of skeleton.
  * @param pErrorCode a pointer to the UErrorCode which must not indicate a
  *                  failure before the function call.
  * @return the length of skeleton.
  * @stable ICU 3.8
  */
U_CAPI int32_t U_EXPORT2
udatpg_getSkeleton(UDateTimePatternGenerator *unusedDtpg,
                   const UChar *pattern, int32_t length,
                   UChar *skeleton, int32_t capacity,
                   UErrorCode *pErrorCode);

/**
 * Get a unique base skeleton from a given pattern. This is the same
 * as the skeleton, except that differences in length are minimized so
 * as to only preserve the difference between string and numeric form. So
 * for example, both "MMM-dd" and "d/MMM" produce the skeleton "MMMd"
 * (notice the single d).
 *
 * Note that this function uses a non-const UDateTimePatternGenerator:
 * It uses a stateful pattern parser which is set up for each generator object,
 * rather than creating one for each function call.
 * Consecutive calls to this function do not affect each other,
 * but this function cannot be used concurrently on a single generator object.
 *
 * @param unusedDtpg     a pointer to UDateTimePatternGenerator.
 *    This parameter is no longer used. Callers may pass NULL.
 * @param pattern  input pattern, such as "dd/MMM".
 * @param length   the length of pattern.
 * @param baseSkeleton such as "Md"
 * @param capacity the capacity of base skeleton.
 * @param pErrorCode a pointer to the UErrorCode which must not indicate a
 *                  failure before the function call.
 * @return the length of baseSkeleton.
 * @stable ICU 3.8
 */
U_CAPI int32_t U_EXPORT2
udatpg_getBaseSkeleton(UDateTimePatternGenerator *unusedDtpg,
                       const UChar *pattern, int32_t length,
                       UChar *baseSkeleton, int32_t capacity,
                       UErrorCode *pErrorCode);

/**
 * Adds a pattern to the generator. If the pattern has the same skeleton as
 * an existing pattern, and the override parameter is set, then the previous
 * value is overridden. Otherwise, the previous value is retained. In either
 * case, the conflicting status is set and previous vale is stored in 
 * conflicting pattern.
 * 
 * Note that single-field patterns (like "MMM") are automatically added, and
 * don't need to be added explicitly!
 *
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param pattern input pattern, such as "dd/MMM"
 * @param patternLength the length of pattern.
 * @param override When existing values are to be overridden use true, 
 * otherwise use false.
 * @param conflictingPattern Previous pattern with the same skeleton.
 * @param capacity the capacity of conflictingPattern.
 * @param pLength a pointer to the length of conflictingPattern.
 * @param pErrorCode a pointer to the UErrorCode which must not indicate a
 * failure before the function call.
 * @return conflicting status. The value could be UDATPG_NO_CONFLICT, 
 * UDATPG_BASE_CONFLICT or UDATPG_CONFLICT.
 * @stable ICU 3.8
 */
U_CAPI UDateTimePatternConflict U_EXPORT2
udatpg_addPattern(UDateTimePatternGenerator *dtpg,
 const UChar *pattern, int32_t patternLength,
 UBool override,
 UChar *conflictingPattern, int32_t capacity, int32_t *pLength,
 UErrorCode *pErrorCode);

/**
 * An AppendItem format is a pattern used to append a field if there is no
 * good match. For example, suppose that the input skeleton is "GyyyyMMMd",
 * and there is no matching pattern internally, but there is a pattern
 * matching "yyyyMMMd", say "d-MM-yyyy". Then that pattern is used, plus the
 * G. The way these two are conjoined is by using the AppendItemFormat for G
 * (era). So if that value is, say "{0}, {1}" then the final resulting
 * pattern is "d-MM-yyyy, G".
 * 
 * There are actually three available variables: {0} is the pattern so far,
 * {1} is the element we are adding, and {2} is the name of the element.
 * 
 * This reflects the way that the CLDR data is organized.
 *
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param field UDateTimePatternField, such as UDATPG_ERA_FIELD
 * @param value pattern, such as "{0}, {1}"
 * @param length the length of value.
 * @stable ICU 3.8
 */
U_CAPI void U_EXPORT2
udatpg_setAppendItemFormat(UDateTimePatternGenerator *dtpg,
 UDateTimePatternField field,
 const UChar *value, int32_t length);

/**
 * Getter corresponding to setAppendItemFormat. Values below 0 or at or
 * above UDATPG_FIELD_COUNT are illegal arguments.
 *
 * @param dtpg   A pointer to UDateTimePatternGenerator.
 * @param field  UDateTimePatternField, such as UDATPG_ERA_FIELD
 * @param pLength A pointer that will receive the length of appendItemFormat.
 * @return appendItemFormat for field.
 * @stable ICU 3.8
 */
U_CAPI const UChar * U_EXPORT2
udatpg_getAppendItemFormat(const UDateTimePatternGenerator *dtpg,
                           UDateTimePatternField field,
                           int32_t *pLength);

/**
 * Set the name of field, eg "era" in English for ERA. These are only
 * used if the corresponding AppendItemFormat is used, and if it contains a
 * {2} variable.
 * 
 * This reflects the way that the CLDR data is organized.
 *
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param field UDateTimePatternField
 * @param value name for the field.
 * @param length the length of value.
 * @stable ICU 3.8
 */
U_CAPI void U_EXPORT2
udatpg_setAppendItemName(UDateTimePatternGenerator *dtpg,
 UDateTimePatternField field,
 const UChar *value, int32_t length);

/**
 * Getter corresponding to setAppendItemNames. Values below 0 or at or above
 * UDATPG_FIELD_COUNT are illegal arguments. Note: The more general function
 * for getting date/time field display names is udatpg_getFieldDisplayName.
 *
 * @param dtpg   a pointer to UDateTimePatternGenerator.
 * @param field  UDateTimePatternField, such as UDATPG_ERA_FIELD
 * @param pLength A pointer that will receive the length of the name for field.
 * @return name for field
 * @see udatpg_getFieldDisplayName
 * @stable ICU 3.8
 */
U_CAPI const UChar * U_EXPORT2
udatpg_getAppendItemName(const UDateTimePatternGenerator *dtpg,
                         UDateTimePatternField field,
                         int32_t *pLength);

/**
 * The general interface to get a display name for a particular date/time field,
 * in one of several possible display widths.
 *
 * @param dtpg
 *          A pointer to the UDateTimePatternGenerator object with the localized
 *          display names.
 * @param field
 *          The desired UDateTimePatternField, such as UDATPG_ERA_FIELD.
 * @param width
 *          The desired UDateTimePGDisplayWidth, such as UDATPG_ABBREVIATED.
 * @param fieldName
 *          A pointer to a buffer to receive the NULL-terminated display name. If the name
 *          fits into fieldName but cannot be  NULL-terminated (length == capacity) then
 *          the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the name doesn't
 *          fit into fieldName then the error code is set to U_BUFFER_OVERFLOW_ERROR.
 * @param capacity
 *          The size of fieldName (in UChars).
 * @param pErrorCode
 *          A pointer to a UErrorCode to receive any errors
 * @return
 *         The full length of the name; if greater than capacity, fieldName contains a
 *         truncated result.
 * @stable ICU 61
 */
U_CAPI int32_t U_EXPORT2
udatpg_getFieldDisplayName(const UDateTimePatternGenerator *dtpg,
                           UDateTimePatternField field,
                           UDateTimePGDisplayWidth width,
                           UChar *fieldName, int32_t capacity,
                           UErrorCode *pErrorCode);

/**
 * The DateTimeFormat is a message format pattern used to compose date and
 * time patterns. The default pattern in the root locale is "{1} {0}", where
 * {1} will be replaced by the date pattern and {0} will be replaced by the
 * time pattern; however, other locales may specify patterns such as
 * "{1}, {0}" or "{1} 'at' {0}", etc.
 * 
 * This is used when the input skeleton contains both date and time fields,
 * but there is not a close match among the added patterns. For example,
 * suppose that this object was created by adding "dd-MMM" and "hh:mm", and
 * its DateTimeFormat is the default "{1} {0}". Then if the input skeleton
 * is "MMMdhmm", there is not an exact match, so the input skeleton is
 * broken up into two components "MMMd" and "hmm". There are close matches
 * for those two skeletons, so the result is put together with this pattern,
 * resulting in "d-MMM h:mm".
 *
 * There are four DateTimeFormats in a UDateTimePatternGenerator object,
 * corresponding to date styles UDAT_FULL..UDAT_SHORT. This method sets
 * all of them to the specified pattern. To set them individually, see
 * udatpg_setDateTimeFormatForStyle.
 *
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param dtFormat
 * message format pattern, here {1} will be replaced by the date
 * pattern and {0} will be replaced by the time pattern.
 * @param length the length of dtFormat.
 * @stable ICU 3.8
 */
U_CAPI void U_EXPORT2
udatpg_setDateTimeFormat(const UDateTimePatternGenerator *dtpg,
 const UChar *dtFormat, int32_t length);

/**
 * Getter corresponding to setDateTimeFormat.
 *
 * There are four DateTimeFormats in a UDateTimePatternGenerator object,
 * corresponding to date styles UDAT_FULL..UDAT_SHORT. This method gets
 * the style for UDAT_MEDIUM (the default). To get them individually, see
 * udatpg_getDateTimeFormatForStyle.
 *
 * @param dtpg   a pointer to UDateTimePatternGenerator.
 * @param pLength A pointer that will receive the length of the format
 * @return dateTimeFormat.
 * @stable ICU 3.8
 */
U_CAPI const UChar * U_EXPORT2
udatpg_getDateTimeFormat(const UDateTimePatternGenerator *dtpg,
                         int32_t *pLength);

#if !UCONFIG_NO_FORMATTING
/**
 * dateTimeFormats are message patterns used to compose combinations of date
 * and time patterns. There are four length styles, corresponding to the
 * inferred style of the date pattern; these are UDateFormatStyle values:
 *  - UDAT_FULL (for date pattern with weekday and long month), else
 *  - UDAT_LONG (for a date pattern with long month), else
 *  - UDAT_MEDIUM (for a date pattern with abbreviated month), else
 *  - UDAT_SHORT (for any other date pattern).
 * For details on dateTimeFormats, see
 * https://www.unicode.org/reports/tr35/tr35-dates.html#dateTimeFormats.
 * The default pattern in the root locale for all styles is "{1} {0}".
 *
 * @param udtpg
 *              a pointer to the UDateTimePatternGenerator
 * @param style
 *              one of UDAT_FULL..UDAT_SHORT. Error if out of range.
 * @param dateTimeFormat
 *              the new dateTimeFormat to set for the the specified style
 * @param length
 *              the length of dateTimeFormat, or -1 if unknown and pattern
 *              is null-terminated
 * @param pErrorCode
 *              a pointer to the UErrorCode (in/out parameter); if no failure
 *              status is already set, it will be set according to result of the
 *              function (e.g. U_ILLEGAL_ARGUMENT_ERROR for style out of range).
 * @stable ICU 71
 */
U_CAPI void U_EXPORT2
udatpg_setDateTimeFormatForStyle(UDateTimePatternGenerator *udtpg,
                        UDateFormatStyle style,
                        const UChar *dateTimeFormat, int32_t length,
                        UErrorCode *pErrorCode);

/**
 * Getter corresponding to udatpg_setDateTimeFormatForStyle.
 *
 * @param udtpg
 *              a pointer to the UDateTimePatternGenerator
 * @param style
 *              one of UDAT_FULL..UDAT_SHORT. Error if out of range.
 * @param pLength
 *              a pointer that will receive the length of the format. May be NULL
 *              if length is not desired.
 * @param pErrorCode
 *              a pointer to the UErrorCode (in/out parameter); if no failure
 *              status is already set, it will be set according to result of the
 *              function (e.g. U_ILLEGAL_ARGUMENT_ERROR for style out of range).
 * @return
 *              pointer to the current dateTimeFormat (0 terminated) for the specified
 *              style, or empty string in case of error. The pointer and its contents
 *              may no longer be valid if udatpg_setDateTimeFormat is called, or
 *              udatpg_setDateTimeFormatForStyle for the same style is called, or the
 *              UDateTimePatternGenerator object is closed.
 * @stable ICU 71
 */
U_CAPI const UChar* U_EXPORT2
udatpg_getDateTimeFormatForStyle(const UDateTimePatternGenerator *udtpg,
                        UDateFormatStyle style, int32_t *pLength,
                        UErrorCode *pErrorCode);
#endif /* #if !UCONFIG_NO_FORMATTING */

/**
 * The decimal value is used in formatting fractions of seconds. If the
 * skeleton contains fractional seconds, then this is used with the
 * fractional seconds. For example, suppose that the input pattern is
 * "hhmmssSSSS", and the best matching pattern internally is "H:mm:ss", and
 * the decimal string is ",". Then the resulting pattern is modified to be
 * "H:mm:ss,SSSS"
 *
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param decimal
 * @param length the length of decimal.
 * @stable ICU 3.8
 */
U_CAPI void U_EXPORT2
udatpg_setDecimal(UDateTimePatternGenerator *dtpg,
                  const UChar *decimal, int32_t length);

/**
 * Getter corresponding to setDecimal.
 * 
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param pLength A pointer that will receive the length of the decimal string.
 * @return corresponding to the decimal point.
 * @stable ICU 3.8
 */
U_CAPI const UChar * U_EXPORT2
udatpg_getDecimal(const UDateTimePatternGenerator *dtpg,
                  int32_t *pLength);

/**
 * Adjusts the field types (width and subtype) of a pattern to match what is
 * in a skeleton. That is, if you supply a pattern like "d-M H:m", and a
 * skeleton of "MMMMddhhmm", then the input pattern is adjusted to be
 * "dd-MMMM hh:mm". This is used internally to get the best match for the
 * input skeleton, but can also be used externally.
 *
 * Note that this function uses a non-const UDateTimePatternGenerator:
 * It uses a stateful pattern parser which is set up for each generator object,
 * rather than creating one for each function call.
 * Consecutive calls to this function do not affect each other,
 * but this function cannot be used concurrently on a single generator object.
 *
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param pattern Input pattern
 * @param patternLength the length of input pattern.
 * @param skeleton
 * @param skeletonLength the length of input skeleton.
 * @param dest  pattern adjusted to match the skeleton fields widths and subtypes.
 * @param destCapacity the capacity of dest.
 * @param pErrorCode a pointer to the UErrorCode which must not indicate a
 *                  failure before the function call.
 * @return the length of dest.
 * @stable ICU 3.8
 */
U_CAPI int32_t U_EXPORT2
udatpg_replaceFieldTypes(UDateTimePatternGenerator *dtpg,
                         const UChar *pattern, int32_t patternLength,
                         const UChar *skeleton, int32_t skeletonLength,
                         UChar *dest, int32_t destCapacity,
                         UErrorCode *pErrorCode);

/**
 * Adjusts the field types (width and subtype) of a pattern to match what is
 * in a skeleton. That is, if you supply a pattern like "d-M H:m", and a
 * skeleton of "MMMMddhhmm", then the input pattern is adjusted to be
 * "dd-MMMM hh:mm". This is used internally to get the best match for the
 * input skeleton, but can also be used externally.
 *
 * Note that this function uses a non-const UDateTimePatternGenerator:
 * It uses a stateful pattern parser which is set up for each generator object,
 * rather than creating one for each function call.
 * Consecutive calls to this function do not affect each other,
 * but this function cannot be used concurrently on a single generator object.
 *
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param pattern Input pattern
 * @param patternLength the length of input pattern.
 * @param skeleton
 * @param skeletonLength the length of input skeleton.
 * @param options
 *            Options controlling whether the length of specified fields in the
 *            pattern are adjusted to match those in the skeleton (when this
 *            would not happen otherwise). For default behavior, use
 *            UDATPG_MATCH_NO_OPTIONS.
 * @param dest  pattern adjusted to match the skeleton fields widths and subtypes.
 * @param destCapacity the capacity of dest.
 * @param pErrorCode a pointer to the UErrorCode which must not indicate a
 *                  failure before the function call.
 * @return the length of dest.
 * @stable ICU 4.4
 */
U_CAPI int32_t U_EXPORT2
udatpg_replaceFieldTypesWithOptions(UDateTimePatternGenerator *dtpg,
                                    const UChar *pattern, int32_t patternLength,
                                    const UChar *skeleton, int32_t skeletonLength,
                                    UDateTimePatternMatchOptions options,
                                    UChar *dest, int32_t destCapacity,
                                    UErrorCode *pErrorCode);

/**
 * Return a UEnumeration list of all the skeletons in canonical form.
 * Call udatpg_getPatternForSkeleton() to get the corresponding pattern.
 * 
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param pErrorCode a pointer to the UErrorCode which must not indicate a
 *                  failure before the function call
 * @return a UEnumeration list of all the skeletons
 *         The caller must close the object.
 * @stable ICU 3.8
 */
U_CAPI UEnumeration * U_EXPORT2
udatpg_openSkeletons(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode);

/**
 * Return a UEnumeration list of all the base skeletons in canonical form.
 *
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param pErrorCode a pointer to the UErrorCode which must not indicate a
 *             failure before the function call.
 * @return a UEnumeration list of all the base skeletons
 *             The caller must close the object.
 * @stable ICU 3.8
 */
U_CAPI UEnumeration * U_EXPORT2
udatpg_openBaseSkeletons(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode);

/**
 * Get the pattern corresponding to a given skeleton.
 * 
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param skeleton 
 * @param skeletonLength pointer to the length of skeleton.
 * @param pLength pointer to the length of return pattern.
 * @return pattern corresponding to a given skeleton.
 * @stable ICU 3.8
 */
U_CAPI const UChar * U_EXPORT2
udatpg_getPatternForSkeleton(const UDateTimePatternGenerator *dtpg,
                             const UChar *skeleton, int32_t skeletonLength,
                             int32_t *pLength);

#if !UCONFIG_NO_FORMATTING

/**
 * Return the default hour cycle for a locale. Uses the locale that the
 * UDateTimePatternGenerator was initially created with.
 * 
 * Cannot be used on an empty UDateTimePatternGenerator instance.
 * 
 * @param dtpg a pointer to UDateTimePatternGenerator.
 * @param pErrorCode a pointer to the UErrorCode which must not indicate a
 *                   failure before the function call. Set to U_UNSUPPORTED_ERROR
 *                   if used on an empty instance.
 * @return the default hour cycle.
 * @stable ICU 67
 */
U_CAPI UDateFormatHourCycle U_EXPORT2
udatpg_getDefaultHourCycle(const UDateTimePatternGenerator *dtpg, UErrorCode* pErrorCode);

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif

${this.title}

Code Editor : udatpg.h