PageRenderTime 7ms CodeModel.GetById 1ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 0ms

/gecko_api/include/nsTextFormatter.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 111 lines | 22 code | 13 blank | 76 comment | 0 complexity | 4834ac24b66bcb5451dd6fc9767f2fb6 MD5 | raw file
  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 *      Prasad <prasad@medhas.org>
 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/*
 40 * This code was copied from xpcom/ds/nsTextFormatter r1.3
 41 *           Memory model and Frozen linkage changes only.
 42 *                           -- Prasad <prasad@medhas.org>
 43 */
 44
 45#ifndef nsTextFormatter_h___
 46#define nsTextFormatter_h___
 47
 48/*
 49 ** API for PR printf like routines. Supports the following formats
 50 **	%d - decimal
 51 **	%u - unsigned decimal
 52 **	%x - unsigned hex
 53 **	%X - unsigned uppercase hex
 54 **	%o - unsigned octal
 55 **	%hd, %hu, %hx, %hX, %ho - 16-bit versions of above
 56 **	%ld, %lu, %lx, %lX, %lo - 32-bit versions of above
 57 **	%lld, %llu, %llx, %llX, %llo - 64 bit versions of above
 58 **	%s - utf8 string
 59 **	%S - PRUnichar string
 60 **	%c - character
 61 **	%p - pointer (deals with machine dependent pointer size)
 62 **	%f - float
 63 **	%g - float
 64 */
 65#include "prtypes.h"
 66#include "prio.h"
 67#include <stdio.h>
 68#include <stdarg.h>
 69#include "nscore.h"
 70#include "nsStringGlue.h"
 71
 72#ifdef XPCOM_GLUE
 73#error "nsTextFormatter is not available in the standalone glue due to NSPR dependencies."
 74#endif
 75
 76class NS_COM_GLUE nsTextFormatter {
 77
 78  public:
 79
 80    /*
 81     * sprintf into a fixed size buffer. Guarantees that a NULL is at the end
 82     * of the buffer. Returns the length of the written output, NOT including
 83     * the NUL, or (PRUint32)-1 if an error occurs.
 84     */
 85    static PRUint32 snprintf(PRUnichar *out, PRUint32 outlen, const PRUnichar *fmt, ...);
 86
 87    /*
 88     * sprintf into a nsMemory::Alloc'd buffer. Return a pointer to 
 89     * buffer on success, NULL on failure. 
 90     */
 91    static PRUnichar* smprintf(const PRUnichar *fmt, ...);
 92
 93    static PRUint32 ssprintf(nsAString& out, const PRUnichar* fmt, ...);
 94
 95    /*
 96     * va_list forms of the above.
 97     */
 98    static PRUint32 vsnprintf(PRUnichar *out, PRUint32 outlen, const PRUnichar *fmt, va_list ap);
 99    static PRUnichar* vsmprintf(const PRUnichar *fmt, va_list ap);
100    static PRUint32 vssprintf(nsAString& out, const PRUnichar *fmt, va_list ap);
101
102    /*
103     * Free the memory allocated, for the caller, by smprintf.
104     * -- Deprecated --
105     * Callers can substitute calling smprintf_free with nsMemory::Free
106     */
107    static void smprintf_free(PRUnichar *mem);
108
109};
110
111#endif /* nsTextFormatter_h___ */