js/src/jsprf.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 Mozilla Communicator client code, released
  16  * March 31, 1998.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1998
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef jsprf_h___
  40 #define jsprf_h___
  41
  42 /*
  43 ** API for PR printf like routines. Supports the following formats
  44 **      %d - decimal
  45 **      %u - unsigned decimal
  46 **      %x - unsigned hex
  47 **      %X - unsigned uppercase hex
  48 **      %o - unsigned octal
  49 **      %hd, %hu, %hx, %hX, %ho - 16-bit versions of above
  50 **      %ld, %lu, %lx, %lX, %lo - 32-bit versions of above
  51 **      %lld, %llu, %llx, %llX, %llo - 64 bit versions of above
  52 **      %s - string
  53 **      %hs - 16-bit version of above (only available if js_CStringsAreUTF8)
  54 **      %c - character
  55 **      %hc - 16-bit version of above (only available if js_CStringsAreUTF8)
  56 **      %p - pointer (deals with machine dependent pointer size)
  57 **      %f - float
  58 **      %g - float
  59 */
  60 #include "jstypes.h"
  61 #include <stdio.h>
  62 #include <stdarg.h>
  63
  64 JS_BEGIN_EXTERN_C
  65
  66 /*
  67 ** sprintf into a fixed size buffer. Guarantees that a NUL is at the end
  68 ** of the buffer. Returns the length of the written output, NOT including
  69 ** the NUL, or (JSUint32)-1 if an error occurs.
  70 */
  71 extern JS_PUBLIC_API(JSUint32) JS_snprintf(char *out, JSUint32 outlen, const char *fmt, ...);
  72
  73 /*
  74 ** sprintf into a malloc'd buffer. Return a pointer to the malloc'd
  75 ** buffer on success, NULL on failure. Call "JS_smprintf_free" to release
  76 ** the memory returned.
  77 */
  78 extern JS_PUBLIC_API(char*) JS_smprintf(const char *fmt, ...);
  79
  80 /*
  81 ** Free the memory allocated, for the caller, by JS_smprintf
  82 */
  83 extern JS_PUBLIC_API(void) JS_smprintf_free(char *mem);
  84
  85 /*
  86 ** "append" sprintf into a malloc'd buffer. "last" is the last value of
  87 ** the malloc'd buffer. sprintf will append data to the end of last,
  88 ** growing it as necessary using realloc. If last is NULL, JS_sprintf_append
  89 ** will allocate the initial string. The return value is the new value of
  90 ** last for subsequent calls, or NULL if there is a malloc failure.
  91 */
  92 extern JS_PUBLIC_API(char*) JS_sprintf_append(char *last, const char *fmt, ...);
  93
  94 /*
  95 ** sprintf into a function. The function "f" is called with a string to
  96 ** place into the output. "arg" is an opaque pointer used by the stuff
  97 ** function to hold any state needed to do the storage of the output
  98 ** data. The return value is a count of the number of characters fed to
  99 ** the stuff function, or (JSUint32)-1 if an error occurs.
 100 */
 101 typedef JSIntn (*JSStuffFunc)(void *arg, const char *s, JSUint32 slen);
 102
 103 extern JS_PUBLIC_API(JSUint32) JS_sxprintf(JSStuffFunc f, void *arg, const char *fmt, ...);
 104
 105 /*
 106 ** va_list forms of the above.
 107 */
 108 extern JS_PUBLIC_API(JSUint32) JS_vsnprintf(char *out, JSUint32 outlen, const char *fmt, va_list ap);
 109 extern JS_PUBLIC_API(char*) JS_vsmprintf(const char *fmt, va_list ap);
 110 extern JS_PUBLIC_API(char*) JS_vsprintf_append(char *last, const char *fmt, va_list ap);
 111 extern JS_PUBLIC_API(JSUint32) JS_vsxprintf(JSStuffFunc f, void *arg, const char *fmt, va_list ap);
 112
 113 /*
 114 ***************************************************************************
 115 ** FUNCTION: JS_sscanf
 116 ** DESCRIPTION:
 117 **     JS_sscanf() scans the input character string, performs data
 118 **     conversions, and stores the converted values in the data objects
 119 **     pointed to by its arguments according to the format control
 120 **     string.
 121 **
 122 **     JS_sscanf() behaves the same way as the sscanf() function in the
 123 **     Standard C Library (stdio.h), with the following exceptions:
 124 **     - JS_sscanf() handles the NSPR integer and floating point types,
 125 **       such as JSInt16, JSInt32, JSInt64, and JSFloat64, whereas
 126 **       sscanf() handles the standard C types like short, int, long,
 127 **       and double.
 128 **     - JS_sscanf() has no multibyte character support, while sscanf()
 129 **       does.
 130 ** INPUTS:
 131 **     const char *buf
 132 **         a character string holding the input to scan
 133 **     const char *fmt
 134 **         the format control string for the conversions
 135 **     ...
 136 **         variable number of arguments, each of them is a pointer to
 137 **         a data object in which the converted value will be stored
 138 ** OUTPUTS: none
 139 ** RETURNS: JSInt32
 140 **     The number of values converted and stored.
 141 ** RESTRICTIONS:
 142 **    Multibyte characters in 'buf' or 'fmt' are not allowed.
 143 ***************************************************************************
 144 */
 145
 146 extern JS_PUBLIC_API(JSInt32) JS_sscanf(const char *buf, const char *fmt, ...);
 147
 148 JS_END_EXTERN_C
 149
 150 #endif /* jsprf_h___ */