summaryrefslogtreecommitdiffstats
path: root/dom/fetch/Headers.h
blob: ea3b24405d3fdafe44c04d98c0927f077c1e625f (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
/* -*- 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 mozilla_dom_Headers_h
#define mozilla_dom_Headers_h

#include "mozilla/dom/HeadersBinding.h"

#include "nsClassHashtable.h"
#include "nsWrapperCache.h"

#include "InternalHeaders.h"

namespace mozilla {

class ErrorResult;

namespace dom {

template <typename K, typename V>
class Record;
class ByteStringSequenceSequenceOrByteStringByteStringRecord;
class OwningByteStringSequenceSequenceOrByteStringByteStringRecord;

/**
 * This Headers class is only used to represent the content facing Headers
 * object. It is actually backed by an InternalHeaders implementation. Gecko
 * code should NEVER use this, except in the Request and Response
 * implementations, where they must always be created from the backing
 * InternalHeaders object.
 */
class Headers final : public nsISupports, public nsWrapperCache {
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(Headers)

  friend class Request;
  friend class Response;

 private:
  nsCOMPtr<nsISupports> mOwner;
  RefPtr<InternalHeaders> mInternalHeaders;

 public:
  explicit Headers(nsISupports* aOwner, InternalHeaders* aInternalHeaders)
      : mOwner(aOwner), mInternalHeaders(aInternalHeaders) {}

  explicit Headers(const Headers& aOther) = delete;

  static bool PrefEnabled(JSContext* cx, JSObject* obj);

  static already_AddRefed<Headers> Constructor(
      const GlobalObject& aGlobal,
      const Optional<ByteStringSequenceSequenceOrByteStringByteStringRecord>&
          aInit,
      ErrorResult& aRv);

  static already_AddRefed<Headers> Constructor(
      const GlobalObject& aGlobal,
      const OwningByteStringSequenceSequenceOrByteStringByteStringRecord& aInit,
      ErrorResult& aRv);

  static already_AddRefed<Headers> Create(
      nsIGlobalObject* aGlobalObject,
      const OwningByteStringSequenceSequenceOrByteStringByteStringRecord& aInit,
      ErrorResult& aRv);

  void Append(const nsACString& aName, const nsACString& aValue,
              ErrorResult& aRv) {
    mInternalHeaders->Append(aName, aValue, aRv);
  }

  void Delete(const nsACString& aName, ErrorResult& aRv) {
    mInternalHeaders->Delete(aName, aRv);
  }

  void Get(const nsACString& aName, nsACString& aValue,
           ErrorResult& aRv) const {
    mInternalHeaders->Get(aName, aValue, aRv);
  }

  void GetSetCookie(nsTArray<nsCString>& aValues) const {
    mInternalHeaders->GetSetCookie(aValues);
  }

  void GetFirst(const nsACString& aName, nsACString& aValue,
                ErrorResult& aRv) const {
    mInternalHeaders->GetFirst(aName, aValue, aRv);
  }

  bool Has(const nsACString& aName, ErrorResult& aRv) const {
    return mInternalHeaders->Has(aName, aRv);
  }

  void Set(const nsACString& aName, const nsACString& aValue,
           ErrorResult& aRv) {
    mInternalHeaders->Set(aName, aValue, aRv);
  }

  uint32_t GetIterableLength() const {
    return mInternalHeaders->GetIterableLength();
  }
  const nsString GetKeyAtIndex(unsigned aIndex) const {
    return mInternalHeaders->GetKeyAtIndex(aIndex);
  }
  const nsString GetValueAtIndex(unsigned aIndex) const {
    return mInternalHeaders->GetValueAtIndex(aIndex);
  }

  // ChromeOnly
  HeadersGuardEnum Guard() const { return mInternalHeaders->Guard(); }

  void SetGuard(HeadersGuardEnum aGuard, ErrorResult& aRv) {
    mInternalHeaders->SetGuard(aGuard, aRv);
  }

  virtual JSObject* WrapObject(JSContext* aCx,
                               JS::Handle<JSObject*> aGivenProto) override;
  nsISupports* GetParentObject() const { return mOwner; }

 private:
  virtual ~Headers();

  InternalHeaders* GetInternalHeaders() const { return mInternalHeaders; }
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_Headers_h