xpcom/string/public/nsTDependentString.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla.
  17  *
  18  * The Initial Developer of the Original Code is IBM Corporation.
  19  * Portions created by IBM Corporation are Copyright (C) 2003
  20  * IBM Corporation. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Scott Collins <scc@mozilla.org> (original author)
  24  *   Darin Fisher <darin@meer.net>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40
  41   /**
  42    * nsTDependentString_CharT
  43    *
  44    * Stores a null-terminated, immutable sequence of characters.
  45    *
  46    * Subclass of nsTString that restricts string value to an immutable
  47    * character sequence.  This class does not own its data, so the creator
  48    * of objects of this type must take care to ensure that a
  49    * nsTDependentString continues to reference valid memory for the
  50    * duration of its use.
  51    */
  52 class nsTDependentString_CharT : public nsTString_CharT
  53   {
  54     public:
  55
  56       typedef nsTDependentString_CharT    self_type;
  57
  58     public:
  59
  60         /**
  61          * verify restrictions
  62          */
  63       void AssertValid()
  64         {
  65           NS_ASSERTION(mData, "nsTDependentString must wrap a non-NULL buffer");
  66           NS_ASSERTION(mLength != size_type(-1), "nsTDependentString has bogus length");
  67           NS_ASSERTION(mData[mLength] == 0, "nsTDependentString must wrap only null-terminated strings");
  68         }
  69
  70
  71         /**
  72          * constructors
  73          */
  74
  75       nsTDependentString_CharT( const char_type* start, const char_type* end )
  76         : string_type(const_cast<char_type*>(start), PRUint32(end - start), F_TERMINATED)
  77         {
  78           AssertValid();
  79         }
  80
  81       nsTDependentString_CharT( const char_type* data, PRUint32 length )
  82         : string_type(const_cast<char_type*>(data), length, F_TERMINATED)
  83         {
  84           AssertValid();
  85         }
  86
  87       explicit
  88       nsTDependentString_CharT( const char_type* data )
  89         : string_type(const_cast<char_type*>(data), PRUint32(char_traits::length(data)), F_TERMINATED)
  90         {
  91           AssertValid();
  92         }
  93
  94       explicit
  95       nsTDependentString_CharT( const substring_type& str )
  96         : string_type(const_cast<char_type*>(str.Data()), str.Length(), F_TERMINATED)
  97         {
  98           AssertValid();
  99         }
 100
 101       // Create a nsTDependentSubstring to be bound later
 102       nsTDependentString_CharT()
 103         : string_type() {}
 104
 105       // XXX are you sure??
 106       // auto-generated copy-constructor OK
 107       // auto-generated copy-assignment operator OK
 108       // auto-generated destructor OK
 109
 110
 111         /**
 112          * allow this class to be bound to a different string...
 113          */
 114
 115       void Rebind( const char_type* data )
 116         {
 117           Rebind(data, PRUint32(char_traits::length(data)));
 118         }
 119
 120       NS_COM void Rebind( const char_type* data, size_type length );
 121
 122       void Rebind( const char_type* start, const char_type* end )
 123         {
 124           Rebind(start, PRUint32(end - start));
 125         }
 126
 127     private:
 128
 129       // NOT USED
 130       nsTDependentString_CharT( const substring_tuple_type& );
 131   };