/*
 * Copyright (C) 2008 Apple Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

// https://html.spec.whatwg.org/#the-location-interface

[
    CheckSecurity=Frame,
    Unforgeable,
    WillBeGarbageCollected,
] interface Location {
    // |assign|, |replace|, and *writing* |href| do not require a security
    // check, as they *change* the page, and thus these do not change any
    // property of an *existing* document at a different origin.
    // However, *reading* |href|, or accessing any component, is a security
    // problem, since that allows tracking navigation.
    [CallWith=(ActiveWindow,FirstWindow), DoNotCheckSecurity] void assign(DOMString url);
    [CallWith=(ActiveWindow,FirstWindow), DoNotCheckSecurity] void replace(DOMString url);
    [CallWith=ActiveWindow] void reload();

    // TODO(philipj): ancestorOrigins should have [SameObject] and be of type
    // DOMString[], i.e. it should return the same array every time.
    [Measure] readonly attribute DOMStringList ancestorOrigins;

    // TODO(philipj): Per spec, Location implements URLUtils. The below is
    // mostly like the URLUtils interface, but with some members missing and
    // using DOMString instead of USVString.
    [SetterCallWith=(ActiveWindow,FirstWindow), DoNotCheckSecurity=Setter] attribute DOMString href;
    [NotEnumerable, ImplementedAs=href] DOMString toString();
    readonly attribute DOMString origin;

    [SetterCallWith=(ActiveWindow,FirstWindow), RaisesException=Setter] attribute DOMString protocol;
    [SetterCallWith=(ActiveWindow,FirstWindow)] attribute DOMString host;
    [SetterCallWith=(ActiveWindow,FirstWindow)] attribute DOMString hostname;
    [SetterCallWith=(ActiveWindow,FirstWindow)] attribute DOMString port;
    [SetterCallWith=(ActiveWindow,FirstWindow)] attribute DOMString pathname;
    [SetterCallWith=(ActiveWindow,FirstWindow)] attribute DOMString search;
    [SetterCallWith=(ActiveWindow,FirstWindow)] attribute DOMString hash;

    // TODO(philipj): Location does not have a valueOf() override in the spec.
    // See the comment in Location.h for the purpose of this.
    [NotEnumerable, CallWith=ThisValue] any valueOf();
};