1 /* 2 * Copyright (C) 2010 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 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 SpellCheckRequester_h 27 #define SpellCheckRequester_h 28 29 #include "core/dom/Element.h" 30 #include "core/dom/Range.h" 31 #include "platform/Timer.h" 32 #include "platform/text/TextChecking.h" 33 #include "wtf/Deque.h" 34 #include "wtf/Noncopyable.h" 35 #include "wtf/RefPtr.h" 36 #include "wtf/Vector.h" 37 #include "wtf/text/WTFString.h" 38 39 namespace WebCore { 40 41 class LocalFrame; 42 class Node; 43 class SpellCheckRequester; 44 class TextCheckerClient; 45 46 class SpellCheckRequest FINAL : public TextCheckingRequest { 47 public: 48 static PassRefPtr<SpellCheckRequest> create(TextCheckingTypeMask, TextCheckingProcessType, PassRefPtrWillBeRawPtr<Range> checkingRange, PassRefPtrWillBeRawPtr<Range> paragraphRange, int requestNumber = 0); 49 virtual ~SpellCheckRequest(); 50 checkingRange()51 PassRefPtrWillBeRawPtr<Range> checkingRange() const { return m_checkingRange; } paragraphRange()52 PassRefPtrWillBeRawPtr<Range> paragraphRange() const { return m_paragraphRange; } rootEditableElement()53 PassRefPtrWillBeRawPtr<Element> rootEditableElement() const { return m_rootEditableElement; } 54 55 void setCheckerAndSequence(SpellCheckRequester*, int sequence); 56 void requesterDestroyed(); 57 58 virtual const TextCheckingRequestData& data() const OVERRIDE; 59 virtual void didSucceed(const Vector<TextCheckingResult>&) OVERRIDE; 60 virtual void didCancel() OVERRIDE; 61 requestNumber()62 int requestNumber() const { return m_requestNumber; } 63 64 private: 65 SpellCheckRequest(PassRefPtrWillBeRawPtr<Range> checkingRange, PassRefPtrWillBeRawPtr<Range> paragraphRange, const String&, TextCheckingTypeMask, TextCheckingProcessType, const Vector<uint32_t>& documentMarkersInRange, const Vector<unsigned>& documentMarkerOffsets, int requestNumber); 66 67 SpellCheckRequester* m_requester; 68 RefPtrWillBePersistent<Range> m_checkingRange; 69 RefPtrWillBePersistent<Range> m_paragraphRange; 70 RefPtrWillBePersistent<Element> m_rootEditableElement; 71 TextCheckingRequestData m_requestData; 72 int m_requestNumber; 73 }; 74 75 class SpellCheckRequester { 76 WTF_MAKE_NONCOPYABLE(SpellCheckRequester); WTF_MAKE_FAST_ALLOCATED; 77 public: 78 friend class SpellCheckRequest; 79 80 explicit SpellCheckRequester(LocalFrame&); 81 ~SpellCheckRequester(); 82 83 bool isAsynchronousEnabled() const; 84 bool isCheckable(Range*) const; 85 86 void requestCheckingFor(PassRefPtr<SpellCheckRequest>); 87 void cancelCheck(); 88 lastRequestSequence()89 int lastRequestSequence() const 90 { 91 return m_lastRequestSequence; 92 } 93 lastProcessedSequence()94 int lastProcessedSequence() const 95 { 96 return m_lastProcessedSequence; 97 } 98 99 private: 100 typedef Deque<RefPtr<SpellCheckRequest> > RequestQueue; 101 102 bool canCheckAsynchronously(Range*) const; 103 TextCheckerClient& client() const; 104 void timerFiredToProcessQueuedRequest(Timer<SpellCheckRequester>*); 105 void invokeRequest(PassRefPtr<SpellCheckRequest>); 106 void enqueueRequest(PassRefPtr<SpellCheckRequest>); 107 void didCheckSucceed(int sequence, const Vector<TextCheckingResult>&); 108 void didCheckCancel(int sequence); 109 void didCheck(int sequence, const Vector<TextCheckingResult>&); 110 111 LocalFrame& m_frame; 112 int m_lastRequestSequence; 113 int m_lastProcessedSequence; 114 115 Timer<SpellCheckRequester> m_timerToProcessQueuedRequest; 116 117 RefPtr<SpellCheckRequest> m_processingRequest; 118 RequestQueue m_requestQueue; 119 }; 120 121 } // namespace WebCore 122 123 #endif // SpellCheckRequester_h 124