1/*
2 * Copyright (C) 2008, 2010 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef Location_h
30#define Location_h
31
32#include "DOMStringList.h"
33#include "DOMWindowProperty.h"
34#include "ScriptWrappable.h"
35#include <wtf/PassRefPtr.h>
36#include <wtf/RefCounted.h>
37#include <wtf/text/WTFString.h>
38
39namespace WebCore {
40
41class DOMWindow;
42class Frame;
43class URL;
44
45typedef int ExceptionCode;
46
47class Location : public ScriptWrappable, public RefCounted<Location>, public DOMWindowProperty {
48public:
49    static PassRefPtr<Location> create(Frame* frame) { return adoptRef(new Location(frame)); }
50
51    void setHref(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
52    String href() const;
53
54    void assign(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
55    void replace(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
56    void reload(DOMWindow& activeWindow);
57
58    void setProtocol(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow, ExceptionCode&);
59    String protocol() const;
60    void setHost(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
61    String host() const;
62    void setHostname(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
63    String hostname() const;
64    void setPort(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
65    String port() const;
66    void setPathname(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
67    String pathname() const;
68    void setSearch(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
69    String search() const;
70    void setHash(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
71    String hash() const;
72    String origin() const;
73
74    String toString() const { return href(); }
75
76    PassRefPtr<DOMStringList> ancestorOrigins() const;
77
78private:
79    explicit Location(Frame*);
80
81    void setLocation(const String&, DOMWindow& activeWindow, DOMWindow& firstWindow);
82
83    const URL& url() const;
84};
85
86} // namespace WebCore
87
88#endif // Location_h
89