1/*
2 * Copyright (C) 2012 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 INC. AND ITS CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
20 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 * SUCH DAMAGE.
24 */
25
26#ifndef TypeAhead_h
27#define TypeAhead_h
28
29#include "core/dom/DOMTimeStamp.h"
30#include "wtf/text/StringBuilder.h"
31#include "wtf/text/WTFString.h"
32
33namespace blink {
34
35class KeyboardEvent;
36
37class TypeAheadDataSource {
38public:
39    virtual ~TypeAheadDataSource() { }
40
41    virtual int indexOfSelectedOption() const = 0;
42    virtual int optionCount() const = 0;
43    virtual String optionAtIndex(int index) const = 0;
44};
45
46class TypeAhead {
47public:
48    TypeAhead(TypeAheadDataSource*);
49
50    enum ModeFlag {
51        MatchPrefix = 1 << 0,
52        CycleFirstChar = 1 << 1,
53        MatchIndex = 1 << 2,
54    };
55    typedef unsigned MatchModeFlags;
56
57    // Returns the index for the matching option.
58    int handleEvent(KeyboardEvent*, MatchModeFlags);
59
60private:
61    TypeAheadDataSource* m_dataSource;
62    DOMTimeStamp m_lastTypeTime;
63    UChar m_repeatingChar;
64    StringBuilder m_buffer;
65};
66
67} // namespace blink
68
69#endif // TypeAhead_h
70