/*
******************************************************************************
*
-* Copyright (C) 1998-2008, International Business Machines
+* Copyright (C) 1998-2015, International Business Machines
* Corporation and others. All Rights Reserved.
*
******************************************************************************
#include "unicode/utypes.h"
#include "unicode/ucnv.h"
#include "unicode/utrans.h"
+#include "unicode/localpointer.h"
+#include "unicode/unum.h"
+
+#if !UCONFIG_NO_CONVERSION
/*
TODO
* 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 ICU 3.0
*/
-U_DRAFT UFILE* U_EXPORT2
+U_STABLE UFILE* U_EXPORT2
u_fopen(const char *filename,
const char *perm,
const char *locale,
const char *codepage);
/**
- * Open a UFILE on top of an existing FILE* stream.
- * @param f The FILE* to which this UFILE will attach.
+ * Open a UFILE with a UChar* filename
+ * A UFILE is a wrapper around a FILE* that is locale and codepage aware.
+ * That is, data written to a UFILE will be formatted using the conventions
+ * specified by that UFILE's Locale; this data will be in the character set
+ * specified by that UFILE's codepage.
+ * @param filename The name of the file to open.
+ * @param perm The read/write permission for the UFILE; one of "r", "w", "rw"
+ * @param locale The locale whose conventions will be used to format
+ * and parse output. If this parameter is NULL, the default locale will
+ * be used.
+ * @param codepage The codepage in which data will be written to and
+ * 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 ICU 54
+ */
+U_STABLE UFILE* U_EXPORT2
+u_fopen_u(const UChar *filename,
+ const char *perm,
+ const char *locale,
+ const char *codepage);
+
+/**
+ * Open a UFILE on top of an existing FILE* stream. The FILE* stream
+ * ownership remains with the caller. To have the UFILE take over
+ * ownership and responsibility for the FILE* stream, use the
+ * function u_fadopt.
+ * @param f The FILE* to which this UFILE will attach and use.
* @param locale The locale whose conventions will be used to format
* and parse output. If this parameter is NULL, the default locale will
* be used.
* 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 ICU 3.0
*/
-U_DRAFT UFILE* U_EXPORT2
+U_STABLE UFILE* U_EXPORT2
u_finit(FILE *f,
const char *locale,
const char *codepage);
+/**
+ * Open a UFILE on top of an existing FILE* stream. The FILE* stream
+ * ownership is transferred to the new UFILE. It will be closed when the
+ * UFILE is closed.
+ * @param f The FILE* which this UFILE will take ownership of.
+ * @param locale The locale whose conventions will be used to format
+ * and parse output. If this parameter is NULL, the default locale will
+ * be used.
+ * @param codepage The codepage in which data will be written to and
+ * read from the file. If this paramter is NULL, data will be written and
+ * 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. If an error occurs
+ * the ownership of the FILE* stream remains with the caller.
+ * @stable ICU 4.4
+ */
+U_STABLE UFILE* U_EXPORT2
+u_fadopt(FILE *f,
+ const char *locale,
+ const char *codepage);
+
/**
* Create a UFILE that can be used for localized formatting or parsing.
* The u_sprintf and u_sscanf functions do not read or write numbers for a
* 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 ICU 3.0
*/
-U_DRAFT UFILE* U_EXPORT2
+U_STABLE UFILE* U_EXPORT2
u_fstropen(UChar *stringBuf,
int32_t capacity,
const char *locale);
/**
- * Close a UFILE.
+ * Close a UFILE. Implies u_fflush first.
* @param file The UFILE to close.
- * @draft 3.0
+ * @stable ICU 3.0
+ * @see u_fflush
*/
-U_DRAFT void U_EXPORT2
+U_STABLE void U_EXPORT2
u_fclose(UFILE *file);
+#if U_SHOW_CPLUSPLUS_API
+
+U_NAMESPACE_BEGIN
+
+/**
+ * \class LocalUFILEPointer
+ * "Smart pointer" class, closes a UFILE via u_fclose().
+ * For most methods see the LocalPointerBase base class.
+ *
+ * @see LocalPointerBase
+ * @see LocalPointer
+ * @stable ICU 4.4
+ */
+U_DEFINE_LOCAL_OPEN_POINTER(LocalUFILEPointer, UFILE, u_fclose);
+
+U_NAMESPACE_END
+
+#endif
+
/**
* Tests if the UFILE is at the end of the file stream.
* @param f The UFILE from which to read.
* @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 ICU 3.0
*/
-U_DRAFT UBool U_EXPORT2
+U_STABLE UBool U_EXPORT2
u_feof(UFILE *f);
/**
* converter/transliterator state. (That is, a logical break is
* made in the output stream - for example if a different type of
* output is desired.) The underlying OS level file is also flushed.
+ * Note that for a stateful encoding, the converter may write additional
+ * bytes to return the stream to default state.
* @param file The UFILE to flush.
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT void U_EXPORT2
+U_STABLE void U_EXPORT2
u_fflush(UFILE *file);
/**
* Rewind the file pointer to the beginning of the file.
* @param file The UFILE to rewind.
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT void
+U_STABLE 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.
- * @draft 3.0
+ * @return A FILE*, owned by the UFILE. (The FILE <EM>must not</EM> be modified or closed)
+ * @stable ICU 3.0
*/
-U_DRAFT FILE* U_EXPORT2
+U_STABLE FILE* U_EXPORT2
u_fgetfile(UFILE *f);
#if !UCONFIG_NO_FORMATTING
* 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 ICU 3.0
*/
-U_DRAFT const char* U_EXPORT2
+U_STABLE const char* U_EXPORT2
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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_fsetlocale(UFILE *file,
const char *locale);
* @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 ICU 3.0
*/
-U_DRAFT const char* U_EXPORT2
+U_STABLE const char* U_EXPORT2
u_fgetcodepage(UFILE *file);
/**
* mix codepages within a file. This should only be called right
* after opening the <TT>UFile</TT>, or after calling <TT>u_frewind</TT>.
* @param codepage The codepage in which data will be written to
- * and read from the file. For example <TT>"latin-1"</TT> or <TT>"ibm-943</TT>.
+ * and read from the file. For example <TT>"latin-1"</TT> or <TT>"ibm-943"</TT>.
* A value of NULL means the default codepage for the UFILE's current
* locale will be used.
* @param file The UFILE to set.
* @return 0 if successful, otherwise a negative number.
* @see u_frewind
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_fsetcodepage(const char *codepage,
UFILE *file);
/**
* 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
+ * @return alias to the converter (The converter <EM>must not</EM> be modified or closed)
+ * @stable ICU 3.0
*/
-U_DRAFT UConverter* U_EXPORT2 u_fgetConverter(UFILE *f);
+U_STABLE UConverter* U_EXPORT2 u_fgetConverter(UFILE *f);
#if !UCONFIG_NO_FORMATTING
+/**
+ * Returns an alias to the number formatter being used for this file.
+ * @param f The UFILE to get the value from
+ * @return alias to the number formatter (The formatter <EM>must not</EM> be modified or closed)
+ * @stable ICU 51
+*/
+ U_STABLE const UNumberFormat* U_EXPORT2 u_fgetNumberFormat(UFILE *f);
/* Output functions */
+/**
+ * Write formatted data to <TT>stdout</TT>.
+ * @param patternSpecification A pattern specifying how <TT>u_printf</TT> will
+ * interpret the variable arguments received and format the data.
+ * @return The number of Unicode characters written to <TT>stdout</TT>
+ * @stable ICU 49
+ */
+U_STABLE int32_t U_EXPORT2
+u_printf(const char *patternSpecification,
+ ... );
+
/**
* Write formatted data to a UFILE.
* @param f The UFILE to which to write.
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_fprintf(UFILE *f,
const char *patternSpecification,
... );
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vfprintf(UFILE *f,
const char *patternSpecification,
va_list ap);
+/**
+ * Write formatted data to <TT>stdout</TT>.
+ * @param patternSpecification A pattern specifying how <TT>u_printf_u</TT> will
+ * interpret the variable arguments received and format the data.
+ * @return The number of Unicode characters written to <TT>stdout</TT>
+ * @stable ICU 49
+ */
+U_STABLE int32_t U_EXPORT2
+u_printf_u(const UChar *patternSpecification,
+ ... );
+
+/**
+ * Get a UFILE for <TT>stdout</TT>.
+ * @return UFILE that writes to <TT>stdout</TT>
+ * @stable ICU 49
+ */
+U_STABLE UFILE * U_EXPORT2
+u_get_stdout(void);
+
/**
* Write formatted data to a UFILE.
* @param f The UFILE to which to write.
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_fprintf_u(UFILE *f,
const UChar *patternSpecification,
... );
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vfprintf_u(UFILE *f,
const UChar *patternSpecification,
va_list ap);
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_fputs(const UChar *s,
UFILE *f);
* @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 ICU 3.0
*/
-U_DRAFT UChar32 U_EXPORT2
+U_STABLE UChar32 U_EXPORT2
u_fputc(UChar32 uc,
UFILE *f);
* @param f The UFILE to which to write.
* @return The number of Unicode characters written.
* @see u_fputs
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_file_write(const UChar *ustring,
int32_t count,
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
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_fscanf(UFILE *f,
const char *patternSpecification,
... );
* @return The number of items successfully converted and assigned, or EOF
* if an error occurred.
* @see u_fscanf
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vfscanf(UFILE *f,
const char *patternSpecification,
va_list ap);
* 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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_fscanf_u(UFILE *f,
const UChar *patternSpecification,
... );
* @return The number of items successfully converted and assigned, or EOF
* if an error occurred.
* @see u_fscanf_u
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vfscanf_u(UFILE *f,
const UChar *patternSpecification,
va_list ap);
* 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 ICU 3.0
*/
-U_DRAFT UChar* U_EXPORT2
+U_STABLE UChar* U_EXPORT2
u_fgets(UChar *s,
int32_t n,
UFILE *f);
*
* @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 ICU 3.0
*/
-U_DRAFT UChar U_EXPORT2
+U_STABLE UChar U_EXPORT2
u_fgetc(UFILE *f);
/**
* available, or U+FFFFFFFF if an ill-formed character was
* encountered.
* @see u_unescape()
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT UChar32 U_EXPORT2
+U_STABLE UChar32 U_EXPORT2
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 ICU 3.0
*/
-U_DRAFT UChar32 U_EXPORT2
+U_STABLE UChar32 U_EXPORT2
u_fungetc(UChar32 c,
UFILE *f);
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_file_read(UChar *chars,
int32_t count,
UFILE *f);
* 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 ICU 3.0
*/
-U_DRAFT UTransliterator* U_EXPORT2
+U_STABLE UTransliterator* U_EXPORT2
u_fsettransliterator(UFILE *file, UFileDirection direction,
UTransliterator *adopt, UErrorCode *status);
* 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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_sprintf(UChar *buffer,
const char *patternSpecification,
... );
* @return The number of Unicode characters that would have been written to
* <TT>buffer</TT> had count been sufficiently large. This does not include
* the terminating null character.
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_snprintf(UChar *buffer,
int32_t count,
const char *patternSpecification,
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vsprintf(UChar *buffer,
const char *patternSpecification,
va_list ap);
* @return The number of Unicode characters that would have been written to
* <TT>buffer</TT> had count been sufficiently large.
* @see u_sprintf
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vsnprintf(UChar *buffer,
int32_t count,
const char *patternSpecification,
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_sprintf_u(UChar *buffer,
const UChar *patternSpecification,
... );
* interpret the variable arguments received and format the data.
* @return The number of Unicode characters that would have been written to
* <TT>buffer</TT> had count been sufficiently large.
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_snprintf_u(UChar *buffer,
int32_t count,
const UChar *patternSpecification,
* @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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vsprintf_u(UChar *buffer,
const UChar *patternSpecification,
va_list ap);
* @return The number of Unicode characters that would have been written to
* <TT>f</TT> had count been sufficiently large.
* @see u_sprintf_u
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vsnprintf_u(UChar *buffer,
int32_t count,
const UChar *patternSpecification,
* 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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_sscanf(const UChar *buffer,
const char *patternSpecification,
... );
* @return The number of items successfully converted and assigned, or EOF
* if an error occurred.
* @see u_sscanf
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vsscanf(const UChar *buffer,
const char *patternSpecification,
va_list ap);
* 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 ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_sscanf_u(const UChar *buffer,
const UChar *patternSpecification,
... );
* @return The number of items successfully converted and assigned, or EOF
* if an error occurred.
* @see u_sscanf_u
- * @draft 3.0
+ * @stable ICU 3.0
*/
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
u_vsscanf_u(const UChar *buffer,
const UChar *patternSpecification,
va_list ap);
+
+#endif
#endif
#endif
projects / apple / icu.git / blobdiff