nsprpub/pr/include/prprf.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is the Netscape Portable Runtime (NSPR).
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998-2000
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef prprf_h___
  39 #define prprf_h___
  40
  41 /*
  42 ** API for PR printf like routines. Supports the following formats
  43 **      %d - decimal
  44 **      %u - unsigned decimal
  45 **      %x - unsigned hex
  46 **      %X - unsigned uppercase hex
  47 **      %o - unsigned octal
  48 **      %hd, %hu, %hx, %hX, %ho - 16-bit versions of above
  49 **      %ld, %lu, %lx, %lX, %lo - 32-bit versions of above
  50 **      %lld, %llu, %llx, %llX, %llo - 64 bit versions of above
  51 **      %s - string
  52 **      %c - character
  53 **      %p - pointer (deals with machine dependent pointer size)
  54 **      %f - float
  55 **      %g - float
  56 */
  57 #include "prtypes.h"
  58 #include "prio.h"
  59 #include <stdio.h>
  60 #include <stdarg.h>
  61
  62 PR_BEGIN_EXTERN_C
  63
  64 /*
  65 ** sprintf into a fixed size buffer. Guarantees that a NUL is at the end
  66 ** of the buffer. Returns the length of the written output, NOT including
  67 ** the NUL, or (PRUint32)-1 if an error occurs.
  68 */
  69 NSPR_API(PRUint32) PR_snprintf(char *out, PRUint32 outlen, const char *fmt, ...);
  70
  71 /*
  72 ** sprintf into a PR_MALLOC'd buffer. Return a pointer to the malloc'd
  73 ** buffer on success, NULL on failure. Call "PR_smprintf_free" to release
  74 ** the memory returned.
  75 */
  76 NSPR_API(char*) PR_smprintf(const char *fmt, ...);
  77
  78 /*
  79 ** Free the memory allocated, for the caller, by PR_smprintf
  80 */
  81 NSPR_API(void) PR_smprintf_free(char *mem);
  82
  83 /*
  84 ** "append" sprintf into a PR_MALLOC'd buffer. "last" is the last value of
  85 ** the PR_MALLOC'd buffer. sprintf will append data to the end of last,
  86 ** growing it as necessary using realloc. If last is NULL, PR_sprintf_append
  87 ** will allocate the initial string. The return value is the new value of
  88 ** last for subsequent calls, or NULL if there is a malloc failure.
  89 */
  90 NSPR_API(char*) PR_sprintf_append(char *last, const char *fmt, ...);
  91
  92 /*
  93 ** sprintf into a function. The function "f" is called with a string to
  94 ** place into the output. "arg" is an opaque pointer used by the stuff
  95 ** function to hold any state needed to do the storage of the output
  96 ** data. The return value is a count of the number of characters fed to
  97 ** the stuff function, or (PRUint32)-1 if an error occurs.
  98 */
  99 typedef PRIntn (*PRStuffFunc)(void *arg, const char *s, PRUint32 slen);
 100
 101 NSPR_API(PRUint32) PR_sxprintf(PRStuffFunc f, void *arg, const char *fmt, ...);
 102
 103 /*
 104 ** fprintf to a PRFileDesc
 105 */
 106 NSPR_API(PRUint32) PR_fprintf(struct PRFileDesc* fd, const char *fmt, ...);
 107
 108 /*
 109 ** va_list forms of the above.
 110 */
 111 NSPR_API(PRUint32) PR_vsnprintf(char *out, PRUint32 outlen, const char *fmt, va_list ap);
 112 NSPR_API(char*) PR_vsmprintf(const char *fmt, va_list ap);
 113 NSPR_API(char*) PR_vsprintf_append(char *last, const char *fmt, va_list ap);
 114 NSPR_API(PRUint32) PR_vsxprintf(PRStuffFunc f, void *arg, const char *fmt, va_list ap);
 115 NSPR_API(PRUint32) PR_vfprintf(struct PRFileDesc* fd, const char *fmt, va_list ap);
 116
 117 /*
 118 ***************************************************************************
 119 ** FUNCTION: PR_sscanf
 120 ** DESCRIPTION:
 121 **     PR_sscanf() scans the input character string, performs data
 122 **     conversions, and stores the converted values in the data objects
 123 **     pointed to by its arguments according to the format control
 124 **     string.
 125 **
 126 **     PR_sscanf() behaves the same way as the sscanf() function in the
 127 **     Standard C Library (stdio.h), with the following exceptions:
 128 **     - PR_sscanf() handles the NSPR integer and floating point types,
 129 **       such as PRInt16, PRInt32, PRInt64, and PRFloat64, whereas
 130 **       sscanf() handles the standard C types like short, int, long,
 131 **       and double.
 132 **     - PR_sscanf() has no multibyte character support, while sscanf()
 133 **       does.
 134 ** INPUTS:
 135 **     const char *buf
 136 **         a character string holding the input to scan
 137 **     const char *fmt
 138 **         the format control string for the conversions
 139 **     ...
 140 **         variable number of arguments, each of them is a pointer to
 141 **         a data object in which the converted value will be stored
 142 ** OUTPUTS: none
 143 ** RETURNS: PRInt32
 144 **     The number of values converted and stored.
 145 ** RESTRICTIONS:
 146 **    Multibyte characters in 'buf' or 'fmt' are not allowed.
 147 ***************************************************************************
 148 */
 149
 150 NSPR_API(PRInt32) PR_sscanf(const char *buf, const char *fmt, ...);
 151
 152 PR_END_EXTERN_C
 153
 154 #endif /* prprf_h___ */