xpcom/string/nsTDependentSubstring.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6 // IWYU pragma: private, include "nsString.h"
   7
   8 /**
   9  * nsTDependentSubstring_CharT
  10  *
  11  * A string class which wraps an external array of string characters. It
  12  * is the client code's responsibility to ensure that the external buffer
  13  * remains valid for a long as the string is alive.
  14  *
  15  * NAMES:
  16  *   nsDependentSubstring for wide characters
  17  *   nsDependentCSubstring for narrow characters
  18  */
  19 class nsTDependentSubstring_CharT : public nsTSubstring_CharT
  20 {
  21 public:
  22
  23   typedef nsTDependentSubstring_CharT self_type;
  24
  25 public:
  26
  27   void Rebind(const substring_type&, uint32_t aStartPos,
  28               uint32_t aLength = size_type(-1));
  29
  30   void Rebind(const char_type* aData, size_type aLength);
  31
  32   void Rebind(const char_type* aStart, const char_type* aEnd)
  33   {
  34     Rebind(aStart, size_type(aEnd - aStart));
  35   }
  36
  37   nsTDependentSubstring_CharT(const substring_type& aStr, uint32_t aStartPos,
  38                               uint32_t aLength = size_type(-1))
  39     : substring_type()
  40   {
  41     Rebind(aStr, aStartPos, aLength);
  42   }
  43
  44   nsTDependentSubstring_CharT(const char_type* aData, size_type aLength)
  45     : substring_type(const_cast<char_type*>(aData), aLength, F_NONE)
  46   {
  47   }
  48
  49   nsTDependentSubstring_CharT(const char_type* aStart, const char_type* aEnd)
  50     : substring_type(const_cast<char_type*>(aStart), uint32_t(aEnd - aStart),
  51                      F_NONE)
  52   {
  53   }
  54
  55 #if defined(CharT_is_PRUnichar) && defined(MOZ_USE_CHAR16_WRAPPER)
  56   nsTDependentSubstring_CharT(char16ptr_t aData, size_type aLength)
  57     : nsTDependentSubstring_CharT(static_cast<const char16_t*>(aData), aLength)
  58   {
  59   }
  60
  61   nsTDependentSubstring_CharT(char16ptr_t aStart, char16ptr_t aEnd)
  62     : nsTDependentSubstring_CharT(static_cast<const char16_t*>(aStart),
  63                                   static_cast<const char16_t*>(aEnd))
  64   {
  65   }
  66 #endif
  67
  68   nsTDependentSubstring_CharT(const const_iterator& aStart,
  69                               const const_iterator& aEnd)
  70     : substring_type(const_cast<char_type*>(aStart.get()),
  71                      uint32_t(aEnd.get() - aStart.get()), F_NONE)
  72   {
  73   }
  74
  75   // Create a nsTDependentSubstring to be bound later
  76   nsTDependentSubstring_CharT()
  77     : substring_type()
  78   {
  79   }
  80
  81   // auto-generated copy-constructor OK (XXX really?? what about base class copy-ctor?)
  82
  83 private:
  84   // NOT USED
  85   void operator=(const self_type&);  // we're immutable, you can't assign into a substring
  86 };
  87
  88 inline const nsTDependentSubstring_CharT
  89 Substring(const nsTSubstring_CharT& aStr, uint32_t aStartPos,
  90           uint32_t aLength = uint32_t(-1))
  91 {
  92   return nsTDependentSubstring_CharT(aStr, aStartPos, aLength);
  93 }
  94
  95 inline const nsTDependentSubstring_CharT
  96 Substring(const nsReadingIterator<CharT>& aStart,
  97           const nsReadingIterator<CharT>& aEnd)
  98 {
  99   return nsTDependentSubstring_CharT(aStart.get(), aEnd.get());
 100 }
 101
 102 inline const nsTDependentSubstring_CharT
 103 Substring(const CharT* aData, uint32_t aLength)
 104 {
 105   return nsTDependentSubstring_CharT(aData, aLength);
 106 }
 107
 108 inline const nsTDependentSubstring_CharT
 109 Substring(const CharT* aStart, const CharT* aEnd)
 110 {
 111   return nsTDependentSubstring_CharT(aStart, aEnd);
 112 }
 113
 114 inline const nsTDependentSubstring_CharT
 115 StringHead(const nsTSubstring_CharT& aStr, uint32_t aCount)
 116 {
 117   return nsTDependentSubstring_CharT(aStr, 0, aCount);
 118 }
 119
 120 inline const nsTDependentSubstring_CharT
 121 StringTail(const nsTSubstring_CharT& aStr, uint32_t aCount)
 122 {
 123   return nsTDependentSubstring_CharT(aStr, aStr.Length() - aCount, aCount);
 124 }