Back to index

lightning-sunbird  0.9+nobinonly
prprf.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Netscape Portable Runtime (NSPR).
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef prprf_h___
00039 #define prprf_h___
00040 
00041 /*
00042 ** API for PR printf like routines. Supports the following formats
00043 **     %d - decimal
00044 **     %u - unsigned decimal
00045 **     %x - unsigned hex
00046 **     %X - unsigned uppercase hex
00047 **     %o - unsigned octal
00048 **     %hd, %hu, %hx, %hX, %ho - 16-bit versions of above
00049 **     %ld, %lu, %lx, %lX, %lo - 32-bit versions of above
00050 **     %lld, %llu, %llx, %llX, %llo - 64 bit versions of above
00051 **     %s - string
00052 **     %c - character
00053 **     %p - pointer (deals with machine dependent pointer size)
00054 **     %f - float
00055 **     %g - float
00056 */
00057 #include "prtypes.h"
00058 #include "prio.h"
00059 #include <stdio.h>
00060 #include <stdarg.h>
00061 
00062 PR_BEGIN_EXTERN_C
00063 
00064 /*
00065 ** sprintf into a fixed size buffer. Guarantees that a NUL is at the end
00066 ** of the buffer. Returns the length of the written output, NOT including
00067 ** the NUL, or (PRUint32)-1 if an error occurs.
00068 */
00069 NSPR_API(PRUint32) PR_snprintf(char *out, PRUint32 outlen, const char *fmt, ...);
00070 
00071 /*
00072 ** sprintf into a PR_MALLOC'd buffer. Return a pointer to the malloc'd
00073 ** buffer on success, NULL on failure. Call "PR_smprintf_free" to release
00074 ** the memory returned.
00075 */
00076 NSPR_API(char*) PR_smprintf(const char *fmt, ...);
00077 
00078 /*
00079 ** Free the memory allocated, for the caller, by PR_smprintf
00080 */
00081 NSPR_API(void) PR_smprintf_free(char *mem);
00082 
00083 /*
00084 ** "append" sprintf into a PR_MALLOC'd buffer. "last" is the last value of
00085 ** the PR_MALLOC'd buffer. sprintf will append data to the end of last,
00086 ** growing it as necessary using realloc. If last is NULL, PR_sprintf_append
00087 ** will allocate the initial string. The return value is the new value of
00088 ** last for subsequent calls, or NULL if there is a malloc failure.
00089 */
00090 NSPR_API(char*) PR_sprintf_append(char *last, const char *fmt, ...);
00091 
00092 /*
00093 ** sprintf into a function. The function "f" is called with a string to
00094 ** place into the output. "arg" is an opaque pointer used by the stuff
00095 ** function to hold any state needed to do the storage of the output
00096 ** data. The return value is a count of the number of characters fed to
00097 ** the stuff function, or (PRUint32)-1 if an error occurs.
00098 */
00099 typedef PRIntn (*PRStuffFunc)(void *arg, const char *s, PRUint32 slen);
00100 
00101 NSPR_API(PRUint32) PR_sxprintf(PRStuffFunc f, void *arg, const char *fmt, ...);
00102 
00103 /*
00104 ** fprintf to a PRFileDesc
00105 */
00106 NSPR_API(PRUint32) PR_fprintf(struct PRFileDesc* fd, const char *fmt, ...);
00107 
00108 /*
00109 ** va_list forms of the above.
00110 */
00111 NSPR_API(PRUint32) PR_vsnprintf(char *out, PRUint32 outlen, const char *fmt, va_list ap);
00112 NSPR_API(char*) PR_vsmprintf(const char *fmt, va_list ap);
00113 NSPR_API(char*) PR_vsprintf_append(char *last, const char *fmt, va_list ap);
00114 NSPR_API(PRUint32) PR_vsxprintf(PRStuffFunc f, void *arg, const char *fmt, va_list ap);
00115 NSPR_API(PRUint32) PR_vfprintf(struct PRFileDesc* fd, const char *fmt, va_list ap);
00116 
00117 /*
00118 ***************************************************************************
00119 ** FUNCTION: PR_sscanf
00120 ** DESCRIPTION:
00121 **     PR_sscanf() scans the input character string, performs data
00122 **     conversions, and stores the converted values in the data objects
00123 **     pointed to by its arguments according to the format control
00124 **     string.
00125 **
00126 **     PR_sscanf() behaves the same way as the sscanf() function in the
00127 **     Standard C Library (stdio.h), with the following exceptions:
00128 **     - PR_sscanf() handles the NSPR integer and floating point types,
00129 **       such as PRInt16, PRInt32, PRInt64, and PRFloat64, whereas
00130 **       sscanf() handles the standard C types like short, int, long,
00131 **       and double.
00132 **     - PR_sscanf() has no multibyte character support, while sscanf()
00133 **       does.
00134 ** INPUTS:
00135 **     const char *buf
00136 **         a character string holding the input to scan
00137 **     const char *fmt
00138 **         the format control string for the conversions
00139 **     ...
00140 **         variable number of arguments, each of them is a pointer to
00141 **         a data object in which the converted value will be stored
00142 ** OUTPUTS: none
00143 ** RETURNS: PRInt32
00144 **     The number of values converted and stored.
00145 ** RESTRICTIONS:
00146 **    Multibyte characters in 'buf' or 'fmt' are not allowed.
00147 ***************************************************************************
00148 */
00149 
00150 NSPR_API(PRInt32) PR_sscanf(const char *buf, const char *fmt, ...);
00151 
00152 PR_END_EXTERN_C
00153 
00154 #endif /* prprf_h___ */