4e77a70b778f060d31b95b71310bce1b54cf53b9
[WebKit-https.git] / Source / WebCore / page / Location.h
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 #pragma once
30
31 #include "DOMStringList.h"
32 #include "DOMWindowProperty.h"
33 #include "ExceptionOr.h"
34 #include "ScriptWrappable.h"
35
36 namespace WebCore {
37
38 class DOMWindow;
39 class Frame;
40 class URL;
41
42 class Location : public ScriptWrappable, public RefCounted<Location>, public DOMWindowProperty {
43 public:
44     static Ref<Location> create(Frame* frame) { return adoptRef(*new Location(frame)); }
45
46     void setHref(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
47     String href() const;
48
49     void assign(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
50     void replace(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
51     void reload(DOMWindow& activeWindow);
52
53     ExceptionOr<void> setProtocol(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
54     String protocol() const;
55     void setHost(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
56     String host() const;
57     void setHostname(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
58     String hostname() const;
59     void setPort(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
60     String port() const;
61     void setPathname(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
62     String pathname() const;
63     void setSearch(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
64     String search() const;
65     void setHash(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
66     String hash() const;
67     String origin() const;
68
69     String toString() const { return href(); }
70
71     Vector<String> ancestorOrigins() const;
72
73 private:
74     explicit Location(Frame*);
75
76     void setLocation(DOMWindow& activeWindow, DOMWindow& firstWindow, const String&);
77
78     const URL& url() const;
79 };
80
81 } // namespace WebCore