1 files changed, 113 insertions, 0 deletions
diff --git a/js/src/vm/JSAtomUtils.h b/js/src/vm/JSAtomUtils.h
new file mode 100644
index 0000000000..8e16dae434
--- /dev/null
+++ b/js/src/vm/JSAtomUtils.h
@@ -0,0 +1,113 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ * vim: set ts=8 sts=2 et sw=2 tw=80:
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef vm_JSAtomUtils_h
+#define vm_JSAtomUtils_h
+
+#include "mozilla/HashFunctions.h"
+#include "mozilla/Maybe.h"
+
+#include "NamespaceImports.h"
+
+#include "gc/MaybeRooted.h"
+#include "js/TypeDecls.h"
+#include "js/Utility.h"
+
+namespace js {
+
+class AtomSet;
+
+/*
+ * Return a printable, lossless char[] representation of a string-type atom.
+ * The returned string is guaranteed to contain only ASCII characters.
+ */
+extern UniqueChars AtomToPrintableString(JSContext* cx, JSAtom* atom);
+
+class PropertyName;
+
+} /* namespace js */
+
+namespace js {
+
+/*
+ * Atom tracing and garbage collection hooks.
+ */
+void TraceAtoms(JSTracer* trc);
+
+extern JSAtom* Atomize(
+    JSContext* cx, const char* bytes, size_t length,
+    const mozilla::Maybe<uint32_t>& indexValue = mozilla::Nothing());
+
+extern JSAtom* AtomizeWithoutActiveZone(JSContext* cx, const char* bytes,
+                                        size_t length);
+
+template <typename CharT>
+extern JSAtom* AtomizeChars(JSContext* cx, const CharT* chars, size_t length);
+
+/*
+ * Optimized entry points for atomization.
+ *
+ * The meaning of suffix:
+ *   * "NonStatic": characters don't match StaticStrings
+ *   * "ValidLength": length fits JSString::MAX_LENGTH
+ */
+
+/* Atomize characters when the value of HashString is already known. */
+template <typename CharT>
+extern JSAtom* AtomizeCharsNonStaticValidLength(JSContext* cx,
+                                                mozilla::HashNumber hash,
+                                                const CharT* chars,
+                                                size_t length);
+
+/**
+ * Permanently atomize characters.
+ *
+ * `chars` shouldn't match any of StaticStrings entry.
+ * `length` should be validated by JSString::validateLength.
+ */
+extern JSAtom* PermanentlyAtomizeCharsNonStaticValidLength(
+    JSContext* cx, AtomSet& atomSet, mozilla::HashNumber hash,
+    const Latin1Char* chars, size_t length);
+
+/**
+ * Create an atom whose contents are those of the |utf8ByteLength| code units
+ * starting at |utf8Chars|, interpreted as UTF-8.
+ *
+ * Throws if the code units do not contain valid UTF-8.
+ */
+extern JSAtom* AtomizeUTF8Chars(JSContext* cx, const char* utf8Chars,
+                                size_t utf8ByteLength);
+
+extern JSAtom* AtomizeString(JSContext* cx, JSString* str);
+
+template <AllowGC allowGC>
+extern JSAtom* ToAtom(JSContext* cx,
+                      typename MaybeRooted<JS::Value, allowGC>::HandleType v);
+
+/*
+ * Pin an atom so that it is never collected. Avoid using this if possible.
+ *
+ * This function does not GC.
+ */
+extern bool PinAtom(JSContext* cx, JSAtom* atom);
+
+#ifdef ENABLE_RECORD_TUPLE
+extern bool EnsureAtomized(JSContext* cx, MutableHandleValue v, bool* updated);
+#endif
+
+extern JS::Handle<PropertyName*> ClassName(JSProtoKey key, JSContext* cx);
+
+#ifdef DEBUG
+
+bool AtomIsMarked(JS::Zone* zone, JSAtom* atom);
+bool AtomIsMarked(JS::Zone* zone, jsid id);
+bool AtomIsMarked(JS::Zone* zone, const JS::Value& value);
+
+#endif  // DEBUG
+
+} /* namespace js */
+
+#endif /* vm_JSAtomUtils_h */