1999-08-21 10:38:59 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
2012-05-21 15:12:37 +04:00
|
|
|
/* 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/. */
|
1999-08-21 10:38:59 +04:00
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
2000-08-23 21:27:06 +04:00
|
|
|
%{C++
|
2005-11-08 21:17:49 +03:00
|
|
|
#include "nsStringGlue.h"
|
2001-10-21 03:19:07 +04:00
|
|
|
#include "nsCOMPtr.h"
|
2010-03-08 18:45:00 +03:00
|
|
|
#include "nsStringBuffer.h"
|
1999-08-21 10:38:59 +04:00
|
|
|
%}
|
|
|
|
|
Bug 1261735 (part 1) - Overhaul the atom implementation. r=froydnj,erahm.
This patch changes things so that dynamic atoms and static atoms have distinct
implementations. This is a step towards allowing dynamic atoms and static atoms
to have different layouts in memory, which will allow static atoms to be
represented more compactly.
Specifically, the patch does the following.
- It renames AtomImpl as DynamicAtom and PermanentAtomImpl as StaticAtom, and
the latter is no longer a subclass of the former. This required duplicating
some methods from the former into the latter: ScriptableToString(),
ToUTF8String(), ScriptableEquals(), IsStaticAtom(). (This duplication will
disappear in the future if the representations of dynamic atoms and static
atoms diverge. Indeed, SizeOfIncludingThis() is already different in the two
classes.)
- It replaces all mentions of "permanent"/"non-permanent" atoms with
"static"/"dynamic".
- In ~DynamicAtom() it removes the check that causes gAtomTable to be deleted
when it becomes empty. This will only happen at shutdown and so doesn't seem
useful.
- It documents better various things, especially the basics of the
dynamic/static split, the transmutation of dynamic atoms to static atoms, and
the details of the SizeOf functions.
--HG--
extra : rebase_source : dbf903012e70ebf1a43de1e1088db1bc1b8dd4f4
2016-04-01 03:18:06 +03:00
|
|
|
native MallocSizeOf(mozilla::MallocSizeOf);
|
|
|
|
|
2001-10-21 03:19:07 +04:00
|
|
|
/*
|
|
|
|
* Should this really be scriptable? Using atoms from script or proxies
|
|
|
|
* could be dangerous since double-wrapping could lead to loss of
|
|
|
|
* pointer identity.
|
|
|
|
*/
|
|
|
|
|
2016-01-06 04:08:45 +03:00
|
|
|
[scriptable, builtinclass, uuid(8b8c11d4-3ed5-4079-8974-73c7576cdb34)]
|
1999-08-21 10:38:59 +04:00
|
|
|
interface nsIAtom : nsISupports
|
|
|
|
{
|
|
|
|
/**
|
2003-03-25 21:55:59 +03:00
|
|
|
* Get the Unicode or UTF8 value for the string
|
1999-08-21 10:38:59 +04:00
|
|
|
*/
|
2010-03-08 18:45:00 +03:00
|
|
|
[binaryname(ScriptableToString)] AString toString();
|
|
|
|
[noscript] AUTF8String toUTF8String();
|
2003-03-25 21:55:59 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Compare the atom to a specific string value
|
|
|
|
* Note that this will NEVER return/throw an error condition.
|
|
|
|
*/
|
2010-03-08 18:45:00 +03:00
|
|
|
[binaryname(ScriptableEquals)] boolean equals(in AString aString);
|
|
|
|
|
Bug 1261735 (part 1) - Overhaul the atom implementation. r=froydnj,erahm.
This patch changes things so that dynamic atoms and static atoms have distinct
implementations. This is a step towards allowing dynamic atoms and static atoms
to have different layouts in memory, which will allow static atoms to be
represented more compactly.
Specifically, the patch does the following.
- It renames AtomImpl as DynamicAtom and PermanentAtomImpl as StaticAtom, and
the latter is no longer a subclass of the former. This required duplicating
some methods from the former into the latter: ScriptableToString(),
ToUTF8String(), ScriptableEquals(), IsStaticAtom(). (This duplication will
disappear in the future if the representations of dynamic atoms and static
atoms diverge. Indeed, SizeOfIncludingThis() is already different in the two
classes.)
- It replaces all mentions of "permanent"/"non-permanent" atoms with
"static"/"dynamic".
- In ~DynamicAtom() it removes the check that causes gAtomTable to be deleted
when it becomes empty. This will only happen at shutdown and so doesn't seem
useful.
- It documents better various things, especially the basics of the
dynamic/static split, the transmutation of dynamic atoms to static atoms, and
the details of the SizeOf functions.
--HG--
extra : rebase_source : dbf903012e70ebf1a43de1e1088db1bc1b8dd4f4
2016-04-01 03:18:06 +03:00
|
|
|
[noscript, notxpcom]
|
|
|
|
size_t SizeOfIncludingThis(in MallocSizeOf aMallocSizeOf);
|
|
|
|
|
2003-03-25 21:55:59 +03:00
|
|
|
%{C++
|
|
|
|
// note this is NOT virtual so this won't muck with the vtable!
|
2013-01-29 18:42:14 +04:00
|
|
|
inline bool Equals(const nsAString& aString) const {
|
2010-03-08 18:45:00 +03:00
|
|
|
return aString.Equals(nsDependentString(mString, mLength));
|
2003-03-25 21:55:59 +03:00
|
|
|
}
|
|
|
|
|
2016-04-06 04:28:40 +03:00
|
|
|
inline bool IsStaticAtom() const {
|
|
|
|
return mIsStatic;
|
|
|
|
}
|
|
|
|
|
2013-12-04 16:19:09 +04:00
|
|
|
inline char16ptr_t GetUTF16String() const {
|
2010-03-08 18:45:00 +03:00
|
|
|
return mString;
|
2003-03-25 21:55:59 +03:00
|
|
|
}
|
2010-03-08 18:45:00 +03:00
|
|
|
|
2016-01-06 04:08:45 +03:00
|
|
|
inline uint32_t GetLength() const {
|
2010-03-08 18:45:00 +03:00
|
|
|
return mLength;
|
|
|
|
}
|
|
|
|
|
|
|
|
inline void ToString(nsAString& aBuf) {
|
2016-02-17 03:30:02 +03:00
|
|
|
// See the comment on |mString|'s declaration.
|
2010-03-08 18:45:00 +03:00
|
|
|
nsStringBuffer::FromData(mString)->ToString(mLength, aBuf);
|
2010-03-08 18:45:00 +03:00
|
|
|
}
|
|
|
|
|
2013-01-29 18:42:14 +04:00
|
|
|
inline nsStringBuffer* GetStringBuffer() const {
|
2016-02-17 03:30:02 +03:00
|
|
|
// See the comment on |mString|'s declaration.
|
2013-01-29 18:42:14 +04:00
|
|
|
return nsStringBuffer::FromData(mString);
|
|
|
|
}
|
|
|
|
|
2012-03-01 06:44:02 +04:00
|
|
|
/**
|
|
|
|
* A hashcode that is better distributed than the actual atom
|
|
|
|
* pointer, for use in situations that need a well-distributed
|
|
|
|
* hashcode.
|
|
|
|
*/
|
2012-03-01 06:40:51 +04:00
|
|
|
inline uint32_t hash() const {
|
|
|
|
return mHash;
|
|
|
|
}
|
|
|
|
|
2010-03-08 18:45:00 +03:00
|
|
|
protected:
|
2016-04-06 04:28:40 +03:00
|
|
|
uint32_t mLength:31;
|
|
|
|
uint32_t mIsStatic:1;
|
2012-03-01 06:40:51 +04:00
|
|
|
uint32_t mHash;
|
2016-02-17 03:30:02 +03:00
|
|
|
/**
|
|
|
|
* WARNING! There is an invisible constraint on |mString|: the chars it
|
|
|
|
* points to must belong to an nsStringBuffer. This is so that the
|
|
|
|
* nsStringBuffer::FromData() calls above are valid.
|
|
|
|
*/
|
2014-01-04 19:02:17 +04:00
|
|
|
char16_t* mString;
|
2003-03-25 21:55:59 +03:00
|
|
|
%}
|
1999-08-21 10:38:59 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
%{C++
|
2001-10-21 03:19:07 +04:00
|
|
|
/*
|
2016-03-29 02:09:43 +03:00
|
|
|
* The four forms of NS_Atomize (for use with |nsCOMPtr<nsIAtom>|) return the
|
|
|
|
* atom for the string given. At any given time there will always be one atom
|
|
|
|
* representing a given string. Atoms are intended to make string comparison
|
|
|
|
* cheaper by simplifying it to pointer equality. A pointer to the atom that
|
|
|
|
* does not own a reference is not guaranteed to be valid.
|
2001-10-21 03:19:07 +04:00
|
|
|
*/
|
|
|
|
|
1999-08-21 10:38:59 +04:00
|
|
|
|
|
|
|
/**
|
2003-06-21 06:59:51 +04:00
|
|
|
* Find an atom that matches the given UTF-8 string.
|
2013-04-09 01:04:21 +04:00
|
|
|
* The string is assumed to be zero terminated. Never returns null.
|
1999-08-21 10:38:59 +04:00
|
|
|
*/
|
2016-03-29 02:09:43 +03:00
|
|
|
extern already_AddRefed<nsIAtom> NS_Atomize(const char* aUTF8String);
|
2003-06-21 06:59:51 +04:00
|
|
|
|
|
|
|
/**
|
2013-04-09 01:04:21 +04:00
|
|
|
* Find an atom that matches the given UTF-8 string. Never returns null.
|
2003-06-21 06:59:51 +04:00
|
|
|
*/
|
2016-03-29 02:09:43 +03:00
|
|
|
extern already_AddRefed<nsIAtom> NS_Atomize(const nsACString& aUTF8String);
|
1999-08-21 10:38:59 +04:00
|
|
|
|
|
|
|
/**
|
2003-06-21 06:59:51 +04:00
|
|
|
* Find an atom that matches the given UTF-16 string.
|
2013-04-09 01:04:21 +04:00
|
|
|
* The string is assumed to be zero terminated. Never returns null.
|
1999-08-21 10:38:59 +04:00
|
|
|
*/
|
2016-03-29 02:09:43 +03:00
|
|
|
extern already_AddRefed<nsIAtom> NS_Atomize(const char16_t* aUTF16String);
|
1999-08-21 10:38:59 +04:00
|
|
|
|
|
|
|
/**
|
2013-04-09 01:04:21 +04:00
|
|
|
* Find an atom that matches the given UTF-16 string. Never returns null.
|
1999-08-21 10:38:59 +04:00
|
|
|
*/
|
2016-03-29 02:09:43 +03:00
|
|
|
extern already_AddRefed<nsIAtom> NS_Atomize(const nsAString& aUTF16String);
|
1999-08-21 10:38:59 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return a count of the total number of atoms currently
|
|
|
|
* alive in the system.
|
|
|
|
*/
|
2011-08-18 17:46:39 +04:00
|
|
|
extern nsrefcnt NS_GetNumberOfAtoms(void);
|
1999-08-21 10:38:59 +04:00
|
|
|
|
2009-09-18 19:13:10 +04:00
|
|
|
/**
|
|
|
|
* Return a pointer for a static atom for the string or null if there's
|
|
|
|
* no static atom for this string.
|
|
|
|
*/
|
2011-08-18 17:46:39 +04:00
|
|
|
extern nsIAtom* NS_GetStaticAtom(const nsAString& aUTF16String);
|
2009-09-18 19:13:10 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Seal the static atom table
|
|
|
|
*/
|
2011-08-18 17:46:39 +04:00
|
|
|
extern void NS_SealStaticAtomTable();
|
2009-09-18 19:13:10 +04:00
|
|
|
|
2010-03-08 18:45:00 +03:00
|
|
|
class nsAtomString : public nsString
|
|
|
|
{
|
|
|
|
public:
|
2014-05-26 05:16:01 +04:00
|
|
|
explicit nsAtomString(nsIAtom* aAtom)
|
2010-03-08 18:45:00 +03:00
|
|
|
{
|
|
|
|
aAtom->ToString(*this);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
class nsAtomCString : public nsCString
|
|
|
|
{
|
|
|
|
public:
|
2014-05-26 05:16:01 +04:00
|
|
|
explicit nsAtomCString(nsIAtom* aAtom)
|
2010-03-08 18:45:00 +03:00
|
|
|
{
|
|
|
|
aAtom->ToUTF8String(*this);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
class nsDependentAtomString : public nsDependentString
|
|
|
|
{
|
|
|
|
public:
|
2014-05-26 05:16:01 +04:00
|
|
|
explicit nsDependentAtomString(nsIAtom* aAtom)
|
2010-03-08 18:45:00 +03:00
|
|
|
: nsDependentString(aAtom->GetUTF16String(), aAtom->GetLength())
|
|
|
|
{
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
1999-08-21 10:38:59 +04:00
|
|
|
%}
|