prprf.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- *//* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is the Netscape Portable Runtime (NSPR). * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998-2000 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */#ifndef prprf_h___#define prprf_h___/*** API for PR printf like routines. Supports the following formats** %d - decimal** %u - unsigned decimal** %x - unsigned hex** %X - unsigned uppercase hex** %o - unsigned octal** %hd, %hu, %hx, %hX, %ho - 16-bit versions of above** %ld, %lu, %lx, %lX, %lo - 32-bit versions of above** %lld, %llu, %llx, %llX, %llo - 64 bit versions of above** %s - string** %c - character** %p - pointer (deals with machine dependent pointer size)** %f - float** %g - float*/#include "prtypes.h"#include "prio.h"#include <stdio.h>#include <stdarg.h>
PR_BEGIN_EXTERN_C
/*** sprintf into a fixed size buffer. Guarantees that a NUL is at the end** of the buffer. Returns the length of the written output, NOT including** the NUL, or (PRUint32)-1 if an error occurs.*/
NSPR_API(PRUint32) PR_snprintf(char *out, PRUint32 outlen, const char *fmt, ...);
/*** sprintf into a PR_MALLOC'd buffer. Return a pointer to the malloc'd** buffer on success, NULL on failure. Call "PR_smprintf_free" to release** the memory returned.*/
NSPR_API(char*) PR_smprintf(const char *fmt, ...);
/*** Free the memory allocated, for the caller, by PR_smprintf*/
NSPR_API(void) PR_smprintf_free(char *mem);
/*** "append" sprintf into a PR_MALLOC'd buffer. "last" is the last value of** the PR_MALLOC'd buffer. sprintf will append data to the end of last,** growing it as necessary using realloc. If last is NULL, PR_sprintf_append** will allocate the initial string. The return value is the new value of** last for subsequent calls, or NULL if there is a malloc failure.*/
NSPR_API(char*) PR_sprintf_append(char *last, const char *fmt, ...);
/*** sprintf into a function. The function "f" is called with a string to** place into the output. "arg" is an opaque pointer used by the stuff** function to hold any state needed to do the storage of the output** data. The return value is a count of the number of characters fed to** the stuff function, or (PRUint32)-1 if an error occurs.*/
typedef PRIntn (*PRStuffFunc)(void *arg, const char *s, PRUint32 slen);
NSPR_API(PRUint32) PR_sxprintf(PRStuffFunc f, void *arg, const char *fmt, ...);
/*** fprintf to a PRFileDesc*/
NSPR_API(PRUint32) PR_fprintf(struct PRFileDesc* fd, const char *fmt, ...);
/*** va_list forms of the above.*/
NSPR_API(PRUint32) PR_vsnprintf(char *out, PRUint32 outlen, const char *fmt, va_list ap);
NSPR_API(char*) PR_vsmprintf(const char *fmt, va_list ap);
NSPR_API(char*) PR_vsprintf_append(char *last, const char *fmt, va_list ap);
NSPR_API(PRUint32) PR_vsxprintf(PRStuffFunc f, void *arg, const char *fmt, va_list ap);
NSPR_API(PRUint32) PR_vfprintf(struct PRFileDesc* fd, const char *fmt, va_list ap);
/****************************************************************************** FUNCTION: PR_sscanf** DESCRIPTION:** PR_sscanf() scans the input character string, performs data** conversions, and stores the converted values in the data objects** pointed to by its arguments according to the format control** string.**** PR_sscanf() behaves the same way as the sscanf() function in the** Standard C Library (stdio.h), with the following exceptions:** - PR_sscanf() handles the NSPR integer and floating point types,** such as PRInt16, PRInt32, PRInt64, and PRFloat64, whereas** sscanf() handles the standard C types like short, int, long,** and double.** - PR_sscanf() has no multibyte character support, while sscanf()** does.** INPUTS:** const char *buf** a character string holding the input to scan** const char *fmt** the format control string for the conversions** ...** variable number of arguments, each of them is a pointer to** a data object in which the converted value will be stored** OUTPUTS: none** RETURNS: PRInt32** The number of values converted and stored.** RESTRICTIONS:** Multibyte characters in 'buf' or 'fmt' are not allowed.****************************************************************************/
NSPR_API(PRInt32) PR_sscanf(const char *buf, const char *fmt, ...);
PR_END_EXTERN_C
#endif /* prprf_h___ */