widget/public/nsStringUtil.h

   1 /* -*- Mode: c++; tab-width: 2; indent-tabs-mode: nil; -*- */
   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 the GNU General Public License Version 2 or later (the "GPL"), or
  26  * 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 // Convience macros for converting nsString's to chars +
  39 // creating temporary char[] bufs.
  40
  41 #ifndef NS_STR_UTIL_H
  42 #define NS_STR_UTIL_H
  43
  44 // temporary char[] macro
  45
  46 // Convience MACROS which use a static char array if possible to reduce
  47 // memory fragmentation, otherwise they allocate a char[] which must be
  48 // freed.  REMEMBER to always use the NS_FREE_CHAR_BUF after using the
  49 // NS_ALLOC_CHAR_BUF. You can not nest NS_ALLOC_CHAR_BUF's.
  50
  51 #define NS_ALLOC_CHAR_BUF(aBuf, aSize, aActualSize) \
  52   int _ns_tmpActualSize = aActualSize;              \
  53   char _ns_smallBuffer[aSize];                      \
  54   char * const aBuf = _ns_tmpActualSize <= aSize ? _ns_smallBuffer : new char[_ns_tmpActualSize];
  55
  56 #define NS_FREE_CHAR_BUF(aBuf)   \
  57   if (aBuf != _ns_smallBuffer) \
  58    delete[] aBuf;
  59
  60 #endif // !defined(NS_STR_UTIL_H)