| 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.org Code.
|
|---|
| 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
|
|---|
| 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 of the GNU General Public License Version 2 or later (the "GPL"),
|
|---|
| 26 | * or 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 nsTextFormatter_h___
|
|---|
| 39 | #define nsTextFormatter_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 - utf8 string
|
|---|
| 52 | ** %S - PRUnichar string
|
|---|
| 53 | ** %c - character
|
|---|
| 54 | ** %p - pointer (deals with machine dependent pointer size)
|
|---|
| 55 | ** %f - float
|
|---|
| 56 | ** %g - float
|
|---|
| 57 | */
|
|---|
| 58 | #include "prtypes.h"
|
|---|
| 59 | #include "prio.h"
|
|---|
| 60 | #include <stdio.h>
|
|---|
| 61 | #include <stdarg.h>
|
|---|
| 62 | #include "nscore.h"
|
|---|
| 63 | #include "nsAString.h"
|
|---|
| 64 |
|
|---|
| 65 |
|
|---|
| 66 | class NS_COM nsTextFormatter {
|
|---|
| 67 |
|
|---|
| 68 | public:
|
|---|
| 69 |
|
|---|
| 70 | /*
|
|---|
| 71 | ** sprintf into a fixed size buffer. Guarantees that a NUL is at the end
|
|---|
| 72 | ** of the buffer. Returns the length of the written output, NOT including
|
|---|
| 73 | ** the NUL, or (PRUint32)-1 if an error occurs.
|
|---|
| 74 | */
|
|---|
| 75 | static PRUint32 snprintf(PRUnichar *out, PRUint32 outlen, const PRUnichar *fmt, ...);
|
|---|
| 76 |
|
|---|
| 77 | /*
|
|---|
| 78 | ** sprintf into a PR_MALLOC'd buffer. Return a pointer to the malloc'd
|
|---|
| 79 | ** buffer on success, NULL on failure. Call "smprintf_free" to release
|
|---|
| 80 | ** the memory returned.
|
|---|
| 81 | */
|
|---|
| 82 | static PRUnichar* smprintf(const PRUnichar *fmt, ...);
|
|---|
| 83 |
|
|---|
| 84 |
|
|---|
| 85 | static PRUint32 ssprintf(nsAString& out, const PRUnichar* fmt, ...);
|
|---|
| 86 | /*
|
|---|
| 87 | ** Free the memory allocated, for the caller, by smprintf
|
|---|
| 88 | */
|
|---|
| 89 | static void smprintf_free(PRUnichar *mem);
|
|---|
| 90 |
|
|---|
| 91 | /*
|
|---|
| 92 | ** "append" sprintf into a PR_MALLOC'd buffer. "last" is the last value of
|
|---|
| 93 | ** the PR_MALLOC'd buffer. sprintf will append data to the end of last,
|
|---|
| 94 | ** growing it as necessary using realloc. If last is NULL, PR_sprintf_append
|
|---|
| 95 | ** will allocate the initial string. The return value is the new value of
|
|---|
| 96 | ** last for subsequent calls, or NULL if there is a malloc failure.
|
|---|
| 97 | */
|
|---|
| 98 | static PRUnichar* sprintf_append(PRUnichar *last, const PRUnichar *fmt, ...);
|
|---|
| 99 |
|
|---|
| 100 | /*
|
|---|
| 101 | ** va_list forms of the above.
|
|---|
| 102 | */
|
|---|
| 103 | static PRUint32 vsnprintf(PRUnichar *out, PRUint32 outlen, const PRUnichar *fmt, va_list ap);
|
|---|
| 104 | static PRUnichar* vsmprintf(const PRUnichar *fmt, va_list ap);
|
|---|
| 105 | static PRUint32 vssprintf(nsAString& out, const PRUnichar *fmt, va_list ap);
|
|---|
| 106 | static PRUnichar* vsprintf_append(PRUnichar *last, const PRUnichar *fmt, va_list ap);
|
|---|
| 107 |
|
|---|
| 108 | #ifdef DEBUG
|
|---|
| 109 | static PRBool SelfTest();
|
|---|
| 110 | #endif
|
|---|
| 111 |
|
|---|
| 112 |
|
|---|
| 113 | };
|
|---|
| 114 |
|
|---|
| 115 | #endif /* nsTextFormatter_h___ */
|
|---|
