Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use Scan prefix instead of 's'

Browse Source 
Also use getDescription instead of localizedRepresentation
This commit is contained in:
Lukas Dürrenberger 2017-09-09 01:21:29 +02:00 committed by Lukas Dürrenberger
parent cabf1a3c34
commit b191a0dc58
12 changed files with 942 additions and 942 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

273
include/SFML/Window/Keyboard.hpp
View File

@ -29,11 +29,12 @@
// Headers
////////////////////////////////////////////////////////////
#include <SFML/Window/Export.hpp>
#include <SFML/System/String.hpp>
namespace sf
{
class String;
////////////////////////////////////////////////////////////
/// \brief Give access to the real-time state of the keyboard
///
@ -169,153 +170,151 @@ public:
////////////////////////////////////////////////////////////
/// \brief Scancodes
///
/// The enumerators are bound to a physical key and do *not* depend
/// on the keyboard layout used by the operating system. Usually, the AT-101
/// The enumerators are bound to a physical key and do not depend on
/// the keyboard layout used by the operating system. Usually, the AT-101
/// keyboard can be used as reference for the physical position of the keys.
///
/// The scancodes are based on a subset of Table 12: Keyboard/Keypad Page
/// of Universal Serial Bus (USB): HID Usage Tables, v1.12.
///
/// \todo When porting this for SFML 3, remove the `s` prefix and use
/// \todo When porting this for SFML 3, remove the `Scan` prefix and use
/// enum class.
///
////////////////////////////////////////////////////////////
enum Scancode
{
sUnknown = -1, ///< Represents any scancode not present in this enum
sA = 0, ///< Keyboard a and A key
sB, ///< Keyboard b and B key
sC, ///< Keyboard c and C key
sD, ///< Keyboard d and D key
sE, ///< Keyboard e and E key
sF, ///< Keyboard f and F key
sG, ///< Keyboard g and G key
sH, ///< Keyboard h and H key
sI, ///< Keyboard i and I key
sJ, ///< Keyboard j and J key
sK, ///< Keyboard k and K key
sL, ///< Keyboard l and L key
sM, ///< Keyboard m and M key
sN, ///< Keyboard n and N key
sO, ///< Keyboard o and O key
sP, ///< Keyboard p and P key
sQ, ///< Keyboard q and Q key
sR, ///< Keyboard r and R key
sS, ///< Keyboard s and S key
sT, ///< Keyboard t and T key
sU, ///< Keyboard u and U key
sV, ///< Keyboard v and V key
sW, ///< Keyboard w and W key
sX, ///< Keyboard x and X key
sY, ///< Keyboard y and Y key
sZ, ///< Keyboard z and Z key
sNum1, ///< Keyboard 1 and ! key
sNum2, ///< Keyboard 2 and @ key
sNum3, ///< Keyboard 3 and # key
sNum4, ///< Keyboard 4 and $ key
sNum5, ///< Keyboard 5 and % key
sNum6, ///< Keyboard 6 and ^ key
sNum7, ///< Keyboard 7 and & key
sNum8, ///< Keyboard 8 and * key
sNum9, ///< Keyboard 9 and ) key
sNum0, ///< Keyboard 0 and ) key
sEnter, ///< Keyboard Return (ENTER) key
sEscape, ///< Keyboard Escape key
sBackspace, ///< Keyboard Backspace key
// TODO above it's BackSpace, but is it correct? What do we use here?
sTab, ///< Keyboard Tab key
sSpace, ///< Keyboard Space key
sHyphen, ///< Keyboard - and _ key
sEquals, ///< Keyboard = and +
sLBracket, ///< Keyboard [ and { key
sRBracket, ///< Keyboard ] and } key
sBackslash, ///< Keyboard \ and | key
// TODO capitalisation
sDash, ///< Keyboard Non-US # and ~
sSemicolon, ///< Keyboard ; and : key
// TODO capitalisation
sQuote, ///< Keyboard ' and " key
sGraveAccent, ///< Keyboard ` and ~ key
sComma, ///< Keyboard , and < key
sPeriod, ///< Keyboard . and > key
sForwardSlash, ///< Keyboard / and ? key
sF1, ///< Keyboard F1 key
sF2, ///< Keyboard F2 key
sF3, ///< Keyboard F3 key
sF4, ///< Keyboard F4 key
sF5, ///< Keyboard F5 key
sF6, ///< Keyboard F6 key
sF7, ///< Keyboard F7 key
sF8, ///< Keyboard F8 key
sF9, ///< Keyboard F9 key
sF10, ///< Keyboard F10 key
sF11, ///< Keyboard F11 key
sF12, ///< Keyboard F12 key
sF13, ///< Keyboard F13 key
sF14, ///< Keyboard F14 key
sF15, ///< Keyboard F15 key
sCapsLock, ///< Keyboard Caps Lock key
sPrintScreen, ///< Keyboard Print Screen key
sScrollLock, ///< Keyboard Scroll Lock key
sPause, ///< Keyboard Pause key
sInsert, ///< Keyboard Insert key
sHome, ///< Keyboard Home key
sPageUp, ///< Keyboard Page Up key
sDelete, ///< Keyboard Delete Forward key
sEnd, ///< Keyboard End key
sPageDown, ///< Keyboard Page Down key
sRight, ///< Keyboard Right Arrow key
sLeft, ///< Keyboard Left Arrow key
sDown, ///< Keyboard Down Arrow key
sUp, ///< Keyboard Up Arrow key
sNumLock, ///< Keypad Num Lock and Clear key
sDivide, ///< Keypad / key
sMultiply, ///< Keypad * key
sMinus, ///< Keypad - key
sPlus, ///< Keypad + key
sPadEquals, ///< keypad = key, probably Mac only
sReturn, ///< Keypad Enter (return) key
sDecimal, ///< Keypad . and Delete key
sNumpad1, ///< Keypad 1 and End key
sNumpad2, ///< Keypad 2 and Down Arrow key
sNumpad3, ///< Keypad 3 and Page Down key
sNumpad4, ///< Keypad 4 and Left Arrow key
sNumpad5, ///< Keypad 5 key
sNumpad6, ///< Keypad 6 and Right Arrow key
sNumpad7, ///< Keypad 7 and Home key
sNumpad8, ///< Keypad 8 and Up Arrow key
sNumpad9, ///< Keypad 9 and Page Up key
sNumpad0, ///< Keypad 0 and Insert key
sReverseSolidus, ///< Keyboard Non-US \ and | key
ScanUnknown = -1, ///< Represents any scancode not present in this enum
ScanA = 0, ///< Keyboard a and A key
ScanB, ///< Keyboard b and B key
ScanC, ///< Keyboard c and C key
ScanD, ///< Keyboard d and D key
ScanE, ///< Keyboard e and E key
ScanF, ///< Keyboard f and F key
ScanG, ///< Keyboard g and G key
ScanH, ///< Keyboard h and H key
ScanI, ///< Keyboard i and I key
ScanJ, ///< Keyboard j and J key
ScanK, ///< Keyboard k and K key
ScanL, ///< Keyboard l and L key
ScanM, ///< Keyboard m and M key
ScanN, ///< Keyboard n and N key
ScanO, ///< Keyboard o and O key
ScanP, ///< Keyboard p and P key
ScanQ, ///< Keyboard q and Q key
ScanR, ///< Keyboard r and R key
ScanS, ///< Keyboard s and S key
ScanT, ///< Keyboard t and T key
ScanU, ///< Keyboard u and U key
ScanV, ///< Keyboard v and V key
ScanW, ///< Keyboard w and W key
ScanX, ///< Keyboard x and X key
ScanY, ///< Keyboard y and Y key
ScanZ, ///< Keyboard z and Z key
ScanNum1, ///< Keyboard 1 and ! key
ScanNum2, ///< Keyboard 2 and @ key
ScanNum3, ///< Keyboard 3 and # key
ScanNum4, ///< Keyboard 4 and $ key
ScanNum5, ///< Keyboard 5 and % key
ScanNum6, ///< Keyboard 6 and ^ key
ScanNum7, ///< Keyboard 7 and & key
ScanNum8, ///< Keyboard 8 and * key
ScanNum9, ///< Keyboard 9 and ) key
ScanNum0, ///< Keyboard 0 and ) key
ScanEnter, ///< Keyboard Enter/Return key
ScanEscape, ///< Keyboard Escape key
ScanBackspace, ///< Keyboard Backspace key
ScanTab, ///< Keyboard Tab key
ScanSpace, ///< Keyboard Space key
ScanHyphen, ///< Keyboard - and _ key
ScanEquals, ///< Keyboard = and +
ScanLBracket, ///< Keyboard [ and { key
ScanRBracket, ///< Keyboard ] and } key
ScanBackslash, ///< Keyboard \ and | key
ScanDash, ///< Keyboard Non-US # and ~
// TODO hyphen vs minus vs dash
ScanSemicolon, ///< Keyboard ; and : key
ScanQuote, ///< Keyboard ' and " key
ScanGraveAccent, ///< Keyboard ` and ~ key
ScanComma, ///< Keyboard , and < key
ScanPeriod, ///< Keyboard . and > key
ScanSlash, ///< Keyboard / and ? key
ScanF1, ///< Keyboard F1 key
ScanF2, ///< Keyboard F2 key
ScanF3, ///< Keyboard F3 key
ScanF4, ///< Keyboard F4 key
ScanF5, ///< Keyboard F5 key
ScanF6, ///< Keyboard F6 key
ScanF7, ///< Keyboard F7 key
ScanF8, ///< Keyboard F8 key
ScanF9, ///< Keyboard F9 key
ScanF10, ///< Keyboard F10 key
ScanF11, ///< Keyboard F11 key
ScanF12, ///< Keyboard F12 key
ScanF13, ///< Keyboard F13 key
ScanF14, ///< Keyboard F14 key
ScanF15, ///< Keyboard F15 key
ScanCapsLock, ///< Keyboard Caps Lock key
ScanPrintScreen, ///< Keyboard Print Screen key
ScanScrollLock, ///< Keyboard Scroll Lock key
ScanPause, ///< Keyboard Pause key
ScanInsert, ///< Keyboard Insert key
ScanHome, ///< Keyboard Home key
ScanPageUp, ///< Keyboard Page Up key
ScanDelete, ///< Keyboard Delete Forward key
ScanEnd, ///< Keyboard End key
ScanPageDown, ///< Keyboard Page Down key
ScanRight, ///< Keyboard Right Arrow key
ScanLeft, ///< Keyboard Left Arrow key
ScanDown, ///< Keyboard Down Arrow key
ScanUp, ///< Keyboard Up Arrow key
ScanNumLock, ///< Keypad Num Lock and Clear key
ScanDivide, ///< Keypad / key
ScanMultiply, ///< Keypad * key
ScanMinus, ///< Keypad - key
ScanPlus, ///< Keypad + key
ScanNumpadEquals, ///< keypad = key, probably Mac only
ScanNumpadEnter, ///< Keypad Enter/Return key
ScanDecimal, ///< Keypad . and Delete key
ScanNumpad1, ///< Keypad 1 and End key
ScanNumpad2, ///< Keypad 2 and Down Arrow key
ScanNumpad3, ///< Keypad 3 and Page Down key
ScanNumpad4, ///< Keypad 4 and Left Arrow key
ScanNumpad5, ///< Keypad 5 key
ScanNumpad6, ///< Keypad 6 and Right Arrow key
ScanNumpad7, ///< Keypad 7 and Home key
ScanNumpad8, ///< Keypad 8 and Up Arrow key
ScanNumpad9, ///< Keypad 9 and Page Up key
ScanNumpad0, ///< Keypad 0 and Insert key
ScanReverseSolidus, ///< Keyboard Non-US \ and | key
// FIXME what is this one? Might need better name. The doc says:
// - Typically near the Left-Shift key in AT-102 implementations.
// - Typical language mappings: Belg:<\> FrCa:«°» Dan:<\> Dutch:]|[ Fren:<> Ger:<|> Ital:<> LatAm:<> Nor:<> Span:<> Swed:<|> Swiss:<\> UK:\| Brazil: \|.
// What is the difference with "regular" \ and | key?
sApplication, ///< Keyboard Application key
sExecute, ///< Keyboard Execute key
sHelp, ///< Keyboard Help key
sMenu, ///< Keyboard Menu key
sSelect, ///< Keyboard Select key
sStop, ///< Keyboard Stop key
sAgain, ///< Keyboard Again key
sUndo, ///< Keyboard Undo key
sCut, ///< Keyboard Cut key
sCopy, ///< Keyboard Copy key
sPaste, ///< Keyboard Paste key
sFind, ///< Keyboard Find key
sMute, ///< Keyboard Mute key
sVolumeUp, ///< Keyboard Volume Up key
sVolumeDown, ///< Keyboard Volume Down key
sLControl, ///< Keyboard Left Control key
sLShift, ///< Keyboard Left Shift key
sLAlt, ///< Keyboard Left Alt key
sLSystem, ///< Keyboard Left System key
sRControl, ///< Keyboard Right Control key
sRShift, ///< Keyboard Right Shift key
sRAlt, ///< Keyboard Right Alt key
sRSystem, ///< Keyboard Right System key
ScanApplication, ///< Keyboard Application key
ScanExecute, ///< Keyboard Execute key
ScanHelp, ///< Keyboard Help key
ScanMenu, ///< Keyboard Menu key
ScanSelect, ///< Keyboard Select key
ScanStop, ///< Keyboard Stop key
ScanAgain, ///< Keyboard Again key
ScanUndo, ///< Keyboard Undo key
ScanCut, ///< Keyboard Cut key
ScanCopy, ///< Keyboard Copy key
ScanPaste, ///< Keyboard Paste key
ScanFind, ///< Keyboard Find key
ScanMute, ///< Keyboard Mute key
ScanVolumeUp, ///< Keyboard Volume Up key
ScanVolumeDown, ///< Keyboard Volume Down key
ScanLControl, ///< Keyboard Left Control key
ScanLShift, ///< Keyboard Left Shift key
ScanLAlt, ///< Keyboard Left Alt key
ScanLSystem, ///< Keyboard Left System key
ScanRControl, ///< Keyboard Right Control key
ScanRShift, ///< Keyboard Right Shift key
ScanRAlt, ///< Keyboard Right Alt key
ScanRSystem, ///< Keyboard Right System key
sCodeCount ///< Keep last -- the total number of scancodes
ScanCodeCount ///< Keep last -- the total number of scancodes
};
////////////////////////////////////////////////////////////
@ -360,7 +359,7 @@ public:
///
/// \return The scancode corresponding to the key under the current
/// keyboard layout used by the operating system, or
/// sf::Keyboard::sUnknown when the key cannot be mapped
/// sf::Keyboard::ScanUnknown when the key cannot be mapped
/// to a Keyboard::Scancode.
///
/// \see localize
@ -376,18 +375,18 @@ public:
/// when the given physical key is pressed by the user, when no
/// modifiers are involved.
///
/// \warning The result is OS-dependent: for example, sf::Keyboard::sLSystem
/// \warning The result is OS-dependent: for example, sf::Keyboard::ScanLSystem
/// is "Left Meta" on Linux, "Left Windows" on Windows and
/// "Left Command" on macOS.
///
/// The current keyboard layout set by the operating system is used to
/// interpret the scancode: for example, sf::Keyboard::SemiColon is
/// interpret the scancode: for example, sf::Keyboard::Semicolon is
/// mapped to ";" for layout and to "é" for others.
///
/// \return The localized description of the code
///
////////////////////////////////////////////////////////////
static String localizedRepresentation(Scancode code);
static String getDescription(Scancode code);
////////////////////////////////////////////////////////////
/// \brief Show or hide the virtual keyboard

2
src/SFML/Window/Android/InputImpl.hpp
View File

@ -72,7 +72,7 @@ public:
/// \copydoc sf::Keyboard::localizedRepresentation
///
////////////////////////////////////////////////////////////
static String localizedRepresentation(Keyboard::Scancode code);
static String getDescription(Keyboard::Scancode code);
////////////////////////////////////////////////////////////
/// \copydoc sf::Keyboard::setVirtualKeyboardVisible

5
src/SFML/Window/Keyboard.cpp
View File

@ -27,6 +27,7 @@
////////////////////////////////////////////////////////////
#include <SFML/Window/Keyboard.hpp>
#include <SFML/Window/InputImpl.hpp>
#include <SFML/System/String.hpp>
namespace sf
@ -56,9 +57,9 @@ Keyboard::Scancode Keyboard::unlocalize(Key key)
}
////////////////////////////////////////////////////////////
String Keyboard::localizedRepresentation(Scancode code)
String Keyboard::getDescription(Scancode code)
{
return priv::InputImpl::localizedRepresentation(code);
return priv::InputImpl::getDescription(code);
}
////////////////////////////////////////////////////////////

8
src/SFML/Window/OSX/HIDInputManager.hpp
View File

@ -115,7 +115,7 @@ public:
/// Try to convert a virtual keycode (HID level) into a
/// SFML scancode.
///
/// Return sf::Keyboard::sUnknown if the keycode is unknown.
/// Return sf::Keyboard::ScanUnknown if the keycode is unknown.
///
////////////////////////////////////////////////////////////
static Keyboard::Scancode nonLocalizedKey(UniChar virtualKeycode);
@ -279,9 +279,9 @@ private:
// Member data
////////////////////////////////////////////////////////////
IOHIDManagerRef m_manager; ///< Underlying HID Manager
IOHIDElements m_keys[Keyboard::sCodeCount]; ///< All the keys on any connected keyboard
Keyboard::Scancode m_mapping[Keyboard::KeyCount]; ///< Mapping from Key to Scancode
Keyboard::Key m_gnippam[Keyboard::sCodeCount]; ///< Mapping from Scancode to Key
IOHIDElements m_keys[Keyboard::ScanCodeCount]; ///< All the keys on any connected keyboard
Keyboard::Scancode m_keyToScancodeMapping[Keyboard::KeyCount]; ///< Mapping from Key to Scancode
Keyboard::Key m_scancodeToKeyMapping[Keyboard::ScanCodeCount]; ///< Mapping from Scancode to Key
////////////////////////////////////////////////////////////
/// m_keys' index corresponds to sf::Keyboard::Scancode enum.

1122
src/SFML/Window/OSX/HIDInputManager.mm
View File

File diff suppressed because it is too large Load Diff

2
src/SFML/Window/OSX/InputImpl.hpp
View File

@ -73,7 +73,7 @@ public:
/// \copydoc sf::Keyboard::localizedRepresentation
///
////////////////////////////////////////////////////////////
static String localizedRepresentation(Keyboard::Scancode code);
static String getDescription(Keyboard::Scancode code);
////////////////////////////////////////////////////////////
/// \copydoc sf::Keyboard::setVirtualKeyboardVisible

2
src/SFML/Window/OSX/InputImpl.mm
View File

@ -151,7 +151,7 @@ Keyboard::Scancode InputImpl::unlocalize(Keyboard::Key key)
////////////////////////////////////////////////////////////
String InputImpl::localizedRepresentation(Keyboard::Scancode code)
String InputImpl::getDescription(Keyboard::Scancode code)
{
return HIDInputManager::getInstance().localizedRepresentation(code);
}

8
src/SFML/Window/OSX/SFKeyboardModifiersHelper.mm
View File

@ -169,7 +169,7 @@ void handleModifiersChanged(NSUInteger modifiers, sf::priv::WindowImplCocoa& req
NSLeftShiftKeyMask, NSRightShiftKeyMask,
state.leftShiftWasDown, state.rightShiftWasDown,
sf::Keyboard::LShift, sf::Keyboard::RShift,
sf::Keyboard::sLShift, sf::Keyboard::sRShift,
sf::Keyboard::ScanLShift, sf::Keyboard::ScanRShift,
requester
);
@ -179,7 +179,7 @@ void handleModifiersChanged(NSUInteger modifiers, sf::priv::WindowImplCocoa& req
NSLeftCommandKeyMask, NSRightCommandKeyMask,
state.leftCommandWasDown, state.rightCommandWasDown,
sf::Keyboard::LSystem, sf::Keyboard::RSystem,
sf::Keyboard::sLSystem, sf::Keyboard::sRSystem,
sf::Keyboard::ScanLSystem, sf::Keyboard::ScanRSystem,
requester
);
@ -189,7 +189,7 @@ void handleModifiersChanged(NSUInteger modifiers, sf::priv::WindowImplCocoa& req
NSLeftAlternateKeyMask, NSRightAlternateKeyMask,
state.leftAlternateWasDown, state.rightAlternateWasDown,
sf::Keyboard::LAlt, sf::Keyboard::RAlt,
sf::Keyboard::sLAlt, sf::Keyboard::sRAlt,
sf::Keyboard::ScanLAlt, sf::Keyboard::ScanRAlt,
requester
);
@ -199,7 +199,7 @@ void handleModifiersChanged(NSUInteger modifiers, sf::priv::WindowImplCocoa& req
NSLeftControlKeyMask, NSRightControlKeyMask,
state.leftControlWasDown, state.rightControlWasDown,
sf::Keyboard::LControl, sf::Keyboard::RControl,
sf::Keyboard::sLControl, sf::Keyboard::sRControl,
sf::Keyboard::ScanLControl, sf::Keyboard::ScanRControl,
requester
);
}

2
src/SFML/Window/OSX/SFOpenGLView+keyboard.mm
View File

@ -94,7 +94,7 @@
{
sf::Event::KeyEvent key = [SFOpenGLView convertNSKeyEventToSFMLEvent:theEvent];
if ((key.code != sf::Keyboard::Unknown) || (key.scancode != sf::Keyboard::sUnknown))
if ((key.code != sf::Keyboard::Unknown) || (key.scancode != sf::Keyboard::ScanUnknown))
m_requester->keyDown(key);
}

2
src/SFML/Window/Unix/InputImpl.hpp
View File

@ -72,7 +72,7 @@ public:
/// \copydoc sf::Keyboard::localizedRepresentation
///
////////////////////////////////////////////////////////////
static String localizedRepresentation(Keyboard::Scancode code);
static String getDescription(Keyboard::Scancode code);
////////////////////////////////////////////////////////////
/// \copydoc sf::Keyboard::setVirtualKeyboardVisible

2
src/SFML/Window/Win32/InputImpl.hpp
View File

@ -72,7 +72,7 @@ public:
/// \copydoc sf::Keyboard::localizedRepresentation
///
////////////////////////////////////////////////////////////
static String localizedRepresentation(Keyboard::Scancode code);
static String getDescription(Keyboard::Scancode code);
////////////////////////////////////////////////////////////
/// \copydoc sf::Keyboard::setVirtualKeyboardVisible

2
src/SFML/Window/iOS/InputImpl.hpp
View File

@ -72,7 +72,7 @@ public:
/// \copydoc sf::Keyboard::localizedRepresentation
///
////////////////////////////////////////////////////////////
static String localizedRepresentation(Keyboard::Scancode code);
static String getDescription(Keyboard::Scancode code);
////////////////////////////////////////////////////////////
/// \copydoc sf::Keyboard::setVirtualKeyboardVisible