Files
sousa-gecko/xpcom/string/nsStringFlags.h
T
Emilio Cobos Álvarez fe182cca64 Bug 2025271 - Simplify DOMString. r=smaug,nika,extension-reviewers,core-sessionstore-reviewers,dom-worker-reviewers,robwu,asuth
Make DOMString a regular nsAutoTString with some special methods for
performance in some hot getters. For that, we need to change a bit
nsTString:

 * Support for unowned buffers: Owned buffers now are represented by
   STRINGBUFFER|OWNED flags, rather than REFCOUNTED.

 * Inlining of the destructor: It showed up in profiles, it's also just
   a few instructions, so probably worth it. We could OOL the owned path
   I guess, if we wanted to.

 * Inlinling and reordering of NonVoidStringToJsval. Old code had
   special DOMString path inline with [buffer, literal, copy] paths,
   then out of line code with [literal, buffer, copy]. Instead,
   consolidate everything in a [buffer, literal, copy] inline path.
   Do the same for UTF8/Latin1 strings too for consistency.

Differential Revision: https://phabricator.services.mozilla.com/D288148
2026-04-13 09:33:54 +00:00

104 lines
3.9 KiB
C++

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsStringFlags_h
#define nsStringFlags_h
#include <stdint.h>
#include "mozilla/TypedEnumBits.h"
namespace mozilla {
namespace detail {
// NOTE: these flags are declared public _only_ for convenience inside
// the string implementation. And they are outside of the string
// class so that the type is the same for both narrow and wide
// strings.
// bits for mDataFlags
enum class StringDataFlags : uint16_t {
// Some terminology:
//
// "dependent buffer" A dependent buffer is one that the string class
// does not own. The string class relies on some
// external code to ensure the lifetime of the
// dependent buffer.
//
// "refcounted buffer" A refcounted buffer is one that the string class
// allocates. When it allocates a refcounted string
// buffer, it allocates some additional space at
// the beginning of the buffer for additional
// fields, including a reference count and a
// buffer length. See mozilla::StringBuffer.
//
// "adopted buffer" An adopted buffer is a raw string buffer
// allocated on the heap (using moz_xmalloc)
// of which the string class subsumes ownership.
//
// Some comments about the string data flags:
//
// The allocation type of mData is determined as follows:
// * LITERAL: Points to a static string.
// * INLINE: Points to our inline buffer, exclusive with other flags in
// this list.
// * STRINGBUFFER: Points to a (potentially dependent) StringBuffer.
// * OWNED: Points to heap-allocated data, or to an StringBuffer that we
// keep alive (depending on whether STRINGBUFFER) is set.
//
// If none of these flags are set, then the data pointer is dependent and
// pointing to unknown data (it can also be dependent and pointing to a
// STRINGBUFFER).
//
// STRINGBUFFER, OWNED, or INLINE imply TERMINATED. This is because
// the string classes always allocate null-terminated buffers, and
// non-terminated substrings are always dependent.
//
// VOIDED implies TERMINATED, and moreover it implies that mData
// points to char_traits::sEmptyBuffer. Therefore, VOIDED is
// mutually exclusive with STRINGBUFFER, OWNED, and INLINE.
//
// INLINE requires StringClassFlags::INLINE to be set on the type.
// IsTerminated returns true
TERMINATED = 1 << 0,
// IsVoid returns true
VOIDED = 1 << 1,
// mData points to a heap-allocated, shareable StringBuffer. The buffer is
// only owned iff OWNED is also set.
STRINGBUFFER = 1 << 2,
// mData points either to a heap-allocated, raw buffer, or to an owned
// StringBuffer, iff STRINGBUFFER is also set.
OWNED = 1 << 3,
// mData points to a writable, inline buffer
INLINE = 1 << 4,
// mData points to a string literal; DataFlags::TERMINATED will also be set
LITERAL = 1 << 5,
// used to check for invalid flags -- all bits above the last item
INVALID_MASK = (uint16_t)~((LITERAL << 1) - 1)
};
// bits for mClassFlags
enum class StringClassFlags : uint16_t {
// |this|'s buffer is inline, and requires the type to be binary-compatible
// with nsTAutoStringN
INLINE = 1 << 0,
// |this| requires its buffer is null-terminated
NULL_TERMINATED = 1 << 1,
// used to check for invalid flags -- all bits above the last item
INVALID_MASK = (uint16_t)~((NULL_TERMINATED << 1) - 1)
};
MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS(StringDataFlags)
MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS(StringClassFlags)
} // namespace detail
} // namespace mozilla
#endif