src/third_party/WebKit/Source/modules/notifications/Notification.h

   1 /*
   2  * Copyright (C) 2013 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef Notification_h
  32 #define Notification_h
  33
  34 #include "core/dom/ActiveDOMObject.h"
  35 #include "modules/EventTargetModules.h"
  36 #include "modules/notifications/NotificationClient.h"
  37 #include "platform/AsyncMethodRunner.h"
  38 #include "platform/heap/Handle.h"
  39 #include "platform/text/TextDirection.h"
  40 #include "platform/weborigin/KURL.h"
  41 #include "wtf/PassOwnPtr.h"
  42 #include "wtf/RefCounted.h"
  43
  44 namespace blink {
  45
  46 class Dictionary;
  47 class ExecutionContext;
  48 class NotificationPermissionCallback;
  49
  50 class Notification : public RefCountedGarbageCollectedWillBeGarbageCollectedFinalized<Notification>, public ActiveDOMObject, public EventTargetWithInlineData {
  51     DEFINE_EVENT_TARGET_REFCOUNTING_WILL_BE_REMOVED(RefCountedGarbageCollected<Notification>);
  52     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(Notification);
  53 public:
  54     static Notification* create(ExecutionContext*, const String& title, const Dictionary& options);
  55
  56     virtual ~Notification();
  57
  58     void close();
  59
  60     DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
  61     DEFINE_ATTRIBUTE_EVENT_LISTENER(show);
  62     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
  63     DEFINE_ATTRIBUTE_EVENT_LISTENER(close);
  64
  65     void dispatchShowEvent();
  66     void dispatchClickEvent();
  67     void dispatchErrorEvent();
  68     void dispatchCloseEvent();
  69
  70     String title() const { return m_title; }
  71     String dir() const { return m_dir; }
  72     String lang() const { return m_lang; }
  73     String body() const { return m_body; }
  74     String tag() const { return m_tag; }
  75     String icon() const { return m_iconUrl; }
  76
  77     TextDirection direction() const;
  78     KURL iconURL() const { return m_iconUrl; }
  79
  80     static const String& permissionString(NotificationClient::Permission);
  81     static const String& permission(ExecutionContext*);
  82     static void requestPermission(ExecutionContext*, PassOwnPtr<NotificationPermissionCallback> = nullptr);
  83
  84     // EventTarget interface.
  85     virtual ExecutionContext* executionContext() const OVERRIDE FINAL { return ActiveDOMObject::executionContext(); }
  86     virtual bool dispatchEvent(PassRefPtrWillBeRawPtr<Event>) OVERRIDE FINAL;
  87     virtual const AtomicString& interfaceName() const OVERRIDE;
  88
  89     // ActiveDOMObject interface.
  90     virtual void stop() OVERRIDE;
  91     virtual bool hasPendingActivity() const OVERRIDE;
  92
  93 private:
  94     Notification(const String& title, ExecutionContext*, NotificationClient*);
  95
  96     // Calling show() may start asynchronous operation. If this object has
  97     // a V8 wrapper, hasPendingActivity() prevents the wrapper from being
  98     // collected while m_state is Showing, and so this instance stays alive
  99     // until the operation completes. Otherwise, you need to hold a ref on this
 100     // instance until the operation completes.
 101     void show();
 102
 103     void setDir(const String& dir) { m_dir = dir; }
 104     void setLang(const String& lang) { m_lang = lang; }
 105     void setBody(const String& body) { m_body = body; }
 106     void setIconUrl(KURL iconUrl) { m_iconUrl = iconUrl; }
 107     void setTag(const String& tag) { m_tag = tag; }
 108
 109 private:
 110     String m_title;
 111     String m_dir;
 112     String m_lang;
 113     String m_body;
 114     String m_tag;
 115
 116     KURL m_iconUrl;
 117
 118     enum NotificationState {
 119         NotificationStateIdle,
 120         NotificationStateShowing,
 121         NotificationStateClosed
 122     };
 123
 124     NotificationState m_state;
 125
 126     NotificationClient* m_client;
 127
 128     AsyncMethodRunner<Notification> m_asyncRunner;
 129 };
 130
 131 } // namespace blink
 132
 133 #endif // Notification_h