1/*
2 * Copyright (C) 2012 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef AlternativeTextUIController_h
27#define AlternativeTextUIController_h
28
29#include "AlternativeTextClient.h"
30#include "FloatRect.h"
31#include <wtf/HashMap.h>
32#include <wtf/RetainPtr.h>
33
34#if USE(DICTATION_ALTERNATIVES)
35OBJC_CLASS NSTextAlternatives;
36OBJC_CLASS NSView;
37
38namespace WebCore {
39
40class AlternativeTextUIController {
41public:
42    AlternativeTextUIController() { }
43    // Returns a context ID.
44    uint64_t addAlternatives(const RetainPtr<NSTextAlternatives>&);
45    void clear();
46    void showAlternatives(NSView*, const FloatRect& boundingBoxOfPrimaryString, uint64_t context, void(^acceptanceHandler)(NSString*));
47    void removeAlternatives(uint64_t context);
48    Vector<String> alternativesForContext(uint64_t context);
49
50private:
51    void handleAcceptedAlternative(NSString* acceptedAlternative, uint64_t context, NSTextAlternatives*);
52
53    void dismissAlternatives();
54
55    class AlernativeTextContextController {
56    public:
57        AlernativeTextContextController() { }
58        uint64_t addAlternatives(const RetainPtr<NSTextAlternatives>&);
59        void clear();
60        NSTextAlternatives* alternativesForContext(uint64_t context);
61        void removeAlternativesForContext(uint64_t context);
62        static const uint64_t invalidContext = 0;
63    private:
64        typedef HashMap<uint64_t, RetainPtr<NSTextAlternatives> > HashMapType;
65        HashMapType m_alternativesObjectMap;
66    };
67
68    AlernativeTextContextController m_contextController;
69    RetainPtr<NSView> m_view;
70};
71
72} // namespace WebCore
73
74#endif
75#endif // AlternativeTextUIController_h
76