app/keyboard_code_conversion_mac.h

// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef APP_KEYBOARD_CODE_CONVERSION_MAC_H_
#define APP_KEYBOARD_CODE_CONVERSION_MAC_H_

#import <Cocoa/Cocoa.h>
#include "app/keyboard_codes_posix.h"
#include "base/basictypes.h"

namespace app {

// We use windows virtual keycodes throughout our keyboard event related code,
// including unit tests. But Mac uses a different set of virtual keycodes.
// This function converts a windows virtual keycode into Mac's virtual key code
// and corresponding unicode character. |flags| is the modifiers mask such
// as NSControlKeyMask, NSShiftKeyMask, etc.
// When success, the corresponding Mac's virtual key code will be returned.
// The corresponding unicode character will be stored in |character|, and the
// corresponding unicode character ignoring the modifiers will be stored in
// |characterIgnoringModifiers|.
// -1 will be returned if the keycode can't be converted.
// This function is mainly for simulating keyboard events in unit tests.
// See third_party/WebKit/WebKit/chromium/src/mac/WebInputEventFactory.mm for
// reverse conversion.
int MacKeyCodeForWindowsKeyCode(KeyboardCode keycode,
                                NSUInteger flags,
                                unichar* character,
                                unichar* characterIgnoringModifiers);

} // namespace app

#endif  // APP_KEYBOARD_CODE_CONVERSION_MAC_H_