Annotation of sbbs/include/mozilla/js/jsprf.h, revision 1.1.1.1

1.1       root        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: ** %c - character
                     54: ** %p - pointer (deals with machine dependent pointer size)
                     55: ** %f - float
                     56: ** %g - float
                     57: */
                     58: #include "jstypes.h"
                     59: #include <stdio.h>
                     60: #include <stdarg.h>
                     61: 
                     62: JS_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 (JSUint32)-1 if an error occurs.
                     68: */
                     69: extern JS_PUBLIC_API(JSUint32) JS_snprintf(char *out, JSUint32 outlen, const char *fmt, ...);
                     70: 
                     71: /*
                     72: ** sprintf into a malloc'd buffer. Return a pointer to the malloc'd
                     73: ** buffer on success, NULL on failure. Call "JS_smprintf_free" to release
                     74: ** the memory returned.
                     75: */
                     76: extern JS_PUBLIC_API(char*) JS_smprintf(const char *fmt, ...);
                     77: 
                     78: /*
                     79: ** Free the memory allocated, for the caller, by JS_smprintf
                     80: */
                     81: extern JS_PUBLIC_API(void) JS_smprintf_free(char *mem);
                     82: 
                     83: /*
                     84: ** "append" sprintf into a malloc'd buffer. "last" is the last value of
                     85: ** the malloc'd buffer. sprintf will append data to the end of last,
                     86: ** growing it as necessary using realloc. If last is NULL, JS_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: extern JS_PUBLIC_API(char*) JS_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 (JSUint32)-1 if an error occurs.
                     98: */
                     99: typedef JSIntn (*JSStuffFunc)(void *arg, const char *s, JSUint32 slen);
                    100: 
                    101: extern JS_PUBLIC_API(JSUint32) JS_sxprintf(JSStuffFunc f, void *arg, const char *fmt, ...);
                    102: 
                    103: /*
                    104: ** va_list forms of the above.
                    105: */
                    106: extern JS_PUBLIC_API(JSUint32) JS_vsnprintf(char *out, JSUint32 outlen, const char *fmt, va_list ap);
                    107: extern JS_PUBLIC_API(char*) JS_vsmprintf(const char *fmt, va_list ap);
                    108: extern JS_PUBLIC_API(char*) JS_vsprintf_append(char *last, const char *fmt, va_list ap);
                    109: extern JS_PUBLIC_API(JSUint32) JS_vsxprintf(JSStuffFunc f, void *arg, const char *fmt, va_list ap);
                    110: 
                    111: /*
                    112: ***************************************************************************
                    113: ** FUNCTION: JS_sscanf
                    114: ** DESCRIPTION:
                    115: **     JS_sscanf() scans the input character string, performs data
                    116: **     conversions, and stores the converted values in the data objects
                    117: **     pointed to by its arguments according to the format control
                    118: **     string.
                    119: **
                    120: **     JS_sscanf() behaves the same way as the sscanf() function in the
                    121: **     Standard C Library (stdio.h), with the following exceptions:
                    122: **     - JS_sscanf() handles the NSPR integer and floating point types,
                    123: **       such as JSInt16, JSInt32, JSInt64, and JSFloat64, whereas
                    124: **       sscanf() handles the standard C types like short, int, long,
                    125: **       and double.
                    126: **     - JS_sscanf() has no multibyte character support, while sscanf()
                    127: **       does.
                    128: ** INPUTS:
                    129: **     const char *buf
                    130: **         a character string holding the input to scan
                    131: **     const char *fmt
                    132: **         the format control string for the conversions
                    133: **     ...
                    134: **         variable number of arguments, each of them is a pointer to
                    135: **         a data object in which the converted value will be stored
                    136: ** OUTPUTS: none
                    137: ** RETURNS: JSInt32
                    138: **     The number of values converted and stored.
                    139: ** RESTRICTIONS:
                    140: **    Multibyte characters in 'buf' or 'fmt' are not allowed.
                    141: ***************************************************************************
                    142: */
                    143: 
                    144: extern JS_PUBLIC_API(JSInt32) JS_sscanf(const char *buf, const char *fmt, ...);
                    145: 
                    146: JS_END_EXTERN_C
                    147: 
                    148: #endif /* jsprf_h___ */

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.