src/third_party/WebKit/Source/modules/serviceworkers/Headers.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef Headers_h
   6 #define Headers_h
   7
   8 #include "bindings/core/v8/ScriptWrappable.h"
   9 #include "modules/serviceworkers/FetchHeaderList.h"
  10 #include "wtf/Forward.h"
  11 #include "wtf/PassOwnPtr.h"
  12 #include "wtf/RefCounted.h"
  13
  14 namespace blink {
  15
  16 class Dictionary;
  17 class ExceptionState;
  18 class HeadersForEachCallback;
  19 class ScriptValue;
  20
  21 // http://fetch.spec.whatwg.org/#headers-class
  22 class Headers FINAL : public RefCountedWillBeGarbageCollected<Headers>, public ScriptWrappable {
  23     DECLARE_EMPTY_DESTRUCTOR_WILL_BE_REMOVED(Headers);
  24 public:
  25     enum Guard { ImmutableGuard, RequestGuard, RequestNoCORSGuard, ResponseGuard, NoneGuard };
  26
  27     static PassRefPtrWillBeRawPtr<Headers> create();
  28     static PassRefPtrWillBeRawPtr<Headers> create(ExceptionState&);
  29     static PassRefPtrWillBeRawPtr<Headers> create(const Headers*, ExceptionState&);
  30     static PassRefPtrWillBeRawPtr<Headers> create(const Dictionary&, ExceptionState&);
  31
  32     // Shares the FetchHeaderList. Called when creating a Request or Response.
  33     static PassRefPtrWillBeRawPtr<Headers> create(FetchHeaderList*);
  34
  35     PassRefPtrWillBeRawPtr<Headers> createCopy() const;
  36
  37     // Headers.idl implementation.
  38     void append(const String& name, const String& value, ExceptionState&);
  39     void remove(const String& key, ExceptionState&);
  40     String get(const String& key, ExceptionState&);
  41     Vector<String> getAll(const String& key, ExceptionState&);
  42     bool has(const String& key, ExceptionState&);
  43     void set(const String& key, const String& value, ExceptionState&);
  44     unsigned long size() const;
  45     void forEach(PassOwnPtr<HeadersForEachCallback>, ScriptValue&);
  46     void forEach(PassOwnPtr<HeadersForEachCallback>);
  47
  48     void setGuard(Guard guard) { m_guard = guard; }
  49     Guard guard() const { return m_guard; }
  50
  51     // These methods should only be called when size() would return 0.
  52     void fillWith(const Headers*, ExceptionState&);
  53     void fillWith(const Dictionary&, ExceptionState&);
  54
  55     void trace(Visitor*);
  56
  57 private:
  58     Headers();
  59     // Shares the FetchHeaderList. Called when creating a Request or Response.
  60     explicit Headers(FetchHeaderList*);
  61     void forEachInternal(PassOwnPtr<HeadersForEachCallback>, ScriptValue*);
  62
  63     RefPtrWillBeMember<FetchHeaderList> m_headerList;
  64     Guard m_guard;
  65 };
  66
  67 } // namespace blink
  68
  69 #endif // Headers_h