ICU-5008 Undo @draft changes done after d01.

X-SVN-Rev: 20127
This commit is contained in:
George Rhoten 2006-08-22 05:46:28 +00:00
parent e001b5021f
commit a40785e3f4

View file

@ -193,10 +193,11 @@ 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
* @stable 3.0
* @draft 3.0
*/
typedef enum {
U_READ = 1,
@ -204,6 +205,8 @@ 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.
@ -219,9 +222,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UFILE* U_EXPORT2
U_DRAFT UFILE* U_EXPORT2
u_fopen(const char *filename,
const char *perm,
const char *locale,
@ -238,9 +241,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UFILE* U_EXPORT2
U_DRAFT UFILE* U_EXPORT2
u_finit(FILE *f,
const char *locale,
const char *codepage);
@ -257,9 +260,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UFILE* U_EXPORT2
U_DRAFT UFILE* U_EXPORT2
u_fstropen(UChar *stringBuf,
int32_t capacity,
const char *locale);
@ -267,9 +270,9 @@ u_fstropen(UChar *stringBuf,
/**
* Close a UFILE.
* @param file The UFILE to close.
* @stable 3.0
* @draft 3.0
*/
U_STABLE void U_EXPORT2
U_DRAFT void U_EXPORT2
u_fclose(UFILE *file);
/**
@ -278,9 +281,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UBool U_EXPORT2
U_DRAFT UBool U_EXPORT2
u_feof(UFILE *f);
/**
@ -289,26 +292,26 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE void U_EXPORT2
U_DRAFT void U_EXPORT2
u_fflush(UFILE *file);
/**
* Rewind the file pointer to the beginning of the file.
* @param file The UFILE to rewind.
* @stable 3.0
* @draft 3.0
*/
U_STABLE void
U_DRAFT void
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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE FILE* U_EXPORT2
U_DRAFT FILE* U_EXPORT2
u_fgetfile(UFILE *f);
#if !UCONFIG_NO_FORMATTING
@ -319,9 +322,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE const char* U_EXPORT2
U_DRAFT const char* U_EXPORT2
u_fgetlocale(UFILE *file);
/**
@ -330,9 +333,9 @@ u_fgetlocale(UFILE *file);
* and parse output.
* @param file The UFILE to query.
* @return NULL if successful, otherwise a negative number.
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_fsetlocale(UFILE *file,
const char *locale);
@ -345,9 +348,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE const char* U_EXPORT2
U_DRAFT const char* U_EXPORT2
u_fgetcodepage(UFILE *file);
/**
@ -363,9 +366,9 @@ u_fgetcodepage(UFILE *file);
* @param file The UFILE to set.
* @return 0 if successful, otherwise a negative number.
* @see u_frewind
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_fsetcodepage(const char *codepage,
UFILE *file);
@ -374,9 +377,9 @@ 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
* @stable 3.0
* @draft 3.0
*/
U_STABLE UConverter* U_EXPORT2 u_fgetConverter(UFILE *f);
U_DRAFT UConverter* U_EXPORT2 u_fgetConverter(UFILE *f);
#if !UCONFIG_NO_FORMATTING
@ -388,9 +391,9 @@ U_STABLE 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>.
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_fprintf(UFILE *f,
const char *patternSpecification,
... );
@ -405,9 +408,9 @@ 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
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_vfprintf(UFILE *f,
const char *patternSpecification,
va_list ap);
@ -418,9 +421,9 @@ 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>.
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_fprintf_u(UFILE *f,
const UChar *patternSpecification,
... );
@ -435,9 +438,9 @@ 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
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_vfprintf_u(UFILE *f,
const UChar *patternSpecification,
va_list ap);
@ -450,9 +453,9 @@ 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
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_fputs(const UChar *s,
UFILE *f);
@ -461,9 +464,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UChar32 U_EXPORT2
U_DRAFT UChar32 U_EXPORT2
u_fputc(UChar32 uc,
UFILE *f);
@ -476,9 +479,9 @@ u_fputc(UChar32 uc,
* @param f The UFILE to which to write.
* @return The number of Unicode characters written.
* @see u_fputs
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_file_write(const UChar *ustring,
int32_t count,
UFILE *f);
@ -494,7 +497,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.6
* @draft 3.0
*/
U_DRAFT int32_t U_EXPORT2
u_fscanf(UFILE *f,
@ -512,7 +515,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.6
* @draft 3.0
*/
U_DRAFT int32_t U_EXPORT2
u_vfscanf(UFILE *f,
@ -526,7 +529,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.6
* @draft 3.0
*/
U_DRAFT int32_t U_EXPORT2
u_fscanf_u(UFILE *f,
@ -544,7 +547,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.6
* @draft 3.0
*/
U_DRAFT int32_t U_EXPORT2
u_vfscanf_u(UFILE *f,
@ -562,9 +565,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UChar* U_EXPORT2
U_DRAFT UChar* U_EXPORT2
u_fgets(UChar *s,
int32_t n,
UFILE *f);
@ -576,9 +579,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UChar U_EXPORT2
U_DRAFT UChar U_EXPORT2
u_fgetc(UFILE *f);
/**
@ -589,9 +592,9 @@ u_fgetc(UFILE *f);
* available, or U+FFFFFFFF if an ill-formed character was
* encountered.
* @see u_unescape()
* @stable 3.0
* @draft 3.0
*/
U_STABLE UChar32 U_EXPORT2
U_DRAFT UChar32 U_EXPORT2
u_fgetcx(UFILE *f);
/**
@ -603,9 +606,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UChar32 U_EXPORT2
U_DRAFT UChar32 U_EXPORT2
u_fungetc(UChar32 c,
UFILE *f);
@ -617,9 +620,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_file_read(UChar *chars,
int32_t count,
UFILE *f);
@ -641,9 +644,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE UTransliterator* U_EXPORT2
U_DRAFT UTransliterator* U_EXPORT2
u_fsettransliterator(UFILE *file, UFileDirection direction,
UTransliterator *adopt, UErrorCode *status);
@ -662,9 +665,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_sprintf(UChar *buffer,
const char *patternSpecification,
... );
@ -683,9 +686,9 @@ 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.
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_snprintf(UChar *buffer,
int32_t count,
const char *patternSpecification,
@ -702,9 +705,9 @@ 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
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_vsprintf(UChar *buffer,
const char *patternSpecification,
va_list ap);
@ -726,9 +729,9 @@ 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
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_vsnprintf(UChar *buffer,
int32_t count,
const char *patternSpecification,
@ -741,9 +744,9 @@ 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>.
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_sprintf_u(UChar *buffer,
const UChar *patternSpecification,
... );
@ -761,9 +764,9 @@ 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>.
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_snprintf_u(UChar *buffer,
int32_t count,
const UChar *patternSpecification,
@ -780,9 +783,9 @@ 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
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_vsprintf_u(UChar *buffer,
const UChar *patternSpecification,
va_list ap);
@ -804,9 +807,9 @@ 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
* @stable 3.0
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_vsnprintf_u(UChar *buffer,
int32_t count,
const UChar *patternSpecification,
@ -822,9 +825,9 @@ 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.
* @stable 3.6
* @draft 3.0
*/
U_STABLE int32_t U_EXPORT2
U_DRAFT int32_t U_EXPORT2
u_sscanf(const UChar *buffer,
const char *patternSpecification,
... );
@ -841,7 +844,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.6
* @draft 3.0
*/
U_DRAFT int32_t U_EXPORT2
u_vsscanf(const UChar *buffer,
@ -856,7 +859,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.6
* @draft 3.0
*/
U_DRAFT int32_t U_EXPORT2
u_sscanf_u(const UChar *buffer,
@ -875,7 +878,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.6
* @draft 3.0
*/
U_DRAFT int32_t U_EXPORT2
u_vsscanf_u(const UChar *buffer,