LCOV - code coverage report
Current view: directory - objdir/dist/include - nsPrintfCString.h (source / functions) Found Hit Coverage
Test: app.info Lines: 1 1 100.0 %
Date: 2012-06-02 Functions: 1 1 100.0 %

       1                 : /* -*- Mode: C++; tab-width: 2; 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) 1994-2000
      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 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 nsPrintfCString : public nsCString
      71           18864 :   {
      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___)

Generated by: LCOV version 1.7