third_party/WebKit/Source/modules/fetch/Headers.h

// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef Headers_h
#define Headers_h

#include "bindings/core/v8/Iterable.h"
#include "bindings/core/v8/ScriptState.h"
#include "bindings/core/v8/ScriptWrappable.h"
#include "modules/ModulesExport.h"
#include "modules/fetch/FetchHeaderList.h"
#include "wtf/Forward.h"
#include "wtf/PassOwnPtr.h"

namespace blink {

class Dictionary;
class ExceptionState;
class Iterator;

// http://fetch.spec.whatwg.org/#headers-class
class MODULES_EXPORT Headers final : public GarbageCollected<Headers>, public ScriptWrappable, public PairIterable<String, String> {
    DEFINE_WRAPPERTYPEINFO();
public:
    enum Guard { ImmutableGuard, RequestGuard, RequestNoCORSGuard, ResponseGuard, NoneGuard };

    static Headers* create();
    static Headers* create(ExceptionState&);
    static Headers* create(const Headers*, ExceptionState&);
    static Headers* create(const Vector<Vector<String>>&, ExceptionState&);
    static Headers* create(const Dictionary&, ExceptionState&);

    // Shares the FetchHeaderList. Called when creating a Request or Response.
    static Headers* create(FetchHeaderList*);

    Headers* clone() const;

    // Headers.idl implementation.
    void append(const String& name, const String& value, ExceptionState&);
    void remove(const String& key, ExceptionState&);
    String get(const String& key, ExceptionState&);
    Vector<String> getAll(const String& key, ExceptionState&);
    bool has(const String& key, ExceptionState&);
    void set(const String& key, const String& value, ExceptionState&);

    void setGuard(Guard guard) { m_guard = guard; }
    Guard getGuard() const { return m_guard; }

    // These methods should only be called when size() would return 0.
    void fillWith(const Headers*, ExceptionState&);
    void fillWith(const Vector<Vector<String>>&, ExceptionState&);
    void fillWith(const Dictionary&, ExceptionState&);

    FetchHeaderList* headerList() const { return m_headerList; }
    DECLARE_TRACE();

private:
    Headers();
    // Shares the FetchHeaderList. Called when creating a Request or Response.
    explicit Headers(FetchHeaderList*);

    Member<FetchHeaderList> m_headerList;
    Guard m_guard;

    IterationSource* startIteration(ScriptState*, ExceptionState&) override;
};

} // namespace blink

#endif // Headers_h