summaryrefslogtreecommitdiffstats
path: root/dom/base/nsAttrName.h
blob: 5af01b028b61f19de12ae25510a4000cc1b66d6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/* -*- 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/. */

/*
 * Class that represents the name (nodeinfo or atom) of an attribute;
 * using nodeinfos all the time is too slow, so we use atoms when we
 * can.
 */

#ifndef nsAttrName_h___
#define nsAttrName_h___

#include "mozilla/dom/NodeInfo.h"
#include "nsAtom.h"
#include "nsDOMString.h"

#define NS_ATTRNAME_NODEINFO_BIT 1
class nsAttrName {
 public:
  nsAttrName(const nsAttrName& aOther) : mBits(aOther.mBits) {
    AddRefInternalName();
  }

  explicit nsAttrName(nsAtom* aAtom)
      : mBits(reinterpret_cast<uintptr_t>(aAtom)) {
    NS_ASSERTION(aAtom, "null atom-name in nsAttrName");
    NS_ADDREF(aAtom);
  }

  explicit nsAttrName(mozilla::dom::NodeInfo* aNodeInfo) {
    NS_ASSERTION(aNodeInfo, "null nodeinfo-name in nsAttrName");
    if (aNodeInfo->NamespaceEquals(kNameSpaceID_None)) {
      mBits = reinterpret_cast<uintptr_t>(aNodeInfo->NameAtom());
      NS_ADDREF(aNodeInfo->NameAtom());
    } else {
      mBits = reinterpret_cast<uintptr_t>(aNodeInfo) | NS_ATTRNAME_NODEINFO_BIT;
      NS_ADDREF(aNodeInfo);
    }
  }

  ~nsAttrName() { ReleaseInternalName(); }

  void SetTo(mozilla::dom::NodeInfo* aNodeInfo) {
    NS_ASSERTION(aNodeInfo, "null nodeinfo-name in nsAttrName");

    ReleaseInternalName();
    if (aNodeInfo->NamespaceEquals(kNameSpaceID_None)) {
      mBits = reinterpret_cast<uintptr_t>(aNodeInfo->NameAtom());
      NS_ADDREF(aNodeInfo->NameAtom());
    } else {
      mBits = reinterpret_cast<uintptr_t>(aNodeInfo) | NS_ATTRNAME_NODEINFO_BIT;
      NS_ADDREF(aNodeInfo);
    }
  }

  void SetTo(nsAtom* aAtom) {
    NS_ASSERTION(aAtom, "null atom-name in nsAttrName");

    ReleaseInternalName();
    mBits = reinterpret_cast<uintptr_t>(aAtom);
    NS_ADDREF(aAtom);
  }

  bool IsAtom() const { return !(mBits & NS_ATTRNAME_NODEINFO_BIT); }

  mozilla::dom::NodeInfo* NodeInfo() const {
    NS_ASSERTION(!IsAtom(), "getting nodeinfo-value of atom-name");
    return reinterpret_cast<mozilla::dom::NodeInfo*>(mBits &
                                                     ~NS_ATTRNAME_NODEINFO_BIT);
  }

  nsAtom* Atom() const {
    NS_ASSERTION(IsAtom(), "getting atom-value of nodeinfo-name");
    return reinterpret_cast<nsAtom*>(mBits);
  }

  bool Equals(const nsAttrName& aOther) const { return mBits == aOther.mBits; }

  // Faster comparison in the case we know the namespace is null
  // Note that some callers such as AttrArray::IndexOfAttr() will
  // call this function on nsAttrName structs with 0 mBits, so no attempt
  // must be made to do anything with mBits besides comparing it with the
  // incoming aAtom argument.
  bool Equals(const nsAtom* aAtom) const {
    return reinterpret_cast<uintptr_t>(aAtom) == mBits;
  }

  // And the same but without forcing callers to atomize
  bool Equals(const nsAString& aLocalName) const {
    return IsAtom() && Atom()->Equals(aLocalName);
  }

  bool Equals(const nsAtom* aLocalName, int32_t aNamespaceID) const {
    if (aNamespaceID == kNameSpaceID_None) {
      return Equals(aLocalName);
    }
    return !IsAtom() && NodeInfo()->Equals(aLocalName, aNamespaceID);
  }

  bool Equals(mozilla::dom::NodeInfo* aNodeInfo) const {
    return Equals(aNodeInfo->NameAtom(), aNodeInfo->NamespaceID());
  }

  int32_t NamespaceID() const {
    return IsAtom() ? kNameSpaceID_None : NodeInfo()->NamespaceID();
  }

  int32_t NamespaceEquals(int32_t aNamespaceID) const {
    return aNamespaceID == kNameSpaceID_None
               ? IsAtom()
               : (!IsAtom() && NodeInfo()->NamespaceEquals(aNamespaceID));
  }

  nsAtom* LocalName() const {
    return IsAtom() ? Atom() : NodeInfo()->NameAtom();
  }

  nsAtom* GetPrefix() const {
    return IsAtom() ? nullptr : NodeInfo()->GetPrefixAtom();
  }

  bool QualifiedNameEquals(const nsAString& aName) const {
    return IsAtom() ? Atom()->Equals(aName)
                    : NodeInfo()->QualifiedNameEquals(aName);
  }

  void GetQualifiedName(nsAString& aStr) const {
    if (IsAtom()) {
      Atom()->ToString(aStr);
    } else {
      aStr = NodeInfo()->QualifiedName();
    }
  }

#ifdef MOZILLA_INTERNAL_API
  void GetPrefix(nsAString& aStr) const {
    if (IsAtom()) {
      SetDOMStringToNull(aStr);
    } else {
      NodeInfo()->GetPrefix(aStr);
    }
  }
#endif

  uint32_t HashValue() const {
    // mBits and uint32_t might have different size. This should silence
    // any warnings or compile-errors. This is what the implementation of
    // NS_PTR_TO_INT32 does to take care of the same problem.
    return mBits - 0;
  }

  bool IsSmaller(const nsAtom* aOther) const {
    return mBits < reinterpret_cast<uintptr_t>(aOther);
  }

 private:
  void AddRefInternalName() {
    if (IsAtom()) {
      NS_ADDREF(Atom());
    } else {
      NS_ADDREF(NodeInfo());
    }
  }

  void ReleaseInternalName() {
    if (IsAtom()) {
      Atom()->Release();
    } else {
      NodeInfo()->Release();
    }
  }

  uintptr_t mBits;
};

#endif