mirror of
https://github.com/unicode-org/icu.git
synced 2025-04-08 06:53:45 +00:00
ICU-5008 promote draft APIs to stable
X-SVN-Rev: 19938
This commit is contained in:
Ram Viswanadha
parent
79e7c706dd
commit
dccb974b4b
2 changed files with 46 additions and 49 deletions
|
|
@ -193,11 +193,10 @@ scanf modifier
|
|||
/** Forward declaration of a Unicode-aware file @stable 3.0 */
|
||||
typedef struct UFILE UFILE;
|
||||
|
||||
#ifndef U_HIDE_DRAFT_API
|
||||
/**
|
||||
* Enum for which direction of stream a transliterator applies to.
|
||||
* @see u_fsettransliterator
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
typedef enum {
|
||||
U_READ = 1,
|
||||
|
|
@ -205,8 +204,6 @@ typedef enum {
|
|||
U_READWRITE =3 /* == (U_READ | U_WRITE) */
|
||||
} UFileDirection;
|
||||
|
||||
#endif /* U_HIDE_DRAFT_API */
|
||||
|
||||
/**
|
||||
* Open a UFILE.
|
||||
* A UFILE is a wrapper around a FILE* that is locale and codepage aware.
|
||||
|
|
@ -222,7 +219,7 @@ typedef enum {
|
|||
* read from the file. If this paramter is NULL the system default codepage
|
||||
* will be used.
|
||||
* @return A new UFILE, or NULL if an error occurred.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UFILE* U_EXPORT2
|
||||
u_fopen(const char *filename,
|
||||
|
|
@ -241,7 +238,7 @@ u_fopen(const char *filename,
|
|||
* read using the default codepage for <TT>locale</TT>, unless <TT>locale</TT>
|
||||
* is NULL, in which case the system default codepage will be used.
|
||||
* @return A new UFILE, or NULL if an error occurred.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UFILE* U_EXPORT2
|
||||
u_finit(FILE *f,
|
||||
|
|
@ -260,7 +257,7 @@ u_finit(FILE *f,
|
|||
* and parse output. If this parameter is NULL, the default locale will
|
||||
* be used.
|
||||
* @return A new UFILE, or NULL if an error occurred.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UFILE* U_EXPORT2
|
||||
u_fstropen(UChar *stringBuf,
|
||||
|
|
@ -270,7 +267,7 @@ u_fstropen(UChar *stringBuf,
|
|||
/**
|
||||
* Close a UFILE.
|
||||
* @param file The UFILE to close.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT void U_EXPORT2
|
||||
u_fclose(UFILE *file);
|
||||
|
|
@ -281,7 +278,7 @@ u_fclose(UFILE *file);
|
|||
* @return Returns TRUE after the first read operation that attempts to
|
||||
* read past the end of the file. It returns FALSE if the current position is
|
||||
* not end of file.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UBool U_EXPORT2
|
||||
u_feof(UFILE *f);
|
||||
|
|
@ -292,7 +289,7 @@ u_feof(UFILE *f);
|
|||
* made in the output stream - for example if a different type of
|
||||
* output is desired.) The underlying OS level file is also flushed.
|
||||
* @param file The UFILE to flush.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT void U_EXPORT2
|
||||
u_fflush(UFILE *file);
|
||||
|
|
@ -300,7 +297,7 @@ u_fflush(UFILE *file);
|
|||
/**
|
||||
* Rewind the file pointer to the beginning of the file.
|
||||
* @param file The UFILE to rewind.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT void
|
||||
u_frewind(UFILE *file);
|
||||
|
|
@ -309,7 +306,7 @@ u_frewind(UFILE *file);
|
|||
* Get the FILE* associated with a UFILE.
|
||||
* @param f The UFILE
|
||||
* @return A FILE*, owned by the UFILE. The FILE <EM>must not</EM> be closed.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT FILE* U_EXPORT2
|
||||
u_fgetfile(UFILE *f);
|
||||
|
|
@ -322,7 +319,7 @@ u_fgetfile(UFILE *f);
|
|||
* or <TT>u_fopen</TT>.
|
||||
* @param file The UFILE to set.
|
||||
* @return The locale whose conventions are used to format and parse output.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT const char* U_EXPORT2
|
||||
u_fgetlocale(UFILE *file);
|
||||
|
|
@ -333,7 +330,7 @@ u_fgetlocale(UFILE *file);
|
|||
* and parse output.
|
||||
* @param file The UFILE to query.
|
||||
* @return NULL if successful, otherwise a negative number.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_fsetlocale(UFILE *file,
|
||||
|
|
@ -348,7 +345,7 @@ u_fsetlocale(UFILE *file,
|
|||
* @param file The UFILE to query.
|
||||
* @return The codepage in which data is written to and read from the UFILE,
|
||||
* or NULL if an error occurred.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT const char* U_EXPORT2
|
||||
u_fgetcodepage(UFILE *file);
|
||||
|
|
@ -366,7 +363,7 @@ u_fgetcodepage(UFILE *file);
|
|||
* @param file The UFILE to set.
|
||||
* @return 0 if successful, otherwise a negative number.
|
||||
* @see u_frewind
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_fsetcodepage(const char *codepage,
|
||||
|
|
@ -377,7 +374,7 @@ u_fsetcodepage(const char *codepage,
|
|||
* Returns an alias to the converter being used for this file.
|
||||
* @param f The UFILE to get the value from
|
||||
* @return alias to the converter
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UConverter* U_EXPORT2 u_fgetConverter(UFILE *f);
|
||||
|
||||
|
|
@ -391,7 +388,7 @@ U_DRAFT UConverter* U_EXPORT2 u_fgetConverter(UFILE *f);
|
|||
* @param patternSpecification A pattern specifying how <TT>u_fprintf</TT> will
|
||||
* interpret the variable arguments received and format the data.
|
||||
* @return The number of Unicode characters written to <TT>f</TT>.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_fprintf(UFILE *f,
|
||||
|
|
@ -408,7 +405,7 @@ u_fprintf(UFILE *f,
|
|||
* @param ap The argument list to use.
|
||||
* @return The number of Unicode characters written to <TT>f</TT>.
|
||||
* @see u_fprintf
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vfprintf(UFILE *f,
|
||||
|
|
@ -421,7 +418,7 @@ u_vfprintf(UFILE *f,
|
|||
* @param patternSpecification A pattern specifying how <TT>u_fprintf</TT> will
|
||||
* interpret the variable arguments received and format the data.
|
||||
* @return The number of Unicode characters written to <TT>f</TT>.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_fprintf_u(UFILE *f,
|
||||
|
|
@ -438,7 +435,7 @@ u_fprintf_u(UFILE *f,
|
|||
* @param ap The argument list to use.
|
||||
* @return The number of Unicode characters written to <TT>f</TT>.
|
||||
* @see u_fprintf_u
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vfprintf_u(UFILE *f,
|
||||
|
|
@ -453,7 +450,7 @@ u_vfprintf_u(UFILE *f,
|
|||
* @param f The UFILE to which to write.
|
||||
* @return A non-negative number if successful, EOF otherwise.
|
||||
* @see u_file_write
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_fputs(const UChar *s,
|
||||
|
|
@ -464,7 +461,7 @@ u_fputs(const UChar *s,
|
|||
* @param uc The UChar to write.
|
||||
* @param f The UFILE to which to write.
|
||||
* @return The character written if successful, EOF otherwise.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UChar32 U_EXPORT2
|
||||
u_fputc(UChar32 uc,
|
||||
|
|
@ -479,7 +476,7 @@ u_fputc(UChar32 uc,
|
|||
* @param f The UFILE to which to write.
|
||||
* @return The number of Unicode characters written.
|
||||
* @see u_fputs
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_file_write(const UChar *ustring,
|
||||
|
|
@ -497,7 +494,7 @@ u_file_write(const UChar *ustring,
|
|||
* interpret the variable arguments received and parse the data.
|
||||
* @return The number of items successfully converted and assigned, or EOF
|
||||
* if an error occurred.
|
||||
* @draft 3.0
|
||||
* @draft 3.6
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_fscanf(UFILE *f,
|
||||
|
|
@ -515,7 +512,7 @@ u_fscanf(UFILE *f,
|
|||
* @return The number of items successfully converted and assigned, or EOF
|
||||
* if an error occurred.
|
||||
* @see u_fscanf
|
||||
* @draft 3.0
|
||||
* @draft 3.6
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vfscanf(UFILE *f,
|
||||
|
|
@ -529,7 +526,7 @@ u_vfscanf(UFILE *f,
|
|||
* interpret the variable arguments received and parse the data.
|
||||
* @return The number of items successfully converted and assigned, or EOF
|
||||
* if an error occurred.
|
||||
* @draft 3.0
|
||||
* @draft 3.6
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_fscanf_u(UFILE *f,
|
||||
|
|
@ -547,7 +544,7 @@ u_fscanf_u(UFILE *f,
|
|||
* @return The number of items successfully converted and assigned, or EOF
|
||||
* if an error occurred.
|
||||
* @see u_fscanf_u
|
||||
* @draft 3.0
|
||||
* @draft 3.6
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vfscanf_u(UFILE *f,
|
||||
|
|
@ -565,7 +562,7 @@ u_vfscanf_u(UFILE *f,
|
|||
* stored successively in <TT>s</TT> until a newline or EOF is
|
||||
* reached. A null character (U+0000) will be appended to <TT>s</TT>.
|
||||
* @return A pointer to <TT>s</TT>, or NULL if no characters were available.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UChar* U_EXPORT2
|
||||
u_fgets(UChar *s,
|
||||
|
|
@ -579,7 +576,7 @@ u_fgets(UChar *s,
|
|||
*
|
||||
* @param f The UFILE from which to read.
|
||||
* @return The UChar value read, or U+FFFF if no character was available.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UChar U_EXPORT2
|
||||
u_fgetc(UFILE *f);
|
||||
|
|
@ -592,7 +589,7 @@ u_fgetc(UFILE *f);
|
|||
* available, or U+FFFFFFFF if an ill-formed character was
|
||||
* encountered.
|
||||
* @see u_unescape()
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UChar32 U_EXPORT2
|
||||
u_fgetcx(UFILE *f);
|
||||
|
|
@ -606,7 +603,7 @@ u_fgetcx(UFILE *f);
|
|||
* @param c The UChar to put back on the stream.
|
||||
* @param f The UFILE to receive <TT>c</TT>.
|
||||
* @return The UChar32 value put back if successful, U_EOF otherwise.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UChar32 U_EXPORT2
|
||||
u_fungetc(UChar32 c,
|
||||
|
|
@ -620,7 +617,7 @@ u_fungetc(UChar32 c,
|
|||
* @param count The number of Unicode characters to read.
|
||||
* @param f The UFILE from which to read.
|
||||
* @return The number of Unicode characters read.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_file_read(UChar *chars,
|
||||
|
|
@ -644,7 +641,7 @@ u_file_read(UChar *chars,
|
|||
* caller. If U_READWRITE is specified, only the WRITE transliterator
|
||||
* is returned. In most cases, the caller should call utrans_close()
|
||||
* on the result of this function.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT UTransliterator* U_EXPORT2
|
||||
u_fsettransliterator(UFILE *file, UFileDirection direction,
|
||||
|
|
@ -665,7 +662,7 @@ u_fsettransliterator(UFILE *file, UFileDirection direction,
|
|||
* interpret the variable arguments received and format the data.
|
||||
* @return The number of Unicode code units written to <TT>buffer</TT>. This
|
||||
* does not include the terminating null character.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_sprintf(UChar *buffer,
|
||||
|
|
@ -686,7 +683,7 @@ u_sprintf(UChar *buffer,
|
|||
* interpret the variable arguments received and format the data.
|
||||
* @return The number of Unicode code units written to <TT>buffer</TT>. This
|
||||
* does not include the terminating null character.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_snprintf(UChar *buffer,
|
||||
|
|
@ -705,7 +702,7 @@ u_snprintf(UChar *buffer,
|
|||
* @param ap The argument list to use.
|
||||
* @return The number of Unicode characters written to <TT>buffer</TT>.
|
||||
* @see u_sprintf
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vsprintf(UChar *buffer,
|
||||
|
|
@ -729,7 +726,7 @@ u_vsprintf(UChar *buffer,
|
|||
* @param ap The argument list to use.
|
||||
* @return The number of Unicode characters written to <TT>buffer</TT>.
|
||||
* @see u_sprintf
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vsnprintf(UChar *buffer,
|
||||
|
|
@ -744,7 +741,7 @@ u_vsnprintf(UChar *buffer,
|
|||
* @param patternSpecification A pattern specifying how <TT>u_sprintf</TT> will
|
||||
* interpret the variable arguments received and format the data.
|
||||
* @return The number of Unicode characters written to <TT>buffer</TT>.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_sprintf_u(UChar *buffer,
|
||||
|
|
@ -764,7 +761,7 @@ u_sprintf_u(UChar *buffer,
|
|||
* @param patternSpecification A pattern specifying how <TT>u_sprintf</TT> will
|
||||
* interpret the variable arguments received and format the data.
|
||||
* @return The number of Unicode characters written to <TT>buffer</TT>.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_snprintf_u(UChar *buffer,
|
||||
|
|
@ -783,7 +780,7 @@ u_snprintf_u(UChar *buffer,
|
|||
* @param ap The argument list to use.
|
||||
* @return The number of Unicode characters written to <TT>f</TT>.
|
||||
* @see u_sprintf_u
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vsprintf_u(UChar *buffer,
|
||||
|
|
@ -807,7 +804,7 @@ u_vsprintf_u(UChar *buffer,
|
|||
* @param ap The argument list to use.
|
||||
* @return The number of Unicode characters written to <TT>f</TT>.
|
||||
* @see u_sprintf_u
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vsnprintf_u(UChar *buffer,
|
||||
|
|
@ -825,7 +822,7 @@ u_vsnprintf_u(UChar *buffer,
|
|||
* interpret the variable arguments received and parse the data.
|
||||
* @return The number of items successfully converted and assigned, or EOF
|
||||
* if an error occurred.
|
||||
* @draft 3.0
|
||||
* @stable 3.6
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_sscanf(const UChar *buffer,
|
||||
|
|
@ -844,7 +841,7 @@ u_sscanf(const UChar *buffer,
|
|||
* @return The number of items successfully converted and assigned, or EOF
|
||||
* if an error occurred.
|
||||
* @see u_sscanf
|
||||
* @draft 3.0
|
||||
* @draft 3.6
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vsscanf(const UChar *buffer,
|
||||
|
|
@ -859,7 +856,7 @@ u_vsscanf(const UChar *buffer,
|
|||
* interpret the variable arguments received and parse the data.
|
||||
* @return The number of items successfully converted and assigned, or EOF
|
||||
* if an error occurred.
|
||||
* @draft 3.0
|
||||
* @draft 3.6
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_sscanf_u(const UChar *buffer,
|
||||
|
|
@ -878,7 +875,7 @@ u_sscanf_u(const UChar *buffer,
|
|||
* @return The number of items successfully converted and assigned, or EOF
|
||||
* if an error occurred.
|
||||
* @see u_sscanf_u
|
||||
* @draft 3.0
|
||||
* @draft 3.6
|
||||
*/
|
||||
U_DRAFT int32_t U_EXPORT2
|
||||
u_vsscanf_u(const UChar *buffer,
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/*
|
||||
**********************************************************************
|
||||
* Copyright (C) 2001-2005, International Business Machines
|
||||
* Copyright (C) 2001-2006 International Business Machines
|
||||
* Corporation and others. All Rights Reserved.
|
||||
**********************************************************************
|
||||
* FILE NAME : ustream.h
|
||||
|
|
@ -36,7 +36,7 @@ U_NAMESPACE_BEGIN
|
|||
* the characters in a UnicodeString to an ostream. The UChars in the
|
||||
* UnicodeString are converted to the char based ostream with the default
|
||||
* converter.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_IO_API std::ostream & U_EXPORT2 operator<<(std::ostream& stream, const UnicodeString& s);
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ U_IO_API std::ostream & U_EXPORT2 operator<<(std::ostream& stream, const Unicode
|
|||
* Write the contents from a C++ istream to a UnicodeString. The UChars in the
|
||||
* UnicodeString are converted from the char based istream with the default
|
||||
* converter.
|
||||
* @draft 3.0
|
||||
* @stable 3.0
|
||||
*/
|
||||
U_IO_API std::istream & U_EXPORT2 operator>>(std::istream& stream, UnicodeString& s);
|
||||
U_NAMESPACE_END
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue