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