Home | History | Annotate | Download | only in frame
      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 Computer, 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 "bindings/v8/ScriptWrappable.h"
     33 #include "core/dom/DOMStringList.h"
     34 #include "core/frame/DOMWindowProperty.h"
     35 #include "wtf/PassRefPtr.h"
     36 #include "wtf/RefCounted.h"
     37 #include "wtf/text/WTFString.h"
     38 
     39 namespace WebCore {
     40 
     41 class LocalDOMWindow;
     42 class ExceptionState;
     43 class LocalFrame;
     44 class KURL;
     45 
     46 class Location FINAL : public RefCountedWillBeGarbageCollectedFinalized<Location>, public ScriptWrappable, public DOMWindowProperty {
     47 public:
     48     static PassRefPtrWillBeRawPtr<Location> create(LocalFrame* frame)
     49     {
     50         return adoptRefWillBeNoop(new Location(frame));
     51     }
     52 
     53     void setHref(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     54     String href() const;
     55 
     56     void assign(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     57     void replace(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     58     void reload(LocalDOMWindow* callingWindow);
     59 
     60     void setProtocol(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&, ExceptionState&);
     61     String protocol() const;
     62     void setHost(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     63     String host() const;
     64     void setHostname(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     65     String hostname() const;
     66     void setPort(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     67     String port() const;
     68     void setPathname(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     69     String pathname() const;
     70     void setSearch(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     71     String search() const;
     72     void setHash(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
     73     String hash() const;
     74     String origin() const;
     75 
     76     PassRefPtrWillBeRawPtr<DOMStringList> ancestorOrigins() const;
     77 
     78     void trace(Visitor*) { }
     79 
     80 private:
     81     explicit Location(LocalFrame*);
     82 
     83     void setLocation(const String&, LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow);
     84 
     85     const KURL& url() const;
     86 };
     87 
     88 } // namespace WebCore
     89 
     90 #endif // Location_h
     91