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/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 DOMWindow;
  42 class ExceptionState;
  43 class Frame;
  44 class KURL;
  45
  46 class Location FINAL : public ScriptWrappable, public RefCounted<Location>, public DOMWindowProperty {
  47 public:
  48     static PassRefPtr<Location> create(Frame* frame) { return adoptRef(new Location(frame)); }
  49
  50     void setHref(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  51     String href() const;
  52
  53     void assign(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  54     void replace(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  55     void reload(DOMWindow* activeWindow);
  56
  57     void setProtocol(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&, ExceptionState&);
  58     String protocol() const;
  59     void setHost(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  60     String host() const;
  61     void setHostname(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  62     String hostname() const;
  63     void setPort(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  64     String port() const;
  65     void setPathname(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  66     String pathname() const;
  67     void setSearch(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  68     String search() const;
  69     void setHash(DOMWindow* activeWindow, DOMWindow* firstWindow, const String&);
  70     String hash() const;
  71     String origin() const;
  72
  73     PassRefPtr<DOMStringList> ancestorOrigins() const;
  74
  75 private:
  76     explicit Location(Frame*);
  77
  78     void setLocation(const String&, DOMWindow* activeWindow, DOMWindow* firstWindow);
  79
  80     const KURL& url() const;
  81 };
  82
  83 } // namespace WebCore
  84
  85 #endif // Location_h