GOLDEN HOUR
DIR: /usr/include/unicode
UP
UPLOAD
Name
Size
Action
alphaindex.h
26.48 KB
DEL
appendable.h
8.49 KB
DEL
basictz.h
9.27 KB
DEL
brkiter.h
27.8 KB
DEL
bytestream.h
10.78 KB
DEL
bytestrie.h
20.77 KB
DEL
bytestriebuilder.h
7.08 KB
DEL
calendar.h
105.74 KB
DEL
caniter.h
7.43 KB
DEL
casemap.h
25.33 KB
DEL
char16ptr.h
7.22 KB
DEL
chariter.h
24.05 KB
DEL
choicfmt.h
23.91 KB
DEL
coleitr.h
13.76 KB
DEL
coll.h
56.23 KB
DEL
compactdecimalformat.h
6.88 KB
DEL
curramt.h
3.76 KB
DEL
currpinf.h
7.3 KB
DEL
currunit.h
4 KB
DEL
datefmt.h
40.67 KB
DEL
dbbi.h
1.19 KB
DEL
dcfmtsym.h
20.41 KB
DEL
decimfmt.h
87.19 KB
DEL
docmain.h
6.97 KB
DEL
dtfmtsym.h
37.7 KB
DEL
dtintrv.h
3.84 KB
DEL
dtitvfmt.h
46.52 KB
DEL
dtitvinf.h
18.62 KB
DEL
dtptngen.h
25.8 KB
DEL
dtrule.h
8.68 KB
DEL
edits.h
20.74 KB
DEL
enumset.h
2.08 KB
DEL
errorcode.h
4.84 KB
DEL
fieldpos.h
8.69 KB
DEL
filteredbrk.h
5.37 KB
DEL
fmtable.h
24.42 KB
DEL
format.h
12.5 KB
DEL
formattedvalue.h
9.75 KB
DEL
fpositer.h
3.04 KB
DEL
gender.h
3.33 KB
DEL
gregocal.h
31.71 KB
DEL
icudataver.h
1.03 KB
DEL
icuplug.h
11.88 KB
DEL
idna.h
12.7 KB
DEL
listformatter.h
9.27 KB
DEL
localebuilder.h
11.23 KB
DEL
localematcher.h
24.56 KB
DEL
localpointer.h
19.36 KB
DEL
locdspnm.h
7.12 KB
DEL
locid.h
47.68 KB
DEL
measfmt.h
11.33 KB
DEL
measunit.h
95.28 KB
DEL
measure.h
4.32 KB
DEL
messagepattern.h
33.71 KB
DEL
msgfmt.h
44.11 KB
DEL
normalizer2.h
34.03 KB
DEL
normlzr.h
30.94 KB
DEL
nounit.h
2.69 KB
DEL
numberformatter.h
84.25 KB
DEL
numberrangeformatter.h
27.95 KB
DEL
numfmt.h
49.76 KB
DEL
numsys.h
7.32 KB
DEL
parseerr.h
3.08 KB
DEL
parsepos.h
5.56 KB
DEL
platform.h
28.08 KB
DEL
plurfmt.h
25.2 KB
DEL
plurrule.h
18.34 KB
DEL
ptypes.h
3.49 KB
DEL
putil.h
6.33 KB
DEL
rbbi.h
26.58 KB
DEL
rbnf.h
48.73 KB
DEL
rbtz.h
15.6 KB
DEL
regex.h
84.34 KB
DEL
region.h
9.18 KB
DEL
reldatefmt.h
22.27 KB
DEL
rep.h
9.37 KB
DEL
resbund.h
18.07 KB
DEL
schriter.h
6.32 KB
DEL
scientificnumberformatter.h
6.4 KB
DEL
search.h
22.22 KB
DEL
selfmt.h
14.3 KB
DEL
simpleformatter.h
12.59 KB
DEL
simpletz.h
45.44 KB
DEL
smpdtfmt.h
71.01 KB
DEL
sortkey.h
11.18 KB
DEL
std_string.h
1.05 KB
DEL
strenum.h
9.92 KB
DEL
stringoptions.h
5.79 KB
DEL
stringpiece.h
10.35 KB
DEL
stringtriebuilder.h
15.33 KB
DEL
stsearch.h
21.3 KB
DEL
symtable.h
4.27 KB
DEL
tblcoll.h
36.61 KB
DEL
timezone.h
41.02 KB
DEL
tmunit.h
3.38 KB
DEL
tmutamt.h
4.9 KB
DEL
tmutfmt.h
7.85 KB
DEL
translit.h
65.82 KB
DEL
tzfmt.h
42.89 KB
DEL
tznames.h
16.85 KB
DEL
tzrule.h
35.37 KB
DEL
tztrans.h
6.12 KB
DEL
ubidi.h
89.56 KB
DEL
ubiditransform.h
12.65 KB
DEL
ubrk.h
23.97 KB
DEL
ucal.h
56.9 KB
DEL
ucasemap.h
15.18 KB
DEL
ucat.h
5.36 KB
DEL
uchar.h
141.24 KB
DEL
ucharstrie.h
22.58 KB
DEL
ucharstriebuilder.h
7.21 KB
DEL
uchriter.h
13.2 KB
DEL
uclean.h
11.21 KB
DEL
ucnv.h
83.09 KB
DEL
ucnv_cb.h
6.59 KB
DEL
ucnv_err.h
20.99 KB
DEL
ucnvsel.h
6.14 KB
DEL
ucol.h
61.46 KB
DEL
ucoleitr.h
9.46 KB
DEL
uconfig.h
12.07 KB
DEL
ucpmap.h
5.53 KB
DEL
ucptrie.h
22.46 KB
DEL
ucsdet.h
14.67 KB
DEL
ucurr.h
16.12 KB
DEL
udat.h
61.38 KB
DEL
udata.h
15.56 KB
DEL
udateintervalformat.h
10.74 KB
DEL
udatpg.h
26.8 KB
DEL
udisplaycontext.h
5.89 KB
DEL
uenum.h
7.78 KB
DEL
ufieldpositer.h
4.36 KB
DEL
uformattable.h
10.94 KB
DEL
uformattedvalue.h
12.12 KB
DEL
ugender.h
2 KB
DEL
uidna.h
33.37 KB
DEL
uiter.h
22.77 KB
DEL
uldnames.h
10.45 KB
DEL
ulistformatter.h
10.83 KB
DEL
uloc.h
53.16 KB
DEL
ulocdata.h
11.26 KB
DEL
umachine.h
14.54 KB
DEL
umisc.h
1.33 KB
DEL
umsg.h
24.23 KB
DEL
umutablecptrie.h
8.24 KB
DEL
unifilt.h
3.96 KB
DEL
unifunct.h
4.04 KB
DEL
unimatch.h
6.1 KB
DEL
unirepl.h
3.38 KB
DEL
uniset.h
64.9 KB
DEL
unistr.h
170.43 KB
DEL
unorm.h
20.52 KB
DEL
unorm2.h
24.66 KB
DEL
unum.h
53.46 KB
DEL
unumberformatter.h
25.22 KB
DEL
unumsys.h
7.21 KB
DEL
uobject.h
10.68 KB
DEL
upluralrules.h
7.83 KB
DEL
uregex.h
72.05 KB
DEL
uregion.h
9.84 KB
DEL
ureldatefmt.h
17 KB
DEL
urename.h
131.3 KB
DEL
urep.h
5.38 KB
DEL
ures.h
36.54 KB
DEL
uscript.h
27.21 KB
DEL
usearch.h
38.12 KB
DEL
uset.h
40 KB
DEL
usetiter.h
9.55 KB
DEL
ushape.h
18 KB
DEL
uspoof.h
65.9 KB
DEL
usprep.h
8.14 KB
DEL
ustdio.h
38.54 KB
DEL
ustream.h
1.89 KB
DEL
ustring.h
72.47 KB
DEL
ustringtrie.h
3.15 KB
DEL
utext.h
58.13 KB
DEL
utf.h
7.86 KB
DEL
utf16.h
23.32 KB
DEL
utf32.h
763 B
DEL
utf8.h
30.96 KB
DEL
utf_old.h
45.83 KB
DEL
utmscale.h
13.78 KB
DEL
utrace.h
17.29 KB
DEL
utrans.h
25.52 KB
DEL
utypes.h
30.74 KB
DEL
uvernum.h
6.67 KB
DEL
uversion.h
6 KB
DEL
vtzone.h
20.3 KB
DEL
Edit: ureldatefmt.h
// © 2016 and later: Unicode, Inc. and others. // License & terms of use: http://www.unicode.org/copyright.html /* ***************************************************************************************** * Copyright (C) 2016, International Business Machines * Corporation and others. All Rights Reserved. ***************************************************************************************** */ #ifndef URELDATEFMT_H #define URELDATEFMT_H #include "unicode/utypes.h" #if !UCONFIG_NO_FORMATTING && !UCONFIG_NO_BREAK_ITERATION #include "unicode/unum.h" #include "unicode/udisplaycontext.h" #include "unicode/localpointer.h" #include "unicode/uformattedvalue.h" /** * \file * \brief C API: URelativeDateTimeFormatter, relative date formatting of unit + numeric offset. * * Provides simple formatting of relative dates, in two ways * <ul> * <li>relative dates with a quantity e.g "in 5 days"</li> * <li>relative dates without a quantity e.g "next Tuesday"</li> * </ul> * <p> * This does not provide compound formatting for multiple units, * other than the ability to combine a time string with a relative date, * as in "next Tuesday at 3:45 PM". It also does not provide support * for determining which unit to use, such as deciding between "in 7 days" * and "in 1 week". * * @stable ICU 57 */ /** * The formatting style * @stable ICU 54 */ typedef enum UDateRelativeDateTimeFormatterStyle { /** * Everything spelled out. * @stable ICU 54 */ UDAT_STYLE_LONG, /** * Abbreviations used when possible. * @stable ICU 54 */ UDAT_STYLE_SHORT, /** * Use the shortest possible form. * @stable ICU 54 */ UDAT_STYLE_NARROW, #ifndef U_HIDE_DEPRECATED_API /** * One more than the highest normal UDateRelativeDateTimeFormatterStyle value. * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420. */ UDAT_STYLE_COUNT #endif /* U_HIDE_DEPRECATED_API */ } UDateRelativeDateTimeFormatterStyle; /** * Represents the unit for formatting a relative date. e.g "in 5 days" * or "next year" * @stable ICU 57 */ typedef enum URelativeDateTimeUnit { /** * Specifies that relative unit is year, e.g. "last year", * "in 5 years". * @stable ICU 57 */ UDAT_REL_UNIT_YEAR, /** * Specifies that relative unit is quarter, e.g. "last quarter", * "in 5 quarters". * @stable ICU 57 */ UDAT_REL_UNIT_QUARTER, /** * Specifies that relative unit is month, e.g. "last month", * "in 5 months". * @stable ICU 57 */ UDAT_REL_UNIT_MONTH, /** * Specifies that relative unit is week, e.g. "last week", * "in 5 weeks". * @stable ICU 57 */ UDAT_REL_UNIT_WEEK, /** * Specifies that relative unit is day, e.g. "yesterday", * "in 5 days". * @stable ICU 57 */ UDAT_REL_UNIT_DAY, /** * Specifies that relative unit is hour, e.g. "1 hour ago", * "in 5 hours". * @stable ICU 57 */ UDAT_REL_UNIT_HOUR, /** * Specifies that relative unit is minute, e.g. "1 minute ago", * "in 5 minutes". * @stable ICU 57 */ UDAT_REL_UNIT_MINUTE, /** * Specifies that relative unit is second, e.g. "1 second ago", * "in 5 seconds". * @stable ICU 57 */ UDAT_REL_UNIT_SECOND, /** * Specifies that relative unit is Sunday, e.g. "last Sunday", * "this Sunday", "next Sunday", "in 5 Sundays". * @stable ICU 57 */ UDAT_REL_UNIT_SUNDAY, /** * Specifies that relative unit is Monday, e.g. "last Monday", * "this Monday", "next Monday", "in 5 Mondays". * @stable ICU 57 */ UDAT_REL_UNIT_MONDAY, /** * Specifies that relative unit is Tuesday, e.g. "last Tuesday", * "this Tuesday", "next Tuesday", "in 5 Tuesdays". * @stable ICU 57 */ UDAT_REL_UNIT_TUESDAY, /** * Specifies that relative unit is Wednesday, e.g. "last Wednesday", * "this Wednesday", "next Wednesday", "in 5 Wednesdays". * @stable ICU 57 */ UDAT_REL_UNIT_WEDNESDAY, /** * Specifies that relative unit is Thursday, e.g. "last Thursday", * "this Thursday", "next Thursday", "in 5 Thursdays". * @stable ICU 57 */ UDAT_REL_UNIT_THURSDAY, /** * Specifies that relative unit is Friday, e.g. "last Friday", * "this Friday", "next Friday", "in 5 Fridays". * @stable ICU 57 */ UDAT_REL_UNIT_FRIDAY, /** * Specifies that relative unit is Saturday, e.g. "last Saturday", * "this Saturday", "next Saturday", "in 5 Saturdays". * @stable ICU 57 */ UDAT_REL_UNIT_SATURDAY, #ifndef U_HIDE_DEPRECATED_API /** * One more than the highest normal URelativeDateTimeUnit value. * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420. */ UDAT_REL_UNIT_COUNT #endif /* U_HIDE_DEPRECATED_API */ } URelativeDateTimeUnit; /** * FieldPosition and UFieldPosition selectors for format fields * defined by RelativeDateTimeFormatter. * @stable ICU 64 */ typedef enum URelativeDateTimeFormatterField { /** * Represents a literal text string, like "tomorrow" or "days ago". * @stable ICU 64 */ UDAT_REL_LITERAL_FIELD, /** * Represents a number quantity, like "3" in "3 days ago". * @stable ICU 64 */ UDAT_REL_NUMERIC_FIELD, } URelativeDateTimeFormatterField; /** * Opaque URelativeDateTimeFormatter object for use in C programs. * @stable ICU 57 */ struct URelativeDateTimeFormatter; typedef struct URelativeDateTimeFormatter URelativeDateTimeFormatter; /**< C typedef for struct URelativeDateTimeFormatter. @stable ICU 57 */ /** * Open a new URelativeDateTimeFormatter object for a given locale using the * specified width and capitalizationContext, along with a number formatter * (if desired) to override the default formatter that would be used for * display of numeric field offsets. The default formatter typically rounds * toward 0 and has a minimum of 0 fraction digits and a maximum of 3 * fraction digits (i.e. it will show as many decimal places as necessary * up to 3, without showing trailing 0s). * * @param locale * The locale * @param nfToAdopt * A number formatter to set for this URelativeDateTimeFormatter * object (instead of the default decimal formatter). Ownership of * this UNumberFormat object will pass to the URelativeDateTimeFormatter * object (the URelativeDateTimeFormatter adopts the UNumberFormat), * which becomes responsible for closing it. If the caller wishes to * retain ownership of the UNumberFormat object, the caller must clone * it (with unum_clone) and pass the clone to ureldatefmt_open. May be * NULL to use the default decimal formatter. * @param width * The width - wide, short, narrow, etc. * @param capitalizationContext * A value from UDisplayContext that pertains to capitalization, e.g. * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE. * @param status * A pointer to a UErrorCode to receive any errors. * @return * A pointer to a URelativeDateTimeFormatter object for the specified locale, * or NULL if an error occurred. * @stable ICU 57 */ U_STABLE URelativeDateTimeFormatter* U_EXPORT2 ureldatefmt_open( const char* locale, UNumberFormat* nfToAdopt, UDateRelativeDateTimeFormatterStyle width, UDisplayContext capitalizationContext, UErrorCode* status ); /** * Close a URelativeDateTimeFormatter object. Once closed it may no longer be used. * @param reldatefmt * The URelativeDateTimeFormatter object to close. * @stable ICU 57 */ U_STABLE void U_EXPORT2 ureldatefmt_close(URelativeDateTimeFormatter *reldatefmt); struct UFormattedRelativeDateTime; /** * Opaque struct to contain the results of a URelativeDateTimeFormatter operation. * @stable ICU 64 */ typedef struct UFormattedRelativeDateTime UFormattedRelativeDateTime; /** * Creates an object to hold the result of a URelativeDateTimeFormatter * operation. The object can be used repeatedly; it is cleared whenever * passed to a format function. * * @param ec Set if an error occurs. * @return A pointer needing ownership. * @stable ICU 64 */ U_STABLE UFormattedRelativeDateTime* U_EXPORT2 ureldatefmt_openResult(UErrorCode* ec); /** * Returns a representation of a UFormattedRelativeDateTime as a UFormattedValue, * which can be subsequently passed to any API requiring that type. * * The returned object is owned by the UFormattedRelativeDateTime and is valid * only as long as the UFormattedRelativeDateTime is present and unchanged in memory. * * You can think of this method as a cast between types. * * @param ufrdt The object containing the formatted string. * @param ec Set if an error occurs. * @return A UFormattedValue owned by the input object. * @stable ICU 64 */ U_STABLE const UFormattedValue* U_EXPORT2 ureldatefmt_resultAsValue(const UFormattedRelativeDateTime* ufrdt, UErrorCode* ec); /** * Releases the UFormattedRelativeDateTime created by ureldatefmt_openResult. * * @param ufrdt The object to release. * @stable ICU 64 */ U_STABLE void U_EXPORT2 ureldatefmt_closeResult(UFormattedRelativeDateTime* ufrdt); #if U_SHOW_CPLUSPLUS_API U_NAMESPACE_BEGIN /** * \class LocalURelativeDateTimeFormatterPointer * "Smart pointer" class, closes a URelativeDateTimeFormatter via ureldatefmt_close(). * For most methods see the LocalPointerBase base class. * * @see LocalPointerBase * @see LocalPointer * @stable ICU 57 */ U_DEFINE_LOCAL_OPEN_POINTER(LocalURelativeDateTimeFormatterPointer, URelativeDateTimeFormatter, ureldatefmt_close); /** * \class LocalUFormattedRelativeDateTimePointer * "Smart pointer" class, closes a UFormattedRelativeDateTime via ureldatefmt_closeResult(). * For most methods see the LocalPointerBase base class. * * @see LocalPointerBase * @see LocalPointer * @stable ICU 64 */ U_DEFINE_LOCAL_OPEN_POINTER(LocalUFormattedRelativeDateTimePointer, UFormattedRelativeDateTime, ureldatefmt_closeResult); U_NAMESPACE_END #endif /** * Format a combination of URelativeDateTimeUnit and numeric * offset using a numeric style, e.g. "1 week ago", "in 1 week", * "5 weeks ago", "in 5 weeks". * * @param reldatefmt * The URelativeDateTimeFormatter object specifying the * format conventions. * @param offset * The signed offset for the specified unit. This will * be formatted according to this object's UNumberFormat * object. * @param unit * The unit to use when formatting the relative * date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY. * @param result * A pointer to a buffer to receive the formatted result. * @param resultCapacity * The maximum size of result. * @param status * A pointer to a UErrorCode to receive any errors. In * case of error status, the contents of result are * undefined. * @return * The length of the formatted result; may be greater * than resultCapacity, in which case an error is returned. * @stable ICU 57 */ U_STABLE int32_t U_EXPORT2 ureldatefmt_formatNumeric( const URelativeDateTimeFormatter* reldatefmt, double offset, URelativeDateTimeUnit unit, UChar* result, int32_t resultCapacity, UErrorCode* status); /** * Format a combination of URelativeDateTimeUnit and numeric * offset using a numeric style, e.g. "1 week ago", "in 1 week", * "5 weeks ago", "in 5 weeks". * * @param reldatefmt * The URelativeDateTimeFormatter object specifying the * format conventions. * @param offset * The signed offset for the specified unit. This will * be formatted according to this object's UNumberFormat * object. * @param unit * The unit to use when formatting the relative * date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY. * @param result * A pointer to a UFormattedRelativeDateTime to populate. * @param status * A pointer to a UErrorCode to receive any errors. In * case of error status, the contents of result are * undefined. * @stable ICU 64 */ U_STABLE void U_EXPORT2 ureldatefmt_formatNumericToResult( const URelativeDateTimeFormatter* reldatefmt, double offset, URelativeDateTimeUnit unit, UFormattedRelativeDateTime* result, UErrorCode* status); /** * Format a combination of URelativeDateTimeUnit and numeric offset * using a text style if possible, e.g. "last week", "this week", * "next week", "yesterday", "tomorrow". Falls back to numeric * style if no appropriate text term is available for the specified * offset in the object's locale. * * @param reldatefmt * The URelativeDateTimeFormatter object specifying the * format conventions. * @param offset * The signed offset for the specified unit. * @param unit * The unit to use when formatting the relative * date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY. * @param result * A pointer to a buffer to receive the formatted result. * @param resultCapacity * The maximum size of result. * @param status * A pointer to a UErrorCode to receive any errors. In * case of error status, the contents of result are * undefined. * @return * The length of the formatted result; may be greater * than resultCapacity, in which case an error is returned. * @stable ICU 57 */ U_STABLE int32_t U_EXPORT2 ureldatefmt_format( const URelativeDateTimeFormatter* reldatefmt, double offset, URelativeDateTimeUnit unit, UChar* result, int32_t resultCapacity, UErrorCode* status); /** * Format a combination of URelativeDateTimeUnit and numeric offset * using a text style if possible, e.g. "last week", "this week", * "next week", "yesterday", "tomorrow". Falls back to numeric * style if no appropriate text term is available for the specified * offset in the object's locale. * * This method populates a UFormattedRelativeDateTime, which exposes more * information than the string populated by format(). * * @param reldatefmt * The URelativeDateTimeFormatter object specifying the * format conventions. * @param offset * The signed offset for the specified unit. * @param unit * The unit to use when formatting the relative * date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY. * @param result * A pointer to a UFormattedRelativeDateTime to populate. * @param status * A pointer to a UErrorCode to receive any errors. In * case of error status, the contents of result are * undefined. * @stable ICU 64 */ U_STABLE void U_EXPORT2 ureldatefmt_formatToResult( const URelativeDateTimeFormatter* reldatefmt, double offset, URelativeDateTimeUnit unit, UFormattedRelativeDateTime* result, UErrorCode* status); /** * Combines a relative date string and a time string in this object's * locale. This is done with the same date-time separator used for the * default calendar in this locale to produce a result such as * "yesterday at 3:45 PM". * * @param reldatefmt * The URelativeDateTimeFormatter object specifying the format conventions. * @param relativeDateString * The relative date string. * @param relativeDateStringLen * The length of relativeDateString; may be -1 if relativeDateString * is zero-terminated. * @param timeString * The time string. * @param timeStringLen * The length of timeString; may be -1 if timeString is zero-terminated. * @param result * A pointer to a buffer to receive the formatted result. * @param resultCapacity * The maximum size of result. * @param status * A pointer to a UErrorCode to receive any errors. In case of error status, * the contents of result are undefined. * @return * The length of the formatted result; may be greater than resultCapacity, * in which case an error is returned. * @stable ICU 57 */ U_STABLE int32_t U_EXPORT2 ureldatefmt_combineDateAndTime( const URelativeDateTimeFormatter* reldatefmt, const UChar * relativeDateString, int32_t relativeDateStringLen, const UChar * timeString, int32_t timeStringLen, UChar* result, int32_t resultCapacity, UErrorCode* status ); #endif /* !UCONFIG_NO_FORMATTING && !UCONFIG_NO_BREAK_ITERATION */ #endif
SAVE FILE
TERMINAL
EXEC