← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/xpcom/string/public/nsPrintfCString.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/xpcom/string/public/nsPrintfCString.h
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* 
 
3
 * The contents of this file are subject to the Mozilla Public
 
4
 * License Version 1.1 (the "License"); you may not use this file
 
5
 * except in compliance with the License. You may obtain a copy of
 
6
 * the License at http://www.mozilla.org/MPL/
 
7
 * 
 
8
 * Software distributed under the License is distributed on an "AS
 
9
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 
10
 * implied. See the License for the specific language governing
 
11
 * rights and limitations under the License.
 
12
 * 
 
13
 * The Original Code is mozilla.org code.
 
14
 * 
 
15
 * The Initial Developer of the Original Code is Netscape
 
16
 * Communications Corporation.  Portions created by Netscape are 
 
17
 * Copyright (C) 1994-2000 Netscape Communications Corporation.  All
 
18
 * Rights Reserved.
 
19
 * 
 
20
 * Original Author:
 
21
 *   Scott Collins <scc@mozilla.org>
 
22
 *
 
23
 * Contributor(s):
 
24
 * 
 
25
 * Alternatively, the contents of this file may be used under the
 
26
 * terms of the GNU General Public License Version 2 or later (the
 
27
 * "GPL"), in which case the provisions of the GPL are applicable 
 
28
 * instead of those above.  If you wish to allow use of your 
 
29
 * version of this file only under the terms of the GPL and not to
 
30
 * allow others to use your version of this file under the MPL,
 
31
 * indicate your decision by deleting the provisions above and
 
32
 * replace them with the notice and other provisions required by
 
33
 * the GPL.  If you do not delete the provisions above, a recipient
 
34
 * may use your version of this file under either the MPL or the
 
35
 * GPL.
 
36
 */
 
37
 
 
38
#ifndef nsPrintfCString_h___
 
39
#define nsPrintfCString_h___
 
40
 
 
41
#ifndef nsString_h___
 
42
#include "nsString.h"
 
43
#endif
 
44
 
 
45
 
 
46
  /**
 
47
   * |nsPrintfCString| lets you use a formated |printf| string as an |const nsACString|.
 
48
   *
 
49
   *   myCStr += nsPrintfCString("%f", 13.917);
 
50
   *     // ...a general purpose substitute for |AppendFloat|
 
51
   *
 
52
   * For longer patterns, you'll want to use the constructor that takes a length
 
53
   *
 
54
   *   nsPrintfCString(128, "%f, %f, %f, %f, %f, %f, %f, %i, %f", x, y, z, 3.2, j, k, l, 3, 3.1);
 
55
   *
 
56
   * Exceding the default size (which you must specify in the constructor, it is not determined)
 
57
   * causes an allocation, so avoid that.  If your formatted string exceeds the allocated space, it is
 
58
   * cut off at the size of the buffer, no error is reported (and no out-of-bounds writing occurs).
 
59
   * This class is intended to be useful for numbers and short
 
60
   * strings, not arbitrary formatting of other strings (e.g., with %s).  There is currently no
 
61
   * wide version of this class, since wide |printf| is not generally available.  That means
 
62
   * to get a wide version of your formatted data, you must, e.g.,
 
63
   *
 
64
   *   CopyASCIItoUTF16(nsPrintfCString("%f", 13.917"), myStr);
 
65
   *
 
66
   * That's another good reason to avoid this class for anything but numbers ... as strings can be
 
67
   * much more efficiently handled with |NS_LITERAL_[C]STRING| and |nsLiteral[C]String|.
 
68
   */
 
69
 
 
70
class NS_COM nsPrintfCString : public nsCString
 
71
  {
 
72
    typedef nsCString string_type;
 
73
 
 
74
    enum { kLocalBufferSize=15 };
 
75
      // ought to be large enough for most things ... a |long long| needs at most 20 (so you'd better ask)
 
76
      //  pinkerton suggests 7.  We should measure and decide what's appropriate
 
77
 
 
78
    public:
 
79
      // XXX don't these need to be declared CDECL ??
 
80
      explicit nsPrintfCString( const char_type* format, ... );
 
81
      nsPrintfCString( size_type n, const char_type* format, ...);
 
82
 
 
83
    private:
 
84
      char_type  mLocalBuffer[ kLocalBufferSize + 1 ];
 
85
  };
 
86
 
 
87
#endif // !defined(nsPrintfCString_h___)