Make some things that return never-null pointers return references instead.
[WebKit-https.git] / Source / WebCore / Modules / speech / SpeechSynthesisUtterance.h
1 /*
2  * Copyright (C) 2013 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef SpeechSynthesisUtterance_h
27 #define SpeechSynthesisUtterance_h
28
29 #if ENABLE(SPEECH_SYNTHESIS)
30
31 #include "ContextDestructionObserver.h"
32 #include "EventTarget.h"
33 #include "PlatformSpeechSynthesisUtterance.h"
34 #include "SpeechSynthesisVoice.h"
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37
38 namespace WebCore {
39     
40 class SpeechSynthesisUtterance : public PlatformSpeechSynthesisUtteranceClient, public RefCounted<SpeechSynthesisUtterance>, public ContextDestructionObserver, public EventTarget {
41 public:
42     static PassRefPtr<SpeechSynthesisUtterance> create(ScriptExecutionContext*, const String&);
43     
44     ~SpeechSynthesisUtterance();
45
46     const String& text() const { return m_platformUtterance->text(); }
47     void setText(const String& text) { m_platformUtterance->setText(text); }
48
49     const String& lang() const { return m_platformUtterance->lang(); }
50     void setLang(const String& lang) { m_platformUtterance->setLang(lang); }
51
52     SpeechSynthesisVoice* voice() const;
53     void setVoice(SpeechSynthesisVoice*);
54
55     float volume() const { return m_platformUtterance->volume(); }
56     void setVolume(float volume) { m_platformUtterance->setVolume(volume); }
57
58     float rate() const { return m_platformUtterance->rate(); }
59     void setRate(float rate) { m_platformUtterance->setRate(rate); }
60
61     float pitch() const { return m_platformUtterance->pitch(); }
62     void setPitch(float pitch) { m_platformUtterance->setPitch(pitch); }
63
64     double startTime() const { return m_platformUtterance->startTime(); }
65     void setStartTime(double startTime) { m_platformUtterance->setStartTime(startTime); }
66     
67     DEFINE_ATTRIBUTE_EVENT_LISTENER(start);
68     DEFINE_ATTRIBUTE_EVENT_LISTENER(end);
69     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
70     DEFINE_ATTRIBUTE_EVENT_LISTENER(pause);
71     DEFINE_ATTRIBUTE_EVENT_LISTENER(resume);
72     DEFINE_ATTRIBUTE_EVENT_LISTENER(mark);
73     DEFINE_ATTRIBUTE_EVENT_LISTENER(boundary);
74
75     using RefCounted<SpeechSynthesisUtterance>::ref;
76     using RefCounted<SpeechSynthesisUtterance>::deref;
77
78     virtual ScriptExecutionContext* scriptExecutionContext() const;
79
80     PlatformSpeechSynthesisUtterance* platformUtterance() const { return m_platformUtterance.get(); }
81
82 private:
83     SpeechSynthesisUtterance(ScriptExecutionContext*, const String&);
84     RefPtr<PlatformSpeechSynthesisUtterance> m_platformUtterance;
85     RefPtr<SpeechSynthesisVoice> m_voice;
86     
87     // EventTarget
88     EventTargetData m_eventTargetData;
89
90     virtual const AtomicString& interfaceName() const OVERRIDE;
91     virtual void refEventTarget() OVERRIDE { ref(); }
92     virtual void derefEventTarget() OVERRIDE { deref(); }
93     virtual EventTargetData* eventTargetData() OVERRIDE { return &m_eventTargetData; }
94     virtual EventTargetData& ensureEventTargetData() OVERRIDE { return m_eventTargetData; }
95 };
96     
97 } // namespace WebCore
98
99 #endif // ENABLE(SPEECH_SYNTHESIS)
100
101 #endif // SpeechSynthesisUtterance_h