src/third_party/WebKit/Source/core/frame/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 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/core/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 blink {
  40
  41 class LocalDOMWindow;
  42 class ExceptionState;
  43 class LocalFrame;
  44 class KURL;
  45
  46 class Location FINAL : public RefCountedWillBeGarbageCollected<Location>, public ScriptWrappable, public DOMWindowProperty {
  47     DEFINE_WRAPPERTYPEINFO();
  48     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(Location);
  49 public:
  50     static PassRefPtrWillBeRawPtr<Location> create(LocalFrame* frame)
  51     {
  52         return adoptRefWillBeNoop(new Location(frame));
  53     }
  54
  55     void setHref(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  56     String href() const;
  57
  58     void assign(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  59     void replace(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  60     void reload(LocalDOMWindow* callingWindow);
  61
  62     void setProtocol(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&, ExceptionState&);
  63     String protocol() const;
  64     void setHost(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  65     String host() const;
  66     void setHostname(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  67     String hostname() const;
  68     void setPort(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  69     String port() const;
  70     void setPathname(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  71     String pathname() const;
  72     void setSearch(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  73     String search() const;
  74     void setHash(LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow, const String&);
  75     String hash() const;
  76     String origin() const;
  77
  78     PassRefPtrWillBeRawPtr<DOMStringList> ancestorOrigins() const;
  79
  80     virtual void trace(Visitor*) OVERRIDE;
  81
  82 private:
  83     explicit Location(LocalFrame*);
  84
  85     void setLocation(const String&, LocalDOMWindow* callingWindow, LocalDOMWindow* enteredWindow);
  86
  87     const KURL& url() const;
  88 };
  89
  90 } // namespace blink
  91
  92 #endif // Location_h