Back to index

lightning-sunbird  0.9+nobinonly
jsprf.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 Mozilla Communicator client code, released
00016  * March 31, 1998.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef jsprf_h___
00040 #define jsprf_h___
00041 
00042 /*
00043 ** API for PR printf like routines. Supports the following formats
00044 **      %d - decimal
00045 **      %u - unsigned decimal
00046 **      %x - unsigned hex
00047 **      %X - unsigned uppercase hex
00048 **      %o - unsigned octal
00049 **      %hd, %hu, %hx, %hX, %ho - 16-bit versions of above
00050 **      %ld, %lu, %lx, %lX, %lo - 32-bit versions of above
00051 **      %lld, %llu, %llx, %llX, %llo - 64 bit versions of above
00052 **      %s - string
00053 **      %hs - 16-bit version of above (only available if compiled with JS_C_STRINGS_ARE_UTF8)
00054 **      %c - character
00055 **      %hc - 16-bit version of above (only available if compiled with JS_C_STRINGS_ARE_UTF8)
00056 **      %p - pointer (deals with machine dependent pointer size)
00057 **      %f - float
00058 **      %g - float
00059 */
00060 #include "jstypes.h"
00061 #include <stdio.h>
00062 #include <stdarg.h>
00063 
00064 JS_BEGIN_EXTERN_C
00065 
00066 /*
00067 ** sprintf into a fixed size buffer. Guarantees that a NUL is at the end
00068 ** of the buffer. Returns the length of the written output, NOT including
00069 ** the NUL, or (JSUint32)-1 if an error occurs.
00070 */
00071 extern JS_PUBLIC_API(JSUint32) JS_snprintf(char *out, JSUint32 outlen, const char *fmt, ...);
00072 
00073 /*
00074 ** sprintf into a malloc'd buffer. Return a pointer to the malloc'd
00075 ** buffer on success, NULL on failure. Call "JS_smprintf_free" to release
00076 ** the memory returned.
00077 */
00078 extern JS_PUBLIC_API(char*) JS_smprintf(const char *fmt, ...);
00079 
00080 /*
00081 ** Free the memory allocated, for the caller, by JS_smprintf
00082 */
00083 extern JS_PUBLIC_API(void) JS_smprintf_free(char *mem);
00084 
00085 /*
00086 ** "append" sprintf into a malloc'd buffer. "last" is the last value of
00087 ** the malloc'd buffer. sprintf will append data to the end of last,
00088 ** growing it as necessary using realloc. If last is NULL, JS_sprintf_append
00089 ** will allocate the initial string. The return value is the new value of
00090 ** last for subsequent calls, or NULL if there is a malloc failure.
00091 */
00092 extern JS_PUBLIC_API(char*) JS_sprintf_append(char *last, const char *fmt, ...);
00093 
00094 /*
00095 ** sprintf into a function. The function "f" is called with a string to
00096 ** place into the output. "arg" is an opaque pointer used by the stuff
00097 ** function to hold any state needed to do the storage of the output
00098 ** data. The return value is a count of the number of characters fed to
00099 ** the stuff function, or (JSUint32)-1 if an error occurs.
00100 */
00101 typedef JSIntn (*JSStuffFunc)(void *arg, const char *s, JSUint32 slen);
00102 
00103 extern JS_PUBLIC_API(JSUint32) JS_sxprintf(JSStuffFunc f, void *arg, const char *fmt, ...);
00104 
00105 /*
00106 ** va_list forms of the above.
00107 */
00108 extern JS_PUBLIC_API(JSUint32) JS_vsnprintf(char *out, JSUint32 outlen, const char *fmt, va_list ap);
00109 extern JS_PUBLIC_API(char*) JS_vsmprintf(const char *fmt, va_list ap);
00110 extern JS_PUBLIC_API(char*) JS_vsprintf_append(char *last, const char *fmt, va_list ap);
00111 extern JS_PUBLIC_API(JSUint32) JS_vsxprintf(JSStuffFunc f, void *arg, const char *fmt, va_list ap);
00112 
00113 /*
00114 ***************************************************************************
00115 ** FUNCTION: JS_sscanf
00116 ** DESCRIPTION:
00117 **     JS_sscanf() scans the input character string, performs data
00118 **     conversions, and stores the converted values in the data objects
00119 **     pointed to by its arguments according to the format control
00120 **     string.
00121 **
00122 **     JS_sscanf() behaves the same way as the sscanf() function in the
00123 **     Standard C Library (stdio.h), with the following exceptions:
00124 **     - JS_sscanf() handles the NSPR integer and floating point types,
00125 **       such as JSInt16, JSInt32, JSInt64, and JSFloat64, whereas
00126 **       sscanf() handles the standard C types like short, int, long,
00127 **       and double.
00128 **     - JS_sscanf() has no multibyte character support, while sscanf()
00129 **       does.
00130 ** INPUTS:
00131 **     const char *buf
00132 **         a character string holding the input to scan
00133 **     const char *fmt
00134 **         the format control string for the conversions
00135 **     ...
00136 **         variable number of arguments, each of them is a pointer to
00137 **         a data object in which the converted value will be stored
00138 ** OUTPUTS: none
00139 ** RETURNS: JSInt32
00140 **     The number of values converted and stored.
00141 ** RESTRICTIONS:
00142 **    Multibyte characters in 'buf' or 'fmt' are not allowed.
00143 ***************************************************************************
00144 */
00145 
00146 extern JS_PUBLIC_API(JSInt32) JS_sscanf(const char *buf, const char *fmt, ...);
00147 
00148 JS_END_EXTERN_C
00149 
00150 #endif /* jsprf_h___ */