Bug Summary

File:var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/ipc/ByteBuf.h
Warning:line 61, column 16
Attempt to free released memory

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name nsIconChannel.cpp -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -fhalf-no-semantic-interposition -mframe-pointer=all -relaxed-aliasing -ffp-contract=off -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fdebug-compilation-dir=/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/image/decoders/icon/gtk -fcoverage-compilation-dir=/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/image/decoders/icon/gtk -resource-dir /usr/lib/llvm-18/lib/clang/18 -include /var/lib/jenkins/workspace/firefox-scan-build/config/gcc_hidden.h -include /var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/mozilla-config.h -I /var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/stl_wrappers -I /var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/system_wrappers -U _FORTIFY_SOURCE -D _FORTIFY_SOURCE=2 -D DEBUG=1 -D MOZ_HAS_MOZGLUE -D MOZILLA_INTERNAL_API -D IMPL_LIBXUL -D STATIC_EXPORTABLE_JS_API -I /var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk -I /var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/image/decoders/icon/gtk -I /var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/ipc/ipdl/_ipdlheaders -I /var/lib/jenkins/workspace/firefox-scan-build/ipc/chromium/src -I /var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include -I /var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nspr -I /var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nss -D MOZILLA_CLIENT -I /usr/include/gtk-3.0 -I /usr/include/pango-1.0 -I /usr/include/glib-2.0 -I /usr/lib/x86_64-linux-gnu/glib-2.0/include -I /usr/include/harfbuzz -I /usr/include/freetype2 -I /usr/include/libpng16 -I /usr/include/libmount -I /usr/include/blkid -I /usr/include/fribidi -I /usr/include/cairo -I /usr/include/pixman-1 -I /usr/include/gdk-pixbuf-2.0 -I /usr/include/x86_64-linux-gnu -I /usr/include/webp -I /usr/include/gio-unix-2.0 -I /usr/include/cloudproviders -I /usr/include/atk-1.0 -I /usr/include/at-spi2-atk/2.0 -I /usr/include/at-spi-2.0 -I /usr/include/dbus-1.0 -I /usr/lib/x86_64-linux-gnu/dbus-1.0/include -I /usr/include/gtk-3.0/unix-print -internal-isystem /usr/bin/../lib/gcc/x86_64-linux-gnu/13/../../../../include/c++/13 -internal-isystem /usr/bin/../lib/gcc/x86_64-linux-gnu/13/../../../../include/x86_64-linux-gnu/c++/13 -internal-isystem /usr/bin/../lib/gcc/x86_64-linux-gnu/13/../../../../include/c++/13/backward -internal-isystem /usr/lib/llvm-18/lib/clang/18/include -internal-isystem /usr/local/include -internal-isystem /usr/bin/../lib/gcc/x86_64-linux-gnu/13/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-error=tautological-type-limit-compare -Wno-invalid-offsetof -Wno-range-loop-analysis -Wno-deprecated-anon-enum-enum-conversion -Wno-deprecated-enum-enum-conversion -Wno-deprecated-this-capture -Wno-inline-new-delete -Wno-error=deprecated-declarations -Wno-error=array-bounds -Wno-error=free-nonheap-object -Wno-error=atomic-alignment -Wno-error=deprecated-builtins -Wno-psabi -Wno-error=builtin-macro-redefined -Wno-vla-cxx-extension -Wno-unknown-warning-option -fdeprecated-macro -ferror-limit 19 -stack-protector 2 -fstack-clash-protection -ftrivial-auto-var-init=pattern -fno-rtti -fgnuc-version=4.2.1 -fno-aligned-allocation -vectorize-loops -vectorize-slp -analyzer-checker optin.performance.Padding -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2024-05-16-034744-15991-1 -x c++ /var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp

/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp

1/* vim:set ts=2 sw=2 sts=2 cin et: */
2/* This Source Code Form is subject to the terms of the Mozilla Public
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5
6#include "nsIconChannel.h"
7
8#include <stdlib.h>
9#include <unistd.h>
10
11#include "mozilla/DebugOnly.h"
12#include "mozilla/EndianUtils.h"
13#include "mozilla/NullPrincipal.h"
14#include "mozilla/CheckedInt.h"
15#include "mozilla/dom/ContentChild.h"
16#include "mozilla/gfx/Swizzle.h"
17#include "mozilla/ipc/ByteBuf.h"
18#include <algorithm>
19
20#include <gio/gio.h>
21
22#include <gtk/gtk.h>
23
24#include "nsMimeTypes.h"
25#include "nsIMIMEService.h"
26
27#include "nsServiceManagerUtils.h"
28
29#include "nsNetUtil.h"
30#include "nsComponentManagerUtils.h"
31#include "nsIStringStream.h"
32#include "nsServiceManagerUtils.h"
33#include "nsIURL.h"
34#include "nsIPipe.h"
35#include "nsIAsyncInputStream.h"
36#include "nsIAsyncOutputStream.h"
37#include "prlink.h"
38#include "gfxPlatform.h"
39
40using mozilla::CheckedInt32;
41using mozilla::ipc::ByteBuf;
42
43NS_IMPL_ISUPPORTS(nsIconChannel, nsIRequest, nsIChannel)MozExternalRefCountType nsIconChannel::AddRef(void) { static_assert
(!std::is_destructible_v<nsIconChannel>, "Reference-counted class "
"nsIconChannel" " should not have a public destructor. " "Make this class's destructor non-public"
); do { static_assert( mozilla::detail::AssertionConditionType
<decltype(int32_t(mRefCnt) >= 0)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(int32_t(mRefCnt) >= 0))),
0))) { do { } while (false); MOZ_ReportAssertionFailure("int32_t(mRefCnt) >= 0"
" (" "illegal refcnt" ")", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 43); AnnotateMozCrashReason("MOZ_ASSERT" "(" "int32_t(mRefCnt) >= 0"
") (" "illegal refcnt" ")"); do { *((volatile int*)__null) =
43; __attribute__((nomerge)) ::abort(); } while (false); } }
while (false); do { static_assert( mozilla::detail::AssertionConditionType
<decltype("nsIconChannel" != nullptr)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!("nsIconChannel" != nullptr))
), 0))) { do { } while (false); MOZ_ReportAssertionFailure("\"nsIconChannel\" != nullptr"
" (" "Must specify a name" ")", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 43); AnnotateMozCrashReason("MOZ_ASSERT" "(" "\"nsIconChannel\" != nullptr"
") (" "Must specify a name" ")"); do { *((volatile int*)__null
) = 43; __attribute__((nomerge)) ::abort(); } while (false); }
} while (false); if (!mRefCnt.isThreadSafe) _mOwningThread.AssertOwnership
("nsIconChannel" " not thread-safe"); nsrefcnt count = ++mRefCnt
; NS_LogAddRef((this), (count), ("nsIconChannel"), (uint32_t)
(sizeof(*this))); return count; } MozExternalRefCountType nsIconChannel
::Release(void) { do { static_assert( mozilla::detail::AssertionConditionType
<decltype(int32_t(mRefCnt) > 0)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(int32_t(mRefCnt) > 0))), 0
))) { do { } while (false); MOZ_ReportAssertionFailure("int32_t(mRefCnt) > 0"
" (" "dup release" ")", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 43); AnnotateMozCrashReason("MOZ_ASSERT" "(" "int32_t(mRefCnt) > 0"
") (" "dup release" ")"); do { *((volatile int*)__null) = 43
; __attribute__((nomerge)) ::abort(); } while (false); } } while
(false); do { static_assert( mozilla::detail::AssertionConditionType
<decltype("nsIconChannel" != nullptr)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!("nsIconChannel" != nullptr))
), 0))) { do { } while (false); MOZ_ReportAssertionFailure("\"nsIconChannel\" != nullptr"
" (" "Must specify a name" ")", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 43); AnnotateMozCrashReason("MOZ_ASSERT" "(" "\"nsIconChannel\" != nullptr"
") (" "Must specify a name" ")"); do { *((volatile int*)__null
) = 43; __attribute__((nomerge)) ::abort(); } while (false); }
} while (false); if (!mRefCnt.isThreadSafe) _mOwningThread.AssertOwnership
("nsIconChannel" " not thread-safe"); const char* const nametmp
= "nsIconChannel"; nsrefcnt count = --mRefCnt; NS_LogRelease
((this), (count), (nametmp)); if (count == 0) { mRefCnt = 1; delete
(this); return 0; } return count; } nsresult nsIconChannel::
QueryInterface(const nsIID& aIID, void** aInstancePtr) { do
{ if (!(aInstancePtr)) { NS_DebugBreak(NS_DEBUG_ASSERTION, "QueryInterface requires a non-NULL destination!"
, "aInstancePtr", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 43); MOZ_PretendNoReturn(); } } while (0); nsresult rv = NS_ERROR_FAILURE
; static_assert(2 > 0, "Need more arguments to NS_INTERFACE_TABLE"
); static const QITableEntry table[] = { {&mozilla::detail
::kImplementedIID<nsIconChannel, nsIRequest>, int32_t( reinterpret_cast
<char*>(static_cast<nsIRequest*>((nsIconChannel*)
0x1000)) - reinterpret_cast<char*>((nsIconChannel*)0x1000
))}, {&mozilla::detail::kImplementedIID<nsIconChannel,
nsIChannel>, int32_t( reinterpret_cast<char*>(static_cast
<nsIChannel*>((nsIconChannel*)0x1000)) - reinterpret_cast
<char*>((nsIconChannel*)0x1000))}, {&mozilla::detail
::kImplementedIID<nsIconChannel, nsISupports>, int32_t(
reinterpret_cast<char*>(static_cast<nsISupports*>
( static_cast<nsIRequest*>((nsIconChannel*)0x1000))) - reinterpret_cast
<char*>((nsIconChannel*)0x1000))}, { nullptr, 0 } } ; static_assert
((sizeof(table) / sizeof(table[0])) > 1, "need at least 1 interface"
); rv = NS_TableDrivenQI(static_cast<void*>(this), aIID
, aInstancePtr, table); return rv; }
44
45static nsresult MozGdkPixbufToByteBuf(GdkPixbuf* aPixbuf, ByteBuf* aByteBuf) {
46 int width = gdk_pixbuf_get_width(aPixbuf);
47 int height = gdk_pixbuf_get_height(aPixbuf);
48 NS_ENSURE_TRUE(height < 256 && width < 256 && height > 0 && width > 0 &&do { if ((__builtin_expect(!!(!(height < 256 && width
< 256 && height > 0 && width > 0 &&
gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB &&
gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha
(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4)
), 0))) { NS_DebugBreak(NS_DEBUG_WARNING, "NS_ENSURE_TRUE(" "height < 256 && width < 256 && height > 0 && width > 0 && gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB && gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4"
") failed", nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 53); return NS_ERROR_UNEXPECTED; } } while (false)
49 gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB &&do { if ((__builtin_expect(!!(!(height < 256 && width
< 256 && height > 0 && width > 0 &&
gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB &&
gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha
(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4)
), 0))) { NS_DebugBreak(NS_DEBUG_WARNING, "NS_ENSURE_TRUE(" "height < 256 && width < 256 && height > 0 && width > 0 && gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB && gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4"
") failed", nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 53); return NS_ERROR_UNEXPECTED; } } while (false)
50 gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 &&do { if ((__builtin_expect(!!(!(height < 256 && width
< 256 && height > 0 && width > 0 &&
gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB &&
gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha
(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4)
), 0))) { NS_DebugBreak(NS_DEBUG_WARNING, "NS_ENSURE_TRUE(" "height < 256 && width < 256 && height > 0 && width > 0 && gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB && gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4"
") failed", nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 53); return NS_ERROR_UNEXPECTED; } } while (false)
51 gdk_pixbuf_get_has_alpha(aPixbuf) &&do { if ((__builtin_expect(!!(!(height < 256 && width
< 256 && height > 0 && width > 0 &&
gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB &&
gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha
(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4)
), 0))) { NS_DebugBreak(NS_DEBUG_WARNING, "NS_ENSURE_TRUE(" "height < 256 && width < 256 && height > 0 && width > 0 && gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB && gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4"
") failed", nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 53); return NS_ERROR_UNEXPECTED; } } while (false)
52 gdk_pixbuf_get_n_channels(aPixbuf) == 4,do { if ((__builtin_expect(!!(!(height < 256 && width
< 256 && height > 0 && width > 0 &&
gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB &&
gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha
(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4)
), 0))) { NS_DebugBreak(NS_DEBUG_WARNING, "NS_ENSURE_TRUE(" "height < 256 && width < 256 && height > 0 && width > 0 && gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB && gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4"
") failed", nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 53); return NS_ERROR_UNEXPECTED; } } while (false)
53 NS_ERROR_UNEXPECTED)do { if ((__builtin_expect(!!(!(height < 256 && width
< 256 && height > 0 && width > 0 &&
gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB &&
gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha
(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4)
), 0))) { NS_DebugBreak(NS_DEBUG_WARNING, "NS_ENSURE_TRUE(" "height < 256 && width < 256 && height > 0 && width > 0 && gdk_pixbuf_get_colorspace(aPixbuf) == GDK_COLORSPACE_RGB && gdk_pixbuf_get_bits_per_sample(aPixbuf) == 8 && gdk_pixbuf_get_has_alpha(aPixbuf) && gdk_pixbuf_get_n_channels(aPixbuf) == 4"
") failed", nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 53); return NS_ERROR_UNEXPECTED; } } while (false)
;
54
55 const int n_channels = 4;
56 CheckedInt32 buf_size =
57 4 + n_channels * CheckedInt32(height) * CheckedInt32(width);
58 if (!buf_size.isValid()) {
59 return NS_ERROR_OUT_OF_MEMORY;
60 }
61 uint8_t* const buf = (uint8_t*)moz_xmalloc(buf_size.value());
62 uint8_t* out = buf;
63
64 *(out++) = width;
65 *(out++) = height;
66 *(out++) = uint8_t(mozilla::gfx::SurfaceFormat::OS_RGBA);
67
68 // Set all bits to ensure in nsIconDecoder we color manage and premultiply.
69 *(out++) = 0xFF;
70
71 const guchar* const pixels = gdk_pixbuf_get_pixels(aPixbuf);
72 int instride = gdk_pixbuf_get_rowstride(aPixbuf);
73 int outstride = width * n_channels;
74
75 // encode the RGB data and the A data and adjust the stride as necessary.
76 mozilla::gfx::SwizzleData(pixels, instride,
77 mozilla::gfx::SurfaceFormat::R8G8B8A8, out,
78 outstride, mozilla::gfx::SurfaceFormat::OS_RGBA,
79 mozilla::gfx::IntSize(width, height));
80
81 *aByteBuf = ByteBuf(buf, buf_size.value(), buf_size.value());
82 return NS_OK;
83}
84
85static nsresult ByteBufToStream(ByteBuf&& aBuf, nsIInputStream** aStream) {
86 nsresult rv;
87 nsCOMPtr<nsIStringInputStream> stream =
88 do_CreateInstance("@mozilla.org/io/string-input-stream;1", &rv);
89
90 if (NS_WARN_IF(NS_FAILED(rv))NS_warn_if_impl(((bool)(__builtin_expect(!!(NS_FAILED_impl(rv
)), 0))), "NS_FAILED(rv)", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 90)
) {
91 return rv;
92 }
93
94 // stream takes ownership of buf and will free it on destruction.
95 // This function cannot fail.
96 rv = stream->AdoptData(reinterpret_cast<char*>(aBuf.mData), aBuf.mLen);
97 MOZ_ASSERT(CheckedInt32(aBuf.mLen).isValid(),do { static_assert( mozilla::detail::AssertionConditionType<
decltype(CheckedInt32(aBuf.mLen).isValid())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(CheckedInt32(aBuf.mLen).isValid
()))), 0))) { do { } while (false); MOZ_ReportAssertionFailure
("CheckedInt32(aBuf.mLen).isValid()" " (" "aBuf.mLen should fit in int32_t"
")", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 98); AnnotateMozCrashReason("MOZ_ASSERT" "(" "CheckedInt32(aBuf.mLen).isValid()"
") (" "aBuf.mLen should fit in int32_t" ")"); do { *((volatile
int*)__null) = 98; __attribute__((nomerge)) ::abort(); } while
(false); } } while (false)
98 "aBuf.mLen should fit in int32_t")do { static_assert( mozilla::detail::AssertionConditionType<
decltype(CheckedInt32(aBuf.mLen).isValid())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(CheckedInt32(aBuf.mLen).isValid
()))), 0))) { do { } while (false); MOZ_ReportAssertionFailure
("CheckedInt32(aBuf.mLen).isValid()" " (" "aBuf.mLen should fit in int32_t"
")", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 98); AnnotateMozCrashReason("MOZ_ASSERT" "(" "CheckedInt32(aBuf.mLen).isValid()"
") (" "aBuf.mLen should fit in int32_t" ")"); do { *((volatile
int*)__null) = 98; __attribute__((nomerge)) ::abort(); } while
(false); } } while (false)
;
99 aBuf.mData = nullptr;
100
101 // If this no longer holds then re-examine buf's lifetime.
102 MOZ_ASSERT(NS_SUCCEEDED(rv))do { static_assert( mozilla::detail::AssertionConditionType<
decltype(((bool)(__builtin_expect(!!(!NS_FAILED_impl(rv)), 1)
)))>::isValid, "invalid assertion condition"); if ((__builtin_expect
(!!(!(!!(((bool)(__builtin_expect(!!(!NS_FAILED_impl(rv)), 1)
))))), 0))) { do { } while (false); MOZ_ReportAssertionFailure
("((bool)(__builtin_expect(!!(!NS_FAILED_impl(rv)), 1)))", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 102); AnnotateMozCrashReason("MOZ_ASSERT" "(" "((bool)(__builtin_expect(!!(!NS_FAILED_impl(rv)), 1)))"
")"); do { *((volatile int*)__null) = 102; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
103 NS_ENSURE_SUCCESS(rv, rv)do { nsresult __rv = rv; if (((bool)(__builtin_expect(!!(NS_FAILED_impl
(__rv)), 0)))) { const char* name = mozilla::GetStaticErrorName
(__rv); mozilla::SmprintfPointer msg = mozilla::Smprintf( "NS_ENSURE_SUCCESS(%s, %s) failed with "
"result 0x%" "X" "%s%s%s", "rv", "rv", static_cast<uint32_t
>(__rv), name ? " (" : "", name ? name : "", name ? ")" : ""
); NS_DebugBreak(NS_DEBUG_WARNING, msg.get(), nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 103); return rv; } } while (false)
;
104
105 stream.forget(aStream);
106 return NS_OK;
107}
108
109static nsresult StreamToChannel(already_AddRefed<nsIInputStream> aStream,
110 nsIURI* aURI, nsIChannel** aChannel) {
111 // nsIconProtocolHandler::NewChannel will provide the correct loadInfo for
112 // this iconChannel. Use the most restrictive security settings for the
113 // temporary loadInfo to make sure the channel can not be opened.
114 nsCOMPtr<nsIPrincipal> nullPrincipal =
115 mozilla::NullPrincipal::CreateWithoutOriginAttributes();
116 return NS_NewInputStreamChannel(
117 aChannel, aURI, std::move(aStream), nullPrincipal,
118 nsILoadInfo::SEC_REQUIRE_SAME_ORIGIN_DATA_IS_BLOCKED,
119 nsIContentPolicy::TYPE_INTERNAL_IMAGE, nsLiteralCString(IMAGE_ICON_MS"image/icon"));
120}
121
122static GtkWidget* gProtoWindow = nullptr;
123static GtkWidget* gStockImageWidget = nullptr;
124
125static void ensure_stock_image_widget() {
126 // Only the style of the GtkImage needs to be used, but the widget is kept
127 // to track dynamic style changes.
128 if (!gProtoWindow) {
129 gProtoWindow = gtk_window_new(GTK_WINDOW_POPUP);
130 GtkWidget* protoLayout = gtk_fixed_new();
131 gtk_container_add(GTK_CONTAINER(gProtoWindow)((((GtkContainer*) (void *) ((gProtoWindow))))), protoLayout);
132
133 gStockImageWidget = gtk_image_new();
134 gtk_container_add(GTK_CONTAINER(protoLayout)((((GtkContainer*) (void *) ((protoLayout))))), gStockImageWidget);
135
136 gtk_widget_ensure_style(gStockImageWidget);
137 }
138}
139
140static GtkIconSize moz_gtk_icon_size(const char* name) {
141 if (strcmp(name, "button") == 0) {
142 return GTK_ICON_SIZE_BUTTON;
143 }
144
145 if (strcmp(name, "menu") == 0) {
146 return GTK_ICON_SIZE_MENU;
147 }
148
149 if (strcmp(name, "toolbar") == 0) {
150 return GTK_ICON_SIZE_LARGE_TOOLBAR;
151 }
152
153 if (strcmp(name, "toolbarsmall") == 0) {
154 return GTK_ICON_SIZE_SMALL_TOOLBAR;
155 }
156
157 if (strcmp(name, "dnd") == 0) {
158 return GTK_ICON_SIZE_DND;
159 }
160
161 if (strcmp(name, "dialog") == 0) {
162 return GTK_ICON_SIZE_DIALOG;
163 }
164
165 return GTK_ICON_SIZE_MENU;
166}
167
168static int32_t GetIconSize(nsIMozIconURI* aIconURI) {
169 nsAutoCString iconSizeString;
170
171 aIconURI->GetIconSize(iconSizeString);
172 if (iconSizeString.IsEmpty()) {
173 uint32_t size;
174 mozilla::DebugOnly<nsresult> rv = aIconURI->GetImageSize(&size);
175 NS_ASSERTION(NS_SUCCEEDED(rv), "GetImageSize failed")do { if (!(((bool)(__builtin_expect(!!(!NS_FAILED_impl(rv)), 1
))))) { NS_DebugBreak(NS_DEBUG_ASSERTION, "GetImageSize failed"
, "NS_SUCCEEDED(rv)", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 175); MOZ_PretendNoReturn(); } } while (0)
;
176 return size;
177 }
178 int size;
179
180 GtkIconSize icon_size = moz_gtk_icon_size(iconSizeString.get());
181 gtk_icon_size_lookup(icon_size, &size, nullptr);
182 return size;
183}
184
185/* Scale icon buffer to preferred size */
186static nsresult ScaleIconBuf(GdkPixbuf** aBuf, int32_t iconSize) {
187 // Scale buffer only if width or height differ from preferred size
188 if (gdk_pixbuf_get_width(*aBuf) != iconSize &&
189 gdk_pixbuf_get_height(*aBuf) != iconSize) {
190 GdkPixbuf* scaled =
191 gdk_pixbuf_scale_simple(*aBuf, iconSize, iconSize, GDK_INTERP_BILINEAR);
192 // replace original buffer by scaled
193 g_object_unref(*aBuf);
194 *aBuf = scaled;
195 if (!scaled) {
196 return NS_ERROR_OUT_OF_MEMORY;
197 }
198 }
199 return NS_OK;
200}
201
202/* static */
203nsresult nsIconChannel::GetIconWithGIO(nsIMozIconURI* aIconURI,
204 ByteBuf* aDataOut) {
205 GIcon* icon = nullptr;
206 nsCOMPtr<nsIURL> fileURI;
207
208 // Read icon content
209 aIconURI->GetIconURL(getter_AddRefs(fileURI));
210
211 // Get icon for file specified by URI
212 if (fileURI) {
213 nsAutoCString spec;
214 fileURI->GetAsciiSpec(spec);
215 if (fileURI->SchemeIs("file")) {
216 GFile* file = g_file_new_for_uri(spec.get());
217 GFileInfo* fileInfo =
218 g_file_query_info(file, G_FILE_ATTRIBUTE_STANDARD_ICON"standard::icon",
219 G_FILE_QUERY_INFO_NONE, nullptr, nullptr);
220 g_object_unref(file);
221 if (fileInfo) {
222 // icon from g_content_type_get_icon doesn't need unref
223 icon = g_file_info_get_icon(fileInfo);
224 if (icon) {
225 g_object_ref(icon);
226 }
227 g_object_unref(fileInfo);
228 }
229 }
230 }
231
232 // Try to get icon by using MIME type
233 if (!icon) {
234 nsAutoCString type;
235 aIconURI->GetContentType(type);
236 // Try to get MIME type from file extension by using nsIMIMEService
237 if (type.IsEmpty()) {
238 nsCOMPtr<nsIMIMEService> ms(do_GetService("@mozilla.org/mime;1"));
239 if (ms) {
240 nsAutoCString fileExt;
241 aIconURI->GetFileExtension(fileExt);
242 ms->GetTypeFromExtension(fileExt, type);
243 }
244 }
245 char* ctype = nullptr; // character representation of content type
246 if (!type.IsEmpty()) {
247 ctype = g_content_type_from_mime_type(type.get());
248 }
249 if (ctype) {
250 icon = g_content_type_get_icon(ctype);
251 g_free(ctype);
252 }
253 }
254
255 // Get default icon theme
256 GtkIconTheme* iconTheme = gtk_icon_theme_get_default();
257 GtkIconInfo* iconInfo = nullptr;
258 // Get icon size
259 int32_t iconSize = GetIconSize(aIconURI);
260
261 if (icon) {
262 // Use icon and theme to get GtkIconInfo
263 iconInfo = gtk_icon_theme_lookup_by_gicon(iconTheme, icon, iconSize,
264 (GtkIconLookupFlags)0);
265 g_object_unref(icon);
266 }
267
268 if (!iconInfo) {
269 // Mozilla's mimetype lookup failed. Try the "unknown" icon.
270 iconInfo = gtk_icon_theme_lookup_icon(iconTheme, "unknown", iconSize,
271 (GtkIconLookupFlags)0);
272 if (!iconInfo) {
273 return NS_ERROR_NOT_AVAILABLE;
274 }
275 }
276
277 // Create a GdkPixbuf buffer containing icon and scale it
278 GdkPixbuf* buf = gtk_icon_info_load_icon(iconInfo, nullptr);
279 gtk_icon_info_free(iconInfo);
280 if (!buf) {
281 return NS_ERROR_UNEXPECTED;
282 }
283
284 nsresult rv = ScaleIconBuf(&buf, iconSize);
285 NS_ENSURE_SUCCESS(rv, rv)do { nsresult __rv = rv; if (((bool)(__builtin_expect(!!(NS_FAILED_impl
(__rv)), 0)))) { const char* name = mozilla::GetStaticErrorName
(__rv); mozilla::SmprintfPointer msg = mozilla::Smprintf( "NS_ENSURE_SUCCESS(%s, %s) failed with "
"result 0x%" "X" "%s%s%s", "rv", "rv", static_cast<uint32_t
>(__rv), name ? " (" : "", name ? name : "", name ? ")" : ""
); NS_DebugBreak(NS_DEBUG_WARNING, msg.get(), nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 285); return rv; } } while (false)
;
286
287 rv = MozGdkPixbufToByteBuf(buf, aDataOut);
288 g_object_unref(buf);
289 return rv;
290}
291
292/* static */
293nsresult nsIconChannel::GetIcon(nsIURI* aURI, ByteBuf* aDataOut) {
294 nsCOMPtr<nsIMozIconURI> iconURI = do_QueryInterface(aURI);
295 NS_ASSERTION(iconURI, "URI is not an nsIMozIconURI")do { if (!(iconURI)) { NS_DebugBreak(NS_DEBUG_ASSERTION, "URI is not an nsIMozIconURI"
, "iconURI", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 295); MOZ_PretendNoReturn(); } } while (0)
;
296
297 if (!iconURI) {
298 return NS_ERROR_NOT_AVAILABLE;
299 }
300
301 if (gfxPlatform::IsHeadless()) {
302 return NS_ERROR_NOT_AVAILABLE;
303 }
304
305 nsAutoCString stockIcon;
306 iconURI->GetStockIcon(stockIcon);
307 if (stockIcon.IsEmpty()) {
308 return GetIconWithGIO(iconURI, aDataOut);
309 }
310
311 // Search for stockIcon
312 nsAutoCString iconSizeString;
313 iconURI->GetIconSize(iconSizeString);
314
315 nsAutoCString iconStateString;
316 iconURI->GetIconState(iconStateString);
317
318 GtkIconSize icon_size = moz_gtk_icon_size(iconSizeString.get());
319 GtkStateType state = iconStateString.EqualsLiteral("disabled")
320 ? GTK_STATE_INSENSITIVE
321 : GTK_STATE_NORMAL;
322
323 // First lookup the icon by stock id and text direction.
324 GtkTextDirection direction = GTK_TEXT_DIR_NONE;
325 if (StringEndsWith(stockIcon, "-ltr"_ns)) {
326 direction = GTK_TEXT_DIR_LTR;
327 } else if (StringEndsWith(stockIcon, "-rtl"_ns)) {
328 direction = GTK_TEXT_DIR_RTL;
329 }
330
331 bool forceDirection = direction != GTK_TEXT_DIR_NONE;
332 nsAutoCString stockID;
333 bool useIconName = false;
334 if (!forceDirection) {
335 direction = gtk_widget_get_default_direction();
336 stockID = stockIcon;
337 } else {
338 // GTK versions < 2.22 use icon names from concatenating stock id with
339 // -(rtl|ltr), which is how the moz-icon stock name is interpreted here.
340 stockID = Substring(stockIcon, 0, stockIcon.Length() - 4);
341 // However, if we lookup bidi icons by the stock name, then GTK versions
342 // >= 2.22 will use a bidi lookup convention that most icon themes do not
343 // yet follow. Therefore, we first check to see if the theme supports the
344 // old icon name as this will have bidi support (if found).
345 GtkIconTheme* icon_theme = gtk_icon_theme_get_default();
346 // Micking what gtk_icon_set_render_icon does with sizes, though it's not
347 // critical as icons will be scaled to suit size. It just means we follow
348 // the same paths and so share caches.
349 gint width, height;
350 if (gtk_icon_size_lookup(icon_size, &width, &height)) {
351 gint size = std::min(width, height);
352 // We use gtk_icon_theme_lookup_icon() without
353 // GTK_ICON_LOOKUP_USE_BUILTIN instead of gtk_icon_theme_has_icon() so
354 // we don't pick up fallback icons added by distributions for backward
355 // compatibility.
356 GtkIconInfo* icon = gtk_icon_theme_lookup_icon(
357 icon_theme, stockIcon.get(), size, (GtkIconLookupFlags)0);
358 if (icon) {
359 useIconName = true;
360 gtk_icon_info_free(icon);
361 }
362 }
363 }
364
365 ensure_stock_image_widget();
366 GtkStyle* style = gtk_widget_get_style(gStockImageWidget);
367 GtkIconSet* icon_set = nullptr;
368 if (!useIconName) {
369 icon_set = gtk_style_lookup_icon_set(style, stockID.get());
370 }
371
372 if (!icon_set) {
373 // Either we have chosen icon-name lookup for a bidi icon, or stockIcon is
374 // not a stock id so we assume it is an icon name.
375 useIconName = true;
376 // Creating a GtkIconSet is a convenient way to allow the style to
377 // render the icon, possibly with variations suitable for insensitive
378 // states.
379 icon_set = gtk_icon_set_new();
380 GtkIconSource* icon_source = gtk_icon_source_new();
381
382 gtk_icon_source_set_icon_name(icon_source, stockIcon.get());
383 gtk_icon_set_add_source(icon_set, icon_source);
384 gtk_icon_source_free(icon_source);
385 }
386
387 GdkPixbuf* icon = gtk_icon_set_render_icon(
388 icon_set, style, direction, state, icon_size, gStockImageWidget, nullptr);
389 if (useIconName) {
390 gtk_icon_set_unref(icon_set);
391 }
392
393 // According to documentation, gtk_icon_set_render_icon() never returns
394 // nullptr, but it does return nullptr when we have the problem reported
395 // here: https://bugzilla.gnome.org/show_bug.cgi?id=629878#c13
396 if (!icon) {
397 return NS_ERROR_NOT_AVAILABLE;
398 }
399
400 nsresult rv = MozGdkPixbufToByteBuf(icon, aDataOut);
401
402 g_object_unref(icon);
403
404 return rv;
405}
406
407nsresult nsIconChannel::Init(nsIURI* aURI) {
408 nsCOMPtr<nsIInputStream> stream;
409
410 using ContentChild = mozilla::dom::ContentChild;
411 if (auto* contentChild = ContentChild::GetSingleton()) {
412 // Get the icon via IPC and translate the promise of a ByteBuf
413 // into an actually-existing channel.
414 RefPtr<ContentChild::GetSystemIconPromise> icon =
415 contentChild->SendGetSystemIcon(aURI);
416 if (!icon) {
417 return NS_ERROR_UNEXPECTED;
418 }
419
420 nsCOMPtr<nsIAsyncInputStream> inputStream;
421 nsCOMPtr<nsIAsyncOutputStream> outputStream;
422 NS_NewPipe2(getter_AddRefs(inputStream), getter_AddRefs(outputStream), true,
423 false, 0, UINT32_MAX(4294967295U));
424
425 // FIXME: Bug 1718324
426 // The GetSystemIcon() call will end up on the parent doing GetIcon()
427 // and by using ByteBuf we might not be immune to some deadlock, at least
428 // on paper. From analysis in
429 // https://phabricator.services.mozilla.com/D118596#3865440 we should be
430 // safe in practice, but it would be nicer to just write that differently.
431
432 icon->Then(
433 mozilla::GetCurrentSerialEventTarget(), __func__,
434 [outputStream](std::tuple<nsresult, mozilla::Maybe<ByteBuf>>&& aArg) {
435 nsresult rv = std::get<0>(aArg);
436 mozilla::Maybe<ByteBuf> bytes = std::move(std::get<1>(aArg));
437
438 if (NS_SUCCEEDED(rv)((bool)(__builtin_expect(!!(!NS_FAILED_impl(rv)), 1)))) {
1
Assuming the condition is true
2
Taking true branch
439 MOZ_RELEASE_ASSERT(bytes)do { static_assert( mozilla::detail::AssertionConditionType<
decltype(bytes)>::isValid, "invalid assertion condition");
if ((__builtin_expect(!!(!(!!(bytes))), 0))) { do { } while (
false); MOZ_ReportAssertionFailure("bytes", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 439); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "bytes"
")"); do { *((volatile int*)__null) = 439; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
3
Taking false branch
4
Loop condition is false. Exiting loop
440 uint32_t written;
441 rv = outputStream->Write(reinterpret_cast<char*>(bytes->mData),
442 static_cast<uint32_t>(bytes->mLen),
443 &written);
444 if (NS_SUCCEEDED(rv)((bool)(__builtin_expect(!!(!NS_FAILED_impl(rv)), 1)))) {
5
Assuming the condition is false
6
Taking false branch
445 const bool wroteAll = static_cast<size_t>(written) == bytes->mLen;
446 MOZ_ASSERT(wroteAll)do { static_assert( mozilla::detail::AssertionConditionType<
decltype(wroteAll)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(wroteAll))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("wroteAll", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 446); AnnotateMozCrashReason("MOZ_ASSERT" "(" "wroteAll" ")"
); do { *((volatile int*)__null) = 446; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
447 if (!wroteAll) {
448 rv = NS_ERROR_UNEXPECTED;
449 }
450 }
451 } else {
452 MOZ_ASSERT(!bytes)do { static_assert( mozilla::detail::AssertionConditionType<
decltype(!bytes)>::isValid, "invalid assertion condition")
; if ((__builtin_expect(!!(!(!!(!bytes))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("!bytes", "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 452); AnnotateMozCrashReason("MOZ_ASSERT" "(" "!bytes" ")")
; do { *((volatile int*)__null) = 452; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
453 }
454
455 if (NS_FAILED(rv)((bool)(__builtin_expect(!!(NS_FAILED_impl(rv)), 0)))) {
7
Taking true branch
456 outputStream->CloseWithStatus(rv);
457 }
458 },
8
Calling implicit destructor for 'Maybe<mozilla::ipc::ByteBuf>'
9
Calling '~MaybeStorage'
459 [outputStream](mozilla::ipc::ResponseRejectReason) {
460 outputStream->CloseWithStatus(NS_ERROR_FAILURE);
461 });
462
463 stream = inputStream.forget();
464 } else {
465 // Get the icon directly.
466 ByteBuf bytebuf;
467 nsresult rv = GetIcon(aURI, &bytebuf);
468 NS_ENSURE_SUCCESS(rv, rv)do { nsresult __rv = rv; if (((bool)(__builtin_expect(!!(NS_FAILED_impl
(__rv)), 0)))) { const char* name = mozilla::GetStaticErrorName
(__rv); mozilla::SmprintfPointer msg = mozilla::Smprintf( "NS_ENSURE_SUCCESS(%s, %s) failed with "
"result 0x%" "X" "%s%s%s", "rv", "rv", static_cast<uint32_t
>(__rv), name ? " (" : "", name ? name : "", name ? ")" : ""
); NS_DebugBreak(NS_DEBUG_WARNING, msg.get(), nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 468); return rv; } } while (false)
;
469
470 rv = ByteBufToStream(std::move(bytebuf), getter_AddRefs(stream));
471 NS_ENSURE_SUCCESS(rv, rv)do { nsresult __rv = rv; if (((bool)(__builtin_expect(!!(NS_FAILED_impl
(__rv)), 0)))) { const char* name = mozilla::GetStaticErrorName
(__rv); mozilla::SmprintfPointer msg = mozilla::Smprintf( "NS_ENSURE_SUCCESS(%s, %s) failed with "
"result 0x%" "X" "%s%s%s", "rv", "rv", static_cast<uint32_t
>(__rv), name ? " (" : "", name ? name : "", name ? ")" : ""
); NS_DebugBreak(NS_DEBUG_WARNING, msg.get(), nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/image/decoders/icon/gtk/nsIconChannel.cpp"
, 471); return rv; } } while (false)
;
472 }
473
474 return StreamToChannel(stream.forget(), aURI, getter_AddRefs(mRealChannel));
475}
476
477void nsIconChannel::Shutdown() {
478 if (gProtoWindow) {
479 gtk_widget_destroy(gProtoWindow);
480 gProtoWindow = nullptr;
481 gStockImageWidget = nullptr;
482 }
483}

/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.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
7#ifndef nsINode_h___
8#define nsINode_h___
9
10#include "mozilla/DoublyLinkedList.h"
11#include "mozilla/Likely.h"
12#include "mozilla/UniquePtr.h"
13#include "nsCOMPtr.h" // for member, local
14#include "nsGkAtoms.h" // for nsGkAtoms::baseURIProperty
15#include "mozilla/dom/NodeInfo.h" // member (in nsCOMPtr)
16#include "nsIWeakReference.h"
17#include "nsIMutationObserver.h"
18#include "nsNodeInfoManager.h" // for use in NodePrincipal()
19#include "nsPropertyTable.h" // for typedefs
20#include "mozilla/ErrorResult.h"
21#include "mozilla/LinkedList.h"
22#include "mozilla/MemoryReporting.h"
23#include "mozilla/dom/EventTarget.h" // for base class
24#include "js/TypeDecls.h" // for Handle, Value, JSObject, JSContext
25#include "mozilla/dom/DOMString.h"
26#include "mozilla/dom/BindingDeclarations.h"
27#include "mozilla/dom/NodeBinding.h"
28#include "nsTHashtable.h"
29#include <iosfwd>
30
31// Including 'windows.h' will #define GetClassInfo to something else.
32#ifdef XP_WIN
33# ifdef GetClassInfo
34# undef GetClassInfo
35# endif
36#endif
37
38class AttrArray;
39class nsAttrChildContentList;
40template <typename T>
41class nsCOMArray;
42class nsDOMAttributeMap;
43class nsGenericHTMLElement;
44class nsIAnimationObserver;
45class nsIContent;
46class nsIContentSecurityPolicy;
47class nsIFrame;
48class nsIHTMLCollection;
49class nsMultiMutationObserver;
50class nsINode;
51class nsINodeList;
52class nsIPrincipal;
53class nsIURI;
54class nsNodeSupportsWeakRefTearoff;
55class nsDOMMutationObserver;
56class nsRange;
57class nsWindowSizes;
58
59namespace mozilla {
60class EventListenerManager;
61struct StyleSelectorList;
62template <typename T>
63class Maybe;
64class PresShell;
65class TextEditor;
66namespace dom {
67/**
68 * @return true if aChar is what the WHATWG defines as a 'ascii whitespace'.
69 * https://infra.spec.whatwg.org/#ascii-whitespace
70 */
71inline bool IsSpaceCharacter(char16_t aChar) {
72 return aChar == ' ' || aChar == '\t' || aChar == '\n' || aChar == '\r' ||
73 aChar == '\f';
74}
75inline bool IsSpaceCharacter(char aChar) {
76 return aChar == ' ' || aChar == '\t' || aChar == '\n' || aChar == '\r' ||
77 aChar == '\f';
78}
79class AbstractRange;
80class AccessibleNode;
81template <typename T>
82class AncestorsOfTypeIterator;
83struct BoxQuadOptions;
84struct ConvertCoordinateOptions;
85class DocGroup;
86class Document;
87class DocumentFragment;
88class DocumentOrShadowRoot;
89class DOMPoint;
90class DOMQuad;
91class DOMRectReadOnly;
92class Element;
93class EventHandlerNonNull;
94template <typename T>
95class FlatTreeAncestorsOfTypeIterator;
96template <typename T>
97class InclusiveAncestorsOfTypeIterator;
98template <typename T>
99class InclusiveFlatTreeAncestorsOfTypeIterator;
100class LinkStyle;
101class MutationObservers;
102template <typename T>
103class Optional;
104class OwningNodeOrString;
105template <typename>
106class Sequence;
107class ShadowRoot;
108class SVGUseElement;
109class Text;
110class TextOrElementOrDocument;
111struct DOMPointInit;
112struct GetRootNodeOptions;
113enum class CallerType : uint32_t;
114} // namespace dom
115} // namespace mozilla
116
117#define NODE_FLAG_BIT(n_)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (n_)))
\
118 (nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED + (n_)))
119
120enum : uint32_t {
121 // This bit will be set if the node has a listener manager.
122 NODE_HAS_LISTENERMANAGER = NODE_FLAG_BIT(0)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (0)))
,
123
124 // Whether this node has had any properties set on it
125 NODE_HAS_PROPERTIES = NODE_FLAG_BIT(1)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (1)))
,
126
127 // Whether the node has some ancestor, possibly itself, that is native
128 // anonymous. This includes ancestors crossing XBL scopes, in cases when an
129 // XBL binding is attached to an element which has a native anonymous
130 // ancestor. This flag is set-once: once a node has it, it must not be
131 // removed.
132 // NOTE: Should only be used on nsIContent nodes
133 NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE = NODE_FLAG_BIT(2)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (2)))
,
134
135 // Whether this node is the root of a native anonymous (from the perspective
136 // of its parent) subtree. This flag is set-once: once a node has it, it
137 // must not be removed.
138 // NOTE: Should only be used on nsIContent nodes
139 NODE_IS_NATIVE_ANONYMOUS_ROOT = NODE_FLAG_BIT(3)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (3)))
,
140
141 NODE_IS_EDITABLE = NODE_FLAG_BIT(4)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (4)))
,
142
143 // Whether the node participates in a shadow tree.
144 NODE_IS_IN_SHADOW_TREE = NODE_FLAG_BIT(5)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (5)))
,
145
146 // This node needs to go through frame construction to get a frame (or
147 // undisplayed entry).
148 NODE_NEEDS_FRAME = NODE_FLAG_BIT(6)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (6)))
,
149
150 // At least one descendant in the flattened tree has NODE_NEEDS_FRAME set.
151 // This should be set on every node on the flattened tree path between the
152 // node(s) with NODE_NEEDS_FRAME and the root content.
153 NODE_DESCENDANTS_NEED_FRAMES = NODE_FLAG_BIT(7)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (7)))
,
154
155 // Set if the node has the accesskey attribute set.
156 NODE_HAS_ACCESSKEY = NODE_FLAG_BIT(8)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (8)))
,
157
158 NODE_HAS_BEEN_IN_UA_WIDGET = NODE_FLAG_BIT(9)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (9)))
,
159
160 // Set if the node has a nonce value and a header delivered CSP.
161 NODE_HAS_NONCE_AND_HEADER_CSP = NODE_FLAG_BIT(10)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (10)))
,
162
163 NODE_KEEPS_DOMARENA = NODE_FLAG_BIT(11)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (11)))
,
164
165 NODE_MAY_HAVE_ELEMENT_CHILDREN = NODE_FLAG_BIT(12)(nsWrapperCache::FlagsType(1U) << (WRAPPER_CACHE_FLAGS_BITS_USED
+ (12)))
,
166
167 // Remaining bits are node type specific.
168 NODE_TYPE_SPECIFIC_BITS_OFFSET = 13
169};
170
171// Flags for selectors that persist to the DOM node.
172enum class NodeSelectorFlags : uint32_t {
173 // Node has an :empty or :-moz-only-whitespace selector
174 HasEmptySelector = 1 << 0,
175
176 /// A child of the node has a selector such that any insertion,
177 /// removal, or appending of children requires restyling the parent, if the
178 /// parent is an element. If the parent is the shadow root, the child's
179 /// siblings are restyled.
180 HasSlowSelector = 1 << 1,
181
182 /// A child of the node has a :first-child, :-moz-first-node,
183 /// :only-child, :last-child or :-moz-last-node selector.
184 HasEdgeChildSelector = 1 << 2,
185
186 /// A child of the node has a selector such that any insertion or
187 /// removal of children requires restyling later siblings of that
188 /// element. Additionally (in this manner it is stronger than
189 /// NODE_HAS_SLOW_SELECTOR), if a child's style changes due to any
190 /// other content tree changes (e.g., the child changes to or from
191 /// matching :empty due to a grandchild insertion or removal), the
192 /// child's later siblings must also be restyled.
193 HasSlowSelectorLaterSiblings = 1 << 3,
194
195 /// HasSlowSelector* was set by the presence of :nth (But not of).
196 HasSlowSelectorNth = 1 << 4,
197
198 /// A child of this node might be matched by :nth-child(.. of <selector>) or
199 /// :nth-last-child(.. of <selector>). If a DOM mutation may have caused the
200 /// selector to either match or no longer match that child, the child's
201 /// siblings are restyled.
202 HasSlowSelectorNthOf = 1 << 5,
203
204 /// All instances of :nth flags.
205 HasSlowSelectorNthAll = HasSlowSelectorNthOf | HasSlowSelectorNth,
206
207 /// Set of selector flags that may trigger a restyle on DOM append, with
208 /// restyle on siblings or a single parent (And perhaps their subtrees).
209 AllSimpleRestyleFlagsForAppend = HasEmptySelector | HasSlowSelector |
210 HasEdgeChildSelector | HasSlowSelectorNthAll,
211
212 /// Set of selector flags that may trigger a restyle as a result of any
213 /// DOM mutation.
214 AllSimpleRestyleFlags =
215 AllSimpleRestyleFlagsForAppend | HasSlowSelectorLaterSiblings,
216
217 // This node was evaluated as an anchor for a relative selector.
218 RelativeSelectorAnchor = 1 << 6,
219
220 // This node was evaluated as an anchor for a relative selector, and that
221 // relative selector was not the subject of the overall selector.
222 RelativeSelectorAnchorNonSubject = 1 << 7,
223
224 // This node's sibling(s) performed a relative selector search to this node.
225 RelativeSelectorSearchDirectionSibling = 1 << 8,
226
227 // This node's ancestor(s) performed a relative selector search to this node.
228 RelativeSelectorSearchDirectionAncestor = 1 << 9,
229
230 // This node's sibling(s) and ancestor(s), and/or this node's ancestor's
231 // sibling(s) performed a relative selector search to this node.
232 RelativeSelectorSearchDirectionAncestorSibling =
233 RelativeSelectorSearchDirectionSibling |
234 RelativeSelectorSearchDirectionAncestor,
235};
236
237MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS(NodeSelectorFlags)inline constexpr mozilla::CastableTypedEnumResult<NodeSelectorFlags
> operator |( NodeSelectorFlags a, NodeSelectorFlags b) { typedef
mozilla::CastableTypedEnumResult<NodeSelectorFlags> Result
; typedef mozilla::detail::UnsignedIntegerTypeForEnum<NodeSelectorFlags
>::Type U; return Result(NodeSelectorFlags(U(a) | U(b))); }
inline NodeSelectorFlags& operator |=(NodeSelectorFlags &
a, NodeSelectorFlags b) { return a = a | b; } inline constexpr
mozilla::CastableTypedEnumResult<NodeSelectorFlags> operator
&( NodeSelectorFlags a, NodeSelectorFlags b) { typedef mozilla
::CastableTypedEnumResult<NodeSelectorFlags> Result; typedef
mozilla::detail::UnsignedIntegerTypeForEnum<NodeSelectorFlags
>::Type U; return Result(NodeSelectorFlags(U(a) & U(b)
)); } inline NodeSelectorFlags& operator &=(NodeSelectorFlags
& a, NodeSelectorFlags b) { return a = a & b; } inline
constexpr mozilla::CastableTypedEnumResult<NodeSelectorFlags
> operator ^( NodeSelectorFlags a, NodeSelectorFlags b) { typedef
mozilla::CastableTypedEnumResult<NodeSelectorFlags> Result
; typedef mozilla::detail::UnsignedIntegerTypeForEnum<NodeSelectorFlags
>::Type U; return Result(NodeSelectorFlags(U(a) ^ U(b))); }
inline NodeSelectorFlags& operator ^=(NodeSelectorFlags &
a, NodeSelectorFlags b) { return a = a ^ b; } inline constexpr
mozilla::CastableTypedEnumResult<NodeSelectorFlags> operator
~(NodeSelectorFlags a) { typedef mozilla::CastableTypedEnumResult
<NodeSelectorFlags> Result; typedef mozilla::detail::UnsignedIntegerTypeForEnum
<NodeSelectorFlags>::Type U; return Result(NodeSelectorFlags
(~(U(a)))); }
;
238
239// Make sure we have space for our bits
240#define ASSERT_NODE_FLAGS_SPACE(n)static_assert(WRAPPER_CACHE_FLAGS_BITS_USED + (n) <= sizeof
(nsWrapperCache::FlagsType) * 8, "Not enough space for our bits"
)
\
241 static_assert(WRAPPER_CACHE_FLAGS_BITS_USED + (n) <= \
242 sizeof(nsWrapperCache::FlagsType) * 8, \
243 "Not enough space for our bits")
244ASSERT_NODE_FLAGS_SPACE(NODE_TYPE_SPECIFIC_BITS_OFFSET)static_assert(WRAPPER_CACHE_FLAGS_BITS_USED + (NODE_TYPE_SPECIFIC_BITS_OFFSET
) <= sizeof(nsWrapperCache::FlagsType) * 8, "Not enough space for our bits"
)
;
245
246/**
247 * Class used to detect unexpected mutations. To use the class create an
248 * nsMutationGuard on the stack before unexpected mutations could occur.
249 * You can then at any time call Mutated to check if any unexpected mutations
250 * have occurred.
251 */
252class nsMutationGuard {
253 public:
254 nsMutationGuard() { mStartingGeneration = sGeneration; }
255
256 /**
257 * Returns true if any unexpected mutations have occurred. You can pass in
258 * an 8-bit ignore count to ignore a number of expected mutations.
259 *
260 * We don't need to care about overflow because subtraction of uint64_t's is
261 * finding the difference between two elements of the group Z < 2^64. Once
262 * we know the difference between two elements we only need to check that is
263 * less than the given number of mutations to know less than that many
264 * mutations occured. Assuming constant 1ns mutations it would take 584
265 * years for sGeneration to fully wrap around so we can ignore a guard living
266 * through a full wrap around.
267 */
268 bool Mutated(uint8_t aIgnoreCount) {
269 return (sGeneration - mStartingGeneration) > aIgnoreCount;
270 }
271
272 // This function should be called whenever a mutation that we want to keep
273 // track of happen. For now this is only done when children are added or
274 // removed, but we might do it for attribute changes too in the future.
275 static void DidMutate() { sGeneration++; }
276
277 private:
278 // This is the value sGeneration had when the guard was constructed.
279 uint64_t mStartingGeneration;
280
281 // This value is incremented on every mutation, for the life of the process.
282 static uint64_t sGeneration;
283};
284
285/**
286 * A class that implements nsIWeakReference
287 */
288class nsNodeWeakReference final : public nsIWeakReference {
289 public:
290 explicit nsNodeWeakReference(nsINode* aNode);
291
292 // nsISupports
293 NS_DECL_ISUPPORTSpublic: virtual nsresult QueryInterface(const nsIID& aIID
, void** aInstancePtr) override; virtual MozExternalRefCountType
AddRef(void) override; virtual MozExternalRefCountType Release
(void) override; using HasThreadSafeRefCnt = std::false_type;
protected: nsAutoRefCnt mRefCnt; nsAutoOwningThread _mOwningThread
; public:
294
295 // nsIWeakReference
296 NS_DECL_NSIWEAKREFERENCEvirtual nsresult QueryReferentFromScript(const nsIID & uuid
, void * * result) override; virtual size_t SizeOfOnlyThis(mozilla
::MallocSizeOf aMallocSizeOf) override;
297
298 void NoticeNodeDestruction() { mObject = nullptr; }
299
300 private:
301 ~nsNodeWeakReference();
302};
303
304// This should be used for any nsINode sub-class that has fields of its own
305// that it needs to measure; any sub-class that doesn't use it will inherit
306// AddSizeOfExcludingThis from its super-class. AddSizeOfIncludingThis() need
307// not be defined, it is inherited from nsINode.
308#define NS_DECL_ADDSIZEOFEXCLUDINGTHISvirtual void AddSizeOfExcludingThis(nsWindowSizes& aSizes
, size_t* aNodeSize) const override;
\
309 virtual void AddSizeOfExcludingThis(nsWindowSizes& aSizes, \
310 size_t* aNodeSize) const override;
311
312// IID for the nsINode interface
313// Must be kept in sync with xpcom/rust/xpcom/src/interfaces/nonidl.rs
314#define NS_INODE_IID{ 0x70ba4547, 0x7699, 0x44fc, { 0xb3, 0x20, 0x52, 0xdb, 0xe3,
0xd1, 0xf9, 0x0a } }
\
315 { \
316 0x70ba4547, 0x7699, 0x44fc, { \
317 0xb3, 0x20, 0x52, 0xdb, 0xe3, 0xd1, 0xf9, 0x0a \
318 } \
319 }
320
321/**
322 * An internal interface that abstracts some DOMNode-related parts that both
323 * nsIContent and Document share. An instance of this interface has a list
324 * of nsIContent children and provides access to them.
325 */
326class nsINode : public mozilla::dom::EventTarget {
327#ifdef MOZ_DIAGNOSTIC_ASSERT_ENABLED1
328 void AssertInvariantsOnNodeInfoChange();
329#endif
330 public:
331 using BoxQuadOptions = mozilla::dom::BoxQuadOptions;
332 using ConvertCoordinateOptions = mozilla::dom::ConvertCoordinateOptions;
333 using DocGroup = mozilla::dom::DocGroup;
334 using Document = mozilla::dom::Document;
335 using DOMPoint = mozilla::dom::DOMPoint;
336 using DOMPointInit = mozilla::dom::DOMPointInit;
337 using DOMQuad = mozilla::dom::DOMQuad;
338 using DOMRectReadOnly = mozilla::dom::DOMRectReadOnly;
339 using OwningNodeOrString = mozilla::dom::OwningNodeOrString;
340 using TextOrElementOrDocument = mozilla::dom::TextOrElementOrDocument;
341 using CallerType = mozilla::dom::CallerType;
342 using ErrorResult = mozilla::ErrorResult;
343
344 // XXXbz Maybe we should codegen a class holding these constants and
345 // inherit from it...
346 static const auto ELEMENT_NODE = mozilla::dom::Node_Binding::ELEMENT_NODE;
347 static const auto ATTRIBUTE_NODE = mozilla::dom::Node_Binding::ATTRIBUTE_NODE;
348 static const auto TEXT_NODE = mozilla::dom::Node_Binding::TEXT_NODE;
349 static const auto CDATA_SECTION_NODE =
350 mozilla::dom::Node_Binding::CDATA_SECTION_NODE;
351 static const auto ENTITY_REFERENCE_NODE =
352 mozilla::dom::Node_Binding::ENTITY_REFERENCE_NODE;
353 static const auto ENTITY_NODE = mozilla::dom::Node_Binding::ENTITY_NODE;
354 static const auto PROCESSING_INSTRUCTION_NODE =
355 mozilla::dom::Node_Binding::PROCESSING_INSTRUCTION_NODE;
356 static const auto COMMENT_NODE = mozilla::dom::Node_Binding::COMMENT_NODE;
357 static const auto DOCUMENT_NODE = mozilla::dom::Node_Binding::DOCUMENT_NODE;
358 static const auto DOCUMENT_TYPE_NODE =
359 mozilla::dom::Node_Binding::DOCUMENT_TYPE_NODE;
360 static const auto DOCUMENT_FRAGMENT_NODE =
361 mozilla::dom::Node_Binding::DOCUMENT_FRAGMENT_NODE;
362 static const auto NOTATION_NODE = mozilla::dom::Node_Binding::NOTATION_NODE;
363 static const auto MAX_NODE_TYPE = NOTATION_NODE;
364
365 void* operator new(size_t aSize, nsNodeInfoManager* aManager);
366 void* operator new(size_t aSize) = delete;
367 void operator delete(void* aPtr);
368
369 template <class T>
370 using Sequence = mozilla::dom::Sequence<T>;
371
372 NS_DECLARE_STATIC_IID_ACCESSOR(NS_INODE_IID)template <typename T, typename U> struct COMTypeInfo;
373
374 // The |aNodeSize| outparam on this function is where the actual node size
375 // value is put. It gets added to the appropriate value within |aSizes| by
376 // AddSizeOfNodeTree().
377 //
378 // Among the sub-classes that inherit (directly or indirectly) from nsINode,
379 // measurement of the following members may be added later if DMD finds it is
380 // worthwhile:
381 // - nsGenericHTMLElement: mForm, mFieldSet
382 // - nsGenericHTMLFrameElement: mFrameLoader (bug 672539)
383 // - HTMLBodyElement: mContentStyleRule
384 // - HTMLDataListElement: mOptions
385 // - HTMLFieldSetElement: mElements, mDependentElements, mFirstLegend
386 // - HTMLFormElement: many!
387 // - HTMLFrameSetElement: mRowSpecs, mColSpecs
388 // - HTMLInputElement: mInputData, mFiles, mFileList, mStaticDocfileList
389 // - nsHTMLMapElement: mAreas
390 // - HTMLMediaElement: many!
391 // - nsHTMLOutputElement: mDefaultValue, mTokenList
392 // - nsHTMLRowElement: mCells
393 // - nsHTMLSelectElement: mOptions, mRestoreState
394 // - nsHTMLTableElement: mTBodies, mRows, mTableInheritedAttributes
395 // - nsHTMLTableSectionElement: mRows
396 // - nsHTMLTextAreaElement: mControllers, mState
397 //
398 // The following members don't need to be measured:
399 // - nsIContent: mPrimaryFrame, because it's non-owning and measured elsewhere
400 //
401 virtual void AddSizeOfExcludingThis(nsWindowSizes& aSizes,
402 size_t* aNodeSize) const;
403
404 // SizeOfIncludingThis doesn't need to be overridden by sub-classes because
405 // sub-classes of nsINode are guaranteed to be laid out in memory in such a
406 // way that |this| points to the start of the allocated object, even in
407 // methods of nsINode's sub-classes, so aSizes.mState.mMallocSizeOf(this) is
408 // always safe to call no matter which object it was invoked on.
409 void AddSizeOfIncludingThis(nsWindowSizes& aSizes, size_t* aNodeSize) const;
410
411 friend class nsNodeWeakReference;
412 friend class nsNodeSupportsWeakRefTearoff;
413 friend class AttrArray;
414
415#ifdef MOZILLA_INTERNAL_API1
416 explicit nsINode(already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo);
417#endif
418
419 virtual ~nsINode();
420
421 bool IsContainerNode() const {
422 return IsElement() || IsDocument() || IsDocumentFragment();
423 }
424
425 /**
426 * Returns true if the node is a HTMLTemplate element.
427 */
428 bool IsTemplateElement() const { return IsHTMLElement(nsGkAtoms::_template); }
429
430 bool IsSlotable() const { return IsElement() || IsText(); }
431
432 /**
433 * Returns true if this is a document node.
434 */
435 bool IsDocument() const {
436 // One less pointer-chase than checking NodeType().
437 return !GetParentNode() && IsInUncomposedDoc();
438 }
439
440 /**
441 * Return this node as a document. Asserts IsDocument().
442 *
443 * This is defined inline in Document.h.
444 */
445 inline Document* AsDocument();
446 inline const Document* AsDocument() const;
447
448 /**
449 * Returns true if this is a document fragment node.
450 */
451 bool IsDocumentFragment() const {
452 return NodeType() == DOCUMENT_FRAGMENT_NODE;
453 }
454
455 virtual bool IsHTMLFormControlElement() const { return false; }
456
457 /**
458 * https://dom.spec.whatwg.org/#concept-tree-inclusive-descendant
459 *
460 * @param aNode must not be nullptr.
461 */
462 bool IsInclusiveDescendantOf(const nsINode* aNode) const;
463
464 /**
465 * https://dom.spec.whatwg.org/#concept-shadow-including-inclusive-descendant
466 *
467 * @param aNode must not be nullptr.
468 */
469 bool IsShadowIncludingInclusiveDescendantOf(const nsINode* aNode) const;
470
471 /**
472 * Returns true if the given node is this node or one of its descendants
473 * in the "flat tree."
474 *
475 * @param aNode must not be nullptr.
476 */
477 bool IsInclusiveFlatTreeDescendantOf(const nsINode* aNode) const;
478
479 /**
480 * Return this node as a document fragment. Asserts IsDocumentFragment().
481 *
482 * This is defined inline in DocumentFragment.h.
483 */
484 inline mozilla::dom::DocumentFragment* AsDocumentFragment();
485 inline const mozilla::dom::DocumentFragment* AsDocumentFragment() const;
486
487 JSObject* WrapObject(JSContext*, JS::Handle<JSObject*> aGivenProto) final;
488
489 /**
490 * Hook for constructing JS::ubi::Concrete specializations for memory
491 * reporting. Specializations are defined in NodeUbiReporting.h.
492 */
493 virtual void ConstructUbiNode(void* storage) = 0;
494
495 /**
496 * returns true if we are in priviliged code or
497 * layout.css.getBoxQuads.enabled == true.
498 */
499 static bool HasBoxQuadsSupport(JSContext* aCx, JSObject* /* unused */);
500
501 protected:
502 /**
503 * WrapNode is called from WrapObject to actually wrap this node, WrapObject
504 * does some additional checks and fix-up that's common to all nodes. WrapNode
505 * should just call the DOM binding's Wrap function.
506 *
507 * aGivenProto is the prototype to use (or null if the default one should be
508 * used) and should just be passed directly on to the DOM binding's Wrap
509 * function.
510 */
511 virtual JSObject* WrapNode(JSContext* aCx,
512 JS::Handle<JSObject*> aGivenProto) = 0;
513
514 public:
515 mozilla::dom::ParentObject GetParentObject()
516 const; // Implemented in Document.h
517
518 /**
519 * Returns the first child of a node or the first child of
520 * a template element's content if the provided node is a
521 * template element.
522 */
523 nsIContent* GetFirstChildOfTemplateOrNode();
524
525 /**
526 * Return the scope chain parent for this node, for use in things
527 * like event handler compilation. Returning null means to use the
528 * global object as the scope chain parent.
529 */
530 virtual nsINode* GetScopeChainParent() const;
531
532 MOZ_CAN_RUN_SCRIPT mozilla::dom::Element* GetParentFlexElement();
533
534 /**
535 * Returns the nearest inclusive open popover for a given node, see
536 * https://html.spec.whatwg.org/multipage/popover.html#nearest-inclusive-open-popover
537 */
538 mozilla::dom::Element* GetNearestInclusiveOpenPopover() const;
539
540 /**
541 * https://html.spec.whatwg.org/multipage/popover.html#nearest-inclusive-target-popover-for-invoker
542 */
543 mozilla::dom::Element* GetNearestInclusiveTargetPopoverForInvoker() const;
544
545 /**
546 * https://html.spec.whatwg.org/multipage/popover.html#popover-target-element
547 */
548 nsGenericHTMLElement* GetEffectivePopoverTargetElement() const;
549
550 /**
551 * https://html.spec.whatwg.org/multipage/popover.html#topmost-clicked-popover
552 */
553 mozilla::dom::Element* GetTopmostClickedPopover() const;
554
555 bool IsNode() const final { return true; }
556
557 NS_IMPL_FROMEVENTTARGET_HELPER(nsINode, IsNode())template <typename T> static auto FromEventTarget( T&
aEventTarget) -> decltype(static_cast< nsINode*>(&
aEventTarget)) { return aEventTarget.IsNode() ? static_cast<
nsINode*>(&aEventTarget) : nullptr; } template <typename
T> static nsINode* FromEventTarget( T* aEventTarget) { do
{ static_assert( mozilla::detail::AssertionConditionType<
decltype(aEventTarget)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(aEventTarget))), 0))) { do {
} while (false); MOZ_ReportAssertionFailure("aEventTarget", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 557); AnnotateMozCrashReason("MOZ_DIAGNOSTIC_ASSERT" "(" "aEventTarget"
")"); do { *((volatile int*)__null) = 557; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false); return FromEventTarget
(*aEventTarget); } template <typename T> static nsINode
* FromEventTargetOrNull( T* aEventTarget) { return aEventTarget
? FromEventTarget(*aEventTarget) : nullptr; } template <typename
T> static auto FromEventTarget(const T& aEventTarget)
-> decltype(static_cast<const nsINode*>(&aEventTarget
)) { return aEventTarget.IsNode() ? static_cast<const nsINode
*>(&aEventTarget) : nullptr; } template <typename T
> static const nsINode* FromEventTarget(const T* aEventTarget
) { do { static_assert( mozilla::detail::AssertionConditionType
<decltype(aEventTarget)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(aEventTarget))), 0))) { do {
} while (false); MOZ_ReportAssertionFailure("aEventTarget", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 557); AnnotateMozCrashReason("MOZ_DIAGNOSTIC_ASSERT" "(" "aEventTarget"
")"); do { *((volatile int*)__null) = 557; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false); return FromEventTarget
(*aEventTarget); } template <typename T> static const nsINode
* FromEventTargetOrNull(const T* aEventTarget) { return aEventTarget
? FromEventTarget(*aEventTarget) : nullptr; } template <typename
T> static nsINode* FromEventTarget(T&& aEventTarget
) { do { static_assert( mozilla::detail::AssertionConditionType
<decltype(!!aEventTarget)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(!!aEventTarget))), 0))) { do
{ } while (false); MOZ_ReportAssertionFailure("!!aEventTarget"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 557); AnnotateMozCrashReason("MOZ_DIAGNOSTIC_ASSERT" "(" "!!aEventTarget"
")"); do { *((volatile int*)__null) = 557; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false); return aEventTarget
->IsNode() ? static_cast<nsINode*>(static_cast<EventTarget
*>(aEventTarget)) : nullptr; } template <typename T>
static nsINode* FromEventTargetOrNull(T&& aEventTarget
) { return aEventTarget ? FromEventTarget(aEventTarget) : nullptr
; }
558
559 /**
560 * Return whether the node is an Element node. Faster than using `NodeType()`.
561 */
562 bool IsElement() const { return GetBoolFlag(NodeIsElement); }
563
564 virtual bool IsTextControlElement() const { return false; }
565 virtual bool IsGenericHTMLFormControlElementWithState() const {
566 return false;
567 }
568
569 // Returns non-null if this element subclasses `LinkStyle`.
570 virtual const mozilla::dom::LinkStyle* AsLinkStyle() const { return nullptr; }
571 mozilla::dom::LinkStyle* AsLinkStyle() {
572 return const_cast<mozilla::dom::LinkStyle*>(
573 static_cast<const nsINode*>(this)->AsLinkStyle());
574 }
575
576 /**
577 * Return this node as an Element. Should only be used for nodes
578 * for which IsElement() is true. This is defined inline in Element.h.
579 */
580 inline mozilla::dom::Element* AsElement();
581 inline const mozilla::dom::Element* AsElement() const;
582
583 /**
584 * Return whether the node is an nsStyledElement instance or not.
585 */
586 virtual bool IsStyledElement() const { return false; }
587
588 /**
589 * Return this node as nsIContent. Should only be used for nodes for which
590 * IsContent() is true.
591 *
592 * The assertion in nsIContent's constructor makes this safe.
593 */
594 nsIContent* AsContent() {
595 MOZ_ASSERT(IsContent())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(IsContent())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(IsContent()))), 0))) { do { }
while (false); MOZ_ReportAssertionFailure("IsContent()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 595); AnnotateMozCrashReason("MOZ_ASSERT" "(" "IsContent()"
")"); do { *((volatile int*)__null) = 595; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
596 return reinterpret_cast<nsIContent*>(this);
597 }
598 const nsIContent* AsContent() const {
599 MOZ_ASSERT(IsContent())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(IsContent())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(IsContent()))), 0))) { do { }
while (false); MOZ_ReportAssertionFailure("IsContent()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 599); AnnotateMozCrashReason("MOZ_ASSERT" "(" "IsContent()"
")"); do { *((volatile int*)__null) = 599; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
600 return reinterpret_cast<const nsIContent*>(this);
601 }
602
603 /*
604 * Return whether the node is a Text node (which might be an actual
605 * textnode, or might be a CDATA section).
606 */
607 bool IsText() const {
608 uint32_t nodeType = NodeType();
609 return nodeType == TEXT_NODE || nodeType == CDATA_SECTION_NODE;
610 }
611
612 /**
613 * Return this node as Text if it is one, otherwise null. This is defined
614 * inline in Text.h.
615 */
616 inline mozilla::dom::Text* GetAsText();
617 inline const mozilla::dom::Text* GetAsText() const;
618
619 /**
620 * Return this node as Text. Asserts IsText(). This is defined inline in
621 * Text.h.
622 */
623 inline mozilla::dom::Text* AsText();
624 inline const mozilla::dom::Text* AsText() const;
625
626 /*
627 * Return whether the node is a ProcessingInstruction node.
628 */
629 bool IsProcessingInstruction() const {
630 return NodeType() == PROCESSING_INSTRUCTION_NODE;
631 }
632
633 /*
634 * Return whether the node is a CharacterData node (text, cdata,
635 * comment, processing instruction)
636 */
637 bool IsCharacterData() const {
638 uint32_t nodeType = NodeType();
639 return nodeType == TEXT_NODE || nodeType == CDATA_SECTION_NODE ||
640 nodeType == PROCESSING_INSTRUCTION_NODE || nodeType == COMMENT_NODE;
641 }
642
643 /**
644 * Return whether the node is a Comment node.
645 */
646 bool IsComment() const { return NodeType() == COMMENT_NODE; }
647
648 /**
649 * Return whether the node is an Attr node.
650 */
651 bool IsAttr() const { return NodeType() == ATTRIBUTE_NODE; }
652
653 /**
654 * Return if this node has any children.
655 */
656 bool HasChildren() const { return !!mFirstChild; }
657
658 /**
659 * Get the number of children
660 * @return the number of children
661 */
662 uint32_t GetChildCount() const { return mChildCount; }
663
664 /**
665 * NOTE: this function is going to be removed soon (hopefully!) Don't use it
666 * in new code.
667 *
668 * Get a child by index
669 * @param aIndex the index of the child to get
670 * @return the child, or null if index out of bounds
671 */
672 nsIContent* GetChildAt_Deprecated(uint32_t aIndex) const;
673
674 /**
675 * Get the index of a child within this content.
676 *
677 * @param aPossibleChild the child to get the index of.
678 * @return the index of the child, or Nothing if not a child. Be aware that
679 * anonymous children (e.g. a <div> child of an <input> element) will
680 * result in Nothing.
681 *
682 * If the return value is Some, then calling GetChildAt_Deprecated() with
683 * that value will return aPossibleChild.
684 */
685 mozilla::Maybe<uint32_t> ComputeIndexOf(const nsINode* aPossibleChild) const;
686
687 /**
688 * Get the index of a child within this content's flat tree children.
689 *
690 * @param aPossibleChild the child to get the index of.
691 * @return the index of the child, or Nothing if not a child. Be aware that
692 * anonymous children (e.g. a <div> child of an <input> element) will
693 * result in Nothing.
694 */
695 mozilla::Maybe<uint32_t> ComputeFlatTreeIndexOf(
696 const nsINode* aPossibleChild) const;
697
698 /**
699 * Get the index of this within parent node (ComputeIndexInParentNode) or
700 * parent content (nsIContent) node (ComputeIndexInParentContent).
701 *
702 * @return the index of this node in the parent, or Nothing there is no
703 * parent (content) node or the parent does not have this node anymore
704 * (e.g., being removed from the parent). Be aware that anonymous
705 * children (e.g. a <div> child of an <input> element) will result in
706 * Nothing.
707 *
708 * If the return value is Some, then calling GetChildAt_Deprecated() with
709 * that value will return this.
710 */
711 mozilla::Maybe<uint32_t> ComputeIndexInParentNode() const;
712 mozilla::Maybe<uint32_t> ComputeIndexInParentContent() const;
713
714 /**
715 * Get the index of a child within this content.
716 *
717 * @param aPossibleChild the child to get the index of.
718 * @return the index of the child, or -1 if not a child. Be aware that
719 * anonymous children (e.g. a <div> child of an <input> element) will
720 * result in -1.
721 *
722 * If the return value is not -1, then calling GetChildAt_Deprecated() with
723 * that value will return aPossibleChild.
724 */
725 int32_t ComputeIndexOf_Deprecated(const nsINode* aPossibleChild) const;
726
727 /**
728 * Returns the "node document" of this node.
729 *
730 * https://dom.spec.whatwg.org/#concept-node-document
731 *
732 * Note that in the case that this node is a document node this method
733 * will return |this|. That is different to the Node.ownerDocument DOM
734 * attribute (implemented by nsINode::GetOwnerDocument) which is specified to
735 * be null in that case:
736 *
737 * https://dom.spec.whatwg.org/#dom-node-ownerdocument
738 *
739 * For all other cases OwnerDoc and GetOwnerDocument behave identically.
740 */
741 Document* OwnerDoc() const MOZ_NONNULL_RETURN__attribute__((returns_nonnull)) {
742 return mNodeInfo->GetDocument();
743 }
744
745 /**
746 * Return the "owner document" of this node as an nsINode*. Implemented
747 * in Document.h.
748 */
749 inline nsINode* OwnerDocAsNode() const MOZ_NONNULL_RETURN__attribute__((returns_nonnull));
750
751 /**
752 * Returns true if the content has an ancestor that is a document.
753 *
754 * @return whether this content is in a document tree
755 */
756 bool IsInUncomposedDoc() const { return GetBoolFlag(IsInDocument); }
757
758 /**
759 * Get the document that this content is currently in, if any. This will be
760 * null if the content has no ancestor that is a document.
761 *
762 * @return the current document
763 */
764
765 Document* GetUncomposedDoc() const {
766 return IsInUncomposedDoc() ? OwnerDoc() : nullptr;
767 }
768
769 /**
770 * Returns true if we're connected, and thus GetComposedDoc() would return a
771 * non-null value.
772 */
773 bool IsInComposedDoc() const { return GetBoolFlag(IsConnected); }
774
775 /**
776 * This method returns the owner document if the node is connected to it
777 * (as defined in the DOM spec), otherwise it returns null.
778 * In other words, returns non-null even in the case the node is in
779 * Shadow DOM, if there is a possibly shadow boundary crossing path from
780 * the node to its owner document.
781 */
782 Document* GetComposedDoc() const {
783 return IsInComposedDoc() ? OwnerDoc() : nullptr;
784 }
785
786 /**
787 * Returns OwnerDoc() if the node is in uncomposed document and ShadowRoot if
788 * the node is in Shadow DOM.
789 */
790 mozilla::dom::DocumentOrShadowRoot* GetContainingDocumentOrShadowRoot() const;
791
792 /**
793 * Returns OwnerDoc() if the node is in uncomposed document and ShadowRoot if
794 * the node is in Shadow DOM and is in composed document.
795 */
796 mozilla::dom::DocumentOrShadowRoot* GetUncomposedDocOrConnectedShadowRoot()
797 const;
798
799 /**
800 * To be called when reference count of the node drops to zero.
801 */
802 void LastRelease();
803
804 /**
805 * The values returned by this function are the ones defined for
806 * Node.nodeType
807 */
808 uint16_t NodeType() const { return mNodeInfo->NodeType(); }
809 const nsString& NodeName() const { return mNodeInfo->NodeName(); }
810 const nsString& LocalName() const { return mNodeInfo->LocalName(); }
811
812 /**
813 * Get the NodeInfo for this element
814 * @return the nodes node info
815 */
816 inline mozilla::dom::NodeInfo* NodeInfo() const { return mNodeInfo; }
817
818 /**
819 * Called when we have been adopted, and the information of the
820 * node has been changed.
821 *
822 * The new document can be reached via OwnerDoc().
823 *
824 * If you override this method,
825 * please call up to the parent NodeInfoChanged.
826 *
827 * If you change this, change also the similar method in Link.
828 */
829 virtual void NodeInfoChanged(Document* aOldDoc) {
830#ifdef MOZ_DIAGNOSTIC_ASSERT_ENABLED1
831 AssertInvariantsOnNodeInfoChange();
832#endif
833 }
834
835 inline bool IsInNamespace(int32_t aNamespace) const {
836 return mNodeInfo->NamespaceID() == aNamespace;
837 }
838
839 /**
840 * Returns the DocGroup of the "node document" of this node.
841 */
842 DocGroup* GetDocGroup() const;
843
844 /**
845 * Print a debugger friendly descriptor of this element. This will describe
846 * the position of this element in the document.
847 */
848 friend std::ostream& operator<<(std::ostream& aStream, const nsINode& aNode);
849
850 protected:
851 // These 2 methods are useful for the recursive templates IsHTMLElement,
852 // IsSVGElement, etc.
853 inline bool IsNodeInternal() const { return false; }
854
855 template <typename First, typename... Args>
856 inline bool IsNodeInternal(First aFirst, Args... aArgs) const {
857 return mNodeInfo->Equals(aFirst) || IsNodeInternal(aArgs...);
858 }
859
860 public:
861 inline bool IsHTMLElement() const {
862 return IsElement() && IsInNamespace(kNameSpaceID_XHTML3);
863 }
864
865 inline bool IsHTMLElement(const nsAtom* aTag) const {
866 return IsElement() && mNodeInfo->Equals(aTag, kNameSpaceID_XHTML3);
867 }
868
869 template <typename First, typename... Args>
870 inline bool IsAnyOfHTMLElements(First aFirst, Args... aArgs) const {
871 return IsHTMLElement() && IsNodeInternal(aFirst, aArgs...);
872 }
873
874 inline bool IsSVGElement() const {
875 return IsElement() && IsInNamespace(kNameSpaceID_SVG9);
876 }
877
878 inline bool IsSVGElement(const nsAtom* aTag) const {
879 return IsElement() && mNodeInfo->Equals(aTag, kNameSpaceID_SVG9);
880 }
881
882 template <typename First, typename... Args>
883 inline bool IsAnyOfSVGElements(First aFirst, Args... aArgs) const {
884 return IsSVGElement() && IsNodeInternal(aFirst, aArgs...);
885 }
886
887 virtual bool IsSVGAnimationElement() const { return false; }
888 virtual bool IsSVGComponentTransferFunctionElement() const { return false; }
889 virtual bool IsSVGFilterPrimitiveElement() const { return false; }
890 virtual bool IsSVGFilterPrimitiveChildElement() const { return false; }
891 virtual bool IsSVGGeometryElement() const { return false; }
892 virtual bool IsSVGGraphicsElement() const { return false; }
893
894 inline bool IsXULElement() const {
895 return IsElement() && IsInNamespace(kNameSpaceID_XUL8);
896 }
897
898 inline bool IsXULElement(const nsAtom* aTag) const {
899 return IsElement() && mNodeInfo->Equals(aTag, kNameSpaceID_XUL8);
900 }
901
902 template <typename First, typename... Args>
903 inline bool IsAnyOfXULElements(First aFirst, Args... aArgs) const {
904 return IsXULElement() && IsNodeInternal(aFirst, aArgs...);
905 }
906
907 inline bool IsMathMLElement() const {
908 return IsElement() && IsInNamespace(kNameSpaceID_MathML6);
909 }
910
911 inline bool IsMathMLElement(const nsAtom* aTag) const {
912 return IsElement() && mNodeInfo->Equals(aTag, kNameSpaceID_MathML6);
913 }
914
915 template <typename First, typename... Args>
916 inline bool IsAnyOfMathMLElements(First aFirst, Args... aArgs) const {
917 return IsMathMLElement() && IsNodeInternal(aFirst, aArgs...);
918 }
919
920 bool IsShadowRoot() const {
921 const bool isShadowRoot = IsInShadowTree() && !GetParentNode();
922 MOZ_ASSERT_IF(isShadowRoot, IsDocumentFragment())do { if (isShadowRoot) { do { static_assert( mozilla::detail::
AssertionConditionType<decltype(IsDocumentFragment())>::
isValid, "invalid assertion condition"); if ((__builtin_expect
(!!(!(!!(IsDocumentFragment()))), 0))) { do { } while (false)
; MOZ_ReportAssertionFailure("IsDocumentFragment()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 922); AnnotateMozCrashReason("MOZ_ASSERT" "(" "IsDocumentFragment()"
")"); do { *((volatile int*)__null) = 922; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false); } } while (
false)
;
923 return isShadowRoot;
924 }
925
926 bool IsHTMLHeadingElement() const {
927 return IsAnyOfHTMLElements(nsGkAtoms::h1, nsGkAtoms::h2, nsGkAtoms::h3,
928 nsGkAtoms::h4, nsGkAtoms::h5, nsGkAtoms::h6);
929 }
930
931 /**
932 * Check whether the conditional processing attributes other than
933 * systemLanguage "return true" if they apply to and are specified
934 * on the given SVG element. Returns true if this element should be
935 * rendered, false if it should not.
936 */
937 virtual bool PassesConditionalProcessingTests() const { return true; }
938
939 /**
940 * Insert a content node before another or at the end.
941 * This method handles calling BindToTree on the child appropriately.
942 *
943 * @param aKid the content to insert
944 * @param aBeforeThis an existing node. Use nullptr if you want to
945 * add aKid at the end.
946 * @param aNotify whether to notify the document (current document for
947 * nsIContent, and |this| for Document) that the insert has occurred
948 * @param aRv The error, if any.
949 * Throw NS_ERROR_DOM_HIERARCHY_REQUEST_ERR if one attempts to have
950 * more than one element node as a child of a document. Doing this
951 * will also assert -- you shouldn't be doing it! Check with
952 * Document::GetRootElement() first if you're not sure. Apart from
953 * this one constraint, this doesn't do any checking on whether aKid is
954 * a valid child of |this|.
955 * Throw NS_ERROR_OUT_OF_MEMORY in some cases (from BindToTree).
956 */
957 virtual void InsertChildBefore(nsIContent* aKid, nsIContent* aBeforeThis,
958 bool aNotify, mozilla::ErrorResult& aRv);
959
960 /**
961 * Append a content node to the end of the child list. This method handles
962 * calling BindToTree on the child appropriately.
963 *
964 * @param aKid the content to append
965 * @param aNotify whether to notify the document (current document for
966 * nsIContent, and |this| for Document) that the append has occurred
967 * @param aRv The error, if any.
968 * Throw NS_ERROR_DOM_HIERARCHY_REQUEST_ERR if one attempts to have
969 * more than one element node as a child of a document. Doing this
970 * will also assert -- you shouldn't be doing it! Check with
971 * Document::GetRootElement() first if you're not sure. Apart from
972 * this one constraint, this doesn't do any checking on whether aKid is
973 * a valid child of |this|.
974 * Throw NS_ERROR_OUT_OF_MEMORY in some cases (from BindToTree).
975 */
976 void AppendChildTo(nsIContent* aKid, bool aNotify,
977 mozilla::ErrorResult& aRv) {
978 InsertChildBefore(aKid, nullptr, aNotify, aRv);
979 }
980
981 /**
982 * Remove a child from this node. This method handles calling UnbindFromTree
983 * on the child appropriately.
984 *
985 * @param aKid the content to remove
986 * @param aNotify whether to notify the document (current document for
987 * nsIContent, and |this| for Document) that the remove has occurred
988 */
989 virtual void RemoveChildNode(nsIContent* aKid, bool aNotify);
990
991 /**
992 * Get a property associated with this node.
993 *
994 * @param aPropertyName name of property to get.
995 * @param aStatus out parameter for storing resulting status.
996 * Set to NS_PROPTABLE_PROP_NOT_THERE if the property
997 * is not set.
998 * @return the property. Null if the property is not set
999 * (though a null return value does not imply the
1000 * property was not set, i.e. it can be set to null).
1001 */
1002 void* GetProperty(const nsAtom* aPropertyName,
1003 nsresult* aStatus = nullptr) const;
1004
1005 /**
1006 * Set a property to be associated with this node. This will overwrite an
1007 * existing value if one exists. The existing value is destroyed using the
1008 * destructor function given when that value was set.
1009 *
1010 * @param aPropertyName name of property to set.
1011 * @param aValue new value of property.
1012 * @param aDtor destructor function to be used when this property
1013 * is destroyed.
1014 * @param aTransfer if true the property will not be deleted when the
1015 * ownerDocument of the node changes, if false it
1016 * will be deleted.
1017 *
1018 * @return NS_PROPTABLE_PROP_OVERWRITTEN (success value) if the property
1019 * was already set
1020 * @throws NS_ERROR_OUT_OF_MEMORY if that occurs
1021 */
1022 nsresult SetProperty(nsAtom* aPropertyName, void* aValue,
1023 NSPropertyDtorFunc aDtor = nullptr,
1024 bool aTransfer = false);
1025
1026 /**
1027 * A generic destructor for property values allocated with new.
1028 */
1029 template <class T>
1030 static void DeleteProperty(void*, nsAtom*, void* aPropertyValue, void*) {
1031 delete static_cast<T*>(aPropertyValue);
1032 }
1033
1034 /**
1035 * Removes a property associated with this node. The value is destroyed using
1036 * the destruction function given when that value was set.
1037 *
1038 * @param aPropertyName name of property to destroy.
1039 */
1040 void RemoveProperty(const nsAtom* aPropertyName);
1041
1042 /**
1043 * Take a property associated with this node. The value will not be destroyed
1044 * but rather returned. It is the caller's responsibility to destroy the value
1045 * after that point.
1046 *
1047 * @param aPropertyName name of property to unset.
1048 * @param aStatus out parameter for storing resulting status.
1049 * Set to NS_PROPTABLE_PROP_NOT_THERE if the property
1050 * is not set.
1051 * @return the property. Null if the property is not set
1052 * (though a null return value does not imply the
1053 * property was not set, i.e. it can be set to null).
1054 */
1055 void* TakeProperty(const nsAtom* aPropertyName, nsresult* aStatus = nullptr);
1056
1057 bool HasProperties() const { return HasFlag(NODE_HAS_PROPERTIES); }
1058
1059 /**
1060 * Return the principal of this node. This is guaranteed to never be a null
1061 * pointer.
1062 */
1063 nsIPrincipal* NodePrincipal() const {
1064 return mNodeInfo->NodeInfoManager()->DocumentPrincipal();
1065 }
1066
1067 /**
1068 * Return the CSP of this node's document, if any.
1069 */
1070 nsIContentSecurityPolicy* GetCsp() const;
1071
1072 /**
1073 * Get the parent nsIContent for this node.
1074 * @return the parent, or null if no parent or the parent is not an nsIContent
1075 */
1076 nsIContent* GetParent() const {
1077 return MOZ_LIKELY(GetBoolFlag(ParentIsContent))(__builtin_expect(!!(GetBoolFlag(ParentIsContent)), 1)) ? mParent->AsContent()
1078 : nullptr;
1079 }
1080
1081 /**
1082 * Get the parent nsINode for this node. This can be either an nsIContent, a
1083 * Document or an Attr.
1084 * @return the parent node
1085 */
1086 nsINode* GetParentNode() const { return mParent; }
1087
1088 private:
1089 nsIContent* DoGetShadowHost() const;
1090
1091 public:
1092 nsINode* GetParentOrShadowHostNode() const {
1093 if (MOZ_LIKELY(mParent)(__builtin_expect(!!(mParent), 1))) {
1094 return mParent;
1095 }
1096 // We could put this in nsIContentInlines.h or such to avoid this
1097 // reinterpret_cast, but it doesn't seem worth it.
1098 return IsInShadowTree() ? reinterpret_cast<nsINode*>(DoGetShadowHost())
1099 : nullptr;
1100 }
1101
1102 enum FlattenedParentType { eNormal, eForStyle, eForSelection };
1103
1104 /**
1105 * Returns the node that is the parent of this node in the flattened
1106 * tree. This differs from the normal parent if the node is filtered
1107 * into an insertion point, or if the node is a direct child of a
1108 * shadow root.
1109 *
1110 * @return the flattened tree parent
1111 */
1112 inline nsINode* GetFlattenedTreeParentNode() const;
1113
1114 nsINode* GetFlattenedTreeParentNodeNonInline() const;
1115
1116 /**
1117 * Like GetFlattenedTreeParentNode, but returns the document for any native
1118 * anonymous content that was generated for ancestor frames of the document
1119 * element's primary frame, such as scrollbar elements created by the root
1120 * scroll frame.
1121 */
1122 inline nsINode* GetFlattenedTreeParentNodeForStyle() const;
1123
1124 /**
1125 * Similar to GetFlattenedTreeParentNode, it does two things differently
1126 * 1. For contents that are not in the flattened tree, use its
1127 * parent rather than nullptr.
1128 * 2. For contents that are slotted into a UA shadow tree, use its
1129 * parent rather than the slot element.
1130 */
1131 inline nsIContent* GetFlattenedTreeParentNodeForSelection() const;
1132
1133 inline mozilla::dom::Element* GetFlattenedTreeParentElement() const;
1134 inline mozilla::dom::Element* GetFlattenedTreeParentElementForStyle() const;
1135
1136 /**
1137 * Get the parent nsINode for this node if it is an Element.
1138 *
1139 * Defined inline in Element.h
1140 *
1141 * @return the parent node
1142 */
1143 inline mozilla::dom::Element* GetParentElement() const;
1144
1145 /**
1146 * Get the parent Element of this node, traversing over a ShadowRoot
1147 * to its host if necessary.
1148 */
1149 mozilla::dom::Element* GetParentElementCrossingShadowRoot() const;
1150
1151 /**
1152 * Get closest element node for the node. Meaning that if the node is an
1153 * element node, returns itself. Otherwise, returns parent element or null.
1154 */
1155 inline mozilla::dom::Element* GetAsElementOrParentElement() const;
1156
1157 /**
1158 * Get the root of the subtree this node belongs to. This never returns
1159 * null. It may return 'this' (e.g. for document nodes, and nodes that
1160 * are the roots of disconnected subtrees).
1161 */
1162 nsINode* SubtreeRoot() const;
1163
1164 /*
1165 * Get context object's shadow-including root if options's composed is true,
1166 * and context object's root otherwise.
1167 */
1168 nsINode* GetRootNode(const mozilla::dom::GetRootNodeOptions& aOptions);
1169
1170 virtual mozilla::EventListenerManager* GetExistingListenerManager()
1171 const override;
1172 virtual mozilla::EventListenerManager* GetOrCreateListenerManager() override;
1173
1174 mozilla::Maybe<mozilla::dom::EventCallbackDebuggerNotificationType>
1175 GetDebuggerNotificationType() const override;
1176
1177 bool ComputeDefaultWantsUntrusted(mozilla::ErrorResult& aRv) final;
1178
1179 virtual bool IsApzAware() const override;
1180
1181 virtual nsPIDOMWindowOuter* GetOwnerGlobalForBindingsInternal() override;
1182 virtual nsIGlobalObject* GetOwnerGlobal() const override;
1183
1184 using mozilla::dom::EventTarget::DispatchEvent;
1185 // TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230)
1186 MOZ_CAN_RUN_SCRIPT_BOUNDARY bool DispatchEvent(
1187 mozilla::dom::Event& aEvent, mozilla::dom::CallerType aCallerType,
1188 mozilla::ErrorResult& aRv) override;
1189
1190 MOZ_CAN_RUN_SCRIPT
1191 nsresult PostHandleEvent(mozilla::EventChainPostVisitor& aVisitor) override;
1192
1193 /**
1194 * Adds a mutation observer to be notified when this node, or any of its
1195 * descendants, are modified. The node will hold a weak reference to the
1196 * observer, which means that it is the responsibility of the observer to
1197 * remove itself in case it dies before the node. If an observer is added
1198 * while observers are being notified, it may also be notified. In general,
1199 * adding observers while inside a notification is not a good idea. An
1200 * observer that is already observing the node must not be added without
1201 * being removed first.
1202 *
1203 * For mutation observers that implement nsIAnimationObserver, use
1204 * AddAnimationObserver instead.
1205 */
1206 void AddMutationObserver(nsIMutationObserver* aMutationObserver) {
1207 nsSlots* s = Slots();
1208 if (aMutationObserver) {
1209 NS_ASSERTION(!s->mMutationObservers.contains(aMutationObserver),do { if (!(!s->mMutationObservers.contains(aMutationObserver
))) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Observer already in the list"
, "!s->mMutationObservers.contains(aMutationObserver)", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1210); MOZ_PretendNoReturn(); } } while (0)
1210 "Observer already in the list")do { if (!(!s->mMutationObservers.contains(aMutationObserver
))) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Observer already in the list"
, "!s->mMutationObservers.contains(aMutationObserver)", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1210); MOZ_PretendNoReturn(); } } while (0)
;
1211
1212 s->mMutationObservers.pushBack(aMutationObserver);
1213 }
1214 }
1215
1216 void AddMutationObserver(nsMultiMutationObserver* aMultiMutationObserver);
1217
1218 /**
1219 * Same as above, but only adds the observer if its not observing
1220 * the node already.
1221 *
1222 * For mutation observers that implement nsIAnimationObserver, use
1223 * AddAnimationObserverUnlessExists instead.
1224 */
1225 void AddMutationObserverUnlessExists(nsIMutationObserver* aMutationObserver) {
1226 nsSlots* s = Slots();
1227 if (aMutationObserver &&
1228 !s->mMutationObservers.contains(aMutationObserver)) {
1229 s->mMutationObservers.pushBack(aMutationObserver);
1230 }
1231 }
1232
1233 void AddMutationObserverUnlessExists(
1234 nsMultiMutationObserver* aMultiMutationObserver);
1235 /**
1236 * Same as AddMutationObserver, but for nsIAnimationObservers. This
1237 * additionally records on the document that animation observers have
1238 * been registered, which is used to determine whether notifications
1239 * must be fired when animations are added, removed or changed.
1240 */
1241 void AddAnimationObserver(nsIAnimationObserver* aAnimationObserver);
1242
1243 /**
1244 * Same as above, but only adds the observer if its not observing
1245 * the node already.
1246 */
1247 void AddAnimationObserverUnlessExists(
1248 nsIAnimationObserver* aAnimationObserver);
1249
1250 /**
1251 * Removes a mutation observer.
1252 */
1253 void RemoveMutationObserver(nsIMutationObserver* aMutationObserver) {
1254 nsSlots* s = GetExistingSlots();
1255 if (s) {
1256 s->mMutationObservers.remove(aMutationObserver);
1257 }
1258 }
1259
1260 void RemoveMutationObserver(nsMultiMutationObserver* aMultiMutationObserver);
1261
1262 mozilla::SafeDoublyLinkedList<nsIMutationObserver>* GetMutationObservers();
1263
1264 /**
1265 * Helper methods to access ancestor node(s) of type T.
1266 * The implementations of the methods are in mozilla/dom/AncestorIterator.h.
1267 */
1268 template <typename T>
1269 inline mozilla::dom::AncestorsOfTypeIterator<T> AncestorsOfType() const;
1270
1271 template <typename T>
1272 inline mozilla::dom::InclusiveAncestorsOfTypeIterator<T>
1273 InclusiveAncestorsOfType() const;
1274
1275 template <typename T>
1276 inline mozilla::dom::FlatTreeAncestorsOfTypeIterator<T>
1277 FlatTreeAncestorsOfType() const;
1278
1279 template <typename T>
1280 inline mozilla::dom::InclusiveFlatTreeAncestorsOfTypeIterator<T>
1281 InclusiveFlatTreeAncestorsOfType() const;
1282
1283 template <typename T>
1284 T* FirstAncestorOfType() const;
1285
1286 private:
1287 /**
1288 * Walks aNode, its attributes and, if aDeep is true, its descendant nodes.
1289 * If aClone is true the nodes will be cloned. If aNewNodeInfoManager is
1290 * not null, it is used to create new nodeinfos for the nodes. Also reparents
1291 * the XPConnect wrappers for the nodes into aReparentScope if non-null.
1292 *
1293 * @param aNode Node to adopt/clone.
1294 * @param aClone If true the node will be cloned and the cloned node will
1295 * be returned.
1296 * @param aDeep If true the function will be called recursively on
1297 * descendants of the node
1298 * @param aNewNodeInfoManager The nodeinfo manager to use to create new
1299 * nodeinfos for aNode and its attributes and
1300 * descendants. May be null if the nodeinfos
1301 * shouldn't be changed.
1302 * @param aReparentScope Scope into which wrappers should be reparented, or
1303 * null if no reparenting should be done.
1304 * @param aParent If aClone is true the cloned node will be appended to
1305 * aParent's children. May be null. If not null then aNode
1306 * must be an nsIContent.
1307 * @param aError The error, if any.
1308 *
1309 * @return If aClone is true then the cloned node will be returned,
1310 * unless an error occurred. In error conditions, null
1311 * will be returned.
1312 */
1313 static already_AddRefed<nsINode> CloneAndAdopt(
1314 nsINode* aNode, bool aClone, bool aDeep,
1315 nsNodeInfoManager* aNewNodeInfoManager,
1316 JS::Handle<JSObject*> aReparentScope, nsINode* aParent,
1317 mozilla::ErrorResult& aError);
1318
1319 public:
1320 /**
1321 * Walks the node, its attributes and descendant nodes. If aNewNodeInfoManager
1322 * is not null, it is used to create new nodeinfos for the nodes. Also
1323 * reparents the XPConnect wrappers for the nodes into aReparentScope if
1324 * non-null.
1325 *
1326 * @param aNewNodeInfoManager The nodeinfo manager to use to create new
1327 * nodeinfos for the node and its attributes and
1328 * descendants. May be null if the nodeinfos
1329 * shouldn't be changed.
1330 * @param aReparentScope New scope for the wrappers, or null if no reparenting
1331 * should be done.
1332 * @param aError The error, if any.
1333 */
1334 void Adopt(nsNodeInfoManager* aNewNodeInfoManager,
1335 JS::Handle<JSObject*> aReparentScope,
1336 mozilla::ErrorResult& aError);
1337
1338 /**
1339 * Clones the node, its attributes and, if aDeep is true, its descendant nodes
1340 * If aNewNodeInfoManager is not null, it is used to create new nodeinfos for
1341 * the clones.
1342 *
1343 * @param aDeep If true the function will be called recursively on
1344 * descendants of the node
1345 * @param aNewNodeInfoManager The nodeinfo manager to use to create new
1346 * nodeinfos for the node and its attributes and
1347 * descendants. May be null if the nodeinfos
1348 * shouldn't be changed.
1349 * @param aError The error, if any.
1350 *
1351 * @return The newly created node. Null in error conditions.
1352 */
1353 already_AddRefed<nsINode> Clone(bool aDeep,
1354 nsNodeInfoManager* aNewNodeInfoManager,
1355 mozilla::ErrorResult& aError);
1356
1357 /**
1358 * Clones this node. This needs to be overriden by all node classes. aNodeInfo
1359 * should be identical to this node's nodeInfo, except for the document which
1360 * may be different. When cloning an element, all attributes of the element
1361 * will be cloned. The children of the node will not be cloned.
1362 *
1363 * @param aNodeInfo the nodeinfo to use for the clone
1364 * @param aResult the clone
1365 */
1366 virtual nsresult Clone(mozilla::dom::NodeInfo*, nsINode** aResult) const = 0;
1367
1368 // This class can be extended by subclasses that wish to store more
1369 // information in the slots.
1370 class nsSlots {
1371 public:
1372 nsSlots();
1373
1374 // If needed we could remove the vtable pointer this dtor causes by
1375 // putting a DestroySlots function on nsINode
1376 virtual ~nsSlots();
1377
1378 virtual void Traverse(nsCycleCollectionTraversalCallback&);
1379 virtual void Unlink(nsINode&);
1380
1381 /**
1382 * A list of mutation observers
1383 */
1384 mozilla::SafeDoublyLinkedList<nsIMutationObserver> mMutationObservers;
1385
1386 /**
1387 * An object implementing NodeList for this content (childNodes)
1388 * @see NodeList
1389 * @see nsGenericHTMLElement::GetChildNodes
1390 */
1391 RefPtr<nsAttrChildContentList> mChildNodes;
1392
1393 /**
1394 * Weak reference to this node. This is cleared by the destructor of
1395 * nsNodeWeakReference.
1396 */
1397 nsNodeWeakReference* MOZ_NON_OWNING_REF mWeakReference;
1398
1399 /**
1400 * A set of ranges which are in the selection and which have this node as
1401 * their endpoints' closest common inclusive ancestor
1402 * (https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor). This is
1403 * a UniquePtr instead of just a LinkedList, because that prevents us from
1404 * pushing DOMSlots up to the next allocation bucket size, at the cost of
1405 * some complexity.
1406 */
1407 mozilla::UniquePtr<mozilla::LinkedList<mozilla::dom::AbstractRange>>
1408 mClosestCommonInclusiveAncestorRanges;
1409 };
1410
1411 /**
1412 * Functions for managing flags and slots
1413 */
1414#ifdef DEBUG1
1415 nsSlots* DebugGetSlots() { return Slots(); }
1416#endif
1417
1418 void SetFlags(FlagsType aFlagsToSet) {
1419 NS_ASSERTION(do { if (!(!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT
| NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES
| NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Flag only permitted on nsIContent nodes"
, "!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT | NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES | NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1425); MOZ_PretendNoReturn(); } } while (0)
1420 !(aFlagsToSet &do { if (!(!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT
| NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES
| NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Flag only permitted on nsIContent nodes"
, "!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT | NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES | NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1425); MOZ_PretendNoReturn(); } } while (0)
1421 (NODE_IS_NATIVE_ANONYMOUS_ROOT | NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE |do { if (!(!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT
| NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES
| NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Flag only permitted on nsIContent nodes"
, "!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT | NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES | NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1425); MOZ_PretendNoReturn(); } } while (0)
1422 NODE_DESCENDANTS_NEED_FRAMES | NODE_NEEDS_FRAME |do { if (!(!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT
| NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES
| NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Flag only permitted on nsIContent nodes"
, "!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT | NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES | NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1425); MOZ_PretendNoReturn(); } } while (0)
1423 NODE_HAS_BEEN_IN_UA_WIDGET)) ||do { if (!(!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT
| NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES
| NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Flag only permitted on nsIContent nodes"
, "!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT | NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES | NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1425); MOZ_PretendNoReturn(); } } while (0)
1424 IsContent(),do { if (!(!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT
| NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES
| NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Flag only permitted on nsIContent nodes"
, "!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT | NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES | NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1425); MOZ_PretendNoReturn(); } } while (0)
1425 "Flag only permitted on nsIContent nodes")do { if (!(!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT
| NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES
| NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Flag only permitted on nsIContent nodes"
, "!(aFlagsToSet & (NODE_IS_NATIVE_ANONYMOUS_ROOT | NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE | NODE_DESCENDANTS_NEED_FRAMES | NODE_NEEDS_FRAME | NODE_HAS_BEEN_IN_UA_WIDGET)) || IsContent()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1425); MOZ_PretendNoReturn(); } } while (0)
;
1426 nsWrapperCache::SetFlags(aFlagsToSet);
1427 }
1428
1429 void UnsetFlags(FlagsType aFlagsToUnset) {
1430 NS_ASSERTION(!(aFlagsToUnset & (NODE_HAS_BEEN_IN_UA_WIDGET |do { if (!(!(aFlagsToUnset & (NODE_HAS_BEEN_IN_UA_WIDGET |
NODE_IS_NATIVE_ANONYMOUS_ROOT)))) { NS_DebugBreak(NS_DEBUG_ASSERTION
, "Trying to unset write-only flags", "!(aFlagsToUnset & (NODE_HAS_BEEN_IN_UA_WIDGET | NODE_IS_NATIVE_ANONYMOUS_ROOT))"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1432); MOZ_PretendNoReturn(); } } while (0)
1431 NODE_IS_NATIVE_ANONYMOUS_ROOT)),do { if (!(!(aFlagsToUnset & (NODE_HAS_BEEN_IN_UA_WIDGET |
NODE_IS_NATIVE_ANONYMOUS_ROOT)))) { NS_DebugBreak(NS_DEBUG_ASSERTION
, "Trying to unset write-only flags", "!(aFlagsToUnset & (NODE_HAS_BEEN_IN_UA_WIDGET | NODE_IS_NATIVE_ANONYMOUS_ROOT))"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1432); MOZ_PretendNoReturn(); } } while (0)
1432 "Trying to unset write-only flags")do { if (!(!(aFlagsToUnset & (NODE_HAS_BEEN_IN_UA_WIDGET |
NODE_IS_NATIVE_ANONYMOUS_ROOT)))) { NS_DebugBreak(NS_DEBUG_ASSERTION
, "Trying to unset write-only flags", "!(aFlagsToUnset & (NODE_HAS_BEEN_IN_UA_WIDGET | NODE_IS_NATIVE_ANONYMOUS_ROOT))"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1432); MOZ_PretendNoReturn(); } } while (0)
;
1433 nsWrapperCache::UnsetFlags(aFlagsToUnset);
1434 }
1435
1436 void SetEditableFlag(bool aEditable) {
1437 if (aEditable) {
1438 SetFlags(NODE_IS_EDITABLE);
1439 } else {
1440 UnsetFlags(NODE_IS_EDITABLE);
1441 }
1442 }
1443
1444 inline bool IsEditable() const;
1445
1446 /**
1447 * Check if this node is an editing host. For avoiding confusion, this always
1448 * returns false if the node is in the design mode document.
1449 */
1450 inline bool IsEditingHost() const;
1451
1452 /**
1453 * Check if this node is in design mode or not. When this returns true and:
1454 * - if this is a Document node, it's the design mode root.
1455 * - if this is a content node, it's connected, it's not in a shadow tree
1456 * (except shadow tree for UI widget and native anonymous subtree) and its
1457 * uncomposed document is in design mode.
1458 * Note that returning true does NOT mean the node or its children is
1459 * editable. E.g., when this node is in a shadow tree of a UA widget and its
1460 * host is in design mode.
1461 */
1462 inline bool IsInDesignMode() const;
1463
1464 /**
1465 * Returns true if |this| or any of its ancestors is native anonymous.
1466 */
1467 bool IsInNativeAnonymousSubtree() const {
1468 return HasFlag(NODE_IS_IN_NATIVE_ANONYMOUS_SUBTREE);
1469 }
1470
1471 /**
1472 * If |this| or any ancestor is native anonymous, return the root of the
1473 * native anonymous subtree. Note that in case of nested native anonymous
1474 * content, this returns the innermost root, not the outermost.
1475 */
1476 nsIContent* GetClosestNativeAnonymousSubtreeRoot() const {
1477 if (!IsInNativeAnonymousSubtree()) {
1478 MOZ_ASSERT(!HasBeenInUAWidget(), "UA widget implies anonymous")do { static_assert( mozilla::detail::AssertionConditionType<
decltype(!HasBeenInUAWidget())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(!HasBeenInUAWidget()))), 0))
) { do { } while (false); MOZ_ReportAssertionFailure("!HasBeenInUAWidget()"
" (" "UA widget implies anonymous" ")", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1478); AnnotateMozCrashReason("MOZ_ASSERT" "(" "!HasBeenInUAWidget()"
") (" "UA widget implies anonymous" ")"); do { *((volatile int
*)__null) = 1478; __attribute__((nomerge)) ::abort(); } while
(false); } } while (false)
;
1479 return nullptr;
1480 }
1481 MOZ_ASSERT(IsContent(), "How did non-content end up in NAC?")do { static_assert( mozilla::detail::AssertionConditionType<
decltype(IsContent())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(IsContent()))), 0))) { do { }
while (false); MOZ_ReportAssertionFailure("IsContent()" " ("
"How did non-content end up in NAC?" ")", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1481); AnnotateMozCrashReason("MOZ_ASSERT" "(" "IsContent()"
") (" "How did non-content end up in NAC?" ")"); do { *((volatile
int*)__null) = 1481; __attribute__((nomerge)) ::abort(); } while
(false); } } while (false)
;
1482 if (HasBeenInUAWidget()) {
1483 // reinterpret_cast because in this header we don't know ShadowRoot is an
1484 // nsIContent. ShadowRoot constructor asserts this is correct.
1485 return reinterpret_cast<nsIContent*>(GetContainingShadow());
1486 }
1487 for (const nsINode* node = this; node; node = node->GetParentNode()) {
1488 if (node->IsRootOfNativeAnonymousSubtree()) {
1489 return const_cast<nsINode*>(node)->AsContent();
1490 }
1491 }
1492 // FIXME(emilio): This should not happen, usually, but editor removes nodes
1493 // in native anonymous subtrees, and we don't clean nodes from the current
1494 // event content stack from ContentRemoved, so it can actually happen, see
1495 // bug 1510208.
1496 NS_WARNING("GetClosestNativeAnonymousSubtreeRoot on disconnected NAC!")NS_DebugBreak(NS_DEBUG_WARNING, "GetClosestNativeAnonymousSubtreeRoot on disconnected NAC!"
, nullptr, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1496)
;
1497 return nullptr;
1498 }
1499
1500 /**
1501 * If |this| or any ancestor is native anonymous, return the parent of the
1502 * native anonymous subtree. Note that in case of nested native anonymous
1503 * content, this returns the parent or host of the innermost root, not the
1504 * outermost.
1505 */
1506 nsIContent* GetClosestNativeAnonymousSubtreeRootParentOrHost() const {
1507 // We could put this in nsIContentInlines.h or such to avoid this
1508 // reinterpret_cast, but it doesn't seem worth it.
1509 const auto* root = reinterpret_cast<const nsINode*>(
1510 GetClosestNativeAnonymousSubtreeRoot());
1511 if (!root) {
1512 return nullptr;
1513 }
1514 if (nsIContent* parent = root->GetParent()) {
1515 return parent;
1516 }
1517 if (MOZ_UNLIKELY(root->IsInShadowTree())(__builtin_expect(!!(root->IsInShadowTree()), 0))) {
1518 return root->DoGetShadowHost();
1519 }
1520 return nullptr;
1521 }
1522
1523 /**
1524 * Gets the root of the node tree for this content if it is in a shadow tree.
1525 */
1526 mozilla::dom::ShadowRoot* GetContainingShadow() const;
1527 /**
1528 * Gets the shadow host if this content is in a shadow tree. That is, the host
1529 * of |GetContainingShadow|, if its not null.
1530 *
1531 * @return The shadow host, if this is in shadow tree, or null.
1532 */
1533 mozilla::dom::Element* GetContainingShadowHost() const;
1534
1535 bool IsInSVGUseShadowTree() const {
1536 return !!GetContainingSVGUseShadowHost();
1537 }
1538
1539 mozilla::dom::SVGUseElement* GetContainingSVGUseShadowHost() const {
1540 if (!IsInShadowTree()) {
1541 return nullptr;
1542 }
1543 return DoGetContainingSVGUseShadowHost();
1544 }
1545
1546 // Whether this node has ever been part of a UA widget shadow tree.
1547 bool HasBeenInUAWidget() const { return HasFlag(NODE_HAS_BEEN_IN_UA_WIDGET); }
1548
1549 // True for native anonymous content and for content in UA widgets.
1550 // Only nsIContent can fulfill this condition.
1551 bool ChromeOnlyAccess() const { return IsInNativeAnonymousSubtree(); }
1552
1553 const nsIContent* GetChromeOnlyAccessSubtreeRootParent() const {
1554 return GetClosestNativeAnonymousSubtreeRootParentOrHost();
1555 }
1556
1557 bool IsInShadowTree() const { return HasFlag(NODE_IS_IN_SHADOW_TREE); }
1558
1559 /**
1560 * Get whether this node is C++-generated anonymous content
1561 * @see nsIAnonymousContentCreator
1562 * @return whether this content is anonymous
1563 */
1564 bool IsRootOfNativeAnonymousSubtree() const {
1565 NS_ASSERTION(do { if (!(!HasFlag(NODE_IS_NATIVE_ANONYMOUS_ROOT) || IsInNativeAnonymousSubtree
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Some flags seem to be missing!"
, "!HasFlag(NODE_IS_NATIVE_ANONYMOUS_ROOT) || IsInNativeAnonymousSubtree()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1567); MOZ_PretendNoReturn(); } } while (0)
1566 !HasFlag(NODE_IS_NATIVE_ANONYMOUS_ROOT) || IsInNativeAnonymousSubtree(),do { if (!(!HasFlag(NODE_IS_NATIVE_ANONYMOUS_ROOT) || IsInNativeAnonymousSubtree
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Some flags seem to be missing!"
, "!HasFlag(NODE_IS_NATIVE_ANONYMOUS_ROOT) || IsInNativeAnonymousSubtree()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1567); MOZ_PretendNoReturn(); } } while (0)
1567 "Some flags seem to be missing!")do { if (!(!HasFlag(NODE_IS_NATIVE_ANONYMOUS_ROOT) || IsInNativeAnonymousSubtree
())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Some flags seem to be missing!"
, "!HasFlag(NODE_IS_NATIVE_ANONYMOUS_ROOT) || IsInNativeAnonymousSubtree()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1567); MOZ_PretendNoReturn(); } } while (0)
;
1568 return HasFlag(NODE_IS_NATIVE_ANONYMOUS_ROOT);
1569 }
1570
1571 // Whether this node is the root of a ChromeOnlyAccess DOM subtree.
1572 bool IsRootOfChromeAccessOnlySubtree() const {
1573 return IsRootOfNativeAnonymousSubtree();
1574 }
1575
1576 /** Whether this is the container of a ::before pseudo-element. */
1577 bool IsGeneratedContentContainerForBefore() const {
1578 return IsRootOfNativeAnonymousSubtree() &&
1579 mNodeInfo->NameAtom() == nsGkAtoms::mozgeneratedcontentbefore;
1580 }
1581
1582 /** Whether this is the container of an ::after pseudo-element. */
1583 bool IsGeneratedContentContainerForAfter() const {
1584 return IsRootOfNativeAnonymousSubtree() &&
1585 mNodeInfo->NameAtom() == nsGkAtoms::mozgeneratedcontentafter;
1586 }
1587
1588 /** Whether this is the container of a ::marker pseudo-element. */
1589 bool IsGeneratedContentContainerForMarker() const {
1590 return IsRootOfNativeAnonymousSubtree() &&
1591 mNodeInfo->NameAtom() == nsGkAtoms::mozgeneratedcontentmarker;
1592 }
1593
1594 /**
1595 * Returns true if |this| node is the closest common inclusive ancestor
1596 * (https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor) of the
1597 * start/end nodes of a Range in a Selection or a descendant of such a common
1598 * ancestor. This node is definitely not selected when |false| is returned,
1599 * but it may or may not be selected when |true| is returned.
1600 */
1601 bool IsMaybeSelected() const {
1602 return IsDescendantOfClosestCommonInclusiveAncestorForRangeInSelection() ||
1603 IsClosestCommonInclusiveAncestorForRangeInSelection();
1604 }
1605
1606 /**
1607 * Return true if any part of (this, aStartOffset) .. (this, aEndOffset)
1608 * overlaps any nsRange in
1609 * GetClosestCommonInclusiveAncestorForRangeInSelection ranges (i.e.
1610 * where this is a descendant of a range's common inclusive ancestor node).
1611 * If a nsRange starts in (this, aEndOffset) or if it ends in
1612 * (this, aStartOffset) then it is non-overlapping and the result is false
1613 * for that nsRange. Collapsed ranges always counts as non-overlapping.
1614 *
1615 * @param aStartOffset has to be less or equal to aEndOffset.
1616 */
1617 bool IsSelected(uint32_t aStartOffset, uint32_t aEndOffset) const;
1618
1619 /**
1620 * Get the root element of the text editor associated with this node or the
1621 * root element of the text editor of the ancestor 'TextControlElement' if
1622 * this is in its native anonymous subtree. I.e., this returns anonymous
1623 * `<div>` element of a `TextEditor`. Note that this can be used only for
1624 * getting root content of `<input>` or `<textarea>`. I.e., this method
1625 * doesn't support HTML editors. Note that this may create a `TextEditor`
1626 * instance, and it means that the `TextEditor` may modify its native
1627 * anonymous subtree and may run selection listeners.
1628 */
1629 MOZ_CAN_RUN_SCRIPT mozilla::dom::Element* GetAnonymousRootElementOfTextEditor(
1630 mozilla::TextEditor** aTextEditor = nullptr);
1631
1632 /**
1633 * Get the nearest selection root, ie. the node that will be selected if the
1634 * user does "Select All" while the focus is in this node. Note that if this
1635 * node is not in an editor, the result comes from the nsFrameSelection that
1636 * is related to aPresShell, so the result might not be the ancestor of this
1637 * node. Be aware that if this node and the computed selection limiter are
1638 * not in same subtree, this returns the root content of the closeset subtree.
1639 */
1640 MOZ_CAN_RUN_SCRIPT nsIContent* GetSelectionRootContent(
1641 mozilla::PresShell* aPresShell, bool aAllowCrossShadowBoundary = false);
1642
1643 nsINodeList* ChildNodes();
1644
1645 nsIContent* GetFirstChild() const { return mFirstChild; }
1646
1647 nsIContent* GetLastChild() const;
1648
1649 /**
1650 * Implementation is in Document.h, because it needs to cast from
1651 * Document* to nsINode*.
1652 */
1653 Document* GetOwnerDocument() const;
1654
1655 // TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230)
1656 MOZ_CAN_RUN_SCRIPT_BOUNDARY void Normalize();
1657
1658 /**
1659 * Get the base URI for any relative URIs within this piece of
1660 * content. Generally, this is the document's base URI, but certain
1661 * content carries a local base for backward compatibility.
1662 *
1663 * @return the base URI. May return null.
1664 */
1665 virtual nsIURI* GetBaseURI(bool aTryUseXHRDocBaseURI = false) const = 0;
1666 nsIURI* GetBaseURIObject() const;
1667
1668 /**
1669 * Return true if the node may be apz aware. There are two cases. One is that
1670 * the node is apz aware (such as HTMLInputElement with number type). The
1671 * other is that the node has apz aware listeners. This is a non-virtual
1672 * function which calls IsNodeApzAwareInternal only when the MayBeApzAware is
1673 * set. We check the details in IsNodeApzAwareInternal which may be overriden
1674 * by child classes
1675 */
1676 bool IsNodeApzAware() const {
1677 return NodeMayBeApzAware() ? IsNodeApzAwareInternal() : false;
1678 }
1679
1680 /**
1681 * Override this function and set the flag MayBeApzAware in case the node has
1682 * to let APZC be aware of it. It's used when the node may handle the apz
1683 * aware events and may do preventDefault to stop APZC to do default actions.
1684 *
1685 * For example, instead of scrolling page by APZ, we handle mouse wheel event
1686 * in HTMLInputElement with number type as increasing / decreasing its value.
1687 */
1688 virtual bool IsNodeApzAwareInternal() const;
1689
1690 void GetTextContent(nsAString& aTextContent, mozilla::OOMReporter& aError) {
1691 GetTextContentInternal(aTextContent, aError);
1692 }
1693 void SetTextContent(const nsAString& aTextContent,
1694 nsIPrincipal* aSubjectPrincipal,
1695 mozilla::ErrorResult& aError) {
1696 SetTextContentInternal(aTextContent, aSubjectPrincipal, aError);
1697 }
1698 void SetTextContent(const nsAString& aTextContent,
1699 mozilla::ErrorResult& aError) {
1700 SetTextContentInternal(aTextContent, nullptr, aError);
1701 }
1702
1703 mozilla::dom::Element* QuerySelector(const nsACString& aSelector,
1704 mozilla::ErrorResult& aResult);
1705 already_AddRefed<nsINodeList> QuerySelectorAll(const nsACString& aSelector,
1706 mozilla::ErrorResult& aResult);
1707
1708 protected:
1709 // Document and ShadowRoot override this with its own (faster) version.
1710 // This should really only be called for elements and document fragments.
1711 mozilla::dom::Element* GetElementById(const nsAString& aId);
1712
1713 void AppendChildToChildList(nsIContent* aKid);
1714 void InsertChildToChildList(nsIContent* aKid, nsIContent* aNextSibling);
1715 void DisconnectChild(nsIContent* aKid);
1716
1717 public:
1718 void LookupPrefix(const nsAString& aNamespace, nsAString& aResult);
1719 bool IsDefaultNamespace(const nsAString& aNamespaceURI) {
1720 nsAutoString defaultNamespace;
1721 LookupNamespaceURI(u""_ns, defaultNamespace);
1722 return aNamespaceURI.Equals(defaultNamespace);
1723 }
1724 void LookupNamespaceURI(const nsAString& aNamespacePrefix,
1725 nsAString& aNamespaceURI);
1726
1727 nsIContent* GetNextSibling() const { return mNextSibling; }
1728 nsIContent* GetPreviousSibling() const;
1729
1730 /**
1731 * Return true if the node is being removed from the parent, it means that
1732 * the node still knows the container which it's disconnected from, but the
1733 * node has already been removed from the child node chain of the container.
1734 * I.e., Return true between a call of DisconnectChild of the parent and
1735 * a call of UnbindFromTree of the node.
1736 */
1737 bool IsBeingRemoved() const {
1738 return mParent && !mNextSibling && !mPreviousOrLastSibling;
1739 }
1740
1741 /**
1742 * Get the next node in the pre-order tree traversal of the DOM. If
1743 * aRoot is non-null, then it must be an ancestor of |this|
1744 * (possibly equal to |this|) and only nodes that are descendants of
1745 * aRoot, not including aRoot itself, will be returned. Returns
1746 * null if there are no more nodes to traverse.
1747 */
1748 nsIContent* GetNextNode(const nsINode* aRoot = nullptr) const {
1749 return GetNextNodeImpl(aRoot, false);
1750 }
1751
1752 /**
1753 * Get the next node in the pre-order tree traversal of the DOM but ignoring
1754 * the children of this node. If aRoot is non-null, then it must be an
1755 * ancestor of |this| (possibly equal to |this|) and only nodes that are
1756 * descendants of aRoot, not including aRoot itself, will be returned.
1757 * Returns null if there are no more nodes to traverse.
1758 */
1759 nsIContent* GetNextNonChildNode(const nsINode* aRoot = nullptr) const {
1760 return GetNextNodeImpl(aRoot, true);
1761 }
1762
1763 /**
1764 * Returns true if 'this' is either document or element or
1765 * document fragment and aOther is a descendant in the same
1766 * anonymous tree.
1767 */
1768 bool Contains(const nsINode* aOther) const;
1769
1770 bool UnoptimizableCCNode() const;
1771
1772 /**
1773 * Fire a DOMNodeRemoved mutation event for all children of this node
1774 * TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230)
1775 */
1776 MOZ_CAN_RUN_SCRIPT_BOUNDARY void FireNodeRemovedForChildren();
1777
1778 void QueueDevtoolsAnonymousEvent(bool aIsRemove);
1779
1780 private:
1781 mozilla::dom::SVGUseElement* DoGetContainingSVGUseShadowHost() const;
1782
1783 nsIContent* GetNextNodeImpl(const nsINode* aRoot,
1784 const bool aSkipChildren) const {
1785#ifdef DEBUG1
1786 if (aRoot) {
1787 // TODO: perhaps nsINode::IsInclusiveDescendantOf could be used instead.
1788 const nsINode* cur = this;
1789 for (; cur; cur = cur->GetParentNode())
1790 if (cur == aRoot) break;
1791 NS_ASSERTION(cur, "aRoot not an ancestor of |this|?")do { if (!(cur)) { NS_DebugBreak(NS_DEBUG_ASSERTION, "aRoot not an ancestor of |this|?"
, "cur", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1791); MOZ_PretendNoReturn(); } } while (0)
;
1792 }
1793#endif
1794 if (!aSkipChildren) {
1795 nsIContent* kid = GetFirstChild();
1796 if (kid) {
1797 return kid;
1798 }
1799 }
1800 if (this == aRoot) {
1801 return nullptr;
1802 }
1803 const nsINode* cur = this;
1804 while (1) {
1805 nsIContent* next = cur->GetNextSibling();
1806 if (next) {
1807 return next;
1808 }
1809 nsINode* parent = cur->GetParentNode();
1810 if (parent == aRoot) {
1811 return nullptr;
1812 }
1813 cur = parent;
1814 }
1815 MOZ_ASSERT_UNREACHABLE("How did we get here?")do { static_assert( mozilla::detail::AssertionConditionType<
decltype(false)>::isValid, "invalid assertion condition");
if ((__builtin_expect(!!(!(!!(false))), 0))) { do { } while (
false); MOZ_ReportAssertionFailure("false" " (" "MOZ_ASSERT_UNREACHABLE: "
"How did we get here?" ")", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1815); AnnotateMozCrashReason("MOZ_ASSERT" "(" "false" ") ("
"MOZ_ASSERT_UNREACHABLE: " "How did we get here?" ")"); do {
*((volatile int*)__null) = 1815; __attribute__((nomerge)) ::
abort(); } while (false); } } while (false)
;
1816 }
1817
1818 public:
1819 /**
1820 * Get the previous nsIContent in the pre-order tree traversal of the DOM. If
1821 * aRoot is non-null, then it must be an ancestor of |this|
1822 * (possibly equal to |this|) and only nsIContents that are descendants of
1823 * aRoot, including aRoot itself, will be returned. Returns
1824 * null if there are no more nsIContents to traverse.
1825 */
1826 nsIContent* GetPrevNode(const nsINode* aRoot = nullptr) const {
1827#ifdef DEBUG1
1828 if (aRoot) {
1829 // TODO: perhaps nsINode::IsInclusiveDescendantOf could be used instead.
1830 const nsINode* cur = this;
1831 for (; cur; cur = cur->GetParentNode())
1832 if (cur == aRoot) break;
1833 NS_ASSERTION(cur, "aRoot not an ancestor of |this|?")do { if (!(cur)) { NS_DebugBreak(NS_DEBUG_ASSERTION, "aRoot not an ancestor of |this|?"
, "cur", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 1833); MOZ_PretendNoReturn(); } } while (0)
;
1834 }
1835#endif
1836
1837 if (this == aRoot) {
1838 return nullptr;
1839 }
1840 nsIContent* cur = this->GetParent();
1841 nsIContent* iter = this->GetPreviousSibling();
1842 while (iter) {
1843 cur = iter;
1844 iter = reinterpret_cast<nsINode*>(iter)->GetLastChild();
1845 }
1846 return cur;
1847 }
1848
1849 /**
1850 * Boolean flags
1851 */
1852 private:
1853 enum BooleanFlag {
1854 // Set if we're being used from -moz-element
1855 NodeHasRenderingObservers,
1856 // Set if our parent chain (including this node itself) terminates
1857 // in a document
1858 IsInDocument,
1859 // Set if we're part of the composed doc.
1860 // https://dom.spec.whatwg.org/#connected
1861 IsConnected,
1862 // Set if mParent is an nsIContent
1863 ParentIsContent,
1864 // Set if this node is an Element
1865 NodeIsElement,
1866 // Set if the element has a non-empty id attribute. This can in rare
1867 // cases lie for nsXMLElement, such as when the node has been moved between
1868 // documents with different id mappings.
1869 ElementHasID,
1870 // Set if the element might have a class.
1871 ElementMayHaveClass,
1872 // Set if the element might have inline style.
1873 ElementMayHaveStyle,
1874 // Set if the element has a name attribute set.
1875 ElementHasName,
1876 // Set if the element has a part attribute set.
1877 ElementHasPart,
1878 // Set if the element might have a contenteditable attribute set.
1879 ElementMayHaveContentEditableAttr,
1880 // Set if the node is the closest common inclusive ancestor of the start/end
1881 // nodes of a Range that is in a Selection.
1882 NodeIsClosestCommonInclusiveAncestorForRangeInSelection,
1883 // Set if the node is a descendant of a node with the above bit set.
1884 NodeIsDescendantOfClosestCommonInclusiveAncestorForRangeInSelection,
1885 // Set if CanSkipInCC check has been done for this subtree root.
1886 NodeIsCCMarkedRoot,
1887 // Maybe set if this node is in black subtree.
1888 NodeIsCCBlackTree,
1889 // Maybe set if the node is a root of a subtree
1890 // which needs to be kept in the purple buffer.
1891 NodeIsPurpleRoot,
1892 // Set if the element has some style states locked
1893 ElementHasLockedStyleStates,
1894 // Set if element has pointer locked
1895 ElementHasPointerLock,
1896 // Set if the node may have DOMMutationObserver attached to it.
1897 NodeMayHaveDOMMutationObserver,
1898 // Set if node is Content
1899 NodeIsContent,
1900 // Set if the node has animations or transitions
1901 ElementHasAnimations,
1902 // Set if node has a dir attribute with a valid value (ltr, rtl, or auto).
1903 // Note that we cannot compute this from the dir attribute event state
1904 // flags, because we can't use those to distinguish
1905 // <bdi dir="some-invalid-value"> and <bdi dir="auto">.
1906 NodeHasValidDirAttribute,
1907 // Set if this node, which must be a text node, might be responsible for
1908 // setting the directionality of a dir="auto" ancestor.
1909 NodeMaySetDirAuto,
1910 // Set if a node in the node's parent chain has dir=auto.
1911 NodeAncestorHasDirAuto,
1912 // Set if the node is handling a click.
1913 NodeHandlingClick,
1914 // Set if the element has a parser insertion mode other than "in body",
1915 // per the HTML5 "Parse state" section.
1916 ElementHasWeirdParserInsertionMode,
1917 // Parser sets this flag if it has notified about the node.
1918 ParserHasNotified,
1919 // Sets if the node is apz aware or we have apz aware listeners.
1920 MayBeApzAware,
1921 // Set if the element might have any kind of anonymous content children,
1922 // which would not be found through the element's children list.
1923 ElementMayHaveAnonymousChildren,
1924 // Set if element has CustomElementData.
1925 ElementHasCustomElementData,
1926 // Set if the element was created from prototype cache and
1927 // its l10n attributes haven't been changed.
1928 ElementCreatedFromPrototypeAndHasUnmodifiedL10n,
1929 // Guard value
1930 BooleanFlagCount
1931 };
1932
1933 void SetBoolFlag(BooleanFlag name, bool value) {
1934 static_assert(BooleanFlagCount <= 8 * sizeof(mBoolFlags),
1935 "Too many boolean flags");
1936 mBoolFlags = (mBoolFlags & ~(1 << name)) | (value << name);
1937 }
1938
1939 void SetBoolFlag(BooleanFlag name) {
1940 static_assert(BooleanFlagCount <= 8 * sizeof(mBoolFlags),
1941 "Too many boolean flags");
1942 mBoolFlags |= (1 << name);
1943 }
1944
1945 void ClearBoolFlag(BooleanFlag name) {
1946 static_assert(BooleanFlagCount <= 8 * sizeof(mBoolFlags),
1947 "Too many boolean flags");
1948 mBoolFlags &= ~(1 << name);
1949 }
1950
1951 bool GetBoolFlag(BooleanFlag name) const {
1952 static_assert(BooleanFlagCount <= 8 * sizeof(mBoolFlags),
1953 "Too many boolean flags");
1954 return mBoolFlags & (1 << name);
1955 }
1956
1957 public:
1958 bool HasRenderingObservers() const {
1959 return GetBoolFlag(NodeHasRenderingObservers);
1960 }
1961 void SetHasRenderingObservers(bool aValue) {
1962 SetBoolFlag(NodeHasRenderingObservers, aValue);
1963 }
1964 bool IsContent() const { return GetBoolFlag(NodeIsContent); }
1965 bool HasID() const { return GetBoolFlag(ElementHasID); }
1966 bool MayHaveClass() const { return GetBoolFlag(ElementMayHaveClass); }
1967 void SetMayHaveClass() { SetBoolFlag(ElementMayHaveClass); }
1968 bool MayHaveStyle() const { return GetBoolFlag(ElementMayHaveStyle); }
1969 bool HasName() const { return GetBoolFlag(ElementHasName); }
1970 bool HasPartAttribute() const { return GetBoolFlag(ElementHasPart); }
1971 bool MayHaveContentEditableAttr() const {
1972 return GetBoolFlag(ElementMayHaveContentEditableAttr);
1973 }
1974 /**
1975 * https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor
1976 */
1977 bool IsClosestCommonInclusiveAncestorForRangeInSelection() const {
1978 return GetBoolFlag(NodeIsClosestCommonInclusiveAncestorForRangeInSelection);
1979 }
1980 /**
1981 * https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor
1982 */
1983 void SetClosestCommonInclusiveAncestorForRangeInSelection() {
1984 SetBoolFlag(NodeIsClosestCommonInclusiveAncestorForRangeInSelection);
1985 }
1986 /**
1987 * https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor
1988 */
1989 void ClearClosestCommonInclusiveAncestorForRangeInSelection() {
1990 ClearBoolFlag(NodeIsClosestCommonInclusiveAncestorForRangeInSelection);
1991 }
1992 /**
1993 * https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor
1994 */
1995 bool IsDescendantOfClosestCommonInclusiveAncestorForRangeInSelection() const {
1996 return GetBoolFlag(
1997 NodeIsDescendantOfClosestCommonInclusiveAncestorForRangeInSelection);
1998 }
1999 /**
2000 * https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor
2001 */
2002 void SetDescendantOfClosestCommonInclusiveAncestorForRangeInSelection() {
2003 SetBoolFlag(
2004 NodeIsDescendantOfClosestCommonInclusiveAncestorForRangeInSelection);
2005 }
2006 /**
2007 * https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor
2008 */
2009 void ClearDescendantOfClosestCommonInclusiveAncestorForRangeInSelection() {
2010 ClearBoolFlag(
2011 NodeIsDescendantOfClosestCommonInclusiveAncestorForRangeInSelection);
2012 }
2013
2014 void SetCCMarkedRoot(bool aValue) { SetBoolFlag(NodeIsCCMarkedRoot, aValue); }
2015 bool CCMarkedRoot() const { return GetBoolFlag(NodeIsCCMarkedRoot); }
2016 void SetInCCBlackTree(bool aValue) { SetBoolFlag(NodeIsCCBlackTree, aValue); }
2017 bool InCCBlackTree() const { return GetBoolFlag(NodeIsCCBlackTree); }
2018 void SetIsPurpleRoot(bool aValue) { SetBoolFlag(NodeIsPurpleRoot, aValue); }
2019 bool IsPurpleRoot() const { return GetBoolFlag(NodeIsPurpleRoot); }
2020 bool MayHaveDOMMutationObserver() {
2021 return GetBoolFlag(NodeMayHaveDOMMutationObserver);
2022 }
2023 void SetMayHaveDOMMutationObserver() {
2024 SetBoolFlag(NodeMayHaveDOMMutationObserver, true);
2025 }
2026 bool HasListenerManager() { return HasFlag(NODE_HAS_LISTENERMANAGER); }
2027 bool HasPointerLock() const { return GetBoolFlag(ElementHasPointerLock); }
2028 void SetPointerLock() { SetBoolFlag(ElementHasPointerLock); }
2029 void ClearPointerLock() { ClearBoolFlag(ElementHasPointerLock); }
2030 bool MayHaveAnimations() const { return GetBoolFlag(ElementHasAnimations); }
2031 void SetMayHaveAnimations() { SetBoolFlag(ElementHasAnimations); }
2032 void ClearMayHaveAnimations() { ClearBoolFlag(ElementHasAnimations); }
2033 void SetHasValidDir() { SetBoolFlag(NodeHasValidDirAttribute); }
2034 void ClearHasValidDir() { ClearBoolFlag(NodeHasValidDirAttribute); }
2035 bool HasValidDir() const { return GetBoolFlag(NodeHasValidDirAttribute); }
2036 void SetMaySetDirAuto() {
2037 // FIXME(bug 1881225): dir=auto should probably work on CDATA too.
2038 MOZ_ASSERT(NodeType() == TEXT_NODE)do { static_assert( mozilla::detail::AssertionConditionType<
decltype(NodeType() == TEXT_NODE)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(NodeType() == TEXT_NODE))), 0
))) { do { } while (false); MOZ_ReportAssertionFailure("NodeType() == TEXT_NODE"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2038); AnnotateMozCrashReason("MOZ_ASSERT" "(" "NodeType() == TEXT_NODE"
")"); do { *((volatile int*)__null) = 2038; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
2039 SetBoolFlag(NodeMaySetDirAuto);
2040 }
2041 bool MaySetDirAuto() const {
2042 MOZ_ASSERT(NodeType() == TEXT_NODE)do { static_assert( mozilla::detail::AssertionConditionType<
decltype(NodeType() == TEXT_NODE)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(NodeType() == TEXT_NODE))), 0
))) { do { } while (false); MOZ_ReportAssertionFailure("NodeType() == TEXT_NODE"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2042); AnnotateMozCrashReason("MOZ_ASSERT" "(" "NodeType() == TEXT_NODE"
")"); do { *((volatile int*)__null) = 2042; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
2043 return GetBoolFlag(NodeMaySetDirAuto);
2044 }
2045 void ClearMaySetDirAuto() {
2046 MOZ_ASSERT(NodeType() == TEXT_NODE)do { static_assert( mozilla::detail::AssertionConditionType<
decltype(NodeType() == TEXT_NODE)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(NodeType() == TEXT_NODE))), 0
))) { do { } while (false); MOZ_ReportAssertionFailure("NodeType() == TEXT_NODE"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2046); AnnotateMozCrashReason("MOZ_ASSERT" "(" "NodeType() == TEXT_NODE"
")"); do { *((volatile int*)__null) = 2046; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
2047 ClearBoolFlag(NodeMaySetDirAuto);
2048 }
2049 void SetAncestorHasDirAuto() { SetBoolFlag(NodeAncestorHasDirAuto); }
2050 void ClearAncestorHasDirAuto() { ClearBoolFlag(NodeAncestorHasDirAuto); }
2051 bool AncestorHasDirAuto() const {
2052 return GetBoolFlag(NodeAncestorHasDirAuto);
2053 }
2054
2055 // Implemented in nsIContentInlines.h.
2056 inline bool NodeOrAncestorHasDirAuto() const;
2057
2058 void SetParserHasNotified() { SetBoolFlag(ParserHasNotified); };
2059 bool HasParserNotified() { return GetBoolFlag(ParserHasNotified); }
2060
2061 void SetMayBeApzAware() { SetBoolFlag(MayBeApzAware); }
2062 bool NodeMayBeApzAware() const { return GetBoolFlag(MayBeApzAware); }
2063
2064 void SetMayHaveAnonymousChildren() {
2065 SetBoolFlag(ElementMayHaveAnonymousChildren);
2066 }
2067 bool MayHaveAnonymousChildren() const {
2068 return GetBoolFlag(ElementMayHaveAnonymousChildren);
2069 }
2070
2071 void SetHasCustomElementData() { SetBoolFlag(ElementHasCustomElementData); }
2072 bool HasCustomElementData() const {
2073 return GetBoolFlag(ElementHasCustomElementData);
2074 }
2075
2076 void SetElementCreatedFromPrototypeAndHasUnmodifiedL10n() {
2077 SetBoolFlag(ElementCreatedFromPrototypeAndHasUnmodifiedL10n);
2078 }
2079 bool HasElementCreatedFromPrototypeAndHasUnmodifiedL10n() {
2080 return GetBoolFlag(ElementCreatedFromPrototypeAndHasUnmodifiedL10n);
2081 }
2082 void ClearElementCreatedFromPrototypeAndHasUnmodifiedL10n() {
2083 ClearBoolFlag(ElementCreatedFromPrototypeAndHasUnmodifiedL10n);
2084 }
2085
2086 mozilla::dom::ShadowRoot* GetShadowRoot() const;
2087
2088 // Return the shadow root of the node if it is a shadow host and
2089 // it meets the requirements for being a shadow host of a selection.
2090 // For example, <details>, <video> and <use> elements are not valid
2091 // shadow host for selection.
2092 mozilla::dom::ShadowRoot* GetShadowRootForSelection() const;
2093
2094 protected:
2095 void SetParentIsContent(bool aValue) { SetBoolFlag(ParentIsContent, aValue); }
2096 void SetIsInDocument() { SetBoolFlag(IsInDocument); }
2097 void ClearInDocument() { ClearBoolFlag(IsInDocument); }
2098 void SetIsConnected(bool aConnected) { SetBoolFlag(IsConnected, aConnected); }
2099 void SetNodeIsContent() { SetBoolFlag(NodeIsContent); }
2100 void SetIsElement() { SetBoolFlag(NodeIsElement); }
2101 void SetHasID() { SetBoolFlag(ElementHasID); }
2102 void ClearHasID() { ClearBoolFlag(ElementHasID); }
2103 void SetMayHaveStyle() { SetBoolFlag(ElementMayHaveStyle); }
2104 void SetHasName() { SetBoolFlag(ElementHasName); }
2105 void ClearHasName() { ClearBoolFlag(ElementHasName); }
2106 void SetHasPartAttribute(bool aPart) { SetBoolFlag(ElementHasPart, aPart); }
2107 void SetMayHaveContentEditableAttr() {
2108 SetBoolFlag(ElementMayHaveContentEditableAttr);
2109 }
2110 void SetHasLockedStyleStates() { SetBoolFlag(ElementHasLockedStyleStates); }
2111 void ClearHasLockedStyleStates() {
2112 ClearBoolFlag(ElementHasLockedStyleStates);
2113 }
2114 bool HasLockedStyleStates() const {
2115 return GetBoolFlag(ElementHasLockedStyleStates);
2116 }
2117 void SetHasWeirdParserInsertionMode() {
2118 SetBoolFlag(ElementHasWeirdParserInsertionMode);
2119 }
2120 bool HasWeirdParserInsertionMode() const {
2121 return GetBoolFlag(ElementHasWeirdParserInsertionMode);
2122 }
2123 bool HandlingClick() const { return GetBoolFlag(NodeHandlingClick); }
2124 void SetHandlingClick() { SetBoolFlag(NodeHandlingClick); }
2125 void ClearHandlingClick() { ClearBoolFlag(NodeHandlingClick); }
2126
2127 void SetSubtreeRootPointer(nsINode* aSubtreeRoot) {
2128 NS_ASSERTION(aSubtreeRoot, "aSubtreeRoot can never be null!")do { if (!(aSubtreeRoot)) { NS_DebugBreak(NS_DEBUG_ASSERTION,
"aSubtreeRoot can never be null!", "aSubtreeRoot", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2128); MOZ_PretendNoReturn(); } } while (0)
;
2129 NS_ASSERTION(!(IsContent() && IsInUncomposedDoc()) && !IsInShadowTree(),do { if (!(!(IsContent() && IsInUncomposedDoc()) &&
!IsInShadowTree())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Shouldn't be here!"
, "!(IsContent() && IsInUncomposedDoc()) && !IsInShadowTree()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2130); MOZ_PretendNoReturn(); } } while (0)
2130 "Shouldn't be here!")do { if (!(!(IsContent() && IsInUncomposedDoc()) &&
!IsInShadowTree())) { NS_DebugBreak(NS_DEBUG_ASSERTION, "Shouldn't be here!"
, "!(IsContent() && IsInUncomposedDoc()) && !IsInShadowTree()"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2130); MOZ_PretendNoReturn(); } } while (0)
;
2131 mSubtreeRoot = aSubtreeRoot;
2132 }
2133
2134 void ClearSubtreeRootPointer() { mSubtreeRoot = nullptr; }
2135
2136 public:
2137 // Makes nsINode object to keep aObject alive.
2138 void BindObject(nsISupports* aObject);
2139 // After calling UnbindObject nsINode object doesn't keep
2140 // aObject alive anymore.
2141 void UnbindObject(nsISupports* aObject);
2142
2143 void GenerateXPath(nsAString& aResult);
2144
2145 already_AddRefed<mozilla::dom::AccessibleNode> GetAccessibleNode();
2146
2147 /**
2148 * Returns the length of this node, as specified at
2149 * <http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#concept-node-length>
2150 */
2151 uint32_t Length() const;
2152
2153 void GetNodeName(mozilla::dom::DOMString& aNodeName) {
2154 const nsString& nodeName = NodeName();
2155 aNodeName.SetKnownLiveString(nodeName);
2156 }
2157 [[nodiscard]] nsresult GetBaseURI(nsAString& aBaseURI) const;
2158 // Return the base URI for the document.
2159 // The returned value may differ if the document is loaded via XHR, and
2160 // when accessed from chrome privileged script and
2161 // from content privileged script for compatibility.
2162 void GetBaseURIFromJS(nsAString& aBaseURI, CallerType aCallerType,
2163 ErrorResult& aRv) const;
2164 bool HasChildNodes() const { return HasChildren(); }
2165
2166 // See nsContentUtils::PositionIsBefore for aThisIndex and aOtherIndex usage.
2167 uint16_t CompareDocumentPosition(
2168 nsINode& aOther, mozilla::Maybe<uint32_t>* aThisIndex = nullptr,
2169 mozilla::Maybe<uint32_t>* aOtherIndex = nullptr) const;
2170 void GetNodeValue(nsAString& aNodeValue) { GetNodeValueInternal(aNodeValue); }
2171 void SetNodeValue(const nsAString& aNodeValue, mozilla::ErrorResult& aError) {
2172 SetNodeValueInternal(aNodeValue, aError);
2173 }
2174 virtual void GetNodeValueInternal(nsAString& aNodeValue);
2175 virtual void SetNodeValueInternal(const nsAString& aNodeValue,
2176 mozilla::ErrorResult& aError) {
2177 // The DOM spec says that when nodeValue is defined to be null "setting it
2178 // has no effect", so we don't throw an exception.
2179 }
2180 void EnsurePreInsertionValidity(nsINode& aNewChild, nsINode* aRefChild,
2181 mozilla::ErrorResult& aError);
2182 nsINode* InsertBefore(nsINode& aNode, nsINode* aChild,
2183 mozilla::ErrorResult& aError) {
2184 return ReplaceOrInsertBefore(false, &aNode, aChild, aError);
2185 }
2186
2187 /**
2188 * See <https://dom.spec.whatwg.org/#dom-node-appendchild>.
2189 */
2190 nsINode* AppendChild(nsINode& aNode, mozilla::ErrorResult& aError) {
2191 return InsertBefore(aNode, nullptr, aError);
2192 }
2193
2194 nsINode* ReplaceChild(nsINode& aNode, nsINode& aChild,
2195 mozilla::ErrorResult& aError) {
2196 return ReplaceOrInsertBefore(true, &aNode, &aChild, aError);
2197 }
2198 // TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230)
2199 MOZ_CAN_RUN_SCRIPT_BOUNDARY nsINode* RemoveChild(
2200 nsINode& aChild, mozilla::ErrorResult& aError);
2201 already_AddRefed<nsINode> CloneNode(bool aDeep, mozilla::ErrorResult& aError);
2202 bool IsSameNode(nsINode* aNode);
2203 bool IsEqualNode(nsINode* aNode);
2204 void GetNamespaceURI(nsAString& aNamespaceURI) const {
2205 mNodeInfo->GetNamespaceURI(aNamespaceURI);
2206 }
2207#ifdef MOZILLA_INTERNAL_API1
2208 void GetPrefix(nsAString& aPrefix) { mNodeInfo->GetPrefix(aPrefix); }
2209#endif
2210 void GetLocalName(mozilla::dom::DOMString& aLocalName) const {
2211 const nsString& localName = LocalName();
2212 aLocalName.SetKnownLiveString(localName);
2213 }
2214
2215 nsDOMAttributeMap* GetAttributes();
2216
2217 // Helper method to remove this node from its parent. This is not exposed
2218 // through WebIDL.
2219 // Only call this if the node has a parent node.
2220 nsresult RemoveFromParent() {
2221 nsINode* parent = GetParentNode();
2222 mozilla::ErrorResult rv;
2223 parent->RemoveChild(*this, rv);
2224 return rv.StealNSResult();
2225 }
2226
2227 // ChildNode methods
2228 inline mozilla::dom::Element* GetPreviousElementSibling() const;
2229 inline mozilla::dom::Element* GetNextElementSibling() const;
2230
2231 MOZ_CAN_RUN_SCRIPT void Before(const Sequence<OwningNodeOrString>& aNodes,
2232 ErrorResult& aRv);
2233 MOZ_CAN_RUN_SCRIPT void After(const Sequence<OwningNodeOrString>& aNodes,
2234 ErrorResult& aRv);
2235 MOZ_CAN_RUN_SCRIPT void ReplaceWith(
2236 const Sequence<OwningNodeOrString>& aNodes, ErrorResult& aRv);
2237 /**
2238 * Remove this node from its parent, if any.
2239 */
2240 void Remove();
2241
2242 // ParentNode methods
2243 mozilla::dom::Element* GetFirstElementChild() const;
2244 mozilla::dom::Element* GetLastElementChild() const;
2245
2246 already_AddRefed<nsIHTMLCollection> GetElementsByAttribute(
2247 const nsAString& aAttribute, const nsAString& aValue);
2248 already_AddRefed<nsIHTMLCollection> GetElementsByAttributeNS(
2249 const nsAString& aNamespaceURI, const nsAString& aAttribute,
2250 const nsAString& aValue, ErrorResult& aRv);
2251
2252 MOZ_CAN_RUN_SCRIPT void Prepend(const Sequence<OwningNodeOrString>& aNodes,
2253 ErrorResult& aRv);
2254 MOZ_CAN_RUN_SCRIPT void Append(const Sequence<OwningNodeOrString>& aNodes,
2255 ErrorResult& aRv);
2256 MOZ_CAN_RUN_SCRIPT void ReplaceChildren(
2257 const Sequence<OwningNodeOrString>& aNodes, ErrorResult& aRv);
2258 MOZ_CAN_RUN_SCRIPT void ReplaceChildren(nsINode* aNode, ErrorResult& aRv);
2259
2260 void GetBoxQuads(const BoxQuadOptions& aOptions,
2261 nsTArray<RefPtr<DOMQuad>>& aResult, CallerType aCallerType,
2262 ErrorResult& aRv);
2263
2264 void GetBoxQuadsFromWindowOrigin(const BoxQuadOptions& aOptions,
2265 nsTArray<RefPtr<DOMQuad>>& aResult,
2266 ErrorResult& aRv);
2267
2268 already_AddRefed<DOMQuad> ConvertQuadFromNode(
2269 DOMQuad& aQuad, const TextOrElementOrDocument& aFrom,
2270 const ConvertCoordinateOptions& aOptions, CallerType aCallerType,
2271 ErrorResult& aRv);
2272 already_AddRefed<DOMQuad> ConvertRectFromNode(
2273 DOMRectReadOnly& aRect, const TextOrElementOrDocument& aFrom,
2274 const ConvertCoordinateOptions& aOptions, CallerType aCallerType,
2275 ErrorResult& aRv);
2276 already_AddRefed<DOMPoint> ConvertPointFromNode(
2277 const DOMPointInit& aPoint, const TextOrElementOrDocument& aFrom,
2278 const ConvertCoordinateOptions& aOptions, CallerType aCallerType,
2279 ErrorResult& aRv);
2280
2281 /**
2282 * See nsSlots::mClosestCommonInclusiveAncestorRanges.
2283 */
2284 const mozilla::LinkedList<mozilla::dom::AbstractRange>*
2285 GetExistingClosestCommonInclusiveAncestorRanges() const {
2286 if (!HasSlots()) {
2287 return nullptr;
2288 }
2289 return GetExistingSlots()->mClosestCommonInclusiveAncestorRanges.get();
2290 }
2291
2292 /**
2293 * See nsSlots::mClosestCommonInclusiveAncestorRanges.
2294 */
2295 mozilla::LinkedList<mozilla::dom::AbstractRange>*
2296 GetExistingClosestCommonInclusiveAncestorRanges() {
2297 if (!HasSlots()) {
2298 return nullptr;
2299 }
2300 return GetExistingSlots()->mClosestCommonInclusiveAncestorRanges.get();
2301 }
2302
2303 /**
2304 * See nsSlots::mClosestCommonInclusiveAncestorRanges.
2305 */
2306 mozilla::UniquePtr<mozilla::LinkedList<mozilla::dom::AbstractRange>>&
2307 GetClosestCommonInclusiveAncestorRangesPtr() {
2308 return Slots()->mClosestCommonInclusiveAncestorRanges;
2309 }
2310
2311 nsIWeakReference* GetExistingWeakReference() {
2312 return HasSlots() ? GetExistingSlots()->mWeakReference : nullptr;
2313 }
2314
2315 protected:
2316 // Override this function to create a custom slots class.
2317 // Must not return null.
2318 virtual nsINode::nsSlots* CreateSlots();
2319
2320 bool HasSlots() const { return mSlots != nullptr; }
2321
2322 nsSlots* GetExistingSlots() const { return mSlots; }
2323
2324 nsSlots* Slots() {
2325 if (!HasSlots()) {
2326 mSlots = CreateSlots();
2327 MOZ_ASSERT(mSlots)do { static_assert( mozilla::detail::AssertionConditionType<
decltype(mSlots)>::isValid, "invalid assertion condition")
; if ((__builtin_expect(!!(!(!!(mSlots))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("mSlots", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2327); AnnotateMozCrashReason("MOZ_ASSERT" "(" "mSlots" ")"
); do { *((volatile int*)__null) = 2327; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
2328 }
2329 return GetExistingSlots();
2330 }
2331
2332 /**
2333 * Invalidate cached child array inside mChildNodes
2334 * of type nsParentNodeChildContentList.
2335 */
2336 void InvalidateChildNodes();
2337
2338 virtual void GetTextContentInternal(nsAString& aTextContent,
2339 mozilla::OOMReporter& aError);
2340 virtual void SetTextContentInternal(const nsAString& aTextContent,
2341 nsIPrincipal* aSubjectPrincipal,
2342 mozilla::ErrorResult& aError) {}
2343
2344 void EnsurePreInsertionValidity1(mozilla::ErrorResult& aError);
2345 void EnsurePreInsertionValidity2(bool aReplace, nsINode& aNewChild,
2346 nsINode* aRefChild,
2347 mozilla::ErrorResult& aError);
2348 // TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230)
2349 MOZ_CAN_RUN_SCRIPT_BOUNDARY nsINode* ReplaceOrInsertBefore(
2350 bool aReplace, nsINode* aNewChild, nsINode* aRefChild,
2351 mozilla::ErrorResult& aError);
2352
2353 /**
2354 * Returns the Element that should be used for resolving namespaces
2355 * on this node (ie the ownerElement for attributes, the documentElement for
2356 * documents, the node itself for elements and for other nodes the parentNode
2357 * if it is an element).
2358 */
2359 virtual mozilla::dom::Element* GetNameSpaceElement() = 0;
2360
2361 /**
2362 * Parse the given selector string into a servo SelectorList.
2363 *
2364 * Never returns null if aRv is not failing.
2365 *
2366 * Note that the selector list returned here is owned by the owner doc's
2367 * selector cache.
2368 */
2369 const mozilla::StyleSelectorList* ParseSelectorList(
2370 const nsACString& aSelectorString, mozilla::ErrorResult&);
2371
2372 public:
2373 /* Event stuff that documents and elements share.
2374
2375 Note that we include DOCUMENT_ONLY_EVENT events here so that we
2376 can forward all the document stuff to this implementation.
2377 */
2378#define EVENT(name_, id_, type_, struct_) \
2379 mozilla::dom::EventHandlerNonNull* GetOn##name_() { \
2380 return GetEventHandler(nsGkAtoms::on##name_); \
2381 } \
2382 void SetOn##name_(mozilla::dom::EventHandlerNonNull* handler) { \
2383 SetEventHandler(nsGkAtoms::on##name_, handler); \
2384 }
2385#define TOUCH_EVENT EVENT
2386#define DOCUMENT_ONLY_EVENT EVENT
2387#include "mozilla/EventNameList.h"
2388#undef DOCUMENT_ONLY_EVENT
2389#undef TOUCH_EVENT
2390#undef EVENT
2391
2392 NodeSelectorFlags GetSelectorFlags() const {
2393 return static_cast<NodeSelectorFlags>(mSelectorFlags.Get());
2394 }
2395
2396 protected:
2397 static bool Traverse(nsINode* tmp, nsCycleCollectionTraversalCallback& cb);
2398 static void Unlink(nsINode* tmp);
2399
2400 RefPtr<mozilla::dom::NodeInfo> mNodeInfo;
2401
2402 // mParent is an owning ref most of the time, except for the case of document
2403 // nodes, so it cannot be represented by nsCOMPtr, so mark is as
2404 // MOZ_OWNING_REF.
2405 nsINode* MOZ_OWNING_REF mParent;
2406
2407 private:
2408#ifndef BOOL_FLAGS_ON_WRAPPER_CACHE
2409 // Boolean flags.
2410 uint32_t mBoolFlags;
2411#endif
2412
2413 mozilla::RustCell<uint32_t> mSelectorFlags{0};
2414
2415 uint32_t mChildCount;
2416
2417 protected:
2418 // mNextSibling and mFirstChild are strong references while
2419 // mPreviousOrLastSibling is a weak ref. |mFirstChild->mPreviousOrLastSibling|
2420 // points to the last child node.
2421 nsCOMPtr<nsIContent> mFirstChild;
2422 nsCOMPtr<nsIContent> mNextSibling;
2423 nsIContent* MOZ_NON_OWNING_REF mPreviousOrLastSibling;
2424
2425 union {
2426 // Pointer to our primary frame. Might be null.
2427 nsIFrame* mPrimaryFrame;
2428
2429 // Pointer to the root of our subtree. Might be null.
2430 // This reference is non-owning and safe, since it either points to the
2431 // object itself, or is reset by ClearSubtreeRootPointer.
2432 nsINode* MOZ_NON_OWNING_REF mSubtreeRoot;
2433 };
2434
2435 // Storage for more members that are usually not needed; allocated lazily.
2436 nsSlots* mSlots;
2437};
2438
2439NON_VIRTUAL_ADDREF_RELEASE(nsINode)
2440
2441inline nsINode* mozilla::dom::EventTarget::GetAsNode() {
2442 return IsNode() ? AsNode() : nullptr;
2443}
2444
2445inline const nsINode* mozilla::dom::EventTarget::GetAsNode() const {
2446 return const_cast<mozilla::dom::EventTarget*>(this)->GetAsNode();
2447}
2448
2449inline nsINode* mozilla::dom::EventTarget::AsNode() {
2450 MOZ_DIAGNOSTIC_ASSERT(IsNode())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(IsNode())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(IsNode()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("IsNode()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2450); AnnotateMozCrashReason("MOZ_DIAGNOSTIC_ASSERT" "(" "IsNode()"
")"); do { *((volatile int*)__null) = 2450; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
2451 return static_cast<nsINode*>(this);
2452}
2453
2454inline const nsINode* mozilla::dom::EventTarget::AsNode() const {
2455 MOZ_DIAGNOSTIC_ASSERT(IsNode())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(IsNode())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(IsNode()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("IsNode()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/nsINode.h"
, 2455); AnnotateMozCrashReason("MOZ_DIAGNOSTIC_ASSERT" "(" "IsNode()"
")"); do { *((volatile int*)__null) = 2455; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
2456 return static_cast<const nsINode*>(this);
2457}
2458
2459// Useful inline function for getting a node given an nsIContent and a Document.
2460// Returns the first argument cast to nsINode if it is non-null, otherwise
2461// returns the second (which may be null). We use type variables instead of
2462// nsIContent* and Document* because the actual types must be
2463// known for the cast to work.
2464template <class C, class D>
2465inline nsINode* NODE_FROM(C& aContent, D& aDocument) {
2466 if (aContent) return static_cast<nsINode*>(aContent);
2467 return static_cast<nsINode*>(aDocument);
2468}
2469
2470NS_DEFINE_STATIC_IID_ACCESSOR(nsINode, NS_INODE_IID)template <typename T> struct nsINode::COMTypeInfo<nsINode
, T> { static const nsIID kIID __attribute__((visibility("hidden"
))); }; template <typename T> const nsIID nsINode::COMTypeInfo
<nsINode, T>::kIID __attribute__((visibility("hidden"))
) = { 0x70ba4547, 0x7699, 0x44fc, { 0xb3, 0x20, 0x52, 0xdb, 0xe3
, 0xd1, 0xf9, 0x0a } };
2471
2472inline nsISupports* ToSupports(nsINode* aPointer) { return aPointer; }
2473
2474// Some checks are faster to do on nsIContent or Element than on
2475// nsINode, so spit out FromNode versions taking those types too.
2476#define NS_IMPL_FROMNODE_GENERIC(_class, _check, _const)template <typename T> static auto FromNode(_const T&
aNode) -> decltype(static_cast<_const _class*>(&
aNode)) { return aNode._check ? static_cast<_const _class*
>(&aNode) : nullptr; } template <typename T> static
_const _class* FromNode(_const T* aNode) { return FromNode(*
aNode); } template <typename T> static _const _class* FromNodeOrNull
(_const T* aNode) { return aNode ? FromNode(*aNode) : nullptr
; } template <typename T> static auto FromEventTarget(_const
T& aEventTarget) -> decltype(static_cast<_const _class
*>(&aEventTarget)) { return aEventTarget.IsNode() &&
aEventTarget.AsNode()->_check ? static_cast<_const _class
*>(&aEventTarget) : nullptr; } template <typename T
> static _const _class* FromEventTarget(_const T* aEventTarget
) { return FromEventTarget(*aEventTarget); } template <typename
T> static _const _class* FromEventTargetOrNull(_const T* aEventTarget
) { return aEventTarget ? FromEventTarget(*aEventTarget) : nullptr
; }
\
2477 template <typename T> \
2478 static auto FromNode(_const T& aNode) \
2479 -> decltype(static_cast<_const _class*>(&aNode)) { \
2480 return aNode._check ? static_cast<_const _class*>(&aNode) : nullptr; \
2481 } \
2482 template <typename T> \
2483 static _const _class* FromNode(_const T* aNode) { \
2484 return FromNode(*aNode); \
2485 } \
2486 template <typename T> \
2487 static _const _class* FromNodeOrNull(_const T* aNode) { \
2488 return aNode ? FromNode(*aNode) : nullptr; \
2489 } \
2490 template <typename T> \
2491 static auto FromEventTarget(_const T& aEventTarget) \
2492 -> decltype(static_cast<_const _class*>(&aEventTarget)) { \
2493 return aEventTarget.IsNode() && aEventTarget.AsNode()->_check \
2494 ? static_cast<_const _class*>(&aEventTarget) \
2495 : nullptr; \
2496 } \
2497 template <typename T> \
2498 static _const _class* FromEventTarget(_const T* aEventTarget) { \
2499 return FromEventTarget(*aEventTarget); \
2500 } \
2501 template <typename T> \
2502 static _const _class* FromEventTargetOrNull(_const T* aEventTarget) { \
2503 return aEventTarget ? FromEventTarget(*aEventTarget) : nullptr; \
2504 }
2505
2506#define NS_IMPL_FROMNODE_HELPER(_class, _check)template <typename T> static auto FromNode( T& aNode
) -> decltype(static_cast< _class*>(&aNode)) { return
aNode._check ? static_cast< _class*>(&aNode) : nullptr
; } template <typename T> static _class* FromNode( T* aNode
) { return FromNode(*aNode); } template <typename T> static
_class* FromNodeOrNull( T* aNode) { return aNode ? FromNode(
*aNode) : nullptr; } template <typename T> static auto FromEventTarget
( T& aEventTarget) -> decltype(static_cast< _class*
>(&aEventTarget)) { return aEventTarget.IsNode() &&
aEventTarget.AsNode()->_check ? static_cast< _class*>
(&aEventTarget) : nullptr; } template <typename T> static
_class* FromEventTarget( T* aEventTarget) { return FromEventTarget
(*aEventTarget); } template <typename T> static _class*
FromEventTargetOrNull( T* aEventTarget) { return aEventTarget
? FromEventTarget(*aEventTarget) : nullptr; } template <typename
T> static auto FromNode(const T& aNode) -> decltype
(static_cast<const _class*>(&aNode)) { return aNode
._check ? static_cast<const _class*>(&aNode) : nullptr
; } template <typename T> static const _class* FromNode
(const T* aNode) { return FromNode(*aNode); } template <typename
T> static const _class* FromNodeOrNull(const T* aNode) { return
aNode ? FromNode(*aNode) : nullptr; } template <typename T
> static auto FromEventTarget(const T& aEventTarget) ->
decltype(static_cast<const _class*>(&aEventTarget)
) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->_check ? static_cast<const _class*>(&aEventTarget
) : nullptr; } template <typename T> static const _class
* FromEventTarget(const T* aEventTarget) { return FromEventTarget
(*aEventTarget); } template <typename T> static const _class
* FromEventTargetOrNull(const T* aEventTarget) { return aEventTarget
? FromEventTarget(*aEventTarget) : nullptr; } template <typename
T> static _class* FromNode(T&& aNode) { return aNode
->_check ? static_cast<_class*>(static_cast<nsINode
*>(aNode)) : nullptr; } template <typename T> static
_class* FromNodeOrNull(T&& aNode) { return aNode ? FromNode
(aNode) : nullptr; } template <typename T> static _class
* FromEventTarget(T&& aEventTarget) { return aEventTarget
->IsNode() && aEventTarget->AsNode()->_check
? static_cast<_class*>(static_cast<EventTarget*>
(aEventTarget)) : nullptr; } template <typename T> static
_class* FromEventTargetOrNull(T&& aEventTarget) { return
aEventTarget ? FromEventTarget(aEventTarget) : nullptr; }
\
2507 NS_IMPL_FROMNODE_GENERIC(_class, _check, )template <typename T> static auto FromNode( T& aNode
) -> decltype(static_cast< _class*>(&aNode)) { return
aNode._check ? static_cast< _class*>(&aNode) : nullptr
; } template <typename T> static _class* FromNode( T* aNode
) { return FromNode(*aNode); } template <typename T> static
_class* FromNodeOrNull( T* aNode) { return aNode ? FromNode(
*aNode) : nullptr; } template <typename T> static auto FromEventTarget
( T& aEventTarget) -> decltype(static_cast< _class*
>(&aEventTarget)) { return aEventTarget.IsNode() &&
aEventTarget.AsNode()->_check ? static_cast< _class*>
(&aEventTarget) : nullptr; } template <typename T> static
_class* FromEventTarget( T* aEventTarget) { return FromEventTarget
(*aEventTarget); } template <typename T> static _class*
FromEventTargetOrNull( T* aEventTarget) { return aEventTarget
? FromEventTarget(*aEventTarget) : nullptr; }
\
2508 NS_IMPL_FROMNODE_GENERIC(_class, _check, const)template <typename T> static auto FromNode(const T&
aNode) -> decltype(static_cast<const _class*>(&
aNode)) { return aNode._check ? static_cast<const _class*>
(&aNode) : nullptr; } template <typename T> static const
_class* FromNode(const T* aNode) { return FromNode(*aNode); }
template <typename T> static const _class* FromNodeOrNull
(const T* aNode) { return aNode ? FromNode(*aNode) : nullptr;
} template <typename T> static auto FromEventTarget(const
T& aEventTarget) -> decltype(static_cast<const _class
*>(&aEventTarget)) { return aEventTarget.IsNode() &&
aEventTarget.AsNode()->_check ? static_cast<const _class
*>(&aEventTarget) : nullptr; } template <typename T
> static const _class* FromEventTarget(const T* aEventTarget
) { return FromEventTarget(*aEventTarget); } template <typename
T> static const _class* FromEventTargetOrNull(const T* aEventTarget
) { return aEventTarget ? FromEventTarget(*aEventTarget) : nullptr
; }
\
2509 \
2510 template <typename T> \
2511 static _class* FromNode(T&& aNode) { \
2512 /* We need the double-cast in case aNode is a smartptr. Those */ \
2513 /* can cast to superclasses of the type they're templated on, */ \
2514 /* but not directly to subclasses. */ \
2515 return aNode->_check ? static_cast<_class*>(static_cast<nsINode*>(aNode)) \
2516 : nullptr; \
2517 } \
2518 template <typename T> \
2519 static _class* FromNodeOrNull(T&& aNode) { \
2520 return aNode ? FromNode(aNode) : nullptr; \
2521 } \
2522 template <typename T> \
2523 static _class* FromEventTarget(T&& aEventTarget) { \
2524 /* We need the double-cast in case aEventTarget is a smartptr. Those */ \
2525 /* can cast to superclasses of the type they're templated on, */ \
2526 /* but not directly to subclasses. */ \
2527 return aEventTarget->IsNode() && aEventTarget->AsNode()->_check \
2528 ? static_cast<_class*>(static_cast<EventTarget*>(aEventTarget)) \
2529 : nullptr; \
2530 } \
2531 template <typename T> \
2532 static _class* FromEventTargetOrNull(T&& aEventTarget) { \
2533 return aEventTarget ? FromEventTarget(aEventTarget) : nullptr; \
2534 }
2535
2536#define NS_IMPL_FROMNODE(_class, _nsid)template <typename T> static auto FromNode( T& aNode
) -> decltype(static_cast< _class*>(&aNode)) { return
aNode.IsInNamespace(_nsid) ? static_cast< _class*>(&
aNode) : nullptr; } template <typename T> static _class
* FromNode( T* aNode) { return FromNode(*aNode); } template <
typename T> static _class* FromNodeOrNull( T* aNode) { return
aNode ? FromNode(*aNode) : nullptr; } template <typename T
> static auto FromEventTarget( T& aEventTarget) -> decltype
(static_cast< _class*>(&aEventTarget)) { return aEventTarget
.IsNode() && aEventTarget.AsNode()->IsInNamespace(
_nsid) ? static_cast< _class*>(&aEventTarget) : nullptr
; } template <typename T> static _class* FromEventTarget
( T* aEventTarget) { return FromEventTarget(*aEventTarget); }
template <typename T> static _class* FromEventTargetOrNull
( T* aEventTarget) { return aEventTarget ? FromEventTarget(*aEventTarget
) : nullptr; } template <typename T> static auto FromNode
(const T& aNode) -> decltype(static_cast<const _class
*>(&aNode)) { return aNode.IsInNamespace(_nsid) ? static_cast
<const _class*>(&aNode) : nullptr; } template <typename
T> static const _class* FromNode(const T* aNode) { return
FromNode(*aNode); } template <typename T> static const
_class* FromNodeOrNull(const T* aNode) { return aNode ? FromNode
(*aNode) : nullptr; } template <typename T> static auto
FromEventTarget(const T& aEventTarget) -> decltype(static_cast
<const _class*>(&aEventTarget)) { return aEventTarget
.IsNode() && aEventTarget.AsNode()->IsInNamespace(
_nsid) ? static_cast<const _class*>(&aEventTarget) :
nullptr; } template <typename T> static const _class* FromEventTarget
(const T* aEventTarget) { return FromEventTarget(*aEventTarget
); } template <typename T> static const _class* FromEventTargetOrNull
(const T* aEventTarget) { return aEventTarget ? FromEventTarget
(*aEventTarget) : nullptr; } template <typename T> static
_class* FromNode(T&& aNode) { return aNode->IsInNamespace
(_nsid) ? static_cast<_class*>(static_cast<nsINode*>
(aNode)) : nullptr; } template <typename T> static _class
* FromNodeOrNull(T&& aNode) { return aNode ? FromNode
(aNode) : nullptr; } template <typename T> static _class
* FromEventTarget(T&& aEventTarget) { return aEventTarget
->IsNode() && aEventTarget->AsNode()->IsInNamespace
(_nsid) ? static_cast<_class*>(static_cast<EventTarget
*>(aEventTarget)) : nullptr; } template <typename T>
static _class* FromEventTargetOrNull(T&& aEventTarget
) { return aEventTarget ? FromEventTarget(aEventTarget) : nullptr
; }
\
2537 NS_IMPL_FROMNODE_HELPER(_class, IsInNamespace(_nsid))template <typename T> static auto FromNode( T& aNode
) -> decltype(static_cast< _class*>(&aNode)) { return
aNode.IsInNamespace(_nsid) ? static_cast< _class*>(&
aNode) : nullptr; } template <typename T> static _class
* FromNode( T* aNode) { return FromNode(*aNode); } template <
typename T> static _class* FromNodeOrNull( T* aNode) { return
aNode ? FromNode(*aNode) : nullptr; } template <typename T
> static auto FromEventTarget( T& aEventTarget) -> decltype
(static_cast< _class*>(&aEventTarget)) { return aEventTarget
.IsNode() && aEventTarget.AsNode()->IsInNamespace(
_nsid) ? static_cast< _class*>(&aEventTarget) : nullptr
; } template <typename T> static _class* FromEventTarget
( T* aEventTarget) { return FromEventTarget(*aEventTarget); }
template <typename T> static _class* FromEventTargetOrNull
( T* aEventTarget) { return aEventTarget ? FromEventTarget(*aEventTarget
) : nullptr; } template <typename T> static auto FromNode
(const T& aNode) -> decltype(static_cast<const _class
*>(&aNode)) { return aNode.IsInNamespace(_nsid) ? static_cast
<const _class*>(&aNode) : nullptr; } template <typename
T> static const _class* FromNode(const T* aNode) { return
FromNode(*aNode); } template <typename T> static const
_class* FromNodeOrNull(const T* aNode) { return aNode ? FromNode
(*aNode) : nullptr; } template <typename T> static auto
FromEventTarget(const T& aEventTarget) -> decltype(static_cast
<const _class*>(&aEventTarget)) { return aEventTarget
.IsNode() && aEventTarget.AsNode()->IsInNamespace(
_nsid) ? static_cast<const _class*>(&aEventTarget) :
nullptr; } template <typename T> static const _class* FromEventTarget
(const T* aEventTarget) { return FromEventTarget(*aEventTarget
); } template <typename T> static const _class* FromEventTargetOrNull
(const T* aEventTarget) { return aEventTarget ? FromEventTarget
(*aEventTarget) : nullptr; } template <typename T> static
_class* FromNode(T&& aNode) { return aNode->IsInNamespace
(_nsid) ? static_cast<_class*>(static_cast<nsINode*>
(aNode)) : nullptr; } template <typename T> static _class
* FromNodeOrNull(T&& aNode) { return aNode ? FromNode
(aNode) : nullptr; } template <typename T> static _class
* FromEventTarget(T&& aEventTarget) { return aEventTarget
->IsNode() && aEventTarget->AsNode()->IsInNamespace
(_nsid) ? static_cast<_class*>(static_cast<EventTarget
*>(aEventTarget)) : nullptr; } template <typename T>
static _class* FromEventTargetOrNull(T&& aEventTarget
) { return aEventTarget ? FromEventTarget(aEventTarget) : nullptr
; }
2538
2539#define NS_IMPL_FROMNODE_WITH_TAG(_class, _nsid, _tag)template <typename T> static auto FromNode( T& aNode
) -> decltype(static_cast< _class*>(&aNode)) { return
aNode.NodeInfo()->Equals(nsGkAtoms::_tag, _nsid) ? static_cast
< _class*>(&aNode) : nullptr; } template <typename
T> static _class* FromNode( T* aNode) { return FromNode(*
aNode); } template <typename T> static _class* FromNodeOrNull
( T* aNode) { return aNode ? FromNode(*aNode) : nullptr; } template
<typename T> static auto FromEventTarget( T& aEventTarget
) -> decltype(static_cast< _class*>(&aEventTarget
)) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->NodeInfo()->Equals(nsGkAtoms::_tag, _nsid) ? static_cast
< _class*>(&aEventTarget) : nullptr; } template <
typename T> static _class* FromEventTarget( T* aEventTarget
) { return FromEventTarget(*aEventTarget); } template <typename
T> static _class* FromEventTargetOrNull( T* aEventTarget)
{ return aEventTarget ? FromEventTarget(*aEventTarget) : nullptr
; } template <typename T> static auto FromNode(const T&
aNode) -> decltype(static_cast<const _class*>(&
aNode)) { return aNode.NodeInfo()->Equals(nsGkAtoms::_tag,
_nsid) ? static_cast<const _class*>(&aNode) : nullptr
; } template <typename T> static const _class* FromNode
(const T* aNode) { return FromNode(*aNode); } template <typename
T> static const _class* FromNodeOrNull(const T* aNode) { return
aNode ? FromNode(*aNode) : nullptr; } template <typename T
> static auto FromEventTarget(const T& aEventTarget) ->
decltype(static_cast<const _class*>(&aEventTarget)
) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->NodeInfo()->Equals(nsGkAtoms::_tag, _nsid) ? static_cast
<const _class*>(&aEventTarget) : nullptr; } template
<typename T> static const _class* FromEventTarget(const
T* aEventTarget) { return FromEventTarget(*aEventTarget); } template
<typename T> static const _class* FromEventTargetOrNull
(const T* aEventTarget) { return aEventTarget ? FromEventTarget
(*aEventTarget) : nullptr; } template <typename T> static
_class* FromNode(T&& aNode) { return aNode->NodeInfo
()->Equals(nsGkAtoms::_tag, _nsid) ? static_cast<_class
*>(static_cast<nsINode*>(aNode)) : nullptr; } template
<typename T> static _class* FromNodeOrNull(T&&
aNode) { return aNode ? FromNode(aNode) : nullptr; } template
<typename T> static _class* FromEventTarget(T&&
aEventTarget) { return aEventTarget->IsNode() && aEventTarget
->AsNode()->NodeInfo()->Equals(nsGkAtoms::_tag, _nsid
) ? static_cast<_class*>(static_cast<EventTarget*>
(aEventTarget)) : nullptr; } template <typename T> static
_class* FromEventTargetOrNull(T&& aEventTarget) { return
aEventTarget ? FromEventTarget(aEventTarget) : nullptr; }
\
2540 NS_IMPL_FROMNODE_HELPER(_class, NodeInfo()->Equals(nsGkAtoms::_tag, _nsid))template <typename T> static auto FromNode( T& aNode
) -> decltype(static_cast< _class*>(&aNode)) { return
aNode.NodeInfo()->Equals(nsGkAtoms::_tag, _nsid) ? static_cast
< _class*>(&aNode) : nullptr; } template <typename
T> static _class* FromNode( T* aNode) { return FromNode(*
aNode); } template <typename T> static _class* FromNodeOrNull
( T* aNode) { return aNode ? FromNode(*aNode) : nullptr; } template
<typename T> static auto FromEventTarget( T& aEventTarget
) -> decltype(static_cast< _class*>(&aEventTarget
)) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->NodeInfo()->Equals(nsGkAtoms::_tag, _nsid) ? static_cast
< _class*>(&aEventTarget) : nullptr; } template <
typename T> static _class* FromEventTarget( T* aEventTarget
) { return FromEventTarget(*aEventTarget); } template <typename
T> static _class* FromEventTargetOrNull( T* aEventTarget)
{ return aEventTarget ? FromEventTarget(*aEventTarget) : nullptr
; } template <typename T> static auto FromNode(const T&
aNode) -> decltype(static_cast<const _class*>(&
aNode)) { return aNode.NodeInfo()->Equals(nsGkAtoms::_tag,
_nsid) ? static_cast<const _class*>(&aNode) : nullptr
; } template <typename T> static const _class* FromNode
(const T* aNode) { return FromNode(*aNode); } template <typename
T> static const _class* FromNodeOrNull(const T* aNode) { return
aNode ? FromNode(*aNode) : nullptr; } template <typename T
> static auto FromEventTarget(const T& aEventTarget) ->
decltype(static_cast<const _class*>(&aEventTarget)
) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->NodeInfo()->Equals(nsGkAtoms::_tag, _nsid) ? static_cast
<const _class*>(&aEventTarget) : nullptr; } template
<typename T> static const _class* FromEventTarget(const
T* aEventTarget) { return FromEventTarget(*aEventTarget); } template
<typename T> static const _class* FromEventTargetOrNull
(const T* aEventTarget) { return aEventTarget ? FromEventTarget
(*aEventTarget) : nullptr; } template <typename T> static
_class* FromNode(T&& aNode) { return aNode->NodeInfo
()->Equals(nsGkAtoms::_tag, _nsid) ? static_cast<_class
*>(static_cast<nsINode*>(aNode)) : nullptr; } template
<typename T> static _class* FromNodeOrNull(T&&
aNode) { return aNode ? FromNode(aNode) : nullptr; } template
<typename T> static _class* FromEventTarget(T&&
aEventTarget) { return aEventTarget->IsNode() && aEventTarget
->AsNode()->NodeInfo()->Equals(nsGkAtoms::_tag, _nsid
) ? static_cast<_class*>(static_cast<EventTarget*>
(aEventTarget)) : nullptr; } template <typename T> static
_class* FromEventTargetOrNull(T&& aEventTarget) { return
aEventTarget ? FromEventTarget(aEventTarget) : nullptr; }
2541
2542#define NS_IMPL_FROMNODE_HTML_WITH_TAG(_class, _tag)template <typename T> static auto FromNode( T& aNode
) -> decltype(static_cast< _class*>(&aNode)) { return
aNode.NodeInfo()->Equals(nsGkAtoms::_tag, 3) ? static_cast
< _class*>(&aNode) : nullptr; } template <typename
T> static _class* FromNode( T* aNode) { return FromNode(*
aNode); } template <typename T> static _class* FromNodeOrNull
( T* aNode) { return aNode ? FromNode(*aNode) : nullptr; } template
<typename T> static auto FromEventTarget( T& aEventTarget
) -> decltype(static_cast< _class*>(&aEventTarget
)) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->NodeInfo()->Equals(nsGkAtoms::_tag, 3) ? static_cast
< _class*>(&aEventTarget) : nullptr; } template <
typename T> static _class* FromEventTarget( T* aEventTarget
) { return FromEventTarget(*aEventTarget); } template <typename
T> static _class* FromEventTargetOrNull( T* aEventTarget)
{ return aEventTarget ? FromEventTarget(*aEventTarget) : nullptr
; } template <typename T> static auto FromNode(const T&
aNode) -> decltype(static_cast<const _class*>(&
aNode)) { return aNode.NodeInfo()->Equals(nsGkAtoms::_tag,
3) ? static_cast<const _class*>(&aNode) : nullptr;
} template <typename T> static const _class* FromNode(
const T* aNode) { return FromNode(*aNode); } template <typename
T> static const _class* FromNodeOrNull(const T* aNode) { return
aNode ? FromNode(*aNode) : nullptr; } template <typename T
> static auto FromEventTarget(const T& aEventTarget) ->
decltype(static_cast<const _class*>(&aEventTarget)
) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->NodeInfo()->Equals(nsGkAtoms::_tag, 3) ? static_cast
<const _class*>(&aEventTarget) : nullptr; } template
<typename T> static const _class* FromEventTarget(const
T* aEventTarget) { return FromEventTarget(*aEventTarget); } template
<typename T> static const _class* FromEventTargetOrNull
(const T* aEventTarget) { return aEventTarget ? FromEventTarget
(*aEventTarget) : nullptr; } template <typename T> static
_class* FromNode(T&& aNode) { return aNode->NodeInfo
()->Equals(nsGkAtoms::_tag, 3) ? static_cast<_class*>
(static_cast<nsINode*>(aNode)) : nullptr; } template <
typename T> static _class* FromNodeOrNull(T&& aNode
) { return aNode ? FromNode(aNode) : nullptr; } template <
typename T> static _class* FromEventTarget(T&& aEventTarget
) { return aEventTarget->IsNode() && aEventTarget->
AsNode()->NodeInfo()->Equals(nsGkAtoms::_tag, 3) ? static_cast
<_class*>(static_cast<EventTarget*>(aEventTarget)
) : nullptr; } template <typename T> static _class* FromEventTargetOrNull
(T&& aEventTarget) { return aEventTarget ? FromEventTarget
(aEventTarget) : nullptr; }
\
2543 NS_IMPL_FROMNODE_WITH_TAG(_class, kNameSpaceID_XHTML, _tag)template <typename T> static auto FromNode( T& aNode
) -> decltype(static_cast< _class*>(&aNode)) { return
aNode.NodeInfo()->Equals(nsGkAtoms::_tag, 3) ? static_cast
< _class*>(&aNode) : nullptr; } template <typename
T> static _class* FromNode( T* aNode) { return FromNode(*
aNode); } template <typename T> static _class* FromNodeOrNull
( T* aNode) { return aNode ? FromNode(*aNode) : nullptr; } template
<typename T> static auto FromEventTarget( T& aEventTarget
) -> decltype(static_cast< _class*>(&aEventTarget
)) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->NodeInfo()->Equals(nsGkAtoms::_tag, 3) ? static_cast
< _class*>(&aEventTarget) : nullptr; } template <
typename T> static _class* FromEventTarget( T* aEventTarget
) { return FromEventTarget(*aEventTarget); } template <typename
T> static _class* FromEventTargetOrNull( T* aEventTarget)
{ return aEventTarget ? FromEventTarget(*aEventTarget) : nullptr
; } template <typename T> static auto FromNode(const T&
aNode) -> decltype(static_cast<const _class*>(&
aNode)) { return aNode.NodeInfo()->Equals(nsGkAtoms::_tag,
3) ? static_cast<const _class*>(&aNode) : nullptr;
} template <typename T> static const _class* FromNode(
const T* aNode) { return FromNode(*aNode); } template <typename
T> static const _class* FromNodeOrNull(const T* aNode) { return
aNode ? FromNode(*aNode) : nullptr; } template <typename T
> static auto FromEventTarget(const T& aEventTarget) ->
decltype(static_cast<const _class*>(&aEventTarget)
) { return aEventTarget.IsNode() && aEventTarget.AsNode
()->NodeInfo()->Equals(nsGkAtoms::_tag, 3) ? static_cast
<const _class*>(&aEventTarget) : nullptr; } template
<typename T> static const _class* FromEventTarget(const
T* aEventTarget) { return FromEventTarget(*aEventTarget); } template
<typename T> static const _class* FromEventTargetOrNull
(const T* aEventTarget) { return aEventTarget ? FromEventTarget
(*aEventTarget) : nullptr; } template <typename T> static
_class* FromNode(T&& aNode) { return aNode->NodeInfo
()->Equals(nsGkAtoms::_tag, 3) ? static_cast<_class*>
(static_cast<nsINode*>(aNode)) : nullptr; } template <
typename T> static _class* FromNodeOrNull(T&& aNode
) { return aNode ? FromNode(aNode) : nullptr; } template <
typename T> static _class* FromEventTarget(T&& aEventTarget
) { return aEventTarget->IsNode() && aEventTarget->
AsNode()->NodeInfo()->Equals(nsGkAtoms::_tag, 3) ? static_cast
<_class*>(static_cast<EventTarget*>(aEventTarget)
) : nullptr; } template <typename T> static _class* FromEventTargetOrNull
(T&& aEventTarget) { return aEventTarget ? FromEventTarget
(aEventTarget) : nullptr; }
2544
2545#endif /* nsINode_h___ */

/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h

1/* -*- Mode: C++; tab-width: 2; 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
7/* A class for optional values and in-place lazy construction. */
8
9#ifndef mozilla_Maybe_h
10#define mozilla_Maybe_h
11
12#include <functional>
13#include <new> // for placement new
14#include <ostream>
15#include <type_traits>
16#include <utility>
17
18#include "mozilla/Alignment.h"
19#include "mozilla/Assertions.h"
20#include "mozilla/Attributes.h"
21#include "mozilla/MaybeStorageBase.h"
22#include "mozilla/MemoryChecking.h"
23#include "mozilla/OperatorNewExtensions.h"
24#include "mozilla/Poison.h"
25#include "mozilla/ThreadSafety.h"
26
27class nsCycleCollectionTraversalCallback;
28
29template <typename T>
30inline void CycleCollectionNoteChild(
31 nsCycleCollectionTraversalCallback& aCallback, T* aChild, const char* aName,
32 uint32_t aFlags);
33
34namespace mozilla {
35
36struct Nothing {};
37
38inline constexpr bool operator==(const Nothing&, const Nothing&) {
39 return true;
40}
41
42template <class T>
43class Maybe;
44
45namespace detail {
46
47// You would think that poisoning Maybe instances could just be a call
48// to mozWritePoison. Unfortunately, using a simple call to
49// mozWritePoison generates poor code on MSVC for small structures. The
50// generated code contains (always not-taken) branches and does a bunch
51// of setup for `rep stos{l,q}`, even though we know at compile time
52// exactly how many words we're poisoning. Instead, we're going to
53// force MSVC to generate the code we want via recursive templates.
54
55// Write the given poisonValue into p at offset*sizeof(uintptr_t).
56template <size_t offset>
57inline void WritePoisonAtOffset(void* p, const uintptr_t poisonValue) {
58 memcpy(static_cast<char*>(p) + offset * sizeof(poisonValue), &poisonValue,
59 sizeof(poisonValue));
60}
61
62template <size_t Offset, size_t NOffsets>
63struct InlinePoisoner {
64 static void poison(void* p, const uintptr_t poisonValue) {
65 WritePoisonAtOffset<Offset>(p, poisonValue);
66 InlinePoisoner<Offset + 1, NOffsets>::poison(p, poisonValue);
67 }
68};
69
70template <size_t N>
71struct InlinePoisoner<N, N> {
72 static void poison(void*, const uintptr_t) {
73 // All done!
74 }
75};
76
77// We can't generate inline code for large structures, though, because we'll
78// blow out recursive template instantiation limits, and the code would be
79// bloated to boot. So provide a fallback to the out-of-line poisoner.
80template <size_t ObjectSize>
81struct OutOfLinePoisoner {
82 static MOZ_NEVER_INLINE__attribute__((noinline)) void poison(void* p, const uintptr_t) {
83 mozWritePoison(p, ObjectSize);
84 }
85};
86
87template <typename T>
88inline void PoisonObject(T* p) {
89 const uintptr_t POISON = mozPoisonValue();
90 std::conditional_t<(sizeof(T) <= 8 * sizeof(POISON)),
91 InlinePoisoner<0, sizeof(T) / sizeof(POISON)>,
92 OutOfLinePoisoner<sizeof(T)>>::poison(p, POISON);
93}
94
95template <typename T>
96struct MaybePoisoner {
97 static const size_t N = sizeof(T);
98
99 static void poison(void* aPtr) {
100#ifdef MOZ_DIAGNOSTIC_ASSERT_ENABLED1
101 if (N >= sizeof(uintptr_t)) {
102 PoisonObject(static_cast<std::remove_cv_t<T>*>(aPtr));
103 }
104#endif
105 MOZ_MAKE_MEM_UNDEFINED(aPtr, N)do { } while (0);
106 }
107};
108
109template <typename T,
110 bool TriviallyDestructibleAndCopyable =
111 IsTriviallyDestructibleAndCopyable<T>,
112 bool Copyable = std::is_copy_constructible_v<T>,
113 bool Movable = std::is_move_constructible_v<T>>
114class Maybe_CopyMove_Enabler;
115
116#define MOZ_MAYBE_COPY_OPS() \
117 Maybe_CopyMove_Enabler(const Maybe_CopyMove_Enabler& aOther) { \
118 if (downcast(aOther).isSome()) { \
119 downcast(*this).emplace(*downcast(aOther)); \
120 } \
121 } \
122 \
123 Maybe_CopyMove_Enabler& operator=(const Maybe_CopyMove_Enabler& aOther) { \
124 return downcast(*this).template operator= <T>(downcast(aOther)); \
125 }
126
127#define MOZ_MAYBE_MOVE_OPS() \
128 constexpr Maybe_CopyMove_Enabler(Maybe_CopyMove_Enabler&& aOther) { \
129 if (downcast(aOther).isSome()) { \
130 downcast(*this).emplace(std::move(*downcast(aOther))); \
131 downcast(aOther).reset(); \
132 } \
133 } \
134 \
135 constexpr Maybe_CopyMove_Enabler& operator=( \
136 Maybe_CopyMove_Enabler&& aOther) { \
137 downcast(*this).template operator= <T>(std::move(downcast(aOther))); \
138 \
139 return *this; \
140 }
141
142#define MOZ_MAYBE_DOWNCAST() \
143 static constexpr Maybe<T>& downcast(Maybe_CopyMove_Enabler& aObj) { \
144 return static_cast<Maybe<T>&>(aObj); \
145 } \
146 static constexpr const Maybe<T>& downcast( \
147 const Maybe_CopyMove_Enabler& aObj) { \
148 return static_cast<const Maybe<T>&>(aObj); \
149 }
150
151template <typename T>
152class Maybe_CopyMove_Enabler<T, true, true, true> {
153 public:
154 Maybe_CopyMove_Enabler() = default;
155
156 Maybe_CopyMove_Enabler(const Maybe_CopyMove_Enabler&) = default;
157 Maybe_CopyMove_Enabler& operator=(const Maybe_CopyMove_Enabler&) = default;
158 constexpr Maybe_CopyMove_Enabler(Maybe_CopyMove_Enabler&& aOther) {
159 downcast(aOther).reset();
160 }
161 constexpr Maybe_CopyMove_Enabler& operator=(Maybe_CopyMove_Enabler&& aOther) {
162 downcast(aOther).reset();
163 return *this;
164 }
165
166 private:
167 MOZ_MAYBE_DOWNCAST()
168};
169
170template <typename T>
171class Maybe_CopyMove_Enabler<T, true, false, true> {
172 public:
173 Maybe_CopyMove_Enabler() = default;
174
175 Maybe_CopyMove_Enabler(const Maybe_CopyMove_Enabler&) = delete;
176 Maybe_CopyMove_Enabler& operator=(const Maybe_CopyMove_Enabler&) = delete;
177 constexpr Maybe_CopyMove_Enabler(Maybe_CopyMove_Enabler&& aOther) {
178 downcast(aOther).reset();
179 }
180 constexpr Maybe_CopyMove_Enabler& operator=(Maybe_CopyMove_Enabler&& aOther) {
181 downcast(aOther).reset();
182 return *this;
183 }
184
185 private:
186 MOZ_MAYBE_DOWNCAST()
187};
188
189template <typename T>
190class Maybe_CopyMove_Enabler<T, false, true, true> {
191 public:
192 Maybe_CopyMove_Enabler() = default;
193
194 MOZ_MAYBE_COPY_OPS()
195 MOZ_MAYBE_MOVE_OPS()
196
197 private:
198 MOZ_MAYBE_DOWNCAST()
199};
200
201template <typename T>
202class Maybe_CopyMove_Enabler<T, false, false, true> {
203 public:
204 Maybe_CopyMove_Enabler() = default;
205
206 Maybe_CopyMove_Enabler(const Maybe_CopyMove_Enabler&) = delete;
207 Maybe_CopyMove_Enabler& operator=(const Maybe_CopyMove_Enabler&) = delete;
208 MOZ_MAYBE_MOVE_OPS()
209
210 private:
211 MOZ_MAYBE_DOWNCAST()
212};
213
214template <typename T>
215class Maybe_CopyMove_Enabler<T, false, true, false> {
216 public:
217 Maybe_CopyMove_Enabler() = default;
218
219 MOZ_MAYBE_COPY_OPS()
220 Maybe_CopyMove_Enabler(Maybe_CopyMove_Enabler&&) = delete;
221 Maybe_CopyMove_Enabler& operator=(Maybe_CopyMove_Enabler&&) = delete;
222
223 private:
224 MOZ_MAYBE_DOWNCAST()
225};
226
227template <typename T, bool TriviallyDestructibleAndCopyable>
228class Maybe_CopyMove_Enabler<T, TriviallyDestructibleAndCopyable, false,
229 false> {
230 public:
231 Maybe_CopyMove_Enabler() = default;
232
233 Maybe_CopyMove_Enabler(const Maybe_CopyMove_Enabler&) = delete;
234 Maybe_CopyMove_Enabler& operator=(const Maybe_CopyMove_Enabler&) = delete;
235 Maybe_CopyMove_Enabler(Maybe_CopyMove_Enabler&&) = delete;
236 Maybe_CopyMove_Enabler& operator=(Maybe_CopyMove_Enabler&&) = delete;
237};
238
239#undef MOZ_MAYBE_COPY_OPS
240#undef MOZ_MAYBE_MOVE_OPS
241#undef MOZ_MAYBE_DOWNCAST
242
243template <typename T, bool TriviallyDestructibleAndCopyable =
244 IsTriviallyDestructibleAndCopyable<T>>
245struct MaybeStorage;
246
247template <typename T>
248struct MaybeStorage<T, false> : MaybeStorageBase<T> {
249 protected:
250 char mIsSome = false; // not bool -- guarantees minimal space consumption
251
252 MaybeStorage() = default;
253 explicit MaybeStorage(const T& aVal)
254 : MaybeStorageBase<T>{aVal}, mIsSome{true} {}
255 explicit MaybeStorage(T&& aVal)
256 : MaybeStorageBase<T>{std::move(aVal)}, mIsSome{true} {}
257
258 template <typename... Args>
259 explicit MaybeStorage(std::in_place_t, Args&&... aArgs)
260 : MaybeStorageBase<T>{std::in_place, std::forward<Args>(aArgs)...},
261 mIsSome{true} {}
262
263 public:
264 // Copy and move operations are no-ops, since copying is moving is implemented
265 // by Maybe_CopyMove_Enabler.
266
267 MaybeStorage(const MaybeStorage&) : MaybeStorageBase<T>{} {}
268 MaybeStorage& operator=(const MaybeStorage&) { return *this; }
269 MaybeStorage(MaybeStorage&&) : MaybeStorageBase<T>{} {}
270 MaybeStorage& operator=(MaybeStorage&&) { return *this; }
271
272 ~MaybeStorage() {
273 if (mIsSome
9.1
Field 'mIsSome' is 1
9.1
Field 'mIsSome' is 1
9.1
Field 'mIsSome' is 1
9.1
Field 'mIsSome' is 1
9.1
Field 'mIsSome' is 1
) {
10
Taking true branch
274 this->addr()->T::~T();
11
Calling '~ByteBuf'
13
Returning; memory was released
275 }
276 }
14
Calling implicit destructor for 'MaybeStorageBase<mozilla::ipc::ByteBuf, false>'
15
Calling '~Union'
277};
278
279template <typename T>
280struct MaybeStorage<T, true> : MaybeStorageBase<T> {
281 protected:
282 char mIsSome = false; // not bool -- guarantees minimal space consumption
283
284 constexpr MaybeStorage() = default;
285 constexpr explicit MaybeStorage(const T& aVal)
286 : MaybeStorageBase<T>{aVal}, mIsSome{true} {}
287 constexpr explicit MaybeStorage(T&& aVal)
288 : MaybeStorageBase<T>{std::move(aVal)}, mIsSome{true} {}
289
290 template <typename... Args>
291 constexpr explicit MaybeStorage(std::in_place_t, Args&&... aArgs)
292 : MaybeStorageBase<T>{std::in_place, std::forward<Args>(aArgs)...},
293 mIsSome{true} {}
294};
295
296template <typename T>
297struct IsMaybeImpl : std::false_type {};
298
299template <typename T>
300struct IsMaybeImpl<Maybe<T>> : std::true_type {};
301
302template <typename T>
303using IsMaybe = IsMaybeImpl<std::decay_t<T>>;
304
305} // namespace detail
306
307template <typename T, typename U = typename std::remove_cv<
308 typename std::remove_reference<T>::type>::type>
309constexpr Maybe<U> Some(T&& aValue);
310
311/*
312 * Maybe is a container class which contains either zero or one elements. It
313 * serves two roles. It can represent values which are *semantically* optional,
314 * augmenting a type with an explicit 'Nothing' value. In this role, it provides
315 * methods that make it easy to work with values that may be missing, along with
316 * equality and comparison operators so that Maybe values can be stored in
317 * containers. Maybe values can be constructed conveniently in expressions using
318 * type inference, as follows:
319 *
320 * void doSomething(Maybe<Foo> aFoo) {
321 * if (aFoo) // Make sure that aFoo contains a value...
322 * aFoo->takeAction(); // and then use |aFoo->| to access it.
323 * } // |*aFoo| also works!
324 *
325 * doSomething(Nothing()); // Passes a Maybe<Foo> containing no value.
326 * doSomething(Some(Foo(100))); // Passes a Maybe<Foo> containing |Foo(100)|.
327 *
328 * You'll note that it's important to check whether a Maybe contains a value
329 * before using it, using conversion to bool, |isSome()|, or |isNothing()|. You
330 * can avoid these checks, and sometimes write more readable code, using
331 * |valueOr()|, |ptrOr()|, and |refOr()|, which allow you to retrieve the value
332 * in the Maybe and provide a default for the 'Nothing' case. You can also use
333 * |apply()| to call a function only if the Maybe holds a value, and |map()| to
334 * transform the value in the Maybe, returning another Maybe with a possibly
335 * different type.
336 *
337 * Maybe's other role is to support lazily constructing objects without using
338 * dynamic storage. A Maybe directly contains storage for a value, but it's
339 * empty by default. |emplace()|, as mentioned above, can be used to construct a
340 * value in Maybe's storage. The value a Maybe contains can be destroyed by
341 * calling |reset()|; this will happen automatically if a Maybe is destroyed
342 * while holding a value.
343 *
344 * It's a common idiom in C++ to use a pointer as a 'Maybe' type, with a null
345 * value meaning 'Nothing' and any other value meaning 'Some'. You can convert
346 * from such a pointer to a Maybe value using 'ToMaybe()'.
347 *
348 * Maybe is inspired by similar types in the standard library of many other
349 * languages (e.g. Haskell's Maybe and Rust's Option). In the C++ world it's
350 * very similar to std::optional, which was proposed for C++14 and originated in
351 * Boost. The most important differences between Maybe and std::optional are:
352 *
353 * - std::optional<T> may be compared with T. We deliberately forbid that.
354 * - std::optional has |valueOr()|, equivalent to Maybe's |valueOr()|, but
355 * lacks corresponding methods for |refOr()| and |ptrOr()|.
356 * - std::optional lacks |map()| and |apply()|, making it less suitable for
357 * functional-style code.
358 * - std::optional lacks many convenience functions that Maybe has. Most
359 * unfortunately, it lacks equivalents of the type-inferred constructor
360 * functions |Some()| and |Nothing()|.
361 */
362template <class T>
363class MOZ_INHERIT_TYPE_ANNOTATIONS_FROM_TEMPLATE_ARGS Maybe
364 : private detail::MaybeStorage<T>,
365 public detail::Maybe_CopyMove_Enabler<T> {
366 template <typename, bool, bool, bool>
367 friend class detail::Maybe_CopyMove_Enabler;
368
369 template <typename U, typename V>
370 friend constexpr Maybe<V> Some(U&& aValue);
371
372 struct SomeGuard {};
373
374 template <typename U>
375 constexpr Maybe(U&& aValue, SomeGuard)
376 : detail::MaybeStorage<T>{std::forward<U>(aValue)} {}
377
378 using detail::MaybeStorage<T>::mIsSome;
379 using detail::MaybeStorage<T>::mStorage;
380
381 void poisonData() { detail::MaybePoisoner<T>::poison(&mStorage.val); }
382
383 public:
384 using ValueType = T;
385
386 MOZ_ALLOW_TEMPORARY constexpr Maybe() = default;
387
388 MOZ_ALLOW_TEMPORARY MOZ_IMPLICIT constexpr Maybe(Nothing) : Maybe{} {}
389
390 template <typename... Args>
391 constexpr explicit Maybe(std::in_place_t, Args&&... aArgs)
392 : detail::MaybeStorage<T>{std::in_place, std::forward<Args>(aArgs)...} {}
393
394 /**
395 * Maybe<T> can be copy-constructed from a Maybe<U> if T is constructible from
396 * a const U&.
397 */
398 template <typename U,
399 std::enable_if_t<std::is_constructible_v<T, const U&>, bool> = true>
400 MOZ_IMPLICIT Maybe(const Maybe<U>& aOther) {
401 if (aOther.isSome()) {
402 emplace(*aOther);
403 }
404 }
405
406 template <typename U, std::enable_if_t<!std::is_constructible_v<T, const U&>,
407 bool> = true>
408 explicit Maybe(const Maybe<U>& aOther) = delete;
409
410 /**
411 * Maybe<T> can be move-constructed from a Maybe<U> if T is constructible from
412 * a U&&.
413 */
414 template <typename U,
415 std::enable_if_t<std::is_constructible_v<T, U&&>, bool> = true>
416 MOZ_IMPLICIT Maybe(Maybe<U>&& aOther) {
417 if (aOther.isSome()) {
418 emplace(std::move(*aOther));
419 aOther.reset();
420 }
421 }
422 template <typename U,
423 std::enable_if_t<!std::is_constructible_v<T, U&&>, bool> = true>
424 explicit Maybe(Maybe<U>&& aOther) = delete;
425
426 template <typename U,
427 std::enable_if_t<std::is_constructible_v<T, const U&>, bool> = true>
428 Maybe& operator=(const Maybe<U>& aOther) {
429 if (aOther.isSome()) {
430 if (mIsSome) {
431 ref() = aOther.ref();
432 } else {
433 emplace(*aOther);
434 }
435 } else {
436 reset();
437 }
438 return *this;
439 }
440
441 template <typename U, std::enable_if_t<!std::is_constructible_v<T, const U&>,
442 bool> = true>
443 Maybe& operator=(const Maybe<U>& aOther) = delete;
444
445 template <typename U,
446 std::enable_if_t<std::is_constructible_v<T, U&&>, bool> = true>
447 Maybe& operator=(Maybe<U>&& aOther) {
448 if (aOther.isSome()) {
449 if (mIsSome) {
450 ref() = std::move(aOther.ref());
451 } else {
452 emplace(std::move(*aOther));
453 }
454 aOther.reset();
455 } else {
456 reset();
457 }
458
459 return *this;
460 }
461
462 template <typename U,
463 std::enable_if_t<!std::is_constructible_v<T, U&&>, bool> = true>
464 Maybe& operator=(Maybe<U>&& aOther) = delete;
465
466 constexpr Maybe& operator=(Nothing) {
467 reset();
468 return *this;
469 }
470
471 /* Methods that check whether this Maybe contains a value */
472 constexpr explicit operator bool() const { return isSome(); }
473 constexpr bool isSome() const { return mIsSome; }
474 constexpr bool isNothing() const { return !mIsSome; }
475
476 /* Returns the contents of this Maybe<T> by value. Unsafe unless |isSome()|.
477 */
478 constexpr T value() const&;
479 constexpr T value() &&;
480 constexpr T value() const&&;
481
482 /**
483 * Move the contents of this Maybe<T> out of internal storage and return it
484 * without calling the destructor. The internal storage is also reset to
485 * avoid multiple calls. Unsafe unless |isSome()|.
486 */
487 constexpr T extract() {
488 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 488); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 488; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
489 T v = std::move(mStorage.val);
490 reset();
491 return v;
492 }
493
494 /**
495 * Returns the value (possibly |Nothing()|) by moving it out of this Maybe<T>
496 * and leaving |Nothing()| in its place.
497 */
498 Maybe<T> take() { return std::exchange(*this, Nothing()); }
499
500 /*
501 * Returns the contents of this Maybe<T> by value. If |isNothing()|, returns
502 * the default value provided.
503 *
504 * Note: If the value passed to aDefault is not the result of a trivial
505 * expression, but expensive to evaluate, e.g. |valueOr(ExpensiveFunction())|,
506 * use |valueOrFrom| instead, e.g.
507 * |valueOrFrom([arg] { return ExpensiveFunction(arg); })|. This ensures
508 * that the expensive expression is only evaluated when its result will
509 * actually be used.
510 */
511 template <typename V>
512 constexpr T valueOr(V&& aDefault) const {
513 if (isSome()) {
514 return ref();
515 }
516 return std::forward<V>(aDefault);
517 }
518
519 /*
520 * Returns the contents of this Maybe<T> by value. If |isNothing()|, returns
521 * the value returned from the function or functor provided.
522 */
523 template <typename F>
524 constexpr T valueOrFrom(F&& aFunc) const {
525 if (isSome()) {
526 return ref();
527 }
528 return aFunc();
529 }
530
531 /* Returns the contents of this Maybe<T> by pointer. Unsafe unless |isSome()|.
532 */
533 T* ptr();
534 constexpr const T* ptr() const;
535
536 /*
537 * Returns the contents of this Maybe<T> by pointer. If |isNothing()|,
538 * returns the default value provided.
539 */
540 T* ptrOr(T* aDefault) {
541 if (isSome()) {
542 return ptr();
543 }
544 return aDefault;
545 }
546
547 constexpr const T* ptrOr(const T* aDefault) const {
548 if (isSome()) {
549 return ptr();
550 }
551 return aDefault;
552 }
553
554 /*
555 * Returns the contents of this Maybe<T> by pointer. If |isNothing()|,
556 * returns the value returned from the function or functor provided.
557 */
558 template <typename F>
559 T* ptrOrFrom(F&& aFunc) {
560 if (isSome()) {
561 return ptr();
562 }
563 return aFunc();
564 }
565
566 template <typename F>
567 const T* ptrOrFrom(F&& aFunc) const {
568 if (isSome()) {
569 return ptr();
570 }
571 return aFunc();
572 }
573
574 constexpr T* operator->();
575 constexpr const T* operator->() const;
576
577 /* Returns the contents of this Maybe<T> by ref. Unsafe unless |isSome()|. */
578 constexpr T& ref() &;
579 constexpr const T& ref() const&;
580 constexpr T&& ref() &&;
581 constexpr const T&& ref() const&&;
582
583 /*
584 * Returns the contents of this Maybe<T> by ref. If |isNothing()|, returns
585 * the default value provided.
586 */
587 constexpr T& refOr(T& aDefault) {
588 if (isSome()) {
589 return ref();
590 }
591 return aDefault;
592 }
593
594 constexpr const T& refOr(const T& aDefault) const {
595 if (isSome()) {
596 return ref();
597 }
598 return aDefault;
599 }
600
601 /*
602 * Returns the contents of this Maybe<T> by ref. If |isNothing()|, returns the
603 * value returned from the function or functor provided.
604 */
605 template <typename F>
606 constexpr T& refOrFrom(F&& aFunc) {
607 if (isSome()) {
608 return ref();
609 }
610 return aFunc();
611 }
612
613 template <typename F>
614 constexpr const T& refOrFrom(F&& aFunc) const {
615 if (isSome()) {
616 return ref();
617 }
618 return aFunc();
619 }
620
621 constexpr T& operator*() &;
622 constexpr const T& operator*() const&;
623 constexpr T&& operator*() &&;
624 constexpr const T&& operator*() const&&;
625
626 /* If |isSome()|, runs the provided function or functor on the contents of
627 * this Maybe. */
628 template <typename Func>
629 constexpr Maybe& apply(Func&& aFunc) & {
630 if (isSome()) {
631 std::forward<Func>(aFunc)(ref());
632 }
633 return *this;
634 }
635
636 template <typename Func>
637 constexpr const Maybe& apply(Func&& aFunc) const& {
638 if (isSome()) {
639 std::forward<Func>(aFunc)(ref());
640 }
641 return *this;
642 }
643
644 template <typename Func>
645 constexpr Maybe& apply(Func&& aFunc) && {
646 if (isSome()) {
647 std::forward<Func>(aFunc)(extract());
648 }
649 return *this;
650 }
651
652 template <typename Func>
653 constexpr Maybe& apply(Func&& aFunc) const&& {
654 if (isSome()) {
655 std::forward<Func>(aFunc)(extract());
656 }
657 return *this;
658 }
659
660 /*
661 * If |isSome()|, runs the provided function and returns the result wrapped
662 * in a Maybe. If |isNothing()|, returns an empty Maybe value with the same
663 * value type as what the provided function would have returned.
664 */
665 template <typename Func>
666 constexpr auto map(Func&& aFunc) & {
667 if (isSome()) {
668 return Some(std::forward<Func>(aFunc)(ref()));
669 }
670 return Maybe<decltype(std::forward<Func>(aFunc)(ref()))>{};
671 }
672
673 template <typename Func>
674 constexpr auto map(Func&& aFunc) const& {
675 if (isSome()) {
676 return Some(std::forward<Func>(aFunc)(ref()));
677 }
678 return Maybe<decltype(std::forward<Func>(aFunc)(ref()))>{};
679 }
680
681 template <typename Func>
682 constexpr auto map(Func&& aFunc) && {
683 if (isSome()) {
684 return Some(std::forward<Func>(aFunc)(extract()));
685 }
686 return Maybe<decltype(std::forward<Func>(aFunc)(extract()))>{};
687 }
688
689 template <typename Func>
690 constexpr auto map(Func&& aFunc) const&& {
691 if (isSome()) {
692 return Some(std::forward<Func>(aFunc)(extract()));
693 }
694 return Maybe<decltype(std::forward<Func>(aFunc)(extract()))>{};
695 }
696
697 /*
698 * If |isSome()|, runs the provided function or functor on the contents of
699 * this Maybe and returns the result. Note that the provided function or
700 * functor must return a Maybe<U> of any type U.
701 * If |isNothing()|, returns an empty Maybe value with the same type as what
702 * the provided function would have returned.
703 */
704 template <typename Func>
705 constexpr auto andThen(Func&& aFunc) & {
706 static_assert(std::is_invocable_v<Func, T&>);
707 using U = std::invoke_result_t<Func, T&>;
708 static_assert(detail::IsMaybe<U>::value);
709 if (isSome()) {
710 return std::invoke(std::forward<Func>(aFunc), ref());
711 }
712 return std::remove_cv_t<std::remove_reference_t<U>>{};
713 }
714
715 template <typename Func>
716 constexpr auto andThen(Func&& aFunc) const& {
717 static_assert(std::is_invocable_v<Func, const T&>);
718 using U = std::invoke_result_t<Func, const T&>;
719 static_assert(detail::IsMaybe<U>::value);
720 if (isSome()) {
721 return std::invoke(std::forward<Func>(aFunc), ref());
722 }
723 return std::remove_cv_t<std::remove_reference_t<U>>{};
724 }
725
726 template <typename Func>
727 constexpr auto andThen(Func&& aFunc) && {
728 static_assert(std::is_invocable_v<Func, T&&>);
729 using U = std::invoke_result_t<Func, T&&>;
730 static_assert(detail::IsMaybe<U>::value);
731 if (isSome()) {
732 return std::invoke(std::forward<Func>(aFunc), extract());
733 }
734 return std::remove_cv_t<std::remove_reference_t<U>>{};
735 }
736
737 template <typename Func>
738 constexpr auto andThen(Func&& aFunc) const&& {
739 static_assert(std::is_invocable_v<Func, const T&&>);
740 using U = std::invoke_result_t<Func, const T&&>;
741 static_assert(detail::IsMaybe<U>::value);
742 if (isSome()) {
743 return std::invoke(std::forward<Func>(aFunc), extract());
744 }
745 return std::remove_cv_t<std::remove_reference_t<U>>{};
746 }
747
748 /*
749 * If |isNothing()|, runs the provided function or functor and returns its
750 * result. If |isSome()|, returns the contained value wrapped in a Maybe.
751 */
752 template <typename Func>
753 constexpr Maybe orElse(Func&& aFunc) & {
754 static_assert(std::is_invocable_v<Func>);
755 using U = std::invoke_result_t<Func>;
756 static_assert(
757 std::is_same_v<Maybe, std::remove_cv_t<std::remove_reference_t<U>>>);
758 if (isSome()) {
759 return *this;
760 }
761 return std::invoke(std::forward<Func>(aFunc));
762 }
763
764 template <typename Func>
765 constexpr Maybe orElse(Func&& aFunc) const& {
766 static_assert(std::is_invocable_v<Func>);
767 using U = std::invoke_result_t<Func>;
768 static_assert(
769 std::is_same_v<Maybe, std::remove_cv_t<std::remove_reference_t<U>>>);
770 if (isSome()) {
771 return *this;
772 }
773 return std::invoke(std::forward<Func>(aFunc));
774 }
775
776 template <typename Func>
777 constexpr Maybe orElse(Func&& aFunc) && {
778 static_assert(std::is_invocable_v<Func>);
779 using U = std::invoke_result_t<Func>;
780 static_assert(
781 std::is_same_v<Maybe, std::remove_cv_t<std::remove_reference_t<U>>>);
782 if (isSome()) {
783 return std::move(*this);
784 }
785 return std::invoke(std::forward<Func>(aFunc));
786 }
787
788 template <typename Func>
789 constexpr Maybe orElse(Func&& aFunc) const&& {
790 static_assert(std::is_invocable_v<Func>);
791 using U = std::invoke_result_t<Func>;
792 static_assert(
793 std::is_same_v<Maybe, std::remove_cv_t<std::remove_reference_t<U>>>);
794 if (isSome()) {
795 return std::move(*this);
796 }
797 return std::invoke(std::forward<Func>(aFunc));
798 }
799
800 /* If |isSome()|, empties this Maybe and destroys its contents. */
801 constexpr void reset() {
802 if (isSome()) {
803 if constexpr (!std::is_trivially_destructible_v<T>) {
804 /*
805 * Static analyzer gets confused if we have Maybe<MutexAutoLock>,
806 * so we suppress thread-safety warnings here
807 */
808 MOZ_PUSH_IGNORE_THREAD_SAFETYGCC diagnostic push GCC diagnostic ignored "-Wthread-safety"
809 ref().T::~T();
810 MOZ_POP_THREAD_SAFETYGCC diagnostic pop
811 poisonData();
812 }
813 mIsSome = false;
814 }
815 }
816
817 /*
818 * Constructs a T value in-place in this empty Maybe<T>'s storage. The
819 * arguments to |emplace()| are the parameters to T's constructor.
820 */
821 template <typename... Args>
822 constexpr void emplace(Args&&... aArgs);
823
824 template <typename U>
825 constexpr std::enable_if_t<std::is_same_v<T, U> &&
826 std::is_copy_constructible_v<U> &&
827 !std::is_move_constructible_v<U>>
828 emplace(U&& aArgs) {
829 emplace(aArgs);
830 }
831
832 friend std::ostream& operator<<(std::ostream& aStream,
833 const Maybe<T>& aMaybe) {
834 if (aMaybe) {
835 aStream << aMaybe.ref();
836 } else {
837 aStream << "<Nothing>";
838 }
839 return aStream;
840 }
841};
842
843template <typename T>
844class Maybe<T&> {
845 public:
846 constexpr Maybe() = default;
847 constexpr MOZ_IMPLICIT Maybe(Nothing) {}
848
849 void emplace(T& aRef) { mValue = &aRef; }
850
851 /* Methods that check whether this Maybe contains a value */
852 constexpr explicit operator bool() const { return isSome(); }
853 constexpr bool isSome() const { return mValue; }
854 constexpr bool isNothing() const { return !mValue; }
855
856 T& ref() const {
857 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 857); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 857; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
858 return *mValue;
859 }
860
861 T* operator->() const { return &ref(); }
862 T& operator*() const { return ref(); }
863
864 // Deliberately not defining value and ptr accessors, as these may be
865 // confusing on a reference-typed Maybe.
866
867 // XXX Should we define refOr?
868
869 void reset() { mValue = nullptr; }
870
871 template <typename Func>
872 const Maybe& apply(Func&& aFunc) const {
873 if (isSome()) {
874 std::forward<Func>(aFunc)(ref());
875 }
876 return *this;
877 }
878
879 template <typename Func>
880 auto map(Func&& aFunc) const {
881 Maybe<decltype(std::forward<Func>(aFunc)(ref()))> val;
882 if (isSome()) {
883 val.emplace(std::forward<Func>(aFunc)(ref()));
884 }
885 return val;
886 }
887
888 template <typename Func>
889 constexpr auto andThen(Func&& aFunc) const {
890 static_assert(std::is_invocable_v<Func, T&>);
891 using U = std::invoke_result_t<Func, T&>;
892 static_assert(detail::IsMaybe<U>::value);
893 if (isSome()) {
894 return std::invoke(std::forward<Func>(aFunc), ref());
895 }
896 return std::remove_cv_t<std::remove_reference_t<U>>{};
897 }
898
899 template <typename Func>
900 constexpr Maybe orElse(Func&& aFunc) const {
901 static_assert(std::is_invocable_v<Func>);
902 using U = std::invoke_result_t<Func>;
903 static_assert(
904 std::is_same_v<Maybe, std::remove_cv_t<std::remove_reference_t<U>>>);
905 if (isSome()) {
906 return *this;
907 }
908 return std::invoke(std::forward<Func>(aFunc));
909 }
910
911 bool refEquals(const Maybe<T&>& aOther) const {
912 return mValue == aOther.mValue;
913 }
914
915 bool refEquals(const T& aOther) const { return mValue == &aOther; }
916
917 private:
918 T* mValue = nullptr;
919};
920
921template <typename T>
922constexpr T Maybe<T>::value() const& {
923 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 923); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 923; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
924 return ref();
925}
926
927template <typename T>
928constexpr T Maybe<T>::value() && {
929 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 929); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 929; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
930 return std::move(ref());
931}
932
933template <typename T>
934constexpr T Maybe<T>::value() const&& {
935 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 935); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 935; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
936 return std::move(ref());
937}
938
939template <typename T>
940T* Maybe<T>::ptr() {
941 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 941); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 941; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
942 return &ref();
943}
944
945template <typename T>
946constexpr const T* Maybe<T>::ptr() const {
947 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 947); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 947; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
948 return &ref();
949}
950
951template <typename T>
952constexpr T* Maybe<T>::operator->() {
953 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 953); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 953; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
954 return ptr();
955}
956
957template <typename T>
958constexpr const T* Maybe<T>::operator->() const {
959 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 959); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 959; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
960 return ptr();
961}
962
963template <typename T>
964constexpr T& Maybe<T>::ref() & {
965 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 965); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 965; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
966 return mStorage.val;
967}
968
969template <typename T>
970constexpr const T& Maybe<T>::ref() const& {
971 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 971); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 971; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
972 return mStorage.val;
973}
974
975template <typename T>
976constexpr T&& Maybe<T>::ref() && {
977 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 977); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 977; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
978 return std::move(mStorage.val);
979}
980
981template <typename T>
982constexpr const T&& Maybe<T>::ref() const&& {
983 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 983); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 983; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
984 return std::move(mStorage.val);
985}
986
987template <typename T>
988constexpr T& Maybe<T>::operator*() & {
989 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 989); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 989; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
990 return ref();
991}
992
993template <typename T>
994constexpr const T& Maybe<T>::operator*() const& {
995 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 995); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 995; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
996 return ref();
997}
998
999template <typename T>
1000constexpr T&& Maybe<T>::operator*() && {
1001 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 1001); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 1001; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
1002 return std::move(ref());
1003}
1004
1005template <typename T>
1006constexpr const T&& Maybe<T>::operator*() const&& {
1007 MOZ_RELEASE_ASSERT(isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 1007); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "isSome()"
")"); do { *((volatile int*)__null) = 1007; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
1008 return std::move(ref());
1009}
1010
1011template <typename T>
1012template <typename... Args>
1013constexpr void Maybe<T>::emplace(Args&&... aArgs) {
1014 MOZ_RELEASE_ASSERT(!isSome())do { static_assert( mozilla::detail::AssertionConditionType<
decltype(!isSome())>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(!isSome()))), 0))) { do { } while
(false); MOZ_ReportAssertionFailure("!isSome()", "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/Maybe.h"
, 1014); AnnotateMozCrashReason("MOZ_RELEASE_ASSERT" "(" "!isSome()"
")"); do { *((volatile int*)__null) = 1014; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
1015 ::new (KnownNotNull, &mStorage.val) T(std::forward<Args>(aArgs)...);
1016 mIsSome = true;
1017}
1018
1019/*
1020 * Some() creates a Maybe<T> value containing the provided T value. If T has a
1021 * move constructor, it's used to make this as efficient as possible.
1022 *
1023 * Some() selects the type of Maybe it returns by removing any const, volatile,
1024 * or reference qualifiers from the type of the value you pass to it. This gives
1025 * it more intuitive behavior when used in expressions, but it also means that
1026 * if you need to construct a Maybe value that holds a const, volatile, or
1027 * reference value, you need to use emplace() instead.
1028 */
1029template <typename T, typename U>
1030constexpr Maybe<U> Some(T&& aValue) {
1031 return {std::forward<T>(aValue), typename Maybe<U>::SomeGuard{}};
1032}
1033
1034template <typename T>
1035constexpr Maybe<T&> SomeRef(T& aValue) {
1036 Maybe<T&> value;
1037 value.emplace(aValue);
1038 return value;
1039}
1040
1041template <typename T>
1042constexpr Maybe<T&> ToMaybeRef(T* const aPtr) {
1043 return aPtr ? SomeRef(*aPtr) : Nothing{};
1044}
1045
1046template <typename T>
1047Maybe<std::remove_cv_t<std::remove_reference_t<T>>> ToMaybe(T* aPtr) {
1048 if (aPtr) {
1049 return Some(*aPtr);
1050 }
1051 return Nothing();
1052}
1053
1054/*
1055 * Two Maybe<T> values are equal if
1056 * - both are Nothing, or
1057 * - both are Some, and the values they contain are equal.
1058 */
1059template <typename T>
1060constexpr bool operator==(const Maybe<T>& aLHS, const Maybe<T>& aRHS) {
1061 static_assert(!std::is_reference_v<T>,
1062 "operator== is not defined for Maybe<T&>, compare values or "
1063 "addresses explicitly instead");
1064 if (aLHS.isNothing() != aRHS.isNothing()) {
1065 return false;
1066 }
1067 return aLHS.isNothing() || *aLHS == *aRHS;
1068}
1069
1070template <typename T>
1071constexpr bool operator!=(const Maybe<T>& aLHS, const Maybe<T>& aRHS) {
1072 return !(aLHS == aRHS);
1073}
1074
1075/*
1076 * We support comparison to Nothing to allow reasonable expressions like:
1077 * if (maybeValue == Nothing()) { ... }
1078 */
1079template <typename T>
1080constexpr bool operator==(const Maybe<T>& aLHS, const Nothing& aRHS) {
1081 return aLHS.isNothing();
1082}
1083
1084template <typename T>
1085constexpr bool operator!=(const Maybe<T>& aLHS, const Nothing& aRHS) {
1086 return !(aLHS == aRHS);
1087}
1088
1089template <typename T>
1090constexpr bool operator==(const Nothing& aLHS, const Maybe<T>& aRHS) {
1091 return aRHS.isNothing();
1092}
1093
1094template <typename T>
1095constexpr bool operator!=(const Nothing& aLHS, const Maybe<T>& aRHS) {
1096 return !(aLHS == aRHS);
1097}
1098
1099/*
1100 * Maybe<T> values are ordered in the same way T values are ordered, except that
1101 * Nothing comes before anything else.
1102 */
1103template <typename T>
1104constexpr bool operator<(const Maybe<T>& aLHS, const Maybe<T>& aRHS) {
1105 if (aLHS.isNothing()) {
1106 return aRHS.isSome();
1107 }
1108 if (aRHS.isNothing()) {
1109 return false;
1110 }
1111 return *aLHS < *aRHS;
1112}
1113
1114template <typename T>
1115constexpr bool operator>(const Maybe<T>& aLHS, const Maybe<T>& aRHS) {
1116 return !(aLHS < aRHS || aLHS == aRHS);
1117}
1118
1119template <typename T>
1120constexpr bool operator<=(const Maybe<T>& aLHS, const Maybe<T>& aRHS) {
1121 return aLHS < aRHS || aLHS == aRHS;
1122}
1123
1124template <typename T>
1125constexpr bool operator>=(const Maybe<T>& aLHS, const Maybe<T>& aRHS) {
1126 return !(aLHS < aRHS);
1127}
1128
1129template <typename T>
1130inline void ImplCycleCollectionTraverse(
1131 nsCycleCollectionTraversalCallback& aCallback, mozilla::Maybe<T>& aField,
1132 const char* aName, uint32_t aFlags = 0) {
1133 if (aField) {
1134 ImplCycleCollectionTraverse(aCallback, aField.ref(), aName, aFlags);
1135 }
1136}
1137
1138template <typename T>
1139inline void ImplCycleCollectionUnlink(mozilla::Maybe<T>& aField) {
1140 if (aField) {
1141 ImplCycleCollectionUnlink(aField.ref());
1142 }
1143}
1144
1145} // namespace mozilla
1146
1147#endif /* mozilla_Maybe_h */

/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/ipc/ByteBuf.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
7/* A type that can be sent without needing to make a copy during
8 * serialization. In addition the receiver can take ownership of the
9 * data to avoid having to make an additional copy. */
10
11#ifndef mozilla_ipc_ByteBuf_h
12#define mozilla_ipc_ByteBuf_h
13
14#include "mozilla/Assertions.h"
15
16namespace IPC {
17template <typename T>
18struct ParamTraits;
19}
20
21namespace mozilla {
22
23namespace ipc {
24
25class ByteBuf final {
26 friend struct IPC::ParamTraits<mozilla::ipc::ByteBuf>;
27
28 public:
29 bool Allocate(size_t aLength) {
30 MOZ_ASSERT(mData == nullptr)do { static_assert( mozilla::detail::AssertionConditionType<
decltype(mData == nullptr)>::isValid, "invalid assertion condition"
); if ((__builtin_expect(!!(!(!!(mData == nullptr))), 0))) { do
{ } while (false); MOZ_ReportAssertionFailure("mData == nullptr"
, "/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/ipc/ByteBuf.h"
, 30); AnnotateMozCrashReason("MOZ_ASSERT" "(" "mData == nullptr"
")"); do { *((volatile int*)__null) = 30; __attribute__((nomerge
)) ::abort(); } while (false); } } while (false)
;
31 mData = (uint8_t*)malloc(aLength);
32 if (!mData) {
33 return false;
34 }
35 mLen = aLength;
36 mCapacity = aLength;
37 return true;
38 }
39
40 ByteBuf() : mData(nullptr), mLen(0), mCapacity(0) {}
41
42 ByteBuf(uint8_t* aData, size_t aLen, size_t aCapacity)
43 : mData(aData), mLen(aLen), mCapacity(aCapacity) {}
44
45 ByteBuf(const ByteBuf& aFrom) = delete;
46
47 ByteBuf(ByteBuf&& aFrom)
48 : mData(aFrom.mData), mLen(aFrom.mLen), mCapacity(aFrom.mCapacity) {
49 aFrom.mData = nullptr;
50 aFrom.mLen = 0;
51 aFrom.mCapacity = 0;
52 }
53
54 ByteBuf& operator=(ByteBuf&& aFrom) {
55 std::swap(mData, aFrom.mData);
56 std::swap(mLen, aFrom.mLen);
57 std::swap(mCapacity, aFrom.mCapacity);
58 return *this;
59 }
60
61 ~ByteBuf() { free(mData); }
12
Memory is released
17
Attempt to free released memory
62
63 uint8_t* mData;
64 size_t mLen;
65 size_t mCapacity;
66};
67
68} // namespace ipc
69} // namespace mozilla
70
71#endif // ifndef mozilla_ipc_ByteBuf_h

/var/lib/jenkins/workspace/firefox-scan-build/obj-x86_64-pc-linux-gnu/dist/include/mozilla/MaybeStorageBase.h

1/* -*- Mode: C++; tab-width: 2; 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
7/* Internal storage class used e.g. by Maybe and Result. This file doesn't
8 * contain any public declarations. */
9
10#ifndef mfbt_MaybeStorageBase_h
11#define mfbt_MaybeStorageBase_h
12
13#include <type_traits>
14#include <utility>
15
16namespace mozilla::detail {
17
18template <typename T>
19constexpr bool IsTriviallyDestructibleAndCopyable =
20 std::is_trivially_destructible_v<T> &&
21 (std::is_trivially_copy_constructible_v<T> ||
22 !std::is_copy_constructible_v<T>);
23
24template <typename T, bool TriviallyDestructibleAndCopyable =
25 IsTriviallyDestructibleAndCopyable<T>>
26struct MaybeStorageBase;
27
28template <typename T>
29struct MaybeStorageBase<T, false> {
30 protected:
31 using NonConstT = std::remove_const_t<T>;
32
33 union Union {
34 Union() {}
35 explicit Union(const T& aVal) : val{aVal} {}
36 template <typename U,
37 typename = std::enable_if_t<std::is_move_constructible_v<U>>>
38 explicit Union(U&& aVal) : val{std::forward<U>(aVal)} {}
39 template <typename... Args>
40 explicit Union(std::in_place_t, Args&&... aArgs)
41 : val{std::forward<Args>(aArgs)...} {}
42
43 ~Union() {}
16
Calling '~ByteBuf'
44
45 NonConstT val;
46 } mStorage;
47
48 public:
49 MaybeStorageBase() = default;
50 explicit MaybeStorageBase(const T& aVal) : mStorage{aVal} {}
51 explicit MaybeStorageBase(T&& aVal) : mStorage{std::move(aVal)} {}
52 template <typename... Args>
53 explicit MaybeStorageBase(std::in_place_t, Args&&... aArgs)
54 : mStorage{std::in_place, std::forward<Args>(aArgs)...} {}
55
56 const T* addr() const { return &mStorage.val; }
57 T* addr() { return &mStorage.val; }
58};
59
60template <typename T>
61struct MaybeStorageBase<T, true> {
62 protected:
63 using NonConstT = std::remove_const_t<T>;
64
65 union Union {
66 constexpr Union() : dummy() {}
67 constexpr explicit Union(const T& aVal) : val{aVal} {}
68 constexpr explicit Union(T&& aVal) : val{std::move(aVal)} {}
69 template <typename... Args>
70 constexpr explicit Union(std::in_place_t, Args&&... aArgs)
71 : val{std::forward<Args>(aArgs)...} {}
72
73 NonConstT val;
74 char dummy;
75 } mStorage;
76
77 public:
78 constexpr MaybeStorageBase() = default;
79 constexpr explicit MaybeStorageBase(const T& aVal) : mStorage{aVal} {}
80 constexpr explicit MaybeStorageBase(T&& aVal) : mStorage{std::move(aVal)} {}
81
82 template <typename... Args>
83 constexpr explicit MaybeStorageBase(std::in_place_t, Args&&... aArgs)
84 : mStorage{std::in_place, std::forward<Args>(aArgs)...} {}
85
86 constexpr const T* addr() const { return &mStorage.val; }
87 constexpr T* addr() { return &mStorage.val; }
88};
89
90} // namespace mozilla::detail
91
92#endif